Skip to content
Source
Sign inSign up
TanStack/router
Open History to see the last commit

renderRouterToStream.test.tsx

148 lines4.3 KB

1import { afterEach, describe, expect, test, vi } from 'vitest'
2import { attachRouterServerSsrUtils } from '@tanstack/router-core/ssr/server'
3import { createMemoryHistory, createRootRoute, createRouter } from '../src'
4import type * as SolidWeb from 'solid-js/web'
5​
6const solidMocks = vi.hoisted(() => ({
7 renderToStream: vi.fn(),
8 pipeTo: vi.fn(),
9}))
10​
11vi.mock('solid-js/web', async () => {
12 const actual = await vi.importActual<typeof SolidWeb>('solid-js/web')
13 return {
14 ...actual,
15 renderToStream: solidMocks.renderToStream,
16 }
17})
18​
19// Imported after mock so the wrapper picks up the mocked binding.
20const { renderRouterToStream } = await import('../src/ssr/renderRouterToStream')
21​
22function unwrapResponse(
23 result: Awaited<ReturnType<typeof renderRouterToStream>>,
24) {
25 return result.response
27​
28afterEach(() => {
29 solidMocks.renderToStream.mockReset()
30 solidMocks.pipeTo.mockReset()
31 vi.restoreAllMocks()
32})
33​
34async function buildRouter() {
35 const rootRoute = createRootRoute({
36 component: () => null,
37 })
38 const router = createRouter({
39 history: createMemoryHistory({ initialEntries: ['/'] }),
40 routeTree: rootRoute,
41 })
42 router.isServer = true
43 attachRouterServerSsrUtils({ router, manifest: undefined })
44 await router.load()
45 return router
47​
48function drainBody(response: Response) {
49 const reader = response.body!.getReader()
50 return (async () => {
51 for (;;) {
52 const { done } = await reader.read()
53 if (done) return true
54 }
55 })().catch(() => true)
57​
58describe('renderRouterToStream - bot abort', () => {
59 test('request abort during bot wait terminates before rendering starts', async () => {
60 const neverReady = new Promise<void>(() => {})
61 solidMocks.pipeTo.mockImplementationOnce(
62 (writable: WritableStream<Uint8Array>) => {
63 const writer = writable.getWriter()
64 return writer
65 .write(new TextEncoder().encode('<html><body>solid</body></html>'))
66 .catch(() => {})
67 },
68 )
69 solidMocks.renderToStream.mockImplementationOnce(
70 () =>
71 ({
72 then: neverReady.then.bind(neverReady),
73 pipeTo: solidMocks.pipeTo,
74 }) as any,
75 )
76​
77 const router = await buildRouter()
78 const abortController = new AbortController()
79 const errorSpy = vi.spyOn(console, 'error').mockImplementation(() => {})
80 try {
81 const responsePromise = renderRouterToStream({
82 request: new Request('http://localhost/', {
83 headers: { 'User-Agent': 'Googlebot' },
84 signal: abortController.signal,
85 }),
86 router,
87 responseHeaders: new Headers(),
88 children: () => null,
89 })
90​
91 await Promise.resolve()
92 abortController.abort(new Error('client-gone'))
93​
94 const result = await Promise.race([
95 responsePromise,
96 new Promise<false>((resolve) => setTimeout(() => resolve(false), 2000)),
97 ])
98​
99 expect(result).not.toBe(false)
100 expect(solidMocks.pipeTo).not.toHaveBeenCalled()
101 const response = unwrapResponse(result as Exclude<typeof result, false>)
102 expect(response.body).not.toBeNull()
103​
104 const terminated = await Promise.race([
105 drainBody(response),
106 new Promise<false>((resolve) => setTimeout(() => resolve(false), 2000)),
107 ])
108​
109 expect(terminated).toBe(true)
110 } finally {
111 errorSpy.mockRestore()
112 router.serverSsr?.cleanup()
113 }
114 })
115​
116 test('pipeTo rejection aborts writer and terminates response stream', async () => {
117 solidMocks.renderToStream.mockImplementationOnce(
118 () =>
119 ({
120 pipeTo: () => Promise.reject(new Error('solid-pipe-failed')),
121 }) as any,
122 )
123​
124 const router = await buildRouter()
125 const errorSpy = vi.spyOn(console, 'error').mockImplementation(() => {})
126 try {
127 const response = unwrapResponse(
128 await renderRouterToStream({
129 request: new Request('http://localhost/'),
130 router,
131 responseHeaders: new Headers(),
132 children: () => null,
133 }),
134 )
135​
136 const terminated = await Promise.race([
137 drainBody(response),
138 new Promise<false>((resolve) => setTimeout(() => resolve(false), 2000)),
139 ])
140​
141 expect(terminated).toBe(true)
142 expect(errorSpy).toHaveBeenCalled()
143 } finally {
144 errorSpy.mockRestore()
145 router.serverSsr?.cleanup()
146 }
147 })
148})