/** * 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 */ describe('StoreStressConcurrent', () => { let React; let ReactDOMClient; let act; let actAsync; let bridge; let store; let print; jest.setTimeout(15000); beforeEach(() => { global.IS_REACT_ACT_ENVIRONMENT = true; bridge = global.bridge; store = global.store; store.collapseNodesByDefault = false; React = require('react'); ReactDOMClient = require('react-dom/client'); act = require('./utils').act; // TODO: Figure out recommendation for concurrent mode tests, then replace // this helper with the real thing. actAsync = require('./utils').actAsync; print = require('./__serializers__/storeSerializer').print; }); // This is a stress test for the tree mount/update/unmount traversal. // It renders different trees that should produce the same output. // @reactVersion >= 18.0 it('should handle a stress test with different tree operations (Concurrent Mode)', () => { let setShowX; const A = () => 'a'; const B = () => 'b'; const C = () => { // We'll be manually flipping this component back and forth in the test. // We only do this for a single node in order to verify that DevTools // can handle a subtree switching alternates while other subtrees are memoized. const [showX, _setShowX] = React.useState(false); setShowX = _setShowX; return showX ? : 'c'; }; const D = () => 'd'; const E = () => 'e'; const X = () => 'x'; const a = ; const b = ; const c = ; const d = ; const e = ; function Parent({children}) { return children; } // 1. Render a normal version of [a, b, c, d, e]. let container = document.createElement('div'); let root = ReactDOMClient.createRoot(container); act(() => root.render({[a, b, c, d, e]})); expect(store).toMatchInlineSnapshot( ` [root] ▾ `, ); expect(container.textContent).toMatch('abcde'); const snapshotForABCDE = print(store); // 2. Render a version where renders an child instead of 'c'. // This is how we'll test an update to a single component. act(() => { setShowX(true); }); expect(store).toMatchInlineSnapshot( ` [root] ▾ `, ); expect(container.textContent).toMatch('abxde'); const snapshotForABXDE = print(store); // 3. Verify flipping it back produces the original result. act(() => { setShowX(false); }); expect(container.textContent).toMatch('abcde'); expect(print(store)).toBe(snapshotForABCDE); // 4. Clean up. act(() => root.unmount()); expect(print(store)).toBe(''); // Now comes the interesting part. // All of these cases are equivalent to [a, b, c, d, e] in output. // We'll verify that DevTools produces the same snapshots for them. // These cases are picked so that rendering them sequentially in the same // container results in a combination of mounts, updates, unmounts, and reorders. // prettier-ignore const cases = [ [a, b, c, d, e], [[a], b, c, d, e], [[a, b], c, d, e], [[a, b], c, [d, e]], [[a, b], c, [d, '', e]], [[a], b, c, d, [e]], [a, b, [[c]], d, e], [[a, ''], [b], [c], [d], [e]], [a, b, [c, [d, ['', e]]]], [a, b, c, d, e], [
{a}
, b, c, d, e], [
{a}{b}
, c, d, e], [
{a}{b}
, c,
{d}{e}
], [
{a}{b}
, c,
{d}{e}
], [
{a}{b}
, c,
{d}{e}
], [
{a}{b}
, c,
{d}{e}
], [{a}, b, c, d, [e]], [a, b, {c}, d, e], [
{a}
, [b], {c}, [d],
{e}
], [a, b, [c,
{d}{e}
], ''], [a, [[]], b, c, [d, [[]], e]], [[[a, b, c, d], e]], [a, b, c, d, e], ]; // 5. Test fresh mount for each case. for (let i = 0; i < cases.length; i++) { // Ensure fresh mount. container = document.createElement('div'); root = ReactDOMClient.createRoot(container); // Verify mounting 'abcde'. act(() => root.render({cases[i]})); expect(container.textContent).toMatch('abcde'); expect(print(store)).toEqual(snapshotForABCDE); // Verify switching to 'abxde'. act(() => { setShowX(true); }); expect(container.textContent).toMatch('abxde'); expect(print(store)).toBe(snapshotForABXDE); // Verify switching back to 'abcde'. act(() => { setShowX(false); }); expect(container.textContent).toMatch('abcde'); expect(print(store)).toBe(snapshotForABCDE); // Clean up. act(() => root.unmount()); expect(print(store)).toBe(''); } // 6. Verify *updates* by reusing the container between iterations. // There'll be no unmounting until the very end. container = document.createElement('div'); root = ReactDOMClient.createRoot(container); for (let i = 0; i < cases.length; i++) { // Verify mounting 'abcde'. act(() => root.render({cases[i]})); expect(container.textContent).toMatch('abcde'); expect(print(store)).toEqual(snapshotForABCDE); // Verify switching to 'abxde'. act(() => { setShowX(true); }); expect(container.textContent).toMatch('abxde'); expect(print(store)).toBe(snapshotForABXDE); // Verify switching back to 'abcde'. act(() => { setShowX(false); }); expect(container.textContent).toMatch('abcde'); expect(print(store)).toBe(snapshotForABCDE); // Don't unmount. Reuse the container between iterations. } act(() => root.unmount()); expect(print(store)).toBe(''); }); // @reactVersion >= 18.0 it('should handle stress test with reordering (Concurrent Mode)', () => { const A = () => 'a'; const B = () => 'b'; const C = () => 'c'; const D = () => 'd'; const E = () => 'e'; const a =
; const b = ; const c = ; const d = ; const e = ; // prettier-ignore const steps = [ a, b, c, d, e, [a], [b], [c], [d], [e], [a, b], [b, a], [b, c], [c, b], [a, c], [c, a], ]; const Root = ({children}) => { return children; }; // 1. Capture the expected render result. const snapshots = []; let container = document.createElement('div'); for (let i = 0; i < steps.length; i++) { const root = ReactDOMClient.createRoot(container); act(() => root.render({steps[i]})); // We snapshot each step once so it doesn't regress. snapshots.push(print(store)); act(() => root.unmount()); expect(print(store)).toBe(''); } expect(snapshots).toMatchInlineSnapshot(` [ "[root] ▾ ", "[root] ▾ ", "[root] ▾ ", "[root] ▾ ", "[root] ▾ ", "[root] ▾ ", "[root] ▾ ", "[root] ▾ ", "[root] ▾ ", "[root] ▾ ", "[root] ▾ ", "[root] ▾ ", "[root] ▾ ", "[root] ▾ ", "[root] ▾ ", "[root] ▾ ", ] `); // 2. Verify that we can update from every step to every other step and back. for (let i = 0; i < steps.length; i++) { for (let j = 0; j < steps.length; j++) { container = document.createElement('div'); const root = ReactDOMClient.createRoot(container); act(() => root.render({steps[i]})); expect(print(store)).toMatch(snapshots[i]); act(() => root.render({steps[j]})); expect(print(store)).toMatch(snapshots[j]); act(() => root.render({steps[i]})); expect(print(store)).toMatch(snapshots[i]); act(() => root.unmount()); expect(print(store)).toBe(''); } } // 3. Same test as above, but this time we wrap children in a host component. for (let i = 0; i < steps.length; i++) { for (let j = 0; j < steps.length; j++) { container = document.createElement('div'); const root = ReactDOMClient.createRoot(container); act(() => root.render(
{steps[i]}
, ), ); expect(print(store)).toMatch(snapshots[i]); act(() => root.render(
{steps[j]}
, ), ); expect(print(store)).toMatch(snapshots[j]); act(() => root.render(
{steps[i]}
, ), ); expect(print(store)).toMatch(snapshots[i]); act(() => root.unmount()); expect(print(store)).toBe(''); } } }); // @reactVersion >= 18.0 it('should handle a stress test for Suspense (Concurrent Mode)', async () => { const A = () => 'a'; const B = () => 'b'; const C = () => 'c'; const X = () => 'x'; const Y = () => 'y'; const Z = () => 'z'; const a =
; const b = ; const c = ; const z = ; // prettier-ignore const steps = [ a, [a], [a, b, c], [c, b, a], [c, null, a], {c}{a},
{c}{a}
,
{a}{b}
, [[a]], null, b, a, ]; const Never = () => { throw new Promise(() => {}); }; const Root = ({children}) => { return children; }; // 1. For each step, check Suspense can render them as initial primary content. // This is the only step where we use Jest snapshots. const snapshots = []; let container = document.createElement('div'); for (let i = 0; i < steps.length; i++) { const root = ReactDOMClient.createRoot(container); act(() => root.render( {steps[i]} , ), ); // We snapshot each step once so it doesn't regress.d snapshots.push(print(store)); act(() => root.unmount()); expect(print(store)).toBe(''); } expect(snapshots).toMatchInlineSnapshot(` [ "[root] ▾
", "[root] ▾ ", "[root] ▾ ", "[root] ▾ ", "[root] ▾ ", "[root] ▾ ", "[root] ▾ ", "[root] ▾ ", "[root] ▾ ", "[root] ▾ ", "[root] ▾ ", "[root] ▾ ", ] `); // 2. Verify check Suspense can render same steps as initial fallback content. for (let i = 0; i < steps.length; i++) { const root = ReactDOMClient.createRoot(container); act(() => root.render( , ), ); expect(print(store)).toEqual(snapshots[i]); act(() => root.unmount()); expect(print(store)).toBe(''); } // 3. Verify we can update from each step to each step in primary mode. for (let i = 0; i < steps.length; i++) { for (let j = 0; j < steps.length; j++) { // Always start with a fresh container and steps[i]. container = document.createElement('div'); const root = ReactDOMClient.createRoot(container); act(() => root.render( {steps[i]} , ), ); expect(print(store)).toEqual(snapshots[i]); // Re-render with steps[j]. act(() => root.render( {steps[j]} , ), ); // Verify the successful transition to steps[j]. expect(print(store)).toEqual(snapshots[j]); // Check that we can transition back again. act(() => root.render( {steps[i]} , ), ); expect(print(store)).toEqual(snapshots[i]); // Clean up after every iteration. act(() => root.unmount()); expect(print(store)).toBe(''); } } // 4. Verify we can update from each step to each step in fallback mode. for (let i = 0; i < steps.length; i++) { for (let j = 0; j < steps.length; j++) { // Always start with a fresh container and steps[i]. container = document.createElement('div'); const root = ReactDOMClient.createRoot(container); act(() => root.render( , ), ); expect(print(store)).toEqual(snapshots[i]); // Re-render with steps[j]. act(() => root.render( , ), ); // Verify the successful transition to steps[j]. expect(print(store)).toEqual(snapshots[j]); // Check that we can transition back again. act(() => root.render( , ), ); expect(print(store)).toEqual(snapshots[i]); // Clean up after every iteration. act(() => root.unmount()); expect(print(store)).toBe(''); } } // 5. Verify we can update from each step to each step when moving primary -> fallback. for (let i = 0; i < steps.length; i++) { for (let j = 0; j < steps.length; j++) { // Always start with a fresh container and steps[i]. container = document.createElement('div'); const root = ReactDOMClient.createRoot(container); act(() => root.render( {steps[i]} , ), ); expect(print(store)).toEqual(snapshots[i]); // Re-render with steps[j]. act(() => root.render( , ), ); // Verify the successful transition to steps[j]. expect(print(store)).toEqual(snapshots[j]); // Check that we can transition back again. act(() => root.render( {steps[i]} , ), ); expect(print(store)).toEqual(snapshots[i]); // Clean up after every iteration. act(() => root.unmount()); expect(print(store)).toBe(''); } } // 6. Verify we can update from each step to each step when moving fallback -> primary. for (let i = 0; i < steps.length; i++) { for (let j = 0; j < steps.length; j++) { // Always start with a fresh container and steps[i]. container = document.createElement('div'); const root = ReactDOMClient.createRoot(container); act(() => root.render( , ), ); expect(print(store)).toEqual(snapshots[i]); // Re-render with steps[j]. act(() => root.render( {steps[j]} , ), ); // Verify the successful transition to steps[j]. expect(print(store)).toEqual(snapshots[j]); // Check that we can transition back again. act(() => root.render( , ), ); expect(print(store)).toEqual(snapshots[i]); // Clean up after every iteration. act(() => root.unmount()); expect(print(store)).toBe(''); } } // 7. Verify we can update from each step to each step when toggling Suspense. for (let i = 0; i < steps.length; i++) { for (let j = 0; j < steps.length; j++) { // Always start with a fresh container and steps[i]. container = document.createElement('div'); const root = ReactDOMClient.createRoot(container); act(() => root.render( {steps[i]} , ), ); // We get ID from the index in the tree above: // Root, X, Suspense, ... // ^ (index is 2) const suspenseID = store.getElementIDAtIndex(2); // Force fallback. expect(print(store)).toEqual(snapshots[i]); await actAsync(async () => { bridge.send('overrideSuspense', { id: suspenseID, rendererID: store.getRendererIDForElement(suspenseID), forceFallback: true, }); }); expect(print(store)).toEqual(snapshots[j]); // Stop forcing fallback. await actAsync(async () => { bridge.send('overrideSuspense', { id: suspenseID, rendererID: store.getRendererIDForElement(suspenseID), forceFallback: false, }); }); expect(print(store)).toEqual(snapshots[i]); // Trigger actual fallback. act(() => root.render( , ), ); expect(print(store)).toEqual(snapshots[j]); // Force fallback while we're in fallback mode. act(() => { bridge.send('overrideSuspense', { id: suspenseID, rendererID: store.getRendererIDForElement(suspenseID), forceFallback: true, }); }); // Keep seeing fallback content. expect(print(store)).toEqual(snapshots[j]); // Switch to primary mode. act(() => root.render( {steps[i]} , ), ); // Fallback is still forced though. expect(print(store)).toEqual(snapshots[j]); // Stop forcing fallback. This reverts to primary content. await actAsync(async () => { bridge.send('overrideSuspense', { id: suspenseID, rendererID: store.getRendererIDForElement(suspenseID), forceFallback: false, }); }); // Now we see primary content. expect(print(store)).toEqual(snapshots[i]); // Clean up after every iteration. await actAsync(async () => root.unmount()); expect(print(store)).toBe(''); } } }); // @reactVersion >= 18.0 it('should handle a stress test for Suspense without type change (Concurrent Mode)', async () => { const A = () => 'a'; const B = () => 'b'; const C = () => 'c'; const X = () => 'x'; const Y = () => 'y'; const Z = () => 'z'; const a = ; const b = ; const c = ; const z = ; // prettier-ignore const steps = [ a, [a], [a, b, c], [c, b, a], [c, null, a], {c}{a},
{c}{a}
,
{a}{b}
, [[a]], null, b, a, ]; const Never = () => { throw new Promise(() => {}); }; const MaybeSuspend = ({children, suspend}) => { if (suspend) { return (
{children}
); } return (
{children}
); }; const Root = ({children}) => { return children; }; // 1. For each step, check Suspense can render them as initial primary content. // This is the only step where we use Jest snapshots. const snapshots = []; let container = document.createElement('div'); for (let i = 0; i < steps.length; i++) { const root = ReactDOMClient.createRoot(container); act(() => root.render( {steps[i]} , ), ); // We snapshot each step once so it doesn't regress. snapshots.push(print(store)); act(() => root.unmount()); expect(print(store)).toBe(''); } // 2. Verify check Suspense can render same steps as initial fallback content. // We don't actually assert here because the tree includes // which is different from the snapshots above. So we take more snapshots. const fallbackSnapshots = []; for (let i = 0; i < steps.length; i++) { const root = ReactDOMClient.createRoot(container); act(() => root.render( {steps[i]} , ), ); // We snapshot each step once so it doesn't regress. fallbackSnapshots.push(print(store)); act(() => root.unmount()); expect(print(store)).toBe(''); } expect(snapshots).toMatchInlineSnapshot(` [ "[root] ▾
", "[root] ▾ ", "[root] ▾ ", "[root] ▾ ", "[root] ▾ ", "[root] ▾ ", "[root] ▾ ", "[root] ▾ ", "[root] ▾ ", "[root] ▾ ", "[root] ▾ ", "[root] ▾ ", ] `); // 3. Verify we can update from each step to each step in primary mode. for (let i = 0; i < steps.length; i++) { for (let j = 0; j < steps.length; j++) { // Always start with a fresh container and steps[i]. container = document.createElement('div'); const root = ReactDOMClient.createRoot(container); act(() => root.render( {steps[i]} , ), ); expect(print(store)).toEqual(snapshots[i]); // Re-render with steps[j]. act(() => root.render( {steps[j]} , ), ); // Verify the successful transition to steps[j]. expect(print(store)).toEqual(snapshots[j]); // Check that we can transition back again. act(() => root.render( {steps[i]} , ), ); expect(print(store)).toEqual(snapshots[i]); // Clean up after every iteration. act(() => root.unmount()); expect(print(store)).toBe(''); } } // 4. Verify we can update from each step to each step in fallback mode. for (let i = 0; i < steps.length; i++) { for (let j = 0; j < steps.length; j++) { // Always start with a fresh container and steps[i]. container = document.createElement('div'); const root = ReactDOMClient.createRoot(container); act(() => root.render( , ), ); expect(print(store)).toEqual(fallbackSnapshots[i]); // Re-render with steps[j]. act(() => root.render( , ), ); // Verify the successful transition to steps[j]. expect(print(store)).toEqual(fallbackSnapshots[j]); // Check that we can transition back again. act(() => root.render( , ), ); expect(print(store)).toEqual(fallbackSnapshots[i]); // Clean up after every iteration. act(() => root.unmount()); expect(print(store)).toBe(''); } } // 5. Verify we can update from each step to each step when moving primary -> fallback. for (let i = 0; i < steps.length; i++) { for (let j = 0; j < steps.length; j++) { // Always start with a fresh container and steps[i]. container = document.createElement('div'); const root = ReactDOMClient.createRoot(container); act(() => root.render( {steps[i]} , ), ); expect(print(store)).toEqual(snapshots[i]); // Re-render with steps[j]. act(() => root.render( {steps[i]} , ), ); // Verify the successful transition to steps[j]. expect(print(store)).toEqual(fallbackSnapshots[j]); // Check that we can transition back again. act(() => root.render( {steps[i]} , ), ); expect(print(store)).toEqual(snapshots[i]); // Clean up after every iteration. act(() => root.unmount()); expect(print(store)).toBe(''); } } // 6. Verify we can update from each step to each step when moving fallback -> primary. for (let i = 0; i < steps.length; i++) { for (let j = 0; j < steps.length; j++) { // Always start with a fresh container and steps[i]. container = document.createElement('div'); const root = ReactDOMClient.createRoot(container); act(() => root.render( {steps[j]} , ), ); expect(print(store)).toEqual(fallbackSnapshots[i]); // Re-render with steps[j]. act(() => root.render( {steps[j]} , ), ); // Verify the successful transition to steps[j]. expect(print(store)).toEqual(snapshots[j]); // Check that we can transition back again. act(() => root.render( {steps[j]} , ), ); expect(print(store)).toEqual(fallbackSnapshots[i]); // Clean up after every iteration. act(() => root.unmount()); expect(print(store)).toBe(''); } } // 7. Verify we can update from each step to each step when toggling Suspense. for (let i = 0; i < steps.length; i++) { for (let j = 0; j < steps.length; j++) { // Always start with a fresh container and steps[i]. container = document.createElement('div'); const root = ReactDOMClient.createRoot(container); act(() => root.render( {steps[i]} , ), ); // We get ID from the index in the tree above: // Root, X, Suspense, ... // ^ (index is 2) const suspenseID = store.getElementIDAtIndex(2); // Force fallback. expect(print(store)).toEqual(snapshots[i]); await actAsync(async () => { bridge.send('overrideSuspense', { id: suspenseID, rendererID: store.getRendererIDForElement(suspenseID), forceFallback: true, }); }); expect(print(store)).toEqual(fallbackSnapshots[j]); // Stop forcing fallback. await actAsync(async () => { bridge.send('overrideSuspense', { id: suspenseID, rendererID: store.getRendererIDForElement(suspenseID), forceFallback: false, }); }); expect(print(store)).toEqual(snapshots[i]); // Trigger actual fallback. act(() => root.render( {steps[i]} , ), ); expect(print(store)).toEqual(fallbackSnapshots[j]); // Force fallback while we're in fallback mode. act(() => { bridge.send('overrideSuspense', { id: suspenseID, rendererID: store.getRendererIDForElement(suspenseID), forceFallback: true, }); }); // Keep seeing fallback content. expect(print(store)).toEqual(fallbackSnapshots[j]); // Switch to primary mode. act(() => root.render( {steps[i]} , ), ); // Fallback is still forced though. expect(print(store)).toEqual(fallbackSnapshots[j]); // Stop forcing fallback. This reverts to primary content. await actAsync(async () => { bridge.send('overrideSuspense', { id: suspenseID, rendererID: store.getRendererIDForElement(suspenseID), forceFallback: false, }); }); // Now we see primary content. expect(print(store)).toEqual(snapshots[i]); // Clean up after every iteration. act(() => root.unmount()); expect(print(store)).toBe(''); } } }); });