-
Notifications
You must be signed in to change notification settings - Fork 282
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(clerk-js): Revalidate environment on window focus for Keyless #4813
Merged
BRKalow
merged 2 commits into
main
from
elef/actls-37-change-ui-links-for-api-keys-to-open-in-new-tab
Dec 20, 2024
Merged
Changes from 1 commit
Commits
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 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 |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
'@clerk/clerk-js': patch | ||
--- | ||
|
||
Revalidate environment on window focus for Keyless. |
This file contains 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 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
62 changes: 62 additions & 0 deletions
62
packages/clerk-js/src/ui/components/KeylessPrompt/use-revalidate-environment.ts
This file contains 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 |
---|---|---|
@@ -0,0 +1,62 @@ | ||
import { useClerk } from '@clerk/shared/react'; | ||
import { useEffect, useReducer } from 'react'; | ||
|
||
import type { Clerk } from '../../../core/clerk'; | ||
import type { Environment } from '../../../core/resources'; | ||
import { useEnvironment } from '../../contexts'; | ||
|
||
/** | ||
* Revalidates environment on focus, highly optimized for Keyless mode. | ||
* Attention: this is not a generic solution, and should not be used for revalidating environment inside UI components that are end-user facing (e.g. SignIn) | ||
*/ | ||
function useRevalidateEnvironment() { | ||
const clerk = useClerk(); | ||
const [, forceUpdate] = useReducer(v => v + 1, 0); | ||
|
||
useEffect(() => { | ||
const controller = new AbortController(); | ||
window.addEventListener( | ||
'focus', | ||
|
||
async () => { | ||
const environment = (clerk as Clerk).__unstable__environment as Environment | undefined; | ||
|
||
if (!environment) { | ||
return; | ||
} | ||
|
||
if (environment.authConfig.claimedAt !== null) { | ||
return controller.abort(); | ||
} | ||
|
||
if (document.visibilityState !== 'visible') { | ||
return; | ||
} | ||
|
||
const maxRetries = 2; | ||
|
||
for (let i = 0; i < maxRetries; i++) { | ||
const { | ||
authConfig: { claimedAt }, | ||
} = await environment.fetch(); | ||
|
||
if (claimedAt !== null) { | ||
forceUpdate(); | ||
break; | ||
} | ||
} | ||
}, | ||
Comment on lines
+36
to
+48
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. If you claim in dashboard and quickly switch the fetched environment will not reflect the claimed status. We are trying to fetch a couple of times until we get it. |
||
{ | ||
signal: controller.signal, | ||
}, | ||
); | ||
|
||
return () => { | ||
controller.abort(); | ||
}; | ||
}, []); | ||
|
||
return useEnvironment(); | ||
} | ||
|
||
export { useRevalidateEnvironment }; |
Oops, something went wrong.
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.
Currently there is not pattern for "updating" the environment context after a component has already mounted. This is a quick hack to get this working for Keyless mode, which is a dev facing UI component.