0
0
mirror of https://github.com/honojs/hono.git synced 2024-11-29 17:46:30 +01:00
hono/deno_dist/context.ts

320 lines
8.8 KiB
TypeScript
Raw Normal View History

import { HonoRequest } from './request.ts'
import type { TypeResponse } from './types.ts'
import type { Env, NotFoundHandler, Input } from './types.ts'
2022-07-10 17:17:29 +02:00
import type { CookieOptions } from './utils/cookie.ts'
import { serialize } from './utils/cookie.ts'
2022-07-02 08:09:45 +02:00
import type { StatusCode } from './utils/http-status.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<void>): void
passThroughOnException(): void
}
export interface ContextVariableMap {}
2022-07-02 08:09:45 +02:00
type GetVariable<K, E extends Env> = K extends keyof E['Variables']
? E['Variables'][K]
: K extends keyof ContextVariableMap
? ContextVariableMap[K]
: unknown
type ContextOptions<E extends Env> = {
env: E['Bindings']
executionCtx?: FetchEvent | ExecutionContext | undefined
notFoundHandler?: NotFoundHandler<E>
paramData?: Record<string, string>
2023-01-10 13:24:21 +01:00
queryIndex?: number
}
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 = {}
> {
env: E['Bindings'] = {}
finalized: boolean = false
error: Error | undefined = undefined
// eslint-disable-next-line @typescript-eslint/no-explicit-any
private _req?: HonoRequest<any, any>
private _status: StatusCode = 200
2022-07-17 11:11:09 +02:00
private _executionCtx: FetchEvent | ExecutionContext | undefined
2022-07-02 08:09:45 +02:00
private _pretty: boolean = false
private _prettySpace: number = 2
private _map: Record<string, unknown> | undefined
private _headers: Headers | undefined = undefined
private _preparedHeaders: Record<string, string> | undefined = undefined
2022-07-02 08:09:45 +02:00
private _res: Response | undefined
private _paramData?: Record<string, string> | null
2023-01-10 13:24:21 +01:00
private _queryIndex: number | undefined
private rawRequest?: Request | null
private notFoundHandler: NotFoundHandler<E> = () => new Response()
constructor(req: Request, options?: ContextOptions<E>) {
this.rawRequest = req
if (options) {
this._executionCtx = options.executionCtx
this._paramData = options.paramData
this.env = options.env
if (options.notFoundHandler) {
this.notFoundHandler = options.notFoundHandler
}
2023-01-10 13:24:21 +01:00
this._queryIndex = options.queryIndex
}
}
get req(): HonoRequest<P, I> {
if (this._req) {
return this._req
} else {
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
this._req = new HonoRequest(this.rawRequest!, this._paramData!, this._queryIndex)
this.rawRequest = undefined
this._paramData = undefined
return this._req
}
2022-07-17 11:11:09 +02:00
}
get event(): FetchEvent {
if (this._executionCtx instanceof FetchEvent) {
return this._executionCtx
2022-07-02 08:09:45 +02:00
} else {
2022-07-17 11:11:09 +02:00
throw Error('This context has no FetchEvent')
2022-07-02 08:09:45 +02:00
}
2022-07-17 11:11:09 +02:00
}
2022-07-02 08:09:45 +02:00
2022-07-17 11:11:09 +02:00
get executionCtx(): ExecutionContext {
if (this._executionCtx) {
return this._executionCtx as ExecutionContext
2022-07-17 11:11:09 +02:00
} else {
throw Error('This context has no ExecutionContext')
}
2022-07-02 08:09:45 +02:00
}
get res(): Response {
return (this._res ||= new Response('404 Not Found', { status: 404 }))
2022-07-02 08:09:45 +02:00
}
set res(_res: Response) {
if (this._res) {
this._res.headers.delete('content-type')
this._res.headers.forEach((v, k) => {
_res.headers.set(k, v)
})
}
2022-07-02 08:09:45 +02:00
this._res = _res
this.finalized = true
}
header = (name: string, value: string, options?: { append?: boolean }): void => {
if (options?.append) {
if (!this._headers) {
this._headers = new Headers(this._preparedHeaders)
}
this._headers.append(name, value)
} else {
if (this._headers) {
this._headers.set(name, value)
} else {
this._preparedHeaders ??= {}
this._preparedHeaders[name.toLowerCase()] = value
}
}
2022-07-02 08:09:45 +02:00
if (this.finalized) {
if (options?.append) {
this.res.headers.append(name, value)
} else {
this.res.headers.set(name, value)
}
2022-07-02 08:09:45 +02:00
}
}
status = (status: StatusCode): void => {
2022-07-02 08:09:45 +02:00
this._status = status
}
set = <Key extends keyof E['Variables'] | keyof ContextVariableMap>(
key: Key,
value: GetVariable<Key, E>
): void => {
2022-07-02 08:09:45 +02:00
this._map ||= {}
this._map[key as string] = value
2022-07-02 08:09:45 +02:00
}
get = <Key extends keyof E['Variables'] | keyof ContextVariableMap>(
key: Key
): GetVariable<Key, E> => {
return this._map?.[key as string] as GetVariable<Key, E>
2022-07-02 08:09:45 +02:00
}
pretty = (prettyJSON: boolean, space: number = 2): void => {
2022-07-02 08:09:45 +02:00
this._pretty = prettyJSON
this._prettySpace = space
}
newResponse = (data: Data | null, status?: StatusCode, headers?: HeaderRecord): Response => {
// Optimized
if (!headers && !this._headers && !this._res && !status) {
return new Response(data, {
headers: this._preparedHeaders,
})
}
this._preparedHeaders ??= {}
if (!this._headers) {
this._headers = new Headers()
for (const [k, v] of Object.entries(this._preparedHeaders)) {
this._headers.set(k, v)
}
}
if (this._res) {
this._res.headers.forEach((v, k) => {
this._headers?.set(k, v)
})
for (const [k, v] of Object.entries(this._preparedHeaders)) {
this._headers.set(k, v)
}
}
headers ??= {}
for (const [k, v] of Object.entries(headers)) {
if (typeof v === 'string') {
this._headers.set(k, v)
} else {
this._headers.delete(k)
for (const v2 of v) {
this._headers.append(k, v2)
}
}
}
return new Response(data, {
status,
headers: this._headers,
})
}
body = (
data: Data | null,
status: StatusCode = this._status,
headers?: HeaderRecord
): Response => {
return this.newResponse(data, status, headers)
}
text = (text: string, status?: StatusCode, headers?: HeaderRecord): Response => {
// If the header is empty, return Response immediately.
// Content-Type will be added automatically as `text/plain`.
if (!this._preparedHeaders) {
if (!headers && !this._res && !this._headers && !status) {
return new Response(text)
}
this._preparedHeaders = {}
}
// If Content-Type is not set, we don't have to set `text/plain`.
// Fewer the header values, it will be faster.
if (this._preparedHeaders['content-type']) {
this._preparedHeaders['content-type'] = 'text/plain; charset=UTF8'
}
return this.newResponse(text, status, headers)
2022-07-02 08:09:45 +02:00
}
2023-02-01 16:25:58 +01:00
json = <T = object>(
object: T,
status: StatusCode = this._status,
headers?: HeaderRecord
): Response => {
2022-07-02 08:09:45 +02:00
const body = this._pretty
? JSON.stringify(object, null, this._prettySpace)
: JSON.stringify(object)
this._preparedHeaders ??= {}
this._preparedHeaders['content-type'] = 'application/json; charset=UTF-8'
return this.newResponse(body, status, headers)
2022-07-02 08:09:45 +02:00
}
2023-02-01 16:25:58 +01:00
jsonT = <T = object>(
object: T,
status: StatusCode = this._status,
headers?: HeaderRecord
): TypeResponse<T> => {
return {
response: this.json(object, status, headers),
data: object,
format: 'json',
}
}
html = (html: string, status: StatusCode = this._status, headers?: HeaderRecord): Response => {
this._preparedHeaders ??= {}
this._preparedHeaders['content-type'] = 'text/html; charset=UTF-8'
return this.newResponse(html, status, headers)
}
redirect = (location: string, status: StatusCode = 302): Response => {
this._headers ??= new Headers()
this._headers.set('Location', location)
return this.newResponse(null, status)
2022-07-02 08:09:45 +02:00
}
cookie = (name: string, value: string, opt?: CookieOptions): void => {
2022-07-10 17:17:29 +02:00
const cookie = serialize(name, value, opt)
this.header('set-cookie', cookie, { append: true })
2022-07-10 17:17:29 +02:00
}
notFound = (): Response | Promise<Response> => {
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-ignore
return this.notFoundHandler(this)
2022-07-02 08:09:45 +02:00
}
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'
}
2023-01-08 01:05:49 +01:00
let onFastly = false
try {
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-ignore
const { env } = require('fastly:env')
if (env instanceof Function) onFastly = true
} catch {}
if (onFastly) {
return 'fastly'
}
if (global?.__lagon__ !== undefined) {
return 'lagon'
}
2023-01-08 01:05:49 +01:00
if (global?.process?.release?.name === 'node') {
return 'node'
}
return 'other'
}
2022-07-02 08:09:45 +02:00
}