-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathfetch.ts
More file actions
317 lines (275 loc) · 9 KB
/
Copy pathfetch.ts
File metadata and controls
317 lines (275 loc) · 9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
import {
joinBasename,
type AppDefinition,
type RouteDefinition,
} from "./index.ts"
import type { OctaneDocuments } from "./octane.tsx"
import type { DocumentMode, RenderedDocument } from "./server.ts"
import {
isRouteFragmentRequest,
stripFlamefrontProtocolRequest,
} from "./fragment-protocol.ts"
import type { RouteFragmentArtifact } from "./fragment-client.ts"
import { isSameOriginActionRequest } from "./action.ts"
export interface TemplateContext<
Route extends RouteDefinition = RouteDefinition,
> {
readonly request: Request
readonly route: Route | null
readonly mode: DocumentMode
}
export type TemplateLoader<Route extends RouteDefinition = RouteDefinition> = (
context: TemplateContext<Route>,
) => string | Promise<string>
export interface StaticFragmentContext<
Route extends RouteDefinition = RouteDefinition,
> {
readonly request: Request
readonly route: Route
}
/** Load a pre-rendered static fragment from the host's asset system. */
export type StaticFragmentLoader<
Route extends RouteDefinition = RouteDefinition,
> = (
context: StaticFragmentContext<Route>,
) =>
RouteFragmentArtifact | undefined | Promise<RouteFragmentArtifact | undefined>
export interface ResponseHeadersContext<
Route extends RouteDefinition = RouteDefinition,
> {
readonly request: Request
readonly route: Route | null
readonly mode: DocumentMode
readonly document: RenderedDocument
}
export type ResponseHeaders = HeadersInit
/** Add or override response headers after document rendering. */
export type ResponseHeadersHook<
Route extends RouteDefinition = RouteDefinition,
> = (
context: ResponseHeadersContext<Route>,
) => ResponseHeaders | Promise<ResponseHeaders>
export type FetchMiddleware = (
request: Request,
next: () => Response | Promise<Response>,
) => Response | Promise<Response>
export type ServerDocuments = Pick<
OctaneDocuments,
"renderDocument" | "loadRouteData"
> &
Partial<Pick<OctaneDocuments, "renderFragment" | "loadAction">>
/** Lifecycle operations shared by all Flamefront server adapters. */
export interface ServerEntryLifecycle {
readonly renderDocument: OctaneDocuments["renderDocument"]
readonly loadRouteData: OctaneDocuments["loadRouteData"]
readonly loadAction?: OctaneDocuments["loadAction"]
readonly renderFragment?: OctaneDocuments["renderFragment"]
}
/** A Web Fetch-compatible server entry. */
export interface FlamefrontFetchServerEntry extends ServerEntryLifecycle {
readonly fetch: (request: Request) => Response | Promise<Response>
}
export interface FetchServerAssets<
Route extends RouteDefinition = RouteDefinition,
> {
readonly loadTemplate: TemplateLoader<Route>
readonly loadStaticFragment?: StaticFragmentLoader<Route>
}
export interface FetchServerEntryOptions<
Route extends RouteDefinition = RouteDefinition,
> {
readonly app: AppDefinition<Route>
readonly documents: ServerDocuments
readonly assets: FetchServerAssets<Route>
/** Applied outermost first, in declaration order. */
readonly middleware?: readonly FetchMiddleware[]
readonly headers?: ResponseHeadersHook<Route>
}
function mergeHeaders(target: Headers, source: HeadersInit | undefined): void {
if (source === undefined) {
return
}
for (const [name, value] of new Headers(source)) {
target.set(name, value)
}
}
function composeMiddleware(
middleware: readonly FetchMiddleware[],
handler: (request: Request) => Promise<Response>,
): (request: Request) => Promise<Response> {
return middleware.reduceRight<(request: Request) => Promise<Response>>(
(next, current) => async (request) => current(request, () => next(request)),
handler,
)
}
/**
* Create the transport-neutral Flamefront request handler. Hosts can expose
* the returned `fetch` function directly or wrap it in their own adapter.
*/
export function createFetchServerEntry<
Route extends RouteDefinition = RouteDefinition,
>(options: FetchServerEntryOptions<Route>): FlamefrontFetchServerEntry {
const defaultClientRoute = options.app.routes.find(
(route) => route.render === "client",
)
const handleRequest = async (request: Request): Promise<Response> => {
const url = new URL(request.url)
const match = options.app.match(url)
try {
const actionRequest =
url.searchParams.has("action") ||
url.searchParams.has("__flamefront_action") ||
(match !== null && !["GET", "HEAD", "OPTIONS"].includes(request.method))
if (actionRequest && !isSameOriginActionRequest(request)) {
return new Response("Forbidden.", { status: 403 })
}
if (
url.pathname === options.app.routing.basename &&
!match &&
defaultClientRoute
) {
return new Response(null, {
status: 302,
headers: {
Location: joinBasename(
options.app.routing.basename,
defaultClientRoute.path,
),
},
})
}
if (
url.searchParams.has("action") ||
url.searchParams.has("__flamefront_action")
) {
if (!options.documents.loadAction) {
return new Response("Actions are not configured.", { status: 404 })
}
return options.documents.loadAction(request)
}
if (
!["GET", "HEAD", "OPTIONS"].includes(request.method) &&
match?.data.render === "static"
) {
return options.documents.loadAction
? options.documents.loadAction(request)
: new Response(
"Static routes cannot define actions; submit to a server route instead.",
{ status: 405 },
)
}
if (url.pathname === options.app.routing.dataPath) {
return options.documents.loadRouteData(request)
}
if (isRouteFragmentRequest(url)) {
const sanitizedRequest = stripFlamefrontProtocolRequest(request)
const fragmentMatch = options.app.match(sanitizedRequest.url)
if (!fragmentMatch || fragmentMatch.data.render === "client") {
return new Response("Not found", { status: 404 })
}
let artifact: RouteFragmentArtifact | undefined
if (
fragmentMatch.data.render === "static" &&
options.assets.loadStaticFragment
) {
artifact = await options.assets.loadStaticFragment({
request: sanitizedRequest,
route: fragmentMatch.data,
})
}
if (!artifact && options.documents.renderFragment) {
artifact = await options.documents.renderFragment(sanitizedRequest)
}
if (!artifact) {
return new Response("Not found", { status: 404 })
}
const responseHeaders = new Headers({
"Content-Type":
"application/vnd.flamefront.fragment+json; charset=utf-8",
})
if (options.headers) {
mergeHeaders(
responseHeaders,
await options.headers({
request: sanitizedRequest,
route: fragmentMatch.data,
mode: fragmentMatch.data.render,
document: {
html: artifact.html,
routeData: artifact.routeData,
status: artifact.status,
},
}),
)
}
return new Response(JSON.stringify(artifact), {
status: artifact.status ?? 200,
headers: responseHeaders,
})
}
if (!match) {
return new Response("Not found", { status: 404 })
}
const mode: DocumentMode = url.searchParams.has("__flamefront_shell")
? "shell"
: match.data.render
const template = await options.assets.loadTemplate({
request,
route: match.data,
mode,
})
const document = await options.documents.renderDocument(
template,
request,
{ mode },
)
const responseHeaders = new Headers({
"Content-Type": "text/html; charset=utf-8",
})
mergeHeaders(responseHeaders, document.headers)
if (options.headers) {
mergeHeaders(
responseHeaders,
await options.headers({
request,
route: match.data,
mode,
document,
}),
)
}
return new Response(document.html, {
status: document.status ?? 200,
headers: responseHeaders,
})
} catch (error) {
if (error instanceof Response) {
return error
}
throw error
}
}
const composedFetch = composeMiddleware(
options.middleware ?? [],
handleRequest,
)
const fetch = async (request: Request): Promise<Response> => {
try {
return await composedFetch(request)
} catch (error) {
if (error instanceof Response) {
return error
}
throw error
}
}
return {
fetch,
renderDocument: options.documents.renderDocument,
loadRouteData: options.documents.loadRouteData,
...(options.documents.loadAction
? { loadAction: options.documents.loadAction }
: {}),
renderFragment: options.documents.renderFragment,
}
}