feat: update to Node.js 18+, fix status code reporting, replace AVA with native test runner

titanism · titanism · commit adc233c80e34 · 2026-01-02T12:51:54.000-06:00
BREAKING CHANGES:
- Minimum Node.js version is now 18
- Removed lodash dependencies (replaced with native JS)
- Removed co dependency (replaced with native Promises)

Fixes:
- Status code is now correctly set before emitting error events, fixing
  incorrect status code reporting in logs (e.g., Boom.unauthorized() now
  correctly reports 401 instead of 500)
- Status code determination moved before headerSent early return to ensure
  all error paths have correct status codes

Changes:
- Replace AVA with Node.js native test runner
- Replace camelcase v8 (ESM) with v6 (CommonJS) for compatibility
- Replace humanize-string v3 (ESM) with v2 (CommonJS) for compatibility
- Replace co with native Promise wrappers for session store callbacks
- Replace lodash.iserror, lodash.isfunction, lodash.isnumber,
  lodash.isobject, lodash.isstring, lodash.map, lodash.values with
  native JavaScript equivalents
- Update GitHub CI to test Node.js 18, 20, 22, 24
- Update actions/checkout and actions/setup-node to v4
- Update husky to v9 (new pre-commit hook format)
- Update devDependencies: @commitlint/cli, @commitlint/config-conventional,
  @koa/router, mongoose, mongodb, lint-staged, xo, and others
- Replace nyc with c8 for code coverage
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -10,14 +10,15 @@ jobs:
         os:
           - ubuntu-latest
         node_version:
-          - 14
-          - 16
           - 18
+          - 20
+          - 22
+          - 24
     name: Node ${{ matrix.node_version }} on ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Setup node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node_version }}
       - name: Install dependencies
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -1,4 +1 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
 npx --no-install lint-staged && npm test
diff --git a/.xo-config.js b/.xo-config.js
@@ -1,5 +1,13 @@
 module.exports = {
   prettier: true,
   space: true,
-  extends: ['xo-lass']
+  extends: ['xo-lass'],
+  overrides: [
+    {
+      files: 'test/**/*.js',
+      rules: {
+        'n/no-unsupported-features/node-builtins': 'off'
+      }
+    }
+  ]
 };
diff --git a/examples/api.js b/examples/api.js
@@ -1,7 +1,6 @@
 const Koa = require('koa');
 const Router = require('koa-router');
 const koa404Handler = require('koa-404-handler');
-
 const errorHandler = require('..');
 
 // initialize our app
diff --git a/examples/web-app.js b/examples/web-app.js
@@ -6,7 +6,6 @@ const flash = require('koa-connect-flash');
 const convert = require('koa-convert');
 const Router = require('koa-router');
 const koa404Handler = require('koa-404-handler');
-
 const errorHandler = require('..');
 
 // initialize our app
diff --git a/index.js b/index.js
@@ -2,8 +2,6 @@ const fs = require('node:fs');
 const path = require('node:path');
 const process = require('node:process');
 const { Buffer } = require('node:buffer');
-
-const co = require('co');
 const Boom = require('@hapi/boom');
 const camelCase = require('camelcase');
 const capitalize = require('capitalize');
@@ -13,15 +11,6 @@ const statuses = require('statuses');
 const toIdentifier = require('toidentifier');
 const { convert } = require('html-to-text');
 
-// lodash
-const _isError = require('lodash.iserror');
-const _isFunction = require('lodash.isfunction');
-const _isNumber = require('lodash.isnumber');
-const _isObject = require('lodash.isobject');
-const _isString = require('lodash.isstring');
-const _map = require('lodash.map');
-const _values = require('lodash.values');
-
 // <https://github.com/nodejs/node/blob/08dd4b1723b20d56fbedf37d52e736fe09715f80/lib/dns.js#L296-L320>
 const DNS_RETRY_CODES = new Set([
   'EADDRGETNETWORKPARAMS',
@@ -54,6 +43,33 @@ const opts = {
   encoding: 'utf8'
 };
 
+// Helper functions to replace lodash dependencies
+function isError(value) {
+  return (
+    value instanceof Error ||
+    (typeof value === 'object' &&
+      value !== null &&
+      typeof value.message === 'string' &&
+      typeof value.name === 'string')
+  );
+}
+
+function isFunction(value) {
+  return typeof value === 'function';
+}
+
+function isNumber(value) {
+  return typeof value === 'number' && !Number.isNaN(value);
+}
+
+function isObject(value) {
+  return value !== null && typeof value === 'object';
+}
+
+function isString(value) {
+  return typeof value === 'string';
+}
+
 function isErrorConstructorName(err, name) {
   const names = [];
 
@@ -130,18 +146,34 @@ function errorHandler(
     try {
       if (!err) return;
 
-      this.app.emit('error', err, this);
+      if (!isError(err)) err = new Error(err);
+
+      // check if we have a boom error that specified
+      // a status code already for us (and then use it)
+      if (isObject(err.output) && isNumber(err.output.statusCode)) {
+        err.status = err.output.statusCode;
+      } else if (isString(err.code) && DNS_RETRY_CODES.has(err.code)) {
+        // check if this was a DNS error and if so
+        // then set status code for retries appropriately
+        err.status = 408;
+      }
+
+      if (!isNumber(err.status)) err.status = 500;
+
+      // set err.statusCode for consistency
+      err.statusCode = err.status;
 
       // nothing we can do here other
       // than delegate to the app-level
       // handler and log.
-      if (this.headerSent || !this.writable) return;
+      if (this.headerSent || !this.writable) {
+        this.app.emit('error', err, this);
+        return;
+      }
 
       // translate messages
       const translate = (message) =>
-        _isFunction(this.request.t) ? this.request.t(message) : message;
-
-      if (!_isError(err)) err = new Error(err);
+        isFunction(this.request.t) ? this.request.t(message) : message;
 
       const type = this.accepts(['text', 'json', 'html']);
 
@@ -151,7 +183,7 @@ function errorHandler(
       }
 
       const val = Number.parseInt(err.message, 10);
-      if (_isNumber(val) && val >= 400 && val < 600) {
+      if (isNumber(val) && val >= 400 && val < 600) {
         // check if we threw just a status code in order to keep it simple
         err = Boom[camelCase(toIdentifier(statuses.message[val]))]();
         err.message = translate(err.message);
@@ -209,32 +241,22 @@ function errorHandler(
         err.message = translate(Boom.internal().output.payload.message);
       }
 
-      // check if we have a boom error that specified
-      // a status code already for us (and then use it)
-      if (_isObject(err.output) && _isNumber(err.output.statusCode)) {
-        err.status = err.output.statusCode;
-      } else if (_isString(err.code) && DNS_RETRY_CODES.has(err.code)) {
-        // check if this was a DNS error and if so
-        // then set status code for retries appropriately
-        err.status = 408;
-        err.message = translate(Boom.clientTimeout().output.payload.message);
-      }
+      // finalize status code after all error type checks
+      err.status ||= 500;
+      err.statusCode = err.status;
 
-      if (!_isNumber(err.status)) err.status = 500;
+      // emit error event AFTER status code has been determined
+      // so that error listeners (e.g. loggers) have access to the correct status
+      this.app.emit('error', err, this);
 
       // check if there is flash messaging
-      const hasFlash = _isFunction(this.flash);
+      const hasFlash = isFunction(this.flash);
 
       // check if there is a view rendering engine binding `this.render`
-      const hasRender = _isFunction(this.render);
+      const hasRender = isFunction(this.render);
 
       // check if we're about to go into a possible endless redirect loop
       const noReferrer = this.get('Referrer') === '';
-
-      // populate the status and body with `boom` error message payload
-      // (e.g. you can do `ctx.throw(404)` and it will output a beautiful err obj)
-      err.status = err.status || 500;
-      err.statusCode = err.status;
       this.statusCode = err.statusCode;
       this.status = this.statusCode;
 
@@ -246,7 +268,7 @@ function errorHandler(
 
       // set any additional error headers specified
       // (e.g. for BasicAuth we use `basic-auth` which specifies WWW-Authenticate)
-      if (_isObject(err.headers) && Object.keys(err.headers).length > 0)
+      if (isObject(err.headers) && Object.keys(err.headers).length > 0)
         this.set(err.headers);
 
       // fix page title and description
@@ -304,9 +326,12 @@ function errorHandler(
               cookiesKey
             ) {
               try {
-                await co
-                  .wrap(this.sessionStore.set)
-                  .call(this.sessionStore, this.sessionId, this.session);
+                await new Promise((resolve, reject) => {
+                  this.sessionStore.set(this.sessionId, this.session, (err) => {
+                    if (err) reject(err);
+                    else resolve();
+                  });
+                });
                 this.cookies.set(
                   cookiesKey,
                   this.sessionId,
@@ -326,11 +351,16 @@ function errorHandler(
             //
             // if we're using `koa-session-store` we need to add
             // `this._session = new Session()`, and then run this:
-            await co.wrap(this._session._store.save).call(
-              this._session._store,
-              this._session._sid,
-              stringify(this.session)
-            );
+            await new Promise((resolve, reject) => {
+              this._session._store.save(
+                this._session._sid,
+                stringify(this.session),
+                (err) => {
+                  if (err) reject(err);
+                  else resolve();
+                }
+              );
+            });
             this.cookies.set(this._session._name, stringify({
               _sid: this._session._sid
             }), this._session._cookieOpts);
@@ -391,28 +421,31 @@ function makeAPIFriendly(ctx, message) {
 function parseValidationError(ctx, err, translate) {
   // transform the error messages to be humanized as adapted from:
   // https://github.com/niftylettuce/mongoose-validation-error-transform
-  err.errors = _map(err.errors, (error) => {
-    if (!_isString(error.path)) {
-      error.message = capitalize(error.message);
-      return error;
-    }
+  err.errors = Object.fromEntries(
+    Object.entries(err.errors).map(([key, error]) => {
+      if (!isString(error.path)) {
+        error.message = capitalize(error.message);
+        return [key, error];
+      }
 
-    error.message = error.message.replace(
-      new RegExp(error.path, 'g'),
-      humanize(error.path)
-    );
-    error.message = capitalize(error.message);
-    return error;
-  });
+      error.message = error.message.replaceAll(
+        new RegExp(error.path, 'g'),
+        humanize(error.path)
+      );
+      error.message = capitalize(error.message);
+      return [key, error];
+    })
+  );
 
   // loop over the errors object of the Validation Error
   // with support for HTML error lists
-  if (_values(err.errors).length === 1) {
-    err.message = _values(err.errors)[0].message;
+  const errorValues = Object.values(err.errors);
+  if (errorValues.length === 1) {
+    err.message = errorValues[0].message;
     if (!err.no_translate) err.message = translate(err.message);
   } else {
-    const errors = _map(_map(_values(err.errors), 'message'), (message) =>
-      err.no_translate ? message : translate(message)
+    const errors = errorValues.map((error) =>
+      err.no_translate ? error.message : translate(error.message)
     );
     err.message = makeAPIFriendly(
       ctx,
diff --git a/package.json b/package.json
@@ -31,54 +31,44 @@
     }
   ],
   "dependencies": {
-    "@hapi/boom": "^10.0.0",
+    "@hapi/boom": "^10.0.1",
     "camelcase": "6",
     "capitalize": "^2.0.4",
-    "co": "^4.6.0",
     "fast-safe-stringify": "^2.1.1",
-    "html-to-text": "^9.0.3",
+    "html-to-text": "^9.0.5",
     "humanize-string": "2",
-    "lodash.iserror": "^3.1.1",
-    "lodash.isfunction": "^3.0.9",
-    "lodash.isnumber": "^3.0.3",
-    "lodash.isobject": "^3.0.2",
-    "lodash.isstring": "^4.0.1",
-    "lodash.map": "^4.6.0",
-    "lodash.values": "^4.3.0",
     "statuses": "^2.0.1",
     "toidentifier": "^1.0.1"
   },
   "devDependencies": {
-    "@commitlint/cli": "^17.4.2",
-    "@commitlint/config-conventional": "^17.4.2",
-    "@koa/router": "^12.0.0",
-    "ava": "^5.1.1",
+    "@commitlint/cli": "^19.8.1",
+    "@commitlint/config-conventional": "^19.8.1",
+    "@koa/router": "^13.1.0",
+    "c8": "^10.1.3",
     "cross-env": "^7.0.3",
     "eslint-config-xo-lass": "^2.0.1",
     "fixpack": "^4.0.0",
-    "get-port": "5",
-    "husky": "^8.0.3",
-    "koa": "^2.14.1",
+    "get-port": "^7.1.0",
+    "husky": "^9.1.7",
+    "koa": "^2.16.3",
     "koa-404-handler": "^0.1.0",
     "koa-basic-auth": "^4.0.0",
     "koa-connect-flash": "^0.1.2",
     "koa-convert": "^2.0.0",
-    "koa-generic-session": "^2.3.0",
+    "koa-generic-session": "^2.3.1",
     "koa-redis": "^4.0.1",
-    "lint-staged": "^13.1.0",
-    "mongodb": "^4.13.0",
-    "mongoose": "^6.8.4",
-    "nyc": "^15.1.0",
-    "redis": "^4.5.1",
+    "lint-staged": "^15.5.2",
+    "mongodb": "^6.16.0",
+    "mongoose": "^8.15.1",
+    "redis": "^5.10.0",
     "redis-errors": "^1.2.0",
-    "remark-cli": "^11.0.0",
+    "remark-cli": "^12.0.1",
     "remark-preset-github": "^4.0.4",
-    "rimraf": "^4.1.1",
-    "supertest": "^6.3.3",
-    "xo": "^0.53.1"
+    "supertest": "^7.1.0",
+    "xo": "^0.60.0"
   },
   "engines": {
-    "node": ">= 14"
+    "node": ">= 18"
   },
   "files": [
     "404.html",
@@ -113,9 +103,9 @@
   "main": "index.js",
   "repository": "ladjs/koa-better-error-handler",
   "scripts": {
-    "lint": "xo --fix && remark . -qfo && fixpack",
-    "prepare": "husky install",
+    "lint": "xo --fix && fixpack",
+    "prepare": "husky",
     "pretest": "npm run lint",
-    "test": "cross-env NODE_ENV=test nyc ava"
+    "test": "cross-env NODE_ENV=test c8 node --test test/test.js"
   }
 }
diff --git a/test/test.js b/test/test.js
