Skip to content

fix(clerk-js): Preserve active organization when attempting to switch to personal workspace #6103

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 1 commit into from
Jun 11, 2025

Conversation

LauraBeatris
Copy link
Member

@LauraBeatris LauraBeatris commented Jun 11, 2025

Description

Related to #6073

Instead of throwing an error, this PR maintains the latest active organization ID and does not update the session to the personal workspace.

Important to note that this only applies to the Clerk.session singleton, as FAPI has already been updated on /tokens and /touch to also handle it in a idempotent way.

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 handling of organization selection when force organization selection is enabled, ensuring the active organization is not cleared if set to null.
  • Tests
    • Added tests to verify correct behavior when changing the active organization with force organization selection enabled.

@LauraBeatris LauraBeatris self-assigned this Jun 11, 2025
Copy link

vercel bot commented Jun 11, 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 11, 2025 7:41pm

Copy link

changeset-bot bot commented Jun 11, 2025

🦋 Changeset detected

Latest commit: ffb8f5b

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
Contributor

coderabbitai bot commented Jun 11, 2025

📝 Walkthrough

"""

Walkthrough

This change updates the internal logic of the setActive function in the @clerk/clerk-js package to ensure that when forced organization selection is enabled, calling setActive({ organization: null }) does not clear the active organization. Instead, it leaves the current active organization unchanged. Related tests were added to verify this behavior.

Changes

Files/Paths Change Summary
.changeset/dark-cougars-burn.md Documents the patch modifying setActive behavior for forced organization selection.
packages/clerk-js/src/core/clerk.ts Updates setActive logic to skip clearing the organization if forced selection is enabled; adjusts internal method call.
packages/clerk-js/src/core/tests/clerk.test.ts Adds tests for setActive with forced organization selection enabled, verifying organization is not cleared.

Possibly related PRs


📜 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 1c9a95a and ffb8f5b.

📒 Files selected for processing (3)
  • .changeset/dark-cougars-burn.md (1 hunks)
  • packages/clerk-js/src/core/__tests__/clerk.test.ts (1 hunks)
  • packages/clerk-js/src/core/clerk.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (3)
  • .changeset/dark-cougars-burn.md
  • packages/clerk-js/src/core/clerk.ts
  • packages/clerk-js/src/core/tests/clerk.test.ts
⏰ 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)
✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 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 docstrings to generate docstrings for this 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.

@@ -1071,10 +1071,6 @@ export class Clerk implements ClerkInterface {
);
}

if (organization === null && this.environment?.organizationSettings?.forceOrganizationSelection) {
throw new Error('setActive requires an organization parameter when organization selection is forced.');
Copy link
Member Author

@LauraBeatris LauraBeatris Jun 11, 2025

Choose a reason for hiding this comment

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

I believe it's better to not throw an error and just handle it idempotently as we're doing on the backend, cause it might break the entire application.

@LauraBeatris LauraBeatris marked this pull request as ready for review June 11, 2025 14:54
@LauraBeatris LauraBeatris requested a review from a team June 11, 2025 14:54
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/dark-cougars-burn.md (1)

5-5: Add punctuation for consistency.
Consider ending the summary line with a period to maintain consistency across changesets.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 4118ed7 and 420eb19.

📒 Files selected for processing (3)
  • .changeset/dark-cougars-burn.md (1 hunks)
  • packages/clerk-js/src/core/__tests__/clerk.test.ts (1 hunks)
  • packages/clerk-js/src/core/clerk.ts (2 hunks)
🔇 Additional comments (3)
packages/clerk-js/src/core/clerk.ts (2)

29-29: Import order change looks good.

The reorganization groups related imports together, which improves code organization.


1106-1115:

❓ Verification inconclusive

Implementation correctly prevents switching to personal workspace when force organization selection is enabled.

The logic properly handles the case by returning early without updating the session, which aligns with the PR objectives and the idempotent approach mentioned in past review comments.

Since the PR objectives mention that FAPI endpoints /tokens and /touch already handle this scenario idempotently, let's verify the behavior is consistent:


🏁 Script executed:

#!/bin/bash
# Description: Search for similar force organization selection handling in the codebase to ensure consistency

# Look for other references to forceOrganizationSelection to understand the pattern
rg -A 5 -B 5 "forceOrganizationSelection"

# Search for handling of organization switching in token/touch endpoints
ast-grep --pattern 'forceOrganizationSelection && $$$null$$$'

Length of output: 11923


Approve in-memory logic; verify backend idempotency

The client-side implementation in packages/clerk-js/src/core/clerk.ts (lines 1106–1115) prevents switching to the personal workspace when environment.organizationSettings.forceOrganizationSelection is true. Similar flags are used consistently in:

  • usePreloadTasks.ts (hasTasks check)
  • OrganizationSwitcher.ts and OrganizationList.ts (hidePersonal props)

Please confirm that the FAPI endpoints (/tokens and /touch) on the backend also enforce this scenario idempotently, matching the PR objectives.

.changeset/dark-cougars-burn.md (1)

1-3: YAML frontmatter is well-formed.
The changeset correctly specifies a patch bump for the @clerk/clerk-js package.

@LauraBeatris LauraBeatris force-pushed the laura/fix-set-active-force-an-org branch 2 times, most recently from 5a0ed3d to 4dbe881 Compare June 11, 2025 16:12
Copy link

pkg-pr-new bot commented Jun 11, 2025

Open in StackBlitz

@clerk/agent-toolkit

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

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

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

@clerk/elements

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

@clerk/clerk-expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/clerk-react

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

@clerk/react-router

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

@clerk/remix

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/themes

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

@clerk/types

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

@clerk/upgrade

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

@clerk/vue

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

commit: ffb8f5b

@LauraBeatris LauraBeatris force-pushed the laura/fix-set-active-force-an-org branch from 98d41f6 to ffb8f5b Compare June 11, 2025 19:40
@LauraBeatris LauraBeatris merged commit b0e47f1 into main Jun 11, 2025
37 checks passed
@LauraBeatris LauraBeatris deleted the laura/fix-set-active-force-an-org branch June 11, 2025 19:54
wobsoriano pushed a commit that referenced this pull request Jun 12, 2025
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