Skip to content

Commit eab523e

Browse files
authored
[Fiber] Avoid duplicate debug info for array children (facebook#35733)
1 parent 272441a commit eab523e

File tree

3 files changed

+101
-7
lines changed

3 files changed

+101
-7
lines changed

packages/react-client/src/__tests__/ReactFlight-test.js

Lines changed: 60 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2820,7 +2820,8 @@ describe('ReactFlight', () => {
28202820
]
28212821
: undefined,
28222822
);
2823-
expect(getDebugInfo(thirdPartyChildren[2])).toEqual(
2823+
const fragment = thirdPartyChildren[2];
2824+
expect(getDebugInfo(fragment)).toEqual(
28242825
__DEV__
28252826
? [
28262827
{time: gate(flags => flags.enableAsyncDebugInfo) ? 54 : 22},
@@ -2835,6 +2836,9 @@ describe('ReactFlight', () => {
28352836
]
28362837
: undefined,
28372838
);
2839+
expect(getDebugInfo(fragment.props.children[0])).toEqual(
2840+
__DEV__ ? null : undefined,
2841+
);
28382842
ReactNoop.render(result);
28392843
});
28402844

@@ -2847,6 +2851,61 @@ describe('ReactFlight', () => {
28472851
);
28482852
});
28492853

2854+
it('preserves debug info for keyed Fragment', async () => {
2855+
function App() {
2856+
return ReactServer.createElement(
2857+
ReactServer.Fragment,
2858+
{key: 'app'},
2859+
ReactServer.createElement('h1', null, 'App'),
2860+
ReactServer.createElement('div', null, 'Child'),
2861+
);
2862+
}
2863+
2864+
const transport = ReactNoopFlightServer.render(
2865+
ReactServer.createElement(
2866+
ReactServer.Fragment,
2867+
null,
2868+
ReactServer.createElement('link', {key: 'styles'}),
2869+
ReactServer.createElement(App, null),
2870+
),
2871+
);
2872+
2873+
await act(async () => {
2874+
const root = await ReactNoopFlightClient.read(transport);
2875+
2876+
const fragment = root[1];
2877+
expect(getDebugInfo(fragment)).toEqual(
2878+
__DEV__
2879+
? [
2880+
{time: 12},
2881+
{
2882+
name: 'App',
2883+
env: 'Server',
2884+
key: null,
2885+
stack: ' in Object.<anonymous> (at **)',
2886+
props: {},
2887+
},
2888+
{time: 13},
2889+
]
2890+
: undefined,
2891+
);
2892+
// Making sure debug info doesn't get added multiple times on Fragment children
2893+
expect(getDebugInfo(fragment[0])).toEqual(__DEV__ ? null : undefined);
2894+
const fragmentChild = fragment[0].props.children[0];
2895+
expect(getDebugInfo(fragmentChild)).toEqual(__DEV__ ? null : undefined);
2896+
2897+
ReactNoop.render(root);
2898+
});
2899+
2900+
expect(ReactNoop).toMatchRenderedOutput(
2901+
<>
2902+
<link />
2903+
<h1>App</h1>
2904+
<div>Child</div>
2905+
</>,
2906+
);
2907+
});
2908+
28502909
// @gate enableAsyncIterableChildren && enableComponentPerformanceTrack
28512910
it('preserves debug info for server-to-server pass through of async iterables', async () => {
28522911
let resolve;

packages/react-devtools-shared/src/__tests__/store-test.js

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2827,6 +2827,40 @@ describe('Store', () => {
28272827
`);
28282828
});
28292829

2830+
// @reactVersion >= 19.0
2831+
it('does not duplicate Server Component parents in keyed Fragments', async () => {
2832+
// TODO: Use an actual Flight renderer.
2833+
// See ReactFlight-test for the produced JSX from Flight.
2834+
function ClientComponent() {
2835+
return null;
2836+
}
2837+
// This used to be a keyed Fragment on the Server.
2838+
const children = [<ClientComponent key="app" />];
2839+
children._debugInfo = [
2840+
{time: 12},
2841+
{
2842+
name: 'App',
2843+
env: 'Server',
2844+
key: null,
2845+
stack: ' in Object.<anonymous> (at **)',
2846+
props: {},
2847+
},
2848+
{time: 13},
2849+
];
2850+
2851+
const container = document.createElement('div');
2852+
const root = ReactDOMClient.createRoot(container);
2853+
await actAsync(() => {
2854+
root.render([children]);
2855+
});
2856+
2857+
expect(store).toMatchInlineSnapshot(`
2858+
[root]
2859+
▾ <App> [Server]
2860+
<ClientComponent key="app">
2861+
`);
2862+
});
2863+
28302864
// @reactVersion >= 17.0
28312865
it('can reconcile Suspense in fallback positions', async () => {
28322866
let resolveFallback;

packages/react-reconciler/src/ReactChildFiber.js

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -789,6 +789,7 @@ function createChildReconciler(
789789
// We treat the parent as the owner for stack purposes.
790790
created._debugOwner = returnFiber;
791791
created._debugTask = returnFiber._debugTask;
792+
// Make sure to not push again when handling the Fragment child.
792793
const prevDebugInfo = pushDebugInfo(newChild._debugInfo);
793794
created._debugInfo = currentDebugInfo;
794795
currentDebugInfo = prevDebugInfo;
@@ -1915,41 +1916,41 @@ function createChildReconciler(
19151916
}
19161917

19171918
if (isArray(newChild)) {
1918-
const prevDebugInfo = pushDebugInfo(newChild._debugInfo);
1919+
// We created a Fragment for this child with the debug info.
1920+
// No need to push again.
19191921
const firstChild = reconcileChildrenArray(
19201922
returnFiber,
19211923
currentFirstChild,
19221924
newChild,
19231925
lanes,
19241926
);
1925-
currentDebugInfo = prevDebugInfo;
19261927
return firstChild;
19271928
}
19281929

19291930
if (getIteratorFn(newChild)) {
1930-
const prevDebugInfo = pushDebugInfo(newChild._debugInfo);
1931+
// We created a Fragment for this child with the debug info.
1932+
// No need to push again.
19311933
const firstChild = reconcileChildrenIteratable(
19321934
returnFiber,
19331935
currentFirstChild,
19341936
newChild,
19351937
lanes,
19361938
);
1937-
currentDebugInfo = prevDebugInfo;
19381939
return firstChild;
19391940
}
19401941

19411942
if (
19421943
enableAsyncIterableChildren &&
19431944
typeof newChild[ASYNC_ITERATOR] === 'function'
19441945
) {
1945-
const prevDebugInfo = pushDebugInfo(newChild._debugInfo);
1946+
// We created a Fragment for this child with the debug info.
1947+
// No need to push again.
19461948
const firstChild = reconcileChildrenAsyncIteratable(
19471949
returnFiber,
19481950
currentFirstChild,
19491951
newChild,
19501952
lanes,
19511953
);
1952-
currentDebugInfo = prevDebugInfo;
19531954
return firstChild;
19541955
}
19551956

0 commit comments

Comments
 (0)