0
0
mirror of https://github.com/honojs/hono.git synced 2024-11-29 17:46:30 +01:00
hono/deno_dist/hono.ts
Yusuke Wada 85e3c6a275 feat: new validator middleware using 3rd-party & current middleware obsolete (#745)
* feat: introduce HonoRequest with "wrapper pattern" (#733)

* feat: HonoRequest

* avoid `awaits`

* use `raw` instead of `original`

* feat: types for "RPC" support & build-in validator obsolete

* feat: introduce HonoRequest with "wrapper pattern" (#733)

* feat: HonoRequest

* avoid `awaits`

* use `raw` instead of `original`

* create generic middleare for 3rd-party validator

* indent

* support multiple validators and refactor

* remove unsed lines

* denoify
2023-01-19 22:40:13 +09:00

265 lines
7.5 KiB
TypeScript

import { compose } from './compose.ts'
import { Context } from './context.ts'
import type { ExecutionContext } from './context.ts'
import type { Router } from './router.ts'
import { METHOD_NAME_ALL, METHOD_NAME_ALL_LOWERCASE, METHODS } from './router.ts'
import { RegExpRouter } from './router/reg-exp-router/index.ts'
import { SmartRouter } from './router/smart-router/index.ts'
import { StaticRouter } from './router/static-router/index.ts'
import { TrieRouter } from './router/trie-router/index.ts'
import type { ExtractType, HandlerInterface, GetParamKeys, ToAppType, TypeResponse } from './types.ts'
import type { Handler, Environment, ErrorHandler, NotFoundHandler } from './types.ts'
import { getPathFromURL, mergePath } from './utils/url.ts'
type Methods = typeof METHODS[number] | typeof METHOD_NAME_ALL_LOWERCASE
interface Route {
path: string
method: string
handler: Handler
}
function defineDynamicClass(): {
new <
E extends Partial<Environment> = Partial<Environment>,
P extends string = string,
S = unknown,
T = unknown,
U = Hono<E, P, S, T>
>(): {
[M in Methods]: HandlerInterface<E, M, P, S, T, U>
}
} {
return class {} as never
}
export class Hono<
E extends Partial<Environment> = Partial<Environment>,
P extends string = string,
// eslint-disable-next-line @typescript-eslint/no-explicit-any
S = any, // should be any
T = unknown
> extends defineDynamicClass()<E, P, S, T, Hono<E, P, S, T>> {
readonly router: Router<Handler> = new SmartRouter({
routers: [new StaticRouter(), new RegExpRouter(), new TrieRouter()],
})
readonly strict: boolean = true // strict routing - default is true
private _tempPath: string = ''
private path: string = '/'
routes: Route[] = []
constructor(init: Partial<Pick<Hono, 'router' | 'strict'>> = {}) {
super()
const allMethods = [...METHODS, METHOD_NAME_ALL_LOWERCASE]
allMethods.map((method) => {
this[method] = (args1: string | Handler, ...args: Handler[]) => {
if (typeof args1 === 'string') {
this.path = args1
} else {
this.addRoute(method, this.path, args1)
}
args.map((handler) => {
if (typeof handler !== 'string') {
this.addRoute(method, this.path, handler)
}
})
// eslint-disable-next-line @typescript-eslint/no-explicit-any
return this as Hono<E, any, any, any>
}
})
Object.assign(this, init)
}
private notFoundHandler: NotFoundHandler<E> = (c: Context<E>) => {
return c.text('404 Not Found', 404)
}
private errorHandler: ErrorHandler<E> = (err: Error, c: Context<E>) => {
console.trace(err)
const message = 'Internal Server Error'
return c.text(message, 500)
}
// eslint-disable-next-line @typescript-eslint/no-explicit-any
route(path: string, app?: Hono<any>) {
this._tempPath = path
if (app) {
app.routes.map((r) => {
this.addRoute(r.method, r.path, r.handler)
})
this._tempPath = ''
}
return this
}
use<Env extends Environment>(...middleware: Handler<Env>[]): Hono<E, P, S, T>
use<Env extends Environment>(arg1: string, ...middleware: Handler<Env>[]): Hono<E, P, S, T>
use(arg1: string | Handler<E>, ...handlers: Handler<E>[]) {
if (typeof arg1 === 'string') {
this.path = arg1
} else {
handlers.unshift(arg1)
}
handlers.map((handler) => {
this.addRoute(METHOD_NAME_ALL, this.path, handler)
})
return this
}
on<Env extends Environment, Method extends string, Path extends string, Data = S, Type = unknown>(
method: Method,
path: Path,
...handlers: Handler<Env, Method, GetParamKeys<Path>, Data, Type>[]
): Hono<E, P, Data & S, ExtractType<typeof handlers[-1], Type>>
on<M extends string, P extends string>(
method: M,
path: P,
...handlers: Handler<E, M, P, S, T>[]
) {
if (!method) return this
this.path = path
handlers.map((handler) => {
this.addRoute(method.toUpperCase(), this.path, handler)
})
return this
}
build = (): ToAppType<typeof this> => {
const app = {} as typeof this
type AppType = ToAppType<typeof app>
return {} as AppType
}
onError(handler: ErrorHandler<E>) {
this.errorHandler = handler
return this
}
notFound(handler: NotFoundHandler<E>) {
this.notFoundHandler = handler
return this
}
showRoutes() {
const length = 8
this.routes.map((route) => {
console.log(
`\x1b[32m${route.method}\x1b[0m ${' '.repeat(length - route.method.length)} ${route.path}`
)
})
}
private addRoute(method: string, path: string, handler: Handler) {
method = method.toUpperCase()
if (this._tempPath) {
path = mergePath(this._tempPath, path)
}
this.router.add(method, path, handler)
const r: Route = { path: path, method: method, handler: handler }
this.routes.push(r)
}
private matchRoute(method: string, path: string) {
return this.router.match(method, path)
}
private handleError(err: unknown, c: Context<E>) {
if (err instanceof Error) {
return this.errorHandler(err, c)
}
throw err
}
private dispatch(
request: Request,
eventOrExecutionCtx?: ExecutionContext | FetchEvent,
env?: E['Bindings']
): Response | Promise<Response> {
const path = getPathFromURL(request.url, this.strict)
const method = request.method
const result = this.matchRoute(method, path)
const paramData = result?.params
const c = new Context<E>(request, {
env,
executionCtx: eventOrExecutionCtx,
notFoundHandler: this.notFoundHandler,
paramData,
})
// Do not `compose` if it has only one handler
if (result && result.handlers.length === 1) {
const handler = result.handlers[0]
let res: ReturnType<Handler>
try {
res = handler(c, async () => {})
if (!res) {
return this.notFoundHandler(c)
}
} catch (err) {
return this.handleError(err, c)
}
if ('response' in res) {
res = res.response
}
if (res instanceof Response) {
return res
}
return (async () => {
let awaited: Response | TypeResponse | undefined | void
try {
awaited = await res
if (awaited !== undefined && 'response' in awaited) {
awaited = awaited['response'] as Response
}
if (!awaited) {
return this.notFoundHandler(c)
}
} catch (err) {
return this.handleError(err, c)
}
return awaited
})()
}
const handlers = result ? result.handlers : [this.notFoundHandler]
const composed = compose<Context<E>, E>(handlers, this.notFoundHandler, this.errorHandler)
return (async () => {
try {
const tmp = composed(c)
const context = tmp instanceof Promise ? await tmp : tmp
if (!context.finalized) {
throw new Error(
'Context is not finalized. You may forget returning Response object or `await next()`'
)
}
return context.res
} catch (err) {
return this.handleError(err, c)
}
})()
}
handleEvent = (event: FetchEvent) => {
return this.dispatch(event.request, event)
}
fetch = (request: Request, Environment?: E['Bindings'], executionCtx?: ExecutionContext) => {
return this.dispatch(request, executionCtx, Environment)
}
request = async (input: Request | string, requestInit?: RequestInit) => {
const req = input instanceof Request ? input : new Request(input, requestInit)
return await this.fetch(req)
}
}