fix: tell router that rendering finished when rendering to string #5174
main fromrefs/pull/5174/head·merged by schiller-manuel(GitHub profile, opens in a new tab) fixes #5155
Summary by CodeRabbit#
Bug Fixes
- Improved server-side rendering stability by correctly finalizing the initial render before injecting additional HTML, preventing rare hangs or incomplete pages.
- Applies to both React and Solid router SSR paths.
Performance
- Slightly reduces SSR latency by signaling render completion earlier in the pipeline.
- 1
github-actions[bot](GitHub profile, opens in a new tab) added labelspackage: react-router
github-actions[bot](GitHub profile, opens in a new tab) added labelspackage: solid-router
View your CI Pipeline Execution ↗ for commit 0f5c6b6e4c76f3a63f5a107025323adbadd84e81
Command Status Duration Result nx affected --targets=test:eslint,test:unit,tes...✅ Succeeded 4m 25s View ↗ nx run-many --target=build --exclude=examples/*...✅ Succeeded 1m 31s View ↗
☁️ Nx Cloud last updated this comment at
2025-09-19 23:22:52UTCMore templates
- tanstack-router-solid-example-basic
- 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-streaming-file-based
- tanstack-router-solid-example-kitchen-sink-file-based
- tanstack-router-solid-example-quickstart-file-based
- tanstack-solid-start-example-bare
- tanstack-solid-start-example-basic
- tanstack-solid-start-example-basic-static
- 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-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-start-example-basic-react-query
- tanstack-start-example-basic-rsc
- tanstack-start-example-basic-static
- tanstack-start-example-clerk-basic
- tanstack-start-example-convex-trellaux
- tanstack-start-example-counter
- tanstack-start-example-large
- tanstack-start-example-material-ui
- 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/arktype-adapter
npm i https://pkg.pr.new/TanStack/router/@tanstack/arktype-adapter@5174@tanstack/directive-functions-plugin
npm i https://pkg.pr.new/TanStack/router/@tanstack/directive-functions-plugin@5174@tanstack/eslint-plugin-router
npm i https://pkg.pr.new/TanStack/router/@tanstack/eslint-plugin-router@5174@tanstack/history
npm i https://pkg.pr.new/TanStack/router/@tanstack/history@5174@tanstack/react-router
npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router@5174@tanstack/react-router-devtools
npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router-devtools@5174@tanstack/react-router-ssr-query
npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router-ssr-query@5174@tanstack/react-start
npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start@5174@tanstack/react-start-client
npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-client@5174@tanstack/react-start-plugin
npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-plugin@5174@tanstack/react-start-server
npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-server@5174@tanstack/router-cli
npm i https://pkg.pr.new/TanStack/router/@tanstack/router-cli@5174@tanstack/router-core
npm i https://pkg.pr.new/TanStack/router/@tanstack/router-core@5174@tanstack/router-devtools
npm i https://pkg.pr.new/TanStack/router/@tanstack/router-devtools@5174@tanstack/router-devtools-core
npm i https://pkg.pr.new/TanStack/router/@tanstack/router-devtools-core@5174@tanstack/router-generator
npm i https://pkg.pr.new/TanStack/router/@tanstack/router-generator@5174@tanstack/router-plugin
npm i https://pkg.pr.new/TanStack/router/@tanstack/router-plugin@5174@tanstack/router-ssr-query-core
npm i https://pkg.pr.new/TanStack/router/@tanstack/router-ssr-query-core@5174@tanstack/router-utils
npm i https://pkg.pr.new/TanStack/router/@tanstack/router-utils@5174@tanstack/router-vite-plugin
npm i https://pkg.pr.new/TanStack/router/@tanstack/router-vite-plugin@5174@tanstack/server-functions-plugin
npm i https://pkg.pr.new/TanStack/router/@tanstack/server-functions-plugin@5174@tanstack/solid-router
npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-router@5174@tanstack/solid-router-devtools
npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-router-devtools@5174@tanstack/solid-start
npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start@5174@tanstack/solid-start-client
npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-client@5174@tanstack/solid-start-plugin
npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-plugin@5174@tanstack/solid-start-server
npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-server@5174@tanstack/start-client-core
npm i https://pkg.pr.new/TanStack/router/@tanstack/start-client-core@5174@tanstack/start-plugin-core
npm i https://pkg.pr.new/TanStack/router/@tanstack/start-plugin-core@5174@tanstack/start-server-core
npm i https://pkg.pr.new/TanStack/router/@tanstack/start-server-core@5174@tanstack/start-server-functions-client
npm i https://pkg.pr.new/TanStack/router/@tanstack/start-server-functions-client@5174@tanstack/start-server-functions-fetcher
npm i https://pkg.pr.new/TanStack/router/@tanstack/start-server-functions-fetcher@5174@tanstack/start-server-functions-server
npm i https://pkg.pr.new/TanStack/router/@tanstack/start-server-functions-server@5174@tanstack/start-storage-context
npm i https://pkg.pr.new/TanStack/router/@tanstack/start-storage-context@5174@tanstack/valibot-adapter
npm i https://pkg.pr.new/TanStack/router/@tanstack/valibot-adapter@5174@tanstack/virtual-file-routes
npm i https://pkg.pr.new/TanStack/router/@tanstack/virtual-file-routes@5174@tanstack/zod-adapter
npm i https://pkg.pr.new/TanStack/router/@tanstack/zod-adapter@5174commit:
0f5c6b6Actionable comments posted: 0
🧹 Nitpick comments (2)
packages/solid-router/src/ssr/renderRouterToString.tsx (1)
17-19: Add a bounded wait to prevent future indefinite hangsRecommend guarding Promise.all with a timeout so a misbehaving injector can't stall SSR forever.
Apply this minimal change:
- const injectedHtml = await Promise.all(router.serverSsr!.injectedHtml).then( - (htmls) => htmls.join(''), - ) + const timeoutMs = 15000 + const injectedHtml = await Promise.race<string>([ + Promise.all(router.serverSsr!.injectedHtml).then((htmls) => htmls.join('')), + new Promise<string>((resolve) => + setTimeout(() => resolve('<!-- ssr injectedHtml timed out -->'), timeoutMs), + ), + ])If you prefer not to hardcode a timeout, expose it via router/serverSsr options and default here.
packages/react-router/src/ssr/renderRouterToString.tsx (1)
17-19: Defensive timeout around injectedHtml awaitMirror the bounded wait to avoid indefinite stalls if an injector never resolves.
- const injectedHtml = await Promise.all(router.serverSsr!.injectedHtml).then( - (htmls) => htmls.join(''), - ) + const timeoutMs = 15000 + const injectedHtml = await Promise.race<string>([ + Promise.all(router.serverSsr!.injectedHtml).then((htmls) => htmls.join('')), + new Promise<string>((resolve) => + setTimeout(() => resolve('<!-- ssr injectedHtml timed out -->'), timeoutMs), + ), + ])📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📥 Commits
Reviewing files that changed from the base of the PR and between f5872dfef7dcb243a7ad61578b5a51d820db26c8 and 0f5c6b6e4c76f3a63f5a107025323adbadd84e81.
📒 Files selected for processing (2)
packages/react-router/src/ssr/renderRouterToString.tsx(1 hunks)packages/solid-router/src/ssr/renderRouterToString.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). (2)
- GitHub Check: Test
- GitHub Check: Preview
🔇 Additional comments (3)
packages/solid-router/src/ssr/renderRouterToString.tsx (1)
16-16: LGTM: correct placement of setRenderFinished()Calling setRenderFinished() right after renderToString unblocks SSR consumers and addresses the hanging behavior.
Please confirm that after setRenderFinished(), serverSsr.injectedHtml is no longer appended to (or that the API guarantees a finalized list). If it can still grow, Promise.all on a pre‑iteration snapshot might miss late entries.
packages/react-router/src/ssr/renderRouterToString.tsx (2)
16-16: LGTM: render completion signal fixes SSR hangSame rationale as Solid: signaling completion before awaiting injections is the right lifecycle point.
As above, please confirm injectedHtml is finalized after setRenderFinished() so Promise.all can’t miss late pushes.
5-13: Resolved — setRenderFinished already invoked for string and stream SSR pathsrenderRouterToString (react/solid) calls router.serverSsr!.setRenderFinished; streaming paths rely on router-core transforms which call setRenderFinished (packages/router-core/src/ssr/transformStreamWithRouter.ts).
Sign in to join this conversation.
Walkthrough#
Adds a call to router.serverSsr!.setRenderFinished() immediately after the initial renderToString in both React and Solid SSR renderRouterToString implementations, before awaiting injectedHtml. No other logic or signatures are changed.
Changes#
packages/react-router/src/ssr/renderRouterToString.tsx,packages/solid-router/src/ssr/renderRouterToString.tsxrouter.serverSsr!.setRenderFinished()before awaitingrouter.serverSsr!.injectedHtml; rest of SSR flow and error handling unchanged.Sequence Diagram(s)#
Estimated code review effort#
🎯 2 (Simple) | ⏱️ ~10 minutes
Poem#
Pre-merge checks and finishing touches#
✅ Passed checks (5 passed)
✨ Finishing touches
🧪 Generate unit tests
Comment `@coderabbitai help` to get the list of available commands and usage tips.