Skip to content

Conversation

brkalow
Copy link
Member

@brkalow brkalow commented Jun 17, 2025

Description

Emits a TokenUpdate event on a successful Session.touch() event. This addresses a potential race condition scenario where the active session is switched, but the session token does not update immediately, causing some requests to potentially fire with the "old" session token in parallel.

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

  • Bug Fixes

    • Resolved an issue where the session token did not update immediately after invoking the session touch action, ensuring the token now reflects the latest state right away.
  • Tests

    • Added tests to verify that the session token update event is triggered correctly after the session touch action.

@brkalow brkalow requested review from aeliox, wobsoriano and a team as code owners June 17, 2025 21:15
Copy link

changeset-bot bot commented Jun 17, 2025

🦋 Changeset detected

Latest commit: 549d11c

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

This PR includes changesets to release 3 packages
Name Type
@clerk/clerk-js Patch
@clerk/chrome-extension Patch
@clerk/clerk-expo 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 Jun 17, 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 18, 2025 5:46pm

Copy link
Contributor

coderabbitai bot commented Jun 17, 2025

📝 Walkthrough

Walkthrough

This change updates the '@clerk/clerk-js' package to ensure that the session token is immediately updated after the Clerk.session.touch() method is called. The implementation modifies the touch method in the Session class to emit a TokenUpdate event if a new lastActiveToken is present in the response. Additionally, a new test suite is introduced to verify that the touch() method triggers the correct event emission with the updated token. The bundlewatch configuration was also updated to slightly increase the maximum allowed size for the clerk.browser.js file. No changes were made to the signatures of exported or public entities.

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 caa02b1 and 549d11c.

📒 Files selected for processing (1)
  • packages/clerk-js/bundlewatch.config.json (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • packages/clerk-js/bundlewatch.config.json
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: Check Permissions
  • GitHub Check: semgrep/ci
  • GitHub Check: Analyze (actions)
  • 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
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: 2

🧹 Nitpick comments (1)
packages/clerk-js/src/core/resources/__tests__/Session.spec.ts (1)

267-291: Assertion is fragile – count may change as touch() evolves

expect(dispatchSpy).toHaveBeenCalledTimes(1); will break if future work emits additional, unrelated events (e.g. session:updated). A safer pattern is to assert the specific emission you care about and ignore extras:

-      expect(dispatchSpy).toHaveBeenCalledTimes(1);
-      expect(dispatchSpy).toHaveBeenCalledWith('token:update', {
-        token: session.lastActiveToken,
-      });
+      expect(dispatchSpy).toHaveBeenCalledWith('token:update', {
+        token: session.lastActiveToken,
+      });

This keeps the test intent intact while reducing maintenance churn.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 86f32ab and 13e55d3.

📒 Files selected for processing (3)
  • .changeset/wide-bags-mate.md (1 hunks)
  • packages/clerk-js/src/core/resources/Session.ts (2 hunks)
  • packages/clerk-js/src/core/resources/__tests__/Session.spec.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: Build Packages
  • GitHub Check: Formatting | Dedupe | Changeset
  • GitHub Check: semgrep/ci
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (1)
.changeset/wide-bags-mate.md (1)

1-6: Changelog entry looks good – clearly states the fix and affected API.

Copy link

pkg-pr-new bot commented Jun 17, 2025

Open in StackBlitz

@clerk/agent-toolkit

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

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

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

@clerk/elements

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

@clerk/clerk-expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/clerk-react

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

@clerk/react-router

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

@clerk/remix

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/themes

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

@clerk/types

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

@clerk/upgrade

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

@clerk/vue

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

commit: 549d11c

@brkalow brkalow merged commit b207dcc into main Jun 18, 2025
37 checks passed
@brkalow brkalow deleted the brk.fix/touch-token-update branch June 18, 2025 19:02
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.

4 participants