koa 2.11.0 → 2.13.1

package/History.md

@@ -1,4 +1,59 @@
 
+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
+==================
+
+**features**
+  * [[`0d2f421`](http://github.com/koajs/koa/commit/0d2f421c265350d3d84e1bc261572954479f27d3)] - feat: error handler treat err.statusCode as the same as err.status (#1460) (Vijay Krishnavanshi <<vijaykrishnavanshi@gmail.com>>)
+  * [[`8d52105`](http://github.com/koajs/koa/commit/8d52105a34234be9e771ff3b76b43e4e30328943)] - feat: allow bodyless responses for non empty status codes (#1447) (ejose19 <<8742215+ejose19@users.noreply.github.com>>)
+
+**others**
+  * [[`faeaff5`](http://github.com/koajs/koa/commit/faeaff5c149a81a188ab8e5af0b994029e45acbb)] - fox: remove `error-inject` and fix error handling (#1409) (Konstantin Vyatkin <<tino@vtkn.io>>)
+  * [[`f7c732f`](http://github.com/koajs/koa/commit/f7c732fd06f724505e9090add4d977e667da55a8)] - docs: fixed incorrect onerror example (#1459) (Paul Annekov <<paul.annekov@gmail.com>>)
+  * [[`143d8f7`](http://github.com/koajs/koa/commit/143d8f72f2a232b4c97eac00e7811015911e4f7c)] - Always use strict equality. (#1225) (Yazan Medanat <<medanat@gmail.com>>)
+  * [[`6b6b0dd`](http://github.com/koajs/koa/commit/6b6b0ddf7aff073e65493c6efaffab8331c0331c)] - docs(api): add app.use chainability note (#1449) (Zac Anger <<zac@zacanger.com>>)
+  * [[`8ddab48`](http://github.com/koajs/koa/commit/8ddab48cbdbca1e6d1cc8c3ddae45491db524d51)] - docs: Document response status with empty body (#1445) (Marc-Aurèle DARCHE <<152407+madarche@users.noreply.github.com>>)
+  * [[`7deedb2`](http://github.com/koajs/koa/commit/7deedb235274223f1b9da46dee296545b23598de)] - docs: Updating context.md with the latest cookies opts (#1433) (Brad Ito <<phlogisticfugu@users.noreply.github.com>>)
+  * [[`3e97a10`](http://github.com/koajs/koa/commit/3e97a106bb846d9337737011bb85149ddd797229)] - docs(links): remove Google+ link (#1439) (laffachan <<45162759+laffachan@users.noreply.github.com>>)
+  * [[`eda2760`](http://github.com/koajs/koa/commit/eda27608f7d39ede86d7b402aae64b1867ce31c6)] - build: Drop unused Travis sudo: false directive (#1416) (Olle Jonsson <<olle.jonsson@gmail.com>>)
+
 2.11.0 / 2019-10-28
 ==================
 

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
 
@@ -221,7 +185,6 @@ See [AUTHORS](AUTHORS).
  - [Examples](https://github.com/koajs/examples)
  - [Middleware](https://github.com/koajs/koa/wiki) list
  - [Wiki](https://github.com/koajs/koa/wiki)
- - [G+ Community](https://plus.google.com/communities/101845768320796750641)
  - [Reddit Community](https://www.reddit.com/r/koajs)
  - [Mailing list](https://groups.google.com/forum/#!forum/koajs)
  - [中文文档 v1.x](https://github.com/guo-yu/koa-guide)

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

@@ -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));
-
-    if (404 == err.status || err.expose) return;
+    // 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;
   }
 };
 
@@ -238,6 +253,11 @@ function respond(ctx) {
 
   // status body
   if (null == body) {
+    if (ctx.response._explicitNullBody) {
+      ctx.response.remove('Content-Type');
+      ctx.response.remove('Transfer-Encoding');
+      return res.end();
+    }
     if (ctx.req.httpVersionMajor >= 2) {
       body = String(code);
     } else {
@@ -252,7 +272,7 @@ function respond(ctx) {
 
   // responses
   if (Buffer.isBuffer(body)) return res.end(body);
-  if ('string' == typeof body) return res.end(body);
+  if ('string' === typeof body) return res.end(body);
   if (body instanceof Stream) return body.pipe(res);
 
   // body: json
@@ -267,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) {
@@ -143,16 +149,18 @@ const proto = module.exports = {
     // force text/plain
     this.type = 'text';
 
+    let statusCode = err.status || err.statusCode;
+
     // ENOENT support
-    if ('ENOENT' == err.code) err.status = 404;
+    if ('ENOENT' === err.code) statusCode = 404;
 
     // default to 500
-    if ('number' != typeof err.status || !statuses[err.status]) err.status = 500;
+    if ('number' !== typeof statusCode || !statuses[statusCode]) statusCode = 500;
 
     // respond
-    const code = statuses[err.status];
+    const code = statuses[statusCode];
     const msg = err.expose ? err.message : code;
-    this.status = err.status;
+    this.status = err.status = statusCode;
     this.length = Buffer.byteLength(msg);
     res.end(msg);
   },

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}
@@ -272,7 +272,7 @@ module.exports = {
   get hostname() {
     const host = this.host;
     if (!host) return '';
-    if ('[' == host[0]) return this.URL.hostname || ''; // IPv6
+    if ('[' === host[0]) return this.URL.hostname || ''; // IPv6
     return host.split(':', 1)[0];
   },
 
@@ -311,10 +311,10 @@ module.exports = {
     const s = this.ctx.status;
 
     // GET or HEAD for weak freshness validation only
-    if ('GET' != method && 'HEAD' != method) return false;
+    if ('GET' !== method && 'HEAD' !== method) return false;
 
     // 2xx or 304 as per rfc2616 14.26
-    if ((s >= 200 && s < 300) || 304 == s) {
+    if ((s >= 200 && s < 300) || 304 === s) {
       return fresh(this.header, this.response.header);
     }
 
@@ -382,7 +382,7 @@ module.exports = {
 
   get length() {
     const len = this.get('Content-Length');
-    if (len == '') return;
+    if (len === '') return;
     return ~~len;
   },
 
@@ -406,7 +406,7 @@ module.exports = {
   },
 
   /**
-   * Short-hand for:
+   * Shorthand for:
    *
    *    this.protocol == 'https'
    *
@@ -415,14 +415,14 @@ module.exports = {
    */
 
   get secure() {
-    return 'https' == this.protocol;
+    return 'https' === this.protocol;
   },
 
   /**
    * 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

@@ -6,7 +6,6 @@
  */
 
 const contentDisposition = require('content-disposition');
-const ensureErrorHandler = require('error-inject');
 const getType = require('cache-content-type');
 const onFinish = require('on-finished');
 const escape = require('escape-html');
@@ -139,6 +138,7 @@ module.exports = {
     // no content
     if (null == val) {
       if (!statuses.empty[this.status]) this.status = 204;
+      if (val === null) this._explicitNullBody = true;
       this.remove('Content-Type');
       this.remove('Content-Length');
       this.remove('Transfer-Encoding');
@@ -152,7 +152,7 @@ module.exports = {
     const setType = !this.has('Content-Type');
 
     // string
-    if ('string' == typeof val) {
+    if ('string' === typeof val) {
       if (setType) this.type = /^\s*</.test(val) ? 'html' : 'text';
       this.length = Buffer.byteLength(val);
       return;
@@ -166,12 +166,13 @@ module.exports = {
     }
 
     // stream
-    if ('function' == typeof val.pipe) {
+    if (val instanceof Stream) {
       onFinish(this.res, destroy.bind(null, val));
-      ensureErrorHandler(val, err => this.ctx.onerror(err));
-
-      // overwriting
-      if (null != original && original != val) this.remove('Content-Length');
+      if (original != val) {
+        val.once('error', err => this.ctx.onerror(err));
+        // overwriting
+        if (null != original) this.remove('Content-Length');
+      }
 
       if (setType) this.type = 'bin';
       return;
@@ -257,7 +258,7 @@ module.exports = {
 
   redirect(url, alt) {
     // location
-    if ('back' == url) url = this.ctx.get('Referrer') || alt || '/';
+    if ('back' === url) url = this.ctx.get('Referrer') || alt || '/';
     this.set('Location', encodeUrl(url));
 
     // status
@@ -324,7 +325,7 @@ module.exports = {
    */
 
   set lastModified(val) {
-    if ('string' == typeof val) val = new Date(val);
+    if ('string' === typeof val) val = new Date(val);
     this.set('Last-Modified', val.toUTCString());
   },
 
@@ -432,6 +433,7 @@ module.exports = {
    * @return {boolean}
    * @api public
    */
+
   has(field) {
     return typeof this.res.hasHeader === 'function'
       ? this.res.hasHeader(field)
@@ -440,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:
@@ -457,7 +459,7 @@ module.exports = {
   set(field, val) {
     if (this.headerSent) return;
 
-    if (2 == arguments.length) {
+    if (2 === arguments.length) {
       if (Array.isArray(val)) val = val.map(v => typeof v === 'string' ? v : String(v));
       else if (typeof val !== 'string') val = String(val);
       this.res.setHeader(field, val);
@@ -563,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,23 @@
 {
   "name": "koa",
-  "version": "2.11.0",
+  "version": "2.13.1",
   "description": "Koa web app framework",
   "main": "lib/application.js",
+  "exports": {
+    ".": {
+      "require": "./lib/application.js",
+      "import": "./dist/koa.mjs"
+    },
+    "./": "./"
+  },
   "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"
+    "authors": "git log --format='%aN <%aE>' | sort -u > AUTHORS",
+    "build": "gen-esm-wrapper . ./dist/koa.mjs",
+    "prepare": "npm run build"
   },
   "repository": "koajs/koa",
   "keywords": [
@@ -29,10 +38,9 @@
     "cookies": "~0.8.0",
     "debug": "~3.1.0",
     "delegates": "^1.0.0",
-    "depd": "^1.1.2",
+    "depd": "^2.0.0",
     "destroy": "^1.0.4",
     "encodeurl": "^1.0.2",
-    "error-inject": "^1.0.0",
     "escape-html": "^1.0.3",
     "fresh": "~0.5.2",
     "http-assert": "^1.3.0",
@@ -56,6 +64,7 @@
     "eslint-plugin-node": "^10.0.0",
     "eslint-plugin-promise": "^4.2.1",
     "eslint-plugin-standard": "^4.0.1",
+    "gen-esm-wrapper": "^1.0.6",
     "mm": "^2.5.0",
     "supertest": "^3.1.0"
   },
@@ -63,6 +72,7 @@
     "node": "^4.8.4 || ^6.10.1 || ^7.10.1 || >= 8.1.4"
   },
   "files": [
+    "dist",
     "lib"
   ]
 }