3.2.7

.editorconfig

@@ -11,3 +11,7 @@ indent_style = tab
 [README.md]
 indent_style = space
 indent_size = 4
+
+[{package,package-lock}.json]
+indent_style = space
+indent_size = 2

.github/workflows/publish-main.yml

@@ -1,8 +1,8 @@
-name: Publish (main)
+name: Publish
 
 on:
   release:
-    types: [published]
+    types: [ published ]
 
 jobs:
   publish:

.github/workflows/test.yml

@@ -0,0 +1,21 @@
+name: Test
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: latest
+          registry-url: https://registry.npmjs.org/
+      - name: Install dependencies
+        run: npm ci
+      - name: Run tests
+        run: npm test

.npmignore

@@ -1,7 +1,10 @@
-.github/
-src/
-test/
-.nvmrc
-MIGRATION.md
-tsconfig.json
 .editorconfig
+.github/
+.gitignore
+.nvmrc
+coverage/
+jest.config.ts
+MIGRATION.md
+src/
+tests/
+tsconfig.json

README.md

@@ -4,8 +4,6 @@ Cloudflare Workers Router is a super lightweight router (1.0K gzipped) with midd
 
 When I was trying out Cloudflare Workers I almost immediately noticed how fast it was compared to other serverless offerings. So I wanted to build a full-fledged API to see how it performs doing real work, but since I wasn't able to find a router that suited my needs I created my own.
 
-I worked a lot with [Express.js](https://expressjs.com/) in the past and really enjoyed their middleware approach, but since none of the available Cloudflare Worker routers offered middleware support at the time, I felt the need to create this router.
-
 
 ## Contents
 
@@ -240,7 +238,6 @@ Key                        | Type       | Default Value
 ### Supported Methods
 
 - `router.any(url, [...handlers])`
-- `router.connect(url, [...handlers])`
 - `router.delete(url, [...handlers])`
 - `router.get(url, [...handlers])`
 - `router.head(url, [...handlers])`
@@ -248,7 +245,6 @@ Key                        | Type       | Default Value
 - `router.patch(url, [...handlers])`
 - `router.post(url, [...handlers])`
 - `router.put(url, [...handlers])`
-- `router.trace(url, [...handlers])`
 
 
 #### `url` (string)
@@ -296,7 +292,7 @@ wrangler init <name>
 Use of TypeScript is strongly encouraged :)
 
 ```bash
-npm i -D @tsndr/cloudflare-worker-router
+npm i @tsndr/cloudflare-worker-router
 ```
 
 

package.json

@@ -1,22 +1,23 @@
 {
   "name": "@tsndr/cloudflare-worker-router",
-  "version": "3.1.3",
+  "version": "3.2.7",
   "description": "",
-  "main": "index.js",
+  "type": "module",
+  "exports": "./index.js",
   "types": "index.d.ts",
   "scripts": {
-    "build": "tsc"
+    "build": "tsc",
+    "test": "vitest"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/tsndr/cloudflare-worker-router.git"
   },
   "keywords": [
+    "api",
     "cloudflare",
     "cloudflare-worker",
     "cloudflare-workers",
-    "express",
-    "expressjs",
     "framework",
     "middleware",
     "router",
@@ -31,7 +32,9 @@
   },
   "homepage": "https://github.com/tsndr/cloudflare-worker-router#readme",
   "devDependencies": {
-    "@cloudflare/workers-types": "^4.20231025.0",
+    "@cloudflare/workers-types": "^4.20240222.0",
-    "typescript": "^5.2.2"
+    "@edge-runtime/vm": "^3.2.0",
+    "typescript": "^5.3.3",
+    "vitest": "^1.3.1"
   }
 }

src/index.ts

@@ -175,17 +175,6 @@ export class Router<Env = any, CtxExt = {}, ReqExt = {}> {
 		return this
 	}
 
-	/**
-	* Register CONNECT route
-	*
-	* @param {string} url
-	* @param  {RouterHandler[]} handlers
-	* @returns {Router}
-	*/
-	public connect(url: string, ...handlers: RouterHandler<Env, CtxExt, ReqExt>[]): Router<Env, CtxExt, ReqExt> {
-		return this.register('CONNECT', url, handlers)
-	}
-
 	/**
 	* Register DELETE route
 	*
@@ -263,17 +252,6 @@ export class Router<Env = any, CtxExt = {}, ReqExt = {}> {
 		return this.register('PUT', url, handlers)
 	}
 
-	/**
-	* Register TRACE route
-	*
-	* @param {string} url
-	* @param  {RouterHandler[]} handlers
-	* @returns {Router}
-	*/
-	public trace(url: string, ...handlers: RouterHandler<Env, CtxExt, ReqExt>[]): Router<Env, CtxExt, ReqExt> {
-		return this.register('TRACE', url, handlers)
-	}
-
 	/**
 	* Register route, ignoring method
 	*
@@ -428,21 +406,23 @@ export class Router<Env = any, CtxExt = {}, ReqExt = {}> {
 		}
 
 		const route = this.getRoute(req)
+		let response: Response | undefined
 
 		if (!route)
-			return new Response(this.debugMode ? 'Route not found!' : null, { status: 404 })
+			response = new Response(this.debugMode ? 'Route not found!' : null, { status: 404 })
 
-		const handlers = [...this.globalHandlers, ...route.handlers]
+		if (!response) {
-		const dbg = this.debugMode
+			const handlers = [
-
+				...this.globalHandlers,
-		let response: Response | undefined
+				...(route?.handlers ?? [])
+			]
 
 			for (const handler of handlers) {
 				const context = {
 					...(ctxExt ?? {}),
 					env,
 					req,
-				dbg,
+					dbg: this.debugMode,
 					ctx
 				} as RouterContext<Env, CtxExt, ReqExt>
 
@@ -453,9 +433,10 @@ export class Router<Env = any, CtxExt = {}, ReqExt = {}> {
 					break
 				}
 			}
+		}
 
 		if (!response)
-			return new Response(this.debugMode ? 'Handler did not return a Response!' : null, { status: 404 })
+			response = new Response(this.debugMode ? 'Handler did not return a Response!' : null, { status: 404 })
 
 		if (this.corsEnabled) {
 			response = new Response(response.body, response)

tests/index.spec.ts

@@ -0,0 +1,366 @@
+import { describe, expect, test } from 'vitest'
+import { Router } from '../src/index'
+
+describe('Router', () => {
+	test('use', async () => {
+		const router = new Router()
+		const testRequest = new Request('https://example.com/')
+		const testResponse = new Response('success', { status: 200 })
+
+		expect(router.use(() => testResponse)).toBeInstanceOf(Router)
+
+		router.get('/', () => new Response('failed'))
+
+		const response = await router.handle(testRequest, {})
+
+		expect(response.status).toBe(200)
+
+		expect(await response.text()).toBe('success')
+	})
+
+	test('delete', async () => {
+		const router = new Router()
+		const testRequest = new Request('https://example.com/', { method: 'DELETE' })
+		const testResponse = new Response('success', { status: 200 })
+
+		expect(router.delete('/', () => testResponse)).toBeInstanceOf(Router)
+
+		const response = await router.handle(testRequest, {})
+
+		expect(response.status).toBe(200)
+
+		expect(await response.text()).toBe('success')
+	})
+
+	test('get', async () => {
+		const router = new Router()
+		const testRequest = new Request('https://example.com/', { method: 'GET' })
+		const testResponse = new Response('success', { status: 200 })
+
+		expect(router.get('/', () => testResponse)).toBeInstanceOf(Router)
+
+		const response = await router.handle(testRequest, {})
+
+		expect(response.status).toBe(200)
+
+		expect(await response.text()).toBe('success')
+	})
+
+	test('head', async () => {
+		const router = new Router()
+		const testRequest = new Request('https://example.com/', { method: 'HEAD' })
+		const testResponse = new Response('success', { status: 200 })
+
+		expect(router.head('/', () => testResponse)).toBeInstanceOf(Router)
+
+		const response = await router.handle(testRequest, {})
+
+		expect(response.status).toBe(200)
+
+		expect(await response.text()).toBe('success')
+	})
+
+	test('options', async () => {
+		const router = new Router()
+		const testRequest = new Request('https://example.com/', { method: 'OPTIONS' })
+		const testResponse = new Response('success', { status: 200 })
+
+		expect(router.options('/', () => testResponse)).toBeInstanceOf(Router)
+
+		const response = await router.handle(testRequest, {})
+
+		expect(response.status).toBe(200)
+
+		expect(await response.text()).toBe('success')
+	})
+
+	test('patch', async () => {
+		const router = new Router()
+		const testRequest = new Request('https://example.com/', { method: 'PATCH' })
+		const testResponse = new Response('success', { status: 200 })
+
+		expect(router.patch('/', () => testResponse)).toBeInstanceOf(Router)
+
+		const response = await router.handle(testRequest, {})
+
+		expect(response.status).toBe(200)
+
+		expect(await response.text()).toBe('success')
+	})
+
+	test('post', async () => {
+		const router = new Router()
+		const testRequest = new Request('https://example.com/', { method: 'POST' })
+		const testResponse = new Response('success', { status: 200 })
+
+		expect(router.post('/test', () => testResponse)).toBeInstanceOf(Router)
+		expect(router.post('/', () => testResponse)).toBeInstanceOf(Router)
+
+		const response = await router.handle(testRequest, {})
+
+		expect(response.status).toBe(200)
+
+		expect(await response.text()).toBe('success')
+	})
+
+	test('put', async () => {
+		const router = new Router()
+		const testRequest = new Request('https://example.com/', { method: 'PUT' })
+		const testResponse = new Response('success', { status: 200 })
+
+		expect(router.put('/test', () => testResponse)).toBeInstanceOf(Router)
+		expect(router.put('/', () => testResponse)).toBeInstanceOf(Router)
+
+		const response = await router.handle(testRequest, {})
+
+		expect(response.status).toBe(200)
+
+		expect(await response.text()).toBe('success')
+	})
+
+	test('any', async () => {
+		const router = new Router()
+		const testRequest = new Request('https://example.com/', { method: 'POST' })
+		const testResponse = new Response('success', { status: 200 })
+
+		expect(router.any('/test', () => testResponse)).toBeInstanceOf(Router)
+		expect(router.any('/', () => testResponse)).toBeInstanceOf(Router)
+
+		const response = await router.handle(testRequest, {})
+
+		expect(response.status).toBe(200)
+
+		expect(await response.text()).toBe('success')
+	})
+
+	test('cors', async () => {
+		const router = new Router()
+		const testRequest = new Request('https://example.com/', { method: 'GET' })
+		const testOptionsRequest = new Request('https://example.com/', { method: 'OPTIONS' })
+		const testResponse = new Response('success', { status: 200 })
+
+		expect(router.cors()).toBeInstanceOf(Router)
+
+		router.get('/', () => testResponse)
+
+		const response = await router.handle(testRequest, {})
+
+		expect(response.status).toBe(200)
+
+		expect(response.headers.get('Access-Control-Allow-Origin')).toBe('*')
+		expect(response.headers.get('Access-Control-Allow-Methods')).toBe('*')
+		expect(response.headers.get('Access-Control-Allow-Headers')).toBe('*')
+		expect(response.headers.get('Access-Control-Allow-Credentials')).toBe(null)
+		expect(response.headers.get('vary')).toBe(null)
+		expect(response.headers.get('Access-Control-Max-Age')).toBe('86400')
+
+		const optionsRes = await router.handle(testOptionsRequest, {})
+
+		expect(optionsRes.status).toBe(204)
+		expect(optionsRes.headers.get('Access-Control-Allow-Origin')).toBe('*')
+		expect(optionsRes.headers.get('Access-Control-Allow-Methods')).toBe('*')
+		expect(optionsRes.headers.get('Access-Control-Allow-Headers')).toBe('*')
+		expect(optionsRes.headers.get('Access-Control-Allow-Credentials')).toBe(null)
+		expect(optionsRes.headers.get('vary')).toBe(null)
+		expect(optionsRes.headers.get('Access-Control-Max-Age')).toBe('86400')
+
+		expect(await response.text()).toBe('success')
+	})
+
+	test('params', async () => {
+		const router = new Router()
+		const testRequest = new Request('https://example.com/bar/foo')
+
+		router.get('/:foo/:bar', ({ req }) => {
+			return Response.json(req.params)
+		})
+
+		const response = await router.handle(testRequest, {})
+
+		expect(response.status).toEqual(200)
+
+		expect(await response.json()).toMatchObject({ foo: 'bar', bar: 'foo' })
+	})
+
+	test('query', async () => {
+		const router = new Router()
+		const testRequest = new Request('https://example.com/?foo=bar&bar=foo')
+
+		router.get('/', ({ req }) => {
+			return Response.json(req.query)
+		})
+
+		const response = await router.handle(testRequest, {})
+
+		expect(response.status).toEqual(200)
+
+		expect(await response.json()).toMatchObject({ foo: 'bar', bar: 'foo' })
+	})
+
+	test('404', async () => {
+		const router = new Router()
+		const testRequest = new Request('https://example.com/')
+
+		const response = await router.handle(testRequest, {})
+
+		expect(response.status).toEqual(404)
+	})
+
+	test('debug mode', async () => {
+		const router = new Router()
+		const testRequest = new Request('https://example.com/')
+
+		router.debug()
+
+		const response = await router.handle(testRequest, {})
+
+		expect(response.status).toEqual(404)
+
+		expect(await response.text()).toBe('Route not found!')
+	})
+
+	test('handler no response', async () => {
+		const router = new Router()
+		const testRequest = new Request('https://example.com/')
+
+		router.debug()
+
+		router.get('/', () => {})
+
+		const response = await router.handle(testRequest, {})
+
+		expect(response.status).toEqual(404)
+
+		expect(await response.text()).toBe('Handler did not return a Response!')
+	})
+
+	test('wildcard', async () => {
+		const router = new Router()
+		const testRequest = new Request('https://example.com/foo/bar')
+		const testResponse = new Response('success', { status: 200 })
+
+		router.get('*', () => testResponse)
+
+		const response = await router.handle(testRequest, {})
+
+		expect(response.status).toEqual(200)
+
+		expect(await response.text()).toBe('success')
+	})
+
+	test('bearer', async () => {
+		const router = new Router()
+		const testToken = 'super-secret-token'
+		const testRequest = new Request('https://example.com/', { headers: { 'Authorization': `Bearer ${testToken}` }})
+
+		router.get('/', ({ req }) => new Response(req.bearer()))
+
+		const response = await router.handle(testRequest, {})
+
+		expect(response.status).toEqual(200)
+
+		expect(await response.text()).toBe(testToken)
+	})
+})
+
+describe('Middleware', () => {
+	const router = new Router()
+	const testHandlerSuccess = () => new Response('success', { status: 200 })
+	const testHandlerContinue = () => {}
+	const testHandlerFailed = () => new Response('failed', { status: 403 })
+
+	router.get('/success', testHandlerContinue, testHandlerSuccess)
+	router.get('/failed', testHandlerFailed, testHandlerSuccess)
+
+	test('continue', async () => {
+		const testRequest = new Request('https://example.com/success')
+		const response = await router.handle(testRequest, {})
+
+		expect(response.status).toEqual(200)
+
+		expect(await response.text()).toBe('success')
+	})
+
+	test('block', async () => {
+		const testRequest = new Request('https://example.com/failed')
+		const response = await router.handle(testRequest, {})
+
+		expect(response.status).toEqual(403)
+
+		expect(await response.text()).toBe('failed')
+	})
+})
+
+describe('Body', () => {
+
+	test('text then text', async () => {
+		const router = new Router()
+		const testText = "lorem ipsum dolor sit amet"
+		const testRequest = new Request('https://example.com/', { method: 'POST', body: testText })
+
+		router.post('/', async ({ req }) => {
+			return Response.json({
+				text: await req.text(),
+				text2: await req.text()
+			})
+		})
+
+		const response = await router.handle(testRequest, {})
+
+		expect(await response.json()).toMatchObject({ text: testText, text2: testText })
+	})
+
+	test('json then json', async () => {
+		const router = new Router()
+		const testObject = { text: 'cloudflare-worker-router', binary: true, amount: 17 }
+		const testJson = JSON.stringify(testObject)
+		const testRequest = new Request('https://example.com/', { method: 'POST', body: testJson })
+
+		router.post('/', async ({ req }) => {
+			return Response.json({
+				json: await req.json(),
+				json2: await req.json()
+			})
+		})
+
+		const response = await router.handle(testRequest, {})
+
+		expect(await response.json()).toMatchObject({ json: testObject, json2: testObject })
+	})
+
+	test('text then json', async () => {
+		const router = new Router()
+		const testObject = { text: 'cloudflare-worker-router', binary: true, amount: 17 }
+		const testJson = JSON.stringify(testObject)
+		const testRequest = new Request('https://example.com/', { method: 'POST', body: testJson })
+
+		router.post('/', async ({ req }) => {
+			return Response.json({
+				text: await req.text(),
+				json: await req.json()
+			})
+		})
+
+		const response = await router.handle(testRequest, {})
+
+		expect(await response.json()).toMatchObject({ text: testJson, json: testObject })
+	})
+
+	test('json then text', async () => {
+		const router = new Router()
+		const testObject = { text: 'cloudflare-worker-router', binary: true, amount: 17 }
+		const testJson = JSON.stringify(testObject)
+		const testRequest = new Request('https://example.com/', { method: 'POST', body: testJson })
+
+		router.post('/', async ({ req }) => {
+			return Response.json({
+				json: await req.json(),
+				text: await req.text()
+			})
+		})
+
+		const response = await router.handle(testRequest, {})
+
+		expect(await response.json()).toMatchObject({ text: testJson, json: testObject })
+	})
+})

vite.config.ts

@@ -0,0 +1,9 @@
+import { defineConfig } from 'vitest/config'
+
+export default defineConfig({
+	test: {
+		environment: 'edge-runtime',
+		reporters: ['verbose'],
+		watch: false
+	}
+})