test(nextjs): Add tests for useInternalNavFun navigation promise resolution by jacekradko · Pull Request #7996 · clerk/javascript

jacekradko · 2026-03-05T16:05:52Z

Summary

Adds unit and integration tests to validate that removing usePathname from useInternalNavFun's effect deps (#7989) doesn't regress the navigation promise flushing behavior originally fixed in #2899.

Context

PR #7989 changed the flush effect deps from [pathname, isPending] to [isPending] to fix cacheComponents: true build failures. The concern raised was: "how did we test this? I think usePathname was added because we were seeing the promise never resolve in some scenarios without it."

Investigation of the original PR #2889/#2899 review comments revealed:

The real fix was moving the promise buffer from useRef to window (surviving ClerkProvider unmount/remount)
usePathname was added as a belt-and-suspenders safety net — the original author stated "I never managed to reproduce a failed setActive because of us not listening to isPending"
usePathname actually introduced a latent bug: same-path navigations would hang because pathname wouldn't change

Unit tests (`useInternalNavFun.test.tsx`)

Test	What it validates
Single navigation promise resolves	Core `isPending`-only mechanism works
Pre-existing window buffer flushed on mount	ClerkProvider remount scenario from #2899
Pending promises flushed on unmount	ClerkProvider unmount during navigation
Internal navigations use history pushState	Previously untested `navigationType === 'internal'` path

Integration tests (`cache-components.test.ts`)

Test	What it validates
Sign out completes without hanging	Full `setActive(null)` -> `navigate(redirectUrl)` -> `routerPush` -> `useInternalNavFun` -> `startTransition` chain. If `isPending` doesn't cycle, `signOut()` hangs and the test times out.
Protected route redirects after sign out	Cache invalidation + navigation work correctly end-to-end

The E2E tests run against cacheComponents: true (the exact environment where #7989's change matters) and exercise real Next.js routing where isPending behavior differs from mocked unit tests.

Test plan

pnpm vitest run packages/nextjs/src/app-router/client/__tests__/useInternalNavFun.test.tsx passes (14/14 tests, 0 type errors)
CI passes (integration tests run in CI against next.cacheComponents pattern)

Summary by CodeRabbit

Tests
- Added integration tests for sign-out behavior and navigation flows.
- Added unit tests for internal navigation functionality and promise resolution.

…lution Add unit and integration tests to validate that removing usePathname from useInternalNavFun's effect deps (#7989) doesn't regress the navigation promise flushing behavior originally fixed in #2899. Unit tests: - Single navigation promise resolves via isPending alone - Pre-existing window buffer flushed on mount (ClerkProvider remount) - Pending promises flushed on unmount (ClerkProvider unmount) - Internal navigations use history pushState instead of router Integration tests (cache-components / cacheComponents: true): - Sign out completes without hanging (exercises full setActive → navigate → routerPush → useInternalNavFun chain) - Protected route redirects correctly after sign out (validates cache invalidation + navigation)

vercel · 2026-03-05T16:05:55Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
clerk-js-sandbox	Ready	Preview, Comment	Mar 5, 2026 7:57pm

changeset-bot · 2026-03-05T16:06:02Z

🦋 Changeset detected

Latest commit: d721c17

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

This PR includes changesets to release 0 packages

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

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

pkg-pr-new · 2026-03-05T16:08:53Z

Open in StackBlitz

@clerk/agent-toolkit

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

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

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

@clerk/expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

npm i https://pkg.pr.new/@clerk/hono@7996

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

npm i https://pkg.pr.new/@clerk/ui@7996

@clerk/upgrade

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

@clerk/vue

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

commit: d721c17

coderabbitai · 2026-03-05T16:09:03Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro

Run ID: a8dcfa60-85d9-4a4e-bd41-4a26900a695a

📥 Commits

Reviewing files that changed from the base of the PR and between 3157c25 and 279fc69.

📒 Files selected for processing (3)

.changeset/add-navigation-promise-tests.md
integration/tests/cache-components.test.ts
packages/nextjs/src/app-router/client/__tests__/useInternalNavFun.test.tsx

📝 Walkthrough

Walkthrough

This pull request adds test coverage for navigation promise handling and sign-out behavior. A changeset file is introduced to document the changes. Two new integration tests verify that sign-out operations complete successfully and that protected routes redirect appropriately after sign-out. Additionally, unit tests are added for the useInternalNavFun hook to cover navigation promise resolution, buffer flushing on component mount and unmount, and internal navigation using window history state management.

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and specifically describes the main change: adding tests for useInternalNavFun navigation promise resolution, which aligns with the test additions across unit and integration test files.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

jacekradko added 2 commits March 5, 2026 10:01

chore: Add empty changeset
279fc69

github-actionsBot added nextjs integration labels Mar 5, 2026

vercelBotdeployed to Preview March 5, 2026 16:06 View deployment

Merge branch 'main' into jacek/add-navigation-promise-tests
d721c17

vercelBotdeployed to Preview March 5, 2026 19:57 View deployment

wobsoriano approved these changes Mar 5, 2026
View reviewed changes

jacekradko merged commit 79d0ecf into mainMar 5, 2026
39 checks passed

jacekradko deleted the jacek/add-navigation-promise-tests branch March 5, 2026 23:46

Navigation Menu

Uh oh!

test(nextjs): Add tests for useInternalNavFun navigation promise resolution - #7996

test(nextjs): Add tests for useInternalNavFun navigation promise resolution#7996
jacekradko merged 3 commits into
mainfrom
jacek/add-navigation-promise-tests

jacekradko commented Mar 5, 2026•
edited by coderabbitai Bot
Loading

Uh oh!

vercelBot commented Mar 5, 2026•
edited
Loading

Uh oh!

changeset-botBot commented Mar 5, 2026•
edited
Loading

Uh oh!

pkg-pr-newBot commented Mar 5, 2026•
edited
Loading

Uh oh!

coderabbitaiBot commented Mar 5, 2026

Walkthrough

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

jacekradko commented Mar 5, 2026• edited by coderabbitai BotLoading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Context

Unit tests (useInternalNavFun.test.tsx)

Integration tests (cache-components.test.ts)

Test plan

Summary by CodeRabbit

Uh oh!

vercelBot commented Mar 5, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

changeset-botBot commented Mar 5, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

pkg-pr-newBot commented Mar 5, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitaiBot commented Mar 5, 2026

Walkthrough

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

jacekradko commented Mar 5, 2026•
edited by coderabbitai Bot
Loading

Unit tests (`useInternalNavFun.test.tsx`)

Integration tests (`cache-components.test.ts`)

vercelBot commented Mar 5, 2026•
edited
Loading

changeset-botBot commented Mar 5, 2026•
edited
Loading

pkg-pr-newBot commented Mar 5, 2026•
edited
Loading