Open History to see the last commit
1import { PassThrough, Readable } from 'node:stream'
2import ReactDOMServer from 'react-dom/server'
3import { isbot } from 'isbot'
4import {
5 createSsrStreamResponse,
6 getSsrStatus,
7 transformReadableStreamWithRouter,
8 waitForRequest,
9} from '@tanstack/router-core/ssr/server'
10import type { AnyRouter } from '@tanstack/router-core'
11import type { ReactNode } from 'react'
12β
13export const renderRouterToStream = async ({
14 request,
15 router,
16 responseHeaders,
17 children,
18}: {
19 request: Request
20 router: AnyRouter
21 responseHeaders: Headers
22 children: ReactNode
23}) => {
24 const signal = request.signal
25 if (signal.aborted) {
26 router.serverSsr?.cleanup()
27 throw signal.reason
28 }
29 let rendererTeardown = false
30 const bot = isbot(request.headers.get('User-Agent'))
31 const onError =
32 (
33 renderer: string,
34 ): ReactDOMServer.RenderToPipeableStreamOptions['onError'] =>
35 (error, info) => {
36 if (!rendererTeardown && !signal.aborted) {
37 console.error(`Error in ${renderer}:`, error, info)
38 }
39 }
40β
41 try {
42 if (typeof ReactDOMServer.renderToReadableStream === 'function') {
43 const stream = await ReactDOMServer.renderToReadableStream(children, {
44 signal,
45 nonce: router.options.ssr?.nonce,
46 progressiveChunkSize: Number.POSITIVE_INFINITY,
47 onError: onError('renderToReadableStream'),
48 })
49 // The transform owns the reader and bounds bot readiness by its lifetime.
50 const rendererAbort = bot ? new AbortController() : undefined
51 const responseStream = transformReadableStreamWithRouter(router, stream, {
52 rendererSafePoint: 'script-close',
53 signal,
54 onAbort: (reason) => {
55 rendererTeardown = true
56 rendererAbort?.abort(reason)
57 },
58 })
59 if (rendererAbort) {
60 await waitForRequest(stream.allReady, rendererAbort.signal)
61 }
62 return createSsrStreamResponse(
63 router,
64 new Response(responseStream, {
65 status: getSsrStatus(router),
66 headers: responseHeaders,
67 }),
68 )
69 }
70β
71 if (typeof ReactDOMServer.renderToPipeableStream === 'function') {
72 const reactAppPassthrough = new PassThrough()
73 let pipeable:
74 | ReturnType<typeof ReactDOMServer.renderToPipeableStream>
75 | undefined
76 let resolveReady!: () => void
77 const ready = new Promise<void>((resolve) => {
78 resolveReady = resolve
79 })
80 const rendererAbort = new AbortController()
81 const abortPipeable = (reason?: unknown) => {
82 if (rendererTeardown) {
83 return
84 }
85 rendererTeardown = true
86 rendererAbort.abort(reason)
87 try {
88 pipeable?.abort(reason)
89 } catch {
90 // ignore β React may throw if already aborted/finished
91 }
92 }
93 try {
94 pipeable = ReactDOMServer.renderToPipeableStream(children, {
95 nonce: router.options.ssr?.nonce,
96 progressiveChunkSize: Number.POSITIVE_INFINITY,
97 ...(bot
98 ? { onAllReady: resolveReady }
99 : { onShellReady: resolveReady }),
100 onError: onError('renderToPipeableStream'),
101 onShellError: (error) => rendererAbort.abort(error),
102 })
103 const responseStream = transformReadableStreamWithRouter(
104 router,
105 Readable.toWeb(reactAppPassthrough),
106 {
107 rendererSafePoint: 'script-close',
108 signal,
109 onAbort: abortPipeable,
110 },
111 )
112β
113 await waitForRequest(ready, rendererAbort.signal)
114 pipeable.pipe(reactAppPassthrough)
115β
116 return createSsrStreamResponse(
117 router,
118 new Response(responseStream, {
119 status: getSsrStatus(router),
120 headers: responseHeaders,
121 }),
122 )
123 } catch (error) {
124 abortPipeable(error)
125 throw error
126 }
127 }
128β
129 throw new Error(
130 'No renderToReadableStream or renderToPipeableStream found in react-dom/server. Ensure you are using a version of react-dom that supports streaming.',
131 )
132 } catch (error) {
133 router.serverSsr?.cleanup()
134 throw error
135 }
136}