fix(tanstack-router): remove Suspense gate around RouterProvider during hydration #3213
+148
−59
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
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 | ||||||
|---|---|---|---|---|---|---|---|---|
|
|
@@ -1364,4 +1364,141 @@ describe('tanstack-router integration (Pro)', () => { | |||||||
| }, | ||||||||
| }); | ||||||||
| }); | ||||||||
|
|
||||||||
| it('waits for the matched route chunk preload promise before triggering post-hydration router.load', async () => { | ||||||||
| // Regression test for the Suspense-gate removal: with the gate gone, | ||||||||
| // RouterProvider renders directly during hydration. The chunk-preload | ||||||||
| // behavior must still be preserved by awaiting routeChunkPreloadPromiseRef | ||||||||
| // inside runPostHydrationLoad before calling router.load(); otherwise | ||||||||
| // post-hydration navigation could race ahead of matched lazy chunks. | ||||||||
| const router = buildRouter(); | ||||||||
| const productsRoute = { id: '/products' }; | ||||||||
| let resolveChunk: (() => void) | undefined; | ||||||||
| const loadRouteChunk = jest.fn().mockImplementation( | ||||||||
| () => | ||||||||
| new Promise<void>((resolve) => { | ||||||||
| resolveChunk = resolve; | ||||||||
| }), | ||||||||
| ); | ||||||||
| (router.matchRoutes as jest.Mock).mockReturnValue([ | ||||||||
| { id: '/products', routeId: '/products', status: 'pending', updatedAt: 0, loaderData: undefined }, | ||||||||
| ]); | ||||||||
| router.looseRoutesById = { '/products': productsRoute }; | ||||||||
| router.loadRouteChunk = loadRouteChunk; | ||||||||
| // No user-defined hydrate callback — isolate the chunk-preload await path. | ||||||||
| router.options = {}; | ||||||||
|
Contributor
There was a problem hiding this comment. This silently replaces the entire
Suggested change
|
||||||||
|
|
||||||||
| const renderFn = createTanStackRouterRenderFunction( | ||||||||
| { createRouter: () => router }, | ||||||||
| { | ||||||||
| RouterProvider: (_: { router: TanStackRouter }) => React.createElement('div'), | ||||||||
| createMemoryHistory: jest.fn(), | ||||||||
| createBrowserHistory: jest.fn().mockReturnValue({ | ||||||||
| location: { | ||||||||
| pathname: '/products', | ||||||||
| search: '?category=tools', | ||||||||
| hash: '', | ||||||||
| href: '/products?category=tools', | ||||||||
| state: null, | ||||||||
| }, | ||||||||
| }), | ||||||||
| }, | ||||||||
| ); | ||||||||
| const props = { | ||||||||
| __tanstackRouterDehydratedState: { | ||||||||
| url: '/products?category=tools', | ||||||||
| dehydratedRouter: { matches: [{ id: 'products' }] }, | ||||||||
| }, | ||||||||
| }; | ||||||||
| const clientApp = renderFn(props, { | ||||||||
| serverSide: false, | ||||||||
| pathname: '/products', | ||||||||
| search: '?category=tools', | ||||||||
| } as unknown as RailsContext); | ||||||||
| const container = document.createElement('div'); | ||||||||
| const root = createRoot(container); | ||||||||
|
|
||||||||
| await compatAct(async () => { | ||||||||
| root.render(React.createElement(clientApp as React.ComponentType<Record<string, unknown>>, props)); | ||||||||
| await Promise.resolve(); | ||||||||
| }); | ||||||||
|
|
||||||||
| // Chunk preload kicked off during render-phase init, but the post-hydration | ||||||||
| // load must remain blocked until the preload promise settles. | ||||||||
| expect(loadRouteChunk).toHaveBeenCalledTimes(1); | ||||||||
| expect(loadRouteChunk).toHaveBeenCalledWith(productsRoute); | ||||||||
| expect(router.load).not.toHaveBeenCalled(); | ||||||||
|
|
||||||||
| if (!resolveChunk) { | ||||||||
| throw new Error('Expected loadRouteChunk to be invoked during render-phase init.'); | ||||||||
| } | ||||||||
| const settleChunk = resolveChunk; | ||||||||
|
|
||||||||
| await compatAct(async () => { | ||||||||
| settleChunk(); | ||||||||
| // Use a macrotask boundary so all queued microtasks (the preload | ||||||||
| // promise's .then plus every await hop in runPostHydrationLoad) fully | ||||||||
| // drain before we assert. Counting individual ticks is fragile: | ||||||||
| // adding or removing a single await in runPostHydrationLoad would | ||||||||
| // silently break the assertion below. | ||||||||
| await new Promise((r) => { | ||||||||
| setTimeout(r, 0); | ||||||||
| }); | ||||||||
| }); | ||||||||
|
|
||||||||
| expect(router.load).toHaveBeenCalledTimes(1); | ||||||||
|
|
||||||||
| await compatAct(async () => { | ||||||||
| root.unmount(); | ||||||||
| }); | ||||||||
| }); | ||||||||
|
|
||||||||
| it('renders RouterProvider directly without an enclosing Suspense boundary during hydration', () => { | ||||||||
| // Regression test for the Suspense-gate removal: serverRender.ts's | ||||||||
| // buildAppElement emits AppWrapper > RouterProvider with no Suspense | ||||||||
| // boundary. Any extra Suspense in the client tree produces a shape | ||||||||
| // mismatch and React bails to a full client-side re-render. | ||||||||
| const router = buildRouter(); | ||||||||
| const renderFn = createTanStackRouterRenderFunction( | ||||||||
| { createRouter: () => router }, | ||||||||
| { | ||||||||
| RouterProvider: (_: { router: TanStackRouter }) => | ||||||||
| React.createElement('div', { 'data-testid': 'provider' }), | ||||||||
| createMemoryHistory: jest.fn(), | ||||||||
| createBrowserHistory: jest.fn().mockReturnValue({ | ||||||||
| location: { | ||||||||
| pathname: '/products', | ||||||||
| search: '?category=tools', | ||||||||
| hash: '', | ||||||||
| href: '/products?category=tools', | ||||||||
| state: null, | ||||||||
| }, | ||||||||
| }), | ||||||||
| }, | ||||||||
| ); | ||||||||
| const props = { | ||||||||
| __tanstackRouterDehydratedState: { | ||||||||
| url: '/products?category=tools', | ||||||||
| dehydratedRouter: { matches: [{ id: 'products' }] }, | ||||||||
| ssrRouter: { | ||||||||
| manifest: undefined, | ||||||||
| lastMatchId: '\u0000products', | ||||||||
| matches: [{ i: '\u0000products', l: { products: ['hammer'] }, s: 'success', ssr: true, u: 123 }], | ||||||||
| }, | ||||||||
| }, | ||||||||
| }; | ||||||||
| const Client = renderFn(props, { | ||||||||
| serverSide: false, | ||||||||
| pathname: '/products', | ||||||||
| search: '?category=tools', | ||||||||
| } as unknown as RailsContext) as React.ComponentType<Record<string, unknown>>; | ||||||||
|
|
||||||||
| // The fix's strongest guarantee: the rendered HTML must be exactly the | ||||||||
| // mock RouterProvider's output. With a Suspense wrapper (the bug), | ||||||||
| // react-dom/server emits <!--$-->/<!--/$--> markers around the children | ||||||||
| // even when the boundary does not actually suspend, so this equality | ||||||||
| // assertion catches any wrapping Suspense boundary. | ||||||||
| const html = renderToString(React.createElement(Client, props)); | ||||||||
| expect(html).toBe('<div data-testid="provider"></div>'); | ||||||||
| }); | ||||||||
| }); | ||||||||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This ref is still used correctly — it is populated at line ~231 and awaited in
runPostHydrationLoadbeforerouter.load(). Consider a short inline comment here (or a JSDoc onrunPostHydrationLoad) clarifying that this is the only remaining consumer, so a future reader doesn't assume it is dead code after the gate removal.