Skip to content

fix(clerk-js): Fix multi-session navigation for hash routing #6461

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 3 commits into from
Aug 4, 2025

Conversation

LauraBeatris
Copy link
Member

@LauraBeatris LauraBeatris commented Aug 2, 2025

Description

  • Fixes navigation on "Add account" from SignInAccountSwitcher: On a hash routing, it was trying to use the route path, which was undefined
CleanShot.2025-08-02.at.14.15.00.mp4
  • Fixes build method for afterMultiSessionSignOutUrl - it was passing /choose as a path, but wasn't building it as a hash.
CleanShot.2025-08-02.at.14.20.38.mp4

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
    • Improved navigation behavior for multi-session scenarios when using hash-based URLs.
    • Enhanced logic for determining the correct sign-in URL during account switching, ensuring better fallback handling.

@LauraBeatris LauraBeatris self-assigned this Aug 2, 2025
Copy link

changeset-bot bot commented Aug 2, 2025

🦋 Changeset detected

Latest commit: ec80d16

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 Aug 2, 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 Aug 4, 2025 10:30pm

Copy link
Contributor

coderabbitai bot commented Aug 2, 2025

📝 Walkthrough

Walkthrough

This change refines multi-session navigation handling in the @clerk/clerk-js package, specifically addressing hash routing scenarios. The internal logic of the buildAfterMultiSessionSingleSignOutUrl method was updated to first check for the presence of this.environment, then prioritize returning a decorated URL from afterMultiSessionSingleSignOutUrl, followed by constructing a URL from signInUrl with a hash path 'choose', and finally falling back to an environment default URL. The URL construction now uses a dedicated buildURL function instead of string concatenation. Additionally, the SignInAccountSwitcher component was modified to add a fallback mechanism for the signInUrl property by incorporating it alongside signInPath when invoking useMultisessionActions. No changes were made to exported or public API declarations.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.


📜 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 d540a77 and ec80d16.

📒 Files selected for processing (3)
  • .changeset/warm-lies-dance.md (1 hunks)
  • packages/clerk-js/src/core/clerk.ts (1 hunks)
  • packages/clerk-js/src/ui/components/SignIn/SignInAccountSwitcher.tsx (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (3)
  • .changeset/warm-lies-dance.md
  • packages/clerk-js/src/ui/components/SignIn/SignInAccountSwitcher.tsx
  • packages/clerk-js/src/core/clerk.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.
  • 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.

Support

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

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

🧹 Nitpick comments (1)
packages/clerk-js/src/core/clerk.ts (1)

1587-1595: Inconsistent leading slash in hashPath may break routing

Other calls to buildURL pass a leading slash (e.g. '/factor-one', '/continue').
Here 'choose' is passed without the slash, relying on joinPaths to prepend it.
This inconsistency can lead to double slashes (//choose) or missing slashes depending on joinPaths behaviour and the trailing slash of pathname.

For consistency and to avoid edge-cases, prepend the slash explicitly:

-            hashPath: 'choose',
+            hashPath: '/choose',
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between b637177 and 35b1339.

📒 Files selected for processing (3)
  • .changeset/warm-lies-dance.md (1 hunks)
  • packages/clerk-js/src/core/clerk.ts (1 hunks)
  • packages/clerk-js/src/ui/components/SignIn/SignInAccountSwitcher.tsx (1 hunks)
🧰 Additional context used
📓 Path-based instructions (11)
.changeset/**

📄 CodeRabbit Inference Engine (.cursor/rules/monorepo.mdc)

Automated releases must use Changesets.

Files:

  • .changeset/warm-lies-dance.md
packages/clerk-js/src/ui/**/*.{ts,tsx}

📄 CodeRabbit Inference Engine (.cursor/rules/clerk-js-ui.mdc)

packages/clerk-js/src/ui/**/*.{ts,tsx}: Element descriptors should always be camelCase
Use element descriptors in UI components to enable consistent theming and styling via appearance.elements
Element descriptors should generate unique, stable CSS classes for theming
Element descriptors should handle state classes (e.g., cl-loading, cl-active, cl-error, cl-open) automatically based on component state
Do not render hard-coded values; all user-facing strings must be localized using provided localization methods
Use the useLocalizations hook and localizationKeys utility for all text and error messages
Use the styled system (sx prop, theme tokens, responsive values) for custom component styling
Use useCardState for card-level state, useFormState for form-level state, and useLoadingStatus for loading states
Always use handleError utility for API errors and use translateError for localized error messages
Use useFormControl for form field state, implement proper validation, and handle loading and error states in forms
Use localization keys for all form labels and placeholders
Use element descriptors for consistent styling and follow the theme token system
Use the Card and FormContainer patterns for consistent UI structure

Files:

  • packages/clerk-js/src/ui/components/SignIn/SignInAccountSwitcher.tsx
**/*.{js,jsx,ts,tsx}

📄 CodeRabbit Inference Engine (.cursor/rules/development.mdc)

**/*.{js,jsx,ts,tsx}: All code must pass ESLint checks with the project's configuration
Follow established naming conventions (PascalCase for components, camelCase for variables)
Maintain comprehensive JSDoc comments for public APIs
Use dynamic imports for optional features
All public APIs must be documented with JSDoc
Provide meaningful error messages to developers
Include error recovery suggestions where applicable
Log errors appropriately for debugging
Lazy load components and features when possible
Implement proper caching strategies
Use efficient data structures and algorithms
Profile and optimize critical paths
Validate all inputs and sanitize outputs
Implement proper logging with different levels

Files:

  • packages/clerk-js/src/ui/components/SignIn/SignInAccountSwitcher.tsx
  • packages/clerk-js/src/core/clerk.ts
**/*.{js,jsx,ts,tsx,json,css,scss,md,yaml,yml}

📄 CodeRabbit Inference Engine (.cursor/rules/development.mdc)

Use Prettier for consistent code formatting

Files:

  • packages/clerk-js/src/ui/components/SignIn/SignInAccountSwitcher.tsx
  • packages/clerk-js/src/core/clerk.ts
packages/**/*.{ts,tsx}

📄 CodeRabbit Inference Engine (.cursor/rules/development.mdc)

TypeScript is required for all packages

Files:

  • packages/clerk-js/src/ui/components/SignIn/SignInAccountSwitcher.tsx
  • packages/clerk-js/src/core/clerk.ts
packages/**/*.{ts,tsx,d.ts}

📄 CodeRabbit Inference Engine (.cursor/rules/development.mdc)

Packages should export TypeScript types alongside runtime code

Files:

  • packages/clerk-js/src/ui/components/SignIn/SignInAccountSwitcher.tsx
  • packages/clerk-js/src/core/clerk.ts
**/*.{ts,tsx}

📄 CodeRabbit Inference Engine (.cursor/rules/development.mdc)

Use proper TypeScript error types

**/*.{ts,tsx}: Always define explicit return types for functions, especially public APIs
Use proper type annotations for variables and parameters where inference isn't clear
Avoid any type - prefer unknown when type is uncertain, then narrow with type guards
Use interface for object shapes that might be extended
Use type for unions, primitives, and computed types
Prefer readonly properties for immutable data structures
Use private for internal implementation details
Use protected for inheritance hierarchies
Use public explicitly for clarity in public APIs
Prefer readonly for properties that shouldn't change after construction
Prefer composition and interfaces over deep inheritance chains
Use mixins for shared behavior across unrelated classes
Implement dependency injection for loose coupling
Let TypeScript infer when types are obvious
Use const assertions for literal types: as const
Use satisfies operator for type checking without widening
Use mapped types for transforming object types
Use conditional types for type-level logic
Leverage template literal types for string manipulation
Use ES6 imports/exports consistently
Use default exports sparingly, prefer named exports
Use type-only imports: import type { ... } from ...
No any types without justification
Proper error handling with typed errors
Consistent use of readonly for immutable data
Proper generic constraints
No unused type parameters
Proper use of utility types instead of manual type construction
Type-only imports where possible
Proper tree-shaking friendly exports
No circular dependencies
Efficient type computations (avoid deep recursion)

Files:

  • packages/clerk-js/src/ui/components/SignIn/SignInAccountSwitcher.tsx
  • packages/clerk-js/src/core/clerk.ts
**/*.{jsx,tsx}

📄 CodeRabbit Inference Engine (.cursor/rules/development.mdc)

**/*.{jsx,tsx}: Use error boundaries in React components
Minimize re-renders in React components

**/*.{jsx,tsx}: Always use functional components with hooks instead of class components
Follow PascalCase naming for components: UserProfile, NavigationMenu
Keep components focused on a single responsibility - split large components
Limit component size to 150-200 lines; extract logic into custom hooks
Use composition over inheritance - prefer smaller, composable components
Export components as named exports for better tree-shaking
One component per file with matching filename and component name
Use useState for simple state management
Use useReducer for complex state logic
Implement proper state initialization
Use proper state updates with callbacks
Implement proper state cleanup
Use Context API for theme/authentication
Implement proper state selectors
Use proper state normalization
Implement proper state persistence
Use React.memo for expensive components
Implement proper useCallback for handlers
Use proper useMemo for expensive computations
Implement proper virtualization for lists
Use proper code splitting with React.lazy
Implement proper cleanup in useEffect
Use proper refs for DOM access
Implement proper event listener cleanup
Use proper abort controllers for fetch
Implement proper subscription cleanup
Use proper HTML elements
Implement proper ARIA attributes
Use proper heading hierarchy
Implement proper form labels
Use proper button types
Implement proper focus management
Use proper keyboard shortcuts
Implement proper tab order
Use proper skip links
Implement proper focus traps
Implement proper error boundaries
Use proper error logging
Implement proper error recovery
Use proper error messages
Implement proper error fallbacks
Use proper form validation
Implement proper error states
Use proper error messages
Implement proper form submission
Use proper form reset
Use proper component naming
Implement proper file naming
Use proper prop naming
Implement proper...

Files:

  • packages/clerk-js/src/ui/components/SignIn/SignInAccountSwitcher.tsx
**/*.{js,ts,tsx,jsx}

📄 CodeRabbit Inference Engine (.cursor/rules/monorepo.mdc)

Support multiple Clerk environment variables (CLERK_, NEXT_PUBLIC_CLERK_, etc.) for configuration.

Files:

  • packages/clerk-js/src/ui/components/SignIn/SignInAccountSwitcher.tsx
  • packages/clerk-js/src/core/clerk.ts
**/*.tsx

📄 CodeRabbit Inference Engine (.cursor/rules/react.mdc)

**/*.tsx: Use proper type definitions for props and state
Leverage TypeScript's type inference where possible
Use proper event types for handlers
Implement proper generic types for reusable components
Use proper type guards for conditional rendering

Files:

  • packages/clerk-js/src/ui/components/SignIn/SignInAccountSwitcher.tsx
**/*

⚙️ CodeRabbit Configuration File

**/*: If there are no tests added or modified as part of the PR, please suggest that tests be added to cover the changes.

Whenever reviewing a pull request, if there are any changes that could impact security, always tag @clerk/security in the PR.

Security-impacting changes include, but are not limited to:

  • Changes to authentication logic or mechanisms (e.g. login, session handling, token issuance)
  • Any modification to access control, authorization checks, or role-based permissions
  • Introduction or modification of hashing algorithms, signature verification, or cryptographic primitives
  • Handling of sensitive data (e.g. passwords, tokens, secrets, PII)
  • Integration with external identity providers (e.g. SSO, OAuth, OpenID Connect)
  • Modifications to security headers, cookie flags, CORS policies, or CSRF protections
  • Bypass mechanisms (e.g. feature flags, testing overrides) that could weaken protections
  • Changes to rate limiting, abuse prevention, or input validation

If you're unsure whether a change is security-relevant, err on the side of caution and tag @clerk/security.

Any time that you tag @clerk/security, please do so explicitly in a code comment, rather than within a collapsed section in a coderabbit comment, such as the "recent review details" section. If you do use the team name in any thinking or non-direct-code-comment content, it can be referred to as "clerk security team" to avoid accidentally printing the tag which sends a notification to the team.

Files:

  • packages/clerk-js/src/ui/components/SignIn/SignInAccountSwitcher.tsx
  • packages/clerk-js/src/core/clerk.ts
🧬 Code Graph Analysis (1)
packages/clerk-js/src/core/clerk.ts (1)
packages/clerk-js/src/utils/url.ts (1)
  • buildURL (81-155)
⏰ 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). (3)
  • GitHub Check: semgrep-cloud-platform/scan
  • GitHub Check: semgrep/ci
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (4)
.changeset/warm-lies-dance.md (1)

1-6: LGTM! Changeset follows proper format.

The changeset is correctly formatted with appropriate patch-level versioning for a bug fix and includes a clear description of the changes.

packages/clerk-js/src/ui/components/SignIn/SignInAccountSwitcher.tsx (2)

18-18: Good addition of signInUrl from context.

Adding signInUrl from the sign-in context provides the necessary fallback value for hash routing scenarios where signInPath may be undefined.


25-25: Excellent fix for hash routing navigation issue.

The fallback mechanism signInPath ?? signInUrl directly addresses the navigation failure mentioned in the PR objectives. When using hash routing, signInPath can be undefined, and this change ensures that signInUrl is used as a fallback to prevent navigation failures in the "Add account" action.

packages/clerk-js/src/core/clerk.ts (1)

1582-1607: No unit tests cover the new decision tree

The prioritisation logic (afterMultiSessionSingleSignOutUrlsignInUrl#/choose → env fallback) is critical for navigation and easy to regress.
Please add targeted tests exercising:

  1. Custom afterMultiSessionSingleSignOutUrl
  2. Absence of the above with signInUrl present
  3. Absence of both, ensuring the env fallback is used

If desired, I can draft the test cases.

Copy link

pkg-pr-new bot commented Aug 2, 2025

Open in StackBlitz

@clerk/agent-toolkit

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

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

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

@clerk/elements

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

@clerk/clerk-expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/clerk-react

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

@clerk/react-router

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

@clerk/remix

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/themes

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

@clerk/types

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

@clerk/upgrade

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

@clerk/vue

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

commit: ec80d16

@LauraBeatris LauraBeatris force-pushed the laura/fix-multi-session-routing branch from d540a77 to ec80d16 Compare August 4, 2025 22:29
@LauraBeatris LauraBeatris merged commit e3d073e into main Aug 4, 2025
36 checks passed
@LauraBeatris LauraBeatris deleted the laura/fix-multi-session-routing branch August 4, 2025 22:40
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