Gate the public EventTarget API on ReactNativeElement and ReadOnlyText behind enableImperativeEvents (#57088)#57088

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.

Sign up for GitHub

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

Closed
rubennorte wants to merge 1 commit into from
Closed

Gate the public EventTarget API on ReactNativeElement and ReadOnlyText behind enableImperativeEvents (#57088) #57088

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 10 additions & 0 deletions packages/react-native/scripts/featureflags/ReactNativeFeatureFlags.config.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1036,6 +1036,16 @@ const definitions: FeatureFlagDefinitions = {
},
ossReleaseStage: 'none',
},
enableImperativeEvents: {
defaultValue: false,
metadata: {
description:
'When enabled, ReactNativeElement and ReadOnlyText expose the public EventTarget API (addEventListener, removeEventListener, dispatchEvent). When disabled, those methods are removed from those final classes.',
expectedReleaseValue: true,
purpose: 'release',
},
ossReleaseStage: 'none',
},
enableNativeEventTargetEventDispatching: {
defaultValue: false,
metadata: {
Expand Down
8 changes: 7 additions & 1 deletion packages/react-native/src/private/featureflags/ReactNativeFeatureFlags.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @generated SignedSource<<77b178e216aa86a309f46cbf661d9122>>
* @generated SignedSource<<9ea39238fb9e7a4fd17f5c6a4f557e8c>>
* @flow strict
* @noformat
*/
Expand DownExpand Up@@ -33,6 +33,7 @@ export type ReactNativeFeatureFlagsJsOnly = $ReadOnly<{
animatedShouldSyncValueBeforeStartCallback: Getter<boolean>,
animatedShouldUseSingleOp: Getter<boolean>,
deferFlatListFocusChangeRenderUpdate: Getter<boolean>,
enableImperativeEvents: Getter<boolean>,
enableNativeEventTargetEventDispatching: Getter<boolean>,
externalElementInspectionEnabled: Getter<boolean>,
fixVirtualizeListCollapseWindowSize: Getter<boolean>,
Expand DownExpand Up@@ -162,6 +163,11 @@ export const animatedShouldUseSingleOp: Getter<boolean> = createJavaScriptFlagGe
*/
export const deferFlatListFocusChangeRenderUpdate: Getter<boolean> = createJavaScriptFlagGetter('deferFlatListFocusChangeRenderUpdate', false);

/**
* When enabled, ReactNativeElement and ReadOnlyText expose the public EventTarget API (addEventListener, removeEventListener, dispatchEvent). When disabled, those methods are removed from those final classes.
*/
export const enableImperativeEvents: Getter<boolean> = createJavaScriptFlagGetter('enableImperativeEvents', false);

/**
* When enabled, the React Native renderer dispatches events through the W3C EventTarget API (addEventListener/dispatchEvent) instead of the legacy plugin-based system.
*/
Expand Down
16 changes: 11 additions & 5 deletions packages/react-native/src/private/renderer/core/__tests__/EventTargetDispatching-itest.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@
* LICENSE file in the root directory of this source tree.
*
* @fantom_flags enableNativeEventTargetEventDispatching:*
* @fantom_flags enableImperativeEvents:*
* @flow strict-local
* @format
*/
Expand DownExpand Up@@ -465,10 +466,13 @@ const {isOSS} = Fantom.getConstants();
});

// --- addEventListener / removeEventListener on refs ---
// These tests require EventTarget-based dispatching to be enabled,
// since addEventListener is only available when the flag is on.
// These tests require both `enableNativeEventTargetEventDispatching` and
// `enableImperativeEvents` to be enabled, since the public `addEventListener`
// API on element refs is only available when both flags are on. They are
// skipped for the other flag combinations.

(ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching()
(ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching() &&
ReactNativeFeatureFlags.enableImperativeEvents()
? describe
: describe.skip)('addEventListener / removeEventListener', () => {
it('addEventListener on a ref receives dispatched events', () => {
Expand DownExpand Up@@ -915,7 +919,8 @@ const {isOSS} = Fantom.getConstants();
},
);

(ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching()
(ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching() &&
ReactNativeFeatureFlags.enableImperativeEvents()
? it
: it.skip)(
'direct (non-bubbling) events do not propagate via addEventListener',
Expand DownExpand Up@@ -964,7 +969,8 @@ const {isOSS} = Fantom.getConstants();
},
);

(ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching()
(ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching() &&
ReactNativeFeatureFlags.enableImperativeEvents()
? describe
: describe.skip)('bubbling to document element and document', () => {
it('event bubbles from child up to the document element', () => {
Expand Down
21 changes: 21 additions & 0 deletions packages/react-native/src/private/webapis/dom/nodes/ReactNativeElement.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -354,3 +354,24 @@ export const ReactNativeElement_public: typeof ReactNativeElement =

// $FlowExpectedError[prop-missing]
ReactNativeElement_public.prototype = ReactNativeElement.prototype;

// The public imperative EventTarget API (`addEventListener`,
// `removeEventListener`, `dispatchEvent`) is only inherited by this final class
// when `enableNativeEventTargetEventDispatching` is enabled (which makes
// `ReadOnlyNode` extend `EventTarget`). Until that public API is finalized, it
// is gated behind `enableImperativeEvents`: when that flag is off we remove
// those methods from this final class. Native/internal event dispatch does not
// rely on these public methods, so removing them is safe.
if (
ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching() &&
!ReactNativeFeatureFlags.enableImperativeEvents()
) {
const prototype: interface {
addEventListener?: unknown,
removeEventListener?: unknown,
dispatchEvent?: unknown,
} = ReactNativeElement.prototype;
prototype.addEventListener = undefined;
prototype.removeEventListener = undefined;
prototype.dispatchEvent = undefined;
}
22 changes: 22 additions & 0 deletions packages/react-native/src/private/webapis/dom/nodes/ReadOnlyText.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@

// flowlint unsafe-getters-setters:off

import * as ReactNativeFeatureFlags from '../../../featureflags/ReactNativeFeatureFlags';
import ReadOnlyCharacterData from './ReadOnlyCharacterData';
import ReadOnlyNode from './ReadOnlyNode';

Expand DownExpand Up@@ -39,3 +40,24 @@ export const ReadOnlyText_public: typeof ReadOnlyText =

// $FlowExpectedError[prop-missing]
ReadOnlyText_public.prototype = ReadOnlyText.prototype;

// The public imperative EventTarget API (`addEventListener`,
// `removeEventListener`, `dispatchEvent`) is only inherited by this final class
// when `enableNativeEventTargetEventDispatching` is enabled (which makes
// `ReadOnlyNode` extend `EventTarget`). Until that public API is finalized, it
// is gated behind `enableImperativeEvents`: when that flag is off we remove
// those methods from this final class. Native/internal event dispatch does not
// rely on these public methods, so removing them is safe.
if (
ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching() &&
!ReactNativeFeatureFlags.enableImperativeEvents()
) {
const prototype: interface {
addEventListener?: unknown,
removeEventListener?: unknown,
dispatchEvent?: unknown,
} = ReadOnlyText.prototype;
prototype.addEventListener = undefined;
prototype.removeEventListener = undefined;
prototype.dispatchEvent = undefined;
}
120 changes: 120 additions & 0 deletions packages/react-native/src/private/webapis/dom/nodes/__tests__/ReactNativeElement-itest.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,8 @@
* LICENSE file in the root directory of this source tree.
*
* @fantom_flags enableFabricCommitBranching:*
* @fantom_flags enableNativeEventTargetEventDispatching:true
* @fantom_flags enableImperativeEvents:*
* @flow strict-local
* @format
*/
Expand All@@ -23,6 +25,8 @@ import {
NativeText,
NativeVirtualText,
} from 'react-native/Libraries/Text/TextNativeComponent';
import * as ReactNativeFeatureFlags from 'react-native/src/private/featureflags/ReactNativeFeatureFlags';
import Event from 'react-native/src/private/webapis/dom/events/Event';
import ReactNativeElement from 'react-native/src/private/webapis/dom/nodes/ReactNativeElement';
import ReadOnlyElement from 'react-native/src/private/webapis/dom/nodes/ReadOnlyElement';
import ReadOnlyNode from 'react-native/src/private/webapis/dom/nodes/ReadOnlyNode';
Expand All@@ -33,6 +37,20 @@ function ensureReactNativeElement(value: unknown): ReactNativeElement {
return ensureInstance(value, ReactNativeElement);
}

// The public imperative EventTarget API is not part of the static type of this
// final class (it is only present at runtime, gated by feature flags), so we
// cast to an interface with optional members to inspect/use it without Flow
// errors. Optional members make this a valid upcast and let us assert both
// presence (`'function'`) and absence (`'undefined'`).
type MaybeEventTarget = interface {
addEventListener?: (type: string, callback: (event: Event) => void) => void,
removeEventListener?: (
type: string,
callback: (event: Event) => void,
) => void,
dispatchEvent?: (event: Event) => boolean,
};

/* eslint-disable no-bitwise */

describe('ReactNativeElement', () => {
Expand DownExpand Up@@ -1632,6 +1650,108 @@ describe('ReactNativeElement', () => {
});
});

describe('imperative EventTarget API', () => {
// These tests run with `enableNativeEventTargetEventDispatching:true` and
// `enableImperativeEvents:*` (see the `@fantom_flags` pragmas). The public
// EventTarget API is gated behind `enableImperativeEvents`: when it is off
// the methods are removed from this final class, when it is on they are
// available.
const {isOSS} = Fantom.getConstants();

if (!ReactNativeFeatureFlags.enableImperativeEvents()) {
describe('when `enableImperativeEvents` is off (default)', () => {
it('removes the public EventTarget methods', () => {
const ref = createRef<HostInstance>();
const root = Fantom.createRoot();

Fantom.runTask(() => {
root.render(<View ref={ref} />);
});

const element = ensureReactNativeElement(
ref.current,
) as MaybeEventTarget;
expect(typeof element.addEventListener).toBe('undefined');
expect(typeof element.removeEventListener).toBe('undefined');
expect(typeof element.dispatchEvent).toBe('undefined');
});

// Removing the public API must not affect native/prop event delivery,
// which goes through the internal (symbol-keyed) dispatch path.
(isOSS ? it.skip : it)(
'still delivers native events to prop handlers',
() => {
const ref = createRef<HostInstance>();
const onPointerUp = jest.fn();
const root = Fantom.createRoot();

Fantom.runTask(() => {
root.render(<View ref={ref} onPointerUp={onPointerUp} />);
});

expect(onPointerUp).toHaveBeenCalledTimes(0);

Fantom.dispatchNativeEvent(
ref,
'onPointerUp',
{x: 0, y: 0},
{
category: Fantom.NativeEventCategory.Discrete,
},
);

expect(onPointerUp).toHaveBeenCalledTimes(1);
},
);
});
}

if (ReactNativeFeatureFlags.enableImperativeEvents()) {
describe('when `enableImperativeEvents` is on', () => {
it('exposes the public EventTarget methods', () => {
const ref = createRef<HostInstance>();
const root = Fantom.createRoot();

Fantom.runTask(() => {
root.render(<View ref={ref} />);
});

const element = ensureReactNativeElement(
ref.current,
) as MaybeEventTarget;
expect(typeof element.addEventListener).toBe('function');
expect(typeof element.removeEventListener).toBe('function');
expect(typeof element.dispatchEvent).toBe('function');
});

it('round-trips a listener via `addEventListener` + `dispatchEvent`', () => {
const ref = createRef<HostInstance>();
const root = Fantom.createRoot();

Fantom.runTask(() => {
root.render(<View ref={ref} />);
});

const element = ensureReactNativeElement(
ref.current,
) as MaybeEventTarget;
const listener = jest.fn();

element.addEventListener?.('custom', listener);
const result = element.dispatchEvent?.(new Event('custom'));

expect(listener).toHaveBeenCalledTimes(1);
expect(result).toBe(true);

element.removeEventListener?.('custom', listener);
element.dispatchEvent?.(new Event('custom'));

expect(listener).toHaveBeenCalledTimes(1);
});
});
}
});

describe('global constructors', () => {
it('throws when constructing HTMLElement', () => {
expect(() => new HTMLElement()).toThrow(
Expand Down
63 changes: 63 additions & 0 deletions packages/react-native/src/private/webapis/dom/nodes/__tests__/ReadOnlyText-itest.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,8 @@
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @fantom_flags enableNativeEventTargetEventDispatching:true
* @fantom_flags enableImperativeEvents:*
* @flow strict-local
* @format
*/
Expand All@@ -18,6 +20,7 @@ import invariant from 'invariant';
import * as React from 'react';
import {createRef} from 'react';
import {NativeText} from 'react-native/Libraries/Text/TextNativeComponent';
import * as ReactNativeFeatureFlags from 'react-native/src/private/featureflags/ReactNativeFeatureFlags';
import ReactNativeElement from 'react-native/src/private/webapis/dom/nodes/ReactNativeElement';
import ReadOnlyNode from 'react-native/src/private/webapis/dom/nodes/ReadOnlyNode';
import ReadOnlyText from 'react-native/src/private/webapis/dom/nodes/ReadOnlyText';
Expand All@@ -34,6 +37,17 @@ function ensureReactNativeElement(value: unknown): ReactNativeElement {
return ensureInstance(value, ReactNativeElement);
}

// The public imperative EventTarget API is not part of the static type of this
// final class (it is only present at runtime, gated by feature flags), so we
// cast to an interface with optional members to inspect it without Flow errors.
// Optional members make this a valid upcast and let us assert both presence
// (`'function'`) and absence (`'undefined'`).
type MaybeEventTarget = interface {
addEventListener?: unknown,
removeEventListener?: unknown,
dispatchEvent?: unknown,
};

describe('ReadOnlyText', () => {
it('should be used to create public text instances', () => {
const parentNodeRef = createRef<HostInstance>();
Expand DownExpand Up@@ -332,6 +346,55 @@ describe('ReadOnlyText', () => {
});
});

describe('imperative EventTarget API', () => {
// These tests run with `enableNativeEventTargetEventDispatching:true` and
// `enableImperativeEvents:*` (see the `@fantom_flags` pragmas). The public
// EventTarget API is gated behind `enableImperativeEvents`: when it is off
// the methods are removed from this final class, when it is on they are
// available.
if (!ReactNativeFeatureFlags.enableImperativeEvents()) {
it('removes the public EventTarget methods when `enableImperativeEvents` is off (default)', () => {
const parentNodeRef = createRef<HostInstance>();

const root = Fantom.createRoot();

Fantom.runTask(() => {
root.render(<NativeText ref={parentNodeRef}>Some text</NativeText>);
});

const parentNode = ensureReadOnlyNode(parentNodeRef.current);
const textNode = ensureReadOnlyText(
parentNode.childNodes[0],
) as MaybeEventTarget;

expect(typeof textNode.addEventListener).toBe('undefined');
expect(typeof textNode.removeEventListener).toBe('undefined');
expect(typeof textNode.dispatchEvent).toBe('undefined');
});
}

if (ReactNativeFeatureFlags.enableImperativeEvents()) {
it('exposes the public EventTarget methods when `enableImperativeEvents` is on', () => {
const parentNodeRef = createRef<HostInstance>();

const root = Fantom.createRoot();

Fantom.runTask(() => {
root.render(<NativeText ref={parentNodeRef}>Some text</NativeText>);
});

const parentNode = ensureReadOnlyNode(parentNodeRef.current);
const textNode = ensureReadOnlyText(
parentNode.childNodes[0],
) as MaybeEventTarget;

expect(typeof textNode.addEventListener).toBe('function');
expect(typeof textNode.removeEventListener).toBe('function');
expect(typeof textNode.dispatchEvent).toBe('function');
});
}
});

describe('global constructors', () => {
it('throws when constructing Text', () => {
expect(() => new Text()).toThrow(
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Gate the public EventTarget API on ReactNativeElement and ReadOnlyText behind enableImperativeEvents (#57088)#57088

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.

 Sign up for GitHub

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

 Closed

rubennorte
wants to merge
1
commit into

from

 Closed


Gate the public EventTarget API on ReactNativeElement and ReadOnlyText behind enableImperativeEvents (#57088)
#57088
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


10 changes: 10 additions & 0 deletions
packages/react-native/scripts/featureflags/ReactNativeFeatureFlags.config.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1036,6 +1036,16 @@ const definitions: FeatureFlagDefinitions = {
 },
 ossReleaseStage: 'none',
 },
 enableImperativeEvents: {
 defaultValue: false,
 metadata: {
 description:
 'When enabled, ReactNativeElement and ReadOnlyText expose the public EventTarget API (addEventListener, removeEventListener, dispatchEvent). When disabled, those methods are removed from those final classes.',
 expectedReleaseValue: true,
 purpose: 'release',
 },
 ossReleaseStage: 'none',
 },
 enableNativeEventTargetEventDispatching: {
 defaultValue: false,
 metadata: {
Expand Down

8 changes: 7 additions & 1 deletion
packages/react-native/src/private/featureflags/ReactNativeFeatureFlags.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *
 * @generated SignedSource<<77b178e216aa86a309f46cbf661d9122>>
 * @generated SignedSource<<9ea39238fb9e7a4fd17f5c6a4f557e8c>>
 * @flow strict
 * @noformat
 */
Expand DownExpand Up@@ -33,6 +33,7 @@ export type ReactNativeFeatureFlagsJsOnly = $ReadOnly<{
 animatedShouldSyncValueBeforeStartCallback: Getter<boolean>,
 animatedShouldUseSingleOp: Getter<boolean>,
 deferFlatListFocusChangeRenderUpdate: Getter<boolean>,
 enableImperativeEvents: Getter<boolean>,
 enableNativeEventTargetEventDispatching: Getter<boolean>,
 externalElementInspectionEnabled: Getter<boolean>,
 fixVirtualizeListCollapseWindowSize: Getter<boolean>,
Expand DownExpand Up@@ -162,6 +163,11 @@ export const animatedShouldUseSingleOp: Getter<boolean> = createJavaScriptFlagGe
 */
export const deferFlatListFocusChangeRenderUpdate: Getter<boolean> = createJavaScriptFlagGetter('deferFlatListFocusChangeRenderUpdate', false);

/**
 * When enabled, ReactNativeElement and ReadOnlyText expose the public EventTarget API (addEventListener, removeEventListener, dispatchEvent). When disabled, those methods are removed from those final classes.
 */
export const enableImperativeEvents: Getter<boolean> = createJavaScriptFlagGetter('enableImperativeEvents', false);

/**
 * When enabled, the React Native renderer dispatches events through the W3C EventTarget API (addEventListener/dispatchEvent) instead of the legacy plugin-based system.
 */
Expand Down

16 changes: 11 additions & 5 deletions
packages/react-native/src/private/renderer/core/__tests__/EventTargetDispatching-itest.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@
 * LICENSE file in the root directory of this source tree.
 *
 * @fantom_flags enableNativeEventTargetEventDispatching:*
 * @fantom_flags enableImperativeEvents:*
 * @flow strict-local
 * @format
 */
Expand DownExpand Up@@ -465,10 +466,13 @@ const {isOSS} = Fantom.getConstants();
 });

 // --- addEventListener / removeEventListener on refs ---
 // These tests require EventTarget-based dispatching to be enabled,
 // since addEventListener is only available when the flag is on.
 // These tests require both `enableNativeEventTargetEventDispatching` and
 // `enableImperativeEvents` to be enabled, since the public `addEventListener`
 // API on element refs is only available when both flags are on. They are
 // skipped for the other flag combinations.

 (ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching()
 (ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching() &&
 ReactNativeFeatureFlags.enableImperativeEvents()
 ? describe
 : describe.skip)('addEventListener / removeEventListener', () => {
 it('addEventListener on a ref receives dispatched events', () => {
Expand DownExpand Up@@ -915,7 +919,8 @@ const {isOSS} = Fantom.getConstants();
 },
 );

 (ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching()
 (ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching() &&
 ReactNativeFeatureFlags.enableImperativeEvents()
 ? it
 : it.skip)(
 'direct (non-bubbling) events do not propagate via addEventListener',
Expand DownExpand Up@@ -964,7 +969,8 @@ const {isOSS} = Fantom.getConstants();
 },
 );

 (ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching()
 (ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching() &&
 ReactNativeFeatureFlags.enableImperativeEvents()
 ? describe
 : describe.skip)('bubbling to document element and document', () => {
 it('event bubbles from child up to the document element', () => {
Expand Down

21 changes: 21 additions & 0 deletions
packages/react-native/src/private/webapis/dom/nodes/ReactNativeElement.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -354,3 +354,24 @@ export const ReactNativeElement_public: typeof ReactNativeElement =

// $FlowExpectedError[prop-missing]
ReactNativeElement_public.prototype = ReactNativeElement.prototype;

// The public imperative EventTarget API (`addEventListener`,
// `removeEventListener`, `dispatchEvent`) is only inherited by this final class
// when `enableNativeEventTargetEventDispatching` is enabled (which makes
// `ReadOnlyNode` extend `EventTarget`). Until that public API is finalized, it
// is gated behind `enableImperativeEvents`: when that flag is off we remove
// those methods from this final class. Native/internal event dispatch does not
// rely on these public methods, so removing them is safe.
if (
 ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching() &&
 !ReactNativeFeatureFlags.enableImperativeEvents()
) {
 const prototype: interface {
 addEventListener?: unknown,
 removeEventListener?: unknown,
 dispatchEvent?: unknown,
 } = ReactNativeElement.prototype;
 prototype.addEventListener = undefined;
 prototype.removeEventListener = undefined;
 prototype.dispatchEvent = undefined;
}

22 changes: 22 additions & 0 deletions
packages/react-native/src/private/webapis/dom/nodes/ReadOnlyText.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@

// flowlint unsafe-getters-setters:off

import * as ReactNativeFeatureFlags from '../../../featureflags/ReactNativeFeatureFlags';
import ReadOnlyCharacterData from './ReadOnlyCharacterData';
import ReadOnlyNode from './ReadOnlyNode';

Expand DownExpand Up@@ -39,3 +40,24 @@ export const ReadOnlyText_public: typeof ReadOnlyText =

// $FlowExpectedError[prop-missing]
ReadOnlyText_public.prototype = ReadOnlyText.prototype;

// The public imperative EventTarget API (`addEventListener`,
// `removeEventListener`, `dispatchEvent`) is only inherited by this final class
// when `enableNativeEventTargetEventDispatching` is enabled (which makes
// `ReadOnlyNode` extend `EventTarget`). Until that public API is finalized, it
// is gated behind `enableImperativeEvents`: when that flag is off we remove
// those methods from this final class. Native/internal event dispatch does not
// rely on these public methods, so removing them is safe.
if (
 ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching() &&
 !ReactNativeFeatureFlags.enableImperativeEvents()
) {
 const prototype: interface {
 addEventListener?: unknown,
 removeEventListener?: unknown,
 dispatchEvent?: unknown,
 } = ReadOnlyText.prototype;
 prototype.addEventListener = undefined;
 prototype.removeEventListener = undefined;
 prototype.dispatchEvent = undefined;
}

120 changes: 120 additions & 0 deletions
packages/react-native/src/private/webapis/dom/nodes/__tests__/ReactNativeElement-itest.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,8 @@
 * LICENSE file in the root directory of this source tree.
 *
 * @fantom_flags enableFabricCommitBranching:*
 * @fantom_flags enableNativeEventTargetEventDispatching:true
 * @fantom_flags enableImperativeEvents:*
 * @flow strict-local
 * @format
 */
Expand All@@ -23,6 +25,8 @@ import {
 NativeText,
 NativeVirtualText,
} from 'react-native/Libraries/Text/TextNativeComponent';
import * as ReactNativeFeatureFlags from 'react-native/src/private/featureflags/ReactNativeFeatureFlags';
import Event from 'react-native/src/private/webapis/dom/events/Event';
import ReactNativeElement from 'react-native/src/private/webapis/dom/nodes/ReactNativeElement';
import ReadOnlyElement from 'react-native/src/private/webapis/dom/nodes/ReadOnlyElement';
import ReadOnlyNode from 'react-native/src/private/webapis/dom/nodes/ReadOnlyNode';
Expand All@@ -33,6 +37,20 @@ function ensureReactNativeElement(value: unknown): ReactNativeElement {
 return ensureInstance(value, ReactNativeElement);
}

// The public imperative EventTarget API is not part of the static type of this
// final class (it is only present at runtime, gated by feature flags), so we
// cast to an interface with optional members to inspect/use it without Flow
// errors. Optional members make this a valid upcast and let us assert both
// presence (`'function'`) and absence (`'undefined'`).
type MaybeEventTarget = interface {
 addEventListener?: (type: string, callback: (event: Event) => void) => void,
 removeEventListener?: (
 type: string,
 callback: (event: Event) => void,
 ) => void,
 dispatchEvent?: (event: Event) => boolean,
};

/* eslint-disable no-bitwise */

describe('ReactNativeElement', () => {
Expand DownExpand Up@@ -1632,6 +1650,108 @@ describe('ReactNativeElement', () => {
 });
 });

 describe('imperative EventTarget API', () => {
 // These tests run with `enableNativeEventTargetEventDispatching:true` and
 // `enableImperativeEvents:*` (see the `@fantom_flags` pragmas). The public
 // EventTarget API is gated behind `enableImperativeEvents`: when it is off
 // the methods are removed from this final class, when it is on they are
 // available.
 const {isOSS} = Fantom.getConstants();

 if (!ReactNativeFeatureFlags.enableImperativeEvents()) {
 describe('when `enableImperativeEvents` is off (default)', () => {
 it('removes the public EventTarget methods', () => {
 const ref = createRef<HostInstance>();
 const root = Fantom.createRoot();

 Fantom.runTask(() => {
 root.render(<View ref={ref} />);
 });

 const element = ensureReactNativeElement(
 ref.current,
 ) as MaybeEventTarget;
 expect(typeof element.addEventListener).toBe('undefined');
 expect(typeof element.removeEventListener).toBe('undefined');
 expect(typeof element.dispatchEvent).toBe('undefined');
 });

 // Removing the public API must not affect native/prop event delivery,
 // which goes through the internal (symbol-keyed) dispatch path.
 (isOSS ? it.skip : it)(
 'still delivers native events to prop handlers',
 () => {
 const ref = createRef<HostInstance>();
 const onPointerUp = jest.fn();
 const root = Fantom.createRoot();

 Fantom.runTask(() => {
 root.render(<View ref={ref} onPointerUp={onPointerUp} />);
 });

 expect(onPointerUp).toHaveBeenCalledTimes(0);

 Fantom.dispatchNativeEvent(
 ref,
 'onPointerUp',
 {x: 0, y: 0},
 {
 category: Fantom.NativeEventCategory.Discrete,
 },
 );

 expect(onPointerUp).toHaveBeenCalledTimes(1);
 },
 );
 });
 }

 if (ReactNativeFeatureFlags.enableImperativeEvents()) {
 describe('when `enableImperativeEvents` is on', () => {
 it('exposes the public EventTarget methods', () => {
 const ref = createRef<HostInstance>();
 const root = Fantom.createRoot();

 Fantom.runTask(() => {
 root.render(<View ref={ref} />);
 });

 const element = ensureReactNativeElement(
 ref.current,
 ) as MaybeEventTarget;
 expect(typeof element.addEventListener).toBe('function');
 expect(typeof element.removeEventListener).toBe('function');
 expect(typeof element.dispatchEvent).toBe('function');
 });

 it('round-trips a listener via `addEventListener` + `dispatchEvent`', () => {
 const ref = createRef<HostInstance>();
 const root = Fantom.createRoot();

 Fantom.runTask(() => {
 root.render(<View ref={ref} />);
 });

 const element = ensureReactNativeElement(
 ref.current,
 ) as MaybeEventTarget;
 const listener = jest.fn();

 element.addEventListener?.('custom', listener);
 const result = element.dispatchEvent?.(new Event('custom'));

 expect(listener).toHaveBeenCalledTimes(1);
 expect(result).toBe(true);

 element.removeEventListener?.('custom', listener);
 element.dispatchEvent?.(new Event('custom'));

 expect(listener).toHaveBeenCalledTimes(1);
 });
 });
 }
 });

 describe('global constructors', () => {
 it('throws when constructing HTMLElement', () => {
 expect(() => new HTMLElement()).toThrow(
Expand Down

63 changes: 63 additions & 0 deletions
packages/react-native/src/private/webapis/dom/nodes/__tests__/ReadOnlyText-itest.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,8 @@
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *
 * @fantom_flags enableNativeEventTargetEventDispatching:true
 * @fantom_flags enableImperativeEvents:*
 * @flow strict-local
 * @format
 */
Expand All@@ -18,6 +20,7 @@ import invariant from 'invariant';
import * as React from 'react';
import {createRef} from 'react';
import {NativeText} from 'react-native/Libraries/Text/TextNativeComponent';
import * as ReactNativeFeatureFlags from 'react-native/src/private/featureflags/ReactNativeFeatureFlags';
import ReactNativeElement from 'react-native/src/private/webapis/dom/nodes/ReactNativeElement';
import ReadOnlyNode from 'react-native/src/private/webapis/dom/nodes/ReadOnlyNode';
import ReadOnlyText from 'react-native/src/private/webapis/dom/nodes/ReadOnlyText';
Expand All@@ -34,6 +37,17 @@ function ensureReactNativeElement(value: unknown): ReactNativeElement {
 return ensureInstance(value, ReactNativeElement);
}

// The public imperative EventTarget API is not part of the static type of this
// final class (it is only present at runtime, gated by feature flags), so we
// cast to an interface with optional members to inspect it without Flow errors.
// Optional members make this a valid upcast and let us assert both presence
// (`'function'`) and absence (`'undefined'`).
type MaybeEventTarget = interface {
 addEventListener?: unknown,
 removeEventListener?: unknown,
 dispatchEvent?: unknown,
};

describe('ReadOnlyText', () => {
 it('should be used to create public text instances', () => {
 const parentNodeRef = createRef<HostInstance>();
Expand DownExpand Up@@ -332,6 +346,55 @@ describe('ReadOnlyText', () => {
 });
 });

 describe('imperative EventTarget API', () => {
 // These tests run with `enableNativeEventTargetEventDispatching:true` and
 // `enableImperativeEvents:*` (see the `@fantom_flags` pragmas). The public
 // EventTarget API is gated behind `enableImperativeEvents`: when it is off
 // the methods are removed from this final class, when it is on they are
 // available.
 if (!ReactNativeFeatureFlags.enableImperativeEvents()) {
 it('removes the public EventTarget methods when `enableImperativeEvents` is off (default)', () => {
 const parentNodeRef = createRef<HostInstance>();

 const root = Fantom.createRoot();

 Fantom.runTask(() => {
 root.render(<NativeText ref={parentNodeRef}>Some text</NativeText>);
 });

 const parentNode = ensureReadOnlyNode(parentNodeRef.current);
 const textNode = ensureReadOnlyText(
 parentNode.childNodes[0],
 ) as MaybeEventTarget;

 expect(typeof textNode.addEventListener).toBe('undefined');
 expect(typeof textNode.removeEventListener).toBe('undefined');
 expect(typeof textNode.dispatchEvent).toBe('undefined');
 });
 }

 if (ReactNativeFeatureFlags.enableImperativeEvents()) {
 it('exposes the public EventTarget methods when `enableImperativeEvents` is on', () => {
 const parentNodeRef = createRef<HostInstance>();

 const root = Fantom.createRoot();

 Fantom.runTask(() => {
 root.render(<NativeText ref={parentNodeRef}>Some text</NativeText>);
 });

 const parentNode = ensureReadOnlyNode(parentNodeRef.current);
 const textNode = ensureReadOnlyText(
 parentNode.childNodes[0],
 ) as MaybeEventTarget;

 expect(typeof textNode.addEventListener).toBe('function');
 expect(typeof textNode.removeEventListener).toBe('function');
 expect(typeof textNode.dispatchEvent).toBe('function');
 });
 }
 });

 describe('global constructors', () => {
 it('throws when constructing Text', () => {
 expect(() => new Text()).toThrow(
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Gate the public EventTarget API on ReactNativeElement and ReadOnlyText behind enableImperativeEvents (#57088)#57088

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.

 Sign up for GitHub

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

 Closed

rubennorte
wants to merge
1
commit into

from

 Closed


Gate the public EventTarget API on ReactNativeElement and ReadOnlyText behind enableImperativeEvents (#57088)
#57088
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


10 changes: 10 additions & 0 deletions
packages/react-native/scripts/featureflags/ReactNativeFeatureFlags.config.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1036,6 +1036,16 @@ const definitions: FeatureFlagDefinitions = {
 },
 ossReleaseStage: 'none',
 },
 enableImperativeEvents: {
 defaultValue: false,
 metadata: {
 description:
 'When enabled, ReactNativeElement and ReadOnlyText expose the public EventTarget API (addEventListener, removeEventListener, dispatchEvent). When disabled, those methods are removed from those final classes.',
 expectedReleaseValue: true,
 purpose: 'release',
 },
 ossReleaseStage: 'none',
 },
 enableNativeEventTargetEventDispatching: {
 defaultValue: false,
 metadata: {
Expand Down

8 changes: 7 additions & 1 deletion
packages/react-native/src/private/featureflags/ReactNativeFeatureFlags.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *
 * @generated SignedSource<<77b178e216aa86a309f46cbf661d9122>>
 * @generated SignedSource<<9ea39238fb9e7a4fd17f5c6a4f557e8c>>
 * @flow strict
 * @noformat
 */
Expand DownExpand Up@@ -33,6 +33,7 @@ export type ReactNativeFeatureFlagsJsOnly = $ReadOnly<{
 animatedShouldSyncValueBeforeStartCallback: Getter<boolean>,
 animatedShouldUseSingleOp: Getter<boolean>,
 deferFlatListFocusChangeRenderUpdate: Getter<boolean>,
 enableImperativeEvents: Getter<boolean>,
 enableNativeEventTargetEventDispatching: Getter<boolean>,
 externalElementInspectionEnabled: Getter<boolean>,
 fixVirtualizeListCollapseWindowSize: Getter<boolean>,
Expand DownExpand Up@@ -162,6 +163,11 @@ export const animatedShouldUseSingleOp: Getter<boolean> = createJavaScriptFlagGe
 */
export const deferFlatListFocusChangeRenderUpdate: Getter<boolean> = createJavaScriptFlagGetter('deferFlatListFocusChangeRenderUpdate', false);

/**
 * When enabled, ReactNativeElement and ReadOnlyText expose the public EventTarget API (addEventListener, removeEventListener, dispatchEvent). When disabled, those methods are removed from those final classes.
 */
export const enableImperativeEvents: Getter<boolean> = createJavaScriptFlagGetter('enableImperativeEvents', false);

/**
 * When enabled, the React Native renderer dispatches events through the W3C EventTarget API (addEventListener/dispatchEvent) instead of the legacy plugin-based system.
 */
Expand Down

16 changes: 11 additions & 5 deletions
packages/react-native/src/private/renderer/core/__tests__/EventTargetDispatching-itest.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@
 * LICENSE file in the root directory of this source tree.
 *
 * @fantom_flags enableNativeEventTargetEventDispatching:*
 * @fantom_flags enableImperativeEvents:*
 * @flow strict-local
 * @format
 */
Expand DownExpand Up@@ -465,10 +466,13 @@ const {isOSS} = Fantom.getConstants();
 });

 // --- addEventListener / removeEventListener on refs ---
 // These tests require EventTarget-based dispatching to be enabled,
 // since addEventListener is only available when the flag is on.
 // These tests require both `enableNativeEventTargetEventDispatching` and
 // `enableImperativeEvents` to be enabled, since the public `addEventListener`
 // API on element refs is only available when both flags are on. They are
 // skipped for the other flag combinations.

 (ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching()
 (ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching() &&
 ReactNativeFeatureFlags.enableImperativeEvents()
 ? describe
 : describe.skip)('addEventListener / removeEventListener', () => {
 it('addEventListener on a ref receives dispatched events', () => {
Expand DownExpand Up@@ -915,7 +919,8 @@ const {isOSS} = Fantom.getConstants();
 },
 );

 (ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching()
 (ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching() &&
 ReactNativeFeatureFlags.enableImperativeEvents()
 ? it
 : it.skip)(
 'direct (non-bubbling) events do not propagate via addEventListener',
Expand DownExpand Up@@ -964,7 +969,8 @@ const {isOSS} = Fantom.getConstants();
 },
 );

 (ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching()
 (ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching() &&
 ReactNativeFeatureFlags.enableImperativeEvents()
 ? describe
 : describe.skip)('bubbling to document element and document', () => {
 it('event bubbles from child up to the document element', () => {
Expand Down

21 changes: 21 additions & 0 deletions
packages/react-native/src/private/webapis/dom/nodes/ReactNativeElement.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -354,3 +354,24 @@ export const ReactNativeElement_public: typeof ReactNativeElement =

// $FlowExpectedError[prop-missing]
ReactNativeElement_public.prototype = ReactNativeElement.prototype;

// The public imperative EventTarget API (`addEventListener`,
// `removeEventListener`, `dispatchEvent`) is only inherited by this final class
// when `enableNativeEventTargetEventDispatching` is enabled (which makes
// `ReadOnlyNode` extend `EventTarget`). Until that public API is finalized, it
// is gated behind `enableImperativeEvents`: when that flag is off we remove
// those methods from this final class. Native/internal event dispatch does not
// rely on these public methods, so removing them is safe.
if (
 ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching() &&
 !ReactNativeFeatureFlags.enableImperativeEvents()
) {
 const prototype: interface {
 addEventListener?: unknown,
 removeEventListener?: unknown,
 dispatchEvent?: unknown,
 } = ReactNativeElement.prototype;
 prototype.addEventListener = undefined;
 prototype.removeEventListener = undefined;
 prototype.dispatchEvent = undefined;
}

22 changes: 22 additions & 0 deletions
packages/react-native/src/private/webapis/dom/nodes/ReadOnlyText.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@

// flowlint unsafe-getters-setters:off

import * as ReactNativeFeatureFlags from '../../../featureflags/ReactNativeFeatureFlags';
import ReadOnlyCharacterData from './ReadOnlyCharacterData';
import ReadOnlyNode from './ReadOnlyNode';

Expand DownExpand Up@@ -39,3 +40,24 @@ export const ReadOnlyText_public: typeof ReadOnlyText =

// $FlowExpectedError[prop-missing]
ReadOnlyText_public.prototype = ReadOnlyText.prototype;

// The public imperative EventTarget API (`addEventListener`,
// `removeEventListener`, `dispatchEvent`) is only inherited by this final class
// when `enableNativeEventTargetEventDispatching` is enabled (which makes
// `ReadOnlyNode` extend `EventTarget`). Until that public API is finalized, it
// is gated behind `enableImperativeEvents`: when that flag is off we remove
// those methods from this final class. Native/internal event dispatch does not
// rely on these public methods, so removing them is safe.
if (
 ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching() &&
 !ReactNativeFeatureFlags.enableImperativeEvents()
) {
 const prototype: interface {
 addEventListener?: unknown,
 removeEventListener?: unknown,
 dispatchEvent?: unknown,
 } = ReadOnlyText.prototype;
 prototype.addEventListener = undefined;
 prototype.removeEventListener = undefined;
 prototype.dispatchEvent = undefined;
}

120 changes: 120 additions & 0 deletions
packages/react-native/src/private/webapis/dom/nodes/__tests__/ReactNativeElement-itest.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,8 @@
 * LICENSE file in the root directory of this source tree.
 *
 * @fantom_flags enableFabricCommitBranching:*
 * @fantom_flags enableNativeEventTargetEventDispatching:true
 * @fantom_flags enableImperativeEvents:*
 * @flow strict-local
 * @format
 */
Expand All@@ -23,6 +25,8 @@ import {
 NativeText,
 NativeVirtualText,
} from 'react-native/Libraries/Text/TextNativeComponent';
import * as ReactNativeFeatureFlags from 'react-native/src/private/featureflags/ReactNativeFeatureFlags';
import Event from 'react-native/src/private/webapis/dom/events/Event';
import ReactNativeElement from 'react-native/src/private/webapis/dom/nodes/ReactNativeElement';
import ReadOnlyElement from 'react-native/src/private/webapis/dom/nodes/ReadOnlyElement';
import ReadOnlyNode from 'react-native/src/private/webapis/dom/nodes/ReadOnlyNode';
Expand All@@ -33,6 +37,20 @@ function ensureReactNativeElement(value: unknown): ReactNativeElement {
 return ensureInstance(value, ReactNativeElement);
}

// The public imperative EventTarget API is not part of the static type of this
// final class (it is only present at runtime, gated by feature flags), so we
// cast to an interface with optional members to inspect/use it without Flow
// errors. Optional members make this a valid upcast and let us assert both
// presence (`'function'`) and absence (`'undefined'`).
type MaybeEventTarget = interface {
 addEventListener?: (type: string, callback: (event: Event) => void) => void,
 removeEventListener?: (
 type: string,
 callback: (event: Event) => void,
 ) => void,
 dispatchEvent?: (event: Event) => boolean,
};

/* eslint-disable no-bitwise */

describe('ReactNativeElement', () => {
Expand DownExpand Up@@ -1632,6 +1650,108 @@ describe('ReactNativeElement', () => {
 });
 });

 describe('imperative EventTarget API', () => {
 // These tests run with `enableNativeEventTargetEventDispatching:true` and
 // `enableImperativeEvents:*` (see the `@fantom_flags` pragmas). The public
 // EventTarget API is gated behind `enableImperativeEvents`: when it is off
 // the methods are removed from this final class, when it is on they are
 // available.
 const {isOSS} = Fantom.getConstants();

 if (!ReactNativeFeatureFlags.enableImperativeEvents()) {
 describe('when `enableImperativeEvents` is off (default)', () => {
 it('removes the public EventTarget methods', () => {
 const ref = createRef<HostInstance>();
 const root = Fantom.createRoot();

 Fantom.runTask(() => {
 root.render(<View ref={ref} />);
 });

 const element = ensureReactNativeElement(
 ref.current,
 ) as MaybeEventTarget;
 expect(typeof element.addEventListener).toBe('undefined');
 expect(typeof element.removeEventListener).toBe('undefined');
 expect(typeof element.dispatchEvent).toBe('undefined');
 });

 // Removing the public API must not affect native/prop event delivery,
 // which goes through the internal (symbol-keyed) dispatch path.
 (isOSS ? it.skip : it)(
 'still delivers native events to prop handlers',
 () => {
 const ref = createRef<HostInstance>();
 const onPointerUp = jest.fn();
 const root = Fantom.createRoot();

 Fantom.runTask(() => {
 root.render(<View ref={ref} onPointerUp={onPointerUp} />);
 });

 expect(onPointerUp).toHaveBeenCalledTimes(0);

 Fantom.dispatchNativeEvent(
 ref,
 'onPointerUp',
 {x: 0, y: 0},
 {
 category: Fantom.NativeEventCategory.Discrete,
 },
 );

 expect(onPointerUp).toHaveBeenCalledTimes(1);
 },
 );
 });
 }

 if (ReactNativeFeatureFlags.enableImperativeEvents()) {
 describe('when `enableImperativeEvents` is on', () => {
 it('exposes the public EventTarget methods', () => {
 const ref = createRef<HostInstance>();
 const root = Fantom.createRoot();

 Fantom.runTask(() => {
 root.render(<View ref={ref} />);
 });

 const element = ensureReactNativeElement(
 ref.current,
 ) as MaybeEventTarget;
 expect(typeof element.addEventListener).toBe('function');
 expect(typeof element.removeEventListener).toBe('function');
 expect(typeof element.dispatchEvent).toBe('function');
 });

 it('round-trips a listener via `addEventListener` + `dispatchEvent`', () => {
 const ref = createRef<HostInstance>();
 const root = Fantom.createRoot();

 Fantom.runTask(() => {
 root.render(<View ref={ref} />);
 });

 const element = ensureReactNativeElement(
 ref.current,
 ) as MaybeEventTarget;
 const listener = jest.fn();

 element.addEventListener?.('custom', listener);
 const result = element.dispatchEvent?.(new Event('custom'));

 expect(listener).toHaveBeenCalledTimes(1);
 expect(result).toBe(true);

 element.removeEventListener?.('custom', listener);
 element.dispatchEvent?.(new Event('custom'));

 expect(listener).toHaveBeenCalledTimes(1);
 });
 });
 }
 });

 describe('global constructors', () => {
 it('throws when constructing HTMLElement', () => {
 expect(() => new HTMLElement()).toThrow(
Expand Down

63 changes: 63 additions & 0 deletions
packages/react-native/src/private/webapis/dom/nodes/__tests__/ReadOnlyText-itest.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,8 @@
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *
 * @fantom_flags enableNativeEventTargetEventDispatching:true
 * @fantom_flags enableImperativeEvents:*
 * @flow strict-local
 * @format
 */
Expand All@@ -18,6 +20,7 @@ import invariant from 'invariant';
import * as React from 'react';
import {createRef} from 'react';
import {NativeText} from 'react-native/Libraries/Text/TextNativeComponent';
import * as ReactNativeFeatureFlags from 'react-native/src/private/featureflags/ReactNativeFeatureFlags';
import ReactNativeElement from 'react-native/src/private/webapis/dom/nodes/ReactNativeElement';
import ReadOnlyNode from 'react-native/src/private/webapis/dom/nodes/ReadOnlyNode';
import ReadOnlyText from 'react-native/src/private/webapis/dom/nodes/ReadOnlyText';
Expand All@@ -34,6 +37,17 @@ function ensureReactNativeElement(value: unknown): ReactNativeElement {
 return ensureInstance(value, ReactNativeElement);
}

// The public imperative EventTarget API is not part of the static type of this
// final class (it is only present at runtime, gated by feature flags), so we
// cast to an interface with optional members to inspect it without Flow errors.
// Optional members make this a valid upcast and let us assert both presence
// (`'function'`) and absence (`'undefined'`).
type MaybeEventTarget = interface {
 addEventListener?: unknown,
 removeEventListener?: unknown,
 dispatchEvent?: unknown,
};

describe('ReadOnlyText', () => {
 it('should be used to create public text instances', () => {
 const parentNodeRef = createRef<HostInstance>();
Expand DownExpand Up@@ -332,6 +346,55 @@ describe('ReadOnlyText', () => {
 });
 });

 describe('imperative EventTarget API', () => {
 // These tests run with `enableNativeEventTargetEventDispatching:true` and
 // `enableImperativeEvents:*` (see the `@fantom_flags` pragmas). The public
 // EventTarget API is gated behind `enableImperativeEvents`: when it is off
 // the methods are removed from this final class, when it is on they are
 // available.
 if (!ReactNativeFeatureFlags.enableImperativeEvents()) {
 it('removes the public EventTarget methods when `enableImperativeEvents` is off (default)', () => {
 const parentNodeRef = createRef<HostInstance>();

 const root = Fantom.createRoot();

 Fantom.runTask(() => {
 root.render(<NativeText ref={parentNodeRef}>Some text</NativeText>);
 });

 const parentNode = ensureReadOnlyNode(parentNodeRef.current);
 const textNode = ensureReadOnlyText(
 parentNode.childNodes[0],
 ) as MaybeEventTarget;

 expect(typeof textNode.addEventListener).toBe('undefined');
 expect(typeof textNode.removeEventListener).toBe('undefined');
 expect(typeof textNode.dispatchEvent).toBe('undefined');
 });
 }

 if (ReactNativeFeatureFlags.enableImperativeEvents()) {
 it('exposes the public EventTarget methods when `enableImperativeEvents` is on', () => {
 const parentNodeRef = createRef<HostInstance>();

 const root = Fantom.createRoot();

 Fantom.runTask(() => {
 root.render(<NativeText ref={parentNodeRef}>Some text</NativeText>);
 });

 const parentNode = ensureReadOnlyNode(parentNodeRef.current);
 const textNode = ensureReadOnlyText(
 parentNode.childNodes[0],
 ) as MaybeEventTarget;

 expect(typeof textNode.addEventListener).toBe('function');
 expect(typeof textNode.removeEventListener).toBe('function');
 expect(typeof textNode.dispatchEvent).toBe('function');
 });
 }
 });

 describe('global constructors', () => {
 it('throws when constructing Text', () => {
 expect(() => new Text()).toThrow(
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Gate the public EventTarget API on ReactNativeElement and ReadOnlyText behind enableImperativeEvents (#57088)#57088

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.

 Sign up for GitHub

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

 Closed

rubennorte
wants to merge
1
commit into

from

 Closed


Gate the public EventTarget API on ReactNativeElement and ReadOnlyText behind enableImperativeEvents (#57088)
#57088
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


10 changes: 10 additions & 0 deletions
packages/react-native/scripts/featureflags/ReactNativeFeatureFlags.config.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1036,6 +1036,16 @@ const definitions: FeatureFlagDefinitions = {
 },
 ossReleaseStage: 'none',
 },
 enableImperativeEvents: {
 defaultValue: false,
 metadata: {
 description:
 'When enabled, ReactNativeElement and ReadOnlyText expose the public EventTarget API (addEventListener, removeEventListener, dispatchEvent). When disabled, those methods are removed from those final classes.',
 expectedReleaseValue: true,
 purpose: 'release',
 },
 ossReleaseStage: 'none',
 },
 enableNativeEventTargetEventDispatching: {
 defaultValue: false,
 metadata: {
Expand Down

8 changes: 7 additions & 1 deletion
packages/react-native/src/private/featureflags/ReactNativeFeatureFlags.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *
 * @generated SignedSource<<77b178e216aa86a309f46cbf661d9122>>
 * @generated SignedSource<<9ea39238fb9e7a4fd17f5c6a4f557e8c>>
 * @flow strict
 * @noformat
 */
Expand DownExpand Up@@ -33,6 +33,7 @@ export type ReactNativeFeatureFlagsJsOnly = $ReadOnly<{
 animatedShouldSyncValueBeforeStartCallback: Getter<boolean>,
 animatedShouldUseSingleOp: Getter<boolean>,
 deferFlatListFocusChangeRenderUpdate: Getter<boolean>,
 enableImperativeEvents: Getter<boolean>,
 enableNativeEventTargetEventDispatching: Getter<boolean>,
 externalElementInspectionEnabled: Getter<boolean>,
 fixVirtualizeListCollapseWindowSize: Getter<boolean>,
Expand DownExpand Up@@ -162,6 +163,11 @@ export const animatedShouldUseSingleOp: Getter<boolean> = createJavaScriptFlagGe
 */
export const deferFlatListFocusChangeRenderUpdate: Getter<boolean> = createJavaScriptFlagGetter('deferFlatListFocusChangeRenderUpdate', false);

/**
 * When enabled, ReactNativeElement and ReadOnlyText expose the public EventTarget API (addEventListener, removeEventListener, dispatchEvent). When disabled, those methods are removed from those final classes.
 */
export const enableImperativeEvents: Getter<boolean> = createJavaScriptFlagGetter('enableImperativeEvents', false);

/**
 * When enabled, the React Native renderer dispatches events through the W3C EventTarget API (addEventListener/dispatchEvent) instead of the legacy plugin-based system.
 */
Expand Down

16 changes: 11 additions & 5 deletions
packages/react-native/src/private/renderer/core/__tests__/EventTargetDispatching-itest.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@
 * LICENSE file in the root directory of this source tree.
 *
 * @fantom_flags enableNativeEventTargetEventDispatching:*
 * @fantom_flags enableImperativeEvents:*
 * @flow strict-local
 * @format
 */
Expand DownExpand Up@@ -465,10 +466,13 @@ const {isOSS} = Fantom.getConstants();
 });

 // --- addEventListener / removeEventListener on refs ---
 // These tests require EventTarget-based dispatching to be enabled,
 // since addEventListener is only available when the flag is on.
 // These tests require both `enableNativeEventTargetEventDispatching` and
 // `enableImperativeEvents` to be enabled, since the public `addEventListener`
 // API on element refs is only available when both flags are on. They are
 // skipped for the other flag combinations.

 (ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching()
 (ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching() &&
 ReactNativeFeatureFlags.enableImperativeEvents()
 ? describe
 : describe.skip)('addEventListener / removeEventListener', () => {
 it('addEventListener on a ref receives dispatched events', () => {
Expand DownExpand Up@@ -915,7 +919,8 @@ const {isOSS} = Fantom.getConstants();
 },
 );

 (ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching()
 (ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching() &&
 ReactNativeFeatureFlags.enableImperativeEvents()
 ? it
 : it.skip)(
 'direct (non-bubbling) events do not propagate via addEventListener',
Expand DownExpand Up@@ -964,7 +969,8 @@ const {isOSS} = Fantom.getConstants();
 },
 );

 (ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching()
 (ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching() &&
 ReactNativeFeatureFlags.enableImperativeEvents()
 ? describe
 : describe.skip)('bubbling to document element and document', () => {
 it('event bubbles from child up to the document element', () => {
Expand Down

21 changes: 21 additions & 0 deletions
packages/react-native/src/private/webapis/dom/nodes/ReactNativeElement.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -354,3 +354,24 @@ export const ReactNativeElement_public: typeof ReactNativeElement =

// $FlowExpectedError[prop-missing]
ReactNativeElement_public.prototype = ReactNativeElement.prototype;

// The public imperative EventTarget API (`addEventListener`,
// `removeEventListener`, `dispatchEvent`) is only inherited by this final class
// when `enableNativeEventTargetEventDispatching` is enabled (which makes
// `ReadOnlyNode` extend `EventTarget`). Until that public API is finalized, it
// is gated behind `enableImperativeEvents`: when that flag is off we remove
// those methods from this final class. Native/internal event dispatch does not
// rely on these public methods, so removing them is safe.
if (
 ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching() &&
 !ReactNativeFeatureFlags.enableImperativeEvents()
) {
 const prototype: interface {
 addEventListener?: unknown,
 removeEventListener?: unknown,
 dispatchEvent?: unknown,
 } = ReactNativeElement.prototype;
 prototype.addEventListener = undefined;
 prototype.removeEventListener = undefined;
 prototype.dispatchEvent = undefined;
}

22 changes: 22 additions & 0 deletions
packages/react-native/src/private/webapis/dom/nodes/ReadOnlyText.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@

// flowlint unsafe-getters-setters:off

import * as ReactNativeFeatureFlags from '../../../featureflags/ReactNativeFeatureFlags';
import ReadOnlyCharacterData from './ReadOnlyCharacterData';
import ReadOnlyNode from './ReadOnlyNode';

Expand DownExpand Up@@ -39,3 +40,24 @@ export const ReadOnlyText_public: typeof ReadOnlyText =

// $FlowExpectedError[prop-missing]
ReadOnlyText_public.prototype = ReadOnlyText.prototype;

// The public imperative EventTarget API (`addEventListener`,
// `removeEventListener`, `dispatchEvent`) is only inherited by this final class
// when `enableNativeEventTargetEventDispatching` is enabled (which makes
// `ReadOnlyNode` extend `EventTarget`). Until that public API is finalized, it
// is gated behind `enableImperativeEvents`: when that flag is off we remove
// those methods from this final class. Native/internal event dispatch does not
// rely on these public methods, so removing them is safe.
if (
 ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching() &&
 !ReactNativeFeatureFlags.enableImperativeEvents()
) {
 const prototype: interface {
 addEventListener?: unknown,
 removeEventListener?: unknown,
 dispatchEvent?: unknown,
 } = ReadOnlyText.prototype;
 prototype.addEventListener = undefined;
 prototype.removeEventListener = undefined;
 prototype.dispatchEvent = undefined;
}

120 changes: 120 additions & 0 deletions
packages/react-native/src/private/webapis/dom/nodes/__tests__/ReactNativeElement-itest.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,8 @@
 * LICENSE file in the root directory of this source tree.
 *
 * @fantom_flags enableFabricCommitBranching:*
 * @fantom_flags enableNativeEventTargetEventDispatching:true
 * @fantom_flags enableImperativeEvents:*
 * @flow strict-local
 * @format
 */
Expand All@@ -23,6 +25,8 @@ import {
 NativeText,
 NativeVirtualText,
} from 'react-native/Libraries/Text/TextNativeComponent';
import * as ReactNativeFeatureFlags from 'react-native/src/private/featureflags/ReactNativeFeatureFlags';
import Event from 'react-native/src/private/webapis/dom/events/Event';
import ReactNativeElement from 'react-native/src/private/webapis/dom/nodes/ReactNativeElement';
import ReadOnlyElement from 'react-native/src/private/webapis/dom/nodes/ReadOnlyElement';
import ReadOnlyNode from 'react-native/src/private/webapis/dom/nodes/ReadOnlyNode';
Expand All@@ -33,6 +37,20 @@ function ensureReactNativeElement(value: unknown): ReactNativeElement {
 return ensureInstance(value, ReactNativeElement);
}

// The public imperative EventTarget API is not part of the static type of this
// final class (it is only present at runtime, gated by feature flags), so we
// cast to an interface with optional members to inspect/use it without Flow
// errors. Optional members make this a valid upcast and let us assert both
// presence (`'function'`) and absence (`'undefined'`).
type MaybeEventTarget = interface {
 addEventListener?: (type: string, callback: (event: Event) => void) => void,
 removeEventListener?: (
 type: string,
 callback: (event: Event) => void,
 ) => void,
 dispatchEvent?: (event: Event) => boolean,
};

/* eslint-disable no-bitwise */

describe('ReactNativeElement', () => {
Expand DownExpand Up@@ -1632,6 +1650,108 @@ describe('ReactNativeElement', () => {
 });
 });

 describe('imperative EventTarget API', () => {
 // These tests run with `enableNativeEventTargetEventDispatching:true` and
 // `enableImperativeEvents:*` (see the `@fantom_flags` pragmas). The public
 // EventTarget API is gated behind `enableImperativeEvents`: when it is off
 // the methods are removed from this final class, when it is on they are
 // available.
 const {isOSS} = Fantom.getConstants();

 if (!ReactNativeFeatureFlags.enableImperativeEvents()) {
 describe('when `enableImperativeEvents` is off (default)', () => {
 it('removes the public EventTarget methods', () => {
 const ref = createRef<HostInstance>();
 const root = Fantom.createRoot();

 Fantom.runTask(() => {
 root.render(<View ref={ref} />);
 });

 const element = ensureReactNativeElement(
 ref.current,
 ) as MaybeEventTarget;
 expect(typeof element.addEventListener).toBe('undefined');
 expect(typeof element.removeEventListener).toBe('undefined');
 expect(typeof element.dispatchEvent).toBe('undefined');
 });

 // Removing the public API must not affect native/prop event delivery,
 // which goes through the internal (symbol-keyed) dispatch path.
 (isOSS ? it.skip : it)(
 'still delivers native events to prop handlers',
 () => {
 const ref = createRef<HostInstance>();
 const onPointerUp = jest.fn();
 const root = Fantom.createRoot();

 Fantom.runTask(() => {
 root.render(<View ref={ref} onPointerUp={onPointerUp} />);
 });

 expect(onPointerUp).toHaveBeenCalledTimes(0);

 Fantom.dispatchNativeEvent(
 ref,
 'onPointerUp',
 {x: 0, y: 0},
 {
 category: Fantom.NativeEventCategory.Discrete,
 },
 );

 expect(onPointerUp).toHaveBeenCalledTimes(1);
 },
 );
 });
 }

 if (ReactNativeFeatureFlags.enableImperativeEvents()) {
 describe('when `enableImperativeEvents` is on', () => {
 it('exposes the public EventTarget methods', () => {
 const ref = createRef<HostInstance>();
 const root = Fantom.createRoot();

 Fantom.runTask(() => {
 root.render(<View ref={ref} />);
 });

 const element = ensureReactNativeElement(
 ref.current,
 ) as MaybeEventTarget;
 expect(typeof element.addEventListener).toBe('function');
 expect(typeof element.removeEventListener).toBe('function');
 expect(typeof element.dispatchEvent).toBe('function');
 });

 it('round-trips a listener via `addEventListener` + `dispatchEvent`', () => {
 const ref = createRef<HostInstance>();
 const root = Fantom.createRoot();

 Fantom.runTask(() => {
 root.render(<View ref={ref} />);
 });

 const element = ensureReactNativeElement(
 ref.current,
 ) as MaybeEventTarget;
 const listener = jest.fn();

 element.addEventListener?.('custom', listener);
 const result = element.dispatchEvent?.(new Event('custom'));

 expect(listener).toHaveBeenCalledTimes(1);
 expect(result).toBe(true);

 element.removeEventListener?.('custom', listener);
 element.dispatchEvent?.(new Event('custom'));

 expect(listener).toHaveBeenCalledTimes(1);
 });
 });
 }
 });

 describe('global constructors', () => {
 it('throws when constructing HTMLElement', () => {
 expect(() => new HTMLElement()).toThrow(
Expand Down

63 changes: 63 additions & 0 deletions
packages/react-native/src/private/webapis/dom/nodes/__tests__/ReadOnlyText-itest.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,8 @@
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *
 * @fantom_flags enableNativeEventTargetEventDispatching:true
 * @fantom_flags enableImperativeEvents:*
 * @flow strict-local
 * @format
 */
Expand All@@ -18,6 +20,7 @@ import invariant from 'invariant';
import * as React from 'react';
import {createRef} from 'react';
import {NativeText} from 'react-native/Libraries/Text/TextNativeComponent';
import * as ReactNativeFeatureFlags from 'react-native/src/private/featureflags/ReactNativeFeatureFlags';
import ReactNativeElement from 'react-native/src/private/webapis/dom/nodes/ReactNativeElement';
import ReadOnlyNode from 'react-native/src/private/webapis/dom/nodes/ReadOnlyNode';
import ReadOnlyText from 'react-native/src/private/webapis/dom/nodes/ReadOnlyText';
Expand All@@ -34,6 +37,17 @@ function ensureReactNativeElement(value: unknown): ReactNativeElement {
 return ensureInstance(value, ReactNativeElement);
}

// The public imperative EventTarget API is not part of the static type of this
// final class (it is only present at runtime, gated by feature flags), so we
// cast to an interface with optional members to inspect it without Flow errors.
// Optional members make this a valid upcast and let us assert both presence
// (`'function'`) and absence (`'undefined'`).
type MaybeEventTarget = interface {
 addEventListener?: unknown,
 removeEventListener?: unknown,
 dispatchEvent?: unknown,
};

describe('ReadOnlyText', () => {
 it('should be used to create public text instances', () => {
 const parentNodeRef = createRef<HostInstance>();
Expand DownExpand Up@@ -332,6 +346,55 @@ describe('ReadOnlyText', () => {
 });
 });

 describe('imperative EventTarget API', () => {
 // These tests run with `enableNativeEventTargetEventDispatching:true` and
 // `enableImperativeEvents:*` (see the `@fantom_flags` pragmas). The public
 // EventTarget API is gated behind `enableImperativeEvents`: when it is off
 // the methods are removed from this final class, when it is on they are
 // available.
 if (!ReactNativeFeatureFlags.enableImperativeEvents()) {
 it('removes the public EventTarget methods when `enableImperativeEvents` is off (default)', () => {
 const parentNodeRef = createRef<HostInstance>();

 const root = Fantom.createRoot();

 Fantom.runTask(() => {
 root.render(<NativeText ref={parentNodeRef}>Some text</NativeText>);
 });

 const parentNode = ensureReadOnlyNode(parentNodeRef.current);
 const textNode = ensureReadOnlyText(
 parentNode.childNodes[0],
 ) as MaybeEventTarget;

 expect(typeof textNode.addEventListener).toBe('undefined');
 expect(typeof textNode.removeEventListener).toBe('undefined');
 expect(typeof textNode.dispatchEvent).toBe('undefined');
 });
 }

 if (ReactNativeFeatureFlags.enableImperativeEvents()) {
 it('exposes the public EventTarget methods when `enableImperativeEvents` is on', () => {
 const parentNodeRef = createRef<HostInstance>();

 const root = Fantom.createRoot();

 Fantom.runTask(() => {
 root.render(<NativeText ref={parentNodeRef}>Some text</NativeText>);
 });

 const parentNode = ensureReadOnlyNode(parentNodeRef.current);
 const textNode = ensureReadOnlyText(
 parentNode.childNodes[0],
 ) as MaybeEventTarget;

 expect(typeof textNode.addEventListener).toBe('function');
 expect(typeof textNode.removeEventListener).toBe('function');
 expect(typeof textNode.dispatchEvent).toBe('function');
 });
 }
 });

 describe('global constructors', () => {
 it('throws when constructing Text', () => {
 expect(() => new Text()).toThrow(
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Gate the public EventTarget API on ReactNativeElement and ReadOnlyText behind enableImperativeEvents (#57088)#57088

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.

 Sign up for GitHub

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

 Closed

rubennorte
wants to merge
1
commit into

from

 Closed


Gate the public EventTarget API on ReactNativeElement and ReadOnlyText behind enableImperativeEvents (#57088)
#57088
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


10 changes: 10 additions & 0 deletions
packages/react-native/scripts/featureflags/ReactNativeFeatureFlags.config.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1036,6 +1036,16 @@ const definitions: FeatureFlagDefinitions = {
 },
 ossReleaseStage: 'none',
 },
 enableImperativeEvents: {
 defaultValue: false,
 metadata: {
 description:
 'When enabled, ReactNativeElement and ReadOnlyText expose the public EventTarget API (addEventListener, removeEventListener, dispatchEvent). When disabled, those methods are removed from those final classes.',
 expectedReleaseValue: true,
 purpose: 'release',
 },
 ossReleaseStage: 'none',
 },
 enableNativeEventTargetEventDispatching: {
 defaultValue: false,
 metadata: {
Expand Down

8 changes: 7 additions & 1 deletion
packages/react-native/src/private/featureflags/ReactNativeFeatureFlags.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *
 * @generated SignedSource<<77b178e216aa86a309f46cbf661d9122>>
 * @generated SignedSource<<9ea39238fb9e7a4fd17f5c6a4f557e8c>>
 * @flow strict
 * @noformat
 */
Expand DownExpand Up@@ -33,6 +33,7 @@ export type ReactNativeFeatureFlagsJsOnly = $ReadOnly<{
 animatedShouldSyncValueBeforeStartCallback: Getter<boolean>,
 animatedShouldUseSingleOp: Getter<boolean>,
 deferFlatListFocusChangeRenderUpdate: Getter<boolean>,
 enableImperativeEvents: Getter<boolean>,
 enableNativeEventTargetEventDispatching: Getter<boolean>,
 externalElementInspectionEnabled: Getter<boolean>,
 fixVirtualizeListCollapseWindowSize: Getter<boolean>,
Expand DownExpand Up@@ -162,6 +163,11 @@ export const animatedShouldUseSingleOp: Getter<boolean> = createJavaScriptFlagGe
 */
export const deferFlatListFocusChangeRenderUpdate: Getter<boolean> = createJavaScriptFlagGetter('deferFlatListFocusChangeRenderUpdate', false);

/**
 * When enabled, ReactNativeElement and ReadOnlyText expose the public EventTarget API (addEventListener, removeEventListener, dispatchEvent). When disabled, those methods are removed from those final classes.
 */
export const enableImperativeEvents: Getter<boolean> = createJavaScriptFlagGetter('enableImperativeEvents', false);

/**
 * When enabled, the React Native renderer dispatches events through the W3C EventTarget API (addEventListener/dispatchEvent) instead of the legacy plugin-based system.
 */
Expand Down

16 changes: 11 additions & 5 deletions
packages/react-native/src/private/renderer/core/__tests__/EventTargetDispatching-itest.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@
 * LICENSE file in the root directory of this source tree.
 *
 * @fantom_flags enableNativeEventTargetEventDispatching:*
 * @fantom_flags enableImperativeEvents:*
 * @flow strict-local
 * @format
 */
Expand DownExpand Up@@ -465,10 +466,13 @@ const {isOSS} = Fantom.getConstants();
 });

 // --- addEventListener / removeEventListener on refs ---
 // These tests require EventTarget-based dispatching to be enabled,
 // since addEventListener is only available when the flag is on.
 // These tests require both `enableNativeEventTargetEventDispatching` and
 // `enableImperativeEvents` to be enabled, since the public `addEventListener`
 // API on element refs is only available when both flags are on. They are
 // skipped for the other flag combinations.

 (ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching()
 (ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching() &&
 ReactNativeFeatureFlags.enableImperativeEvents()
 ? describe
 : describe.skip)('addEventListener / removeEventListener', () => {
 it('addEventListener on a ref receives dispatched events', () => {
Expand DownExpand Up@@ -915,7 +919,8 @@ const {isOSS} = Fantom.getConstants();
 },
 );

 (ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching()
 (ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching() &&
 ReactNativeFeatureFlags.enableImperativeEvents()
 ? it
 : it.skip)(
 'direct (non-bubbling) events do not propagate via addEventListener',
Expand DownExpand Up@@ -964,7 +969,8 @@ const {isOSS} = Fantom.getConstants();
 },
 );

 (ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching()
 (ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching() &&
 ReactNativeFeatureFlags.enableImperativeEvents()
 ? describe
 : describe.skip)('bubbling to document element and document', () => {
 it('event bubbles from child up to the document element', () => {
Expand Down

21 changes: 21 additions & 0 deletions
packages/react-native/src/private/webapis/dom/nodes/ReactNativeElement.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -354,3 +354,24 @@ export const ReactNativeElement_public: typeof ReactNativeElement =

// $FlowExpectedError[prop-missing]
ReactNativeElement_public.prototype = ReactNativeElement.prototype;

// The public imperative EventTarget API (`addEventListener`,
// `removeEventListener`, `dispatchEvent`) is only inherited by this final class
// when `enableNativeEventTargetEventDispatching` is enabled (which makes
// `ReadOnlyNode` extend `EventTarget`). Until that public API is finalized, it
// is gated behind `enableImperativeEvents`: when that flag is off we remove
// those methods from this final class. Native/internal event dispatch does not
// rely on these public methods, so removing them is safe.
if (
 ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching() &&
 !ReactNativeFeatureFlags.enableImperativeEvents()
) {
 const prototype: interface {
 addEventListener?: unknown,
 removeEventListener?: unknown,
 dispatchEvent?: unknown,
 } = ReactNativeElement.prototype;
 prototype.addEventListener = undefined;
 prototype.removeEventListener = undefined;
 prototype.dispatchEvent = undefined;
}

22 changes: 22 additions & 0 deletions
packages/react-native/src/private/webapis/dom/nodes/ReadOnlyText.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@

// flowlint unsafe-getters-setters:off

import * as ReactNativeFeatureFlags from '../../../featureflags/ReactNativeFeatureFlags';
import ReadOnlyCharacterData from './ReadOnlyCharacterData';
import ReadOnlyNode from './ReadOnlyNode';

Expand DownExpand Up@@ -39,3 +40,24 @@ export const ReadOnlyText_public: typeof ReadOnlyText =

// $FlowExpectedError[prop-missing]
ReadOnlyText_public.prototype = ReadOnlyText.prototype;

// The public imperative EventTarget API (`addEventListener`,
// `removeEventListener`, `dispatchEvent`) is only inherited by this final class
// when `enableNativeEventTargetEventDispatching` is enabled (which makes
// `ReadOnlyNode` extend `EventTarget`). Until that public API is finalized, it
// is gated behind `enableImperativeEvents`: when that flag is off we remove
// those methods from this final class. Native/internal event dispatch does not
// rely on these public methods, so removing them is safe.
if (
 ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching() &&
 !ReactNativeFeatureFlags.enableImperativeEvents()
) {
 const prototype: interface {
 addEventListener?: unknown,
 removeEventListener?: unknown,
 dispatchEvent?: unknown,
 } = ReadOnlyText.prototype;
 prototype.addEventListener = undefined;
 prototype.removeEventListener = undefined;
 prototype.dispatchEvent = undefined;
}

120 changes: 120 additions & 0 deletions
packages/react-native/src/private/webapis/dom/nodes/__tests__/ReactNativeElement-itest.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,8 @@
 * LICENSE file in the root directory of this source tree.
 *
 * @fantom_flags enableFabricCommitBranching:*
 * @fantom_flags enableNativeEventTargetEventDispatching:true
 * @fantom_flags enableImperativeEvents:*
 * @flow strict-local
 * @format
 */
Expand All@@ -23,6 +25,8 @@ import {
 NativeText,
 NativeVirtualText,
} from 'react-native/Libraries/Text/TextNativeComponent';
import * as ReactNativeFeatureFlags from 'react-native/src/private/featureflags/ReactNativeFeatureFlags';
import Event from 'react-native/src/private/webapis/dom/events/Event';
import ReactNativeElement from 'react-native/src/private/webapis/dom/nodes/ReactNativeElement';
import ReadOnlyElement from 'react-native/src/private/webapis/dom/nodes/ReadOnlyElement';
import ReadOnlyNode from 'react-native/src/private/webapis/dom/nodes/ReadOnlyNode';
Expand All@@ -33,6 +37,20 @@ function ensureReactNativeElement(value: unknown): ReactNativeElement {
 return ensureInstance(value, ReactNativeElement);
}

// The public imperative EventTarget API is not part of the static type of this
// final class (it is only present at runtime, gated by feature flags), so we
// cast to an interface with optional members to inspect/use it without Flow
// errors. Optional members make this a valid upcast and let us assert both
// presence (`'function'`) and absence (`'undefined'`).
type MaybeEventTarget = interface {
 addEventListener?: (type: string, callback: (event: Event) => void) => void,
 removeEventListener?: (
 type: string,
 callback: (event: Event) => void,
 ) => void,
 dispatchEvent?: (event: Event) => boolean,
};

/* eslint-disable no-bitwise */

describe('ReactNativeElement', () => {
Expand DownExpand Up@@ -1632,6 +1650,108 @@ describe('ReactNativeElement', () => {
 });
 });

 describe('imperative EventTarget API', () => {
 // These tests run with `enableNativeEventTargetEventDispatching:true` and
 // `enableImperativeEvents:*` (see the `@fantom_flags` pragmas). The public
 // EventTarget API is gated behind `enableImperativeEvents`: when it is off
 // the methods are removed from this final class, when it is on they are
 // available.
 const {isOSS} = Fantom.getConstants();

 if (!ReactNativeFeatureFlags.enableImperativeEvents()) {
 describe('when `enableImperativeEvents` is off (default)', () => {
 it('removes the public EventTarget methods', () => {
 const ref = createRef<HostInstance>();
 const root = Fantom.createRoot();

 Fantom.runTask(() => {
 root.render(<View ref={ref} />);
 });

 const element = ensureReactNativeElement(
 ref.current,
 ) as MaybeEventTarget;
 expect(typeof element.addEventListener).toBe('undefined');
 expect(typeof element.removeEventListener).toBe('undefined');
 expect(typeof element.dispatchEvent).toBe('undefined');
 });

 // Removing the public API must not affect native/prop event delivery,
 // which goes through the internal (symbol-keyed) dispatch path.
 (isOSS ? it.skip : it)(
 'still delivers native events to prop handlers',
 () => {
 const ref = createRef<HostInstance>();
 const onPointerUp = jest.fn();
 const root = Fantom.createRoot();

 Fantom.runTask(() => {
 root.render(<View ref={ref} onPointerUp={onPointerUp} />);
 });

 expect(onPointerUp).toHaveBeenCalledTimes(0);

 Fantom.dispatchNativeEvent(
 ref,
 'onPointerUp',
 {x: 0, y: 0},
 {
 category: Fantom.NativeEventCategory.Discrete,
 },
 );

 expect(onPointerUp).toHaveBeenCalledTimes(1);
 },
 );
 });
 }

 if (ReactNativeFeatureFlags.enableImperativeEvents()) {
 describe('when `enableImperativeEvents` is on', () => {
 it('exposes the public EventTarget methods', () => {
 const ref = createRef<HostInstance>();
 const root = Fantom.createRoot();

 Fantom.runTask(() => {
 root.render(<View ref={ref} />);
 });

 const element = ensureReactNativeElement(
 ref.current,
 ) as MaybeEventTarget;
 expect(typeof element.addEventListener).toBe('function');
 expect(typeof element.removeEventListener).toBe('function');
 expect(typeof element.dispatchEvent).toBe('function');
 });

 it('round-trips a listener via `addEventListener` + `dispatchEvent`', () => {
 const ref = createRef<HostInstance>();
 const root = Fantom.createRoot();

 Fantom.runTask(() => {
 root.render(<View ref={ref} />);
 });

 const element = ensureReactNativeElement(
 ref.current,
 ) as MaybeEventTarget;
 const listener = jest.fn();

 element.addEventListener?.('custom', listener);
 const result = element.dispatchEvent?.(new Event('custom'));

 expect(listener).toHaveBeenCalledTimes(1);
 expect(result).toBe(true);

 element.removeEventListener?.('custom', listener);
 element.dispatchEvent?.(new Event('custom'));

 expect(listener).toHaveBeenCalledTimes(1);
 });
 });
 }
 });

 describe('global constructors', () => {
 it('throws when constructing HTMLElement', () => {
 expect(() => new HTMLElement()).toThrow(
Expand Down

63 changes: 63 additions & 0 deletions
packages/react-native/src/private/webapis/dom/nodes/__tests__/ReadOnlyText-itest.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,8 @@
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *
 * @fantom_flags enableNativeEventTargetEventDispatching:true
 * @fantom_flags enableImperativeEvents:*
 * @flow strict-local
 * @format
 */
Expand All@@ -18,6 +20,7 @@ import invariant from 'invariant';
import * as React from 'react';
import {createRef} from 'react';
import {NativeText} from 'react-native/Libraries/Text/TextNativeComponent';
import * as ReactNativeFeatureFlags from 'react-native/src/private/featureflags/ReactNativeFeatureFlags';
import ReactNativeElement from 'react-native/src/private/webapis/dom/nodes/ReactNativeElement';
import ReadOnlyNode from 'react-native/src/private/webapis/dom/nodes/ReadOnlyNode';
import ReadOnlyText from 'react-native/src/private/webapis/dom/nodes/ReadOnlyText';
Expand All@@ -34,6 +37,17 @@ function ensureReactNativeElement(value: unknown): ReactNativeElement {
 return ensureInstance(value, ReactNativeElement);
}

// The public imperative EventTarget API is not part of the static type of this
// final class (it is only present at runtime, gated by feature flags), so we
// cast to an interface with optional members to inspect it without Flow errors.
// Optional members make this a valid upcast and let us assert both presence
// (`'function'`) and absence (`'undefined'`).
type MaybeEventTarget = interface {
 addEventListener?: unknown,
 removeEventListener?: unknown,
 dispatchEvent?: unknown,
};

describe('ReadOnlyText', () => {
 it('should be used to create public text instances', () => {
 const parentNodeRef = createRef<HostInstance>();
Expand DownExpand Up@@ -332,6 +346,55 @@ describe('ReadOnlyText', () => {
 });
 });

 describe('imperative EventTarget API', () => {
 // These tests run with `enableNativeEventTargetEventDispatching:true` and
 // `enableImperativeEvents:*` (see the `@fantom_flags` pragmas). The public
 // EventTarget API is gated behind `enableImperativeEvents`: when it is off
 // the methods are removed from this final class, when it is on they are
 // available.
 if (!ReactNativeFeatureFlags.enableImperativeEvents()) {
 it('removes the public EventTarget methods when `enableImperativeEvents` is off (default)', () => {
 const parentNodeRef = createRef<HostInstance>();

 const root = Fantom.createRoot();

 Fantom.runTask(() => {
 root.render(<NativeText ref={parentNodeRef}>Some text</NativeText>);
 });

 const parentNode = ensureReadOnlyNode(parentNodeRef.current);
 const textNode = ensureReadOnlyText(
 parentNode.childNodes[0],
 ) as MaybeEventTarget;

 expect(typeof textNode.addEventListener).toBe('undefined');
 expect(typeof textNode.removeEventListener).toBe('undefined');
 expect(typeof textNode.dispatchEvent).toBe('undefined');
 });
 }

 if (ReactNativeFeatureFlags.enableImperativeEvents()) {
 it('exposes the public EventTarget methods when `enableImperativeEvents` is on', () => {
 const parentNodeRef = createRef<HostInstance>();

 const root = Fantom.createRoot();

 Fantom.runTask(() => {
 root.render(<NativeText ref={parentNodeRef}>Some text</NativeText>);
 });

 const parentNode = ensureReadOnlyNode(parentNodeRef.current);
 const textNode = ensureReadOnlyText(
 parentNode.childNodes[0],
 ) as MaybeEventTarget;

 expect(typeof textNode.addEventListener).toBe('function');
 expect(typeof textNode.removeEventListener).toBe('function');
 expect(typeof textNode.dispatchEvent).toBe('function');
 });
 }
 });

 describe('global constructors', () => {
 it('throws when constructing Text', () => {
 expect(() => new Text()).toThrow(
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Gate the public EventTarget API on ReactNativeElement and ReadOnlyText behind enableImperativeEvents (#57088)#57088

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.

 Sign up for GitHub

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

 Closed

rubennorte
wants to merge
1
commit into

from

 Closed


Gate the public EventTarget API on ReactNativeElement and ReadOnlyText behind enableImperativeEvents (#57088)
#57088
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


10 changes: 10 additions & 0 deletions
packages/react-native/scripts/featureflags/ReactNativeFeatureFlags.config.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1036,6 +1036,16 @@ const definitions: FeatureFlagDefinitions = {
 },
 ossReleaseStage: 'none',
 },
 enableImperativeEvents: {
 defaultValue: false,
 metadata: {
 description:
 'When enabled, ReactNativeElement and ReadOnlyText expose the public EventTarget API (addEventListener, removeEventListener, dispatchEvent). When disabled, those methods are removed from those final classes.',
 expectedReleaseValue: true,
 purpose: 'release',
 },
 ossReleaseStage: 'none',
 },
 enableNativeEventTargetEventDispatching: {
 defaultValue: false,
 metadata: {
Expand Down

8 changes: 7 additions & 1 deletion
packages/react-native/src/private/featureflags/ReactNativeFeatureFlags.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *
 * @generated SignedSource<<77b178e216aa86a309f46cbf661d9122>>
 * @generated SignedSource<<9ea39238fb9e7a4fd17f5c6a4f557e8c>>
 * @flow strict
 * @noformat
 */
Expand DownExpand Up@@ -33,6 +33,7 @@ export type ReactNativeFeatureFlagsJsOnly = $ReadOnly<{
 animatedShouldSyncValueBeforeStartCallback: Getter<boolean>,
 animatedShouldUseSingleOp: Getter<boolean>,
 deferFlatListFocusChangeRenderUpdate: Getter<boolean>,
 enableImperativeEvents: Getter<boolean>,
 enableNativeEventTargetEventDispatching: Getter<boolean>,
 externalElementInspectionEnabled: Getter<boolean>,
 fixVirtualizeListCollapseWindowSize: Getter<boolean>,
Expand DownExpand Up@@ -162,6 +163,11 @@ export const animatedShouldUseSingleOp: Getter<boolean> = createJavaScriptFlagGe
 */
export const deferFlatListFocusChangeRenderUpdate: Getter<boolean> = createJavaScriptFlagGetter('deferFlatListFocusChangeRenderUpdate', false);

/**
 * When enabled, ReactNativeElement and ReadOnlyText expose the public EventTarget API (addEventListener, removeEventListener, dispatchEvent). When disabled, those methods are removed from those final classes.
 */
export const enableImperativeEvents: Getter<boolean> = createJavaScriptFlagGetter('enableImperativeEvents', false);

/**
 * When enabled, the React Native renderer dispatches events through the W3C EventTarget API (addEventListener/dispatchEvent) instead of the legacy plugin-based system.
 */
Expand Down

16 changes: 11 additions & 5 deletions
packages/react-native/src/private/renderer/core/__tests__/EventTargetDispatching-itest.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@
 * LICENSE file in the root directory of this source tree.
 *
 * @fantom_flags enableNativeEventTargetEventDispatching:*
 * @fantom_flags enableImperativeEvents:*
 * @flow strict-local
 * @format
 */
Expand DownExpand Up@@ -465,10 +466,13 @@ const {isOSS} = Fantom.getConstants();
 });

 // --- addEventListener / removeEventListener on refs ---
 // These tests require EventTarget-based dispatching to be enabled,
 // since addEventListener is only available when the flag is on.
 // These tests require both `enableNativeEventTargetEventDispatching` and
 // `enableImperativeEvents` to be enabled, since the public `addEventListener`
 // API on element refs is only available when both flags are on. They are
 // skipped for the other flag combinations.

 (ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching()
 (ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching() &&
 ReactNativeFeatureFlags.enableImperativeEvents()
 ? describe
 : describe.skip)('addEventListener / removeEventListener', () => {
 it('addEventListener on a ref receives dispatched events', () => {
Expand DownExpand Up@@ -915,7 +919,8 @@ const {isOSS} = Fantom.getConstants();
 },
 );

 (ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching()
 (ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching() &&
 ReactNativeFeatureFlags.enableImperativeEvents()
 ? it
 : it.skip)(
 'direct (non-bubbling) events do not propagate via addEventListener',
Expand DownExpand Up@@ -964,7 +969,8 @@ const {isOSS} = Fantom.getConstants();
 },
 );

 (ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching()
 (ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching() &&
 ReactNativeFeatureFlags.enableImperativeEvents()
 ? describe
 : describe.skip)('bubbling to document element and document', () => {
 it('event bubbles from child up to the document element', () => {
Expand Down

21 changes: 21 additions & 0 deletions
packages/react-native/src/private/webapis/dom/nodes/ReactNativeElement.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -354,3 +354,24 @@ export const ReactNativeElement_public: typeof ReactNativeElement =

// $FlowExpectedError[prop-missing]
ReactNativeElement_public.prototype = ReactNativeElement.prototype;

// The public imperative EventTarget API (`addEventListener`,
// `removeEventListener`, `dispatchEvent`) is only inherited by this final class
// when `enableNativeEventTargetEventDispatching` is enabled (which makes
// `ReadOnlyNode` extend `EventTarget`). Until that public API is finalized, it
// is gated behind `enableImperativeEvents`: when that flag is off we remove
// those methods from this final class. Native/internal event dispatch does not
// rely on these public methods, so removing them is safe.
if (
 ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching() &&
 !ReactNativeFeatureFlags.enableImperativeEvents()
) {
 const prototype: interface {
 addEventListener?: unknown,
 removeEventListener?: unknown,
 dispatchEvent?: unknown,
 } = ReactNativeElement.prototype;
 prototype.addEventListener = undefined;
 prototype.removeEventListener = undefined;
 prototype.dispatchEvent = undefined;
}

22 changes: 22 additions & 0 deletions
packages/react-native/src/private/webapis/dom/nodes/ReadOnlyText.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@

// flowlint unsafe-getters-setters:off

import * as ReactNativeFeatureFlags from '../../../featureflags/ReactNativeFeatureFlags';
import ReadOnlyCharacterData from './ReadOnlyCharacterData';
import ReadOnlyNode from './ReadOnlyNode';

Expand DownExpand Up@@ -39,3 +40,24 @@ export const ReadOnlyText_public: typeof ReadOnlyText =

// $FlowExpectedError[prop-missing]
ReadOnlyText_public.prototype = ReadOnlyText.prototype;

// The public imperative EventTarget API (`addEventListener`,
// `removeEventListener`, `dispatchEvent`) is only inherited by this final class
// when `enableNativeEventTargetEventDispatching` is enabled (which makes
// `ReadOnlyNode` extend `EventTarget`). Until that public API is finalized, it
// is gated behind `enableImperativeEvents`: when that flag is off we remove
// those methods from this final class. Native/internal event dispatch does not
// rely on these public methods, so removing them is safe.
if (
 ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching() &&
 !ReactNativeFeatureFlags.enableImperativeEvents()
) {
 const prototype: interface {
 addEventListener?: unknown,
 removeEventListener?: unknown,
 dispatchEvent?: unknown,
 } = ReadOnlyText.prototype;
 prototype.addEventListener = undefined;
 prototype.removeEventListener = undefined;
 prototype.dispatchEvent = undefined;
}

120 changes: 120 additions & 0 deletions
packages/react-native/src/private/webapis/dom/nodes/__tests__/ReactNativeElement-itest.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,8 @@
 * LICENSE file in the root directory of this source tree.
 *
 * @fantom_flags enableFabricCommitBranching:*
 * @fantom_flags enableNativeEventTargetEventDispatching:true
 * @fantom_flags enableImperativeEvents:*
 * @flow strict-local
 * @format
 */
Expand All@@ -23,6 +25,8 @@ import {
 NativeText,
 NativeVirtualText,
} from 'react-native/Libraries/Text/TextNativeComponent';
import * as ReactNativeFeatureFlags from 'react-native/src/private/featureflags/ReactNativeFeatureFlags';
import Event from 'react-native/src/private/webapis/dom/events/Event';
import ReactNativeElement from 'react-native/src/private/webapis/dom/nodes/ReactNativeElement';
import ReadOnlyElement from 'react-native/src/private/webapis/dom/nodes/ReadOnlyElement';
import ReadOnlyNode from 'react-native/src/private/webapis/dom/nodes/ReadOnlyNode';
Expand All@@ -33,6 +37,20 @@ function ensureReactNativeElement(value: unknown): ReactNativeElement {
 return ensureInstance(value, ReactNativeElement);
}

// The public imperative EventTarget API is not part of the static type of this
// final class (it is only present at runtime, gated by feature flags), so we
// cast to an interface with optional members to inspect/use it without Flow
// errors. Optional members make this a valid upcast and let us assert both
// presence (`'function'`) and absence (`'undefined'`).
type MaybeEventTarget = interface {
 addEventListener?: (type: string, callback: (event: Event) => void) => void,
 removeEventListener?: (
 type: string,
 callback: (event: Event) => void,
 ) => void,
 dispatchEvent?: (event: Event) => boolean,
};

/* eslint-disable no-bitwise */

describe('ReactNativeElement', () => {
Expand DownExpand Up@@ -1632,6 +1650,108 @@ describe('ReactNativeElement', () => {
 });
 });

 describe('imperative EventTarget API', () => {
 // These tests run with `enableNativeEventTargetEventDispatching:true` and
 // `enableImperativeEvents:*` (see the `@fantom_flags` pragmas). The public
 // EventTarget API is gated behind `enableImperativeEvents`: when it is off
 // the methods are removed from this final class, when it is on they are
 // available.
 const {isOSS} = Fantom.getConstants();

 if (!ReactNativeFeatureFlags.enableImperativeEvents()) {
 describe('when `enableImperativeEvents` is off (default)', () => {
 it('removes the public EventTarget methods', () => {
 const ref = createRef<HostInstance>();
 const root = Fantom.createRoot();

 Fantom.runTask(() => {
 root.render(<View ref={ref} />);
 });

 const element = ensureReactNativeElement(
 ref.current,
 ) as MaybeEventTarget;
 expect(typeof element.addEventListener).toBe('undefined');
 expect(typeof element.removeEventListener).toBe('undefined');
 expect(typeof element.dispatchEvent).toBe('undefined');
 });

 // Removing the public API must not affect native/prop event delivery,
 // which goes through the internal (symbol-keyed) dispatch path.
 (isOSS ? it.skip : it)(
 'still delivers native events to prop handlers',
 () => {
 const ref = createRef<HostInstance>();
 const onPointerUp = jest.fn();
 const root = Fantom.createRoot();

 Fantom.runTask(() => {
 root.render(<View ref={ref} onPointerUp={onPointerUp} />);
 });

 expect(onPointerUp).toHaveBeenCalledTimes(0);

 Fantom.dispatchNativeEvent(
 ref,
 'onPointerUp',
 {x: 0, y: 0},
 {
 category: Fantom.NativeEventCategory.Discrete,
 },
 );

 expect(onPointerUp).toHaveBeenCalledTimes(1);
 },
 );
 });
 }

 if (ReactNativeFeatureFlags.enableImperativeEvents()) {
 describe('when `enableImperativeEvents` is on', () => {
 it('exposes the public EventTarget methods', () => {
 const ref = createRef<HostInstance>();
 const root = Fantom.createRoot();

 Fantom.runTask(() => {
 root.render(<View ref={ref} />);
 });

 const element = ensureReactNativeElement(
 ref.current,
 ) as MaybeEventTarget;
 expect(typeof element.addEventListener).toBe('function');
 expect(typeof element.removeEventListener).toBe('function');
 expect(typeof element.dispatchEvent).toBe('function');
 });

 it('round-trips a listener via `addEventListener` + `dispatchEvent`', () => {
 const ref = createRef<HostInstance>();
 const root = Fantom.createRoot();

 Fantom.runTask(() => {
 root.render(<View ref={ref} />);
 });

 const element = ensureReactNativeElement(
 ref.current,
 ) as MaybeEventTarget;
 const listener = jest.fn();

 element.addEventListener?.('custom', listener);
 const result = element.dispatchEvent?.(new Event('custom'));

 expect(listener).toHaveBeenCalledTimes(1);
 expect(result).toBe(true);

 element.removeEventListener?.('custom', listener);
 element.dispatchEvent?.(new Event('custom'));

 expect(listener).toHaveBeenCalledTimes(1);
 });
 });
 }
 });

 describe('global constructors', () => {
 it('throws when constructing HTMLElement', () => {
 expect(() => new HTMLElement()).toThrow(
Expand Down

63 changes: 63 additions & 0 deletions
packages/react-native/src/private/webapis/dom/nodes/__tests__/ReadOnlyText-itest.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,8 @@
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *
 * @fantom_flags enableNativeEventTargetEventDispatching:true
 * @fantom_flags enableImperativeEvents:*
 * @flow strict-local
 * @format
 */
Expand All@@ -18,6 +20,7 @@ import invariant from 'invariant';
import * as React from 'react';
import {createRef} from 'react';
import {NativeText} from 'react-native/Libraries/Text/TextNativeComponent';
import * as ReactNativeFeatureFlags from 'react-native/src/private/featureflags/ReactNativeFeatureFlags';
import ReactNativeElement from 'react-native/src/private/webapis/dom/nodes/ReactNativeElement';
import ReadOnlyNode from 'react-native/src/private/webapis/dom/nodes/ReadOnlyNode';
import ReadOnlyText from 'react-native/src/private/webapis/dom/nodes/ReadOnlyText';
Expand All@@ -34,6 +37,17 @@ function ensureReactNativeElement(value: unknown): ReactNativeElement {
 return ensureInstance(value, ReactNativeElement);
}

// The public imperative EventTarget API is not part of the static type of this
// final class (it is only present at runtime, gated by feature flags), so we
// cast to an interface with optional members to inspect it without Flow errors.
// Optional members make this a valid upcast and let us assert both presence
// (`'function'`) and absence (`'undefined'`).
type MaybeEventTarget = interface {
 addEventListener?: unknown,
 removeEventListener?: unknown,
 dispatchEvent?: unknown,
};

describe('ReadOnlyText', () => {
 it('should be used to create public text instances', () => {
 const parentNodeRef = createRef<HostInstance>();
Expand DownExpand Up@@ -332,6 +346,55 @@ describe('ReadOnlyText', () => {
 });
 });

 describe('imperative EventTarget API', () => {
 // These tests run with `enableNativeEventTargetEventDispatching:true` and
 // `enableImperativeEvents:*` (see the `@fantom_flags` pragmas). The public
 // EventTarget API is gated behind `enableImperativeEvents`: when it is off
 // the methods are removed from this final class, when it is on they are
 // available.
 if (!ReactNativeFeatureFlags.enableImperativeEvents()) {
 it('removes the public EventTarget methods when `enableImperativeEvents` is off (default)', () => {
 const parentNodeRef = createRef<HostInstance>();

 const root = Fantom.createRoot();

 Fantom.runTask(() => {
 root.render(<NativeText ref={parentNodeRef}>Some text</NativeText>);
 });

 const parentNode = ensureReadOnlyNode(parentNodeRef.current);
 const textNode = ensureReadOnlyText(
 parentNode.childNodes[0],
 ) as MaybeEventTarget;

 expect(typeof textNode.addEventListener).toBe('undefined');
 expect(typeof textNode.removeEventListener).toBe('undefined');
 expect(typeof textNode.dispatchEvent).toBe('undefined');
 });
 }

 if (ReactNativeFeatureFlags.enableImperativeEvents()) {
 it('exposes the public EventTarget methods when `enableImperativeEvents` is on', () => {
 const parentNodeRef = createRef<HostInstance>();

 const root = Fantom.createRoot();

 Fantom.runTask(() => {
 root.render(<NativeText ref={parentNodeRef}>Some text</NativeText>);
 });

 const parentNode = ensureReadOnlyNode(parentNodeRef.current);
 const textNode = ensureReadOnlyText(
 parentNode.childNodes[0],
 ) as MaybeEventTarget;

 expect(typeof textNode.addEventListener).toBe('function');
 expect(typeof textNode.removeEventListener).toBe('function');
 expect(typeof textNode.dispatchEvent).toBe('function');
 });
 }
 });

 describe('global constructors', () => {
 it('throws when constructing Text', () => {
 expect(() => new Text()).toThrow(
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Gate the public EventTarget API on ReactNativeElement and ReadOnlyText behind enableImperativeEvents (#57088)#57088

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.

 Sign up for GitHub

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

 Closed

rubennorte
wants to merge
1
commit into

from

 Closed


Gate the public EventTarget API on ReactNativeElement and ReadOnlyText behind enableImperativeEvents (#57088)
#57088
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


10 changes: 10 additions & 0 deletions
packages/react-native/scripts/featureflags/ReactNativeFeatureFlags.config.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1036,6 +1036,16 @@ const definitions: FeatureFlagDefinitions = {
 },
 ossReleaseStage: 'none',
 },
 enableImperativeEvents: {
 defaultValue: false,
 metadata: {
 description:
 'When enabled, ReactNativeElement and ReadOnlyText expose the public EventTarget API (addEventListener, removeEventListener, dispatchEvent). When disabled, those methods are removed from those final classes.',
 expectedReleaseValue: true,
 purpose: 'release',
 },
 ossReleaseStage: 'none',
 },
 enableNativeEventTargetEventDispatching: {
 defaultValue: false,
 metadata: {
Expand Down

8 changes: 7 additions & 1 deletion
packages/react-native/src/private/featureflags/ReactNativeFeatureFlags.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *
 * @generated SignedSource<<77b178e216aa86a309f46cbf661d9122>>
 * @generated SignedSource<<9ea39238fb9e7a4fd17f5c6a4f557e8c>>
 * @flow strict
 * @noformat
 */
Expand DownExpand Up@@ -33,6 +33,7 @@ export type ReactNativeFeatureFlagsJsOnly = $ReadOnly<{
 animatedShouldSyncValueBeforeStartCallback: Getter<boolean>,
 animatedShouldUseSingleOp: Getter<boolean>,
 deferFlatListFocusChangeRenderUpdate: Getter<boolean>,
 enableImperativeEvents: Getter<boolean>,
 enableNativeEventTargetEventDispatching: Getter<boolean>,
 externalElementInspectionEnabled: Getter<boolean>,
 fixVirtualizeListCollapseWindowSize: Getter<boolean>,
Expand DownExpand Up@@ -162,6 +163,11 @@ export const animatedShouldUseSingleOp: Getter<boolean> = createJavaScriptFlagGe
 */
export const deferFlatListFocusChangeRenderUpdate: Getter<boolean> = createJavaScriptFlagGetter('deferFlatListFocusChangeRenderUpdate', false);

/**
 * When enabled, ReactNativeElement and ReadOnlyText expose the public EventTarget API (addEventListener, removeEventListener, dispatchEvent). When disabled, those methods are removed from those final classes.
 */
export const enableImperativeEvents: Getter<boolean> = createJavaScriptFlagGetter('enableImperativeEvents', false);

/**
 * When enabled, the React Native renderer dispatches events through the W3C EventTarget API (addEventListener/dispatchEvent) instead of the legacy plugin-based system.
 */
Expand Down

16 changes: 11 additions & 5 deletions
packages/react-native/src/private/renderer/core/__tests__/EventTargetDispatching-itest.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@
 * LICENSE file in the root directory of this source tree.
 *
 * @fantom_flags enableNativeEventTargetEventDispatching:*
 * @fantom_flags enableImperativeEvents:*
 * @flow strict-local
 * @format
 */
Expand DownExpand Up@@ -465,10 +466,13 @@ const {isOSS} = Fantom.getConstants();
 });

 // --- addEventListener / removeEventListener on refs ---
 // These tests require EventTarget-based dispatching to be enabled,
 // since addEventListener is only available when the flag is on.
 // These tests require both `enableNativeEventTargetEventDispatching` and
 // `enableImperativeEvents` to be enabled, since the public `addEventListener`
 // API on element refs is only available when both flags are on. They are
 // skipped for the other flag combinations.

 (ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching()
 (ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching() &&
 ReactNativeFeatureFlags.enableImperativeEvents()
 ? describe
 : describe.skip)('addEventListener / removeEventListener', () => {
 it('addEventListener on a ref receives dispatched events', () => {
Expand DownExpand Up@@ -915,7 +919,8 @@ const {isOSS} = Fantom.getConstants();
 },
 );

 (ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching()
 (ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching() &&
 ReactNativeFeatureFlags.enableImperativeEvents()
 ? it
 : it.skip)(
 'direct (non-bubbling) events do not propagate via addEventListener',
Expand DownExpand Up@@ -964,7 +969,8 @@ const {isOSS} = Fantom.getConstants();
 },
 );

 (ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching()
 (ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching() &&
 ReactNativeFeatureFlags.enableImperativeEvents()
 ? describe
 : describe.skip)('bubbling to document element and document', () => {
 it('event bubbles from child up to the document element', () => {
Expand Down

21 changes: 21 additions & 0 deletions
packages/react-native/src/private/webapis/dom/nodes/ReactNativeElement.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -354,3 +354,24 @@ export const ReactNativeElement_public: typeof ReactNativeElement =

// $FlowExpectedError[prop-missing]
ReactNativeElement_public.prototype = ReactNativeElement.prototype;

// The public imperative EventTarget API (`addEventListener`,
// `removeEventListener`, `dispatchEvent`) is only inherited by this final class
// when `enableNativeEventTargetEventDispatching` is enabled (which makes
// `ReadOnlyNode` extend `EventTarget`). Until that public API is finalized, it
// is gated behind `enableImperativeEvents`: when that flag is off we remove
// those methods from this final class. Native/internal event dispatch does not
// rely on these public methods, so removing them is safe.
if (
 ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching() &&
 !ReactNativeFeatureFlags.enableImperativeEvents()
) {
 const prototype: interface {
 addEventListener?: unknown,
 removeEventListener?: unknown,
 dispatchEvent?: unknown,
 } = ReactNativeElement.prototype;
 prototype.addEventListener = undefined;
 prototype.removeEventListener = undefined;
 prototype.dispatchEvent = undefined;
}

22 changes: 22 additions & 0 deletions
packages/react-native/src/private/webapis/dom/nodes/ReadOnlyText.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@

// flowlint unsafe-getters-setters:off

import * as ReactNativeFeatureFlags from '../../../featureflags/ReactNativeFeatureFlags';
import ReadOnlyCharacterData from './ReadOnlyCharacterData';
import ReadOnlyNode from './ReadOnlyNode';

Expand DownExpand Up@@ -39,3 +40,24 @@ export const ReadOnlyText_public: typeof ReadOnlyText =

// $FlowExpectedError[prop-missing]
ReadOnlyText_public.prototype = ReadOnlyText.prototype;

// The public imperative EventTarget API (`addEventListener`,
// `removeEventListener`, `dispatchEvent`) is only inherited by this final class
// when `enableNativeEventTargetEventDispatching` is enabled (which makes
// `ReadOnlyNode` extend `EventTarget`). Until that public API is finalized, it
// is gated behind `enableImperativeEvents`: when that flag is off we remove
// those methods from this final class. Native/internal event dispatch does not
// rely on these public methods, so removing them is safe.
if (
 ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching() &&
 !ReactNativeFeatureFlags.enableImperativeEvents()
) {
 const prototype: interface {
 addEventListener?: unknown,
 removeEventListener?: unknown,
 dispatchEvent?: unknown,
 } = ReadOnlyText.prototype;
 prototype.addEventListener = undefined;
 prototype.removeEventListener = undefined;
 prototype.dispatchEvent = undefined;
}

120 changes: 120 additions & 0 deletions
packages/react-native/src/private/webapis/dom/nodes/__tests__/ReactNativeElement-itest.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,8 @@
 * LICENSE file in the root directory of this source tree.
 *
 * @fantom_flags enableFabricCommitBranching:*
 * @fantom_flags enableNativeEventTargetEventDispatching:true
 * @fantom_flags enableImperativeEvents:*
 * @flow strict-local
 * @format
 */
Expand All@@ -23,6 +25,8 @@ import {
 NativeText,
 NativeVirtualText,
} from 'react-native/Libraries/Text/TextNativeComponent';
import * as ReactNativeFeatureFlags from 'react-native/src/private/featureflags/ReactNativeFeatureFlags';
import Event from 'react-native/src/private/webapis/dom/events/Event';
import ReactNativeElement from 'react-native/src/private/webapis/dom/nodes/ReactNativeElement';
import ReadOnlyElement from 'react-native/src/private/webapis/dom/nodes/ReadOnlyElement';
import ReadOnlyNode from 'react-native/src/private/webapis/dom/nodes/ReadOnlyNode';
Expand All@@ -33,6 +37,20 @@ function ensureReactNativeElement(value: unknown): ReactNativeElement {
 return ensureInstance(value, ReactNativeElement);
}

// The public imperative EventTarget API is not part of the static type of this
// final class (it is only present at runtime, gated by feature flags), so we
// cast to an interface with optional members to inspect/use it without Flow
// errors. Optional members make this a valid upcast and let us assert both
// presence (`'function'`) and absence (`'undefined'`).
type MaybeEventTarget = interface {
 addEventListener?: (type: string, callback: (event: Event) => void) => void,
 removeEventListener?: (
 type: string,
 callback: (event: Event) => void,
 ) => void,
 dispatchEvent?: (event: Event) => boolean,
};

/* eslint-disable no-bitwise */

describe('ReactNativeElement', () => {
Expand DownExpand Up@@ -1632,6 +1650,108 @@ describe('ReactNativeElement', () => {
 });
 });

 describe('imperative EventTarget API', () => {
 // These tests run with `enableNativeEventTargetEventDispatching:true` and
 // `enableImperativeEvents:*` (see the `@fantom_flags` pragmas). The public
 // EventTarget API is gated behind `enableImperativeEvents`: when it is off
 // the methods are removed from this final class, when it is on they are
 // available.
 const {isOSS} = Fantom.getConstants();

 if (!ReactNativeFeatureFlags.enableImperativeEvents()) {
 describe('when `enableImperativeEvents` is off (default)', () => {
 it('removes the public EventTarget methods', () => {
 const ref = createRef<HostInstance>();
 const root = Fantom.createRoot();

 Fantom.runTask(() => {
 root.render(<View ref={ref} />);
 });

 const element = ensureReactNativeElement(
 ref.current,
 ) as MaybeEventTarget;
 expect(typeof element.addEventListener).toBe('undefined');
 expect(typeof element.removeEventListener).toBe('undefined');
 expect(typeof element.dispatchEvent).toBe('undefined');
 });

 // Removing the public API must not affect native/prop event delivery,
 // which goes through the internal (symbol-keyed) dispatch path.
 (isOSS ? it.skip : it)(
 'still delivers native events to prop handlers',
 () => {
 const ref = createRef<HostInstance>();
 const onPointerUp = jest.fn();
 const root = Fantom.createRoot();

 Fantom.runTask(() => {
 root.render(<View ref={ref} onPointerUp={onPointerUp} />);
 });

 expect(onPointerUp).toHaveBeenCalledTimes(0);

 Fantom.dispatchNativeEvent(
 ref,
 'onPointerUp',
 {x: 0, y: 0},
 {
 category: Fantom.NativeEventCategory.Discrete,
 },
 );

 expect(onPointerUp).toHaveBeenCalledTimes(1);
 },
 );
 });
 }

 if (ReactNativeFeatureFlags.enableImperativeEvents()) {
 describe('when `enableImperativeEvents` is on', () => {
 it('exposes the public EventTarget methods', () => {
 const ref = createRef<HostInstance>();
 const root = Fantom.createRoot();

 Fantom.runTask(() => {
 root.render(<View ref={ref} />);
 });

 const element = ensureReactNativeElement(
 ref.current,
 ) as MaybeEventTarget;
 expect(typeof element.addEventListener).toBe('function');
 expect(typeof element.removeEventListener).toBe('function');
 expect(typeof element.dispatchEvent).toBe('function');
 });

 it('round-trips a listener via `addEventListener` + `dispatchEvent`', () => {
 const ref = createRef<HostInstance>();
 const root = Fantom.createRoot();

 Fantom.runTask(() => {
 root.render(<View ref={ref} />);
 });

 const element = ensureReactNativeElement(
 ref.current,
 ) as MaybeEventTarget;
 const listener = jest.fn();

 element.addEventListener?.('custom', listener);
 const result = element.dispatchEvent?.(new Event('custom'));

 expect(listener).toHaveBeenCalledTimes(1);
 expect(result).toBe(true);

 element.removeEventListener?.('custom', listener);
 element.dispatchEvent?.(new Event('custom'));

 expect(listener).toHaveBeenCalledTimes(1);
 });
 });
 }
 });

 describe('global constructors', () => {
 it('throws when constructing HTMLElement', () => {
 expect(() => new HTMLElement()).toThrow(
Expand Down

63 changes: 63 additions & 0 deletions
packages/react-native/src/private/webapis/dom/nodes/__tests__/ReadOnlyText-itest.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,8 @@
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *
 * @fantom_flags enableNativeEventTargetEventDispatching:true
 * @fantom_flags enableImperativeEvents:*
 * @flow strict-local
 * @format
 */
Expand All@@ -18,6 +20,7 @@ import invariant from 'invariant';
import * as React from 'react';
import {createRef} from 'react';
import {NativeText} from 'react-native/Libraries/Text/TextNativeComponent';
import * as ReactNativeFeatureFlags from 'react-native/src/private/featureflags/ReactNativeFeatureFlags';
import ReactNativeElement from 'react-native/src/private/webapis/dom/nodes/ReactNativeElement';
import ReadOnlyNode from 'react-native/src/private/webapis/dom/nodes/ReadOnlyNode';
import ReadOnlyText from 'react-native/src/private/webapis/dom/nodes/ReadOnlyText';
Expand All@@ -34,6 +37,17 @@ function ensureReactNativeElement(value: unknown): ReactNativeElement {
 return ensureInstance(value, ReactNativeElement);
}

// The public imperative EventTarget API is not part of the static type of this
// final class (it is only present at runtime, gated by feature flags), so we
// cast to an interface with optional members to inspect it without Flow errors.
// Optional members make this a valid upcast and let us assert both presence
// (`'function'`) and absence (`'undefined'`).
type MaybeEventTarget = interface {
 addEventListener?: unknown,
 removeEventListener?: unknown,
 dispatchEvent?: unknown,
};

describe('ReadOnlyText', () => {
 it('should be used to create public text instances', () => {
 const parentNodeRef = createRef<HostInstance>();
Expand DownExpand Up@@ -332,6 +346,55 @@ describe('ReadOnlyText', () => {
 });
 });

 describe('imperative EventTarget API', () => {
 // These tests run with `enableNativeEventTargetEventDispatching:true` and
 // `enableImperativeEvents:*` (see the `@fantom_flags` pragmas). The public
 // EventTarget API is gated behind `enableImperativeEvents`: when it is off
 // the methods are removed from this final class, when it is on they are
 // available.
 if (!ReactNativeFeatureFlags.enableImperativeEvents()) {
 it('removes the public EventTarget methods when `enableImperativeEvents` is off (default)', () => {
 const parentNodeRef = createRef<HostInstance>();

 const root = Fantom.createRoot();

 Fantom.runTask(() => {
 root.render(<NativeText ref={parentNodeRef}>Some text</NativeText>);
 });

 const parentNode = ensureReadOnlyNode(parentNodeRef.current);
 const textNode = ensureReadOnlyText(
 parentNode.childNodes[0],
 ) as MaybeEventTarget;

 expect(typeof textNode.addEventListener).toBe('undefined');
 expect(typeof textNode.removeEventListener).toBe('undefined');
 expect(typeof textNode.dispatchEvent).toBe('undefined');
 });
 }

 if (ReactNativeFeatureFlags.enableImperativeEvents()) {
 it('exposes the public EventTarget methods when `enableImperativeEvents` is on', () => {
 const parentNodeRef = createRef<HostInstance>();

 const root = Fantom.createRoot();

 Fantom.runTask(() => {
 root.render(<NativeText ref={parentNodeRef}>Some text</NativeText>);
 });

 const parentNode = ensureReadOnlyNode(parentNodeRef.current);
 const textNode = ensureReadOnlyText(
 parentNode.childNodes[0],
 ) as MaybeEventTarget;

 expect(typeof textNode.addEventListener).toBe('function');
 expect(typeof textNode.removeEventListener).toBe('function');
 expect(typeof textNode.dispatchEvent).toBe('function');
 });
 }
 });

 describe('global constructors', () => {
 it('throws when constructing Text', () => {
 expect(() => new Text()).toThrow(
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Gate the public EventTarget API on ReactNativeElement and ReadOnlyText behind enableImperativeEvents (#57088)#57088

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.

 Sign up for GitHub

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

 Closed

rubennorte
wants to merge
1
commit into

from

 Closed


Gate the public EventTarget API on ReactNativeElement and ReadOnlyText behind enableImperativeEvents (#57088)
#57088
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


10 changes: 10 additions & 0 deletions
packages/react-native/scripts/featureflags/ReactNativeFeatureFlags.config.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1036,6 +1036,16 @@ const definitions: FeatureFlagDefinitions = {
 },
 ossReleaseStage: 'none',
 },
 enableImperativeEvents: {
 defaultValue: false,
 metadata: {
 description:
 'When enabled, ReactNativeElement and ReadOnlyText expose the public EventTarget API (addEventListener, removeEventListener, dispatchEvent). When disabled, those methods are removed from those final classes.',
 expectedReleaseValue: true,
 purpose: 'release',
 },
 ossReleaseStage: 'none',
 },
 enableNativeEventTargetEventDispatching: {
 defaultValue: false,
 metadata: {
Expand Down

8 changes: 7 additions & 1 deletion
packages/react-native/src/private/featureflags/ReactNativeFeatureFlags.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *
 * @generated SignedSource<<77b178e216aa86a309f46cbf661d9122>>
 * @generated SignedSource<<9ea39238fb9e7a4fd17f5c6a4f557e8c>>
 * @flow strict
 * @noformat
 */
Expand DownExpand Up@@ -33,6 +33,7 @@ export type ReactNativeFeatureFlagsJsOnly = $ReadOnly<{
 animatedShouldSyncValueBeforeStartCallback: Getter<boolean>,
 animatedShouldUseSingleOp: Getter<boolean>,
 deferFlatListFocusChangeRenderUpdate: Getter<boolean>,
 enableImperativeEvents: Getter<boolean>,
 enableNativeEventTargetEventDispatching: Getter<boolean>,
 externalElementInspectionEnabled: Getter<boolean>,
 fixVirtualizeListCollapseWindowSize: Getter<boolean>,
Expand DownExpand Up@@ -162,6 +163,11 @@ export const animatedShouldUseSingleOp: Getter<boolean> = createJavaScriptFlagGe
 */
export const deferFlatListFocusChangeRenderUpdate: Getter<boolean> = createJavaScriptFlagGetter('deferFlatListFocusChangeRenderUpdate', false);

/**
 * When enabled, ReactNativeElement and ReadOnlyText expose the public EventTarget API (addEventListener, removeEventListener, dispatchEvent). When disabled, those methods are removed from those final classes.
 */
export const enableImperativeEvents: Getter<boolean> = createJavaScriptFlagGetter('enableImperativeEvents', false);

/**
 * When enabled, the React Native renderer dispatches events through the W3C EventTarget API (addEventListener/dispatchEvent) instead of the legacy plugin-based system.
 */
Expand Down

16 changes: 11 additions & 5 deletions
packages/react-native/src/private/renderer/core/__tests__/EventTargetDispatching-itest.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@
 * LICENSE file in the root directory of this source tree.
 *
 * @fantom_flags enableNativeEventTargetEventDispatching:*
 * @fantom_flags enableImperativeEvents:*
 * @flow strict-local
 * @format
 */
Expand DownExpand Up@@ -465,10 +466,13 @@ const {isOSS} = Fantom.getConstants();
 });

 // --- addEventListener / removeEventListener on refs ---
 // These tests require EventTarget-based dispatching to be enabled,
 // since addEventListener is only available when the flag is on.
 // These tests require both `enableNativeEventTargetEventDispatching` and
 // `enableImperativeEvents` to be enabled, since the public `addEventListener`
 // API on element refs is only available when both flags are on. They are
 // skipped for the other flag combinations.

 (ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching()
 (ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching() &&
 ReactNativeFeatureFlags.enableImperativeEvents()
 ? describe
 : describe.skip)('addEventListener / removeEventListener', () => {
 it('addEventListener on a ref receives dispatched events', () => {
Expand DownExpand Up@@ -915,7 +919,8 @@ const {isOSS} = Fantom.getConstants();
 },
 );

 (ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching()
 (ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching() &&
 ReactNativeFeatureFlags.enableImperativeEvents()
 ? it
 : it.skip)(
 'direct (non-bubbling) events do not propagate via addEventListener',
Expand DownExpand Up@@ -964,7 +969,8 @@ const {isOSS} = Fantom.getConstants();
 },
 );

 (ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching()
 (ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching() &&
 ReactNativeFeatureFlags.enableImperativeEvents()
 ? describe
 : describe.skip)('bubbling to document element and document', () => {
 it('event bubbles from child up to the document element', () => {
Expand Down

21 changes: 21 additions & 0 deletions
packages/react-native/src/private/webapis/dom/nodes/ReactNativeElement.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -354,3 +354,24 @@ export const ReactNativeElement_public: typeof ReactNativeElement =

// $FlowExpectedError[prop-missing]
ReactNativeElement_public.prototype = ReactNativeElement.prototype;

// The public imperative EventTarget API (`addEventListener`,
// `removeEventListener`, `dispatchEvent`) is only inherited by this final class
// when `enableNativeEventTargetEventDispatching` is enabled (which makes
// `ReadOnlyNode` extend `EventTarget`). Until that public API is finalized, it
// is gated behind `enableImperativeEvents`: when that flag is off we remove
// those methods from this final class. Native/internal event dispatch does not
// rely on these public methods, so removing them is safe.
if (
 ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching() &&
 !ReactNativeFeatureFlags.enableImperativeEvents()
) {
 const prototype: interface {
 addEventListener?: unknown,
 removeEventListener?: unknown,
 dispatchEvent?: unknown,
 } = ReactNativeElement.prototype;
 prototype.addEventListener = undefined;
 prototype.removeEventListener = undefined;
 prototype.dispatchEvent = undefined;
}

22 changes: 22 additions & 0 deletions
packages/react-native/src/private/webapis/dom/nodes/ReadOnlyText.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@

// flowlint unsafe-getters-setters:off

import * as ReactNativeFeatureFlags from '../../../featureflags/ReactNativeFeatureFlags';
import ReadOnlyCharacterData from './ReadOnlyCharacterData';
import ReadOnlyNode from './ReadOnlyNode';

Expand DownExpand Up@@ -39,3 +40,24 @@ export const ReadOnlyText_public: typeof ReadOnlyText =

// $FlowExpectedError[prop-missing]
ReadOnlyText_public.prototype = ReadOnlyText.prototype;

// The public imperative EventTarget API (`addEventListener`,
// `removeEventListener`, `dispatchEvent`) is only inherited by this final class
// when `enableNativeEventTargetEventDispatching` is enabled (which makes
// `ReadOnlyNode` extend `EventTarget`). Until that public API is finalized, it
// is gated behind `enableImperativeEvents`: when that flag is off we remove
// those methods from this final class. Native/internal event dispatch does not
// rely on these public methods, so removing them is safe.
if (
 ReactNativeFeatureFlags.enableNativeEventTargetEventDispatching() &&
 !ReactNativeFeatureFlags.enableImperativeEvents()
) {
 const prototype: interface {
 addEventListener?: unknown,
 removeEventListener?: unknown,
 dispatchEvent?: unknown,
 } = ReadOnlyText.prototype;
 prototype.addEventListener = undefined;
 prototype.removeEventListener = undefined;
 prototype.dispatchEvent = undefined;
}

120 changes: 120 additions & 0 deletions
packages/react-native/src/private/webapis/dom/nodes/__tests__/ReactNativeElement-itest.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,8 @@
 * LICENSE file in the root directory of this source tree.
 *
 * @fantom_flags enableFabricCommitBranching:*
 * @fantom_flags enableNativeEventTargetEventDispatching:true
 * @fantom_flags enableImperativeEvents:*
 * @flow strict-local
 * @format
 */
Expand All@@ -23,6 +25,8 @@ import {
 NativeText,
 NativeVirtualText,
} from 'react-native/Libraries/Text/TextNativeComponent';
import * as ReactNativeFeatureFlags from 'react-native/src/private/featureflags/ReactNativeFeatureFlags';
import Event from 'react-native/src/private/webapis/dom/events/Event';
import ReactNativeElement from 'react-native/src/private/webapis/dom/nodes/ReactNativeElement';
import ReadOnlyElement from 'react-native/src/private/webapis/dom/nodes/ReadOnlyElement';
import ReadOnlyNode from 'react-native/src/private/webapis/dom/nodes/ReadOnlyNode';
Expand All@@ -33,6 +37,20 @@ function ensureReactNativeElement(value: unknown): ReactNativeElement {
 return ensureInstance(value, ReactNativeElement);
}

// The public imperative EventTarget API is not part of the static type of this
// final class (it is only present at runtime, gated by feature flags), so we
// cast to an interface with optional members to inspect/use it without Flow
// errors. Optional members make this a valid upcast and let us assert both
// presence (`'function'`) and absence (`'undefined'`).
type MaybeEventTarget = interface {
 addEventListener?: (type: string, callback: (event: Event) => void) => void,
 removeEventListener?: (
 type: string,
 callback: (event: Event) => void,
 ) => void,
 dispatchEvent?: (event: Event) => boolean,
};

/* eslint-disable no-bitwise */

describe('ReactNativeElement', () => {
Expand DownExpand Up@@ -1632,6 +1650,108 @@ describe('ReactNativeElement', () => {
 });
 });

 describe('imperative EventTarget API', () => {
 // These tests run with `enableNativeEventTargetEventDispatching:true` and
 // `enableImperativeEvents:*` (see the `@fantom_flags` pragmas). The public
 // EventTarget API is gated behind `enableImperativeEvents`: when it is off
 // the methods are removed from this final class, when it is on they are
 // available.
 const {isOSS} = Fantom.getConstants();

 if (!ReactNativeFeatureFlags.enableImperativeEvents()) {
 describe('when `enableImperativeEvents` is off (default)', () => {
 it('removes the public EventTarget methods', () => {
 const ref = createRef<HostInstance>();
 const root = Fantom.createRoot();

 Fantom.runTask(() => {
 root.render(<View ref={ref} />);
 });

 const element = ensureReactNativeElement(
 ref.current,
 ) as MaybeEventTarget;
 expect(typeof element.addEventListener).toBe('undefined');
 expect(typeof element.removeEventListener).toBe('undefined');
 expect(typeof element.dispatchEvent).toBe('undefined');
 });

 // Removing the public API must not affect native/prop event delivery,
 // which goes through the internal (symbol-keyed) dispatch path.
 (isOSS ? it.skip : it)(
 'still delivers native events to prop handlers',
 () => {
 const ref = createRef<HostInstance>();
 const onPointerUp = jest.fn();
 const root = Fantom.createRoot();

 Fantom.runTask(() => {
 root.render(<View ref={ref} onPointerUp={onPointerUp} />);
 });

 expect(onPointerUp).toHaveBeenCalledTimes(0);

 Fantom.dispatchNativeEvent(
 ref,
 'onPointerUp',
 {x: 0, y: 0},
 {
 category: Fantom.NativeEventCategory.Discrete,
 },
 );

 expect(onPointerUp).toHaveBeenCalledTimes(1);
 },
 );
 });
 }

 if (ReactNativeFeatureFlags.enableImperativeEvents()) {
 describe('when `enableImperativeEvents` is on', () => {
 it('exposes the public EventTarget methods', () => {
 const ref = createRef<HostInstance>();
 const root = Fantom.createRoot();

 Fantom.runTask(() => {
 root.render(<View ref={ref} />);
 });

 const element = ensureReactNativeElement(
 ref.current,
 ) as MaybeEventTarget;
 expect(typeof element.addEventListener).toBe('function');
 expect(typeof element.removeEventListener).toBe('function');
 expect(typeof element.dispatchEvent).toBe('function');
 });

 it('round-trips a listener via `addEventListener` + `dispatchEvent`', () => {
 const ref = createRef<HostInstance>();
 const root = Fantom.createRoot();

 Fantom.runTask(() => {
 root.render(<View ref={ref} />);
 });

 const element = ensureReactNativeElement(
 ref.current,
 ) as MaybeEventTarget;
 const listener = jest.fn();

 element.addEventListener?.('custom', listener);
 const result = element.dispatchEvent?.(new Event('custom'));

 expect(listener).toHaveBeenCalledTimes(1);
 expect(result).toBe(true);

 element.removeEventListener?.('custom', listener);
 element.dispatchEvent?.(new Event('custom'));

 expect(listener).toHaveBeenCalledTimes(1);
 });
 });
 }
 });

 describe('global constructors', () => {
 it('throws when constructing HTMLElement', () => {
 expect(() => new HTMLElement()).toThrow(
Expand Down

63 changes: 63 additions & 0 deletions
packages/react-native/src/private/webapis/dom/nodes/__tests__/ReadOnlyText-itest.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,8 @@
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *
 * @fantom_flags enableNativeEventTargetEventDispatching:true
 * @fantom_flags enableImperativeEvents:*
 * @flow strict-local
 * @format
 */
Expand All@@ -18,6 +20,7 @@ import invariant from 'invariant';
import * as React from 'react';
import {createRef} from 'react';
import {NativeText} from 'react-native/Libraries/Text/TextNativeComponent';
import * as ReactNativeFeatureFlags from 'react-native/src/private/featureflags/ReactNativeFeatureFlags';
import ReactNativeElement from 'react-native/src/private/webapis/dom/nodes/ReactNativeElement';
import ReadOnlyNode from 'react-native/src/private/webapis/dom/nodes/ReadOnlyNode';
import ReadOnlyText from 'react-native/src/private/webapis/dom/nodes/ReadOnlyText';
Expand All@@ -34,6 +37,17 @@ function ensureReactNativeElement(value: unknown): ReactNativeElement {
 return ensureInstance(value, ReactNativeElement);
}

// The public imperative EventTarget API is not part of the static type of this
// final class (it is only present at runtime, gated by feature flags), so we
// cast to an interface with optional members to inspect it without Flow errors.
// Optional members make this a valid upcast and let us assert both presence
// (`'function'`) and absence (`'undefined'`).
type MaybeEventTarget = interface {
 addEventListener?: unknown,
 removeEventListener?: unknown,
 dispatchEvent?: unknown,
};

describe('ReadOnlyText', () => {
 it('should be used to create public text instances', () => {
 const parentNodeRef = createRef<HostInstance>();
Expand DownExpand Up@@ -332,6 +346,55 @@ describe('ReadOnlyText', () => {
 });
 });

 describe('imperative EventTarget API', () => {
 // These tests run with `enableNativeEventTargetEventDispatching:true` and
 // `enableImperativeEvents:*` (see the `@fantom_flags` pragmas). The public
 // EventTarget API is gated behind `enableImperativeEvents`: when it is off
 // the methods are removed from this final class, when it is on they are
 // available.
 if (!ReactNativeFeatureFlags.enableImperativeEvents()) {
 it('removes the public EventTarget methods when `enableImperativeEvents` is off (default)', () => {
 const parentNodeRef = createRef<HostInstance>();

 const root = Fantom.createRoot();

 Fantom.runTask(() => {
 root.render(<NativeText ref={parentNodeRef}>Some text</NativeText>);
 });

 const parentNode = ensureReadOnlyNode(parentNodeRef.current);
 const textNode = ensureReadOnlyText(
 parentNode.childNodes[0],
 ) as MaybeEventTarget;

 expect(typeof textNode.addEventListener).toBe('undefined');
 expect(typeof textNode.removeEventListener).toBe('undefined');
 expect(typeof textNode.dispatchEvent).toBe('undefined');
 });
 }

 if (ReactNativeFeatureFlags.enableImperativeEvents()) {
 it('exposes the public EventTarget methods when `enableImperativeEvents` is on', () => {
 const parentNodeRef = createRef<HostInstance>();

 const root = Fantom.createRoot();

 Fantom.runTask(() => {
 root.render(<NativeText ref={parentNodeRef}>Some text</NativeText>);
 });

 const parentNode = ensureReadOnlyNode(parentNodeRef.current);
 const textNode = ensureReadOnlyText(
 parentNode.childNodes[0],
 ) as MaybeEventTarget;

 expect(typeof textNode.addEventListener).toBe('function');
 expect(typeof textNode.removeEventListener).toBe('function');
 expect(typeof textNode.dispatchEvent).toBe('function');
 });
 }
 });

 describe('global constructors', () => {
 it('throws when constructing Text', () => {
 expect(() => new Text()).toThrow(
Expand Down
Loading