Repository navigation
fix(react-router): avoid Suspense above root documents #8055
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| '@tanstack/react-router': patch | ||
| --- | ||
|
|
||
| Avoid wrapping root components that may render the HTML document in a Suspense boundary during SSR and hydration. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| import { expect } from '@playwright/test' | ||
| import { test } from '@tanstack/router-e2e-utils' | ||
|
|
||
| test('#8053: a root pendingComponent preserves the SSR document during hydration', async ({ | ||
| page, | ||
| }) => { | ||
| await page.addInitScript(() => { | ||
| const state = { removed: false } | ||
| ;(window as any).__issue8053Hydration = state | ||
|
|
||
| new MutationObserver((records) => { | ||
| const ssrNode = (window as any).__issue8053SsrNode as Node | undefined | ||
|
Contributor
There was a problem hiding this comment. 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win Replace
Proposed fix+declare global {
+ interface Window {
+ __issue8053Hydration?: { removed: boolean }
+ __issue8053SsrNode?: Node
+ }
+}
+
- ;(window as any).__issue8053Hydration = state
+ window.__issue8053Hydration = state
...
- const ssrNode = (window as any).__issue8053SsrNode as Node | undefined
+ const ssrNode = window.__issue8053SsrNode
...
- captured: !!(window as any).__issue8053SsrNode,
- removed: (window as any).__issue8053Hydration.removed,
+ captured: !!window.__issue8053SsrNode,
+ removed: window.__issue8053Hydration!.removed,As per coding guidelines: Also applies to: 45-50 🤖 Prompt for AI AgentsSource: Coding guidelines |
||
| if (!ssrNode) { | ||
| return | ||
| } | ||
|
|
||
| for (const record of records) { | ||
| for (const removedNode of record.removedNodes) { | ||
| if ( | ||
| removedNode === ssrNode || | ||
| (removedNode instanceof Element && removedNode.contains(ssrNode)) | ||
| ) { | ||
| state.removed = true | ||
| } | ||
| } | ||
| } | ||
| }).observe(document, { childList: true, subtree: true }) | ||
| }) | ||
|
|
||
| const hydrationErrors: Array<string> = [] | ||
|
Sheraff marked this conversation as resolved.
Resolved
|
||
| page.on('console', (message) => { | ||
| if (message.type() === 'error') { | ||
| hydrationErrors.push(message.text()) | ||
| } | ||
| }) | ||
| page.on('pageerror', (error) => { | ||
| hydrationErrors.push(error.message) | ||
| }) | ||
|
|
||
| const response = await page.goto('/') | ||
| expect(response?.ok()).toBe(true) | ||
| await expect(page.locator('html')).toHaveAttribute('data-hydrated', 'true') | ||
|
|
||
| expect( | ||
| await page.evaluate(() => ({ | ||
| captured: !!(window as any).__issue8053SsrNode, | ||
| removed: (window as any).__issue8053Hydration.removed, | ||
| replaced: | ||
| (window as any).__issue8053SsrNode !== | ||
| document.querySelector('[data-testid="issue-8053-ssr-node"]'), | ||
| })), | ||
| ).toEqual({ | ||
| captured: true, | ||
| removed: false, | ||
| replaced: false, | ||
| }) | ||
| expect( | ||
| hydrationErrors.filter((error) => | ||
| /hydrat|did not match|server rendered HTML/i.test(error), | ||
| ), | ||
| ).toEqual([]) | ||
| }) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| import { expect, test } from 'vitest' | ||
| import { Outlet, createRootRoute, createRoute, createRouter } from '../src' | ||
| import { | ||
| RouterServer, | ||
| createRequestHandler, | ||
| renderRouterToStream, | ||
| } from '../src/ssr/server' | ||
|
|
||
| // https://github.com/TanStack/router/issues/8053 | ||
| test('a root pendingComponent does not wrap the SSR document in Suspense', async () => { | ||
| const rootRoute = createRootRoute({ | ||
| pendingComponent: () => null, | ||
| component: () => ( | ||
| <html> | ||
| <head> | ||
| <title>Root document</title> | ||
| </head> | ||
| <body> | ||
| <Outlet /> | ||
| </body> | ||
| </html> | ||
| ), | ||
| }) | ||
| const indexRoute = createRoute({ | ||
| getParentRoute: () => rootRoute, | ||
| path: '/', | ||
| component: () => <main>Root content</main>, | ||
| }) | ||
| const handler = createRequestHandler({ | ||
| request: new Request('http://localhost/'), | ||
| createRouter: () => | ||
| createRouter({ | ||
| routeTree: rootRoute.addChildren([indexRoute]), | ||
| isServer: true, | ||
| }), | ||
| }) | ||
|
|
||
| const response = await handler(({ request, router, responseHeaders }) => | ||
| renderRouterToStream({ | ||
| request, | ||
| router, | ||
| responseHeaders, | ||
| children: <RouterServer router={router} />, | ||
| }), | ||
| ) | ||
| const html = await response.text() | ||
| const serverDocument = new DOMParser().parseFromString(html, 'text/html') | ||
|
|
||
| expect(response.status).toBe(200) | ||
| expect(serverDocument.body.textContent).toContain('Root content') | ||
| expect(html).not.toContain('<!--html--><!--head--><!--body-->') | ||
| }) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.