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

createRequestHandler.ts

129 lines3.6 KB

1import { createServerHistory } from '@tanstack/history'
2import { _getRenderedMatches } from '../load-client'
3import { waitForReason as waitForRequest } from '../await-signal'
4import { mergeHeaders } from './headers'
5import {
6 attachRouterServerSsrUtils,
7 getNormalizedURL,
8 getOrigin,
9} from './ssr-server'
10import {
11 bindSsrResponseToRequest,
12 disposeSsrResponse,
13 isSsrResponse,
14} from './handlerCallback'
15import type { HandlerCallback } from './handlerCallback'
16import type { AnyHeaders } from './headers'
17import type { AnyRouter } from '../router'
18import type { ServerManifest } from '../manifest'
19​
20export type RequestHandler<TRouter extends AnyRouter> = (
21 cb: HandlerCallback<TRouter>,
22) => Promise<Response>
23​
24export { waitForRequest }
25​
26function createLateResponseDisposer(signal: AbortSignal) {
27 return (result: unknown) => {
28 if (result instanceof Response || isSsrResponse(result)) {
29 disposeSsrResponse(result, signal.reason)
30 }
31 }
33​
34export function createRequestHandler<TRouter extends AnyRouter>({
35 createRouter,
36 request,
37 getRouterManifest,
38}: {
39 createRouter: () => TRouter
40 request: Request
41 getRouterManifest?: () => ServerManifest | Promise<ServerManifest>
42}): RequestHandler<TRouter> {
43 return async (cb) => {
44 const signal = request.signal
45 signal.throwIfAborted()
46 const manifest = getRouterManifest
47 ? await waitForRequest(getRouterManifest(), signal)
48 : undefined
49 signal.throwIfAborted()
50 const router = createRouter()
51 let responseOwnsCleanup = false
52​
53 try {
54 attachRouterServerSsrUtils({
55 router,
56 manifest,
57 })
58​
59 // normalizing and sanitizing the pathname here for server, so we always deal with the same format during SSR.
60 const { url } = getNormalizedURL(request.url, 'http://localhost')
61 const origin = getOrigin(request)
62 const href = url.href.replace(url.origin, '')
63​
64 // Create a history for the router
65 const history = createServerHistory(href)
66​
67 // Update the router with the history and context
68 router.update({
69 history,
70 origin: router.options.origin ?? origin,
71 })
72​
73 await router.load({
74 _signal: signal,
75 })
76 signal.throwIfAborted()
77​
78 const result = router._serverResult
79 if (result?.type === 'redirect') {
80 return result.redirect
81 }
82​
83 await router.serverSsr?.dehydrate({ signal })
84 signal.throwIfAborted()
85​
86 const responseHeaders = getRequestHeaders({
87 router,
88 })
89​
90 signal.throwIfAborted()
91 const disposeLate = createLateResponseDisposer(signal)
92 const response = await waitForRequest(
93 cb({
94 request,
95 router,
96 responseHeaders,
97 }),
98 signal,
99 disposeLate,
100 disposeLate,
101 )
102 const ssrResponse = bindSsrResponseToRequest(router, response, signal)
103 signal.throwIfAborted()
104 responseOwnsCleanup = ssrResponse.serverSsrCleanup === 'stream'
105 return ssrResponse.response
106 } finally {
107 if (!responseOwnsCleanup) {
108 // Clean up router SSR state if the callback won't handle it
109 // (e.g., if an error occurred before the callback was invoked).
110 // Transformed streaming response bodies clean up when consumed/cancelled.
111 router.serverSsr?.cleanup()
112 }
113 }
114 }
116​
117function getRequestHeaders(opts: { router: AnyRouter }): Headers {
118 const matchHeaders: Array<AnyHeaders> = []
119 for (const match of _getRenderedMatches(opts.router.stores.matches.get())) {
120 matchHeaders.push(match.headers)
121 }
122​
123 return mergeHeaders(
124 {
125 'Content-Type': 'text/html; charset=UTF-8',
126 },
127 ...matchHeaders,
128 )