fix(nextjs): Propagate `treatPendingAsSignedOut` to `auth` from `clerkMiddleware` #6477

LauraBeatris · 2025-08-05T16:54:52Z

Description

Previously, the treatPendingAsSignedOut wasn't being propagated to the clerkMiddleware handler. This PR fixes it by resolving the auth object on the handler itself using that option.

export default clerkMiddleware((auth, req) => {
  // If the session has a `pending` status, `userId` will be `null` by default, treated as a signed-out state
  const { userId } = await auth()
})

export default clerkMiddleware((auth, req) => {
  // If the session has a `pending` status, `userId` will be defined, treated as a signed-in state
  const { userId } = await auth({ treatPendingAsSignedOut: false })
})

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

Documentation
- Added examples and improved documentation for handling pending sessions with the authentication middleware, clarifying how to control whether pending sessions are treated as signed in or signed out.
New Features
- Introduced an option to explicitly control how pending authentication sessions are interpreted in middleware, allowing more flexible session handling for end-users.

vercel · 2025-08-05T16:54:58Z

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 5, 2025 7:09pm

changeset-bot · 2025-08-05T16:55:02Z

🦋 Changeset detected

Latest commit: 1a8024a

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

This PR includes changesets to release 1 package

Name	Type
@clerk/nextjs	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

coderabbitai · 2025-08-05T17:07:30Z

📝 Walkthrough

Walkthrough

This change updates the clerkMiddleware in the @clerk/nextjs package to propagate the treatPendingAsSignedOut option to the auth function. It modifies the function signature of createMiddlewareAuthHandler to accept a requestState parameter of type AuthenticatedState<'session_token'> | UnauthenticatedState<'session_token'> instead of a precomputed authObject. The conversion to an auth object is deferred until inside the handler by calling requestState.toAuth() with the treatPendingAsSignedOut option. Usage examples and documentation are added to demonstrate how the option affects session handling for pending states, allowing explicit control over whether pending sessions are treated as signed out or signed in.

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 c00fd88 and 1a8024a.

📒 Files selected for processing (2)

.changeset/tricky-planets-cry.md (1 hunks)
packages/nextjs/src/server/clerkMiddleware.ts (3 hunks)

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

.changeset/tricky-planets-cry.md
packages/nextjs/src/server/clerkMiddleware.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). (21)

GitHub Check: Integration Tests (nextjs, chrome, 14)
GitHub Check: Integration Tests (billing, chrome)
GitHub Check: Integration Tests (nextjs, chrome, 15)
GitHub Check: Integration Tests (expo-web, chrome)
GitHub Check: Integration Tests (tanstack-react-router, chrome)
GitHub Check: Integration Tests (nuxt, chrome)
GitHub Check: Integration Tests (react-router, chrome)
GitHub Check: Integration Tests (vue, chrome)
GitHub Check: Integration Tests (tanstack-react-start, chrome)
GitHub Check: Integration Tests (sessions, chrome)
GitHub Check: Integration Tests (localhost, chrome)
GitHub Check: Integration Tests (elements, chrome)
GitHub Check: Integration Tests (ap-flows, chrome)
GitHub Check: Integration Tests (express, chrome)
GitHub Check: Integration Tests (astro, chrome)
GitHub Check: Publish with pkg-pr-new
GitHub Check: Unit Tests (22, **)
GitHub Check: Integration Tests (generic, chrome)
GitHub Check: Integration Tests (quickstart, chrome)
GitHub Check: Unit Tests (18, --filter=@clerk/astro --filter=@clerk/backend --filter=@clerk/express --filter=@c...
GitHub Check: Static analysis

🪧 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-05T17:12:05Z

Open in StackBlitz

@clerk/agent-toolkit

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

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

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

@clerk/elements

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

@clerk/clerk-expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/clerk-react

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

@clerk/react-router

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

@clerk/remix

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/themes

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

@clerk/types

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

@clerk/upgrade

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

@clerk/vue

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

commit: 1a8024a

.changeset/tricky-planets-cry.md

LauraBeatris self-assigned this Aug 5, 2025

LauraBeatris force-pushed the laura/fix-pending-auth-object-middleware-handler branch from 7537036 to 5733359 Compare August 5, 2025 16:55

clerk-cookie added the nextjs label Aug 5, 2025

vercel bot temporarily deployed to Preview August 5, 2025 16:55 Inactive

LauraBeatris changed the title ~~fix(backend): Propagate treatPendingAsSignedOut to auth from clerkMiddleware~~ fix(nextjs): Propagate treatPendingAsSignedOut to auth from clerkMiddleware Aug 5, 2025

vercel bot deployed to Preview August 5, 2025 16:59 View deployment

LauraBeatris changed the title ~~fix(nextjs): Propagate treatPendingAsSignedOut to auth from clerkMiddleware~~ fix(nextjs): Propagate treatPendingAsSignedOut to auth from clerkMiddleware Aug 5, 2025

LauraBeatris force-pushed the laura/fix-pending-auth-object-middleware-handler branch from 1040314 to 1f127e5 Compare August 5, 2025 17:04

LauraBeatris marked this pull request as ready for review August 5, 2025 17:04

LauraBeatris requested a review from a team August 5, 2025 17:04

vercel bot deployed to Preview August 5, 2025 17:05 View deployment

LauraBeatris force-pushed the laura/fix-pending-auth-object-middleware-handler branch from 1f127e5 to c00fd88 Compare August 5, 2025 17:08

LauraBeatris requested a review from iagodahlem August 5, 2025 17:09

vercel bot deployed to Preview August 5, 2025 17:10 View deployment

iagodahlem approved these changes Aug 5, 2025

View reviewed changes

.changeset/tricky-planets-cry.md Outdated Show resolved Hide resolved

.changeset/tricky-planets-cry.md Outdated Show resolved Hide resolved

LauraBeatris force-pushed the laura/fix-pending-auth-object-middleware-handler branch from c00fd88 to 9b07830 Compare August 5, 2025 19:07

LauraBeatris added 2 commits August 5, 2025 16:07

Resolve auth object with options from handler

e861eff

Add changeset

1a8024a

LauraBeatris force-pushed the laura/fix-pending-auth-object-middleware-handler branch from 9b07830 to 1a8024a Compare August 5, 2025 19:07

vercel bot deployed to Preview August 5, 2025 19:09 View deployment

LauraBeatris merged commit 90acc76 into main Aug 5, 2025
36 checks passed

LauraBeatris deleted the laura/fix-pending-auth-object-middleware-handler branch August 5, 2025 20:26

clerk-cookie mentioned this pull request Aug 5, 2025

ci(repo): Version packages #6454

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix(nextjs): Propagate `treatPendingAsSignedOut` to `auth` from `clerkMiddleware` #6477

fix(nextjs): Propagate `treatPendingAsSignedOut` to `auth` from `clerkMiddleware` #6477

Uh oh!

LauraBeatris commented Aug 5, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

vercel bot commented Aug 5, 2025 •

edited

Loading

Uh oh!

changeset-bot bot commented Aug 5, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Aug 5, 2025 •

edited

Loading

Walkthrough

Estimated code review effort

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

pkg-pr-new bot commented Aug 5, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fix(nextjs): Propagate treatPendingAsSignedOut to auth from clerkMiddleware #6477

fix(nextjs): Propagate treatPendingAsSignedOut to auth from clerkMiddleware #6477

Uh oh!

Conversation

LauraBeatris commented Aug 5, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Type of change

Summary by CodeRabbit

Uh oh!

vercel bot commented Aug 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

changeset-bot bot commented Aug 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

coderabbitai bot commented Aug 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Estimated code review effort

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

pkg-pr-new bot commented Aug 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fix(nextjs): Propagate `treatPendingAsSignedOut` to `auth` from `clerkMiddleware` #6477

fix(nextjs): Propagate `treatPendingAsSignedOut` to `auth` from `clerkMiddleware` #6477

LauraBeatris commented Aug 5, 2025 •

edited by coderabbitai bot

Loading

vercel bot commented Aug 5, 2025 •

edited

Loading

changeset-bot bot commented Aug 5, 2025 •

edited

Loading

coderabbitai bot commented Aug 5, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

pkg-pr-new bot commented Aug 5, 2025 •

edited

Loading