Skip to content

[DevTools] Finalize heuristic for naming unnamed <Suspense> #34428

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

Merged
eps1lon merged 1 commit into from
Sep 9, 2025
Merged

[DevTools] Finalize heuristic for naming unnamed <Suspense> #34428

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
6 changes: 3 additions & 3 deletions packages/react-devtools-shared/src/__tests__/profilingCommitTreeBuilder-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ describe('commit tree', () => {
▾ <App>
<Suspense>
[suspense-root] rects={null}
<Suspense name="App>?" rects={null}>
<Suspense name="App" rects={null}>
`);
utils.act(() => modernRender(<App renderChildren={true} />));
expect(store).toMatchInlineSnapshot(`
Expand All @@ -238,7 +238,7 @@ describe('commit tree', () => {
▾ <Suspense>
<LazyInnerComponent>
[suspense-root] rects={null}
<Suspense name="App>?" rects={null}>
<Suspense name="App" rects={null}>
`);
utils.act(() => modernRender(<App renderChildren={false} />));
expect(store).toMatchInlineSnapshot(`
Expand Down Expand Up @@ -304,7 +304,7 @@ describe('commit tree', () => {
▾ <App>
<Suspense>
[suspense-root] rects={null}
<Suspense name="App>?" rects={null}>
<Suspense name="App" rects={null}>
`);
utils.act(() => modernRender(<App renderChildren={false} />));
expect(store).toMatchInlineSnapshot(`
Expand Down
30 changes: 15 additions & 15 deletions packages/react-devtools-shared/src/__tests__/store-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -493,7 +493,7 @@ describe('Store', () => {
▾ <Suspense>
<Loading>
[suspense-root] rects={[{x:1,y:2,width:5,height:1}, {x:1,y:2,width:10,height:1}]}
<Suspense name="Wrapper>?" rects={null}>
<Suspense name="Wrapper" rects={null}>
`);

await act(() => {
Expand All @@ -506,7 +506,7 @@ describe('Store', () => {
▾ <Suspense>
<Component key="Inside">
[suspense-root] rects={[{x:1,y:2,width:5,height:1}, {x:1,y:2,width:5,height:1}]}
<Suspense name="Wrapper>?" rects={[{x:1,y:2,width:5,height:1}]}>
<Suspense name="Wrapper" rects={[{x:1,y:2,width:5,height:1}]}>
`);
});

Expand Down Expand Up @@ -1054,7 +1054,7 @@ describe('Store', () => {
▾ <Suspense>
<Loading>
[suspense-root] rects={[{x:1,y:2,width:5,height:1}, {x:1,y:2,width:10,height:1}]}
<Suspense name="Wrapper>?" rects={null}>
<Suspense name="Wrapper" rects={null}>
`);

await act(() => {
Expand All @@ -1069,7 +1069,7 @@ describe('Store', () => {
<Component key="B">
<Component key="C">
[suspense-root] rects={[{x:1,y:2,width:5,height:1}, {x:1,y:2,width:5,height:1}, {x:1,y:2,width:5,height:1}]}
<Suspense name="Wrapper>?" rects={[{x:1,y:2,width:5,height:1}]}>
<Suspense name="Wrapper" rects={[{x:1,y:2,width:5,height:1}]}>
`);
});

Expand Down Expand Up @@ -1407,7 +1407,7 @@ describe('Store', () => {
[root]
▸ <Wrapper>
[suspense-root] rects={[{x:1,y:2,width:5,height:1}, {x:1,y:2,width:10,height:1}]}
<Suspense name="Wrapper>?" rects={null}>
<Suspense name="Wrapper" rects={null}>
`);

// This test isn't meaningful unless we expand the suspended tree
Expand All @@ -1424,7 +1424,7 @@ describe('Store', () => {
▾ <Suspense>
<Loading>
[suspense-root] rects={[{x:1,y:2,width:5,height:1}, {x:1,y:2,width:10,height:1}]}
<Suspense name="Wrapper>?" rects={null}>
<Suspense name="Wrapper" rects={null}>
`);

await act(() => {
Expand All @@ -1437,7 +1437,7 @@ describe('Store', () => {
▾ <Suspense>
<Component key="Inside">
[suspense-root] rects={[{x:1,y:2,width:5,height:1}, {x:1,y:2,width:5,height:1}]}
<Suspense name="Wrapper>?" rects={[{x:1,y:2,width:5,height:1}]}>
<Suspense name="Wrapper" rects={[{x:1,y:2,width:5,height:1}]}>
`);
});

Expand Down Expand Up @@ -1663,7 +1663,7 @@ describe('Store', () => {
[root]
▸ <SuspenseTree>
[suspense-root] rects={null}
<Suspense name="SuspenseTree>?" rects={null}>
<Suspense name="SuspenseTree" rects={null}>
`);

await act(() =>
Expand All @@ -1678,7 +1678,7 @@ describe('Store', () => {
▾ <Suspense>
▸ <Parent>
[suspense-root] rects={null}
<Suspense name="SuspenseTree>?" rects={null}>
<Suspense name="SuspenseTree" rects={null}>
`);

const rendererID = getRendererID();
Expand All @@ -1697,7 +1697,7 @@ describe('Store', () => {
▾ <Suspense>
<Fallback>
[suspense-root] rects={null}
<Suspense name="SuspenseTree>?" rects={null}>
<Suspense name="SuspenseTree" rects={null}>
`);

await act(() =>
Expand All @@ -1713,7 +1713,7 @@ describe('Store', () => {
▾ <Suspense>
▸ <Parent>
[suspense-root] rects={null}
<Suspense name="SuspenseTree>?" rects={null}>
<Suspense name="SuspenseTree" rects={null}>
`);
});
});
Expand Down Expand Up @@ -2018,7 +2018,7 @@ describe('Store', () => {
▾ <App>
<Suspense>
[suspense-root] rects={null}
<Suspense name="App>?" rects={null}>
<Suspense name="App" rects={null}>
`);

await Promise.resolve();
Expand All @@ -2032,7 +2032,7 @@ describe('Store', () => {
▾ <Suspense>
<LazyInnerComponent>
[suspense-root] rects={null}
<Suspense name="App>?" rects={null}>
<Suspense name="App" rects={null}>
`);

// Render again to unmount it
Expand Down Expand Up @@ -2523,7 +2523,7 @@ describe('Store', () => {
▾ <Suspense>
<ChildA>
[suspense-root] rects={null}
<Suspense name="App>?" rects={null}>
<Suspense name="App" rects={null}>
`);

await actAsync(() => render(<App renderA={false} />));
Expand All @@ -2534,7 +2534,7 @@ describe('Store', () => {
▾ <Suspense>
<ChildB>
[suspense-root] rects={null}
<Suspense name="App>?" rects={null}>
<Suspense name="App" rects={null}>
`);
});
});
Expand Down
8 changes: 4 additions & 4 deletions packages/react-devtools-shared/src/__tests__/treeContext-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1369,8 +1369,8 @@ describe('TreeListContext', () => {
▾ <Suspense>
<Grandchild>
[suspense-root] rects={null}
<Suspense name="Parent>?" rects={null}>
<Suspense name="Child>?" rects={null}>
<Suspense name="Parent" rects={null}>
<Suspense name="Child" rects={null}>
`);

const outerSuspenseID = ((store.getElementIDAtIndex(1): any): number);
Expand Down Expand Up @@ -1411,8 +1411,8 @@ describe('TreeListContext', () => {
▾ <Suspense>
<Grandchild>
[suspense-root] rects={null}
<Suspense name="Parent>?" rects={null}>
<Suspense name="Child>?" rects={null}>
<Suspense name="Parent" rects={null}>
<Suspense name="Child" rects={null}>
`);
});
});
Expand Down
11 changes: 5 additions & 6 deletions packages/react-devtools-shared/src/devtools/store.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1950,14 +1950,13 @@ export default class Store extends EventEmitter<{
throw error;
}

_guessSuspenseName(element: Element): string | null {
// TODO: Use key
_guessSuspenseName(element: Element): string {
const owner = this._idToElement.get(element.ownerID);
if (owner !== undefined) {
// TODO: This is clowny
return `${owner.displayName || 'Unknown'}>?`;
let name = 'Unknown';
if (owner !== undefined && owner.displayName !== null) {
name = owner.displayName;
}

return null;
return name;
}
}
Loading