Skip to content

chore(clerk-js): Extend buildRedirectToHandshake to accept search params #6277

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
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

jfoshee
Copy link
Contributor

@jfoshee jfoshee commented Jul 9, 2025

Extend buildRedirectToHandshake to accept additional search parameters for improved observability

Add a query parameter for tracking delta between session.iat and client_uat

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: observability

Summary by CodeRabbit

  • New Features
    • Handshake redirect URLs now support including additional query parameters, enhancing flexibility for integrations and observability.
  • Bug Fixes
    • Improved handling of authentication edge cases by adding extra metadata to handshake redirects when session timing mismatches are detected.
  • Tests
    • Added test coverage to verify that extra query parameters are correctly included in handshake redirect URLs.

…al search parameters for improved observability

and add a query parameter for tracking delta between `session.iat` and `client_uat`
Copy link

changeset-bot bot commented Jul 9, 2025

🦋 Changeset detected

Latest commit: e54086c

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 Patch
@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

Copy link

vercel bot commented Jul 9, 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 Jul 9, 2025 10:14pm

Copy link
Contributor

coderabbitai bot commented Jul 9, 2025

📝 Walkthrough

"""

Walkthrough

The changes introduce support for adding arbitrary additional query parameters to the handshake redirect URL generated by the HandshakeService's buildRedirectToHandshake method by adding an optional parameter for extra search parameters. The authenticateRequest function's internal helper handleMaybeHandshakeStatus is updated to pass an iat_uat_delta parameter when the session token's issued-at time is earlier than the client's user authentication time. A new test verifies that these additional search parameters are correctly appended to the redirect URL.

Possibly related PRs

Suggested reviewers

  • aeliox
  • dstaley
    """

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1d2e6f8 and e54086c.

📒 Files selected for processing (1)
  • packages/backend/src/tokens/__tests__/handshake.test.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/backend/src/tokens/tests/handshake.test.ts
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (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)

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

pkg-pr-new bot commented Jul 9, 2025

Open in StackBlitz

@clerk/agent-toolkit

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

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

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

@clerk/elements

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

@clerk/clerk-expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/clerk-react

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

@clerk/react-router

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

@clerk/remix

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/themes

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

@clerk/types

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

@clerk/upgrade

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

@clerk/vue

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

commit: e54086c

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/wet-dryers-dance.md (1)

5-6: Clarify wording and match parameter naming with implementation

Tiny wording tweaks will make the changeset clearer and prevent confusion:

  1. Prefer the imperative mood (ExtendExtend, that's fine) but avoid the ambiguous “search params”; use “query parameters” (the term Clerk docs typically use).
  2. The code (and PR description) refer to client_uat, not client.uat. Using the exact identifier here avoids a potential scavenger-hunt for future readers.

Example:

-Extend `buildRedirectToHandshake` to accept search params
-and track delta between `session.iat` and `client.uat` in case `iat < uat`
+Extend `buildRedirectToHandshake` to accept additional query parameters
+and track the delta between `session.iat` and `client_uat` when `iat < uat`
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1bb5d93 and 639d520.

📒 Files selected for processing (1)
  • .changeset/wet-dryers-dance.md (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
  • GitHub Check: Formatting | Dedupe | Changeset
  • GitHub Check: Build Packages
  • GitHub Check: semgrep-cloud-platform/scan
  • GitHub Check: semgrep/ci
  • GitHub Check: Analyze (javascript-typescript)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants