Skip to content

Allow more component types as SuspenseList children #35643

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.

Sign up for GitHub

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

Open
jackpope wants to merge 1 commit into
base: main
Choose a base branch
from
+216 −14
Open

Allow more component types as SuspenseList children #35643

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
45 changes: 44 additions & 1 deletion packages/react-reconciler/src/ReactFiber.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -443,6 +443,49 @@ export function createWorkInProgress(current: Fiber, pendingProps: any): Fiber {
return workInProgress;
}

// Resets the stateNode to a fresh object.
// This is used for components which don't set their stateNode in completeWork.
function resetWorkInProgressStateNode(workInProgress: Fiber): void {
switch (workInProgress.tag) {
case ViewTransitionComponent:
const viewTransitionState: ViewTransitionState = {
autoName: null,
paired: null,
clones: null,
ref: null,
};
workInProgress.stateNode = viewTransitionState;
break;
case Profiler:
if (enableProfilerTimer) {
workInProgress.stateNode = {
effectDuration: 0,
passiveEffectDuration: 0,
};
}
break;
case TracingMarkerComponent:
if (enableTransitionTracing) {
const tracingMarkerInstance: TracingMarkerInstance = {
tag: TransitionTracingMarker,
transitions: null,
pendingBoundaries: null,
aborts: null,
name: workInProgress.pendingProps.name,
};
workInProgress.stateNode = tracingMarkerInstance;
}
break;
case HostPortal:
case DehydratedFragment:
// These preserve their stateNode
break;
default: {
workInProgress.stateNode = null;
}
}
}

// Used to reuse a Fiber for a second pass.
export function resetWorkInProgress(
workInProgress: Fiber,
Expand Down Expand Up @@ -476,7 +519,7 @@ export function resetWorkInProgress(

workInProgress.dependencies = null;

workInProgress.stateNode = null;
Copy link
Collaborator

@eps1lon eps1lon Jan 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was my first intuition for fixing a similar issue for Activity but we specifically moved to creating the stateNode in the begin phase: https://github.com/facebook/react/pull/34127/changes

resetWorkInProgressStateNode(workInProgress);

if (enableProfilerTimer) {
// Note: We don't reset the actualTime counts. It's useful to accumulate
Expand Down
13 changes: 0 additions & 13 deletions packages/react-reconciler/src/ReactFiberBeginWork.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@ import type {
import type {UpdateQueue} from './ReactFiberClassUpdateQueue';
import type {RootState} from './ReactFiberRoot';
import type {TracingMarkerInstance} from './ReactFiberTracingMarkerComponent';
import type {ViewTransitionState} from './ReactFiberViewTransitionComponent';

import {
markComponentRenderStarted,
Expand Down Expand Up @@ -3563,18 +3562,6 @@ function updateViewTransition(
workInProgress: Fiber,
renderLanes: Lanes,
) {
if (workInProgress.stateNode === null) {
// We previously reset the work-in-progress.
// We need to create a new ViewTransitionState instance.
const instance: ViewTransitionState = {
autoName: null,
paired: null,
clones: null,
ref: null,
};
workInProgress.stateNode = instance;
}

const pendingProps: ViewTransitionProps = workInProgress.pendingProps;
if (pendingProps.name != null && pendingProps.name !== 'auto') {
// Explicitly named boundary. We track it so that we can pair it up with another explicit
Expand Down
172 changes: 172 additions & 0 deletions packages/react-reconciler/src/__tests__/ReactSuspenseList-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3736,4 +3736,176 @@ describe('ReactSuspenseList', () => {
' in Foo (at **)',
]);
});

// @gate enableSuspenseList
it('displays all "together" with various wrapper types as direct children', async () => {
const A = createAsyncText('A');
const B = createAsyncText('B');
const C = createAsyncText('C');
const D = createAsyncText('D');
const E = createAsyncText('E');
const F = createAsyncText('F');
const G = createAsyncText('G');

const MemoSuspense = React.memo(function MemoSuspense({
fallback,
children,
}) {
return <Suspense fallback={fallback}>{children}</Suspense>;
});

const ForwardRefSuspense = React.forwardRef(function ForwardRefSuspense(
{fallback, children},
ref,
) {
return (
<Suspense fallback={fallback}>
<span ref={ref}>{children}</span>
</Suspense>
);
});

// Custom function component wrapper
function CustomWrapper({fallback, children}) {
return <Suspense fallback={fallback}>{children}</Suspense>;
}

// Inlined portal helper
function Portal({children, container}) {
return {
$$typeof: Symbol.for('react.portal'),
key: null,
children,
containerInfo: container,
implementation: null,
};
}

const portalContainer = {rootID: 'portal-container', children: []};

function Foo() {
return (
<SuspenseList revealOrder="together">
<Profiler id="profiler" onRender={() => {}}>
<Suspense fallback={<Text text="Loading A" />}>
<A />
</Suspense>
</Profiler>
<>
<Suspense fallback={<Text text="Loading B" />}>
<B />
</Suspense>
</>
<MemoSuspense fallback={<Text text="Loading C" />}>
<C />
</MemoSuspense>
<ForwardRefSuspense fallback={<Text text="Loading D" />}>
<D />
</ForwardRefSuspense>
<CustomWrapper fallback={<Text text="Loading E" />}>
<E />
</CustomWrapper>
<div>
<Suspense fallback={<Text text="Loading F" />}>
<F />
</Suspense>
</div>
<Portal container={portalContainer}>
<Suspense fallback={<Text text="Loading G" />}>
<G />
</Suspense>
</Portal>
</SuspenseList>
);
}

ReactNoop.render(<Foo />);

await waitForAll([
'Suspend! [A]',
'Loading A',
'Suspend! [B]',
'Loading B',
'Suspend! [C]',
'Loading C',
'Suspend! [D]',
'Loading D',
'Suspend! [E]',
'Loading E',
'Suspend! [F]',
'Loading F',
'Suspend! [G]',
'Loading G',
// SuspenseList does a second pass to force fallbacks
'Loading A',
'Loading B',
'Loading C',
'Loading D',
'Loading E',
'Loading F',
'Loading G',
]);

expect(ReactNoop).toMatchRenderedOutput(
<>
<span>Loading A</span>
<span>Loading B</span>
<span>Loading C</span>
<span>Loading D</span>
<span>Loading E</span>
<div>
<span>Loading F</span>
</div>
</>,
);

await act(() => A.resolve());
assertLog([
'A',
'Suspend! [B]',
'Suspend! [C]',
'Suspend! [D]',
'Suspend! [E]',
'Suspend! [F]',
'Suspend! [G]',
]);

expect(ReactNoop).toMatchRenderedOutput(
<>
<span>Loading A</span>
<span>Loading B</span>
<span>Loading C</span>
<span>Loading D</span>
<span>Loading E</span>
<div>
<span>Loading F</span>
</div>
</>,
);

await act(() => {
B.resolve();
C.resolve();
D.resolve();
E.resolve();
F.resolve();
G.resolve();
});
assertLog(['A', 'B', 'C', 'D', 'E', 'F', 'G']);

expect(ReactNoop).toMatchRenderedOutput(
<>
<span>A</span>
<span>B</span>
<span>C</span>
<span>
<span>D</span>
</span>
<span>E</span>
<div>
<span>F</span>
</div>
</>,
);
});
});
Loading