-
-
Notifications
You must be signed in to change notification settings - Fork 445
/
context.ts
407 lines (359 loc) · 10.7 KB
/
context.ts
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
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
import type { HonoRequest } from './request.ts'
import { FetchEventLike } from './types.ts'
import type { Env, NotFoundHandler, Input, TypedResponse } from './types.ts'
import type { CookieOptions } from './utils/cookie.ts'
import { serialize } from './utils/cookie.ts'
import type { StatusCode } from './utils/http-status.ts'
import type { JSONValue, InterfaceToType } from './utils/types.ts'
type Runtime = 'node' | 'deno' | 'bun' | 'workerd' | 'fastly' | 'edge-light' | 'lagon' | 'other'
type HeaderRecord = Record<string, string | string[]>
type Data = string | ArrayBuffer | ReadableStream
export interface ExecutionContext {
waitUntil(promise: Promise<unknown>): void
passThroughOnException(): void
}
export interface ContextVariableMap {}
interface Get<E extends Env> {
<Key extends keyof ContextVariableMap>(key: Key): ContextVariableMap[Key]
<Key extends keyof E['Variables']>(key: Key): E['Variables'][Key]
}
interface Set<E extends Env> {
<Key extends keyof ContextVariableMap>(key: Key, value: ContextVariableMap[Key]): void
<Key extends keyof E['Variables']>(key: Key, value: E['Variables'][Key]): void
}
interface NewResponse {
(data: Data | null, status?: StatusCode, headers?: HeaderRecord): Response
(data: Data | null, init?: ResponseInit): Response
}
interface BodyRespond extends NewResponse {}
interface TextRespond {
(text: string, status?: StatusCode, headers?: HeaderRecord): Response
(text: string, init?: ResponseInit): Response
}
interface JSONRespond {
<T = JSONValue>(object: T, status?: StatusCode, headers?: HeaderRecord): Response
<T = JSONValue>(object: T, init?: ResponseInit): Response
}
interface JSONTRespond {
<T>(
object: InterfaceToType<T> extends JSONValue ? T : JSONValue,
status?: StatusCode,
headers?: HeaderRecord
): TypedResponse<
InterfaceToType<T> extends JSONValue
? JSONValue extends InterfaceToType<T>
? never
: T
: never
>
<T>(
object: InterfaceToType<T> extends JSONValue ? T : JSONValue,
init?: ResponseInit
): TypedResponse<
InterfaceToType<T> extends JSONValue
? JSONValue extends InterfaceToType<T>
? never
: T
: never
>
}
interface HTMLRespond {
(html: string, status?: StatusCode, headers?: HeaderRecord): Response
(html: string, init?: ResponseInit): Response
}
type ContextOptions<E extends Env> = {
env: E['Bindings']
executionCtx?: FetchEventLike | ExecutionContext | undefined
notFoundHandler?: NotFoundHandler<E>
}
export class Context<
// eslint-disable-next-line @typescript-eslint/no-explicit-any
E extends Env = any,
// eslint-disable-next-line @typescript-eslint/no-explicit-any
P extends string = any,
I extends Input = {}
> {
req: HonoRequest<P, I['out']>
env: E['Bindings'] = {}
finalized: boolean = false
error: Error | undefined = undefined
private _status: StatusCode = 200
private _exCtx: FetchEventLike | ExecutionContext | undefined // _executionCtx
private _map: Record<string, unknown> | undefined
private _h: Headers | undefined = undefined // _headers
private _pH: Record<string, string> | undefined = undefined // _preparedHeaders
private _res: Response | undefined
private _init = true
private notFoundHandler: NotFoundHandler<E> = () => new Response()
constructor(req: HonoRequest<P, I['out']>, options?: ContextOptions<E>) {
this.req = req
if (options) {
this._exCtx = options.executionCtx
this.env = options.env
if (options.notFoundHandler) {
this.notFoundHandler = options.notFoundHandler
}
}
}
get event(): FetchEventLike {
if (this._exCtx instanceof FetchEventLike) {
return this._exCtx
} else {
throw Error('This context has no FetchEvent')
}
}
get executionCtx(): ExecutionContext {
if (this._exCtx) {
return this._exCtx as ExecutionContext
} else {
throw Error('This context has no ExecutionContext')
}
}
get res(): Response {
this._init = false
return (this._res ||= new Response('404 Not Found', { status: 404 }))
}
set res(_res: Response | undefined) {
this._init = false
if (this._res && _res) {
this._res.headers.delete('content-type')
this._res.headers.forEach((v, k) => {
_res.headers.set(k, v)
})
}
this._res = _res
this.finalized = true
}
header = (name: string, value: string | undefined, options?: { append?: boolean }): void => {
// Clear the header
if (value === undefined) {
if (this._h) {
this._h.delete(name)
} else if (this._pH) {
delete this._pH[name.toLocaleLowerCase()]
}
if (this.finalized) {
this.res.headers.delete(name)
}
return
}
if (options?.append) {
if (!this._h) {
this._init = false
this._h = new Headers(this._pH)
this._pH = {}
}
this._h.append(name, value)
} else {
if (this._h) {
this._h.set(name, value)
} else {
this._pH ??= {}
this._pH[name.toLowerCase()] = value
}
}
if (this.finalized) {
if (options?.append) {
this.res.headers.append(name, value)
} else {
this.res.headers.set(name, value)
}
}
}
status = (status: StatusCode): void => {
this._status = status
}
set: Set<E> = (key: string, value: unknown) => {
this._map ||= {}
this._map[key as string] = value
}
get: Get<E> = (key: string) => {
return this._map ? this._map[key] : undefined
}
newResponse: NewResponse = (
data: Data | null,
arg?: StatusCode | ResponseInit,
headers?: HeaderRecord
): Response => {
// Optimized
if (this._init && !headers && !arg && this._status === 200) {
return new Response(data, {
headers: this._pH,
})
}
// Return Response immediately if arg is ResponseInit.
if (arg && typeof arg !== 'number') {
const res = new Response(data, arg)
const contentType = this._pH?.['content-type']
if (contentType) {
res.headers.set('content-type', contentType)
}
return res
}
const status = arg ?? this._status
this._pH ??= {}
this._h ??= new Headers()
for (const [k, v] of Object.entries(this._pH)) {
this._h.set(k, v)
}
if (this._res) {
this._res.headers.forEach((v, k) => {
this._h?.set(k, v)
})
for (const [k, v] of Object.entries(this._pH)) {
this._h.set(k, v)
}
}
headers ??= {}
for (const [k, v] of Object.entries(headers)) {
if (typeof v === 'string') {
this._h.set(k, v)
} else {
this._h.delete(k)
for (const v2 of v) {
this._h.append(k, v2)
}
}
}
return new Response(data, {
status,
headers: this._h,
})
}
body: BodyRespond = (
data: Data | null,
arg?: StatusCode | ResponseInit,
headers?: HeaderRecord
): Response => {
return typeof arg === 'number'
? this.newResponse(data, arg, headers)
: this.newResponse(data, arg)
}
text: TextRespond = (
text: string,
arg?: StatusCode | ResponseInit,
headers?: HeaderRecord
): Response => {
// If the header is empty, return Response immediately.
// Content-Type will be added automatically as `text/plain`.
if (!this._pH) {
if (this._init && !headers && !arg) {
return new Response(text)
}
this._pH = {}
}
// If Content-Type is not set, we don't have to set `text/plain`.
// Fewer the header values, it will be faster.
if (this._pH['content-type']) {
this._pH['content-type'] = 'text/plain; charset=UTF-8'
}
return typeof arg === 'number'
? this.newResponse(text, arg, headers)
: this.newResponse(text, arg)
}
json: JSONRespond = <T = {}>(
object: T,
arg?: StatusCode | ResponseInit,
headers?: HeaderRecord
) => {
const body = JSON.stringify(object)
this._pH ??= {}
this._pH['content-type'] = 'application/json; charset=UTF-8'
return typeof arg === 'number'
? this.newResponse(body, arg, headers)
: this.newResponse(body, arg)
}
jsonT: JSONTRespond = <T>(
object: InterfaceToType<T> extends JSONValue ? T : JSONValue,
arg?: StatusCode | ResponseInit,
headers?: HeaderRecord
): TypedResponse<
InterfaceToType<T> extends JSONValue
? JSONValue extends InterfaceToType<T>
? never
: T
: never
> => {
return {
response: typeof arg === 'number' ? this.json(object, arg, headers) : this.json(object, arg),
// eslint-disable-next-line @typescript-eslint/no-explicit-any
data: object as any,
format: 'json',
}
}
html: HTMLRespond = (
html: string,
arg?: StatusCode | ResponseInit,
headers?: HeaderRecord
): Response => {
this._pH ??= {}
this._pH['content-type'] = 'text/html; charset=UTF-8'
return typeof arg === 'number'
? this.newResponse(html, arg, headers)
: this.newResponse(html, arg)
}
redirect = (location: string, status: StatusCode = 302): Response => {
this._h ??= new Headers()
this._h.set('Location', location)
return this.newResponse(null, status)
}
/** @deprecated
* Use Cookie Middleware instead of `c.cookie()`. The `c.cookie()` will be removed in v4.
*
* @example
*
* import { setCookie } from 'hono/cookie'
* // ...
* app.get('/', (c) => {
* setCookie(c, 'key', 'value')
* //...
* })
*/
cookie = (name: string, value: string, opt?: CookieOptions): void => {
const cookie = serialize(name, value, opt)
this.header('set-cookie', cookie, { append: true })
}
notFound = (): Response | Promise<Response> => {
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-ignore
return this.notFoundHandler(this)
}
/** @deprecated
* Use `getRuntimeKey()` exported from `hono/adapter` instead of `c.runtime()`. The `c.runtime()` will be removed in v4.
*
* @example
*
* import { getRuntimeKey } from 'hono/adapter'
* // ...
* app.get('/', (c) => {
* const key = getRuntimeKey()
* //...
* })
*/
get runtime(): Runtime {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
const global = globalThis as any
if (global?.Deno !== undefined) {
return 'deno'
}
if (global?.Bun !== undefined) {
return 'bun'
}
if (typeof global?.WebSocketPair === 'function') {
return 'workerd'
}
if (typeof global?.EdgeRuntime === 'string') {
return 'edge-light'
}
if (global?.fastly !== undefined) {
return 'fastly'
}
if (global?.__lagon__ !== undefined) {
return 'lagon'
}
if (global?.process?.release?.name === 'node') {
return 'node'
}
return 'other'
}
}