Skip to content

Fix useHandleCallback compatibility with React.StrictMode #10486

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
djhi merged 2 commits into from
Jan 31, 2025
Merged

Fix useHandleCallback compatibility with React.StrictMode #10486

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aa0ec8b
Make useHandleCallback compatible with StrictMode + test it
erwanMarmelab Jan 30, 2025
5cbe2f8
revert the handleCallbackPromise definition
erwanMarmelab Jan 31, 2025
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
24 changes: 24 additions & 0 deletions packages/ra-core/src/auth/useHandleAuthCallback.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,4 +160,28 @@ describe('useHandleAuthCallback', () => {
expect(abort).toHaveBeenCalled();
});
});

it('should only call handleCallback once when the component is rendered', async () => {
const handleCallback = jest.spyOn(authProvider, 'handleCallback');
render(
<React.StrictMode>
<TestMemoryRouter initialEntries={['/auth-callback']}>
<AuthContext.Provider value={authProvider}>
<QueryClientProvider client={new QueryClient()}>
<Routes>
<Route path="/" element={<div>Home</div>} />
<Route
path="/auth-callback"
element={<TestComponent />}
/>
</Routes>
</QueryClientProvider>
</AuthContext.Provider>
</TestMemoryRouter>
</React.StrictMode>
);

await screen.findByText('Home');
expect(handleCallback).toHaveBeenCalledTimes(1);
});
});
35 changes: 29 additions & 6 deletions packages/ra-core/src/auth/useHandleAuthCallback.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,38 @@ export const useHandleAuthCallback = (
const nextSearch = locationState && locationState.nextSearch;
const defaultRedirectUrl = nextPathName ? nextPathName + nextSearch : '/';
const { onSuccess, onError, onSettled, ...queryOptions } = options ?? {};
let handleCallbackPromise: Promise<void> | null;

const queryResult = useQuery({
queryKey: ['auth', 'handleCallback'],
queryFn: ({ signal }) =>
authProvider && typeof authProvider.handleCallback === 'function'
? authProvider
.handleCallback({ signal })
.then(result => result ?? null)
: Promise.resolve(),
queryFn: ({ signal }) => {
console.log('queryFn', handleCallbackPromise);
if (!handleCallbackPromise) {
handleCallbackPromise = new Promise(async (resolve, reject) => {
if (authProvider) {
if (typeof authProvider.handleCallback === 'function') {
try {
const result =
await authProvider.handleCallback({
signal,
});
return resolve(result ?? null);
} catch (error) {
return reject({
redirectTo: false,
message: error.message,
});
}
}
return resolve();
}
return reject({
message: 'Failed to handle login callback.',
});
});
Copy link
Contributor

@djhi djhi Jan 31, 2025

Choose a reason for hiding this comment

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

This changes the previous behavior. Please revert to the original code. Only keep the handleCallbackPromise creation as you did

}
return handleCallbackPromise;
},
retry: false,
...queryOptions,
});
Expand Down
Loading