Skip to content

Commit b5bac18

Browse files
authored
Align event group constant naming with lane naming (#20744)
* Rename ContinuousEvent to DefaultEvent * Rename UserBlockingEvent to ContinuousEvent
1 parent bbb2ba8 commit b5bac18

8 files changed

+31
-39
lines changed

packages/react-dom/src/client/ReactDOM.js

+3-3
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ import {
3232
flushPassiveEffects,
3333
IsThisRendererActing,
3434
attemptSynchronousHydration,
35-
attemptUserBlockingHydration,
35+
attemptDiscreteHydration,
3636
attemptContinuousHydration,
3737
attemptHydrationAtCurrentPriority,
3838
runWithPriority,
@@ -56,7 +56,7 @@ import {
5656
import {restoreControlledState} from './ReactDOMComponent';
5757
import {
5858
setAttemptSynchronousHydration,
59-
setAttemptUserBlockingHydration,
59+
setAttemptDiscreteHydration,
6060
setAttemptContinuousHydration,
6161
setAttemptHydrationAtCurrentPriority,
6262
queueExplicitHydrationTarget,
@@ -71,7 +71,7 @@ import {
7171
} from '../events/ReactDOMControlledComponent';
7272

7373
setAttemptSynchronousHydration(attemptSynchronousHydration);
74-
setAttemptUserBlockingHydration(attemptUserBlockingHydration);
74+
setAttemptDiscreteHydration(attemptDiscreteHydration);
7575
setAttemptContinuousHydration(attemptContinuousHydration);
7676
setAttemptHydrationAtCurrentPriority(attemptHydrationAtCurrentPriority);
7777
setGetCurrentUpdatePriority(getCurrentUpdateLanePriority);

packages/react-dom/src/events/DOMEventProperties.js

+10-14
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,7 @@ import {
1717
ANIMATION_START,
1818
TRANSITION_END,
1919
} from './DOMEventNames';
20-
import {
21-
DiscreteEvent,
22-
UserBlockingEvent,
23-
ContinuousEvent,
24-
} from 'shared/ReactTypes';
20+
import {DiscreteEvent, ContinuousEvent, DefaultEvent} from 'shared/ReactTypes';
2521

2622
import {enableCreateEventHandleAPI} from 'shared/ReactFeatureFlags';
2723

@@ -97,7 +93,7 @@ if (enableCreateEventHandleAPI) {
9793
}
9894

9995
// prettier-ignore
100-
const userBlockingPairsForSimpleEventPlugin: Array<string | DOMEventName> = [
96+
const continuousPairsForSimpleEventPlugin: Array<string | DOMEventName> = [
10197
('drag': DOMEventName), 'drag',
10298
('dragenter': DOMEventName), 'dragEnter',
10399
('dragexit': DOMEventName), 'dragExit',
@@ -116,7 +112,7 @@ const userBlockingPairsForSimpleEventPlugin: Array<string | DOMEventName> = [
116112
];
117113

118114
// prettier-ignore
119-
const continuousPairsForSimpleEventPlugin: Array<string | DOMEventName> = [
115+
const defaultPairsForSimpleEventPlugin: Array<string | DOMEventName> = [
120116
('abort': DOMEventName), 'abort',
121117
(ANIMATION_END: DOMEventName), 'animationEnd',
122118
(ANIMATION_ITERATION: DOMEventName), 'animationIteration',
@@ -190,10 +186,10 @@ export function getEventPriorityForPluginSystem(
190186
domEventName: DOMEventName,
191187
): EventPriority {
192188
const priority = eventPriorities.get(domEventName);
193-
// Default to a ContinuousEvent. Note: we might
189+
// Default to a DefaultEvent. Note: we might
194190
// want to warn if we can't detect the priority
195191
// for the event.
196-
return priority === undefined ? ContinuousEvent : priority;
192+
return priority === undefined ? DefaultEvent : priority;
197193
}
198194

199195
export function getEventPriorityForListenerSystem(
@@ -210,21 +206,21 @@ export function getEventPriorityForListenerSystem(
210206
type,
211207
);
212208
}
213-
return ContinuousEvent;
209+
return DefaultEvent;
214210
}
215211

216212
export function registerSimpleEvents() {
217213
registerSimplePluginEventsAndSetTheirPriorities(
218214
discreteEventPairsForSimpleEventPlugin,
219215
DiscreteEvent,
220216
);
221-
registerSimplePluginEventsAndSetTheirPriorities(
222-
userBlockingPairsForSimpleEventPlugin,
223-
UserBlockingEvent,
224-
);
225217
registerSimplePluginEventsAndSetTheirPriorities(
226218
continuousPairsForSimpleEventPlugin,
227219
ContinuousEvent,
228220
);
221+
registerSimplePluginEventsAndSetTheirPriorities(
222+
defaultPairsForSimpleEventPlugin,
223+
DefaultEvent,
224+
);
229225
setEventPriorities(otherDiscreteEvents, DiscreteEvent);
230226
}

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

+5-9
Original file line numberDiff line numberDiff line change
@@ -43,11 +43,7 @@ import {
4343
decoupleUpdatePriorityFromScheduler,
4444
enableNewReconciler,
4545
} from 'shared/ReactFeatureFlags';
46-
import {
47-
UserBlockingEvent,
48-
ContinuousEvent,
49-
DiscreteEvent,
50-
} from 'shared/ReactTypes';
46+
import {ContinuousEvent, DefaultEvent, DiscreteEvent} from 'shared/ReactTypes';
5147
import {getEventPriorityForPluginSystem} from './DOMEventProperties';
5248
import {dispatchEventForPluginEventSystem} from './DOMPluginEventSystem';
5349
import {
@@ -118,10 +114,10 @@ export function createEventListenerWrapperWithPriority(
118114
case DiscreteEvent:
119115
listenerWrapper = dispatchDiscreteEvent;
120116
break;
121-
case UserBlockingEvent:
122-
listenerWrapper = dispatchUserBlockingUpdate;
123-
break;
124117
case ContinuousEvent:
118+
listenerWrapper = dispatchContinuousEvent;
119+
break;
120+
case DefaultEvent:
125121
default:
126122
listenerWrapper = dispatchEvent;
127123
break;
@@ -157,7 +153,7 @@ function dispatchDiscreteEvent(
157153
);
158154
}
159155

160-
function dispatchUserBlockingUpdate(
156+
function dispatchContinuousEvent(
161157
domEventName,
162158
eventSystemFlags,
163159
container,

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

+4-4
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,10 @@ export function setAttemptSynchronousHydration(fn: (fiber: Object) => void) {
3939
attemptSynchronousHydration = fn;
4040
}
4141

42-
let attemptUserBlockingHydration: (fiber: Object) => void;
42+
let attemptDiscreteHydration: (fiber: Object) => void;
4343

44-
export function setAttemptUserBlockingHydration(fn: (fiber: Object) => void) {
45-
attemptUserBlockingHydration = fn;
44+
export function setAttemptDiscreteHydration(fn: (fiber: Object) => void) {
45+
attemptDiscreteHydration = fn;
4646
}
4747

4848
let attemptContinuousHydration: (fiber: Object) => void;
@@ -489,7 +489,7 @@ function replayUnblockedEvents() {
489489
// the next discrete event.
490490
const fiber = getInstanceFromNode(nextDiscreteEvent.blockedOn);
491491
if (fiber !== null) {
492-
attemptUserBlockingHydration(fiber);
492+
attemptDiscreteHydration(fiber);
493493
}
494494
break;
495495
}

packages/react-reconciler/src/ReactFiberReconciler.js

+5-5
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ import {
2929
IsThisRendererActing as IsThisRendererActing_old,
3030
getPublicRootInstance as getPublicRootInstance_old,
3131
attemptSynchronousHydration as attemptSynchronousHydration_old,
32-
attemptUserBlockingHydration as attemptUserBlockingHydration_old,
32+
attemptDiscreteHydration as attemptDiscreteHydration_old,
3333
attemptContinuousHydration as attemptContinuousHydration_old,
3434
attemptHydrationAtCurrentPriority as attemptHydrationAtCurrentPriority_old,
3535
findHostInstance as findHostInstance_old,
@@ -69,7 +69,7 @@ import {
6969
IsThisRendererActing as IsThisRendererActing_new,
7070
getPublicRootInstance as getPublicRootInstance_new,
7171
attemptSynchronousHydration as attemptSynchronousHydration_new,
72-
attemptUserBlockingHydration as attemptUserBlockingHydration_new,
72+
attemptDiscreteHydration as attemptDiscreteHydration_new,
7373
attemptContinuousHydration as attemptContinuousHydration_new,
7474
attemptHydrationAtCurrentPriority as attemptHydrationAtCurrentPriority_new,
7575
findHostInstance as findHostInstance_new,
@@ -134,9 +134,9 @@ export const getPublicRootInstance = enableNewReconciler
134134
export const attemptSynchronousHydration = enableNewReconciler
135135
? attemptSynchronousHydration_new
136136
: attemptSynchronousHydration_old;
137-
export const attemptUserBlockingHydration = enableNewReconciler
138-
? attemptUserBlockingHydration_new
139-
: attemptUserBlockingHydration_old;
137+
export const attemptDiscreteHydration = enableNewReconciler
138+
? attemptDiscreteHydration_new
139+
: attemptDiscreteHydration_old;
140140
export const attemptContinuousHydration = enableNewReconciler
141141
? attemptContinuousHydration_new
142142
: attemptContinuousHydration_old;

packages/react-reconciler/src/ReactFiberReconciler.new.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -396,7 +396,7 @@ function markRetryLaneIfNotHydrated(fiber: Fiber, retryLane: Lane) {
396396
}
397397
}
398398

399-
export function attemptUserBlockingHydration(fiber: Fiber): void {
399+
export function attemptDiscreteHydration(fiber: Fiber): void {
400400
if (fiber.tag !== SuspenseComponent) {
401401
// We ignore HostRoots here because we can't increase
402402
// their priority and they should not suspend on I/O,

packages/react-reconciler/src/ReactFiberReconciler.old.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -396,7 +396,7 @@ function markRetryLaneIfNotHydrated(fiber: Fiber, retryLane: Lane) {
396396
}
397397
}
398398

399-
export function attemptUserBlockingHydration(fiber: Fiber): void {
399+
export function attemptDiscreteHydration(fiber: Fiber): void {
400400
if (fiber.tag !== SuspenseComponent) {
401401
// We ignore HostRoots here because we can't increase
402402
// their priority and they should not suspend on I/O,

packages/shared/ReactTypes.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -89,8 +89,8 @@ export type RefObject = {|
8989
export type EventPriority = 0 | 1 | 2;
9090

9191
export const DiscreteEvent: EventPriority = 0;
92-
export const UserBlockingEvent: EventPriority = 1;
93-
export const ContinuousEvent: EventPriority = 2;
92+
export const ContinuousEvent: EventPriority = 1;
93+
export const DefaultEvent: EventPriority = 2;
9494

9595
export type ReactScope = {|
9696
$$typeof: Symbol | number,

0 commit comments

Comments
 (0)