koa 2.12.0 → 2.13.2

package/History.md

@@ -1,4 +1,66 @@
 
+2.13.2 / 2021-09-24
+==================
+
+**fixes**
+  * [[`04acf02`](http://github.com/koajs/koa/commit/04acf0281a5dcb3fd463d4c8537984c686d0b96f)] - fix: nodejs deprecated api <DEP0148> (#1585) (#1588) (hyj1991 <<yeekwanvong@gmail.com>>)
+
+**others**
+  * [[`3435e78`](http://github.com/koajs/koa/commit/3435e7864a59cca2835ebaad96c4eda801b99b24)] - lint++ (jongleberry <<jonathanrichardong@gmail.com>>)
+  * [[`2cd6618`](http://github.com/koajs/koa/commit/2cd66182f46965f1d824c24826e85df251cca3d2)] - Fix grammar mistake (#1527) (Matheus Souza <<37983247+souzasmatheus@users.noreply.github.com>>)
+  * [[`16ab46e`](http://github.com/koajs/koa/commit/16ab46e9f2b5411fd1c50312ac03719f0a90df61)] - chore: upgrade koa-convert dependency to ^2.0.0 (#1535) (Christian Rodemeyer <<atombrenner@users.noreply.github.com>>)
+  * [[`65113ca`](http://github.com/koajs/koa/commit/65113ca38af634e4b1002d5bc40917cc09a7b7c6)] - Fix jsdoc types for constructor (#1541) (Piotr Kuczynski <<piotr.kuczynski@gmail.com>>)
+  * [[`03e6317`](http://github.com/koajs/koa/commit/03e6317df24d2dce0c1f08869326149f766f1e41)] - :arrow_up: debug (jongleberry <<jonathanrichardong@gmail.com>>)
+  * [[`b37a2d0`](http://github.com/koajs/koa/commit/b37a2d09c137d9a553a0bdf8589b60c7f6425160)] - :arrow_up: eslint dependencies (jongleberry <<jonathanrichardong@gmail.com>>)
+  * [[`4a410cc`](http://github.com/koajs/koa/commit/4a410cc2fbd923868cac6a622f12cc652586abee)] - migrate assert.deepEqual => .deepStrictEqual (jongleberry <<jonathanrichardong@gmail.com>>)
+  * [[`4545b59`](http://github.com/koajs/koa/commit/4545b59aa521e377a4ebb0ccbb8abec01981fbf4)] - test: switch tests to jest (jongleberry <<jonathanrichardong@gmail.com>>)
+  * [[`596cfd5`](http://github.com/koajs/koa/commit/596cfd542ccd1d89d97453e29cf499d49a82e743)] - migrate assert.strict => .strictEqual (jongleberry <<jonathanrichardong@gmail.com>>)
+  * [[`be3e8b6`](http://github.com/koajs/koa/commit/be3e8b68ab58d469f0f450284528dbef32e2d7ba)] - test: switch to github actions (jongleberry <<jonathanrichardong@gmail.com>>)
+  * [[`a2570e3`](http://github.com/koajs/koa/commit/a2570e3ee622cfa5214c2f756ea03b3b7143dbf7)] - package: update bench scripts (jongleberry <<jonathanrichardong@gmail.com>>)
+  * [[`000acf0`](http://github.com/koajs/koa/commit/000acf06ab3e37006569addc8ace5c0a4365daa1)] - npm: enable package-lock (jongleberry <<jonathanrichardong@gmail.com>>)
+  * [[`47fdbca`](http://github.com/koajs/koa/commit/47fdbca8b1c3999c5726f54531f8b47640a65a6f)] - delete benchmarks (jongleberry <<jonathanrichardong@gmail.com>>)
+  * [[`0056f90`](http://github.com/koajs/koa/commit/0056f901e89fd0781067b2c9592fd5909f9ba94a)] - Create dependabot.yml (jongleberry <<jonathanrichardong@gmail.com>>)
+  * [[`698ce0a`](http://github.com/koajs/koa/commit/698ce0afbfac6480400625729a4b8fc4b4203fdc)] - test: fix typo in status.js (Ikko Ashimine <<eltociear@gmail.com>>)
+  * [[`eb51cf5`](http://github.com/koajs/koa/commit/eb51cf5fb35b39592a050b25fd261a574f547cfa)] - doc: app.keys needs to be long enought and random (#1520) (Yiyu He <<dead_horse@qq.com>>)
+
+2.13.1 / 2021-01-04
+==================
+
+**fixes**
+  * [[`b5472f4`](http://github.com/koajs/koa/commit/b5472f4cbb87349becae36b4a9ad5f76a825abb8)] - fix: make ESM transpiled CommonJS play nice for TS folks, fix #1513 (#1518) (miwnwski <<m@iwnw.ski>>)
+  * [[`68d97d6`](http://github.com/koajs/koa/commit/68d97d69e4536065504bf9ef1e348a66b3f35709)] - fix: fixed order of vulnerability disclosure addresses (niftylettuce <<niftylettuce@gmail.com>>)
+
+**others**
+  * [[`b4398f5`](http://github.com/koajs/koa/commit/b4398f5d68f9546167419f394a686afdcb5e10e2)] - correct verb tense in doc (#1512) (Matan Shavit <<71092861+matanshavit@users.noreply.github.com>>)
+  * [[`39e1a5a`](http://github.com/koajs/koa/commit/39e1a5a380aa2bbc4e2d164e8e4bf37cfd512516)] - fixed multiple grammatical errors in docs. (#1497) (Hridayesh Sharma <<vyasriday7@gmail.com>>)
+  * [[`aeb5d19`](http://github.com/koajs/koa/commit/aeb5d1984dcc5f8e3386f8f9724807ae6f3aa1c4)] - docs: added niftylettuce@gmail.com to vulnerability disclosure (niftylettuce <<niftylettuce@gmail.com>>)
+  * [[`6e1093b`](http://github.com/koajs/koa/commit/6e1093be27b41135c8e67fce108743d54e9cab67)] - docs: remove babel from readme (#1494) (miwnwski <<m@iwnw.ski>>)
+  * [[`38cb591`](http://github.com/koajs/koa/commit/38cb591254ff5f65a04e8fb57be293afe697c46e)] - docs: update specific for auto response status (AlbertAZ1992 <<ziyuximing@163.com>>)
+  * [[`2224cd9`](http://github.com/koajs/koa/commit/2224cd9b6a648e7ac2eb27eac332e7d6de7db26c)] -  docs: remove babel ref. (#1488) (Imed Jaberi <<imed_jebari@hotmail.fr>>)
+  * [[`d51f983`](http://github.com/koajs/koa/commit/d51f98328c3b84493cc6bda0732aabb69e20e3a1)] -  docs: fix assert example for response (#1489) (Imed Jaberi <<imed_jebari@hotmail.fr>>)
+  * [[`f8b49b8`](http://github.com/koajs/koa/commit/f8b49b859363ad6c3d9ea5c11ee62341407ceafd)] - chore: fix grammatical and spelling errors in comments and tests (#1490) (Matt Kubej <<mkubej@gmail.com>>)
+  * [[`d1c9263`](http://github.com/koajs/koa/commit/d1c92638c95d799df2fdff5576b96fc43a62813f)] -  deps: update depd  >> v2.0.0 (#1482) (imed jaberi <<imed_jebari@hotmail.fr>>)
+
+2.13.0 / 2020-06-21
+==================
+
+**features**
+  * [[`bbcde76`](http://github.com/koajs/koa/commit/bbcde76f5cb5b67bbcd3201791cf0ef648fd3a8b)] - feat: support esm (#1474) (ZYSzys <<zhangyongsheng@youzan.com>>)
+
+**others**
+  * [[`20e58cf`](http://github.com/koajs/koa/commit/20e58cf3e4f20fc5d5886df1d0ac6dd8c33bd202)] - test: imporve coverage to 100% (dead-horse <<dead_horse@qq.com>>)
+  * [[`4a40d63`](http://github.com/koajs/koa/commit/4a40d633c4b4a203c6656078f9952ccef65c5875)] - build: use prepare instead of prepublish (dead-horse <<dead_horse@qq.com>>)
+  * [[`226ba8c`](http://github.com/koajs/koa/commit/226ba8c8e81e83da48e7bf137be3f146d03f40b8)] - build: use prepublish instead of prepack (dead-horse <<dead_horse@qq.com>>)
+
+2.12.1 / 2020-06-13
+==================
+
+**fixes**
+  * [[`e2030c7`](http://github.com/koajs/koa/commit/e2030c7249c7ae24e28158d8eae405a02fefc9f8)] - fix: Improve checks for Error in onerror handlers (#1468) (Julien Wajsberg <<felash@gmail.com>>)
+
+**others**
+  * [[`5208c5e`](http://github.com/koajs/koa/commit/5208c5e15d35b3653fce6b8ed68d09865abea843)] - chore: Use single console.error() statement in error handler (#1471) (Mike Vosseller <<michael.vosseller@gmail.com>>)
+
 2.12.0 / 2020-05-18
 ==================
 

package/Readme.md

@@ -160,40 +160,6 @@ Learn more about the application object in the [Application API Reference](docs/
  - [FAQ](docs/faq.md)
  - [API documentation](docs/api/index.md)
 
-## Babel setup
-
-If you're not using `node v7.6+`, we recommend setting up `babel` with [`@babel/preset-env`](https://babeljs.io/docs/en/next/babel-preset-env):
-
-```bash
-$ npm install @babel/register @babel/preset-env @babel/cli --save-dev
-```
-
-In development, you'll want to use [`@babel/register`](https://babeljs.io/docs/en/next/babel-register):
-
-```bash
-node --require @babel/register <your-entry-file>
-```
-
-In production, you'll want to build your files with [`@babel/cli`](https://babeljs.io/docs/en/babel-cli). Suppose you are compiling a folder `src` and you wanted the output to go to a new folder `dist` with non-javascript files copied:
-
-```bash
-babel src --out-dir dist --copy-files
-```
-
-And have your `.babelrc` setup:
-
-```json
-{
-  "presets": [
-    ["@babel/preset-env", {
-      "targets": {
-        "node": true
-      }
-    }]
-  ]
-}
-```
-
 ## Troubleshooting
 
 Check the [Troubleshooting Guide](docs/troubleshooting.md) or [Debugging Koa](docs/guide.md#debugging-koa) in
@@ -207,9 +173,7 @@ $ npm test
 
 ## Reporting vulnerabilities
 
-To report a security vulnerability, please do not open an issue, as this notifies attackers
-of the vulnerability. Instead, please email [dead_horse](mailto:heyiyu.deadhorse@gmail.com) and [jonathanong](mailto:me@jongleberry.com) to
-disclose.
+To report a security vulnerability, please do not open an issue, as this notifies attackers of the vulnerability. Instead, please email [dead_horse](mailto:heyiyu.deadhorse@gmail.com), [jonathanong](mailto:me@jongleberry.com), and [niftylettuce](mailto:niftylettuce@gmail.com) to disclose.
 
 ## Authors
 

package/dist/koa.mjs

@@ -0,0 +1,4 @@
+import mod from "../lib/application.js";
+
+export default mod;
+export const HttpError = mod.HttpError;

package/lib/application.js

@@ -41,8 +41,8 @@ module.exports = class Application extends Emitter {
     * @param {string[]} [options.keys] Signed cookie keys
     * @param {boolean} [options.proxy] Trust proxy headers
     * @param {number} [options.subdomainOffset] Subdomain offset
-    * @param {boolean} [options.proxyIpHeader] proxy ip header, default to X-Forwarded-For
-    * @param {boolean} [options.maxIpsCount] max ips read from proxy ip header, default to 0 (means infinity)
+    * @param {string} [options.proxyIpHeader] Proxy IP header, defaults to X-Forwarded-For
+    * @param {number} [options.maxIpsCount] Max IPs read from proxy IP header, default to 0 (means infinity)
     *
     */
 
@@ -59,6 +59,8 @@ module.exports = class Application extends Emitter {
     this.context = Object.create(context);
     this.request = Object.create(request);
     this.response = Object.create(response);
+    // util.inspect.custom support for node 6+
+    /* istanbul ignore else */
     if (util.inspect.custom) {
       this[util.inspect.custom] = this.inspect;
     }
@@ -195,15 +197,28 @@ module.exports = class Application extends Emitter {
    */
 
   onerror(err) {
-    if (!(err instanceof Error)) throw new TypeError(util.format('non-error thrown: %j', err));
+    // When dealing with cross-globals a normal `instanceof` check doesn't work properly.
+    // See https://github.com/koajs/koa/issues/1466
+    // We can probably remove it once jest fixes https://github.com/facebook/jest/issues/2549.
+    const isNativeError =
+      Object.prototype.toString.call(err) === '[object Error]' ||
+      err instanceof Error;
+    if (!isNativeError) throw new TypeError(util.format('non-error thrown: %j', err));
 
     if (404 === err.status || err.expose) return;
     if (this.silent) return;
 
     const msg = err.stack || err.toString();
-    console.error();
-    console.error(msg.replace(/^/gm, '  '));
-    console.error();
+    console.error(`\n${msg.replace(/^/gm, '  ')}\n`);
+  }
+
+  /**
+   * Help TS users comply to CommonJS, ESM, bundler mismatch.
+   * @see https://github.com/koajs/koa/issues/1513
+   */
+
+  static get default() {
+    return Application;
   }
 };
 
@@ -272,4 +287,5 @@ function respond(ctx) {
  * Make HttpError available to consumers of the library so that consumers don't
  * have a direct dependency upon `http-errors`
  */
+
 module.exports.HttpError = HttpError;

package/lib/context.js

@@ -110,7 +110,13 @@ const proto = module.exports = {
     // to node-style callbacks.
     if (null == err) return;
 
-    if (!(err instanceof Error)) err = new Error(util.format('non-error thrown: %j', err));
+    // When dealing with cross-globals a normal `instanceof` check doesn't work properly.
+    // See https://github.com/koajs/koa/issues/1466
+    // We can probably remove it once jest fixes https://github.com/facebook/jest/issues/2549.
+    const isNativeError =
+      Object.prototype.toString.call(err) === '[object Error]' ||
+      err instanceof Error;
+    if (!isNativeError) err = new Error(util.format('non-error thrown: %j', err));
 
     let headerSent = false;
     if (this.headerSent || !this.writable) {

package/lib/request.js

@@ -146,7 +146,7 @@ module.exports = {
   },
 
   /**
-   * Set pathname, retaining the query-string when present.
+   * Set pathname, retaining the query string when present.
    *
    * @param {String} path
    * @api public
@@ -163,7 +163,7 @@ module.exports = {
   },
 
   /**
-   * Get parsed query-string.
+   * Get parsed query string.
    *
    * @return {Object}
    * @api public
@@ -176,7 +176,7 @@ module.exports = {
   },
 
   /**
-   * Set query-string as an object.
+   * Set query string as an object.
    *
    * @param {Object} obj
    * @api public
@@ -199,7 +199,7 @@ module.exports = {
   },
 
   /**
-   * Set querystring.
+   * Set query string.
    *
    * @param {String} str
    * @api public
@@ -216,7 +216,7 @@ module.exports = {
   },
 
   /**
-   * Get the search string. Same as the querystring
+   * Get the search string. Same as the query string
    * except it includes the leading ?.
    *
    * @return {String}
@@ -406,7 +406,7 @@ module.exports = {
   },
 
   /**
-   * Short-hand for:
+   * Shorthand for:
    *
    *    this.protocol == 'https'
    *
@@ -422,7 +422,7 @@ module.exports = {
    * When `app.proxy` is `true`, parse
    * the "X-Forwarded-For" ip address list.
    *
-   * For example if the value were "client, proxy1, proxy2"
+   * For example if the value was "client, proxy1, proxy2"
    * you would receive the array `["client", "proxy1", "proxy2"]`
    * where "proxy2" is the furthest down-stream.
    *
@@ -495,6 +495,7 @@ module.exports = {
    * @return {Object}
    * @api private
    */
+
   get accept() {
     return this._accept || (this._accept = accepts(this.req));
   },
@@ -505,6 +506,7 @@ module.exports = {
    * @param {Object}
    * @api private
    */
+
   set accept(obj) {
     this._accept = obj;
   },
@@ -607,7 +609,7 @@ module.exports = {
 
   /**
    * Check if the incoming request contains the "Content-Type"
-   * header field, and it contains any of the give mime `type`s.
+   * header field and if it contains any of the given mime `type`s.
    * If there is no request body, `null` is returned.
    * If there is no content type, `false` is returned.
    * Otherwise, it returns the first `type` that matches.

package/lib/response.js

@@ -433,6 +433,7 @@ module.exports = {
    * @return {boolean}
    * @api public
    */
+
   has(field) {
     return typeof this.res.hasHeader === 'function'
       ? this.res.hasHeader(field)
@@ -441,7 +442,7 @@ module.exports = {
   },
 
   /**
-   * Set header `field` to `val`, or pass
+   * Set header `field` to `val` or pass
    * an object of header fields.
    *
    * Examples:
@@ -564,19 +565,22 @@ module.exports = {
   },
 
   /**
-   * Flush any set headers, and begin the body
+   * Flush any set headers and begin the body
    */
+
   flushHeaders() {
     this.res.flushHeaders();
   }
 };
 
 /**
- * Custom inspection implementation for newer Node.js versions.
+ * Custom inspection implementation for node 6+.
  *
  * @return {Object}
  * @api public
  */
+
+/* istanbul ignore else */
 if (util.inspect.custom) {
   module.exports[util.inspect.custom] = module.exports.inspect;
 }

package/package.json

@@ -1,14 +1,24 @@
 {
   "name": "koa",
-  "version": "2.12.0",
+  "version": "2.13.2",
   "description": "Koa web app framework",
   "main": "lib/application.js",
+  "exports": {
+    ".": {
+      "require": "./lib/application.js",
+      "import": "./dist/koa.mjs"
+    },
+    "./*": "./*.js",
+    "./*.js": "./*.js",
+    "./package": "./package.json",
+    "./package.json": "./package.json"
+  },
   "scripts": {
-    "test": "egg-bin test test",
-    "test-cov": "egg-bin cov test",
-    "lint": "eslint benchmarks lib test",
-    "bench": "make -C benchmarks",
-    "authors": "git log --format='%aN <%aE>' | sort -u > AUTHORS"
+    "test": "jest --forceExit",
+    "lint": "eslint --ignore-path .gitignore .",
+    "authors": "git log --format='%aN <%aE>' | sort -u > AUTHORS",
+    "build": "gen-esm-wrapper . ./dist/koa.mjs",
+    "prepare": "npm run build"
   },
   "repository": "koajs/koa",
   "keywords": [
@@ -27,9 +37,9 @@
     "content-disposition": "~0.5.2",
     "content-type": "^1.0.4",
     "cookies": "~0.8.0",
-    "debug": "~3.1.0",
+    "debug": "^4.3.2",
     "delegates": "^1.0.0",
-    "depd": "^1.1.2",
+    "depd": "^2.0.0",
     "destroy": "^1.0.4",
     "encodeurl": "^1.0.2",
     "escape-html": "^1.0.3",
@@ -38,7 +48,7 @@
     "http-errors": "^1.6.3",
     "is-generator-function": "^1.0.7",
     "koa-compose": "^4.1.0",
-    "koa-convert": "^1.2.0",
+    "koa-convert": "^2.0.0",
     "on-finished": "^2.3.0",
     "only": "~0.0.2",
     "parseurl": "^1.3.2",
@@ -47,21 +57,25 @@
     "vary": "^1.1.2"
   },
   "devDependencies": {
-    "egg-bin": "^4.13.0",
-    "eslint": "^6.5.1",
+    "eslint": "^7.32.0",
     "eslint-config-koa": "^2.0.0",
-    "eslint-config-standard": "^14.1.0",
+    "eslint-config-standard": "^16.0.3",
     "eslint-plugin-import": "^2.18.2",
-    "eslint-plugin-node": "^10.0.0",
-    "eslint-plugin-promise": "^4.2.1",
-    "eslint-plugin-standard": "^4.0.1",
-    "mm": "^2.5.0",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-promise": "^5.1.0",
+    "eslint-plugin-standard": "^5.0.0",
+    "gen-esm-wrapper": "^1.0.6",
+    "jest": "^27.0.6",
     "supertest": "^3.1.0"
   },
   "engines": {
     "node": "^4.8.4 || ^6.10.1 || ^7.10.1 || >= 8.1.4"
   },
   "files": [
+    "dist",
     "lib"
-  ]
+  ],
+  "jest": {
+    "testEnvironment": "node"
+  }
 }