Skip to content

fix(clerk-js): Do not allow setActive({ organization: null }) when organization selection is forced #6073

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 2 commits into from
Jun 9, 2025

Conversation

LauraBeatris
Copy link
Member

@LauraBeatris LauraBeatris commented Jun 5, 2025

Description

Resolves ORGS-682

Disclaimer: We're also going to apply protections on the API side, this is just an additional guard.

Introduces an error guard not to allow calling setActive({ organization: null }) when organization selection is forced on the instance settings.

The same handling should be made when we refactor setActive to setCurrent 👀

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
    • Prevented users from setting the active organization to "none" when organization selection is required, ensuring a valid organization context is always maintained.

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

changeset-bot bot commented Jun 5, 2025

🦋 Changeset detected

Latest commit: 19999c2

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 5, 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 9, 2025 4:23pm

@LauraBeatris LauraBeatris force-pushed the laura/do-not-allow-org-null-for-force-org branch from aa47320 to b24bfad Compare June 5, 2025 21:34
@LauraBeatris LauraBeatris marked this pull request as ready for review June 5, 2025 21:35
@LauraBeatris LauraBeatris force-pushed the laura/do-not-allow-org-null-for-force-org branch from b24bfad to 4a473d9 Compare June 5, 2025 21:35
@LauraBeatris LauraBeatris requested a review from a team June 5, 2025 21:36
Copy link

pkg-pr-new bot commented Jun 5, 2025

Open in StackBlitz

@clerk/agent-toolkit

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

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

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

@clerk/elements

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

@clerk/clerk-expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/clerk-react

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

@clerk/react-router

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

@clerk/remix

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/themes

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

@clerk/types

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

@clerk/upgrade

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

@clerk/vue

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

commit: 19999c2

@LauraBeatris LauraBeatris force-pushed the laura/do-not-allow-org-null-for-force-org branch from 4a473d9 to c6cf838 Compare June 5, 2025 21:44
@LauraBeatris LauraBeatris marked this pull request as draft June 5, 2025 23:00
@LauraBeatris LauraBeatris force-pushed the laura/do-not-allow-org-null-for-force-org branch from c6cf838 to 5dd6089 Compare June 6, 2025 21:49
@LauraBeatris LauraBeatris marked this pull request as ready for review June 9, 2025 16:08
Copy link
Contributor

coderabbitai bot commented Jun 9, 2025

📝 Walkthrough

Walkthrough

A validation check was added to the setActive method in the Clerk class to prevent setting the active organization to null when forced organization selection is enabled. If this condition is met, the method now throws an error, ensuring invalid state transitions are blocked. Additionally, the maximum allowed size for certain bundle files was slightly increased.

Changes

File(s) Change Summary
packages/clerk-js/src/core/clerk.ts Added a check in setActive to throw an error if organization: null is passed and forced selection is enabled.
.changeset/petite-ravens-see.md Added a changeset describing the patch and its intent.
packages/clerk-js/bundlewatch.config.json Increased max allowed size for ./dist/clerk.headless*.js files from 52.2KB to 53KB.

Assessment against linked issues

Objective Addressed Explanation
Prevent setActive({ organization: null }) from updating session to pending when force-an-org is enabled (ORGS-682)
Throw an error if setActive({ organization: null }) is called when forceOrganizationSelection is true (ORGS-682)

Assessment against linked issues: Out-of-scope changes

No out-of-scope changes were found.

Warning

Review ran into problems

🔥 Problems

Errors were encountered while retrieving linked issues.

Errors (1)
  • ORGS-682: GraphQL Error (Code: 502) -
<title>502 Server Error</title>

Error: Server Error

The server encountered a temporary error and could not complete your request.

Please try again in 30 seconds.


📜 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 dee8e62 and 19999c2.

📒 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 (25)
  • GitHub Check: Integration Tests (quickstart, chrome)
  • GitHub Check: Integration Tests (nuxt, chrome)
  • GitHub Check: Integration Tests (nextjs, chrome, 13)
  • GitHub Check: Integration Tests (billing, chrome)
  • GitHub Check: Integration Tests (nextjs, chrome, 14)
  • GitHub Check: Integration Tests (sessions, chrome)
  • GitHub Check: Integration Tests (vue, chrome)
  • GitHub Check: Integration Tests (react-router, chrome)
  • GitHub Check: Integration Tests (localhost, chrome)
  • GitHub Check: Integration Tests (expo-web, chrome)
  • GitHub Check: Integration Tests (nextjs, chrome, 15)
  • GitHub Check: Integration Tests (astro, chrome)
  • GitHub Check: Integration Tests (tanstack-react-router, chrome)
  • GitHub Check: Integration Tests (tanstack-react-start, chrome)
  • GitHub Check: Integration Tests (elements, chrome)
  • GitHub Check: Integration Tests (ap-flows, chrome)
  • GitHub Check: Integration Tests (express, chrome)
  • GitHub Check: Publish with pkg-pr-new
  • GitHub Check: Unit Tests (22, **)
  • GitHub Check: Static analysis
  • GitHub Check: Unit Tests (18, --filter=@clerk/astro --filter=@clerk/backend --filter=@clerk/express --filter=@c...
  • GitHub Check: semgrep-cloud-platform/scan
  • GitHub Check: Formatting | Dedupe | Changeset
  • 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 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.

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)
packages/clerk-js/src/core/clerk.ts (1)

1074-1076: Consider using ClerkRuntimeError for consistency.

The validation logic is correct and well-placed. However, for consistency with other error handling in this file, consider using ClerkRuntimeError instead of a generic Error.

-      if (organization === null && this.environment?.organizationSettings?.forceOrganizationSelection) {
-        throw new Error('setActive requires an organization parameter when organization selection is forced.');
-      }
+      if (organization === null && this.environment?.organizationSettings?.forceOrganizationSelection) {
+        throw new ClerkRuntimeError('setActive requires an organization parameter when organization selection is forced.');
+      }

This would align with the error handling patterns used elsewhere in the codebase.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 19e9e11 and 5dd6089.

📒 Files selected for processing (2)
  • .changeset/petite-ravens-see.md (1 hunks)
  • packages/clerk-js/src/core/clerk.ts (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
packages/clerk-js/src/core/clerk.ts (1)
packages/react/src/isomorphicClerk.ts (1)
  • organization (658-664)
🔇 Additional comments (2)
packages/clerk-js/src/core/clerk.ts (1)

1061-1183: Validation guard implementation looks solid.

The placement and logic of the organization validation check is excellent:

  • Early placement ensures fail-fast behavior
  • Proper use of optional chaining to handle undefined environment
  • Clear and descriptive error message
  • Correctly targets only explicit null values, not undefined

The implementation effectively prevents invalid state transitions when organization selection is mandatory.

.changeset/petite-ravens-see.md (1)

1-6: Changeset documentation is accurate and well-formatted.

The changeset correctly documents this as a patch-level change and provides a clear description of the functionality being added.

@LauraBeatris LauraBeatris merged commit 684f3bd into main Jun 9, 2025
61 of 62 checks passed
@LauraBeatris LauraBeatris deleted the laura/do-not-allow-org-null-for-force-org branch June 9, 2025 16:37
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