chore(clerk-js,types,clerk-react,astro,vue): Remove `treatPendingAsSignedOut` as Clerk option #6497

LauraBeatris · 2025-08-08T22:25:12Z

Description

Context

treatPendingAsSignedOut was first introduced in order to allow for control components and applications protection in general, to consider pending as signed-out by default, but allowing developers to opt-out.

Why removing as an option

Clerk.isSignedIn should always return false if the session is pending in order to gate UI that is protected from an active session, without tasks.

Our AIO components are going to rely on it. If the developer passes treatPendingAsSignedOut: false to ClerkProvider, it'd break the whole flow and this wouldn't render:

<SignedOut>
  <SignIn />
</SignedOut>

it removes the confusion on why the prop is not propagated for control components on the server boundary.

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

Summary by CodeRabbit

Refactor
- Removed the treatPendingAsSignedOut option and all related fallback logic across React, Vue, Astro, and core packages.
- Pending user sessions are now consistently treated as signed out across all integrations.
- Updated type definitions and environment configurations to reflect this change.

changeset-bot · 2025-08-08T22:25:16Z

🦋 Changeset detected

Latest commit: 48d7fd8

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

This PR includes changesets to release 22 packages

Name	Type
@clerk/clerk-js	Minor
@clerk/astro	Minor
@clerk/clerk-react	Minor
@clerk/types	Minor
@clerk/vue	Minor
@clerk/chrome-extension	Patch
@clerk/clerk-expo	Patch
@clerk/elements	Patch
@clerk/nextjs	Patch
@clerk/react-router	Patch
@clerk/remix	Patch
@clerk/tanstack-react-start	Patch
@clerk/agent-toolkit	Patch
@clerk/backend	Patch
@clerk/expo-passkeys	Patch
@clerk/express	Patch
@clerk/fastify	Patch
@clerk/localizations	Patch
@clerk/nuxt	Patch
@clerk/shared	Patch
@clerk/testing	Patch
@clerk/themes	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

vercel · 2025-08-08T22:25:18Z

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 8, 2025 10:49pm

coderabbitai · 2025-08-08T22:31:50Z

📝 Walkthrough

Walkthrough

This change removes the treatPendingAsSignedOut option and all associated fallback logic from multiple Clerk packages, including Astro, React, Vue, Clerk core, and shared type definitions. The environment variable PUBLIC_CLERK_TREAT_PENDING_AS_SIGNED_OUT and its usage are eliminated. The isSignedIn getter in the Clerk core is updated to always treat a session with status 'pending' as signed out, unconditionally. Type definitions are updated to remove imports and intersections related to pending session options. No exported function signatures or public API contracts are changed.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~15–20 minutes

Possibly related PRs

chore(clerk-js): Remove treatPendingAsSignedOut from useSession #6432: Both PRs remove the treatPendingAsSignedOut option and simplify session and auth state handling by no longer treating pending sessions as signed out based on this flag, indicating they address the same feature removal and related logic simplification.

Suggested reviewers

panteliselef

📜 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 672e8d1 and 48d7fd8.

📒 Files selected for processing (9)

.changeset/shiny-pants-jump.md (1 hunks)
packages/astro/src/env.d.ts (0 hunks)
packages/astro/src/integration/create-integration.ts (1 hunks)
packages/astro/src/react/hooks.ts (2 hunks)
packages/clerk-js/src/core/clerk.ts (1 hunks)
packages/react/src/hooks/useAuth.ts (1 hunks)
packages/types/src/clerk.ts (2 hunks)
packages/vue/src/composables/useAuth.ts (2 hunks)
packages/vue/src/plugin.ts (0 hunks)

💤 Files with no reviewable changes (2)

packages/astro/src/env.d.ts
packages/vue/src/plugin.ts

✅ Files skipped from review due to trivial changes (1)

.changeset/shiny-pants-jump.md

🚧 Files skipped from review as they are similar to previous changes (6)

packages/astro/src/integration/create-integration.ts
packages/react/src/hooks/useAuth.ts
packages/types/src/clerk.ts
packages/astro/src/react/hooks.ts
packages/clerk-js/src/core/clerk.ts
packages/vue/src/composables/useAuth.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: Formatting | Dedupe | Changeset
GitHub Check: Build Packages
GitHub Check: semgrep/ci
GitHub Check: Analyze (javascript-typescript)
GitHub Check: semgrep-cloud-platform/scan

🪧 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.

pkg-pr-new · 2025-08-08T22:33:03Z

Open in StackBlitz

@clerk/agent-toolkit

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

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

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

@clerk/elements

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

@clerk/clerk-expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/clerk-react

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

@clerk/react-router

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

@clerk/remix

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/themes

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

@clerk/types

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

@clerk/upgrade

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

@clerk/vue

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

commit: 48d7fd8

coderabbitai

Actionable comments posted: 0

🔭 Outside diff range comments (3)

packages/vue/src/composables/useAuth.ts (1)

76-115: Tests missing for pending-session behavior in Vue composable

Add tests ensuring useAuth({ /* any value */ }).isSignedIn === false when session is pending.

I can scaffold unit tests for this composable; let me know your preferred test runner.

packages/react/src/hooks/useAuth.ts (1)

95-124: Add tests to assert pending-session semantics in React

Please add/adjust tests to assert useAuth().isSignedIn === false when session is pending, regardless of passed options.

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

361-368: Remove remaining treatPendingAsSignedOut options and add gating tests

The grep run shows many leftover treatPendingAsSignedOut definitions/usages and docs entries across the monorepo. Before merging, please:

• Remove treatPendingAsSignedOut from all packages (vue, react, astro, nextjs, shared, types, backend)
– Delete the option types, prop definitions and default-true fallbacks
– Clean up any CHANGELOG/docs/examples that mention it or the old env var
• Add a unit test in packages/clerk-js to assert:

Clerk.isSignedIn returns false when session.status === 'pending'
• Add control-component tests in each client package to verify that pending sessions are treated as signed-out by default:

<SignedIn> and <Protect> do not render their children when status is pending

<SignedOut> renders correctly under a pending session

🧹 Nitpick comments (4)

packages/astro/src/integration/create-integration.ts (1)

165-186: Env schema consistency check

Schema no longer includes the removed env. Good. Consider adding a migration note in docs pointing users to the new behavior (pending => signed-out always).

I can draft the doc/migration note PR snippet if helpful.

packages/react/src/hooks/useAuth.ts (1)

38-39: Docs/JSDoc follow-up

The JSDoc mentions treatPendingAsSignedOut with default true. If the option is no longer honored, mark it deprecated or clarify it has no effect and pending is always treated as signed-out.

I can update the JSDoc/comment block accordingly.

packages/astro/src/react/hooks.ts (1)

58-60: Type surface follow-up

If we enforce the behavior, consider deprecating PendingSessionOptions.treatPendingAsSignedOut in types used by this hook (non-breaking now; remove in next major).
packages/clerk-js/src/core/clerk.ts (1)
361-368: Minor: drop optional chaining on this; add concise JSDoc clarifying semantics

Inside class methods, this is always defined; prefer this.session?.status over this?.session?.status for clarity.

Apply this tiny cleanup:
-const hasPendingSession = this?.session?.status === 'pending';
+const hasPendingSession = this.session?.status === 'pending';
And consider documenting the public getter to avoid ambiguity:
/**
 * True when an active, non-pending session is present.
 * Sessions with status 'pending' are treated as signed out.
 */
get isSignedIn(): boolean;

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between cf284ee and 01ec690.

📒 Files selected for processing (8)

packages/astro/src/env.d.ts (0 hunks)
packages/astro/src/integration/create-integration.ts (1 hunks)
packages/astro/src/react/hooks.ts (1 hunks)
packages/clerk-js/src/core/clerk.ts (1 hunks)
packages/react/src/hooks/useAuth.ts (1 hunks)
packages/types/src/clerk.ts (2 hunks)
packages/vue/src/composables/useAuth.ts (2 hunks)
packages/vue/src/plugin.ts (0 hunks)

💤 Files with no reviewable changes (2)

packages/astro/src/env.d.ts
packages/vue/src/plugin.ts

🧰 Additional context used

📓 Path-based instructions (7)

**/*.{js,jsx,ts,tsx}