Skip to content

feat(backend): Signal support for handshake nonce #5905

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

Merged
merged 17 commits into from
Jun 26, 2025

Conversation

jacekradko
Copy link
Member

@jacekradko jacekradko commented May 12, 2025

Description

Send query string param to signal support for handshake nonce flow from current version of @clerk/backend

Related: SDKI-979

Checklist

  • pnpm test runs as expected.
  • pnpm build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

Summary by CodeRabbit

  • New Features

    • Introduced an optimized handshake process for large session payloads using a nonce-based fetching mechanism.
    • Added a new query parameter to handshake URLs to indicate support for handshake nonce during redirects.
  • Tests

    • Enhanced tests to verify the presence of the new handshake format parameter in generated URLs.

Copy link

vercel bot commented May 12, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
clerk-js-sandbox ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 26, 2025 3:34am

Copy link

changeset-bot bot commented May 12, 2025

🦋 Changeset detected

Latest commit: 87cf34e

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 11 packages
Name Type
@clerk/backend Minor
@clerk/agent-toolkit Patch
@clerk/astro Patch
@clerk/express Patch
@clerk/fastify Patch
@clerk/nextjs Patch
@clerk/nuxt Patch
@clerk/react-router Patch
@clerk/remix Patch
@clerk/tanstack-react-start Patch
@clerk/testing Patch

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

@jacekradko jacekradko requested a review from Copilot May 12, 2025 14:43
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds support for signaling the handshake nonce flow by including a query parameter.

  • In handshake.ts, the query parameter SupportsHandshakeNonce is appended to the URL.
  • In handshake.test.ts, corresponding tests ensure the parameter is correctly set in both regular and development modes.
  • In constants.ts, a new constant for SupportsHandshakeNonce is added to support the new query parameter.

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
packages/backend/src/tokens/handshake.ts Appends a new query parameter for handshake nonce support.
packages/backend/src/tokens/tests/handshake.test.ts Adds tests to validate the presence of the new query parameter.
packages/backend/src/constants.ts Introduces the SupportsHandshakeNonce constant to hold the parameter key.

@jfoshee
Copy link
Contributor

jfoshee commented May 12, 2025

LGTM. So to be doubly clear: this indicates "nonce support", but FAPI still has the option to return 'optimized' payload in initial response, right?
I'll work on API definition update and FAPI implementation.

@jacekradko
Copy link
Member Author

@jfoshee Yeah, this is just to signal to the API that it COULD send a handshake nonce

@jacekradko jacekradko requested a review from a team May 12, 2025 20:27
Copy link

pkg-pr-new bot commented May 15, 2025

Open in StackBlitz

@clerk/agent-toolkit

npm i https://pkg.pr.new/@clerk/agent-toolkit@5905

@clerk/astro

npm i https://pkg.pr.new/@clerk/astro@5905

@clerk/backend

npm i https://pkg.pr.new/@clerk/backend@5905

@clerk/chrome-extension

npm i https://pkg.pr.new/@clerk/chrome-extension@5905

@clerk/clerk-js

npm i https://pkg.pr.new/@clerk/clerk-js@5905

@clerk/dev-cli

npm i https://pkg.pr.new/@clerk/dev-cli@5905

@clerk/elements

npm i https://pkg.pr.new/@clerk/elements@5905

@clerk/clerk-expo

npm i https://pkg.pr.new/@clerk/clerk-expo@5905

@clerk/expo-passkeys

npm i https://pkg.pr.new/@clerk/expo-passkeys@5905

@clerk/express

npm i https://pkg.pr.new/@clerk/express@5905

@clerk/fastify

npm i https://pkg.pr.new/@clerk/fastify@5905

@clerk/localizations

npm i https://pkg.pr.new/@clerk/localizations@5905

@clerk/nextjs

npm i https://pkg.pr.new/@clerk/nextjs@5905

@clerk/nuxt

npm i https://pkg.pr.new/@clerk/nuxt@5905

@clerk/clerk-react

npm i https://pkg.pr.new/@clerk/clerk-react@5905

@clerk/react-router

npm i https://pkg.pr.new/@clerk/react-router@5905

@clerk/remix

npm i https://pkg.pr.new/@clerk/remix@5905

@clerk/shared

npm i https://pkg.pr.new/@clerk/shared@5905

@clerk/tanstack-react-start

npm i https://pkg.pr.new/@clerk/tanstack-react-start@5905

@clerk/testing

npm i https://pkg.pr.new/@clerk/testing@5905

@clerk/themes

npm i https://pkg.pr.new/@clerk/themes@5905

@clerk/types

npm i https://pkg.pr.new/@clerk/types@5905

@clerk/upgrade

npm i https://pkg.pr.new/@clerk/upgrade@5905

@clerk/vue

npm i https://pkg.pr.new/@clerk/vue@5905

commit: 87cf34e

@jacekradko jacekradko requested a review from aeliox as a code owner June 18, 2025 14:48
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (3)
.changeset/six-ears-wash.md (3)

5-5: Use a proper Markdown heading instead of bold text

Markdown-lint flags MD036 here. Replacing the bold line with a level-2 heading keeps the file consistent with other changesets and avoids lint noise.

-**Optimize handshake payload delivery with nonce-based fetching**
+## Optimize handshake payload delivery with nonce-based fetching

23-26: Fix typo in example domain

ecxample.comexample.com.

-3. Handshake resolves → `307 ecxample.com` with `__clerk_handshake_nonce` cookie containing the nonce
+3. Handshake resolves → `307 example.com` with `__clerk_handshake_nonce` cookie containing the nonce

30-31: Optional: add a clarifying comma

Minor readability tweak; feel free to ignore if you prefer the current wording.

-Continues to work as before with direct payload delivery in cookies for optimal performance.
+Continues to work as before, with direct payload delivery in cookies for optimal performance.
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ef10516 and 7e3ad6e.

📒 Files selected for processing (1)
  • .changeset/six-ears-wash.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
.changeset/six-ears-wash.md

[uncategorized] ~10-~10: This verb may not be in the correct tense. Consider changing the tense to fit the context better.
Context: ...rs limit cookies to ~4KB, this severely restricted the practical size of session tokens, w...

(AI_EN_LECTOR_REPLACEMENT_VERB_TENSE)


[uncategorized] ~31-~31: Possible missing comma found.
Context: ... payloads ≤2KB):** Continues to work as before with direct payload delivery in cookies...

(AI_HYDRA_LEO_MISSING_COMMA)

🪛 markdownlint-cli2 (0.17.2)
.changeset/six-ears-wash.md

5-5: Emphasis used instead of a heading
null

(MD036, no-emphasis-as-heading)

⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: semgrep-cloud-platform/scan
  • GitHub Check: Formatting | Dedupe | Changeset
  • GitHub Check: Build Packages
  • GitHub Check: semgrep/ci
  • GitHub Check: Analyze (javascript-typescript)

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (1)
.changeset/six-ears-wash.md (1)

10-11: Mixed tenses – change “restricted” → “restricts”

Present-tense “limit” pairs naturally with present-tense “restricts”.

-… this severely restricted the practical size …
+… this severely restricts the practical size …
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7e3ad6e and be1acc3.

📒 Files selected for processing (1)
  • .changeset/six-ears-wash.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
.changeset/six-ears-wash.md

[uncategorized] ~10-~10: This verb may not be in the correct tense. Consider changing the tense to fit the context better.
Context: ...rs limit cookies to ~4KB, this severely restricted the practical size of session tokens, w...

(AI_EN_LECTOR_REPLACEMENT_VERB_TENSE)

⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: semgrep-cloud-platform/scan
  • GitHub Check: Formatting | Dedupe | Changeset
  • GitHub Check: Build Packages
  • GitHub Check: semgrep/ci
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (1)
.changeset/six-ears-wash.md (1)

24-26: Step 3 wording is ambiguous

307 example.com doesn’t tell the reader which endpoint the browser is redirected to. Spell out the full redirected URL or path (e.g. / or the original page) so integrators know what to expect.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
.changeset/six-ears-wash.md (1)

10-11: Minor grammar tweak for release-note polish

“restricts” reads slightly better with the present-tense “Since …” lead-in.

- Since browsers limit cookies to ~4KB, this severely restricted the practical size of session tokens,
+ Since browsers limit cookies to ~4KB, this severely restricts the practical size of session tokens,
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between be1acc3 and 87cf34e.

📒 Files selected for processing (1)
  • .changeset/six-ears-wash.md (1 hunks)
🧰 Additional context used
🧠 Learnings (1)
.changeset/six-ears-wash.md (1)
Learnt from: jacekradko
PR: clerk/javascript#5905
File: .changeset/six-ears-wash.md:1-3
Timestamp: 2025-06-26T03:27:05.511Z
Learning: In the Clerk JavaScript repository, changeset headers support single quotes syntax (e.g., '@clerk/backend': minor) and work fine with their current changesets integration, so there's no need to change them to double quotes.
🪛 LanguageTool
.changeset/six-ears-wash.md

[uncategorized] ~10-~10: This verb may not be in the correct tense. Consider changing the tense to fit the context better.
Context: ...rs limit cookies to ~4KB, this severely restricted the practical size of session tokens, w...

(AI_EN_LECTOR_REPLACEMENT_VERB_TENSE)

⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: semgrep-cloud-platform/scan
  • GitHub Check: Build Packages
  • GitHub Check: Formatting | Dedupe | Changeset
  • GitHub Check: semgrep/ci
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (1)
.changeset/six-ears-wash.md (1)

1-3: Header syntax is project-compliant – no action needed

Single-quoted package names are approved by the repo’s Changesets setup (per prior discussion).
Looks good as-is.

@jacekradko jacekradko merged commit 8bfdf94 into main Jun 26, 2025
37 checks passed
@jacekradko jacekradko deleted the feat/signal-support-for-handshake-nonce branch June 26, 2025 03:45
This was referenced Jun 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants