Skip to content

Ensure dispatch from useFormState works in StrictMode #28557

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
merged 3 commits into from
Mar 20, 2024
Merged

Ensure dispatch from useFormState works in StrictMode #28557

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c2f1a2c
Failing test for null dispatch returned from `useFormState` in `Stric…
eps1lon Mar 14, 2024
9b3f1f3
Ensure dispatch in `useFormState` works in `StrictMode`
eps1lon Mar 14, 2024
e32f38a
Just advance the hook list
eps1lon Mar 19, 2024
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
48 changes: 48 additions & 0 deletions packages/react-dom/src/__tests__/ReactDOMForm-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1295,4 +1295,52 @@ describe('ReactDOMForm', () => {
assertLog(['B']);
expect(container.textContent).toBe('B');
});

// @gate enableFormActions
// @gate enableAsyncActions
test('useFormState works in StrictMode', async () => {
let actionCounter = 0;
async function action(state, type) {
actionCounter++;

Scheduler.log(`Async action started [${actionCounter}]`);
await getText(`Wait [${actionCounter}]`);

switch (type) {
case 'increment':
return state + 1;
case 'decrement':
return state - 1;
default:
return state;
}
}

let dispatch;
function App() {
const [state, _dispatch, isPending] = useFormState(action, 0);
dispatch = _dispatch;
const pending = isPending ? 'Pending ' : '';
return <Text text={pending + state} />;
}

const root = ReactDOMClient.createRoot(container);
await act(() =>
root.render(
<React.StrictMode>
<App />
</React.StrictMode>,
),
);
assertLog(['0']);
expect(container.textContent).toBe('0');

await act(() => dispatch('increment'));
assertLog(['Async action started [1]', 'Pending 0']);
expect(container.textContent).toBe('Pending 0');

await act(() => resolveText('Wait [1]'));
assertLog(['1']);
expect(container.textContent).toBe('1');
});
});
6 changes: 4 additions & 2 deletions packages/react-reconciler/src/ReactFiberHooks.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2259,6 +2259,9 @@ function rerenderFormState<S, P>(
);
}

// For mount, pending is always false.
const [isPending] = rerenderState(false);
Copy link
Collaborator

@acdlite acdlite Mar 19, 2024

Choose a reason for hiding this comment

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

Since we don't actually need the result, all we need to do is advance the hook list.

Suggested change
const [isPending] = rerenderState(false);
updateWorkInProgressHook();

Copy link
Collaborator Author

@eps1lon eps1lon Mar 19, 2024

Choose a reason for hiding this comment

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

e32f38a (#28557)

Copy link
Collaborator Author

@eps1lon eps1lon Mar 19, 2024

Choose a reason for hiding this comment

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

Feels a bit brittle but you know this part better than I do.

Copy link
Collaborator

@acdlite acdlite Mar 20, 2024

Choose a reason for hiding this comment

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

I consider this pretty low level code so I think it's fine. I care more about not observing the value of isPending since it causes a bunch of redundant read operations.


// This is a mount. No updates to process.
const state: Awaited<S> = stateHook.memoizedState;

Expand All @@ -2269,8 +2272,7 @@ function rerenderFormState<S, P>(
// This may have changed during the rerender.
actionQueueHook.memoizedState = action;

// For mount, pending is always false.
return [state, dispatch, false];
return [state, dispatch, isPending];
}

function pushEffect(
Expand Down