Add stable React.act export (facebook#28160)

Starting in version 19, users can import the `act` testing API from the `react` package instead of using a renderer specific API, like `react-dom/test-utils`.
EdisonVan · Apr 15, 2024 · 5124588 · 5124588
1 parent 4e3f3fe
commit 5124588
Show file tree

Hide file tree

Showing 18 changed files with 26 additions and 20 deletions.
diff --git a/fixtures/dom/src/__tests__/nested-act-test.js b/fixtures/dom/src/__tests__/nested-act-test.js
@@ -20,7 +20,7 @@ describe('unmocked scheduler', () => {
   beforeEach(() => {
     jest.resetModules();
     React = require('react');
-    DOMAct = React.unstable_act;
+    DOMAct = React.act;
     TestRenderer = require('react-test-renderer');
     TestAct = TestRenderer.act;
   });
@@ -61,7 +61,7 @@ describe('mocked scheduler', () => {
       require.requireActual('scheduler/unstable_mock')
     );
     React = require('react');
-    DOMAct = React.unstable_act;
+    DOMAct = React.act;
     TestRenderer = require('react-test-renderer');
     TestAct = TestRenderer.act;
   });

diff --git a/packages/react-devtools-shared/src/__tests__/storeComponentFilters-test.js b/packages/react-devtools-shared/src/__tests__/storeComponentFilters-test.js
@@ -19,7 +19,9 @@ describe('Store component filters', () => {
   let utils;
 
   const act = async (callback: Function) => {
-    if (React.unstable_act != null) {
+    if (React.act != null) {
+      await React.act(callback);
+    } else if (React.unstable_act != null) {
       await React.unstable_act(callback);
     } else {
       callback();

diff --git a/packages/react-devtools-shared/src/__tests__/utils.js b/packages/react-devtools-shared/src/__tests__/utils.js
@@ -21,7 +21,9 @@ export function act(
   const {act: actTestRenderer} = require('react-test-renderer');
   // Use `require('react-dom/test-utils').act` as a fallback for React 17, which can be used in integration tests for React DevTools.
   const actDOM =
-    require('react').unstable_act || require('react-dom/test-utils').act;
+    require('react').act ||
+    require('react').unstable_act ||
+    require('react-dom/test-utils').act;
 
   actDOM(() => {
     actTestRenderer(() => {

diff --git a/packages/react-dom/src/__tests__/ReactDOMHydrationDiff-test.js b/packages/react-dom/src/__tests__/ReactDOMHydrationDiff-test.js
@@ -25,7 +25,7 @@ describe('ReactDOMServerHydration', () => {
     React = require('react');
     ReactDOMClient = require('react-dom/client');
     ReactDOMServer = require('react-dom/server');
-    act = React.unstable_act;
+    act = React.act;
 
     console.error = jest.fn();
     container = document.createElement('div');

diff --git a/packages/react-dom/src/__tests__/ReactTestUtilsActUnmockedScheduler-test.js b/packages/react-dom/src/__tests__/ReactTestUtilsActUnmockedScheduler-test.js
@@ -32,7 +32,7 @@ beforeEach(() => {
   yields = [];
   React = require('react');
   ReactDOMClient = require('react-dom/client');
-  act = React.unstable_act;
+  act = React.act;
   container = document.createElement('div');
   document.body.appendChild(container);
 });

diff --git a/packages/react-dom/src/test-utils/ReactTestUtils.js b/packages/react-dom/src/test-utils/ReactTestUtils.js
@@ -39,7 +39,9 @@ const getFiberCurrentPropsFromNode = EventInternals[2];
 const enqueueStateRestore = EventInternals[3];
 const restoreStateIfNeeded = EventInternals[4];
 
-const act = React.unstable_act;
+// TODO: Add a warning if this API is accessed with advice to switch to
+// importing directly from the React package instead.
+const act = React.act;
 
 function Event(suffix) {}
 

diff --git a/packages/react-reconciler/src/__tests__/ReactActWarnings-test.js b/packages/react-reconciler/src/__tests__/ReactActWarnings-test.js
@@ -28,7 +28,7 @@ describe('act warnings', () => {
     React = require('react');
     Scheduler = require('scheduler');
     ReactNoop = require('react-noop-renderer');
-    act = React.unstable_act;
+    act = React.act;
     useState = React.useState;
     Suspense = React.Suspense;
     startTransition = React.startTransition;

diff --git a/packages/react-reconciler/src/__tests__/ReactFiberHostContext-test.internal.js b/packages/react-reconciler/src/__tests__/ReactFiberHostContext-test.internal.js
@@ -20,7 +20,7 @@ describe('ReactFiberHostContext', () => {
   beforeEach(() => {
     jest.resetModules();
     React = require('react');
-    act = React.unstable_act;
+    act = React.act;
     ReactFiberReconciler = require('react-reconciler');
     ConcurrentRoot =
       require('react-reconciler/src/ReactRootTags').ConcurrentRoot;

diff --git a/packages/react-reconciler/src/__tests__/ReactIsomorphicAct-test.js b/packages/react-reconciler/src/__tests__/ReactIsomorphicAct-test.js
@@ -28,7 +28,7 @@ describe('isomorphic act()', () => {
     ReactNoop = require('react-noop-renderer');
     DiscreteEventPriority =
       require('react-reconciler/constants').DiscreteEventPriority;
-    act = React.unstable_act;
+    act = React.act;
     use = React.use;
     Suspense = React.Suspense;
     startTransition = React.startTransition;

diff --git a/packages/react-reconciler/src/__tests__/ReactSchedulerIntegration-test.js b/packages/react-reconciler/src/__tests__/ReactSchedulerIntegration-test.js
@@ -370,7 +370,7 @@ describe('`act` bypasses Scheduler methods completely,', () => {
     }
 
     const root = ReactNoop.createRoot();
-    const publicAct = React.unstable_act;
+    const publicAct = React.act;
     const prevIsReactActEnvironment = global.IS_REACT_ACT_ENVIRONMENT;
     try {
       global.IS_REACT_ACT_ENVIRONMENT = true;

diff --git a/packages/react-refresh/src/__tests__/ReactFresh-test.js b/packages/react-refresh/src/__tests__/ReactFresh-test.js
@@ -34,7 +34,7 @@ describe('ReactFresh', () => {
       ReactDOM = require('react-dom');
       ReactDOMClient = require('react-dom/client');
       Scheduler = require('scheduler');
-      act = React.unstable_act;
+      act = React.act;
       internalAct = require('internal-test-utils').act;
 
       const InternalTestUtils = require('internal-test-utils');
@@ -3792,7 +3792,7 @@ describe('ReactFresh', () => {
       React = require('react');
       ReactDOM = require('react-dom');
       Scheduler = require('scheduler');
-      act = React.unstable_act;
+      act = React.act;
       internalAct = require('internal-test-utils').act;
 
       // Important! Inject into the global hook *after* ReactDOM runs:

diff --git a/packages/react-server-dom-webpack/src/__tests__/ReactFlightDOMForm-test.js b/packages/react-server-dom-webpack/src/__tests__/ReactFlightDOMForm-test.js
@@ -54,7 +54,7 @@ describe('ReactFlightDOMForm', () => {
     ReactServerDOMClient = require('react-server-dom-webpack/client.edge');
     ReactDOMServer = require('react-dom/server.edge');
     ReactDOMClient = require('react-dom/client');
-    act = React.unstable_act;
+    act = React.act;
     useFormState = require('react-dom').useFormState;
     container = document.createElement('div');
     document.body.appendChild(container);

diff --git a/packages/react-test-renderer/src/ReactTestRenderer.js b/packages/react-test-renderer/src/ReactTestRenderer.js
@@ -54,7 +54,7 @@ import {getPublicInstance} from './ReactFiberConfigTestHost';
 import {ConcurrentRoot, LegacyRoot} from 'react-reconciler/src/ReactRootTags';
 import {allowConcurrentByDefault} from 'shared/ReactFeatureFlags';
 
-const act = React.unstable_act;
+const act = React.act;
 
 // TODO: Remove from public bundle
 

diff --git a/packages/react/index.classic.fb.js b/packages/react/index.classic.fb.js
@@ -9,7 +9,7 @@
 
 export {
   __SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED,
-  act as unstable_act,
+  act,
   Children,
   Component,
   Fragment,

diff --git a/packages/react/index.experimental.js b/packages/react/index.experimental.js
@@ -9,7 +9,7 @@
 
 export {
   __SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED,
-  act as unstable_act,
+  act,
   Children,
   Component,
   Fragment,

diff --git a/packages/react/index.js b/packages/react/index.js
@@ -30,7 +30,7 @@ export type ChildrenArray<+T> = $ReadOnlyArray<ChildrenArray<T>> | T;
 // We can't use export * from in Flow for some reason.
 export {
   __SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED,
-  act as unstable_act,
+  act,
   Children,
   Component,
   Fragment,

diff --git a/packages/react/index.modern.fb.js b/packages/react/index.modern.fb.js
@@ -9,7 +9,7 @@
 
 export {
   __SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED,
-  act as unstable_act,
+  act,
   Children,
   Component,
   Fragment,

diff --git a/packages/react/index.stable.js b/packages/react/index.stable.js
@@ -9,7 +9,7 @@
 
 export {
   __SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED,
-  act as unstable_act,
+  act,
   Children,
   Component,
   Fragment,