koa 2.5.1 → 2.6.1

package/History.md

@@ -1,4 +1,48 @@
 
+2.6.1 / 2018-10-23
+==================
+
+**fixes**
+  * [[`4964242`](http://github.com/koajs/koa/commit/49642428342e5f291eb9d690802e83ed830623b5)] - fix: use X-Forwarded-Host first on app.proxy present (#1263) (fengmk2 <<fengmk2@gmail.com>>)
+
+2.6.0 / 2018-10-23
+==================
+
+**features**
+  * [[`9c5c58b`](http://github.com/koajs/koa/commit/9c5c58b18363494976185e7ddc790ac63de840ed)] - feat: use :authority header of http2 requests as host (#1262) (Martin Michaelis <<code@mgjm.de>>)
+  * [[`9146024`](http://github.com/koajs/koa/commit/9146024e1094e8bb871ab15d1b7fc556a710732f)] - feat: response.attachment append a parameter: options from contentDisposition (#1240) (小雷 <<863837949@qq.com>>)
+
+**others**
+  * [[`d32623b`](http://github.com/koajs/koa/commit/d32623baa7a6273d47be67d587ad4ea0ecffc5de)] - docs: Update error-handling.md (#1239) (urugator <<j.placek@centrum.cz>>)
+
+2.5.3 / 2018-09-11
+==================
+
+**fixes**
+  * [[`2ee32f5`](http://github.com/koajs/koa/commit/2ee32f50b88b383317e33cc0a4bfaa5f2eadead7)] - fix: pin debug@~3.1.0 avoid deprecated warnning (#1245) (fengmk2 <<fengmk2@gmail.com>>)
+
+**others**
+  * [[`2180839`](http://github.com/koajs/koa/commit/2180839eda2cb16edcfda46ccfe24711680af850)] - docs: Update koa-vs-express.md (#1230) (Clayton Ray <<iamclaytonray@gmail.com>>)
+
+2.5.2 / 2018-07-12
+==================
+
+  * deps: upgrade all dependencies
+  * perf: avoid stringify when set header (#1220)
+  * perf: cache content type's result (#1218)
+  * perf: lazy init cookies and ip when first time use it (#1216)
+  * chore: fix comment & approve cov (#1214)
+  * docs: fix grammar
+  * test&cov: add test case (#1211)
+  * Lazily initialize `request.accept` and delegate `context.accept` (#1209)
+  * fix: use non deprecated custom inspect (#1198)
+  * Simplify processes in the getter `request.protocol` (#1203)
+  * docs: better demonstrate middleware flow (#1195)
+  * fix: Throw a TypeError instead of a AssertionError (#1199)
+  * chore: mistake in a comment (#1201)
+  * chore: use this.res.socket insteadof this.ctx.req.socket (#1177)
+  * chore: Using "listenerCount" instead of "listeners" (#1184)
+
 2.5.1 / 2018-04-27
 ==================
 

package/lib/application.js

@@ -14,10 +14,8 @@ const isJSON = require('koa-is-json');
 const context = require('./context');
 const request = require('./request');
 const statuses = require('statuses');
-const Cookies = require('cookies');
-const accepts = require('accepts');
 const Emitter = require('events');
-const assert = require('assert');
+const util = require('util');
 const Stream = require('stream');
 const http = require('http');
 const only = require('only');
@@ -46,6 +44,9 @@ module.exports = class Application extends Emitter {
     this.context = Object.create(context);
     this.request = Object.create(request);
     this.response = Object.create(response);
+    if (util.inspect.custom) {
+      this[util.inspect.custom] = this.inspect;
+    }
   }
 
   /**
@@ -125,7 +126,7 @@ module.exports = class Application extends Emitter {
   callback() {
     const fn = compose(this.middleware);
 
-    if (!this.listeners('error').length) this.on('error', this.onerror);
+    if (!this.listenerCount('error')) this.on('error', this.onerror);
 
     const handleRequest = (req, res) => {
       const ctx = this.createContext(req, res);
@@ -167,12 +168,6 @@ module.exports = class Application extends Emitter {
     request.response = response;
     response.request = request;
     context.originalUrl = request.originalUrl = req.url;
-    context.cookies = new Cookies(req, res, {
-      keys: this.keys,
-      secure: request.secure
-    });
-    request.ip = request.ips[0] || req.socket.remoteAddress || '';
-    context.accept = request.accept = accepts(req);
     context.state = {};
     return context;
   }
@@ -185,7 +180,7 @@ module.exports = class Application extends Emitter {
    */
 
   onerror(err) {
-    assert(err instanceof Error, `non-error thrown: ${err}`);
+    if (!(err instanceof Error)) throw new TypeError(util.format('non-error thrown: %j', err));
 
     if (404 == err.status || err.expose) return;
     if (this.silent) return;

package/lib/context.js

@@ -10,6 +10,9 @@ const createError = require('http-errors');
 const httpAssert = require('http-assert');
 const delegate = require('delegates');
 const statuses = require('statuses');
+const Cookies = require('cookies');
+
+const COOKIES = Symbol('context#cookies');
 
 /**
  * Context prototype.
@@ -126,6 +129,7 @@ const proto = module.exports = {
     const { res } = this;
 
     // first unset all headers
+    /* istanbul ignore else */
     if (typeof res.getHeaderNames === 'function') {
       res.getHeaderNames().forEach(name => res.removeHeader(name));
     } else {
@@ -150,9 +154,35 @@ const proto = module.exports = {
     this.status = err.status;
     this.length = Buffer.byteLength(msg);
     this.res.end(msg);
+  },
+
+  get cookies() {
+    if (!this[COOKIES]) {
+      this[COOKIES] = new Cookies(this.req, this.res, {
+        keys: this.app.keys,
+        secure: this.request.secure
+      });
+    }
+    return this[COOKIES];
+  },
+
+  set cookies(_cookies) {
+    this[COOKIES] = _cookies;
   }
 };
 
+/**
+ * Custom inspection implementation for newer Node.js versions.
+ *
+ * @return {Object}
+ * @api public
+ */
+
+/* istanbul ignore else */
+if (util.inspect.custom) {
+  module.exports[util.inspect.custom] = module.exports.inspect;
+}
+
 /**
  * Response delegation.
  */
@@ -194,6 +224,7 @@ delegate(proto, 'request')
   .access('query')
   .access('path')
   .access('url')
+  .access('accept')
   .getter('origin')
   .getter('href')
   .getter('subdomains')

package/lib/request.js

@@ -7,6 +7,7 @@
 
 const URL = require('url').URL;
 const net = require('net');
+const accepts = require('accepts');
 const contentType = require('content-type');
 const stringify = require('url').format;
 const parse = require('parseurl');
@@ -14,6 +15,9 @@ const qs = require('querystring');
 const typeis = require('type-is');
 const fresh = require('fresh');
 const only = require('only');
+const util = require('util');
+
+const IP = Symbol('context#ip');
 
 /**
  * Prototype.
@@ -226,7 +230,7 @@ module.exports = {
 
   /**
    * Set the search string. Same as
-   * response.querystring= but included for ubiquity.
+   * request.querystring= but included for ubiquity.
    *
    * @param {String} str
    * @api public
@@ -248,7 +252,10 @@ module.exports = {
   get host() {
     const proxy = this.app.proxy;
     let host = proxy && this.get('X-Forwarded-Host');
-    host = host || this.get('Host');
+    if (!host) {
+      if (this.req.httpVersionMajor >= 2) host = this.get(':authority');
+      if (!host) host = this.get('Host');
+    }
     if (!host) return '';
     return host.split(/\s*,\s*/)[0];
   },
@@ -278,6 +285,7 @@ module.exports = {
    */
 
   get URL() {
+    /* istanbul ignore else */
     if (!this.memoizedURL) {
       const protocol = this.protocol;
       const host = this.host;
@@ -397,11 +405,10 @@ module.exports = {
    */
 
   get protocol() {
-    const proxy = this.app.proxy;
     if (this.socket.encrypted) return 'https';
-    if (!proxy) return 'http';
-    const proto = this.get('X-Forwarded-Proto') || 'http';
-    return proto.split(/\s*,\s*/)[0];
+    if (!this.app.proxy) return 'http';
+    const proto = this.get('X-Forwarded-Proto');
+    return proto ? proto.split(/\s*,\s*/)[0] : 'http';
   },
 
   /**
@@ -437,6 +444,26 @@ module.exports = {
       : [];
   },
 
+  /**
+   * Return request's remote address
+   * When `app.proxy` is `true`, parse
+   * the "X-Forwarded-For" ip address list and return the first one
+   *
+   * @return {String}
+   * @api public
+   */
+
+  get ip() {
+    if (!this[IP]) {
+      this[IP] = this.ips[0] || this.socket.remoteAddress || '';
+    }
+    return this[IP];
+  },
+
+  set ip(_ip) {
+    this[IP] = _ip;
+  },
+
   /**
    * Return subdomains as an array.
    *
@@ -463,6 +490,27 @@ module.exports = {
       .slice(offset);
   },
 
+  /**
+   * Get accept object.
+   * Lazily memoized.
+   *
+   * @return {Object}
+   * @api private
+   */
+  get accept() {
+    return this._accept || (this._accept = accepts(this.req));
+  },
+
+  /**
+   * Set accept object.
+   *
+   * @param {Object}
+   * @api private
+   */
+  set accept(obj) {
+    return this._accept = obj;
+  },
+
   /**
    * Check if the given `type(s)` is acceptable, returning
    * the best match when true, otherwise `false`, in which
@@ -620,7 +668,7 @@ module.exports = {
    *     // => "text/plain"
    *
    *     this.get('Something');
-   *     // => undefined
+   *     // => ''
    *
    * @param {String} field
    * @return {String}
@@ -665,3 +713,15 @@ module.exports = {
     ]);
   }
 };
+
+/**
+ * Custom inspection implementation for newer Node.js versions.
+ *
+ * @return {Object}
+ * @api public
+ */
+
+/* istanbul ignore else */
+if (util.inspect.custom) {
+  module.exports[util.inspect.custom] = module.exports.inspect;
+}

package/lib/response.js

@@ -7,7 +7,7 @@
 
 const contentDisposition = require('content-disposition');
 const ensureErrorHandler = require('error-inject');
-const getType = require('mime-types').contentType;
+const getType = require('cache-content-type');
 const onFinish = require('on-finished');
 const isJSON = require('koa-is-json');
 const escape = require('escape-html');
@@ -18,6 +18,7 @@ const assert = require('assert');
 const extname = require('path').extname;
 const vary = require('vary');
 const only = require('only');
+const util = require('util');
 
 /**
  * Prototype.
@@ -33,7 +34,7 @@ module.exports = {
    */
 
   get socket() {
-    return this.ctx.req.socket;
+    return this.res.socket;
   },
 
   /**
@@ -284,9 +285,9 @@ module.exports = {
    * @api public
    */
 
-  attachment(filename) {
+  attachment(filename, options) {
     if (filename) this.type = extname(filename);
-    this.set('Content-Disposition', contentDisposition(filename));
+    this.set('Content-Disposition', contentDisposition(filename, options));
   },
 
   /**
@@ -438,8 +439,8 @@ module.exports = {
     if (this.headerSent) return;
 
     if (2 == arguments.length) {
-      if (Array.isArray(val)) val = val.map(String);
-      else val = String(val);
+      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);
     } else {
       for (const key in field) {
@@ -545,3 +546,13 @@ module.exports = {
     this.res.flushHeaders();
   }
 };
+
+/**
+ * Custom inspection implementation for newer Node.js versions.
+ *
+ * @return {Object}
+ * @api public
+ */
+if (util.inspect.custom) {
+  module.exports[util.inspect.custom] = module.exports.inspect;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "koa",
-  "version": "2.5.1",
+  "version": "2.6.1",
   "description": "Koa web app framework",
   "main": "lib/application.js",
   "scripts": {
@@ -22,30 +22,30 @@
   ],
   "license": "MIT",
   "dependencies": {
-    "accepts": "^1.2.2",
-    "content-disposition": "~0.5.0",
-    "content-type": "^1.0.0",
-    "cookies": "~0.7.0",
-    "debug": "*",
+    "accepts": "^1.3.5",
+    "cache-content-type": "^1.0.0",
+    "content-disposition": "~0.5.2",
+    "content-type": "^1.0.4",
+    "cookies": "~0.7.1",
+    "debug": "~3.1.0",
     "delegates": "^1.0.0",
-    "depd": "^1.1.0",
-    "destroy": "^1.0.3",
-    "error-inject": "~1.0.0",
-    "escape-html": "~1.0.1",
-    "fresh": "^0.5.2",
-    "http-assert": "^1.1.0",
-    "http-errors": "^1.2.8",
-    "is-generator-function": "^1.0.3",
-    "koa-compose": "^4.0.0",
+    "depd": "^1.1.2",
+    "destroy": "^1.0.4",
+    "error-inject": "^1.0.0",
+    "escape-html": "^1.0.3",
+    "fresh": "~0.5.2",
+    "http-assert": "^1.3.0",
+    "http-errors": "^1.6.3",
+    "is-generator-function": "^1.0.7",
+    "koa-compose": "^4.1.0",
     "koa-convert": "^1.2.0",
     "koa-is-json": "^1.0.0",
-    "mime-types": "^2.0.7",
-    "on-finished": "^2.1.0",
-    "only": "0.0.2",
-    "parseurl": "^1.3.0",
-    "statuses": "^1.2.0",
-    "type-is": "^1.5.5",
-    "vary": "^1.0.0"
+    "on-finished": "^2.3.0",
+    "only": "~0.0.2",
+    "parseurl": "^1.3.2",
+    "statuses": "^1.5.0",
+    "type-is": "^1.6.16",
+    "vary": "^1.1.2"
   },
   "devDependencies": {
     "eslint": "^3.17.1",
@@ -54,7 +54,7 @@
     "eslint-plugin-promise": "^3.5.0",
     "eslint-plugin-standard": "^2.1.1",
     "jest": "^20.0.0",
-    "supertest": "^3.0.0"
+    "supertest": "^3.1.0"
   },
   "engines": {
     "node": "^4.8.4 || ^6.10.1 || ^7.10.1 || >= 8.1.4"