tsndr/cloudflare-worker-router
1
0
Fork 0
Code Activity

switch to return syntax

Browse Source
This commit is contained in:
Toby
2022-11-24 22:55:26 +01:00
parent ad4557ecb3
commit 215a3731da
3 changed files with 156 additions and 226 deletions
Download Patch File Download Diff File Expand all files Collapse all files

146
README.md
View File

@@ -40,8 +40,9 @@ export interface Env {
// //
// Example binding to R2. Learn more at https://developers.cloudflare.com/workers/runtime-apis/r2/ // Example binding to R2. Learn more at https://developers.cloudflare.com/workers/runtime-apis/r2/
// MY_BUCKET: R2Bucket // MY_BUCKET: R2Bucket
}
SECRET_TOKEN: string
}
// Initialize router // Initialize router
const router = new Router<Env>() const router = new Router<Env>()
@@ -50,61 +51,61 @@ const router = new Router<Env>()
router.cors() router.cors()
// Register global middleware // Register global middleware
router.use(({ req, res, next }) => { router.use(() => {
res.headers.set('X-Global-Middlewares', 'true') return new Response(null, {
next() headers: {
'X-Global-Middlewares': 'true'
}
})
}) })
// Simple get // Simple get
router.get('/user', ({ req, res }) => { router.get('/user', () => {
res.body = { return Response.json({
data: { id: 1,
id: 1, name: 'John Doe'
name: 'John Doe' })
}
}
}) })
// Post route with url parameter // Post route with url parameter
router.post('/user/:id', ({ req, res }) => { router.post('/user/:id', ({ req }) => {
const userId = req.params.id const userId = req.params.id
// Do stuff... // Do stuff
if (errorDoingStuff) { if (!true) {
res.status = 400 return Response.json({
res.body = { error: 'Error doing stuff!'
error: 'User did stupid stuff!' }, { status: 400 })
}
return
} }
res.status = 204 return Response.json({ userId }, { status: 204 })
}) })
// Delete route using a middleware // Delete route using a middleware
router.delete('/user/:id', ({ req, res, next }) => { router.delete('/user/:id', ({ env, req }) => {
const { SECRET_TOKEN } = env
if (!apiTokenIsCorrect) { if (req.headers.get('Authorization') === SECRET_TOKEN)
res.status = 401 return new Response(null, { status: 401 })
return
}
await next() }, ({ req }) => {
}, (req, res) => {
const userId = req.params.id const userId = req.params.id
// Do stuff... // Do stuff...
return Response.json({ userId })
}) })
// Listen Cloudflare Workers Fetch Event // Listen Cloudflare Workers Fetch Event
export default { export default {
async fetch(request: Request, env: Env): Promise<Response> { async fetch(request: Request, env: Env, ctx: ExecutionContext) {
return router.handle(env, request) return router.handle(request, env, ctx)
} }
} }
``` ```
<details> <details>
@@ -120,59 +121,56 @@ const router = new Router()
router.cors() router.cors()
// Register global middleware // Register global middleware
router.use(({ req, res, next }) => { router.use(() => {
res.headers.set('X-Global-Middlewares', 'true') return new Response(null, {
next() headers: {
'X-Global-Middlewares': 'true'
}
})
}) })
// Simple get // Simple get
router.get('/user', ({ req, res }) => { router.get('/user', () => {
res.body = { return Response.json({
data: { id: 1,
id: 1, name: 'John Doe'
name: 'John Doe' })
}
}
}) })
// Post route with url parameter // Post route with url parameter
router.post('/user/:id', ({ req, res }) => { router.post('/user/:id', ({ req }) => {
const userId = req.params.id const userId = req.params.id
// Do stuff... // Do stuff
if (errorDoingStuff) { if (errorDoingStuff) {
res.status = 400 return Response.json({
res.body = { error: 'Error doing stuff!'
error: 'User did stupid stuff!' }, { status: 400 })
} }
return
}
res.status = 204 return Response.json({ userId }, { status: 204 })
}) })
// Delete route using a middleware // Delete route using a middleware
router.delete('/user/:id', ({ req, res, next }) => { router.delete('/user/:id', ({ env, req }) => {
const { SECRET_TOKEN } = env
if (!apiTokenIsCorrect) { if (req.headers.get('Authorization') === SECRET_TOKEN)
res.status = 401 return new Response(null, { status: 401 })
return
}
await next()
}, (req, res) => {
}, ({ req }) => {
const userId = req.params.id const userId = req.params.id
// Do stuff... // Do stuff...
return Response.json({ userId })
}) })
// Listen Cloudflare Workers Fetch Event // Listen Cloudflare Workers Fetch Event
export default { export default {
async fetch(request, env) { async fetch(request, env, ctx) {
return router.handle(env, request) return router.handle(request, env, ctx)
} }
} }
``` ```
@@ -206,7 +204,7 @@ Handler is a `function` which will be called for every request.
#### `ctx` #### `ctx`
Object containing `env`, [`req`](#req-object), [`res`](#res-object), `next` Object containing `env`, [`req`](#req-object)
### `router.cors([config])` ### `router.cors([config])`
@@ -247,16 +245,16 @@ Supports the use of dynamic parameters, prefixed with a `:` (i.e. `/user/:userId
#### `handlers` (function, optional) #### `handlers` (function, optional)
An unlimited number of functions getting [`req`](#req-object) and [`res`](#res-object) passed into them. An unlimited number of functions getting [`ctx`](#ctx-object) passed into them.
### `ctx`-Object ### `ctx`-Object
Key | Type | Description Key | Type | Description
--------- | ------------------- | ----------- --------- | ------------------- | -----------
`env` | `object` | Environment `env` | `object` | Environment
`req` | `req`-Object | Request Object `req` | `req`-Object | Request Object
`res` | `res`-Object | Response Object `ctx` | `ctx`-Object | Cloudflare's `ctx`-Object
`next` | `next`-Handler | Next Handler
### `req`-Object ### `req`-Object
@@ -270,16 +268,6 @@ Key | Type | Description
`query` | `object` | Object containing all query parameters `query` | `object` | Object containing all query parameters
### `res`-Object
Key | Type | Description
----------- | ------------------- | -----------
`body` | `object` / `string` | Either set an `object` (will be converted to JSON) or a string
`headers` | `Headers` | Response [Headers Object](https://developer.mozilla.org/en-US/docs/Web/API/Headers)
`status` | `integer` | Return status code (default: `204`)
`webSocket` | `WebSocket` | Upgraded websocket connection
## Setup ## Setup
Please follow Cloudflare's [Get started guide](https://developers.cloudflare.com/workers/get-started/guide/) to install wrangler. Please follow Cloudflare's [Get started guide](https://developers.cloudflare.com/workers/get-started/guide/) to install wrangler.
@@ -335,8 +323,8 @@ const router = new Router<Env>()
// TODO: add your routes here // TODO: add your routes here
export default { export default {
async fetch(request: Request, env: Env, ctx: ExecutionContext): Promise<Response> { async fetch(request: Request, env: Env, ctx: ExecutionContext) {
return router.handle(env, request) return router.handle(request, env, ctx)
} }
} }
``` ```
@@ -360,7 +348,7 @@ const router = new Router()
export default { export default {
async fetch(request, env, ctx) { async fetch(request, env, ctx) {
return router.handle(env, request) return router.handle(request, env, ctx)
} }
} }
``` ```

233
src/index.ts
View File

@@ -13,19 +13,17 @@ export interface Route<TEnv> {
} }
/** /**
* Router Context * Router Context
* *
* @typedef RouterContext * @typedef RouterContext
* @property {RouterEnv} env Environment * @property {RouterEnv} env Environment
* @property {RouterRequest} req Request Object * @property {RouterRequest} req Request Object
* @property {RouterResponse} res Response Object * @property {ExecutionContext} ctx Context Object
* @property {RouterNext} next Next Handler */
*/ export interface RouterContext<TEnv = any> {
export interface RouterContext<TEnv> { env: TEnv
env: TEnv req: RouterRequest
req: RouterRequest ctx: ExecutionContext
res: RouterResponse
next: RouterNext
} }
/** /**
@@ -70,41 +68,14 @@ export interface RouterRequestQuery {
} }
/** /**
* Response Object * Handler Function
* *
* @typedef RouterResponse * @callback RouterHandler
* @property {Headers} headers Response headers object * @param {RouterContext} ctx
* @property {number} [status=204] Return status code (default: `204`) * @returns {Promise<Response | void> Response | void}
* @property {string | any} [body] Either an `object` (will be converted to JSON) or a string */
* @property {Response} [raw] A response object that is to be returned, this will void all other res properties and return this as is.
*/
export interface RouterResponse {
headers: Headers
status?: number
body?: string | any
raw?: Response,
webSocket?: WebSocket
}
/**
* Next Function
*
* @callback RouterNext
* @returns {Promise<void>}
*/
export interface RouterNext {
(): Promise<void>
}
/**
* Handler Function
*
* @callback RouterHandler
* @param {RouterContext} ctx
* @returns {Promise<void> | void}
*/
export interface RouterHandler<TEnv = any> { export interface RouterHandler<TEnv = any> {
(ctx: RouterContext<TEnv>): Promise<void> | void (ctx: RouterContext<TEnv>): Promise<Response | void> | Response | void
} }
/** /**
@@ -325,21 +296,33 @@ export class Router<TEnv = any> {
return this return this
} }
/** private setCorsHeaders(headers: Headers = new Headers()): Headers {
* Register route if (this.corsConfig.allowOrigin && !headers.has('Access-Control-Allow-Origin'))
* headers.set('Access-Control-Allow-Origin', this.corsConfig.allowOrigin)
* @private if (this.corsConfig.allowMethods && !headers.has('Access-Control-Allow-Methods'))
* @param {string} method HTTP request method headers.set('Access-Control-Allow-Methods', this.corsConfig.allowMethods)
* @param {string} url URL String if (this.corsConfig.allowHeaders && !headers.has('Access-Control-Allow-Headers'))
* @param {RouterHandler[]} handlers Arrar of handler functions headers.set('Access-Control-Allow-Headers', this.corsConfig.allowHeaders)
* @returns {Router} if (this.corsConfig.maxAge && !headers.has('Access-Control-Max-Age'))
*/ headers.set('Access-Control-Max-Age', this.corsConfig.maxAge.toString())
private register(method: string, url: string, handlers: RouterHandler<TEnv>[]): Router<TEnv> { return headers
this.routes.push({ }
method,
url, /**
handlers * Register route
}) *
* @private
* @param {string} method HTTP request method
* @param {string} url URL String
* @param {RouterHandler[]} handlers Arrar of handler functions
* @returns {Router}
*/
private register(method: string, url: string, handlers: RouterHandler<TEnv>[]): Router<TEnv> {
this.routes.push({
method,
url,
handlers
})
return this return this
} }
@@ -385,97 +368,57 @@ export class Router<TEnv = any> {
}) || this.routes.find(r => r.url === '*' && [request.method, '*'].includes(r.method)) }) || this.routes.find(r => r.url === '*' && [request.method, '*'].includes(r.method))
} }
/** /**
* Handle requests * Handle requests
* *
* @param {TEnv} env * @param {TEnv} env
* @param {Request} request * @param {Request} request
* @param {any} [extend] * @param {any} [extend]
* @returns {Promise<Response>} * @returns {Promise<Response>}
*/ */
public async handle(env: TEnv, request: Request, extend: any = {}): Promise<Response> { public async handle(request: Request, env: TEnv, ctx: ExecutionContext, extend: any = {}): Promise<Response> {
try { const req: RouterRequest = {
const req: RouterRequest = { ...extend,
...extend, method: request.method,
method: request.method, headers: request.headers,
headers: request.headers, url: request.url,
url: request.url, cf: request.cf,
cf: request.cf, params: {},
params: {}, query: {},
query: {}, body: ''
body: '' }
}
const headers = new Headers() const route = this.getRoute(req)
const route = this.getRoute(req)
if (this.corsEnabled) { if (!route)
if (this.corsConfig.allowOrigin) return new Response(this.debugMode ? 'Route not found!' : null, { status: 404 })
headers.set('Access-Control-Allow-Origin', this.corsConfig.allowOrigin)
if (this.corsConfig.allowMethods)
headers.set('Access-Control-Allow-Methods', this.corsConfig.allowMethods)
if (this.corsConfig.allowHeaders)
headers.set('Access-Control-Allow-Headers', this.corsConfig.allowHeaders)
if (this.corsConfig.maxAge)
headers.set('Access-Control-Max-Age', this.corsConfig.maxAge.toString())
if (!route && req.method === 'OPTIONS') { if (this.corsEnabled && req.method === 'OPTIONS') {
return new Response(null, { return new Response(null, {
headers, headers: this.setCorsHeaders(),
status: this.corsConfig.optionsSuccessStatus status: this.corsConfig.optionsSuccessStatus
}) })
} }
}
if (!route) const handlers = [...this.globalHandlers, ...route.handlers]
return new Response(this.debugMode ? 'Route not found!' : null, { status: 404 })
if (['POST', 'PUT', 'PATCH'].includes(req.method)) { let response: Response | undefined
if (req.headers.has('Content-Type') && req.headers.get('Content-Type')!.includes('json')) {
try {
req.body = await request.json()
} catch {
req.body = {}
}
} else {
try {
req.body = await request.text()
} catch {
req.body = ''
}
}
}
const res: RouterResponse = { headers } for (const handler of handlers) {
const handlers = [...this.globalHandlers, ...route.handlers] const res = await handler({ env, req, ctx })
let prevIndex = -1
const runner = async (index: number) => { if (res) {
if (index === prevIndex) response = res
throw new Error('next() called multiple times') break
}
}
prevIndex = index if (!response)
return new Response(this.debugMode ? 'Handler did not return a Response!' : null, { status: 404 })
if (typeof handlers[index] === 'function') if (this.corsEnabled)
await handlers[index]({ env, req, res, next: async () => await runner(index + 1) }) this.setCorsHeaders(response.headers)
}
await runner(0) return response
}
if (typeof res.body === 'object') {
if (!res.headers.has('Content-Type'))
res.headers.set('Content-Type', 'application/json')
res.body = JSON.stringify(res.body)
}
if (res.raw)
return res.raw
return new Response([101, 204, 205, 304].includes(res.status || (res.body ? 200 : 204)) ? null : res.body, { status: res.status, headers: res.headers, webSocket: res.webSocket || null })
} catch(err) {
console.error(err)
return new Response(this.debugMode && err instanceof Error ? err.stack : '', { status: 500 })
}
}
} }

1
tsconfig.json
View File

@@ -15,7 +15,6 @@
"alwaysStrict": true, "alwaysStrict": true,
"noUnusedLocals": true, "noUnusedLocals": true,
"noUnusedParameters": true, "noUnusedParameters": true,
"noImplicitReturns": true,
"noFallthroughCasesInSwitch": true, "noFallthroughCasesInSwitch": true,
"esModuleInterop": true, "esModuleInterop": true,
"preserveConstEnums": true, "preserveConstEnums": true,