Skip to content
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.

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

Fix useMemoCache with setState in render #30889

Merged
merged 12 commits into from
Sep 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
42 changes: 32 additions & 10 deletions packages/react-reconciler/src/ReactFiberHooks.js
Original file line number Diff line number Diff line change
Expand Up @@ -770,6 +770,12 @@ export function replaySuspendedComponentWithHooks<Props, SecondArg>(
ignorePreviousDependencies =
current !== null && current.type !== workInProgress.type;
}
// renderWithHooks only resets the updateQueue but does not clear it, since
// it needs to work for both this case (suspense replay) as well as for double
// renders in dev and setState-in-render. However, for the suspense replay case
// we need to reset the updateQueue to correctly handle unmount effects, so we
// clear the queue here
workInProgress.updateQueue = null;
const children = renderWithHooksAgain(
workInProgress,
Component,
Expand Down Expand Up @@ -828,7 +834,9 @@ function renderWithHooksAgain<Props, SecondArg>(
currentHook = null;
workInProgressHook = null;

workInProgress.updateQueue = null;
if (workInProgress.updateQueue != null) {
resetFunctionComponentUpdateQueue((workInProgress.updateQueue: any));
}

if (__DEV__) {
// Also validate hook order for cascading updates.
Expand Down Expand Up @@ -1101,6 +1109,22 @@ if (enableUseMemoCacheHook) {
};
}

function resetFunctionComponentUpdateQueue(
updateQueue: FunctionComponentUpdateQueue,
): void {
updateQueue.lastEffect = null;
updateQueue.events = null;
updateQueue.stores = null;
if (enableUseMemoCacheHook) {
if (updateQueue.memoCache != null) {
// NOTE: this function intentionally does not reset memoCache data. We reuse updateQueue for the memo
// cache to avoid increasing the size of fibers that don't need a cache, but we don't want to reset
// the cache when other properties are reset.
updateQueue.memoCache.index = 0;
}
}
}

function useThenable<T>(thenable: Thenable<T>): T {
// Track the position of the thenable within this fiber.
const index = thenableIndexCounter;
Expand Down Expand Up @@ -2496,17 +2520,15 @@ function pushEffect(
if (componentUpdateQueue === null) {
componentUpdateQueue = createFunctionComponentUpdateQueue();
currentlyRenderingFiber.updateQueue = (componentUpdateQueue: any);
}
const lastEffect = componentUpdateQueue.lastEffect;
if (lastEffect === null) {
componentUpdateQueue.lastEffect = effect.next = effect;
} else {
const lastEffect = componentUpdateQueue.lastEffect;
if (lastEffect === null) {
componentUpdateQueue.lastEffect = effect.next = effect;
} else {
const firstEffect = lastEffect.next;
lastEffect.next = effect;
effect.next = firstEffect;
componentUpdateQueue.lastEffect = effect;
}
const firstEffect = lastEffect.next;
lastEffect.next = effect;
effect.next = firstEffect;
componentUpdateQueue.lastEffect = effect;
Comment on lines +2523 to +2531
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

drive by cleanup since i was here

}
return effect;
}
Expand Down
24 changes: 10 additions & 14 deletions packages/react-reconciler/src/__tests__/useMemoCache-test.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ let assertLog;
let useMemo;
let useState;
let useMemoCache;
let waitForThrow;
let MemoCacheSentinel;
let ErrorBoundary;

Expand All @@ -32,7 +31,6 @@ describe('useMemoCache()', () => {
useMemo = React.useMemo;
useMemoCache = require('react/compiler-runtime').c;
useState = React.useState;
waitForThrow = require('internal-test-utils').waitForThrow;
MemoCacheSentinel = Symbol.for('react.memo_cache_sentinel');

class _ErrorBoundary extends React.Component {
Expand Down Expand Up @@ -667,7 +665,7 @@ describe('useMemoCache()', () => {
}

// Baseline / source code
function useUserMemo(value) {
function useManualMemo(value) {
return useMemo(() => [value], [value]);
}

Expand All @@ -683,24 +681,22 @@ describe('useMemoCache()', () => {
}

/**
* Test case: note that the initial render never completes
* Test with useMemoCache
*/
let root = ReactNoop.createRoot();
const IncorrectInfiniteComponent = makeComponent(useCompilerMemo);
root.render(<IncorrectInfiniteComponent value={2} />);
await waitForThrow(
'Too many re-renders. React limits the number of renders to prevent ' +
'an infinite loop.',
);
const CompilerMemoComponent = makeComponent(useCompilerMemo);
await act(() => {
root.render(<CompilerMemoComponent value={2} />);
});
expect(root).toMatchRenderedOutput(<div>2</div>);

/**
* Baseline test: initial render is expected to complete after a retry
* (triggered by the setState)
* Test with useMemo
*/
root = ReactNoop.createRoot();
const CorrectComponent = makeComponent(useUserMemo);
const HookMemoComponent = makeComponent(useManualMemo);
await act(() => {
root.render(<CorrectComponent value={2} />);
root.render(<HookMemoComponent value={2} />);
});
expect(root).toMatchRenderedOutput(<div>2</div>);
});
Expand Down
Loading