feat: bump deps, translate error messages, fixed tests

titanism · titanism · commit fa8cb81b89fd · 2022-06-02T17:30:26.000-05:00
diff --git a/.commitlintrc.js b/.commitlintrc.js
@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ['@commitlint/config-conventional']
+};
diff --git a/.husky/commit-msg b/.husky/commit-msg
@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname "$0")/_/husky.sh"
+
+yarn commitlint --edit $1
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+yarn lint-staged && yarn test
diff --git a/.lintstagedrc.js b/.lintstagedrc.js
@@ -0,0 +1,5 @@
+module.exports = {
+  "*.md": filenames => filenames.map(filename => `remark ${filename} -qfo`),
+  'package.json': 'fixpack',
+  '*.js': 'xo --fix'
+};
diff --git a/.prettierrc.js b/.prettierrc.js
@@ -0,0 +1,5 @@
+module.exports = {
+  singleQuote: true,
+  bracketSpacing: true,
+  trailingComma: 'none'
+};
diff --git a/.remarkrc.js b/.remarkrc.js
@@ -0,0 +1,3 @@
+module.exports = {
+  plugins: ['preset-github']
+};
diff --git a/.travis.yml b/.travis.yml
@@ -1,8 +1,7 @@
 language: node_js
 node_js:
-  - 10
-  - 12
-script: 
-  - npm run test-ci
-after_script:
-  - npm run coverage
+  - '14'
+  - '16'
+  - '18'
+after_success:
+  npm run coverage
diff --git a/.xo-config.js b/.xo-config.js
@@ -0,0 +1,5 @@
+module.exports = {
+  prettier: true,
+  space: true,
+  extends: ['xo-lass']
+};
diff --git a/index.js b/index.js
@@ -1,15 +1,17 @@
 const fs = require('fs');
 const path = require('path');
+const process = require('process');
+const { Buffer } = require('buffer');
 
-const fastSafeStringify = require('fast-safe-stringify');
 const Boom = require('@hapi/boom');
 const camelCase = require('camelcase');
 const capitalize = require('capitalize');
 const co = require('co');
-const htmlToText = require('html-to-text');
+const fastSafeStringify = require('fast-safe-stringify');
 const humanize = require('humanize-string');
 const statuses = require('statuses');
 const toIdentifier = require('toidentifier');
+const { convert } = require('html-to-text');
 
 // lodash
 const _isError = require('lodash.iserror');
@@ -56,7 +58,7 @@ const opts = {
 const _404 = fs.readFileSync(path.join(__dirname, '404.html'), opts);
 const _500 = fs.readFileSync(path.join(__dirname, '500.html'), opts);
 
-const passportLocalMongooseErrorNames = [
+const passportLocalMongooseErrorNames = new Set([
   'AuthenticationError',
   'MissingPasswordError',
   'AttemptTooSoonError',
@@ -66,7 +68,7 @@ const passportLocalMongooseErrorNames = [
   'IncorrectUsernameError',
   'MissingUsernameError',
   'UserExistsError'
-];
+]);
 
 // initialize try/catch error handling right away
 // adapted from: https://github.com/koajs/onerror/blob/master/index.js
@@ -86,6 +88,20 @@ function errorHandler(
   return async function (err) {
     if (!err) return;
 
+    // nothing we can do here other
+    // than delegate to the app-level
+    // handler and log.
+    if (this.headerSent || !this.writable) {
+      err.headerSent = true;
+      this.app.emit('error', err, this);
+      this.app.emit(
+        'error',
+        new Error('Headers were already sent, returning early'),
+        this
+      );
+      return;
+    }
+
     const logger = useCtxLogger && this.logger ? this.logger : _logger;
 
     if (!_isError(err)) err = new Error(err);
@@ -102,7 +118,7 @@ function errorHandler(
     err = parseValidationError(this, err);
 
     // check if we threw just a status code in order to keep it simple
-    const val = parseInt(err.message, 10);
+    const val = Number.parseInt(err.message, 10);
     if (_isNumber(val) && val >= 400)
       err = Boom[camelCase(toIdentifier(statuses.message[val]))]();
 
@@ -127,15 +143,6 @@ function errorHandler(
     // check if we're about to go into a possible endless redirect loop
     const noReferrer = this.get('Referrer') === '';
 
-    // nothing we can do here other
-    // than delegate to the app-level
-    // handler and log.
-    if (this.headerSent || !this.writable) {
-      logger.error(new Error('Headers were already sent, returning early'));
-      err.headerSent = true;
-      return;
-    }
-
     // 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;
@@ -159,8 +166,13 @@ function errorHandler(
     // fix page title and description
     if (!this.api) {
       this.state.meta = this.state.meta || {};
-      this.state.meta.title = this.body.error;
-      this.state.meta.description = err.message;
+      if (!err.no_translate && _isFunction(this.request.t)) {
+        this.state.meta.title = this.request.t(this.body.error);
+        this.state.meta.description = this.request.t(err.message);
+      } else {
+        this.state.meta.title = this.body.error;
+        this.state.meta.description = err.message;
+      }
     }
 
     switch (type) {
@@ -227,7 +239,7 @@ function errorHandler(
           // <https://github.com/koajs/generic-session/pull/95#issuecomment-246308544>
           //
           // these comments may no longer be valid and need reconsidered:
-          // 
+          //
           // 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(
@@ -261,16 +273,23 @@ function errorHandler(
 }
 
 function makeAPIFriendly(ctx, message) {
-  return !ctx.api
-    ? message
-    : htmlToText.fromString(message, {
+  return ctx.api
+    ? convert(message, {
         wordwrap: false,
-        linkHrefBaseUrl: process.env.ERROR_HANDLER_BASE_URL
-          ? process.env.ERROR_HANDLER_BASE_URL
-          : '',
         hideLinkHrefIfSameAsText: true,
-        ignoreImage: true
-      });
+        selectors: [
+          {
+            selector: 'a',
+            options: {
+              baseUrl: process.env.ERROR_HANDLER_BASE_URL
+                ? process.env.ERROR_HANDLER_BASE_URL
+                : ''
+            }
+          },
+          { selector: 'img', format: 'skip' }
+        ]
+      })
+    : message;
 }
 
 function parseValidationError(ctx, err) {
@@ -281,7 +300,7 @@ function parseValidationError(ctx, err) {
       : message;
 
   // passport-local-mongoose support
-  if (passportLocalMongooseErrorNames.includes(err.name)) {
+  if (passportLocalMongooseErrorNames.has(err.name)) {
     err.message = translate(err.message);
     // this ensures the error shows up client-side
     err.status = 400;
diff --git a/package.json b/package.json
@@ -8,11 +8,6 @@
     "url": "http://niftylettuce.com/"
   },
   "bugs": "https://github.com/ladjs/koa-better-error-handler/issues",
-  "commitlint": {
-    "extends": [
-      "@commitlint/config-conventional"
-    ]
-  },
   "contributors": [
     {
       "name": "Nick Baugh",
@@ -36,13 +31,13 @@
     }
   ],
   "dependencies": {
-    "@hapi/boom": "^9.1.1",
-    "camelcase": "^6.2.0",
-    "capitalize": "^2.0.3",
+    "@hapi/boom": "^10.0.0",
+    "camelcase": "^6.3.0",
+    "capitalize": "^2.0.4",
     "co": "^4.6.0",
-    "fast-safe-stringify": "^2.0.7",
-    "html-to-text": "5",
-    "humanize-string": "^2.1.0",
+    "fast-safe-stringify": "^2.1.1",
+    "html-to-text": "^8.2.0",
+    "humanize-string": "2",
     "lodash.iserror": "^3.1.1",
     "lodash.isfunction": "^3.0.9",
     "lodash.isnumber": "^3.0.3",
@@ -51,45 +46,42 @@
     "lodash.map": "^4.6.0",
     "lodash.values": "^4.3.0",
     "statuses": "^2.0.1",
-    "toidentifier": "^1.0.0"
+    "toidentifier": "^1.0.1"
   },
   "devDependencies": {
-    "@commitlint/cli": "^11.0.0",
-    "@commitlint/config-conventional": "^11.0.0",
-    "@koa/router": "^10.0.0",
-    "ava": "3.11.1",
-    "codecov": "^3.8.1",
+    "@commitlint/cli": "^17.0.2",
+    "@commitlint/config-conventional": "^17.0.2",
+    "@koa/router": "^10.1.1",
+    "ava": "^4.3.0",
+    "codecov": "^3.8.2",
     "cross-env": "^7.0.3",
-    "eslint-config-xo-lass": "^1.0.5",
+    "eslint-config-xo-lass": "^1.0.6",
     "fixpack": "^4.0.0",
-    "husky": "^5.0.9",
-    "koa": "^2.13.1",
-    "koa-404-handler": "^0.0.2",
+    "get-port": "5",
+    "husky": "^8.0.1",
+    "koa": "^2.13.4",
+    "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.1.1",
+    "koa-generic-session": "^2.3.0",
     "koa-redis": "^4.0.1",
-    "lint-staged": "^10.5.4",
-    "lodash": "^4.17.20",
+    "lint-staged": "^13.0.0",
     "nyc": "^15.1.0",
-    "redis": "^3.0.2",
-    "remark-cli": "^9.0.0",
-    "remark-preset-github": "^4.0.1",
+    "redis": "^4.1.0",
+    "remark-cli": "^10.0.1",
+    "remark-preset-github": "^4.0.2",
     "rimraf": "^3.0.2",
-    "supertest": "^6.1.3",
-    "xo": "^0.37.1"
+    "supertest": "^6.2.3",
+    "xo": "^0.49.0"
   },
   "engines": {
-    "node": ">= 10.14"
+    "node": ">= 14"
   },
+  "files": [
+    "index.js"
+  ],
   "homepage": "https://github.com/ladjs/koa-better-error-handler",
-  "husky": {
-    "hooks": {
-      "pre-commit": "lint-staged && npm test",
-      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
-    }
-  },
   "keywords": [
     "404",
     "500",
@@ -114,60 +106,14 @@
     "stripe"
   ],
   "license": "MIT",
-  "lint-staged": {
-    "*.js": [
-      "xo --fix",
-      "git add"
-    ],
-    "*.md": [
-      "remark . -qfo",
-      "git add"
-    ],
-    "package.json": [
-      "fixpack",
-      "git add"
-    ]
-  },
   "main": "index.js",
-  "prettier": {
-    "singleQuote": true,
-    "bracketSpacing": true,
-    "trailingComma": "none"
-  },
-  "remarkConfig": {
-    "plugins": [
-      "preset-github"
-    ]
-  },
   "repository": "ladjs/koa-better-error-handler",
   "scripts": {
-    "coverage": "nyc report --reporter=text-lcov > coverage.lcov",
-    "lint": "npm run lint:js",
-    "lint:js": "xo",
-    "lint:md": "remark . -qfo",
-    "postcoverage": "codecov",
-    "precommit": "lint-staged && npm tes-ci",
-    "pretest-ci": "npm run lint",
-    "pretest-cov": "rimraf .nyc_output",
-    "test": "ava",
-    "test-ci": "npm run test-cov",
-    "test-cov": "cross-env NODE_ENV=test nyc npm run test"
-  },
-  "xo": {
-    "prettier": true,
-    "space": true,
-    "extends": [
-      "xo-lass"
-    ],
-    "ignore": [
-      "examples",
-      "test"
-    ],
-    "rules": {
-      "no-negated-condition": "off",
-      "unicorn/prevent-abbreviations": "off",
-      "unicorn/prefer-number-properties": "off",
-      "unicorn/prefer-set-has": "off"
-    }
+    "coverage": "nyc report --reporter=text-lcov > coverage.lcov && codecov",
+    "lint": "xo && remark . -qfo",
+    "precommit": "lint-staged && npm test",
+    "prepare": "husky install",
+    "test": "npm run lint && npm run test-coverage",
+    "test-coverage": "cross-env NODE_ENV=test nyc ava"
   }
 }
diff --git a/test/test.js b/test/test.js
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+module.exports = {`
	`2`	`+ extends: ['@commitlint/config-conventional']`
	`3`	`+};`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+module.exports = {`
	`2`	`+ plugins: ['preset-github']`
	`3`	`+};`