Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[pull] main from facebook:main #44

Merged
merged 2 commits into from
Dec 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions packages/react-dom/src/__tests__/ReactDOMSelect-test.js
Original file line number Diff line number Diff line change
Expand Up @@ -911,9 +911,7 @@ describe('ReactDOMSelect', () => {
const container = document.createElement('div');
const root = ReactDOMClient.createRoot(container);
async function changeView() {
await act(() => {
root.unmount();
});
root.unmount();
}

const stub = (
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3743,6 +3743,10 @@ describe('ReactDOMServerPartialHydration', () => {
await waitForPaint(['App']);
expect(visibleRef.current).toBe(visibleSpan);

if (gate(flags => flags.enableYieldingBeforePassive)) {
// Passive effects.
await waitForPaint([]);
}
// Subsequently, the hidden child is prerendered on the client
await waitForPaint(['HiddenChild']);
expect(container).toMatchInlineSnapshot(`
Expand Down
20 changes: 16 additions & 4 deletions packages/react-reconciler/src/ReactFiberRootScheduler.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import {
enableProfilerNestedUpdatePhase,
enableComponentPerformanceTrack,
enableSiblingPrerendering,
enableYieldingBeforePassive,
} from 'shared/ReactFeatureFlags';
import {
NoLane,
Expand All @@ -41,6 +42,8 @@ import {
getExecutionContext,
getWorkInProgressRoot,
getWorkInProgressRootRenderLanes,
getRootWithPendingPassiveEffects,
getPendingPassiveEffectsLanes,
isWorkLoopSuspendedOnData,
performWorkOnRoot,
} from './ReactFiberWorkLoop';
Expand Down Expand Up @@ -324,12 +327,21 @@ function scheduleTaskForRootDuringMicrotask(
markStarvedLanesAsExpired(root, currentTime);

// Determine the next lanes to work on, and their priority.
const rootWithPendingPassiveEffects = getRootWithPendingPassiveEffects();
const pendingPassiveEffectsLanes = getPendingPassiveEffectsLanes();
const workInProgressRoot = getWorkInProgressRoot();
const workInProgressRootRenderLanes = getWorkInProgressRootRenderLanes();
const nextLanes = getNextLanes(
root,
root === workInProgressRoot ? workInProgressRootRenderLanes : NoLanes,
);
const nextLanes =
enableYieldingBeforePassive && root === rootWithPendingPassiveEffects
? // This will schedule the callback at the priority of the lane but we used to
// always schedule it at NormalPriority. Discrete will flush it sync anyway.
// So the only difference is Idle and it doesn't seem necessarily right for that
// to get upgraded beyond something important just because we're past commit.
pendingPassiveEffectsLanes
: getNextLanes(
root,
root === workInProgressRoot ? workInProgressRootRenderLanes : NoLanes,
);

const existingCallbackNode = root.callbackNode;
if (
Expand Down
76 changes: 54 additions & 22 deletions packages/react-reconciler/src/ReactFiberWorkLoop.js
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ import {
disableDefaultPropsExceptForClasses,
enableSiblingPrerendering,
enableComponentPerformanceTrack,
enableYieldingBeforePassive,
} from 'shared/ReactFeatureFlags';
import ReactSharedInternals from 'shared/ReactSharedInternals';
import is from 'shared/objectIs';
Expand Down Expand Up @@ -610,7 +611,6 @@ export function getRenderTargetTime(): number {

let legacyErrorBoundariesThatAlreadyFailed: Set<mixed> | null = null;

let rootDoesHavePassiveEffects: boolean = false;
let rootWithPendingPassiveEffects: FiberRoot | null = null;
let pendingPassiveEffectsLanes: Lanes = NoLanes;
let pendingPassiveEffectsRemainingLanes: Lanes = NoLanes;
Expand Down Expand Up @@ -638,6 +638,14 @@ export function getWorkInProgressRootRenderLanes(): Lanes {
return workInProgressRootRenderLanes;
}

export function getRootWithPendingPassiveEffects(): FiberRoot | null {
return rootWithPendingPassiveEffects;
}

export function getPendingPassiveEffectsLanes(): Lanes {
return pendingPassiveEffectsLanes;
}

export function isWorkLoopSuspendedOnData(): boolean {
return (
workInProgressSuspendedReason === SuspendedOnData ||
Expand Down Expand Up @@ -3210,12 +3218,6 @@ function commitRootImpl(
);
}

// commitRoot never returns a continuation; it always finishes synchronously.
// So we can clear these now to allow a new callback to be scheduled.
root.callbackNode = null;
root.callbackPriority = NoLane;
root.cancelPendingCommit = null;

// Check which lanes no longer have any work scheduled on them, and mark
// those as finished.
let remainingLanes = mergeLanes(finishedWork.lanes, finishedWork.childLanes);
Expand Down Expand Up @@ -3253,6 +3255,7 @@ function commitRootImpl(
// might get scheduled in the commit phase. (See #16714.)
// TODO: Delete all other places that schedule the passive effect callback
// They're redundant.
let rootDoesHavePassiveEffects: boolean = false;
if (
// If this subtree rendered with profiling this commit, we need to visit it to log it.
(enableProfilerTimer &&
Expand All @@ -3261,17 +3264,25 @@ function commitRootImpl(
(finishedWork.subtreeFlags & PassiveMask) !== NoFlags ||
(finishedWork.flags & PassiveMask) !== NoFlags
) {
if (!rootDoesHavePassiveEffects) {
rootDoesHavePassiveEffects = true;
pendingPassiveEffectsRemainingLanes = remainingLanes;
pendingPassiveEffectsRenderEndTime = completedRenderEndTime;
// workInProgressTransitions might be overwritten, so we want
// to store it in pendingPassiveTransitions until they get processed
// We need to pass this through as an argument to commitRoot
// because workInProgressTransitions might have changed between
// the previous render and commit if we throttle the commit
// with setTimeout
pendingPassiveTransitions = transitions;
rootDoesHavePassiveEffects = true;
pendingPassiveEffectsRemainingLanes = remainingLanes;
pendingPassiveEffectsRenderEndTime = completedRenderEndTime;
// workInProgressTransitions might be overwritten, so we want
// to store it in pendingPassiveTransitions until they get processed
// We need to pass this through as an argument to commitRoot
// because workInProgressTransitions might have changed between
// the previous render and commit if we throttle the commit
// with setTimeout
pendingPassiveTransitions = transitions;
if (enableYieldingBeforePassive) {
// We don't schedule a separate task for flushing passive effects.
// Instead, we just rely on ensureRootIsScheduled below to schedule
// a callback for us to flush the passive effects.
} else {
// So we can clear these now to allow a new callback to be scheduled.
root.callbackNode = null;
root.callbackPriority = NoLane;
root.cancelPendingCommit = null;
scheduleCallback(NormalSchedulerPriority, () => {
if (enableProfilerTimer && enableComponentPerformanceTrack) {
// Track the currently executing event if there is one so we can ignore this
Expand All @@ -3285,6 +3296,12 @@ function commitRootImpl(
return null;
});
}
} else {
// If we don't have passive effects, we're not going to need to perform more work
// so we can clear the callback now.
root.callbackNode = null;
root.callbackPriority = NoLane;
root.cancelPendingCommit = null;
}

if (enableProfilerTimer) {
Expand Down Expand Up @@ -3441,10 +3458,6 @@ function commitRootImpl(
onCommitRootTestSelector();
}

// Always call this before exiting `commitRoot`, to ensure that any
// additional work on this root is scheduled.
ensureRootIsScheduled(root);

if (recoverableErrors !== null) {
// There were errors during this render, but recovered from them without
// needing to surface it to the UI. We log them here.
Expand Down Expand Up @@ -3480,6 +3493,10 @@ function commitRootImpl(
flushPassiveEffects();
}

// Always call this before exiting `commitRoot`, to ensure that any
// additional work on this root is scheduled.
ensureRootIsScheduled(root);

// Read this again, since a passive effect might have updated it
remainingLanes = root.pendingLanes;

Expand Down Expand Up @@ -3648,6 +3665,13 @@ function flushPassiveEffectsImpl(wasDelayedCommit: void | boolean) {
// because it's only used for profiling), but it's a refactor hazard.
pendingPassiveEffectsLanes = NoLanes;

if (enableYieldingBeforePassive) {
// We've finished our work for this render pass.
root.callbackNode = null;
root.callbackPriority = NoLane;
root.cancelPendingCommit = null;
}

if ((executionContext & (RenderContext | CommitContext)) !== NoContext) {
throw new Error('Cannot flush passive effects while already rendering.');
}
Expand Down Expand Up @@ -3745,6 +3769,14 @@ function flushPassiveEffectsImpl(wasDelayedCommit: void | boolean) {
didScheduleUpdateDuringPassiveEffects = false;
}

if (enableYieldingBeforePassive) {
// Next, we reschedule any remaining work in a new task since it's a new
// sequence of work. We wait until the end to do this in case the passive
// effect schedules higher priority work than we had remaining. That way
// we don't schedule an early callback that gets cancelled anyway.
ensureRootIsScheduled(root);
}

// TODO: Move to commitPassiveMountEffects
onPostCommitRootDevTools(root);
if (enableProfilerTimer && enableProfilerCommitHooks) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -753,6 +753,10 @@ describe('ReactDeferredValue', () => {
revealContent();
// Because the preview state was already prerendered, we can reveal it
// without any addditional work.
if (gate(flags => flags.enableYieldingBeforePassive)) {
// Passive effects.
await waitForPaint([]);
}
await waitForPaint([]);
expect(root).toMatchRenderedOutput(<div>Preview [B]</div>);
});
Expand Down
12 changes: 9 additions & 3 deletions packages/react-reconciler/src/__tests__/ReactExpiration-test.js
Original file line number Diff line number Diff line change
Expand Up @@ -755,10 +755,16 @@ describe('ReactExpiration', () => {

// The update finishes without yielding. But it does not flush the effect.
await waitFor(['B1'], {
additionalLogsAfterAttemptingToYield: ['C1'],
additionalLogsAfterAttemptingToYield: gate(
flags => flags.enableYieldingBeforePassive,
)
? ['C1', 'Effect: 1']
: ['C1'],
});
});
// The effect flushes after paint.
assertLog(['Effect: 1']);
if (!gate(flags => flags.enableYieldingBeforePassive)) {
// The effect flushes after paint.
assertLog(['Effect: 1']);
}
});
});
Original file line number Diff line number Diff line change
Expand Up @@ -2695,13 +2695,23 @@ describe('ReactHooksWithNoopRenderer', () => {
React.startTransition(() => {
ReactNoop.render(<Counter count={1} />);
});
await waitForPaint([
'Create passive [current: 0]',
'Destroy insertion [current: 0]',
'Create insertion [current: 0]',
'Destroy layout [current: 1]',
'Create layout [current: 1]',
]);
if (gate(flags => flags.enableYieldingBeforePassive)) {
await waitForPaint(['Create passive [current: 0]']);
await waitForPaint([
'Destroy insertion [current: 0]',
'Create insertion [current: 0]',
'Destroy layout [current: 1]',
'Create layout [current: 1]',
]);
} else {
await waitForPaint([
'Create passive [current: 0]',
'Destroy insertion [current: 0]',
'Create insertion [current: 0]',
'Destroy layout [current: 1]',
'Create layout [current: 1]',
]);
}
expect(committedText).toEqual('1');
});
assertLog([
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,10 @@ describe('ReactSiblingPrerendering', () => {
await waitForPaint(['A']);
expect(root).toMatchRenderedOutput('A');

if (gate(flags => flags.enableYieldingBeforePassive)) {
// Passive effects.
await waitForPaint([]);
}
// The second render is a prerender of the hidden content.
await waitForPaint([
'Suspend! [B]',
Expand Down Expand Up @@ -237,6 +241,10 @@ describe('ReactSiblingPrerendering', () => {
// Immediately after the fallback commits, retry the boundary again. This
// time we include B, since we're not blocking the fallback from showing.
if (gate('enableSiblingPrerendering')) {
if (gate(flags => flags.enableYieldingBeforePassive)) {
// Passive effects.
await waitForPaint([]);
}
await waitForPaint(['Suspend! [A]', 'Suspend! [B]']);
}
});
Expand Down Expand Up @@ -452,6 +460,10 @@ describe('ReactSiblingPrerendering', () => {
</>,
);

if (gate(flags => flags.enableYieldingBeforePassive)) {
// Passive effects.
await waitForPaint([]);
}
// Immediately after the fallback commits, retry the boundary again.
// Because the promise for A resolved, this is a normal render, _not_
// a prerender. So when we proceed to B, and B suspends, we unwind again
Expand All @@ -471,6 +483,10 @@ describe('ReactSiblingPrerendering', () => {
</>,
);

if (gate(flags => flags.enableYieldingBeforePassive)) {
// Passive effects.
await waitForPaint([]);
}
// Now we can proceed to prerendering C.
if (gate('enableSiblingPrerendering')) {
await waitForPaint(['Suspend! [B]', 'Suspend! [C]']);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1901,6 +1901,10 @@ describe('ReactSuspenseWithNoopRenderer', () => {
// be throttled because the fallback would have appeared too recently.
Scheduler.unstable_advanceTime(10000);
jest.advanceTimersByTime(10000);
if (gate(flags => flags.enableYieldingBeforePassive)) {
// Passive effects.
await waitForPaint([]);
}
await waitForPaint(['A']);
expect(ReactNoop).toMatchRenderedOutput(
<>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,14 +81,26 @@ describe('ReactUpdatePriority', () => {
// Schedule another update at default priority
setDefaultState(2);

// The default update flushes first, because
await waitForPaint([
// Idle update is scheduled
'Idle update',

// The default update flushes first, without including the idle update
'Idle: 1, Default: 2',
]);
if (gate(flags => flags.enableYieldingBeforePassive)) {
// The default update flushes first, because
await waitForPaint([
// Idle update is scheduled
'Idle update',
]);
await waitForPaint([
// The default update flushes first, without including the idle update
'Idle: 1, Default: 2',
]);
} else {
// The default update flushes first, because
await waitForPaint([
// Idle update is scheduled
'Idle update',

// The default update flushes first, without including the idle update
'Idle: 1, Default: 2',
]);
}
});
// Now the idle update has flushed
assertLog(['Idle: 2, Default: 2']);
Expand Down
2 changes: 2 additions & 0 deletions packages/scheduler/src/SchedulerFeatureFlags.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,5 @@ export const userBlockingPriorityTimeout = 250;
export const normalPriorityTimeout = 5000;
export const lowPriorityTimeout = 10000;
export const enableRequestPaint = true;

export const enableAlwaysYieldScheduler = __EXPERIMENTAL__;
Loading
Loading