Skip to content

Commit 5682442

Browse files
authored
[react-native-renderer] EventTarget-based event dispatching (#36253)
## Summary Set up the experiment to migrate event dispatching in the React Native renderer to be based on the native EventTarget API. Behind the `enableNativeEventTargetEventDispatching` flag, events are dispatched through `dispatchTrustedEvent` instead of the legacy plugin system. Regular event handler props are NOT registered via addEventListener at commit time. Instead, a hook on EventTarget (`EVENT_TARGET_GET_DECLARATIVE_LISTENER_KEY`) extracts handlers from `canonical.currentProps` at dispatch time, shifting cost from every render to only when events fire. The hook is overridden in ReactNativeElement to look up the prop name via a reverse mapping from event names (built lazily from the view config registry). Responder events bypass EventTarget entirely. `negotiateResponder` walks the fiber tree directly (capture then bubble phase), calling handlers from `canonical.currentProps` and checking return values inline. Lifecycle events (`responderGrant`, `responderMove`, etc.) call handlers directly from props and inspect return values — `onResponderGrant` returning `true` blocks native responder, `onResponderTerminationRequest` returning `false` refuses termination. This eliminates all commit-time cost for responder events (no wrappers, no addEventListener, no `responderWrappers` on canonical). ## How did you test this change? Flow Tested e2e in RN using Fantom tests (that will land after this).
1 parent fef12a0 commit 5682442

10 files changed

Lines changed: 775 additions & 16 deletions

File tree

.eslintrc.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -463,6 +463,7 @@ module.exports = {
463463
globals: {
464464
nativeFabricUIManager: 'readonly',
465465
RN$enableMicrotasksInReact: 'readonly',
466+
RN$isNativeEventTargetEventDispatchingEnabled: 'readonly',
466467
},
467468
},
468469
{
Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
/**
2+
* Copyright (c) Meta Platforms, Inc. and affiliates.
3+
*
4+
* This source code is licensed under the MIT license found in the
5+
* LICENSE file in the root directory of this source tree.
6+
*
7+
* @flow
8+
*/
9+
10+
/* globals Event$Init */
11+
12+
/**
13+
* A bridge event class that extends the W3C Event interface and carries
14+
* the native event payload. This is used as a compatibility layer during
15+
* the migration from the legacy SyntheticEvent system to EventTarget-based
16+
* dispatching.
17+
*/
18+
export default class LegacySyntheticEvent extends Event {
19+
_nativeEvent: {[string]: mixed};
20+
_propagationStopped: boolean;
21+
22+
constructor(
23+
type: string,
24+
options: Event$Init,
25+
nativeEvent: {[string]: mixed},
26+
) {
27+
super(type, options);
28+
this._nativeEvent = nativeEvent;
29+
this._propagationStopped = false;
30+
}
31+
32+
get nativeEvent(): {[string]: mixed} {
33+
return this._nativeEvent;
34+
}
35+
36+
stopPropagation(): void {
37+
super.stopPropagation();
38+
this._propagationStopped = true;
39+
}
40+
41+
stopImmediatePropagation(): void {
42+
super.stopImmediatePropagation();
43+
this._propagationStopped = true;
44+
}
45+
46+
/**
47+
* No-op for backward compatibility. The legacy SyntheticEvent system
48+
* used pooling which required calling persist() to keep the event.
49+
* With EventTarget-based dispatching, events are never pooled.
50+
*/
51+
persist(): void {
52+
// No-op
53+
}
54+
55+
/**
56+
* Backward-compatible wrapper for `defaultPrevented`.
57+
*/
58+
isDefaultPrevented(): boolean {
59+
return this.defaultPrevented;
60+
}
61+
62+
/**
63+
* Backward-compatible wrapper. Returns true if stopPropagation()
64+
* has been called.
65+
*/
66+
isPropagationStopped(): boolean {
67+
return this._propagationStopped;
68+
}
69+
}

packages/react-native-renderer/src/ReactFabricEventEmitter.js

Lines changed: 65 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,23 @@ import accumulateInto from './legacy-events/accumulateInto';
2828
import getListener from './ReactNativeGetListener';
2929
import {runEventsInBatch} from './legacy-events/EventBatching';
3030

31-
import {RawEventEmitter} from 'react-native/Libraries/ReactPrivate/ReactNativePrivateInterface';
31+
import {
32+
RawEventEmitter,
33+
ReactNativeViewConfigRegistry,
34+
dispatchTrustedEvent,
35+
setEventInitTimeStamp,
36+
} from 'react-native/Libraries/ReactPrivate/ReactNativePrivateInterface';
3237
import {getPublicInstance} from './ReactFiberConfigFabric';
38+
import LegacySyntheticEvent from './LegacySyntheticEvent';
39+
import {topLevelTypeToEventName} from './ReactNativeEventTypeMapping';
40+
import {processResponderEvent} from './ReactNativeResponder';
41+
import {enableNativeEventTargetEventDispatching} from './ReactNativeFeatureFlags';
3342

3443
export {getListener, registrationNameModules as registrationNames};
3544

45+
const {customBubblingEventTypes, customDirectEventTypes} =
46+
ReactNativeViewConfigRegistry;
47+
3648
/**
3749
* Allows registered plugins an opportunity to extract events from top-level
3850
* native browser events.
@@ -47,10 +59,12 @@ function extractPluginEvents(
4759
nativeEventTarget: null | EventTarget,
4860
): Array<ReactSyntheticEvent> | ReactSyntheticEvent | null {
4961
let events: Array<ReactSyntheticEvent> | ReactSyntheticEvent | null = null;
50-
const legacyPlugins = ((plugins: any): Array<LegacyPluginModule<Event>>);
62+
const legacyPlugins = ((plugins: any): Array<
63+
LegacyPluginModule<AnyNativeEvent>,
64+
>);
5165
for (let i = 0; i < legacyPlugins.length; i++) {
5266
// Not every plugin in the ordering may be loaded at runtime.
53-
const possiblePlugin: LegacyPluginModule<AnyNativeEvent> = legacyPlugins[i];
67+
const possiblePlugin = legacyPlugins[i];
5468
if (possiblePlugin) {
5569
const extractedEvents = possiblePlugin.extractEvents(
5670
topLevelType,
@@ -84,8 +98,12 @@ function runExtractedPluginEventsInBatch(
8498
export function dispatchEvent(
8599
target: null | Object,
86100
topLevelType: RNTopLevelEventType,
87-
nativeEvent: AnyNativeEvent,
101+
nativeEventParam: mixed,
88102
) {
103+
const nativeEvent: AnyNativeEvent =
104+
nativeEventParam != null && typeof nativeEventParam === 'object'
105+
? (nativeEventParam: any)
106+
: {};
89107
const targetFiber = (target: null | Fiber);
90108

91109
let eventTarget = null;
@@ -121,18 +139,52 @@ export function dispatchEvent(
121139
// Note that extracted events are *not* emitted,
122140
// only events that have a 1:1 mapping with a native event, at least for now.
123141
const event = {eventName: topLevelType, nativeEvent};
124-
// $FlowFixMe[class-object-subtyping] found when upgrading Flow
125142
RawEventEmitter.emit(topLevelType, event);
126-
// $FlowFixMe[class-object-subtyping] found when upgrading Flow
127143
RawEventEmitter.emit('*', event);
128144

129-
// Heritage plugin event system
130-
runExtractedPluginEventsInBatch(
131-
topLevelType,
132-
targetFiber,
133-
nativeEvent,
134-
eventTarget,
135-
);
145+
if (enableNativeEventTargetEventDispatching()) {
146+
// Process responder events before normal event dispatch.
147+
// This handles touch negotiation (onStartShouldSetResponder, etc.)
148+
processResponderEvent(topLevelType, targetFiber, nativeEvent);
149+
150+
// New EventTarget-based dispatch path
151+
if (eventTarget != null) {
152+
const bubbleDispatchConfig = customBubblingEventTypes[topLevelType];
153+
const directDispatchConfig = customDirectEventTypes[topLevelType];
154+
const bubbles = bubbleDispatchConfig != null;
155+
156+
// Skip events that are not registered in the view config
157+
if (bubbles || directDispatchConfig != null) {
158+
const eventName = topLevelTypeToEventName(topLevelType);
159+
const options = {
160+
bubbles,
161+
cancelable: true,
162+
};
163+
// Preserve the native event timestamp for backwards compatibility.
164+
// The legacy SyntheticEvent system used nativeEvent.timeStamp || nativeEvent.timestamp.
165+
const nativeTimestamp =
166+
nativeEvent.timeStamp ?? nativeEvent.timestamp;
167+
if (typeof nativeTimestamp === 'number') {
168+
setEventInitTimeStamp(options, nativeTimestamp);
169+
}
170+
const syntheticEvent = new LegacySyntheticEvent(
171+
eventName,
172+
options,
173+
nativeEvent,
174+
);
175+
// $FlowFixMe[incompatible-call]
176+
dispatchTrustedEvent(eventTarget, syntheticEvent);
177+
}
178+
}
179+
} else {
180+
// Heritage plugin event system
181+
runExtractedPluginEventsInBatch(
182+
topLevelType,
183+
targetFiber,
184+
nativeEvent,
185+
eventTarget,
186+
);
187+
}
136188
});
137189
// React Native doesn't use ReactControlledComponent but if it did, here's
138190
// where it would do it.

packages/react-native-renderer/src/ReactNativeEventEmitter.js

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -131,10 +131,12 @@ function extractPluginEvents(
131131
nativeEventTarget: null | EventTarget,
132132
): Array<ReactSyntheticEvent> | ReactSyntheticEvent | null {
133133
let events: Array<ReactSyntheticEvent> | ReactSyntheticEvent | null = null;
134-
const legacyPlugins = ((plugins: any): Array<LegacyPluginModule<Event>>);
134+
const legacyPlugins = ((plugins: any): Array<
135+
LegacyPluginModule<AnyNativeEvent>,
136+
>);
135137
for (let i = 0; i < legacyPlugins.length; i++) {
136138
// Not every plugin in the ordering may be loaded at runtime.
137-
const possiblePlugin: LegacyPluginModule<AnyNativeEvent> = legacyPlugins[i];
139+
const possiblePlugin = legacyPlugins[i];
138140
if (possiblePlugin) {
139141
const extractedEvents = possiblePlugin.extractEvents(
140142
topLevelType,
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
/**
2+
* Copyright (c) Meta Platforms, Inc. and affiliates.
3+
*
4+
* This source code is licensed under the MIT license found in the
5+
* LICENSE file in the root directory of this source tree.
6+
*
7+
* @flow
8+
*/
9+
10+
/**
11+
* Converts a topLevelType (e.g., "topPress") to a DOM event name (e.g., "press").
12+
* Strips the "top" prefix and lowercases the result.
13+
*/
14+
export function topLevelTypeToEventName(topLevelType: string): string {
15+
const fourthChar = topLevelType.charCodeAt(3);
16+
if (
17+
topLevelType.startsWith('top') &&
18+
fourthChar >= 65 /* A */ &&
19+
fourthChar <= 90 /* Z */
20+
) {
21+
return topLevelType.slice(3).toLowerCase();
22+
}
23+
return topLevelType;
24+
}
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
/**
2+
* Copyright (c) Meta Platforms, Inc. and affiliates.
3+
*
4+
* This source code is licensed under the MIT license found in the
5+
* LICENSE file in the root directory of this source tree.
6+
*
7+
* @flow
8+
*/
9+
10+
// These globals are set by React Native (e.g. in setUpDOM.js, setUpTimers.js)
11+
// and provide access to RN's feature flags. We use global functions because we
12+
// don't have another mechanism to pass feature flags from RN to React in OSS.
13+
// Values are lazily evaluated and cached on first access.
14+
15+
let _enableNativeEventTargetEventDispatching: boolean | null = null;
16+
export function enableNativeEventTargetEventDispatching(): boolean {
17+
if (_enableNativeEventTargetEventDispatching == null) {
18+
_enableNativeEventTargetEventDispatching =
19+
typeof RN$isNativeEventTargetEventDispatchingEnabled === 'function' &&
20+
RN$isNativeEventTargetEventDispatchingEnabled();
21+
}
22+
return _enableNativeEventTargetEventDispatching;
23+
}

0 commit comments

Comments
 (0)