Merge branch 'master' into upgrade-to-eslint9

Author: 3imed-jaberi

.github/workflows/ci.yml

@@ -24,3 +24,59 @@ jobs:
         run: npm install
       - name: Run tests
         run: npm run test
+
+  benchmarks:
+    runs-on: ubuntu-latest
+    env:
+      THRESHOLD: 50000
+    steps:
+      - name: Setup node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20
+      # First checkout master and run benchmarks
+      - name: Checkout master branch
+        uses: actions/checkout@v3
+        with:
+          ref: master
+
+      - name: Install dependencies
+        run: npm install
+      - name: Run benchmarks
+        run: npm run benchmark || echo "0" > bench-result.txt
+      # Store output of bench-result.txt to workflow output
+      - name: Store benchmark result
+        id: main_benchmark
+        run: |
+          echo "result=$(cat bench-result.txt)" >> $GITHUB_OUTPUT
+
+      # Now checkout the PR branch and run benchmarks
+      - name: Checkout PR branch
+        uses: actions/checkout@v3
+
+      - name: Install dependencies
+        run: npm install
+      - name: Run benchmarks
+        run: npm run benchmark
+      # Store output of bench-result.txt to workflow output
+      - name: Store benchmark result
+        id: branch_benchmark
+        run: |
+          echo "result=$(cat bench-result.txt)" >> $GITHUB_OUTPUT
+
+      # Verify difference between main and branch benchmark outputs aren't greater than THRESHOLD env var
+      - name: Verify benchmark results
+        run: |
+          main_result=${{ steps.main_benchmark.outputs.result }}
+          branch_result=${{ steps.branch_benchmark.outputs.result }}
+          difference=$(echo "$main_result - $branch_result" | bc)
+          echo "Main benchmark result: $main_result"
+          echo "Branch benchmark result: $branch_result"
+          echo "Difference: $difference"
+          if (( $(echo "$difference > $THRESHOLD" | bc -l) )); then
+            echo "Benchmark difference exceeds threshold of $THRESHOLD"
+            exit 1
+          else
+            echo "Benchmark difference is within acceptable limit (< $THRESHOLD)."
+          fi
+          

.gitignore

@@ -12,4 +12,5 @@ Thumbs.db
 tmp/
 temp/
 *.lcov
-.env
+.env
+bench-result.txt

bench/run.js

@@ -0,0 +1,83 @@
+'use strict'
+
+const { now, print, operations } = require('./util')
+const KoaRouter = require('../lib/router')
+
+const router = new KoaRouter()
+
+const routes = [
+  { method: 'GET', url: '/user' },
+  { method: 'GET', url: '/user/comments' },
+  { method: 'GET', url: '/user/avatar' },
+  { method: 'GET', url: '/user/lookup/username/:username' },
+  { method: 'GET', url: '/user/lookup/email/:address' },
+  { method: 'GET', url: '/event/:id' },
+  { method: 'GET', url: '/event/:id/comments' },
+  { method: 'POST', url: '/event/:id/comment' },
+  { method: 'GET', url: '/map/:location/events' },
+  { method: 'GET', url: '/status' },
+  { method: 'GET', url: '/very/deeply/nested/route/hello/there' },
+  { method: 'GET', url: '/static/(.*)' }
+]
+
+function noop () {}
+
+var i = 0
+var time = 0
+
+routes.forEach(route => {
+  if (route.method === 'GET') {
+    router.get(route.url, noop)
+  } else {
+    router.post(route.url, noop)
+  }
+})
+
+time = now()
+for (i = 0; i < operations; i++) {
+  router.match('/user', 'GET')
+}
+print('short static:', time)
+
+time = now()
+for (i = 0; i < operations; i++) {
+  router.match('/user/comments', 'GET')
+}
+print('static with same radix:', time)
+
+time = now()
+for (i = 0; i < operations; i++) {
+  router.match('/user/lookup/username/john', 'GET')
+}
+print('dynamic route:', time)
+
+time = now()
+for (i = 0; i < operations; i++) {
+  router.match('/event/abcd1234/comments', 'GET')
+}
+print('mixed static dynamic:', time)
+
+time = now()
+for (i = 0; i < operations; i++) {
+  router.match('/very/deeply/nested/route/hello/there', 'GET')
+}
+print('long static:', time)
+
+time = now()
+for (i = 0; i < operations; i++) {
+  router.match('/static/index.html', 'GET')
+}
+print('wildcard:', time)
+
+time = now()
+for (i = 0; i < operations; i++) {
+  router.match('/user', 'GET')
+  router.match('/user/comments', 'GET')
+  router.match('/user/lookup/username/john', 'GET')
+  router.match('/event/abcd1234/comments', 'GET')
+  router.match('/very/deeply/nested/route/hello/there', 'GET')
+  router.match('/static/index.html', 'GET')
+}
+const output = print('all together:', time)
+
+require('fs').writeFileSync('bench-result.txt', String(output))

bench/util.js

@@ -0,0 +1,51 @@
+'use strict'
+
+const chalk = require('chalk').default
+
+const operations = 1000000
+
+function now () {
+  var ts = process.hrtime()
+  return (ts[0] * 1e3) + (ts[1] / 1e6)
+}
+
+function getOpsSec (ms) {
+  return Number(((operations * 1000) / ms).toFixed())
+}
+
+function print (name, time) {
+  const opsSec = getOpsSec(now() - time)
+  console.log(chalk.yellow(name), opsSec.toLocaleString(), 'ops/sec')
+  return Number(opsSec)
+}
+
+function title (name) {
+  console.log(chalk.green(`
+${'='.repeat(name.length + 2)}
+ ${name}
+${'='.repeat(name.length + 2)}`))
+}
+
+function Queue () {
+  this.q = []
+  this.running = false
+}
+
+Queue.prototype.add = function add (job) {
+  this.q.push(job)
+  if (!this.running) this.run()
+}
+
+Queue.prototype.run = function run () {
+  this.running = true
+  const job = this.q.shift()
+  job(() => {
+    if (this.q.length) {
+      this.run()
+    } else {
+      this.running = false
+    }
+  })
+}
+
+module.exports = { now, getOpsSec, print, title, Queue, operations }

lib/router.js

@@ -5,9 +5,8 @@
  * @link https://github.com/alexmingoia/koa-router
  */
 const http = require('node:http');
-const util = require('node:util');
 
-const debug = util.debuglog('koa-router');
+const debug = require('debug')('koa-router');
 
 const compose = require('koa-compose');
 const HttpError = require('http-errors');

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@koa/router",
   "description": "Router middleware for koa. Maintained by Forward Email and Lad.",
-  "version": "13.1.0",
+  "version": "13.1.1",
   "author": "Alex Mingoia <[email protected]>",
   "bugs": {
     "url": "https://github.com/koajs/router/issues",
@@ -21,6 +21,7 @@
     }
   ],
   "dependencies": {
+    "debug": "^4.4.1",
     "http-errors": "^2.0.0",
     "koa-compose": "^4.1.0",
     "path-to-regexp": "^6.3.0"
@@ -29,6 +30,7 @@
     "@commitlint/cli": "^17.7.2",
     "@commitlint/config-conventional": "^17.7.0",
     "@ladjs/env": "^4.0.0",
+    "chalk": "^5.4.1",
     "eslint": "^9.10.0",
     "eslint-config-xo-lass": "^2.0.1",
     "eslint-plugin-unicorn": "55.0.0",
@@ -64,6 +66,7 @@
   },
   "scripts": {
     "bench": "make -C bench",
+    "benchmark": "node bench/run.js",
     "coverage": "nyc npm run test",
     "docs": "NODE_ENV=test jsdoc2md -t ./lib/API_tpl.hbs --src ./lib/*.js  >| API.md",
     "lint": "eslint . && remark . -qfo && fixpack",
@@ -72,4 +75,4 @@
     "test": "mocha test/**/*.js",
     "test:watch": "mocha test/**/*.js --watch"
   }
-}
+}