/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @flow
*/
import type Store from 'react-devtools-shared/src/devtools/store';
import {
getLegacyRenderImplementation,
getModernRenderImplementation,
} from './utils';
describe('commit tree', () => {
let React = require('react');
let Scheduler;
let store: Store;
let utils;
beforeEach(() => {
utils = require('./utils');
utils.beforeEachProfiling();
store = global.store;
store.collapseNodesByDefault = false;
store.recordChangeDescriptions = true;
React = require('react');
Scheduler = require('scheduler');
});
const {render: legacyRender} = getLegacyRenderImplementation();
const {render: modernRender} = getModernRenderImplementation();
// @reactVersion >= 16.9
// @reactVersion <= 18.2
it('should be able to rebuild the store tree for each commit (legacy render)', () => {
const Parent = ({count}) => {
Scheduler.unstable_advanceTime(10);
return new Array(count)
.fill(true)
.map((_, index) => );
};
const Child = React.memo(function Child() {
Scheduler.unstable_advanceTime(2);
return null;
});
utils.act(() => store.profilerStore.startProfiling());
utils.act(() => legacyRender());
expect(store).toMatchInlineSnapshot(`
[root]
▾
[Memo]
`);
utils.act(() => legacyRender());
expect(store).toMatchInlineSnapshot(`
[root]
▾
[Memo]
[Memo]
[Memo]
`);
utils.act(() => legacyRender());
expect(store).toMatchInlineSnapshot(`
[root]
▾
[Memo]
[Memo]
`);
utils.act(() => legacyRender());
expect(store).toMatchInlineSnapshot(`
[root]
`);
utils.act(() => store.profilerStore.stopProfiling());
const rootID = store.roots[0];
const commitTrees = [];
for (let commitIndex = 0; commitIndex < 4; commitIndex++) {
commitTrees.push(
store.profilerStore.profilingCache.getCommitTree({
commitIndex,
rootID,
}),
);
}
expect(commitTrees[0].nodes.size).toBe(3); // + +
expect(commitTrees[1].nodes.size).toBe(5); // + + x 3
expect(commitTrees[2].nodes.size).toBe(4); // + + x 2
expect(commitTrees[3].nodes.size).toBe(2); // +
});
// @reactVersion >= 18
it('should be able to rebuild the store tree for each commit (createRoot)', () => {
const Parent = ({count}) => {
Scheduler.unstable_advanceTime(10);
return new Array(count)
.fill(true)
.map((_, index) => );
};
const Child = React.memo(function Child() {
Scheduler.unstable_advanceTime(2);
return null;
});
utils.act(() => store.profilerStore.startProfiling());
utils.act(() => modernRender());
expect(store).toMatchInlineSnapshot(`
[root]
▾
[Memo]
`);
utils.act(() => modernRender());
expect(store).toMatchInlineSnapshot(`
[root]
▾
[Memo]
[Memo]
[Memo]
`);
utils.act(() => modernRender());
expect(store).toMatchInlineSnapshot(`
[root]
▾
[Memo]
[Memo]
`);
utils.act(() => modernRender());
expect(store).toMatchInlineSnapshot(`
[root]
`);
utils.act(() => store.profilerStore.stopProfiling());
const rootID = store.roots[0];
const commitTrees = [];
for (let commitIndex = 0; commitIndex < 4; commitIndex++) {
commitTrees.push(
store.profilerStore.profilingCache.getCommitTree({
commitIndex,
rootID,
}),
);
}
expect(commitTrees[0].nodes.size).toBe(3); // + +
expect(commitTrees[1].nodes.size).toBe(5); // + + x 3
expect(commitTrees[2].nodes.size).toBe(4); // + + x 2
expect(commitTrees[3].nodes.size).toBe(2); // +
});
describe('Lazy', () => {
async function fakeImport(result) {
return {default: result};
}
const LazyInnerComponent = () => null;
const App = ({renderChildren}) => {
if (renderChildren) {
return (
);
} else {
return null;
}
};
let LazyComponent;
beforeEach(() => {
LazyComponent = React.lazy(() => fakeImport(LazyInnerComponent));
});
// @reactVersion >= 16.9
// @reactVersion <= 18.2
it('should support Lazy components (legacy render)', async () => {
utils.act(() => store.profilerStore.startProfiling());
utils.act(() => legacyRender());
await Promise.resolve();
expect(store).toMatchInlineSnapshot(`
[root]
▾
[suspense-root] rects={null}
`);
utils.act(() => legacyRender());
expect(store).toMatchInlineSnapshot(`
[root]
▾
▾
[suspense-root] rects={null}
`);
utils.act(() => legacyRender());
expect(store).toMatchInlineSnapshot(`
[root]
`);
utils.act(() => store.profilerStore.stopProfiling());
const rootID = store.roots[0];
const commitTrees = [];
for (let commitIndex = 0; commitIndex < 3; commitIndex++) {
commitTrees.push(
store.profilerStore.profilingCache.getCommitTree({
commitIndex,
rootID,
}),
);
}
expect(commitTrees[0].nodes.size).toBe(3);
expect(commitTrees[1].nodes.size).toBe(4); // + + +
expect(commitTrees[2].nodes.size).toBe(2); // +
});
// @reactVersion >= 18.0
it('should support Lazy components (createRoot)', async () => {
utils.act(() => store.profilerStore.startProfiling());
utils.act(() => modernRender());
await Promise.resolve();
expect(store).toMatchInlineSnapshot(`
[root]
▾
[suspense-root] rects={null}
`);
utils.act(() => modernRender());
expect(store).toMatchInlineSnapshot(`
[root]
▾
▾
[suspense-root] rects={null}
`);
utils.act(() => modernRender());
expect(store).toMatchInlineSnapshot(`
[root]
`);
utils.act(() => store.profilerStore.stopProfiling());
const rootID = store.roots[0];
const commitTrees = [];
for (let commitIndex = 0; commitIndex < 3; commitIndex++) {
commitTrees.push(
store.profilerStore.profilingCache.getCommitTree({
commitIndex,
rootID,
}),
);
}
expect(commitTrees[0].nodes.size).toBe(3); // + +
expect(commitTrees[1].nodes.size).toBe(4); // + + +
expect(commitTrees[2].nodes.size).toBe(2); // +
});
// @reactVersion >= 16.9
// @reactVersion <= 18.2
it('should support Lazy components that are unmounted before resolving (legacy render)', async () => {
utils.act(() => store.profilerStore.startProfiling());
utils.act(() => legacyRender());
expect(store).toMatchInlineSnapshot(`
[root]
▾
[suspense-root] rects={null}
`);
utils.act(() => legacyRender());
expect(store).toMatchInlineSnapshot(`
[root]
`);
utils.act(() => store.profilerStore.stopProfiling());
const rootID = store.roots[0];
const commitTrees = [];
for (let commitIndex = 0; commitIndex < 2; commitIndex++) {
commitTrees.push(
store.profilerStore.profilingCache.getCommitTree({
commitIndex,
rootID,
}),
);
}
expect(commitTrees[0].nodes.size).toBe(3);
expect(commitTrees[1].nodes.size).toBe(2); // +
});
// @reactVersion >= 18.0
it('should support Lazy components that are unmounted before resolving (createRoot)', async () => {
utils.act(() => store.profilerStore.startProfiling());
utils.act(() => modernRender());
expect(store).toMatchInlineSnapshot(`
[root]
▾
[suspense-root] rects={null}
`);
utils.act(() => modernRender());
expect(store).toMatchInlineSnapshot(`
[root]
`);
utils.act(() => store.profilerStore.stopProfiling());
const rootID = store.roots[0];
const commitTrees = [];
for (let commitIndex = 0; commitIndex < 2; commitIndex++) {
commitTrees.push(
store.profilerStore.profilingCache.getCommitTree({
commitIndex,
rootID,
}),
);
}
expect(commitTrees[0].nodes.size).toBe(3); // + +
expect(commitTrees[1].nodes.size).toBe(2); // +
});
});
});