1
0

3 Commits

Author SHA1 Message Date
1b2956b437 add more tests 2024-01-20 02:14:39 +01:00
64458ca755 even more tests 2024-01-19 21:04:54 +01:00
eeea1102af working on testing 2024-01-19 00:37:29 +01:00
12 changed files with 3796 additions and 1213 deletions

View File

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

View File

@@ -1,8 +1,8 @@
name: Publish name: Publish (main)
on: on:
release: release:
types: [ published ] types: [published]
jobs: jobs:
publish: publish:
@@ -28,4 +28,4 @@ jobs:
- name: Publish to GPR - name: Publish to GPR
env: env:
NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}} NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
run: npm publish --tag latest --access public run: npm publish --tag latest --access public

View File

@@ -1,21 +0,0 @@
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

View File

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

View File

@@ -4,6 +4,8 @@ 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. 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 ## Contents
@@ -238,6 +240,7 @@ Key | Type | Default Value
### Supported Methods ### Supported Methods
- `router.any(url, [...handlers])` - `router.any(url, [...handlers])`
- `router.connect(url, [...handlers])`
- `router.delete(url, [...handlers])` - `router.delete(url, [...handlers])`
- `router.get(url, [...handlers])` - `router.get(url, [...handlers])`
- `router.head(url, [...handlers])` - `router.head(url, [...handlers])`
@@ -245,6 +248,7 @@ Key | Type | Default Value
- `router.patch(url, [...handlers])` - `router.patch(url, [...handlers])`
- `router.post(url, [...handlers])` - `router.post(url, [...handlers])`
- `router.put(url, [...handlers])` - `router.put(url, [...handlers])`
- `router.trace(url, [...handlers])`
#### `url` (string) #### `url` (string)
@@ -292,7 +296,7 @@ wrangler init <name>
Use of TypeScript is strongly encouraged :) Use of TypeScript is strongly encouraged :)
```bash ```bash
npm i @tsndr/cloudflare-worker-router npm i -D @tsndr/cloudflare-worker-router
``` ```
@@ -406,4 +410,4 @@ export default {
return router.handle(request, env, ctx) return router.handle(request, env, ctx)
} }
} }
``` ```

9
jest.config.ts Normal file
View File

@@ -0,0 +1,9 @@
import type { Config } from 'jest'
const config: Config = {
preset: 'ts-jest',
testEnvironment: 'node',
verbose: true
}
export default config

4848
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@@ -1,23 +1,22 @@
{ {
"name": "@tsndr/cloudflare-worker-router", "name": "@tsndr/cloudflare-worker-router",
"version": "3.2.9", "version": "3.1.3",
"description": "", "description": "",
"type": "module", "main": "index.js",
"exports": "./index.js",
"types": "index.d.ts", "types": "index.d.ts",
"scripts": { "scripts": {
"build": "tsc", "build": "tsc"
"test": "vitest"
}, },
"repository": { "repository": {
"type": "git", "type": "git",
"url": "git+https://github.com/tsndr/cloudflare-worker-router.git" "url": "git+https://github.com/tsndr/cloudflare-worker-router.git"
}, },
"keywords": [ "keywords": [
"api",
"cloudflare", "cloudflare",
"cloudflare-worker", "cloudflare-worker",
"cloudflare-workers", "cloudflare-workers",
"express",
"expressjs",
"framework", "framework",
"middleware", "middleware",
"router", "router",
@@ -32,9 +31,12 @@
}, },
"homepage": "https://github.com/tsndr/cloudflare-worker-router#readme", "homepage": "https://github.com/tsndr/cloudflare-worker-router#readme",
"devDependencies": { "devDependencies": {
"@cloudflare/workers-types": "^4.20241022.0", "@cloudflare/workers-types": "^4.20231025.0",
"@edge-runtime/vm": "^4.0.3", "@jest/globals": "^29.7.0",
"typescript": "^5.6.3", "@types/jest": "^29.5.11",
"vitest": "^2.1.3" "jest": "^29.7.0",
"ts-jest": "^29.1.1",
"ts-node": "^10.9.2",
"typescript": "^5.2.2"
} }
} }

View File

@@ -1,5 +1,5 @@
import { describe, expect, test } from 'vitest' import { describe, expect, test } from '@jest/globals'
import { Router } from '../src/index' import { Router } from '.'
describe('Router', () => { describe('Router', () => {
test('use', async () => { test('use', async () => {

View File

@@ -175,6 +175,17 @@ export class Router<Env = any, CtxExt = {}, ReqExt = {}> {
return this 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 * Register DELETE route
* *
@@ -252,6 +263,17 @@ export class Router<Env = any, CtxExt = {}, ReqExt = {}> {
return this.register('PUT', url, handlers) 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 * Register route, ignoring method
* *
@@ -406,37 +428,34 @@ export class Router<Env = any, CtxExt = {}, ReqExt = {}> {
} }
const route = this.getRoute(req) const route = this.getRoute(req)
let response: Response | undefined
if (!route) if (!route)
response = new Response(this.debugMode ? 'Route not found!' : null, { status: 404 }) return new Response(this.debugMode ? 'Route not found!' : null, { status: 404 })
if (!response) { const handlers = [...this.globalHandlers, ...route.handlers]
const handlers = [ const dbg = this.debugMode
...this.globalHandlers,
...(route?.handlers ?? [])
]
for (const handler of handlers) { let response: Response | undefined
const context = {
...(ctxExt ?? {}),
env,
req,
dbg: this.debugMode,
ctx
} as RouterContext<Env, CtxExt, ReqExt>
const res = await handler(context) for (const handler of handlers) {
const context = {
...(ctxExt ?? {}),
env,
req,
dbg,
ctx
} as RouterContext<Env, CtxExt, ReqExt>
if (res) { const res = await handler(context)
response = res
break if (res) {
} response = res
break
} }
} }
if (!response) if (!response)
response = new Response(this.debugMode ? 'Handler did not return a Response!' : null, { status: 404 }) return new Response(this.debugMode ? 'Handler did not return a Response!' : null, { status: 404 })
if (this.corsEnabled) { if (this.corsEnabled) {
response = new Response(response.body, response) response = new Response(response.body, response)

View File

@@ -1,7 +1,7 @@
{ {
"compilerOptions": { "compilerOptions": {
"outDir": ".", "outDir": ".",
"module": "esnext", "module": "commonjs",
"target": "esnext", "target": "esnext",
"lib": ["esnext"], "lib": ["esnext"],
"declaration": true, "declaration": true,
@@ -23,4 +23,4 @@
}, },
"include": ["src"], "include": ["src"],
"exclude": ["node_modules"] "exclude": ["node_modules"]
} }

View File

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