fix: no remounting with ssr:false

[schiller-manuel]

fixes #5956

Summary by CodeRabbit

• New Features

  • Route match objects now include SSR metadata, improving visibility of per-route SSR settings.
  • Client hydration now synchronizes and restores per-route SSR settings during app initialization.

• Bug Fixes

  • Removed client-side runtime guards that previously errored when SSR options were present, preventing unexpected client-side failures.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

Adds a public ssr field to route match records produced by RouterCore and propagates per-match SSR settings into route options during client-side hydration; removes several client-side runtime guards that previously errored if Route.options.ssr existed.

Changes

Cohort / File(s)	Summary
Core match metadata packages/router-core/src/router.ts	Adds a new public ssr property to match objects created in RouterCore.matchRoutesInternal (value is route.options.ssr on client, undefined on server).
SSR hydration sync packages/router-core/src/ssr/ssr-client.ts	Adds setRouteSsr(match) helper and calls it during hydration (when dehydrated match missing and after hydrateMatch) to apply match.ssr to route.options.ssr.
E2E: selective-ssr route guards removed e2e/react-start/selective-ssr/src/routes/__root.tsx, e2e/react-start/selective-ssr/src/routes/posts.$postId.tsx, e2e/react-start/selective-ssr/src/routes/posts.tsx, e2e/solid-start/selective-ssr/src/routes/__root.tsx, e2e/solid-start/selective-ssr/src/routes/posts.$postId.tsx, e2e/solid-start/selective-ssr/src/routes/posts.tsx	Removes client-side runtime assertions that threw errors when Route.options.ssr existed on the client; retains existing logging and other logic.

Sequence Diagram(s)

sequenceDiagram
  %% Styling note: green = client-side, blue = router core, gray = server/hydration data
  participant Browser as Browser (client)
  participant RouterCore as RouterCore
  participant SSRClient as ssr-client
  participant Dehydrated as DehydratedState

  Note over Browser,RouterCore: Navigation / Hydration start
  Browser->>RouterCore: matchRoutesInternal(request)
  RouterCore-->>RouterCore: create match { id, ssr: isServer ? undefined : route.options.ssr, ... }
  RouterCore->>Browser: return matches

  alt Hydration with dehydrated state
    Browser->>Dehydrated: read dehydrated match
    Dehydrated-->>SSRClient: provide dehydratedMatch
    SSRClient->>RouterCore: hydrateMatch(match, dehydratedMatch)
    SSRClient->>RouterCore: setRouteSsr(match)  %% apply match.ssr -> route.options.ssr
  else No dehydrated match found
    SSRClient->>RouterCore: setRouteSsr(match)  %% still apply match.ssr -> route.options.ssr
  end

  Note over Browser,RouterCore: Route.options.ssr now aligned with match.ssr on client

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

• Heterogeneous changes across core SSR logic and multiple E2E route files.
• Areas needing attention:
  • Consumers of match objects should be checked for the new ssr field and server/client shape differences.
  • Hydration spots where setRouteSsr is invoked to ensure no missed edge cases.
  • Removed client-side guards in E2E routes — verify tests and runtime behavior for regressions (remounting issues referenced in linked issue).

Possibly related PRs

• fix(router-core): Catch errors thrown during hydrate #5686 — touches per-match hydration logic in packages/router-core/src/ssr/ssr-client.ts; related to hydration flow and error handling.
• fix: cleanup streamed values #5870 — modifies router-core SSR client/server surfaces and per-route SSR management; overlaps with ssr propagation changes.
• refactor(router-core): simplify matchId #5807 — changes RouterCore.matchRoutesInternal; relevant due to the new ssr field addition to match records.

Suggested reviewers

• nlynzaad

Poem

🐰 A matching hop, a tiny SSR tune,

On client it sings, on server it's noon,
Hydration nudges options in place,
No more brave guards to race or to chase,
Routes snug together — a warm rabbit embrace 🥕

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The PR title clearly and concisely identifies the main fix: preventing remounting when ssr:false is set, which directly addresses the linked issue #5956.
Linked Issues check	✅ Passed	Changes add ssr field to match objects and propagate it to route options during hydration, while removing client-side checks that enforce deletion of ssr options, effectively fixing the remounting issue described in #5956.
Out of Scope Changes check	✅ Passed	All changes are directly scoped to fixing the ssr:false remounting issue: core router logic handles ssr metadata, SSR client logic propagates it during hydration, and test files remove obsolete client-side guards.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch fix-5956

---

📜 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 566022f and fba306f.

📒 Files selected for processing (6)

• e2e/react-start/selective-ssr/src/routes/__root.tsx (0 hunks)
• e2e/react-start/selective-ssr/src/routes/posts.$postId.tsx (0 hunks)
• e2e/react-start/selective-ssr/src/routes/posts.tsx (0 hunks)
• e2e/solid-start/selective-ssr/src/routes/__root.tsx (0 hunks)
• e2e/solid-start/selective-ssr/src/routes/posts.$postId.tsx (0 hunks)
• e2e/solid-start/selective-ssr/src/routes/posts.tsx (0 hunks)

💤 Files with no reviewable changes (6)

• e2e/react-start/selective-ssr/src/routes/posts.tsx
• e2e/react-start/selective-ssr/src/routes/posts.$postId.tsx
• e2e/solid-start/selective-ssr/src/routes/posts.$postId.tsx
• e2e/solid-start/selective-ssr/src/routes/posts.tsx
• e2e/react-start/selective-ssr/src/routes/__root.tsx
• e2e/solid-start/selective-ssr/src/routes/__root.tsx

⏰ 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). (2)

• GitHub Check: Preview
• GitHub Check: Test

---

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

[nx-cloud]

View your CI Pipeline Execution ↗ for commit fba306f

Command	Status	Duration	Result
nx affected --targets=test:eslint,test:unit,tes...	✅ Succeeded	1m 19s	View ↗
nx run-many --target=build --exclude=examples/*...	✅ Succeeded	4s	View ↗

---

☁️ Nx Cloud last updated this comment at 2025-11-25 20:04:03 UTC

[pkg-pr-new]

More templates

• tanstack-router-react-example-authenticated-routes
• tanstack-router-react-example-authenticated-routes-firebase
• tanstack-router-react-example-basic
• tanstack-router-react-example-basic-default-search-params
• tanstack-router-react-example-basic-devtools-panel
• tanstack-router-react-example-basic-file-based
• tanstack-router-react-example-basic-non-nested-devtools
• tanstack-router-react-example-react-query
• tanstack-router-react-example-basic-react-query-file-based
• tanstack-router-react-example-basic-ssr-file-based
• tanstack-router-react-example-basic-ssr-streaming-file-based
• tanstack-router-react-example-basic-virtual-file-based
• tanstack-router-react-example-basic-virtual-inside-file-based
• tanstack-router-react-example-deferred-data
• tanstack-router-i18n-paraglide
• tanstack-router-react-example-kitchen-sink
• tanstack-router-react-example-kitchen-sink-file-based
• tanstack-router-react-example-kitchen-sink-react-query
• tanstack-router-react-example-kitchen-sink-react-query-file-based
• tanstack-router-react-example-large-file-based
• tanstack-router-react-example-location-masking
• tanstack-router-react-example-navigation-blocking
• tanstack-router-react-example-quickstart
• tanstack-router-react-example-quickstart-esbuild-file-based
• tanstack-router-react-example-quickstart-file-based
• tanstack-router-react-example-quickstart-rspack-file-based
• tanstack-router-react-example-quickstart-webpack-file-based
• router-monorepo-react-query
• router-mono-simple
• router-mono-simple-lazy
• tanstack-router-react-example-scroll-restoration
• tanstack-search-validator-adapters
• tanstack-start-example-bare
• tanstack-start-example-basic
• tanstack-start-example-basic-auth
• tanstack-router-react-example-basic-authjs
• tanstack-start-example-basic-cloudflare
• tanstack-start-example-basic-react-query
• tanstack-start-example-basic-static
• tanstack-start-bun-hosting
• tanstack-start-example-clerk-basic
• tanstack-start-example-convex-trellaux
• tanstack-start-example-counter
• tanstack-start-i18n-paraglide
• tanstack-start-example-large
• tanstack-start-example-material-ui
• tanstack-start-streaming-data-from-server-functions
• tanstack-start-example-supabase-basic
• tanstack-start-tailwind-v4
• tanstack-start-example-trellaux
• tanstack-start-example-workos
• tanstack-router-react-example-view-transitions
• tanstack-router-react-example-with-framer-motion
• tanstack-router-react-example-with-trpc
• tanstack-router-react-example-with-trpc-react-query
• tanstack-router-solid-example-authenticated-routes
• tanstack-router-solid-example-authenticated-routes-firebase
• tanstack-router-solid-example-basic
• tanstack-router-solid-example-basic-default-search-params
• tanstack-router-solid-example-basic-devtools-panel
• tanstack-router-solid-example-basic-file-based
• tanstack-router-solid-example-basic-non-nested-devtools
• tanstack-router-solid-example-basic-solid-query
• tanstack-router-solid-example-basic-solid-query-file-based
• tanstack-router-solid-example-basic-ssr-file-based
• tanstack-router-solid-example-basic-ssr-streaming-file-based
• tanstack-router-solid-example-basic-virtual-file-based
• tanstack-router-solid-example-basic-virtual-inside-file-based
• tanstack-router-solid-example-deferred-data
• tanstack-router-solid-i18n-paraglide
• tanstack-router-solid-example-kitchen-sink
• tanstack-router-solid-example-kitchen-sink-file-based
• tanstack-router-solid-example-kitchen-sink-solid-query
• tanstack-router-solid-example-kitchen-sink-solid-query-file-based
• tanstack-router-solid-example-large-file-based
• tanstack-router-solid-example-location-masking
• tanstack-router-solid-example-navigation-blocking
• tanstack-router-solid-example-quickstart
• tanstack-router-solid-example-quickstart-esbuild-file-based
• tanstack-router-solid-example-quickstart-file-based
• tanstack-router-solid-example-quickstart-rspack-file-based
• tanstack-router-solid-example-quickstart-webpack-file-based
• router-solid-mono-simple
• router-solid-mono-simple-lazy
• router-solid-monorepo-solid-query
• tanstack-router-solid-example-scroll-restoration
• tanstack-solid-router-search-validator-adapters
• tanstack-solid-start-example-basic
• tanstack-solid-start-example-basic-auth
• tanstack-solid-start-example-basic-authjs
• tanstack-solid-start-example-basic-cloudflare
• tanstack-solid-start-example-basic-netlify
• tanstack-solid-start-example-basic-nitro
• tanstack-start-example-basic-solid-query
• tanstack-solid-start-example-basic-static
• tanstack-solid-start-bun-hosting
• tanstack-solid-start-example-convex-better-auth
• tanstack-solid-start-example-counter
• tanstack-solid-start-i18n-paraglide
• tanstack-solid-start-example-large
• tanstack-solid-start-streaming-data-from-server-functions
• tanstack-solid-start-example-supabase-basic
• tanstack-solid-start-tailwind-v4
• tanstack-router-solid-example-view-transitions
• tanstack-router-solid-example-with-framer-motion
• tanstack-router-solid-example-with-trpc

@tanstack/arktype-adapter

npm i https://pkg.pr.new/TanStack/router/@tanstack/arktype-adapter@5964

@tanstack/directive-functions-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/directive-functions-plugin@5964

@tanstack/eslint-plugin-router

npm i https://pkg.pr.new/TanStack/router/@tanstack/eslint-plugin-router@5964

@tanstack/history

npm i https://pkg.pr.new/TanStack/router/@tanstack/history@5964

@tanstack/nitro-v2-vite-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/nitro-v2-vite-plugin@5964

@tanstack/react-router

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router@5964

@tanstack/react-router-devtools

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router-devtools@5964

@tanstack/react-router-ssr-query

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router-ssr-query@5964

@tanstack/react-start

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start@5964

@tanstack/react-start-client

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-client@5964

@tanstack/react-start-server

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-server@5964

@tanstack/router-cli

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-cli@5964

@tanstack/router-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-core@5964

@tanstack/router-devtools

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-devtools@5964

@tanstack/router-devtools-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-devtools-core@5964

@tanstack/router-generator

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-generator@5964

@tanstack/router-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-plugin@5964

@tanstack/router-ssr-query-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-ssr-query-core@5964

@tanstack/router-utils

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-utils@5964

@tanstack/router-vite-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-vite-plugin@5964

@tanstack/server-functions-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/server-functions-plugin@5964

@tanstack/solid-router

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-router@5964

@tanstack/solid-router-devtools

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-router-devtools@5964

@tanstack/solid-router-ssr-query

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-router-ssr-query@5964

@tanstack/solid-start

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start@5964

@tanstack/solid-start-client

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-client@5964

@tanstack/solid-start-server

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-server@5964

@tanstack/start-client-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-client-core@5964

@tanstack/start-plugin-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-plugin-core@5964

@tanstack/start-server-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-server-core@5964

@tanstack/start-static-server-functions

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-static-server-functions@5964

@tanstack/start-storage-context

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-storage-context@5964

@tanstack/valibot-adapter

npm i https://pkg.pr.new/TanStack/router/@tanstack/valibot-adapter@5964

@tanstack/virtual-file-routes

npm i https://pkg.pr.new/TanStack/router/@tanstack/virtual-file-routes@5964

@tanstack/zod-adapter

npm i https://pkg.pr.new/TanStack/router/@tanstack/zod-adapter@5964

commit: fba306f