Skip to content

[DevTools] Ignore duplicate commit tree adds #36474

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
yudin-s wants to merge 1 commit into
base: main
Choose a base branch
from
+100 −6
Open

[DevTools] Ignore duplicate commit tree adds #36474

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
90 changes: 90 additions & 0 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 @@ -9,6 +9,15 @@

import type Store from 'react-devtools-shared/src/devtools/store';

import {
TREE_OPERATION_ADD,
TREE_OPERATION_UPDATE_TREE_BASE_DURATION,
} from 'react-devtools-shared/src/constants';
import {
ElementTypeFunction,
ElementTypeRoot,
} from 'react-devtools-shared/src/frontend/types';
import {getCommitTree} from 'react-devtools-shared/src/devtools/views/Profiler/CommitTreeBuilder';
import {getVersionedRenderImplementation} from './utils';

describe('commit tree', () => {
Expand All @@ -31,6 +40,87 @@ describe('commit tree', () => {

const {render} = getVersionedRenderImplementation();

// @reactVersion >= 16.9
it('should ignore duplicate add operations for nodes already in the commit tree', () => {
const snapshots = new Map([
[
1,
{
children: [2],
compiledWithForget: false,
displayName: null,
hocDisplayNames: null,
id: 1,
key: null,
type: ElementTypeRoot,
},
],
[
2,
{
children: [],
compiledWithForget: false,
displayName: 'Parent',
hocDisplayNames: null,
id: 2,
key: null,
type: ElementTypeFunction,
},
],
]);
const initialTreeBaseDurations = new Map([
[1, 0],
[2, 10],
]);
const operations = [
[
1, // renderer ID
1, // root ID
0, // string table size
TREE_OPERATION_ADD,
2,
ElementTypeFunction,
1,
0,
0,
0,
0,
TREE_OPERATION_UPDATE_TREE_BASE_DURATION,
2,
20000,
],
];
const profilerStore = {
profilingData: {
dataForRoots: new Map([
[
1,
{
commitData: [],
displayName: 'Parent',
initialTreeBaseDurations,
operations,
rootID: 1,
snapshots,
},
],
]),
imported: false,
timelineData: [],
},
};

const commitTree = getCommitTree({
commitIndex: 0,
profilerStore,
rootID: 1,
});

expect(commitTree.nodes.size).toBe(2);
expect(commitTree.nodes.get(1)?.children).toEqual([2]);
expect(commitTree.nodes.get(2)?.treeBaseDuration).toBe(20);
});

// @reactVersion >= 16.9
it('should be able to rebuild the store tree for each commit', () => {
const Parent = ({count}) => {
Expand Down
16 changes: 10 additions & 6 deletions packages/react-devtools-shared/src/devtools/views/Profiler/CommitTreeBuilder.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,13 +201,12 @@ function updateTree(

i += 3;

if (nodes.has(id)) {
throw new Error(
`Commit tree already contains fiber "${id}". This is a bug in React DevTools.`,
);
}

if (type === ElementTypeRoot) {
if (nodes.has(id)) {
i += 4;
break;
}

i++; // isStrictModeCompliant
i++; // Profiling flag
i++; // supportsStrictMode flag
Expand All @@ -231,6 +230,11 @@ function updateTree(

nodes.set(id, node);
} else {
if (nodes.has(id)) {
i += 5;
break;
}

const parentID = ((operations[i]: any): number);
i++;

Expand Down