chore(nextjs): Improve experience when swapping keys on Keyless mode #4787
Conversation
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
🦋 Changeset detectedLatest commit: 9c2caa2 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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
Dec 16, 2024
Comment on lines
+292
to
+304
| /** | ||
| * There is a great chance when running on Keyless mode that the above fails, | ||
| * because the keys hot-swapped and the Next.js dev server has not yet fully rebuilt middleware and routes. | ||
| * | ||
| * Attempt one more time with the default dummy value. | ||
| */ | ||
| if (canUseKeyless__server) { | ||
| try { | ||
| return decryptData(encryptedRequestData, KEYLESS_ENCRYPTION_KEY); | ||
| } catch (e) { | ||
| throwInvalidEncryptionKey(); | ||
| } | ||
| } |
There was a problem hiding this comment.
Simple retrying with the dummy value
LauraBeatris
approved these changes
Dec 16, 2024
.changeset/young-beans-trade.md
Outdated
| '@clerk/nextjs': patch | ||
| --- | ||
|
|
||
| Improve experience when swapping keys on Keyless mode. |
There was a problem hiding this comment.
💡 Should we mention here regarding the hot-swapped .env case? Just to clarify the "improve experience" part
BRKalow
reviewed
Dec 16, 2024
panteliselef
commented
Dec 16, 2024
.changeset/young-beans-trade.md
Outdated
| '@clerk/nextjs': patch | ||
| --- | ||
|
|
||
| Improve experience when swapping keys on Keyless mode. |
There was a problem hiding this comment.
Suggested change
| Improve experience when swapping keys on Keyless mode. | |
| Improve error message when swapping keys defined as environment variables. Affects (code=encryption_key_invalid). | |
| **On Keyless mode**: Attempt to not throw the error. |
There was a problem hiding this comment.
@BRKalow @LauraBeatris is this better ?
Co-authored-by: Bryce Kalow <[email protected]>
BRKalow
reviewed
Dec 16, 2024
Co-authored-by: Bryce Kalow <[email protected]>
…laiming-the-keys-and-adding
panteliselef
deleted the
elef/actls-38-improve-possible-error-after-claiming-the-keys-and-adding
branch
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
In Keyless mode it is expected that the user will eventually set keys as environment variables. When they do that, the nextjs server will restart, but there seems to be a mismatch because first the rendering lifecycle runs with the new keys and then the keys are updated in the middleware. This causes an error to be thrown to the user which we can actually improve.
For the happy path: we avoid displaying that error by retrying to decrypt data with the dummy key.
For any other case: when swapping keys or going back to headless you will now see this (see picture). this does not only reply to keyless.
Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change