koa 2.2.0 → 2.5.1

package/History.md

@@ -1,4 +1,55 @@
 
+2.5.1 / 2018-04-27
+==================
+
+  * test: node v10 on travis (#1182)
+  * fix tests: remove unnecessary assert doesNotThrow and api calls (#1170)
+  * use this.response insteadof this.ctx.response (#1163)
+  * deps: remove istanbul (#1151)
+  * Update guide.md (#1150)
+
+2.5.0 / 2018-02-11
+==================
+
+  * feat: ignore set header/status when header sent (#1137)
+  * run coverage using --runInBand (#1141)
+  * [Update] license year to 2018 (#1130)
+  * docs: small grammatical fix in api docs index (#1111)
+  * docs: fixed typo (#1112)
+  * docs: capitalize K in word koa (#1126)
+  * Error handling: on non-error throw try to stringify if error is an object (#1113)
+  * Use eslint-config-koa (#1105)
+  * Update mgol's name in AUTHORS, add .mailmap (#1100)
+  * Avoid generating package locks instead of ignoring them (#1108)
+  * chore: update copyright year to 2017 (#1095)
+
+
+2.4.1 / 2017-11-06
+==================
+
+ * fix bad merge w/ 2.4.0
+
+2.4.0 / 2017-11-06
+==================
+
+UNPUBLISHED
+
+ * update `package.engines.node` to be more strict
+ * update `fresh@^0.5.2`
+ * fix: `inspect()` no longer crashes `context`
+ * fix: gated `res.statusMessage` for HTTP/2
+ * added: `app.handleRequest()` is exposed
+
+2.3.0 / 2017-06-20
+==================
+
+ * fix: use `Buffer.from()`
+ * test on node 7 & 8
+ * add `package-lock.json` to `.gitignore`
+ * run `lint --fix`
+ * add `request.header` in addition to `request.headers`
+ * add IPv6 hostname support
+
 2.2.0 / 2017-03-14
 ==================
 

package/LICENSE

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) 2016 Koa contributors
+Copyright (c) 2018 Koa contributors
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

package/Readme.md

@@ -1,4 +1,4 @@
-<img src="https://dl.dropboxusercontent.com/u/6396913/koa/logo.png" alt="koa middleware framework for nodejs" width="255px" />
+<img src="/docs/logo.png" alt="Koa middleware framework for nodejs"/>
 
   [![gitter][gitter-image]][gitter-url]
   [![NPM version][npm-image]][npm-url]
@@ -22,7 +22,7 @@ Koa requires __node v7.6.0__ or higher for ES2015 and async function support.
 $ npm install koa
 ```
 
-## Hello koa
+## Hello Koa
 
 ```js
 const Koa = require('koa');
@@ -38,17 +38,17 @@ app.listen(3000);
 
 ## Getting started
 
- - [Kick-Off-Koa](https://github.com/koajs/kick-off-koa) - An intro to koa via a set of self-guided workshops.
- - [Workshop](https://github.com/koajs/workshop) - A workshop to learn the basics of koa, Express' spiritual successor.
+ - [Kick-Off-Koa](https://github.com/koajs/kick-off-koa) - An intro to Koa via a set of self-guided workshops.
+ - [Workshop](https://github.com/koajs/workshop) - A workshop to learn the basics of Koa, Express' spiritual successor.
  - [Introduction Screencast](http://knowthen.com/episode-3-koajs-quickstart-guide/) - An introduction to installing and getting started with Koa
 
 
 ## Middleware
 
-Koa is a middleware framework that can take 3 different kinds of functions as middleware:
+Koa is a middleware framework that can take two different kinds of functions as middleware:
 
-  * common function
   * async function
+  * common function
 
 Here is an example of logger middleware with each of the different functions:
 
@@ -56,9 +56,9 @@ Here is an example of logger middleware with each of the different functions:
 
 ```js
 app.use(async (ctx, next) => {
-  const start = new Date();
+  const start = Date.now();
   await next();
-  const ms = new Date() - start;
+  const ms = Date.now() - start;
   console.log(`${ctx.method} ${ctx.url} - ${ms}ms`);
 });
 ```
@@ -70,9 +70,9 @@ app.use(async (ctx, next) => {
 // next is a function that is invoked to execute the downstream middleware. It returns a Promise with a then function for running code after completion.
 
 app.use((ctx, next) => {
-  const start = new Date();
+  const start = Date.now();
   return next().then(() => {
-    const ms = new Date() - start;
+    const ms = Date.now() - start;
     console.log(`${ctx.method} ${ctx.url} - ${ms}ms`);
   });
 });
@@ -195,7 +195,7 @@ the general Koa guide.
 ## Running tests
 
 ```
-$ make test
+$ npm test
 ```
 
 ## Authors
@@ -211,9 +211,18 @@ See [AUTHORS](AUTHORS).
  - [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)
- - [中文文档](https://github.com/guo-yu/koa-guide)
+ - [中文文档 v1.x](https://github.com/guo-yu/koa-guide)
+ - [中文文档 v2.x](https://github.com/demopark/koa-docs-Zh-CN)
  - __[#koajs]__ on freenode
 
+## Job Board
+
+Looking for a career upgrade?
+
+<a href="https://astro.netlify.com/automattic"><img src="https://astro.netlify.com/static/automattic.png"></a>
+<a href="https://astro.netlify.com/segment"><img src="https://astro.netlify.com/static/segment.png"></a>
+<a href="https://astro.netlify.com/auth0"><img src="https://astro.netlify.com/static/auth0.png"/></a>
+
 ## Backers
 
 Support us with a monthly donation and help us continue our activities.

package/lib/application.js

@@ -58,10 +58,10 @@ module.exports = class Application extends Emitter {
    * @api public
    */
 
-  listen() {
+  listen(...args) {
     debug('listen');
     const server = http.createServer(this.callback());
-    return server.listen.apply(server, arguments);
+    return server.listen(...args);
   }
 
   /**
@@ -128,17 +128,28 @@ module.exports = class Application extends Emitter {
     if (!this.listeners('error').length) this.on('error', this.onerror);
 
     const handleRequest = (req, res) => {
-      res.statusCode = 404;
       const ctx = this.createContext(req, res);
-      const onerror = err => ctx.onerror(err);
-      const handleResponse = () => respond(ctx);
-      onFinished(res, onerror);
-      return fn(ctx).then(handleResponse).catch(onerror);
+      return this.handleRequest(ctx, fn);
     };
 
     return handleRequest;
   }
 
+  /**
+   * Handle request in callback.
+   *
+   * @api private
+   */
+
+  handleRequest(ctx, fnMiddleware) {
+    const res = ctx.res;
+    res.statusCode = 404;
+    const onerror = err => ctx.onerror(err);
+    const handleResponse = () => respond(ctx);
+    onFinished(res, onerror);
+    return fnMiddleware(ctx).then(handleResponse).catch(onerror);
+  }
+
   /**
    * Initialize a new context.
    *

package/lib/context.js

@@ -5,6 +5,7 @@
  * Module dependencies.
  */
 
+const util = require('util');
 const createError = require('http-errors');
 const httpAssert = require('http-assert');
 const delegate = require('delegates');
@@ -25,6 +26,7 @@ const proto = module.exports = {
    */
 
   inspect() {
+    if (this === proto) return this;
     return this.toJSON();
   },
 
@@ -87,8 +89,8 @@ const proto = module.exports = {
    * @api public
    */
 
-  throw() {
-    throw createError.apply(null, arguments);
+  throw(...args) {
+    throw createError(...args);
   },
 
   /**
@@ -104,7 +106,7 @@ const proto = module.exports = {
     // to node-style callbacks.
     if (null == err) return;
 
-    if (!(err instanceof Error)) err = new Error(`non-error thrown: ${err}`);
+    if (!(err instanceof Error)) err = new Error(util.format('non-error thrown: %j', err));
 
     let headerSent = false;
     if (this.headerSent || !this.writable) {
@@ -198,6 +200,7 @@ delegate(proto, 'request')
   .getter('protocol')
   .getter('host')
   .getter('hostname')
+  .getter('URL')
   .getter('header')
   .getter('headers')
   .getter('secure')

package/lib/request.js

@@ -5,6 +5,7 @@
  * Module dependencies.
  */
 
+const URL = require('url').URL;
 const net = require('net');
 const contentType = require('content-type');
 const stringify = require('url').format;
@@ -31,6 +32,16 @@ module.exports = {
     return this.req.headers;
   },
 
+  /**
+   * Set request header.
+   *
+   * @api public
+   */
+
+  set header(val) {
+    this.req.headers = val;
+  },
+
   /**
    * Return request header, alias as request.header
    *
@@ -42,6 +53,16 @@ module.exports = {
     return this.req.headers;
   },
 
+  /**
+   * Set request header, alias as request.header
+   *
+   * @api public
+   */
+
+  set headers(val) {
+    this.req.headers = val;
+  },
+
   /**
    * Get request URL.
    *
@@ -244,9 +265,32 @@ module.exports = {
   get hostname() {
     const host = this.host;
     if (!host) return '';
+    if ('[' == host[0]) return this.URL.hostname || ''; // IPv6
     return host.split(':')[0];
   },
 
+  /**
+   * Get WHATWG parsed URL.
+   * Lazily memoized.
+   *
+   * @return {URL|Object}
+   * @api public
+   */
+
+  get URL() {
+    if (!this.memoizedURL) {
+      const protocol = this.protocol;
+      const host = this.host;
+      const originalUrl = this.originalUrl || ''; // avoid undefined in template string
+      try {
+        this.memoizedURL = new URL(`${protocol}://${host}${originalUrl}`);
+      } catch (err) {
+        this.memoizedURL = Object.create(null);
+      }
+    }
+    return this.memoizedURL;
+  },
+
   /**
    * Check if the request is fresh, aka
    * Last-Modified and/or the ETag
@@ -265,7 +309,7 @@ module.exports = {
 
     // 2xx or 304 as per rfc2616 14.26
     if ((s >= 200 && s < 300) || 304 == s) {
-      return fresh(this.header, this.ctx.response.header);
+      return fresh(this.header, this.response.header);
     }
 
     return false;
@@ -460,8 +504,8 @@ module.exports = {
    * @api public
    */
 
-  accepts() {
-    return this.accept.types.apply(this.accept, arguments);
+  accepts(...args) {
+    return this.accept.types(...args);
   },
 
   /**
@@ -477,8 +521,8 @@ module.exports = {
    * @api public
    */
 
-  acceptsEncodings() {
-    return this.accept.encodings.apply(this.accept, arguments);
+  acceptsEncodings(...args) {
+    return this.accept.encodings(...args);
   },
 
   /**
@@ -494,8 +538,8 @@ module.exports = {
    * @api public
    */
 
-  acceptsCharsets() {
-    return this.accept.charsets.apply(this.accept, arguments);
+  acceptsCharsets(...args) {
+    return this.accept.charsets(...args);
   },
 
   /**
@@ -511,8 +555,8 @@ module.exports = {
    * @api public
    */
 
-  acceptsLanguages() {
-    return this.accept.languages.apply(this.accept, arguments);
+  acceptsLanguages(...args) {
+    return this.accept.languages(...args);
   },
 
   /**

package/lib/response.js

@@ -80,12 +80,13 @@ module.exports = {
    */
 
   set status(code) {
+    if (this.headerSent) return;
+
     assert('number' == typeof code, 'status code must be a number');
     assert(statuses[code], `invalid status code: ${code}`);
-    assert(!this.res.headersSent, 'headers have already been sent');
     this._explicitStatus = true;
     this.res.statusCode = code;
-    this.res.statusMessage = statuses[code];
+    if (this.req.httpVersionMajor < 2) this.res.statusMessage = statuses[code];
     if (this.body && statuses.empty[code]) this.body = null;
   },
 
@@ -133,8 +134,6 @@ module.exports = {
     const original = this._body;
     this._body = val;
 
-    if (this.res.headersSent) return;
-
     // no content
     if (null == val) {
       if (!statuses.empty[this.status]) this.status = 204;
@@ -233,6 +232,8 @@ module.exports = {
    */
 
   vary(field) {
+    if (this.headerSent) return;
+
     vary(this.res, field);
   },
 
@@ -305,7 +306,7 @@ module.exports = {
    */
 
   set type(type) {
-    type = getType(type) || false;
+    type = getType(type);
     if (type) {
       this.set('Content-Type', type);
     } else {
@@ -434,6 +435,8 @@ module.exports = {
    */
 
   set(field, val) {
+    if (this.headerSent) return;
+
     if (2 == arguments.length) {
       if (Array.isArray(val)) val = val.map(String);
       else val = String(val);
@@ -481,6 +484,8 @@ module.exports = {
    */
 
   remove(field) {
+    if (this.headerSent) return;
+
     this.res.removeHeader(field);
   },
 

package/package.json

@@ -1,10 +1,14 @@
 {
   "name": "koa",
-  "version": "2.2.0",
+  "version": "2.5.1",
   "description": "Koa web app framework",
   "main": "lib/application.js",
   "scripts": {
-    "test": "make test"
+    "test": "jest",
+    "test-cov": "jest --coverage --runInBand --forceExit",
+    "lint": "eslint benchmarks lib test",
+    "bench": "make -C benchmarks",
+    "authors": "git log --format='%aN <%aE>' | sort -u > AUTHORS"
   },
   "repository": "koajs/koa",
   "keywords": [
@@ -28,11 +32,11 @@
     "destroy": "^1.0.3",
     "error-inject": "~1.0.0",
     "escape-html": "~1.0.1",
-    "fresh": "^0.5.0",
+    "fresh": "^0.5.2",
     "http-assert": "^1.1.0",
     "http-errors": "^1.2.8",
     "is-generator-function": "^1.0.3",
-    "koa-compose": "^3.0.0",
+    "koa-compose": "^4.0.0",
     "koa-convert": "^1.2.0",
     "koa-is-json": "^1.0.0",
     "mime-types": "^2.0.7",
@@ -44,23 +48,29 @@
     "vary": "^1.0.0"
   },
   "devDependencies": {
-    "babel-eslint": "^7.1.1",
     "eslint": "^3.17.1",
+    "eslint-config-koa": "^2.0.0",
     "eslint-config-standard": "^7.0.1",
-    "eslint-plugin-babel": "^4.1.1",
     "eslint-plugin-promise": "^3.5.0",
     "eslint-plugin-standard": "^2.1.1",
-    "istanbul": "^0.4.0",
-    "mocha": "^3.2.0",
-    "should": "^6.0.3",
-    "should-http": "0.0.3",
-    "supertest": "^3.0.0",
-    "test-console": "^0.7.1"
+    "jest": "^20.0.0",
+    "supertest": "^3.0.0"
   },
   "engines": {
-    "node": ">= 6.0.0"
+    "node": "^4.8.4 || ^6.10.1 || ^7.10.1 || >= 8.1.4"
   },
   "files": [
     "lib"
-  ]
+  ],
+  "jest": {
+    "testMatch": [
+      "**/test/!(helpers)/*.js"
+    ],
+    "coverageReporters": [
+      "text-summary",
+      "lcov"
+    ],
+    "bail": true,
+    "testEnvironment": "node"
+  }
 }