From 7bac7607a764074e66dd57c68c09ec5cc898f4a5 Mon Sep 17 00:00:00 2001 From: Andrew Clark Date: Fri, 23 Apr 2021 11:46:58 -0500 Subject: [PATCH] Revert "Flush discrete passive effects before paint (#21150)" This reverts commit 2e7aceeb5c8b6e5c61174c0e9731e263e956e445. If a discrete render results in passive effects, we should flush them synchronously at the end of the current task so that the result is immediately observable. For example, if a passive effect adds an event listener, the listener will be added before the next input. We don't need to do this for effects that don't have discrete/sync priority, because we assume they are not order-dependent and do not need to be observed by external systems. For legacy mode, we will maintain the existing behavior, since it hasn't been reported as an issue, and we'd have to do additional work to distinguish "legacy default sync" from "discrete sync" to prevent all passive effects from being treated this way. --- .../src/ReactFiberWorkLoop.new.js | 15 ---- .../src/ReactFiberWorkLoop.old.js | 15 ---- .../src/__tests__/ReactFlushSync-test.js | 69 ------------------- .../ReactHooksWithNoopRenderer-test.js | 7 +- 4 files changed, 2 insertions(+), 104 deletions(-) diff --git a/packages/react-reconciler/src/ReactFiberWorkLoop.new.js b/packages/react-reconciler/src/ReactFiberWorkLoop.new.js index 99f3e014148f5..7c659b7775a1e 100644 --- a/packages/react-reconciler/src/ReactFiberWorkLoop.new.js +++ b/packages/react-reconciler/src/ReactFiberWorkLoop.new.js @@ -1976,21 +1976,6 @@ function commitRootImpl(root, renderPriorityLevel) { return null; } - // If the passive effects are the result of a discrete render, flush them - // synchronously at the end of the current task so that the result is - // immediately observable. Otherwise, we assume that they are not - // order-dependent and do not need to be observed by external systems, so we - // can wait until after paint. - // TODO: We can optimize this by not scheduling the callback earlier. Since we - // currently schedule the callback in multiple places, will wait until those - // are consolidated. - if ( - includesSomeLane(pendingPassiveEffectsLanes, SyncLane) && - root.tag !== LegacyRoot - ) { - flushPassiveEffects(); - } - // If layout work was scheduled, flush it now. flushSyncCallbacks(); diff --git a/packages/react-reconciler/src/ReactFiberWorkLoop.old.js b/packages/react-reconciler/src/ReactFiberWorkLoop.old.js index e7328b989083b..530646f8a4d29 100644 --- a/packages/react-reconciler/src/ReactFiberWorkLoop.old.js +++ b/packages/react-reconciler/src/ReactFiberWorkLoop.old.js @@ -1976,21 +1976,6 @@ function commitRootImpl(root, renderPriorityLevel) { return null; } - // If the passive effects are the result of a discrete render, flush them - // synchronously at the end of the current task so that the result is - // immediately observable. Otherwise, we assume that they are not - // order-dependent and do not need to be observed by external systems, so we - // can wait until after paint. - // TODO: We can optimize this by not scheduling the callback earlier. Since we - // currently schedule the callback in multiple places, will wait until those - // are consolidated. - if ( - includesSomeLane(pendingPassiveEffectsLanes, SyncLane) && - root.tag !== LegacyRoot - ) { - flushPassiveEffects(); - } - // If layout work was scheduled, flush it now. flushSyncCallbacks(); diff --git a/packages/react-reconciler/src/__tests__/ReactFlushSync-test.js b/packages/react-reconciler/src/__tests__/ReactFlushSync-test.js index 327b4a87ca678..f763e44705aaa 100644 --- a/packages/react-reconciler/src/__tests__/ReactFlushSync-test.js +++ b/packages/react-reconciler/src/__tests__/ReactFlushSync-test.js @@ -61,73 +61,4 @@ describe('ReactFlushSync', () => { }); expect(root).toMatchRenderedOutput('1, 1'); }); - - test('flushes passive effects synchronously when they are the result of a sync render', async () => { - function App() { - useEffect(() => { - Scheduler.unstable_yieldValue('Effect'); - }, []); - return ; - } - - const root = ReactNoop.createRoot(); - await ReactNoop.act(async () => { - ReactNoop.flushSync(() => { - root.render(); - }); - expect(Scheduler).toHaveYielded([ - 'Child', - // Because the pending effect was the result of a sync update, calling - // flushSync should flush it. - 'Effect', - ]); - expect(root).toMatchRenderedOutput('Child'); - }); - }); - - test('do not flush passive effects synchronously in legacy mode', async () => { - function App() { - useEffect(() => { - Scheduler.unstable_yieldValue('Effect'); - }, []); - return ; - } - - const root = ReactNoop.createLegacyRoot(); - await ReactNoop.act(async () => { - ReactNoop.flushSync(() => { - root.render(); - }); - expect(Scheduler).toHaveYielded([ - 'Child', - // Because we're in legacy mode, we shouldn't have flushed the passive - // effects yet. - ]); - expect(root).toMatchRenderedOutput('Child'); - }); - // Effect flushes after paint. - expect(Scheduler).toHaveYielded(['Effect']); - }); - - test("do not flush passive effects synchronously when they aren't the result of a sync render", async () => { - function App() { - useEffect(() => { - Scheduler.unstable_yieldValue('Effect'); - }, []); - return ; - } - - const root = ReactNoop.createRoot(); - await ReactNoop.act(async () => { - root.render(); - expect(Scheduler).toFlushUntilNextPaint([ - 'Child', - // Because the passive effect was not the result of a sync update, it - // should not flush before paint. - ]); - expect(root).toMatchRenderedOutput('Child'); - }); - // Effect flushes after paint. - expect(Scheduler).toHaveYielded(['Effect']); - }); }); diff --git a/packages/react-reconciler/src/__tests__/ReactHooksWithNoopRenderer-test.js b/packages/react-reconciler/src/__tests__/ReactHooksWithNoopRenderer-test.js index 27d09697fc213..a02c64067195c 100644 --- a/packages/react-reconciler/src/__tests__/ReactHooksWithNoopRenderer-test.js +++ b/packages/react-reconciler/src/__tests__/ReactHooksWithNoopRenderer-test.js @@ -32,7 +32,6 @@ let useDeferredValue; let forwardRef; let memo; let act; -let ContinuousEventPriority; describe('ReactHooksWithNoopRenderer', () => { beforeEach(() => { @@ -56,8 +55,6 @@ describe('ReactHooksWithNoopRenderer', () => { useDeferredValue = React.unstable_useDeferredValue; Suspense = React.Suspense; act = ReactNoop.act; - ContinuousEventPriority = require('react-reconciler/constants') - .ContinuousEventPriority; textCache = new Map(); @@ -1400,10 +1397,10 @@ describe('ReactHooksWithNoopRenderer', () => { expect(Scheduler).toFlushAndYieldThrough(['Child one render']); // Schedule unmount for the parent that unmounts children with pending update. - ReactNoop.unstable_runWithPriority(ContinuousEventPriority, () => { + ReactNoop.flushSync(() => { setParentState(false); }); - expect(Scheduler).toFlushUntilNextPaint([ + expect(Scheduler).toHaveYielded([ 'Parent false render', 'Parent false commit', ]);