{"body":"Removes `withSuspenseConfig` and migrates relevant tests to\r\n`startTransition` instead.\r\n\r\nWe only had one caller in www, which I've removed.","commit":{"subject":"Remove withSuspenseConfig (#19724)","authoredAt":"2020-08-31T11:16:49-05:00","revision":"1f38dcff67d12828be771403e183652f5e93909a","shortRevision":"1f38dcff67","authorEmail":"git@andrewclark.io","authorName":"Andrew Clark"},"parents":["1396e4a8f5646f35929883cbb449d2c83e7cbc79"],"files":[{"status":"M","path":"fixtures\/ssr\/src\/components\/Chrome.js"},{"status":"M","path":"packages\/react-dom\/src\/__tests__\/ReactDOMServerPartialHydration-test.internal.js"},{"status":"M","path":"packages\/react-dom\/src\/__tests__\/ReactTestUtilsAct-test.js"},{"status":"M","path":"packages\/react-dom\/src\/events\/plugins\/__tests__\/SimpleEventPlugin-test.js"},{"status":"M","path":"packages\/react-reconciler\/src\/__tests__\/ReactSuspense-test.internal.js"},{"status":"M","path":"packages\/react-reconciler\/src\/__tests__\/ReactSuspenseWithNoopRenderer-test.js"},{"status":"M","path":"packages\/react\/index.classic.fb.js"},{"status":"M","path":"packages\/react\/index.experimental.js"},{"status":"M","path":"packages\/react\/index.js"},{"status":"M","path":"packages\/react\/index.modern.fb.js"},{"status":"M","path":"packages\/react\/src\/React.js"},{"status":"D","path":"packages\/react\/src\/ReactBatchConfig.js"}],"patch":"diff --git a\/fixtures\/ssr\/src\/components\/Chrome.js b\/fixtures\/ssr\/src\/components\/Chrome.js\nindex 5bad11aae5..9537f037e7 100644\n--- a\/fixtures\/ssr\/src\/components\/Chrome.js\n+++ b\/fixtures\/ssr\/src\/components\/Chrome.js\n@@ -28,12 +28,9 @@ export default class Chrome extends Component {\n

\n {\n- React.unstable_withSuspenseConfig(\n- () => {\n- this.setState({theme});\n- },\n- {timeoutMs: 6000}\n- );\n+ React.startTransition(() => {\n+ this.setState({theme});\n+ });\n }}\n \/>\n <\/div>\ndiff --git a\/packages\/react-dom\/src\/__tests__\/ReactDOMServerPartialHydration-test.internal.js b\/packages\/react-dom\/src\/__tests__\/ReactDOMServerPartialHydration-test.internal.js\nindex 1d70475041..1e6a912651 100644\n--- a\/packages\/react-dom\/src\/__tests__\/ReactDOMServerPartialHydration-test.internal.js\n+++ b\/packages\/react-dom\/src\/__tests__\/ReactDOMServerPartialHydration-test.internal.js\n@@ -913,9 +913,8 @@ describe('ReactDOMServerPartialHydration', () => {\n expect(container.textContent).toBe('Hello');\n \n \/\/ Render an update with a long timeout.\n- React.unstable_withSuspenseConfig(\n- () => root.render(),\n- {timeoutMs: 5000},\n+ React.unstable_startTransition(() =>\n+ root.render(),\n );\n \n \/\/ This shouldn't force the fallback yet.\ndiff --git a\/packages\/react-dom\/src\/__tests__\/ReactTestUtilsAct-test.js b\/packages\/react-dom\/src\/__tests__\/ReactTestUtilsAct-test.js\nindex d2de57b588..7b48d0118b 100644\n--- a\/packages\/react-dom\/src\/__tests__\/ReactTestUtilsAct-test.js\n+++ b\/packages\/react-dom\/src\/__tests__\/ReactTestUtilsAct-test.js\n@@ -771,14 +771,11 @@ function runActTests(label, render, unmount, rerender) {\n expect(document.querySelector('[data-test-id=spinner]')).toBeNull();\n \n \/\/ trigger a suspendy update with a delay\n- React.unstable_withSuspenseConfig(\n- () => {\n- act(() => {\n- rerender();\n- });\n- },\n- {timeout: 5000},\n- );\n+ React.unstable_startTransition(() => {\n+ act(() => {\n+ rerender();\n+ });\n+ });\n \n if (label === 'concurrent mode') {\n \/\/ In Concurrent Mode, refresh transitions delay indefinitely.\ndiff --git a\/packages\/react-dom\/src\/events\/plugins\/__tests__\/SimpleEventPlugin-test.js b\/packages\/react-dom\/src\/events\/plugins\/__tests__\/SimpleEventPlugin-test.js\nindex 4614052f50..f407bef53f 100644\n--- a\/packages\/react-dom\/src\/events\/plugins\/__tests__\/SimpleEventPlugin-test.js\n+++ b\/packages\/react-dom\/src\/events\/plugins\/__tests__\/SimpleEventPlugin-test.js\n@@ -389,14 +389,11 @@ describe('SimpleEventPlugin', function() {\n (button = el)}\n onClick={() => {\n- React.unstable_withSuspenseConfig(\n- () => {\n- this.setState(state => ({\n- lowPriCount: state.lowPriCount + 1,\n- }));\n- },\n- {timeoutMs: 5000},\n- );\n+ React.unstable_startTransition(() => {\n+ this.setState(state => ({\n+ lowPriCount: state.lowPriCount + 1,\n+ }));\n+ });\n }}>\n {text}\n <\/button>\ndiff --git a\/packages\/react-reconciler\/src\/__tests__\/ReactSuspense-test.internal.js b\/packages\/react-reconciler\/src\/__tests__\/ReactSuspense-test.internal.js\nindex 8c709cb593..e806070e9c 100644\n--- a\/packages\/react-reconciler\/src\/__tests__\/ReactSuspense-test.internal.js\n+++ b\/packages\/react-reconciler\/src\/__tests__\/ReactSuspense-test.internal.js\n@@ -363,12 +363,9 @@ describe('ReactSuspense', () => {\n \n \/\/ Schedule another update. This will have lower priority because it's\n \/\/ a transition.\n- React.unstable_withSuspenseConfig(\n- () => {\n- root.update();\n- },\n- {timeoutMs: 10000},\n- );\n+ React.unstable_startTransition(() => {\n+ root.update();\n+ });\n \n \/\/ Interrupt to trigger a restart.\n interrupt();\n@@ -465,12 +462,9 @@ describe('ReactSuspense', () => {\n \n \/\/ Schedule another update. This will have lower priority because it's\n \/\/ a transition.\n- React.unstable_withSuspenseConfig(\n- () => {\n- setShouldHideInParent(true);\n- },\n- {timeoutMs: 10000},\n- );\n+ React.unstable_startTransition(() => {\n+ setShouldHideInParent(true);\n+ });\n \n expect(Scheduler).toFlushAndYieldThrough([\n \/\/ Should have restarted the first update, because of the interruption\ndiff --git a\/packages\/react-reconciler\/src\/__tests__\/ReactSuspenseWithNoopRenderer-test.js b\/packages\/react-reconciler\/src\/__tests__\/ReactSuspenseWithNoopRenderer-test.js\nindex 035bd8bc57..c10772eaa1 100644\n--- a\/packages\/react-reconciler\/src\/__tests__\/ReactSuspenseWithNoopRenderer-test.js\n+++ b\/packages\/react-reconciler\/src\/__tests__\/ReactSuspenseWithNoopRenderer-test.js\n@@ -959,12 +959,7 @@ describe('ReactSuspenseWithNoopRenderer', () => {\n expect(Scheduler).toFlushAndYield(['S']);\n \n \/\/ Schedule an update, and suspend for up to 5 seconds.\n- React.unstable_withSuspenseConfig(\n- () => ReactNoop.render(),\n- {\n- timeoutMs: 5000,\n- },\n- );\n+ React.unstable_startTransition(() => ReactNoop.render());\n \/\/ The update should suspend.\n expect(Scheduler).toFlushAndYield(['Suspend! [A]', 'Loading...']);\n expect(ReactNoop.getChildren()).toEqual([span('S')]);\n@@ -976,12 +971,7 @@ describe('ReactSuspenseWithNoopRenderer', () => {\n expect(ReactNoop.getChildren()).toEqual([span('S')]);\n \n \/\/ Schedule another low priority update.\n- React.unstable_withSuspenseConfig(\n- () => ReactNoop.render(),\n- {\n- timeoutMs: 10000,\n- },\n- );\n+ React.unstable_startTransition(() => ReactNoop.render());\n \/\/ This update should also suspend.\n expect(Scheduler).toFlushAndYield(['Suspend! [B]', 'Loading...']);\n expect(ReactNoop.getChildren()).toEqual([span('S')]);\n@@ -2282,7 +2272,7 @@ describe('ReactSuspenseWithNoopRenderer', () => {\n ReactNoop.render();\n \n \/\/ Took a long time to render. This is to ensure we get a long suspense time.\n- \/\/ Could also use something like withSuspenseConfig to simulate this.\n+ \/\/ Could also use something like startTransition to simulate this.\n Scheduler.unstable_advanceTime(1500);\n await advanceTimers(1500);\n \n@@ -2314,11 +2304,7 @@ describe('ReactSuspenseWithNoopRenderer', () => {\n expect(ReactNoop.getChildren()).toEqual([span('Loading A...')]);\n });\n \n- describe('delays transitions when there a suspense config is supplied', () => {\n- const SUSPENSE_CONFIG = {\n- timeoutMs: 2000,\n- };\n-\n+ describe('startTransition', () => {\n \/\/ @gate experimental\n it('top level render', async () => {\n function App({page}) {\n@@ -2330,10 +2316,7 @@ describe('ReactSuspenseWithNoopRenderer', () => {\n }\n \n \/\/ Initial render.\n- React.unstable_withSuspenseConfig(\n- () => ReactNoop.render(),\n- SUSPENSE_CONFIG,\n- );\n+ React.unstable_startTransition(() => ReactNoop.render());\n \n expect(Scheduler).toFlushAndYield(['Suspend! [A]', 'Loading...']);\n \/\/ Only a short time is needed to unsuspend the initial loading state.\n@@ -2349,10 +2332,7 @@ describe('ReactSuspenseWithNoopRenderer', () => {\n expect(ReactNoop.getChildren()).toEqual([span('A')]);\n \n \/\/ Start transition.\n- React.unstable_withSuspenseConfig(\n- () => ReactNoop.render(),\n- SUSPENSE_CONFIG,\n- );\n+ React.unstable_startTransition(() => ReactNoop.render());\n \n expect(Scheduler).toFlushAndYield(['Suspend! [B]', 'Loading...']);\n Scheduler.unstable_advanceTime(100000);\n@@ -2389,10 +2369,7 @@ describe('ReactSuspenseWithNoopRenderer', () => {\n \n \/\/ Initial render.\n await ReactNoop.act(async () => {\n- React.unstable_withSuspenseConfig(\n- () => transitionToPage('A'),\n- SUSPENSE_CONFIG,\n- );\n+ React.unstable_startTransition(() => transitionToPage('A'));\n \n expect(Scheduler).toFlushAndYield(['Suspend! [A]', 'Loading...']);\n \/\/ Only a short time is needed to unsuspend the initial loading state.\n@@ -2409,10 +2386,7 @@ describe('ReactSuspenseWithNoopRenderer', () => {\n \n \/\/ Start transition.\n await ReactNoop.act(async () => {\n- React.unstable_withSuspenseConfig(\n- () => transitionToPage('B'),\n- SUSPENSE_CONFIG,\n- );\n+ React.unstable_startTransition(() => transitionToPage('B'));\n \n expect(Scheduler).toFlushAndYield(['Suspend! [B]', 'Loading...']);\n Scheduler.unstable_advanceTime(100000);\n@@ -2452,10 +2426,7 @@ describe('ReactSuspenseWithNoopRenderer', () => {\n \n \/\/ Initial render.\n await ReactNoop.act(async () => {\n- React.unstable_withSuspenseConfig(\n- () => transitionToPage('A'),\n- SUSPENSE_CONFIG,\n- );\n+ React.unstable_startTransition(() => transitionToPage('A'));\n \n expect(Scheduler).toFlushAndYield(['Suspend! [A]', 'Loading...']);\n \/\/ Only a short time is needed to unsuspend the initial loading state.\n@@ -2472,10 +2443,7 @@ describe('ReactSuspenseWithNoopRenderer', () => {\n \n \/\/ Start transition.\n await ReactNoop.act(async () => {\n- React.unstable_withSuspenseConfig(\n- () => transitionToPage('B'),\n- SUSPENSE_CONFIG,\n- );\n+ React.unstable_startTransition(() => transitionToPage('B'));\n \n expect(Scheduler).toFlushAndYield(['Suspend! [B]', 'Loading...']);\n Scheduler.unstable_advanceTime(100000);\n@@ -2689,75 +2657,7 @@ describe('ReactSuspenseWithNoopRenderer', () => {\n });\n \n \/\/ @gate experimental\n- it('disables suspense config when nothing is passed to withSuspenseConfig', async () => {\n- function App({page}) {\n- return (\n- }>\n- \n- <\/Suspense>\n- );\n- }\n-\n- \/\/ Initial render.\n- ReactNoop.render();\n- expect(Scheduler).toFlushAndYield(['Suspend! [A]', 'Loading...']);\n- Scheduler.unstable_advanceTime(2000);\n- await advanceTimers(2000);\n- expect(Scheduler).toHaveYielded(['Promise resolved [A]']);\n- expect(Scheduler).toFlushAndYield(['A']);\n- expect(ReactNoop.getChildren()).toEqual([span('A')]);\n-\n- \/\/ Start transition.\n- React.unstable_withSuspenseConfig(\n- () => {\n- \/\/ When we schedule an inner transition without a suspense config\n- \/\/ so it should only suspend for a short time.\n- React.unstable_withSuspenseConfig(() =>\n- ReactNoop.render(),\n- );\n- },\n- {timeoutMs: 2000},\n- );\n-\n- expect(Scheduler).toFlushAndYield(['Suspend! [B]', 'Loading...']);\n- \/\/ Suspended\n- expect(ReactNoop.getChildren()).toEqual([span('A')]);\n- Scheduler.unstable_advanceTime(500);\n- await advanceTimers(500);\n- \/\/ Committed loading state.\n- expect(ReactNoop.getChildren()).toEqual([\n- hiddenSpan('A'),\n- span('Loading...'),\n- ]);\n-\n- Scheduler.unstable_advanceTime(2000);\n- await advanceTimers(2000);\n- expect(Scheduler).toHaveYielded(['Promise resolved [B]']);\n- expect(Scheduler).toFlushAndYield(['B']);\n- expect(ReactNoop.getChildren()).toEqual([span('B')]);\n-\n- React.unstable_withSuspenseConfig(\n- () => {\n- \/\/ First we schedule an inner unrelated update.\n- React.unstable_withSuspenseConfig(() =>\n- ReactNoop.render(),\n- );\n- \/\/ Then we schedule another transition to a slow page,\n- \/\/ but at this scope we should suspend for longer.\n- Scheduler.unstable_next(() => ReactNoop.render());\n- },\n- {timeoutMs: 60000},\n- );\n- expect(Scheduler).toFlushAndYield(['B', 'Suspend! [C]', 'Loading...']);\n- expect(ReactNoop.getChildren()).toEqual([span('B')]);\n- \/\/ Event after a large amount of time, we never show a loading state.\n- Scheduler.unstable_advanceTime(60000);\n- await advanceTimers(60000);\n- expect(ReactNoop.getChildren()).toEqual([span('B')]);\n- });\n-\n- \/\/ @gate experimental\n- it('withSuspenseConfig delay applies when we use an updated avoided boundary', async () => {\n+ it('do not show placeholder when updating an avoided boundary with startTransition', async () => {\n function App({page}) {\n return (\n }>\n@@ -2780,10 +2680,7 @@ describe('ReactSuspenseWithNoopRenderer', () => {\n expect(ReactNoop.getChildren()).toEqual([span('Hi!'), span('A')]);\n \n \/\/ Start transition.\n- React.unstable_withSuspenseConfig(\n- () => ReactNoop.render(),\n- {timeoutMs: 2000},\n- );\n+ React.unstable_startTransition(() => ReactNoop.render());\n \n expect(Scheduler).toFlushAndYield(['Hi!', 'Suspend! [B]', 'Loading B...']);\n \n@@ -2806,7 +2703,7 @@ describe('ReactSuspenseWithNoopRenderer', () => {\n });\n \n \/\/ @gate experimental\n- it('withSuspenseConfig delay applies when we use a newly created avoided boundary', async () => {\n+ it('do not show placeholder when mounting an avoided boundary with startTransition', async () => {\n function App({page}) {\n return (\n }>\n@@ -2830,10 +2727,7 @@ describe('ReactSuspenseWithNoopRenderer', () => {\n expect(ReactNoop.getChildren()).toEqual([span('Hi!'), span('A')]);\n \n \/\/ Start transition.\n- React.unstable_withSuspenseConfig(\n- () => ReactNoop.render(),\n- {timeoutMs: 2000},\n- );\n+ React.unstable_startTransition(() => ReactNoop.render());\n \n expect(Scheduler).toFlushAndYield(['Hi!', 'Suspend! [B]', 'Loading B...']);\n \n@@ -2992,12 +2886,9 @@ describe('ReactSuspenseWithNoopRenderer', () => {\n expect(ReactNoop).toMatchRenderedOutput(

);\n \n \/\/ Start transition.\n- React.unstable_withSuspenseConfig(\n- () => {\n- ReactNoop.render();\n- },\n- {timeoutMs: 2500},\n- );\n+ React.unstable_startTransition(() => {\n+ ReactNoop.render();\n+ });\n \n expect(Scheduler).toFlushAndYield(['Suspend! [A]', 'Loading...']);\n Scheduler.unstable_advanceTime(2000);\n@@ -3049,12 +2940,9 @@ describe('ReactSuspenseWithNoopRenderer', () => {\n expect(Scheduler).toFlushAndYieldThrough(['Suspend! [A]']);\n \n \/\/ Start transition.\n- React.unstable_withSuspenseConfig(\n- () => {\n- ReactNoop.render();\n- },\n- {timeoutMs: 5000},\n- );\n+ React.unstable_startTransition(() => {\n+ ReactNoop.render();\n+ });\n \n expect(Scheduler).toFlushAndYield(['Suspend! [A]', 'Loading...']);\n Scheduler.unstable_advanceTime(2000);\ndiff --git a\/packages\/react\/index.classic.fb.js b\/packages\/react\/index.classic.fb.js\nindex 5028532881..5f79d3de1f 100644\n--- a\/packages\/react\/index.classic.fb.js\n+++ b\/packages\/react\/index.classic.fb.js\n@@ -50,7 +50,6 @@ export {\n startTransition as unstable_startTransition,\n SuspenseList,\n SuspenseList as unstable_SuspenseList,\n- unstable_withSuspenseConfig,\n \/\/ enableBlocksAPI\n block,\n block as unstable_block,\ndiff --git a\/packages\/react\/index.experimental.js b\/packages\/react\/index.experimental.js\nindex ff00b13333..0b5e7efd13 100644\n--- a\/packages\/react\/index.experimental.js\n+++ b\/packages\/react\/index.experimental.js\n@@ -44,7 +44,6 @@ export {\n useDeferredValue as unstable_useDeferredValue,\n startTransition as unstable_startTransition,\n SuspenseList as unstable_SuspenseList,\n- unstable_withSuspenseConfig,\n \/\/ enableBlocksAPI\n block as unstable_block,\n unstable_useOpaqueIdentifier,\ndiff --git a\/packages\/react\/index.js b\/packages\/react\/index.js\nindex ebbb6cf42e..9fd5ccfbf3 100644\n--- a\/packages\/react\/index.js\n+++ b\/packages\/react\/index.js\n@@ -78,7 +78,6 @@ export {\n useDeferredValue as unstable_useDeferredValue,\n SuspenseList,\n SuspenseList as unstable_SuspenseList,\n- unstable_withSuspenseConfig,\n block,\n block as unstable_block,\n unstable_LegacyHidden,\ndiff --git a\/packages\/react\/index.modern.fb.js b\/packages\/react\/index.modern.fb.js\nindex fb2e1dcbef..a5b509460d 100644\n--- a\/packages\/react\/index.modern.fb.js\n+++ b\/packages\/react\/index.modern.fb.js\n@@ -49,7 +49,6 @@ export {\n startTransition as unstable_startTransition,\n SuspenseList,\n SuspenseList as unstable_SuspenseList,\n- unstable_withSuspenseConfig,\n \/\/ enableBlocksAPI\n block,\n block as unstable_block,\ndiff --git a\/packages\/react\/src\/React.js b\/packages\/react\/src\/React.js\nindex bd737472a5..d5367da328 100644\n--- a\/packages\/react\/src\/React.js\n+++ b\/packages\/react\/src\/React.js\n@@ -49,7 +49,6 @@ import {\n useDeferredValue,\n useOpaqueIdentifier,\n } from '.\/ReactHooks';\n-import {withSuspenseConfig} from '.\/ReactBatchConfig';\n import {\n createElementWithValidation,\n createFactoryWithValidation,\n@@ -112,7 +111,6 @@ export {\n useDeferredValue,\n REACT_SUSPENSE_LIST_TYPE as SuspenseList,\n REACT_LEGACY_HIDDEN_TYPE as unstable_LegacyHidden,\n- withSuspenseConfig as unstable_withSuspenseConfig,\n \/\/ enableBlocksAPI\n block,\n \/\/ enableFundamentalAPI\ndiff --git a\/packages\/react\/src\/ReactBatchConfig.js b\/packages\/react\/src\/ReactBatchConfig.js\ndeleted file mode 100644\nindex c08dac6154..0000000000\n--- a\/packages\/react\/src\/ReactBatchConfig.js\n+++ \/dev\/null\n@@ -1,25 +0,0 @@\n-\/**\n- * Copyright (c) Facebook, Inc. and its affiliates.\n- *\n- * This source code is licensed under the MIT license found in the\n- * LICENSE file in the root directory of this source tree.\n- *\n- * @flow\n- *\/\n-\n-import ReactCurrentBatchConfig from '.\/ReactCurrentBatchConfig';\n-\n-\/\/ This is a copy of startTransition, except if null or undefined is passed,\n-\/\/ then updates inside the scope are opted-out of the outer transition scope.\n-\/\/ TODO: Deprecated. Remove in favor of startTransition. Figure out how scopes\n-\/\/ should nest, and whether we need an API to opt-out nested scopes.\n-export function withSuspenseConfig(scope: () => void, config?: mixed) {\n- const prevTransition = ReactCurrentBatchConfig.transition;\n- ReactCurrentBatchConfig.transition =\n- config === undefined || config === null ? 0 : 1;\n- try {\n- scope();\n- } finally {\n- ReactCurrentBatchConfig.transition = prevTransition;\n- }\n-}\n"}

dillon1000/react

Files changed