Replace SuspenseConfig object with an integer (facebook#19706)

Now that the options in SuspenseConfig are no longer supported, the only thing we use it for is to track whether an update is part of a transition. I've renamed `ReactCurrentBatchConfig.suspense` to `ReactCurrentBatchConfig.transition`, and changed the type to a number. The number is always either 0 or 1. I could have made it a boolean; however, most likely this will eventually be either a Lane or an incrementing identifier. The `withSuspenseConfig` export still exists until we've removed all the callers from www.
koto · Jun 15, 2021 · f3ddfe3 · f3ddfe3
1 parent dc3acfb
commit f3ddfe3
Show file tree

Hide file tree

Showing 15 changed files with 80 additions and 108 deletions.
diff --git a/packages/react-debug-tools/src/ReactDebugHooks.js b/packages/react-debug-tools/src/ReactDebugHooks.js
@@ -20,7 +20,7 @@ import type {
 } from 'react-reconciler/src/ReactInternalTypes';
 import type {OpaqueIDType} from 'react-reconciler/src/ReactFiberHostConfig';
 
-import type {SuspenseConfig} from 'react-reconciler/src/ReactFiberSuspenseConfig';
+import type {SuspenseConfig} from 'react-reconciler/src/ReactFiberTransition';
 import {NoMode} from 'react-reconciler/src/ReactTypeOfMode';
 
 import ErrorStackParser from 'error-stack-parser';

diff --git a/packages/react-dom/src/server/ReactPartialRendererHooks.js b/packages/react-dom/src/server/ReactPartialRendererHooks.js
@@ -15,7 +15,7 @@ import type {
   MutableSourceSubscribeFn,
   ReactContext,
 } from 'shared/ReactTypes';
-import type {SuspenseConfig} from 'react-reconciler/src/ReactFiberSuspenseConfig';
+import type {SuspenseConfig} from 'react-reconciler/src/ReactFiberTransition';
 import type PartialRenderer from './ReactPartialRenderer';
 
 import {validateContextBounds} from './ReactPartialRendererContext';

diff --git a/packages/react-reconciler/src/ReactFiberClassComponent.new.js b/packages/react-reconciler/src/ReactFiberClassComponent.new.js
@@ -56,7 +56,6 @@ import {
   requestUpdateLane,
   scheduleUpdateOnFiber,
 } from './ReactFiberWorkLoop.new';
-import {requestCurrentSuspenseConfig} from './ReactFiberSuspenseConfig';
 import {logForceUpdateScheduled, logStateUpdateScheduled} from './DebugTracing';
 
 import {disableLogs, reenableLogs} from 'shared/ConsolePatchingDev';
@@ -196,8 +195,7 @@ const classComponentUpdater = {
   enqueueSetState(inst, payload, callback) {
     const fiber = getInstance(inst);
     const eventTime = requestEventTime();
-    const suspenseConfig = requestCurrentSuspenseConfig();
-    const lane = requestUpdateLane(fiber, suspenseConfig);
+    const lane = requestUpdateLane(fiber);
 
     const update = createUpdate(eventTime, lane);
     update.payload = payload;
@@ -227,8 +225,7 @@ const classComponentUpdater = {
   enqueueReplaceState(inst, payload, callback) {
     const fiber = getInstance(inst);
     const eventTime = requestEventTime();
-    const suspenseConfig = requestCurrentSuspenseConfig();
-    const lane = requestUpdateLane(fiber, suspenseConfig);
+    const lane = requestUpdateLane(fiber);
 
     const update = createUpdate(eventTime, lane);
     update.tag = ReplaceState;
@@ -260,8 +257,7 @@ const classComponentUpdater = {
   enqueueForceUpdate(inst, callback) {
     const fiber = getInstance(inst);
     const eventTime = requestEventTime();
-    const suspenseConfig = requestCurrentSuspenseConfig();
-    const lane = requestUpdateLane(fiber, suspenseConfig);
+    const lane = requestUpdateLane(fiber);
 
     const update = createUpdate(eventTime, lane);
     update.tag = ForceUpdate;

diff --git a/packages/react-reconciler/src/ReactFiberClassComponent.old.js b/packages/react-reconciler/src/ReactFiberClassComponent.old.js
@@ -56,7 +56,6 @@ import {
   requestUpdateLane,
   scheduleUpdateOnFiber,
 } from './ReactFiberWorkLoop.old';
-import {requestCurrentSuspenseConfig} from './ReactFiberSuspenseConfig';
 import {logForceUpdateScheduled, logStateUpdateScheduled} from './DebugTracing';
 
 import {disableLogs, reenableLogs} from 'shared/ConsolePatchingDev';
@@ -196,8 +195,7 @@ const classComponentUpdater = {
   enqueueSetState(inst, payload, callback) {
     const fiber = getInstance(inst);
     const eventTime = requestEventTime();
-    const suspenseConfig = requestCurrentSuspenseConfig();
-    const lane = requestUpdateLane(fiber, suspenseConfig);
+    const lane = requestUpdateLane(fiber);
 
     const update = createUpdate(eventTime, lane);
     update.payload = payload;
@@ -227,8 +225,7 @@ const classComponentUpdater = {
   enqueueReplaceState(inst, payload, callback) {
     const fiber = getInstance(inst);
     const eventTime = requestEventTime();
-    const suspenseConfig = requestCurrentSuspenseConfig();
-    const lane = requestUpdateLane(fiber, suspenseConfig);
+    const lane = requestUpdateLane(fiber);
 
     const update = createUpdate(eventTime, lane);
     update.tag = ReplaceState;
@@ -260,8 +257,7 @@ const classComponentUpdater = {
   enqueueForceUpdate(inst, callback) {
     const fiber = getInstance(inst);
     const eventTime = requestEventTime();
-    const suspenseConfig = requestCurrentSuspenseConfig();
-    const lane = requestUpdateLane(fiber, suspenseConfig);
+    const lane = requestUpdateLane(fiber);
 
     const update = createUpdate(eventTime, lane);
     update.tag = ForceUpdate;

diff --git a/packages/react-reconciler/src/ReactFiberHooks.new.js b/packages/react-reconciler/src/ReactFiberHooks.new.js
@@ -16,7 +16,7 @@ import type {
 import type {Fiber, Dispatcher} from './ReactInternalTypes';
 import type {Lanes, Lane} from './ReactFiberLane';
 import type {HookEffectTag} from './ReactHookEffectTags';
-import type {SuspenseConfig} from './ReactFiberSuspenseConfig';
+import type {SuspenseConfig} from './ReactFiberTransition';
 import type {ReactPriorityLevel} from './ReactInternalTypes';
 import type {FiberRoot} from './ReactInternalTypes';
 import type {OpaqueIDType} from './ReactFiberHostConfig';
@@ -70,7 +70,6 @@ import invariant from 'shared/invariant';
 import getComponentName from 'shared/getComponentName';
 import is from 'shared/objectIs';
 import {markWorkInProgressReceivedUpdate} from './ReactFiberBeginWork.new';
-import {requestCurrentSuspenseConfig} from './ReactFiberSuspenseConfig';
 import {
   UserBlockingPriority,
   NormalPriority,
@@ -1003,8 +1002,7 @@ function useMutableSource<Source, Snapshot>(
       if (!is(snapshot, maybeNewSnapshot)) {
         setSnapshot(maybeNewSnapshot);
 
-        const suspenseConfig = requestCurrentSuspenseConfig();
-        const lane = requestUpdateLane(fiber, suspenseConfig);
+        const lane = requestUpdateLane(fiber);
         markRootMutableRead(root, lane);
       }
       // If the source mutated between render and now,
@@ -1024,8 +1022,7 @@ function useMutableSource<Source, Snapshot>(
         latestSetSnapshot(latestGetSnapshot(source._source));
 
         // Record a pending mutable source update with the same expiration time.
-        const suspenseConfig = requestCurrentSuspenseConfig();
-        const lane = requestUpdateLane(fiber, suspenseConfig);
+        const lane = requestUpdateLane(fiber);
 
         markRootMutableRead(root, lane);
       } catch (error) {
@@ -1441,12 +1438,12 @@ function mountDeferredValue<T>(
 ): T {
   const [prevValue, setValue] = mountState(value);
   mountEffect(() => {
-    const previousConfig = ReactCurrentBatchConfig.suspense;
-    ReactCurrentBatchConfig.suspense = config === undefined ? null : config;
+    const prevTransition = ReactCurrentBatchConfig.transition;
+    ReactCurrentBatchConfig.transition = 1;
     try {
       setValue(value);
     } finally {
-      ReactCurrentBatchConfig.suspense = previousConfig;
+      ReactCurrentBatchConfig.transition = prevTransition;
     }
   }, [value, config]);
   return prevValue;
@@ -1458,12 +1455,12 @@ function updateDeferredValue<T>(
 ): T {
   const [prevValue, setValue] = updateState(value);
   updateEffect(() => {
-    const previousConfig = ReactCurrentBatchConfig.suspense;
-    ReactCurrentBatchConfig.suspense = config === undefined ? null : config;
+    const prevTransition = ReactCurrentBatchConfig.transition;
+    ReactCurrentBatchConfig.transition = 1;
     try {
       setValue(value);
     } finally {
-      ReactCurrentBatchConfig.suspense = previousConfig;
+      ReactCurrentBatchConfig.transition = prevTransition;
     }
   }, [value, config]);
   return prevValue;
@@ -1475,12 +1472,12 @@ function rerenderDeferredValue<T>(
 ): T {
   const [prevValue, setValue] = rerenderState(value);
   updateEffect(() => {
-    const previousConfig = ReactCurrentBatchConfig.suspense;
-    ReactCurrentBatchConfig.suspense = config === undefined ? null : config;
+    const prevTransition = ReactCurrentBatchConfig.transition;
+    ReactCurrentBatchConfig.transition = 1;
     try {
       setValue(value);
     } finally {
-      ReactCurrentBatchConfig.suspense = previousConfig;
+      ReactCurrentBatchConfig.transition = prevTransition;
     }
   }, [value, config]);
   return prevValue;
@@ -1509,16 +1506,16 @@ function startTransition(setPending, config, callback) {
     runWithPriority(
       priorityLevel > NormalPriority ? NormalPriority : priorityLevel,
       () => {
-        const previousConfig = ReactCurrentBatchConfig.suspense;
-        ReactCurrentBatchConfig.suspense = config === undefined ? null : config;
+        const prevTransition = ReactCurrentBatchConfig.transition;
+        ReactCurrentBatchConfig.transition = 1;
         try {
           setPending(false);
           callback();
         } finally {
           if (decoupleUpdatePriorityFromScheduler) {
             setCurrentUpdateLanePriority(previousLanePriority);
           }
-          ReactCurrentBatchConfig.suspense = previousConfig;
+          ReactCurrentBatchConfig.transition = prevTransition;
         }
       },
     );
@@ -1535,13 +1532,13 @@ function startTransition(setPending, config, callback) {
     runWithPriority(
       priorityLevel > NormalPriority ? NormalPriority : priorityLevel,
       () => {
-        const previousConfig = ReactCurrentBatchConfig.suspense;
-        ReactCurrentBatchConfig.suspense = config === undefined ? null : config;
+        const prevTransition = ReactCurrentBatchConfig.transition;
+        ReactCurrentBatchConfig.transition = 1;
         try {
           setPending(false);
           callback();
         } finally {
-          ReactCurrentBatchConfig.suspense = previousConfig;
+          ReactCurrentBatchConfig.transition = prevTransition;
         }
       },
     );
@@ -1685,8 +1682,7 @@ function dispatchAction<S, A>(
   }
 
   const eventTime = requestEventTime();
-  const suspenseConfig = requestCurrentSuspenseConfig();
-  const lane = requestUpdateLane(fiber, suspenseConfig);
+  const lane = requestUpdateLane(fiber);
 
   const update: Update<S, A> = {
     lane,

diff --git a/packages/react-reconciler/src/ReactFiberHooks.old.js b/packages/react-reconciler/src/ReactFiberHooks.old.js
@@ -16,7 +16,7 @@ import type {
 import type {Fiber, Dispatcher} from './ReactInternalTypes';
 import type {Lanes, Lane} from './ReactFiberLane';
 import type {HookEffectTag} from './ReactHookEffectTags';
-import type {SuspenseConfig} from './ReactFiberSuspenseConfig';
+import type {SuspenseConfig} from './ReactFiberTransition';
 import type {ReactPriorityLevel} from './ReactInternalTypes';
 import type {FiberRoot} from './ReactInternalTypes';
 import type {OpaqueIDType} from './ReactFiberHostConfig';
@@ -69,7 +69,6 @@ import invariant from 'shared/invariant';
 import getComponentName from 'shared/getComponentName';
 import is from 'shared/objectIs';
 import {markWorkInProgressReceivedUpdate} from './ReactFiberBeginWork.old';
-import {requestCurrentSuspenseConfig} from './ReactFiberSuspenseConfig';
 import {
   UserBlockingPriority,
   NormalPriority,
@@ -1002,8 +1001,7 @@ function useMutableSource<Source, Snapshot>(
       if (!is(snapshot, maybeNewSnapshot)) {
         setSnapshot(maybeNewSnapshot);
 
-        const suspenseConfig = requestCurrentSuspenseConfig();
-        const lane = requestUpdateLane(fiber, suspenseConfig);
+        const lane = requestUpdateLane(fiber);
         markRootMutableRead(root, lane);
       }
       // If the source mutated between render and now,
@@ -1023,8 +1021,7 @@ function useMutableSource<Source, Snapshot>(
         latestSetSnapshot(latestGetSnapshot(source._source));
 
         // Record a pending mutable source update with the same expiration time.
-        const suspenseConfig = requestCurrentSuspenseConfig();
-        const lane = requestUpdateLane(fiber, suspenseConfig);
+        const lane = requestUpdateLane(fiber);
 
         markRootMutableRead(root, lane);
       } catch (error) {
@@ -1440,12 +1437,12 @@ function mountDeferredValue<T>(
 ): T {
   const [prevValue, setValue] = mountState(value);
   mountEffect(() => {
-    const previousConfig = ReactCurrentBatchConfig.suspense;
-    ReactCurrentBatchConfig.suspense = config === undefined ? null : config;
+    const prevTransition = ReactCurrentBatchConfig.transition;
+    ReactCurrentBatchConfig.transition = 1;
     try {
       setValue(value);
     } finally {
-      ReactCurrentBatchConfig.suspense = previousConfig;
+      ReactCurrentBatchConfig.transition = prevTransition;
     }
   }, [value, config]);
   return prevValue;
@@ -1457,12 +1454,12 @@ function updateDeferredValue<T>(
 ): T {
   const [prevValue, setValue] = updateState(value);
   updateEffect(() => {
-    const previousConfig = ReactCurrentBatchConfig.suspense;
-    ReactCurrentBatchConfig.suspense = config === undefined ? null : config;
+    const prevTransition = ReactCurrentBatchConfig.transition;
+    ReactCurrentBatchConfig.transition = 1;
     try {
       setValue(value);
     } finally {
-      ReactCurrentBatchConfig.suspense = previousConfig;
+      ReactCurrentBatchConfig.transition = prevTransition;
     }
   }, [value, config]);
   return prevValue;
@@ -1474,12 +1471,12 @@ function rerenderDeferredValue<T>(
 ): T {
   const [prevValue, setValue] = rerenderState(value);
   updateEffect(() => {
-    const previousConfig = ReactCurrentBatchConfig.suspense;
-    ReactCurrentBatchConfig.suspense = config === undefined ? null : config;
+    const prevTransition = ReactCurrentBatchConfig.transition;
+    ReactCurrentBatchConfig.transition = 1;
     try {
       setValue(value);
     } finally {
-      ReactCurrentBatchConfig.suspense = previousConfig;
+      ReactCurrentBatchConfig.transition = prevTransition;
     }
   }, [value, config]);
   return prevValue;
@@ -1508,16 +1505,16 @@ function startTransition(setPending, config, callback) {
     runWithPriority(
       priorityLevel > NormalPriority ? NormalPriority : priorityLevel,
       () => {
-        const previousConfig = ReactCurrentBatchConfig.suspense;
-        ReactCurrentBatchConfig.suspense = config === undefined ? null : config;
+        const prevTransition = ReactCurrentBatchConfig.transition;
+        ReactCurrentBatchConfig.transition = 1;
         try {
           setPending(false);
           callback();
         } finally {
           if (decoupleUpdatePriorityFromScheduler) {
             setCurrentUpdateLanePriority(previousLanePriority);
           }
-          ReactCurrentBatchConfig.suspense = previousConfig;
+          ReactCurrentBatchConfig.transition = prevTransition;
         }
       },
     );
@@ -1534,13 +1531,13 @@ function startTransition(setPending, config, callback) {
     runWithPriority(
       priorityLevel > NormalPriority ? NormalPriority : priorityLevel,
       () => {
-        const previousConfig = ReactCurrentBatchConfig.suspense;
-        ReactCurrentBatchConfig.suspense = config === undefined ? null : config;
+        const prevTransition = ReactCurrentBatchConfig.transition;
+        ReactCurrentBatchConfig.transition = 1;
         try {
           setPending(false);
           callback();
         } finally {
-          ReactCurrentBatchConfig.suspense = previousConfig;
+          ReactCurrentBatchConfig.transition = prevTransition;
         }
       },
     );
@@ -1683,8 +1680,7 @@ function dispatchAction<S, A>(
   }
 
   const eventTime = requestEventTime();
-  const suspenseConfig = requestCurrentSuspenseConfig();
-  const lane = requestUpdateLane(fiber, suspenseConfig);
+  const lane = requestUpdateLane(fiber);
 
   const update: Update<S, A> = {
     lane,

diff --git a/packages/react-reconciler/src/ReactFiberReconciler.new.js b/packages/react-reconciler/src/ReactFiberReconciler.new.js
@@ -83,7 +83,6 @@ import {
   getCurrentUpdateLanePriority,
   setCurrentUpdateLanePriority,
 } from './ReactFiberLane';
-import {requestCurrentSuspenseConfig} from './ReactFiberSuspenseConfig';
 import {
   scheduleRefresh,
   scheduleRoot,
@@ -266,8 +265,7 @@ export function updateContainer(
       warnIfNotScopedWithMatchingAct(current);
     }
   }
-  const suspenseConfig = requestCurrentSuspenseConfig();
-  const lane = requestUpdateLane(current, suspenseConfig);
+  const lane = requestUpdateLane(current);
 
   if (enableSchedulingProfiler) {
     markRenderScheduled(lane);
@@ -427,7 +425,7 @@ export function attemptHydrationAtCurrentPriority(fiber: Fiber): void {
     return;
   }
   const eventTime = requestEventTime();
-  const lane = requestUpdateLane(fiber, null);
+  const lane = requestUpdateLane(fiber);
   scheduleUpdateOnFiber(fiber, lane, eventTime);
   markRetryLaneIfNotHydrated(fiber, lane);
 }