Skip to content

Commit 9fe1031

Browse files
trueadmtrueadm
authored
[react-interactions] Rename Flare APIs to deprecated and remove from RN (#17644)
1 parent e84327b commit 9fe1031

File tree

63 files changed

+215
-1304
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

63 files changed

+215
-1304
lines changed

‎packages/legacy-events/ReactGenericBatching.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import {
1010
restoreStateIfNeeded,
1111
} from './ReactControlledComponent';
1212

13-
import {enableFlareAPI} from 'shared/ReactFeatureFlags';
13+
import {enableDeprecatedFlareAPI} from 'shared/ReactFeatureFlags';
1414
import {invokeGuardedCallbackAndCatchFirstError} from 'shared/ReactErrorUtils';
1515

1616
// Used as a way to call batchedUpdates when we don't have a reference to
@@ -118,7 +118,7 @@ export function flushDiscreteUpdatesIfNeeded(timeStamp: number) {
118118
// behaviour as we had before this change, so the risks are low.
119119
if (
120120
!isInsideEventHandler &&
121-
(!enableFlareAPI ||
121+
(!enableDeprecatedFlareAPI ||
122122
(timeStamp === 0 || lastFlushedEventTimeStamp !== timeStamp))
123123
) {
124124
lastFlushedEventTimeStamp = timeStamp;

‎packages/react-art/src/ReactARTHostConfig.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -426,7 +426,7 @@ export function unhideTextInstance(textInstance, text): void {
426426
// Noop
427427
}
428428

429-
export function mountResponderInstance(
429+
export function DEPRECATED_mountResponderInstance(
430430
responder: ReactEventResponder<any, any>,
431431
responderInstance: ReactEventResponderInstance<any, any>,
432432
props: Object,
@@ -436,7 +436,7 @@ export function mountResponderInstance(
436436
throw new Error('Not yet implemented.');
437437
}
438438

439-
export function unmountResponderInstance(
439+
export function DEPRECATED_unmountResponderInstance(
440440
responderInstance: ReactEventResponderInstance<any, any>,
441441
): void {
442442
throw new Error('Not yet implemented.');

‎packages/react-debug-tools/src/__tests__/ReactHooksInspection-test.internal.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,16 @@ describe('ReactHooksInspection', () => {
1717
beforeEach(() => {
1818
jest.resetModules();
1919
const ReactFeatureFlags = require('shared/ReactFeatureFlags');
20-
ReactFeatureFlags.enableFlareAPI = true;
20+
ReactFeatureFlags.enableDeprecatedFlareAPI = true;
2121
React = require('react');
2222
ReactDebugTools = require('react-debug-tools');
2323
});
2424

2525
it('should inspect a simple useResponder hook', () => {
26-
const TestResponder = React.unstable_createResponder('TestResponder', {});
26+
const TestResponder = React.DEPRECATED_createResponder('TestResponder', {});
2727

2828
function Foo(props) {
29-
const listener = React.unstable_useResponder(TestResponder, {
29+
const listener = React.DEPRECATED_useResponder(TestResponder, {
3030
preventDefault: false,
3131
});
3232
return <div DEPRECATED_flareListeners={listener}>Hello world</div>;

‎packages/react-dom/src/__tests__/ReactDOMServerPartialHydration-test.internal.js

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ describe('ReactDOMServerPartialHydration', () => {
7676

7777
ReactFeatureFlags = require('shared/ReactFeatureFlags');
7878
ReactFeatureFlags.enableSuspenseCallback = true;
79-
ReactFeatureFlags.enableFlareAPI = true;
79+
ReactFeatureFlags.enableDeprecatedFlareAPI = true;
8080
ReactFeatureFlags.debugRenderPhaseSideEffectsForStrictMode = false;
8181

8282
React = require('react');
@@ -1885,13 +1885,16 @@ describe('ReactDOMServerPartialHydration', () => {
18851885
}
18861886

18871887
const onEvent = jest.fn();
1888-
const TestResponder = React.unstable_createResponder('TestEventResponder', {
1889-
targetEventTypes: ['click'],
1890-
onEvent,
1891-
});
1888+
const TestResponder = React.DEPRECATED_createResponder(
1889+
'TestEventResponder',
1890+
{
1891+
targetEventTypes: ['click'],
1892+
onEvent,
1893+
},
1894+
);
18921895

18931896
function Button() {
1894-
let listener = React.unstable_useResponder(TestResponder, {});
1897+
let listener = React.DEPRECATED_useResponder(TestResponder, {});
18951898
return <a DEPRECATED_flareListeners={listener}>Click me</a>;
18961899
}
18971900

@@ -2034,13 +2037,16 @@ describe('ReactDOMServerPartialHydration', () => {
20342037
let promise = new Promise(resolvePromise => (resolve = resolvePromise));
20352038

20362039
const onEvent = jest.fn();
2037-
const TestResponder = React.unstable_createResponder('TestEventResponder', {
2038-
targetEventTypes: ['click'],
2039-
onEvent,
2040-
});
2040+
const TestResponder = React.DEPRECATED_createResponder(
2041+
'TestEventResponder',
2042+
{
2043+
targetEventTypes: ['click'],
2044+
onEvent,
2045+
},
2046+
);
20412047

20422048
function Button() {
2043-
let listener = React.unstable_useResponder(TestResponder, {});
2049+
let listener = React.DEPRECATED_useResponder(TestResponder, {});
20442050
return <a DEPRECATED_flareListeners={listener}>Click me</a>;
20452051
}
20462052

‎packages/react-dom/src/client/ReactDOMComponent.js

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import {getCurrentFiberOwnerNameInDevOrNull} from 'react-reconciler/src/ReactCur
1212
import {registrationNameModules} from 'legacy-events/EventPluginRegistry';
1313
import {canUseDOM} from 'shared/ExecutionEnvironment';
1414
import endsWith from 'shared/endsWith';
15-
import {setListenToResponderEventTypes} from '../events/DOMEventResponderSystem';
15+
import {setListenToResponderEventTypes} from '../events/DeprecatedDOMEventResponderSystem';
1616

1717
import {
1818
getValueForAttribute,
@@ -88,7 +88,7 @@ import {validateProperties as validateUnknownProperties} from '../shared/ReactDO
8888
import {toStringOrTrustedType} from './ToStringValue';
8989

9090
import {
91-
enableFlareAPI,
91+
enableDeprecatedFlareAPI,
9292
enableTrustedTypesIntegration,
9393
} from 'shared/ReactFeatureFlags';
9494

@@ -342,7 +342,7 @@ function setInitialDOMProperties(
342342
setTextContent(domElement, '' + nextProp);
343343
}
344344
} else if (
345-
(enableFlareAPI && propKey === DEPRECATED_flareListeners) ||
345+
(enableDeprecatedFlareAPI && propKey === DEPRECATED_flareListeners) ||
346346
propKey === SUPPRESS_CONTENT_EDITABLE_WARNING ||
347347
propKey === SUPPRESS_HYDRATION_WARNING
348348
) {
@@ -709,7 +709,7 @@ export function diffProperties(
709709
} else if (propKey === DANGEROUSLY_SET_INNER_HTML || propKey === CHILDREN) {
710710
// Noop. This is handled by the clear text mechanism.
711711
} else if (
712-
(enableFlareAPI && propKey === DEPRECATED_flareListeners) ||
712+
(enableDeprecatedFlareAPI && propKey === DEPRECATED_flareListeners) ||
713713
propKey === SUPPRESS_CONTENT_EDITABLE_WARNING ||
714714
propKey === SUPPRESS_HYDRATION_WARNING
715715
) {
@@ -804,7 +804,7 @@ export function diffProperties(
804804
(updatePayload = updatePayload || []).push(propKey, '' + nextProp);
805805
}
806806
} else if (
807-
(enableFlareAPI && propKey === DEPRECATED_flareListeners) ||
807+
(enableDeprecatedFlareAPI && propKey === DEPRECATED_flareListeners) ||
808808
propKey === SUPPRESS_CONTENT_EDITABLE_WARNING ||
809809
propKey === SUPPRESS_HYDRATION_WARNING
810810
) {
@@ -1058,7 +1058,7 @@ export function diffHydratedProperties(
10581058
if (suppressHydrationWarning) {
10591059
// Don't bother comparing. We're ignoring all these warnings.
10601060
} else if (
1061-
(enableFlareAPI && propKey === DEPRECATED_flareListeners) ||
1061+
(enableDeprecatedFlareAPI && propKey === DEPRECATED_flareListeners) ||
10621062
propKey === SUPPRESS_CONTENT_EDITABLE_WARNING ||
10631063
propKey === SUPPRESS_HYDRATION_WARNING ||
10641064
// Controlled attributes are not validated
@@ -1298,7 +1298,7 @@ export function listenToEventResponderEventTypes(
12981298
eventTypes: Array<string>,
12991299
document: Document,
13001300
): void {
1301-
if (enableFlareAPI) {
1301+
if (enableDeprecatedFlareAPI) {
13021302
// Get the listening Map for this element. We use this to track
13031303
// what events we're listening to.
13041304
const listenerMap = getListenerMapForElement(document);
@@ -1346,6 +1346,6 @@ export function listenToEventResponderEventTypes(
13461346
}
13471347

13481348
// We can remove this once the event API is stable and out of a flag
1349-
if (enableFlareAPI) {
1349+
if (enableDeprecatedFlareAPI) {
13501350
setListenToResponderEventTypes(listenToEventResponderEventTypes);
13511351
}

‎packages/react-dom/src/client/ReactDOMHostConfig.js

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,8 @@ import type {
5454
import {
5555
mountEventResponder,
5656
unmountEventResponder,
57-
dispatchEventForResponderEventSystem,
58-
} from '../events/DOMEventResponderSystem';
57+
DEPRECATED_dispatchEventForResponderEventSystem,
58+
} from '../events/DeprecatedDOMEventResponderSystem';
5959
import {retryIfBlockedOn} from '../events/ReactDOMEventReplaying';
6060

6161
export type Type = string;
@@ -111,7 +111,7 @@ type SelectionInformation = {|
111111

112112
import {
113113
enableSuspenseServerRenderer,
114-
enableFlareAPI,
114+
enableDeprecatedFlareAPI,
115115
enableFundamentalAPI,
116116
} from 'shared/ReactFeatureFlags';
117117
import {
@@ -212,7 +212,7 @@ export function resetAfterCommit(containerInfo: Container): void {
212212
restoreSelection(selectionInformation);
213213
ReactBrowserEventEmitterSetEnabled(eventsEnabled);
214214
eventsEnabled = null;
215-
if (enableFlareAPI) {
215+
if (enableDeprecatedFlareAPI) {
216216
const activeElementDetached = (selectionInformation: any)
217217
.activeElementDetached;
218218
if (activeElementDetached !== null) {
@@ -468,7 +468,7 @@ function dispatchBeforeDetachedBlur(target: HTMLElement): void {
468468
const targetInstance = getClosestInstanceFromNode(target);
469469
((selectionInformation: any): SelectionInformation).activeElementDetached = target;
470470

471-
dispatchEventForResponderEventSystem(
471+
DEPRECATED_dispatchEventForResponderEventSystem(
472472
'beforeblur',
473473
targetInstance,
474474
({
@@ -481,7 +481,7 @@ function dispatchBeforeDetachedBlur(target: HTMLElement): void {
481481
}
482482

483483
function dispatchDetachedBlur(target: HTMLElement): void {
484-
dispatchEventForResponderEventSystem(
484+
DEPRECATED_dispatchEventForResponderEventSystem(
485485
'blur',
486486
null,
487487
({
@@ -502,7 +502,7 @@ export function beforeRemoveInstance(
502502
instance: Instance | TextInstance | SuspenseInstance,
503503
): void {
504504
if (
505-
enableFlareAPI &&
505+
enableDeprecatedFlareAPI &&
506506
selectionInformation &&
507507
instance === selectionInformation.focusedElem
508508
) {
@@ -944,7 +944,7 @@ export function didNotFindHydratableSuspenseInstance(
944944
}
945945
}
946946

947-
export function mountResponderInstance(
947+
export function DEPRECATED_mountResponderInstance(
948948
responder: ReactDOMEventResponder,
949949
responderInstance: ReactDOMEventResponderInstance,
950950
responderProps: Object,
@@ -966,10 +966,10 @@ export function mountResponderInstance(
966966
return responderInstance;
967967
}
968968

969-
export function unmountResponderInstance(
969+
export function DEPRECATED_unmountResponderInstance(
970970
responderInstance: ReactDOMEventResponderInstance,
971971
): void {
972-
if (enableFlareAPI) {
972+
if (enableDeprecatedFlareAPI) {
973973
// TODO stop listening to targetEventTypes
974974
unmountEventResponder(responderInstance);
975975
}

‎packages/react-dom/src/events/DOMEventResponderSystem.js renamed to ‎packages/react-dom/src/events/DeprecatedDOMEventResponderSystem.js

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ import {
2929
} from 'legacy-events/ReactGenericBatching';
3030
import {enqueueStateRestore} from 'legacy-events/ReactControlledComponent';
3131
import type {Fiber} from 'react-reconciler/src/ReactFiber';
32-
import {enableFlareAPI} from 'shared/ReactFeatureFlags';
32+
import {enableDeprecatedFlareAPI} from 'shared/ReactFeatureFlags';
3333
import invariant from 'shared/invariant';
3434

3535
import {getClosestInstanceFromNode} from '../client/ReactDOMComponentTree';
@@ -164,7 +164,7 @@ const eventResponderContext: ReactDOMResponderContext = {
164164
for (let i = 0; i < rootEventTypes.length; i++) {
165165
const rootEventType = rootEventTypes[i];
166166
const eventResponderInstance = ((currentInstance: any): ReactDOMEventResponderInstance);
167-
registerRootEventType(rootEventType, eventResponderInstance);
167+
DEPRECATED_registerRootEventType(rootEventType, eventResponderInstance);
168168
}
169169
},
170170
removeRootEventTypes(rootEventTypes: Array<string>): void {
@@ -494,14 +494,14 @@ function validateResponderContext(): void {
494494
);
495495
}
496496

497-
export function dispatchEventForResponderEventSystem(
497+
export function DEPRECATED_dispatchEventForResponderEventSystem(
498498
topLevelType: string,
499499
targetFiber: null | Fiber,
500500
nativeEvent: AnyNativeEvent,
501501
nativeEventTarget: Document | Element,
502502
eventSystemFlags: EventSystemFlags,
503503
): void {
504-
if (enableFlareAPI) {
504+
if (enableDeprecatedFlareAPI) {
505505
const previousInstance = currentInstance;
506506
const previousTimeStamp = currentTimeStamp;
507507
const previousDocument = currentDocument;
@@ -539,11 +539,11 @@ export function addRootEventTypesForResponderInstance(
539539
): void {
540540
for (let i = 0; i < rootEventTypes.length; i++) {
541541
const rootEventType = rootEventTypes[i];
542-
registerRootEventType(rootEventType, responderInstance);
542+
DEPRECATED_registerRootEventType(rootEventType, responderInstance);
543543
}
544544
}
545545

546-
function registerRootEventType(
546+
function DEPRECATED_registerRootEventType(
547547
rootEventType: string,
548548
eventResponderInstance: ReactDOMEventResponderInstance,
549549
): void {

‎packages/react-dom/src/events/ReactDOMEventListener.js

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ import {
2323
flushDiscreteUpdatesIfNeeded,
2424
} from 'legacy-events/ReactGenericBatching';
2525
import {runExtractedPluginEventsInBatch} from 'legacy-events/EventPluginHub';
26-
import {dispatchEventForResponderEventSystem} from './DOMEventResponderSystem';
26+
import {DEPRECATED_dispatchEventForResponderEventSystem} from './DeprecatedDOMEventResponderSystem';
2727
import {
2828
isReplayableDiscreteEvent,
2929
queueDiscreteEvent,
@@ -63,7 +63,7 @@ import SimpleEventPlugin from './SimpleEventPlugin';
6363
import {getRawEventName} from './DOMTopLevelEventTypes';
6464
import {passiveBrowserEventsSupported} from './checkPassiveEvents';
6565

66-
import {enableFlareAPI} from 'shared/ReactFeatureFlags';
66+
import {enableDeprecatedFlareAPI} from 'shared/ReactFeatureFlags';
6767
import {
6868
UserBlockingEvent,
6969
ContinuousEvent,
@@ -403,7 +403,7 @@ export function dispatchEvent(
403403

404404
// This is not replayable so we'll invoke it but without a target,
405405
// in case the event system needs to trace it.
406-
if (enableFlareAPI) {
406+
if (enableDeprecatedFlareAPI) {
407407
if (eventSystemFlags & PLUGIN_EVENT_SYSTEM) {
408408
dispatchEventForPluginEventSystem(
409409
topLevelType,
@@ -414,7 +414,7 @@ export function dispatchEvent(
414414
}
415415
if (eventSystemFlags & RESPONDER_EVENT_SYSTEM) {
416416
// React Flare event system
417-
dispatchEventForResponderEventSystem(
417+
DEPRECATED_dispatchEventForResponderEventSystem(
418418
(topLevelType: any),
419419
null,
420420
nativeEvent,
@@ -481,7 +481,7 @@ export function attemptToDispatchEvent(
481481
}
482482
}
483483

484-
if (enableFlareAPI) {
484+
if (enableDeprecatedFlareAPI) {
485485
if (eventSystemFlags & PLUGIN_EVENT_SYSTEM) {
486486
dispatchEventForPluginEventSystem(
487487
topLevelType,
@@ -492,7 +492,7 @@ export function attemptToDispatchEvent(
492492
}
493493
if (eventSystemFlags & RESPONDER_EVENT_SYSTEM) {
494494
// React Flare event system
495-
dispatchEventForResponderEventSystem(
495+
DEPRECATED_dispatchEventForResponderEventSystem(
496496
(topLevelType: any),
497497
targetInst,
498498
nativeEvent,

‎packages/react-dom/src/events/ReactDOMEventReplaying.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import type {EventSystemFlags} from 'legacy-events/EventSystemFlags';
1414
import type {FiberRoot} from 'react-reconciler/src/ReactFiberRoot';
1515

1616
import {
17-
enableFlareAPI,
17+
enableDeprecatedFlareAPI,
1818
enableSelectiveHydration,
1919
} from 'shared/ReactFeatureFlags';
2020
import {
@@ -217,7 +217,7 @@ function trapReplayableEvent(
217217
listenerMap: Map<DOMTopLevelEventType | string, null | (any => void)>,
218218
) {
219219
listenToTopLevel(topLevelType, document, listenerMap);
220-
if (enableFlareAPI) {
220+
if (enableDeprecatedFlareAPI) {
221221
// Trap events for the responder system.
222222
const topLevelTypeString = unsafeCastDOMTopLevelTypeToString(topLevelType);
223223
const passiveEventKey = topLevelTypeString + '_passive';

0 commit comments

Comments
 (0)