Skip to content

Refactor ElementListenerMap to use expando properties #18766

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 28, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/react-dom/src/client/ReactDOMComponent.js
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,6 @@ import {
TOP_SUBMIT,
TOP_TOGGLE,
} from '../events/DOMTopLevelEventTypes';
import {getListenerMapForElement} from '../events/DOMEventListenerMap';
import {mediaEventTypes} from '../events/DOMTopLevelEventTypes';
import {
createDangerousStringForStyles,
Expand Down Expand Up @@ -96,6 +95,7 @@ import {
legacyTrapBubbledEvent,
} from '../events/DOMLegacyEventPluginSystem';
import {listenToEvent} from '../events/DOMModernPluginEventSystem';
import {getEventListenerMap} from './ReactDOMComponentTree';

let didWarnInvalidHydration = false;
let didWarnScriptTags = false;
Expand Down Expand Up @@ -1346,7 +1346,7 @@ export function listenToEventResponderEventTypes(
if (enableDeprecatedFlareAPI) {
// Get the listening Map for this element. We use this to track
// what events we're listening to.
const listenerMap = getListenerMapForElement(document);
const listenerMap = getEventListenerMap(document);

// Go through each target event type of the event responder
for (let i = 0, length = eventTypes.length; i < length; ++i) {
Expand Down
26 changes: 23 additions & 3 deletions packages/react-dom/src/client/ReactDOMComponentTree.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import type {
SuspenseInstance,
Props,
} from './ReactDOMHostConfig';
import type {DOMTopLevelEventType} from 'legacy-events/TopLevelEventTypes';

import {
HostComponent,
Expand All @@ -30,8 +31,19 @@ const randomKey = Math.random()
.toString(36)
.slice(2);
const internalInstanceKey = '__reactFiber$' + randomKey;
const internalEventHandlersKey = '__reactEvents$' + randomKey;
const internalPropsKey = '__reactProps$' + randomKey;
const internalContainerInstanceKey = '__reactContainer$' + randomKey;
const internalEventHandlersKey = '__reactEvents$' + randomKey;

export type ElementListenerMap = Map<
DOMTopLevelEventType | string,
ElementListenerMapEntry,
>;

export type ElementListenerMapEntry = {
passive: void | boolean,
listener: any => void,
};

export function precacheFiberNode(
hostInst: Fiber,
Expand Down Expand Up @@ -176,12 +188,20 @@ export function getNodeFromInstance(inst: Fiber): Instance | TextInstance {
export function getFiberCurrentPropsFromNode(
node: Instance | TextInstance | SuspenseInstance,
): Props {
return (node: any)[internalEventHandlersKey] || null;
return (node: any)[internalPropsKey] || null;
}

export function updateFiberProps(
node: Instance | TextInstance | SuspenseInstance,
props: Props,
): void {
(node: any)[internalEventHandlersKey] = props;
(node: any)[internalPropsKey] = props;
}

export function getEventListenerMap(node: EventTarget): ElementListenerMap {
let elementListenerMap = (node: any)[internalEventHandlersKey];
if (elementListenerMap === undefined) {
elementListenerMap = (node: any)[internalEventHandlersKey] = new Map();
}
return elementListenerMap;
}
70 changes: 0 additions & 70 deletions packages/react-dom/src/events/DOMEventListenerMap.js

This file was deleted.

10 changes: 6 additions & 4 deletions packages/react-dom/src/events/DOMLegacyEventPluginSystem.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

import type {AnyNativeEvent} from 'legacy-events/PluginModuleType';
import type {DOMTopLevelEventType} from 'legacy-events/TopLevelEventTypes';
import type {ElementListenerMap} from '../events/DOMEventListenerMap';
import type {ElementListenerMap} from '../client/ReactDOMComponentTree';
import type {EventSystemFlags} from './EventSystemFlags';
import type {Fiber} from 'react-reconciler/src/ReactInternalTypes';
import type {PluginModule} from 'legacy-events/PluginModuleType';
Expand All @@ -29,8 +29,10 @@ import accumulateInto from 'legacy-events/accumulateInto';
import {registrationNameDependencies} from 'legacy-events/EventPluginRegistry';

import getEventTarget from './getEventTarget';
import {getClosestInstanceFromNode} from '../client/ReactDOMComponentTree';
import {getListenerMapForElement} from './DOMEventListenerMap';
import {
getClosestInstanceFromNode,
getEventListenerMap,
} from '../client/ReactDOMComponentTree';
import isEventSupported from './isEventSupported';
import {
TOP_BLUR,
Expand Down Expand Up @@ -319,7 +321,7 @@ export function legacyListenToEvent(
registrationName: string,
mountAt: Document | Element,
): void {
const listenerMap = getListenerMapForElement(mountAt);
const listenerMap = getEventListenerMap(mountAt);
const dependencies = registrationNameDependencies[registrationName];

for (let i = 0; i < dependencies.length; i++) {
Expand Down
12 changes: 7 additions & 5 deletions packages/react-dom/src/events/DOMModernPluginEventSystem.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import type {DOMTopLevelEventType} from 'legacy-events/TopLevelEventTypes';
import type {
ElementListenerMap,
ElementListenerMapEntry,
} from '../events/DOMEventListenerMap';
} from '../client/ReactDOMComponentTree';
import type {EventSystemFlags} from './EventSystemFlags';
import type {EventPriority, ReactScopeMethods} from 'shared/ReactTypes';
import type {Fiber} from 'react-reconciler/src/ReactInternalTypes';
Expand All @@ -36,7 +36,6 @@ import {
} from 'react-reconciler/src/ReactWorkTags';

import getEventTarget from './getEventTarget';
import {getListenerMapForElement} from './DOMEventListenerMap';
import {
TOP_FOCUS,
TOP_LOAD,
Expand Down Expand Up @@ -74,7 +73,10 @@ import {
TOP_SELECTION_CHANGE,
getRawEventName,
} from './DOMTopLevelEventTypes';
import {getClosestInstanceFromNode} from '../client/ReactDOMComponentTree';
import {
getClosestInstanceFromNode,
getEventListenerMap,
} from '../client/ReactDOMComponentTree';
import {COMMENT_NODE} from '../shared/HTMLNodeType';
import {batchedEventUpdates} from './ReactDOMUpdateBatching';
import getListener from './getListener';
Expand Down Expand Up @@ -237,7 +239,7 @@ export function listenToTopLevelEvent(
// triggered on the document directly.
if (topLevelType === TOP_SELECTION_CHANGE) {
targetContainer = (targetContainer: any).ownerDocument || targetContainer;
listenerMap = getListenerMapForElement(targetContainer);
listenerMap = getEventListenerMap(targetContainer);
}
const listenerEntry: ElementListenerMapEntry | void = listenerMap.get(
topLevelType,
Expand All @@ -262,7 +264,7 @@ export function listenToEvent(
registrationName: string,
rootContainerElement: Element,
): void {
const listenerMap = getListenerMapForElement(rootContainerElement);
const listenerMap = getEventListenerMap(rootContainerElement);
const dependencies = registrationNameDependencies[registrationName];

for (let i = 0; i < dependencies.length; i++) {
Expand Down
8 changes: 4 additions & 4 deletions packages/react-dom/src/events/ReactDOMEventReplaying.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
import type {AnyNativeEvent} from 'legacy-events/PluginModuleType';
import type {Container, SuspenseInstance} from '../client/ReactDOMHostConfig';
import type {DOMTopLevelEventType} from 'legacy-events/TopLevelEventTypes';
import type {ElementListenerMap} from '../events/DOMEventListenerMap';
import type {ElementListenerMap} from '../client/ReactDOMComponentTree';
import type {EventSystemFlags} from './EventSystemFlags';
import type {FiberRoot} from 'react-reconciler/src/ReactInternalTypes';

Expand All @@ -31,10 +31,10 @@ import {
getSuspenseInstanceFromFiber,
} from 'react-reconciler/src/ReactFiberTreeReflection';
import {attemptToDispatchEvent} from './ReactDOMEventListener';
import {getListenerMapForElement} from './DOMEventListenerMap';
import {
getInstanceFromNode,
getClosestInstanceFromNode,
getEventListenerMap,
} from '../client/ReactDOMComponentTree';
import {unsafeCastDOMTopLevelTypeToString} from 'legacy-events/TopLevelEventTypes';
import {HostRoot, SuspenseComponent} from 'react-reconciler/src/ReactWorkTags';
Expand Down Expand Up @@ -256,10 +256,10 @@ export function eagerlyTrapReplayableEvents(
container: Container,
document: Document,
) {
const listenerMapForDoc = getListenerMapForElement(document);
const listenerMapForDoc = getEventListenerMap(document);
let listenerMapForContainer;
if (enableModernEventSystem) {
listenerMapForContainer = getListenerMapForElement(container);
listenerMapForContainer = getEventListenerMap(container);
}
// Discrete
discreteReplayableEvents.forEach(topLevelType => {
Expand Down
23 changes: 21 additions & 2 deletions packages/react-dom/src/events/plugins/LegacySelectEventPlugin.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,16 @@ import {
TOP_SELECTION_CHANGE,
} from '../DOMTopLevelEventTypes';
import getActiveElement from '../../client/getActiveElement';
import {getNodeFromInstance} from '../../client/ReactDOMComponentTree';
import {
getNodeFromInstance,
getEventListenerMap,
} from '../../client/ReactDOMComponentTree';
import {hasSelectionCapabilities} from '../../client/ReactInputSelection';
import {DOCUMENT_NODE} from '../../shared/HTMLNodeType';
import {isListeningToAllDependencies} from '../DOMEventListenerMap';
import {accumulateTwoPhaseDispatches} from '../DOMLegacyEventPluginSystem';

import {registrationNameDependencies} from 'legacy-events/EventPluginRegistry';

const skipSelectionChangeEvent =
canUseDOM && 'documentMode' in document && document.documentMode <= 11;

Expand Down Expand Up @@ -143,6 +147,21 @@ function constructSelectEvent(nativeEvent, nativeEventTarget) {
return null;
}

function isListeningToAllDependencies(
registrationName: string,
mountAt: Document | Element,
): boolean {
const dependencies = registrationNameDependencies[registrationName];
const listenerMap = getEventListenerMap(mountAt);
for (let i = 0; i < dependencies.length; i++) {
const event = dependencies[i];
if (!listenerMap.has(event)) {
return false;
}
}
return true;
}

/**
* This plugin creates an `onSelect` event that normalizes select events
* across form elements.
Expand Down
28 changes: 26 additions & 2 deletions packages/react-dom/src/events/plugins/ModernSelectEventPlugin.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,12 @@ import {
TOP_SELECTION_CHANGE,
} from '../DOMTopLevelEventTypes';
import getActiveElement from '../../client/getActiveElement';
import {getNodeFromInstance} from '../../client/ReactDOMComponentTree';
import {
getNodeFromInstance,
getEventListenerMap,
} from '../../client/ReactDOMComponentTree';
import {hasSelectionCapabilities} from '../../client/ReactInputSelection';
import {DOCUMENT_NODE} from '../../shared/HTMLNodeType';
import {isListeningToEvent, isListeningToEvents} from '../DOMEventListenerMap';
import {accumulateTwoPhaseListeners} from '../DOMModernPluginEventSystem';

const skipSelectionChangeEvent =
Expand Down Expand Up @@ -144,6 +146,28 @@ function constructSelectEvent(nativeEvent, nativeEventTarget) {
return null;
}

function isListeningToEvents(
events: Array<string>,
mountAt: Document | Element,
): boolean {
const listenerMap = getEventListenerMap(mountAt);
for (let i = 0; i < events.length; i++) {
const event = events[i];
if (!listenerMap.has(event)) {
return false;
}
}
return true;
}

function isListeningToEvent(
registrationName: string,
mountAt: Document | Element,
): boolean {
const listenerMap = getEventListenerMap(mountAt);
return listenerMap.has(registrationName);
}

/**
* This plugin creates an `onSelect` event that normalizes select events
* across form elements.
Expand Down