-
Notifications
You must be signed in to change notification settings - Fork 3
Fix AuthKit + Convex race condition on laptop wake #17
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
Open
nicknisi
wants to merge
5
commits into
main
Choose a base branch
from
nicknisi/fix-authkit-convex-race-condition
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
14ca410
Fix AuthKit + Convex race condition on laptop wake
nicknisi 239d5dd
add comment about what providing onSessionExpired callback does
nicknisi 4a90e65
remove useEffect usage
nicknisi 81292f5
use refresh
nicknisi 1d1d49e
check in _generated files
nicknisi File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| @@ -1,16 +1,22 @@ | ||||||||||
| 'use client'; | ||||||||||
|
|
||||||||||
| import { ReactNode, useCallback, useState } from 'react'; | ||||||||||
| import { ReactNode, useCallback, useState, useRef } from 'react'; | ||||||||||
| import { ConvexReactClient } from 'convex/react'; | ||||||||||
| import { ConvexProviderWithAuth } from 'convex/react'; | ||||||||||
| import { AuthKitProvider, useAuth, useAccessToken } from '@workos-inc/authkit-nextjs/components'; | ||||||||||
|
|
||||||||||
| const noop = () => {}; | ||||||||||
|
|
||||||||||
| export function ConvexClientProvider({ children }: { children: ReactNode }) { | ||||||||||
| const [convex] = useState(() => { | ||||||||||
| return new ConvexReactClient(process.env.NEXT_PUBLIC_CONVEX_URL!); | ||||||||||
| const client = new ConvexReactClient(process.env.NEXT_PUBLIC_CONVEX_URL!); | ||||||||||
| return client; | ||||||||||
| }); | ||||||||||
|
|
||||||||||
| return ( | ||||||||||
| <AuthKitProvider> | ||||||||||
| // Prevent AuthKit's default window.location.reload() on session expiration. | ||||||||||
| // We handle auth state gracefully via Convex token refresh and middleware checks. | ||||||||||
| <AuthKitProvider onSessionExpired={noop}> | ||||||||||
| <ConvexProviderWithAuth client={convex} useAuth={useAuthFromAuthKit}> | ||||||||||
| {children} | ||||||||||
| </ConvexProviderWithAuth> | ||||||||||
|
|
@@ -20,7 +26,9 @@ export function ConvexClientProvider({ children }: { children: ReactNode }) { | |||||||||
|
|
||||||||||
| function useAuthFromAuthKit() { | ||||||||||
| const { user, loading: isLoading } = useAuth(); | ||||||||||
| const { getAccessToken, refresh } = useAccessToken(); | ||||||||||
| const { getAccessToken, accessToken, refresh } = useAccessToken(); | ||||||||||
| const accessTokenRef = useRef<string | undefined>(undefined); | ||||||||||
| accessTokenRef.current = accessToken; | ||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
|
|
||||||||||
| const isAuthenticated = !!user; | ||||||||||
|
|
||||||||||
|
|
@@ -31,17 +39,18 @@ function useAuthFromAuthKit() { | |||||||||
| } | ||||||||||
|
|
||||||||||
| try { | ||||||||||
| if (forceRefreshToken) { | ||||||||||
| return (await refresh()) ?? null; | ||||||||||
nicknisi marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||||
| } | ||||||||||
|
|
||||||||||
| return (await getAccessToken()) ?? null; | ||||||||||
| // If Convex requests a forced refresh (e.g., token was rejected by server), | ||||||||||
| // always get a fresh token. Otherwise, return cached token if still valid. | ||||||||||
| return forceRefreshToken ? ((await refresh()) ?? null) : ((await getAccessToken()) ?? null); | ||||||||||
| } catch (error) { | ||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
| console.error('Failed to get access token:', error); | ||||||||||
| return null; | ||||||||||
| // On network errors during laptop wake, fall back to cached token. | ||||||||||
| // Even if expired, Convex will treat it like null and clear auth. | ||||||||||
| // AuthKit's tokenStore schedules automatic retries in the background. | ||||||||||
| console.log('[Convex Auth] Using cached token during network issues'); | ||||||||||
| return accessTokenRef.current ?? null; | ||||||||||
| } | ||||||||||
| }, | ||||||||||
| [user, refresh, getAccessToken], | ||||||||||
| [user, getAccessToken, refresh], | ||||||||||
| ); | ||||||||||
|
|
||||||||||
| return { | ||||||||||
|
|
||||||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What does this do, disable some default onSessionExpired behavior? a comment would be helpful
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added a comment - this prevents authkit-nextjs from doing a
window.location.reload()