Uh oh!
There was an error while loading. Please reload this page.
fix(nextjs): Support Next.js 16 cache invalidation on sign-out - #7211
Conversation
🦋 Changeset detectedLatest commit: b06501c The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
The latest updates on your projects. Learn more about Vercel for GitHub.
|
WalkthroughThis change extends the sign-out cache invalidation noop handling in Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
Comment |
@clerk/agent-toolkit@clerk/astro@clerk/backend@clerk/chrome-extension@clerk/clerk-js@clerk/dev-cli@clerk/elements@clerk/clerk-expo@clerk/expo-passkeys@clerk/express@clerk/fastify@clerk/localizations@clerk/nextjs@clerk/nuxt@clerk/clerk-react@clerk/react-router@clerk/remix@clerk/shared@clerk/tanstack-react-start@clerk/testing@clerk/themes@clerk/types@clerk/upgrade@clerk/vuecommit: |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
packages/nextjs/src/app-router/client/ClerkProvider.tsx (1)
104-110: Fix correctly extends noop to Next.js 16; consider version check pattern for future maintenance.The logic correctly addresses the reported bug by preventing
invalidateCacheAction()from being called during sign-out on Next.js 16, avoiding 404/405 errors when the__sessioncookie has already been cleared.The current approach using explicit OR conditions (
nextVersion.startsWith('15') || nextVersion.startsWith('16')) is safe but will require updates for each new major version (17, 18, etc.). For improved maintainability, consider extracting the version check into a helper function or using major version comparison:constshouldSkipCacheInvalidationOnSignOut=(version: string,intent: string)=>{constmajorVersion=parseInt(version.split('.')[0],10);returnmajorVersion>=15&&intent==='sign-out';};However, this assumes future Next.js versions maintain the same cache behavior. Given the authentication-critical nature of this code, the current explicit version checking may be safer if you prefer to validate behavior for each new major version before enabling this optimization.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
.changeset/major-rabbits-reply.md(1 hunks)packages/nextjs/src/app-router/client/ClerkProvider.tsx(1 hunks)
⏰ 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). (32)
- GitHub Check: Integration Tests (nextjs, chrome, 16)
- GitHub Check: Integration Tests (nextjs, chrome, 14)
- GitHub Check: Integration Tests (quickstart, chrome, 16)
- GitHub Check: Integration Tests (nextjs, chrome, 15, RQ)
- GitHub Check: Integration Tests (nuxt, chrome)
- GitHub Check: Integration Tests (billing, chrome, RQ)
- GitHub Check: Integration Tests (quickstart, chrome, 15)
- GitHub Check: Integration Tests (billing, chrome)
- GitHub Check: Integration Tests (expo-web, chrome)
- GitHub Check: Integration Tests (vue, chrome)
- GitHub Check: Integration Tests (tanstack-react-start, chrome)
- GitHub Check: Integration Tests (machine, chrome)
- GitHub Check: Integration Tests (nextjs, chrome, 15)
- GitHub Check: Integration Tests (astro, chrome)
- GitHub Check: Integration Tests (custom, chrome)
- GitHub Check: Integration Tests (react-router, chrome)
- GitHub Check: Integration Tests (sessions, chrome)
- GitHub Check: Integration Tests (elements, chrome)
- GitHub Check: Integration Tests (localhost, chrome)
- GitHub Check: Integration Tests (sessions:staging, chrome)
- GitHub Check: Integration Tests (handshake, chrome)
- GitHub Check: Integration Tests (handshake:staging, chrome)
- GitHub Check: Integration Tests (express, chrome)
- GitHub Check: Integration Tests (generic, chrome)
- GitHub Check: Static analysis
- GitHub Check: Unit Tests (22, shared, clerk-js, RQ)
- GitHub Check: Unit Tests (22, **)
- GitHub Check: Publish with pkg-pr-new
- GitHub Check: Formatting | Dedupe | Changeset
- GitHub Check: Analyze (javascript-typescript)
- GitHub Check: semgrep-cloud-platform/scan
- GitHub Check: semgrep-cloud-platform/scan
🔇 Additional comments (2)
.changeset/major-rabbits-reply.md (1)
1-5: LGTM! Changeset accurately documents the patch.The changeset correctly describes the extension of cache invalidation noop handling to Next.js 16 during sign-out, matching the code changes in ClerkProvider.tsx.
packages/nextjs/src/app-router/client/ClerkProvider.tsx (1)
99-100: LGTM! Comment improvement and typo fix.The comment update to "Next.js v15+" accurately reflects the extended version support, and the typo correction from "singed in" to "signed in" improves readability.
| // To mitigate this, since the router cache on version 15+ is much less aggressive, we can treat this as a noop and simply resolve the promise. | ||
| // Once `setActive` performs the navigation, `__unstable__onAfterSetActive` will kick in and perform a router.refresh ensuring shared layouts will also update with the correct authentication context. | ||
| else if (nextVersion.startsWith('15') && intent === 'sign-out') { | ||
| else if ((nextVersion.startsWith('15') || nextVersion.startsWith('16')) && intent === 'sign-out') { |
There was a problem hiding this comment.
This issue may occur again when future Next.js versions are released, such as version 17 and beyond.
To make the logic more future-proof, we could extract the major version number and compare it directly:
constmajorVersion=Number(nextVersion.split('.')[0]);majorVersion===13;// first condition majorVersion>=15&&intent==='sign-out';// second conditionThis avoids having to manually update the code every time a new version (e.g., 17, 18…) is released.
Description
Currently, Next.js 16 is falling through to call
invalidateCacheAction()which is causing issues with the navigation flow when switching to a session with pending status.Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change
Summary by CodeRabbit
Bug Fixes
Improvements