Repository navigation
chore(nextjs): Display keyless prompt until .clerk/ is removed - #4940
Merged
panteliselef merged 15 commits intoJan 21, 2025
Merged
panteliselef merged 15 commits into
panteliselef merged 15 commits into
Conversation
🦋 Changeset detectedLatest commit: 1b36a4a The changes in this PR will be included in the next version bump. This PR includes changesets to release 22 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
panteliselef
commented
Jan 20, 2025
Comment on lines
+99
to
+103
| if (runningWithClaimedKeys) { | ||
| output = clientProvider; | ||
| } else { | ||
| output = <KeylessCookieSync {...newOrReadKeys}>{clientProvider}</KeylessCookieSync>; | ||
| } |
Contributor
Author
There was a problem hiding this comment.
We want to keep rendering the Keyless prompt which is controlled by the props passed to ClientClerkProvider but we don't want the rest of the app to act like it was on keyless since the developer has now set the keys explicitly.
panteliselef
marked this pull request as ready for review
January 20, 2025 11:56
LekoArts
reviewed
Jan 20, 2025
brkalow
reviewed
Jan 20, 2025
Comment on lines
+88
to
+90
| __internal_claimKeylessApplicationUrl: newOrReadKeys.claimUrl, | ||
| __internal_copyInstanceKeysUrl: newOrReadKeys.apiKeysUrl, | ||
| __internal_keyless_dismissPrompt: runningWithClaimedKeys ? deleteKeylessAction : undefined, |
Member
There was a problem hiding this comment.
All of these props are related to keyless, but they use different naming schemes. Can we make them consistent? Proposal:
Suggested change
| __internal_claimKeylessApplicationUrl: newOrReadKeys.claimUrl, | |
| __internal_copyInstanceKeysUrl: newOrReadKeys.apiKeysUrl, | |
| __internal_keyless_dismissPrompt: runningWithClaimedKeys ? deleteKeylessAction : undefined, | |
| __internal_keyless_claimApplicationUrl: newOrReadKeys.claimUrl, | |
| __internal_keyless_copyInstanceKeysUrl: newOrReadKeys.apiKeysUrl, | |
| __internal_keyless_dismissPrompt: runningWithClaimedKeys ? deleteKeylessAction : undefined, |
Contributor
Author
There was a problem hiding this comment.
Yeap, seems like i never pushed this. Thanks for reminding me.
Co-authored-by: Bryce Kalow <bryce@clerk.dev>
brkalow
approved these changes
Jan 20, 2025
LekoArts
approved these changes
Jan 21, 2025
LekoArts
left a comment
LekoArts
left a comment
Contributor
There was a problem hiding this comment.
Pending Bryce's comment (https://github.com/clerk/javascript/pull/4940/files#r1922640604), should be done before merge
…essage-when-env-keys-and-local # Conflicts: # packages/clerk-js/src/ui/components/KeylessPrompt/index.tsx # packages/types/src/clerk.ts
panteliselef
enabled auto-merge (squash)
January 21, 2025 12:39
panteliselef
deleted the
elef/actls-65-nextjs-show-claiming-success-message-when-env-keys-and-local
branch
January 21, 2025 12:46
wobsoriano
pushed a commit
that referenced
this pull request
Feb 8, 2025
This branch was successfully deployed
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
[Keyless]
For Developer who use
<ClerkProvider/>as a Server component (not in a "use client" boundary), we can detect when the explicitly set keys match the ones created from keyless. When that is the case, we are now passing a server action to the Clerk UI resulting in the keyless prompt to display a confirmation step which forces the developer to dismiss.Behind the scenes, on dismiss, we are are deleting the
.clerk/directory as it is no longer necessary. That resets the application and opts it out of keyless.Unfortunately developers who are using
<ClerkProvider/>will not get this confirmation step, but instead the prompt will simply disappear.Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change