koa 2.14.2 → 3.0.0-alpha.1

package/lib/response.js

@@ -1,24 +1,24 @@
 
-'use strict';
+'use strict'
 
 /**
  * Module dependencies.
  */
 
-const contentDisposition = require('content-disposition');
-const getType = require('cache-content-type');
-const onFinish = require('on-finished');
-const escape = require('escape-html');
-const typeis = require('type-is').is;
-const statuses = require('statuses');
-const destroy = require('destroy');
-const assert = require('assert');
-const extname = require('path').extname;
-const vary = require('vary');
-const only = require('only');
-const util = require('util');
-const encodeUrl = require('encodeurl');
-const Stream = require('stream');
+const contentDisposition = require('content-disposition')
+const getType = require('cache-content-type')
+const onFinish = require('on-finished')
+const escape = require('escape-html')
+const typeis = require('type-is').is
+const statuses = require('statuses')
+const destroy = require('destroy')
+const assert = require('assert')
+const extname = require('path').extname
+const vary = require('vary')
+const only = require('only')
+const util = require('util')
+const encodeUrl = require('encodeurl')
+const Stream = require('stream')
 
 /**
  * Prototype.
@@ -33,8 +33,8 @@ module.exports = {
    * @api public
    */
 
-  get socket() {
-    return this.res.socket;
+  get socket () {
+    return this.res.socket
   },
 
   /**
@@ -44,11 +44,11 @@ module.exports = {
    * @api public
    */
 
-  get header() {
-    const { res } = this;
+  get header () {
+    const { res } = this
     return typeof res.getHeaders === 'function'
       ? res.getHeaders()
-      : res._headers || {}; // Node < 7.7
+      : res._headers || {} // Node < 7.7
   },
 
   /**
@@ -58,8 +58,8 @@ module.exports = {
    * @api public
    */
 
-  get headers() {
-    return this.header;
+  get headers () {
+    return this.header
   },
 
   /**
@@ -69,8 +69,8 @@ module.exports = {
    * @api public
    */
 
-  get status() {
-    return this.res.statusCode;
+  get status () {
+    return this.res.statusCode
   },
 
   /**
@@ -80,15 +80,15 @@ module.exports = {
    * @api public
    */
 
-  set status(code) {
-    if (this.headerSent) return;
+  set status (code) {
+    if (this.headerSent) return
 
-    assert(Number.isInteger(code), 'status code must be a number');
-    assert(code >= 100 && code <= 999, `invalid status code: ${code}`);
-    this._explicitStatus = true;
-    this.res.statusCode = code;
-    if (this.req.httpVersionMajor < 2) this.res.statusMessage = statuses[code];
-    if (this.body && statuses.empty[code]) this.body = null;
+    assert(Number.isInteger(code), 'status code must be a number')
+    assert(code >= 100 && code <= 999, `invalid status code: ${code}`)
+    this._explicitStatus = true
+    this.res.statusCode = code
+    if (this.req.httpVersionMajor < 2) this.res.statusMessage = statuses[code]
+    if (this.body && statuses.empty[code]) this.body = null
   },
 
   /**
@@ -98,8 +98,8 @@ module.exports = {
    * @api public
    */
 
-  get message() {
-    return this.res.statusMessage || statuses[this.status];
+  get message () {
+    return this.res.statusMessage || statuses[this.status]
   },
 
   /**
@@ -109,8 +109,8 @@ module.exports = {
    * @api public
    */
 
-  set message(msg) {
-    this.res.statusMessage = msg;
+  set message (msg) {
+    this.res.statusMessage = msg
   },
 
   /**
@@ -120,8 +120,8 @@ module.exports = {
    * @api public
    */
 
-  get body() {
-    return this._body;
+  get body () {
+    return this._body
   },
 
   /**
@@ -131,56 +131,62 @@ module.exports = {
    * @api public
    */
 
-  set body(val) {
-    const original = this._body;
-    this._body = val;
+  set body (val) {
+    const original = this._body
+    this._body = val
 
     // 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');
-      return;
+    if (val == null) {
+      if (!statuses.empty[this.status]) {
+        if (this.type === 'application/json') {
+          this._body = 'null'
+          return
+        }
+        this.status = 204
+      }
+      if (val === null) this._explicitNullBody = true
+      this.remove('Content-Type')
+      this.remove('Content-Length')
+      this.remove('Transfer-Encoding')
+      return
     }
 
     // set the status
-    if (!this._explicitStatus) this.status = 200;
+    if (!this._explicitStatus) this.status = 200
 
     // set the content-type only if not yet set
-    const setType = !this.has('Content-Type');
+    const setType = !this.has('Content-Type')
 
     // string
-    if ('string' === typeof val) {
-      if (setType) this.type = /^\s*</.test(val) ? 'html' : 'text';
-      this.length = Buffer.byteLength(val);
-      return;
+    if (typeof val === 'string') {
+      if (setType) this.type = /^\s*</.test(val) ? 'html' : 'text'
+      this.length = Buffer.byteLength(val)
+      return
     }
 
     // buffer
     if (Buffer.isBuffer(val)) {
-      if (setType) this.type = 'bin';
-      this.length = val.length;
-      return;
+      if (setType) this.type = 'bin'
+      this.length = val.length
+      return
     }
 
     // stream
     if (val instanceof Stream) {
-      onFinish(this.res, destroy.bind(null, val));
-      if (original != val) {
-        val.once('error', err => this.ctx.onerror(err));
+      onFinish(this.res, destroy.bind(null, val))
+      if (original !== val) {
+        val.once('error', err => this.ctx.onerror(err))
         // overwriting
-        if (null != original) this.remove('Content-Length');
+        if (original != null) this.remove('Content-Length')
       }
 
-      if (setType) this.type = 'bin';
-      return;
+      if (setType) this.type = 'bin'
+      return
     }
 
     // json
-    this.remove('Content-Length');
-    this.type = 'json';
+    this.remove('Content-Length')
+    this.type = 'json'
   },
 
   /**
@@ -190,9 +196,9 @@ module.exports = {
    * @api public
    */
 
-  set length(n) {
+  set length (n) {
     if (!this.has('Transfer-Encoding')) {
-      this.set('Content-Length', n);
+      this.set('Content-Length', n)
     }
   },
 
@@ -203,16 +209,16 @@ module.exports = {
    * @api public
    */
 
-  get length() {
+  get length () {
     if (this.has('Content-Length')) {
-      return parseInt(this.get('Content-Length'), 10) || 0;
+      return parseInt(this.get('Content-Length'), 10) || 0
     }
 
-    const { body } = this;
-    if (!body || body instanceof Stream) return undefined;
-    if ('string' === typeof body) return Buffer.byteLength(body);
-    if (Buffer.isBuffer(body)) return body.length;
-    return Buffer.byteLength(JSON.stringify(body));
+    const { body } = this
+    if (!body || body instanceof Stream) return undefined
+    if (typeof body === 'string') return Buffer.byteLength(body)
+    if (Buffer.isBuffer(body)) return body.length
+    return Buffer.byteLength(JSON.stringify(body))
   },
 
   /**
@@ -222,8 +228,8 @@ module.exports = {
    * @api public
    */
 
-  get headerSent() {
-    return this.res.headersSent;
+  get headerSent () {
+    return this.res.headersSent
   },
 
   /**
@@ -233,10 +239,10 @@ module.exports = {
    * @api public
    */
 
-  vary(field) {
-    if (this.headerSent) return;
+  vary (field) {
+    if (this.headerSent) return
 
-    vary(this.res, field);
+    vary(this.res, field)
   },
 
   /**
@@ -258,25 +264,25 @@ module.exports = {
    * @api public
    */
 
-  redirect(url, alt) {
+  redirect (url, alt) {
     // location
-    if ('back' === url) url = this.ctx.get('Referrer') || alt || '/';
-    this.set('Location', encodeUrl(url));
+    if (url === 'back') url = this.ctx.get('Referrer') || alt || '/'
+    this.set('Location', encodeUrl(url))
 
     // status
-    if (!statuses.redirect[this.status]) this.status = 302;
+    if (!statuses.redirect[this.status]) this.status = 302
 
     // html
     if (this.ctx.accepts('html')) {
-      url = escape(url);
-      this.type = 'text/html; charset=utf-8';
-      this.body = `Redirecting to <a href="${url}">${url}</a>.`;
-      return;
+      url = escape(url)
+      this.type = 'text/html; charset=utf-8'
+      this.body = `Redirecting to <a href="${url}">${url}</a>.`
+      return
     }
 
     // text
-    this.type = 'text/plain; charset=utf-8';
-    this.body = `Redirecting to ${url}.`;
+    this.type = 'text/plain; charset=utf-8'
+    this.body = `Redirecting to ${url}.`
   },
 
   /**
@@ -286,9 +292,9 @@ module.exports = {
    * @api public
    */
 
-  attachment(filename, options) {
-    if (filename) this.type = extname(filename);
-    this.set('Content-Disposition', contentDisposition(filename, options));
+  attachment (filename, options) {
+    if (filename) this.type = extname(filename)
+    this.set('Content-Disposition', contentDisposition(filename, options))
   },
 
   /**
@@ -307,12 +313,12 @@ module.exports = {
    * @api public
    */
 
-  set type(type) {
-    type = getType(type);
+  set type (type) {
+    type = getType(type)
     if (type) {
-      this.set('Content-Type', type);
+      this.set('Content-Type', type)
     } else {
-      this.remove('Content-Type');
+      this.remove('Content-Type')
     }
   },
 
@@ -326,9 +332,9 @@ module.exports = {
    * @api public
    */
 
-  set lastModified(val) {
-    if ('string' === typeof val) val = new Date(val);
-    this.set('Last-Modified', val.toUTCString());
+  set lastModified (val) {
+    if (typeof val === 'string') val = new Date(val)
+    this.set('Last-Modified', val.toUTCString())
   },
 
   /**
@@ -338,9 +344,9 @@ module.exports = {
    * @api public
    */
 
-  get lastModified() {
-    const date = this.get('last-modified');
-    if (date) return new Date(date);
+  get lastModified () {
+    const date = this.get('last-modified')
+    if (date) return new Date(date)
   },
 
   /**
@@ -355,9 +361,9 @@ module.exports = {
    * @api public
    */
 
-  set etag(val) {
-    if (!/^(W\/)?"/.test(val)) val = `"${val}"`;
-    this.set('ETag', val);
+  set etag (val) {
+    if (!/^(W\/)?"/.test(val)) val = `"${val}"`
+    this.set('ETag', val)
   },
 
   /**
@@ -367,8 +373,8 @@ module.exports = {
    * @api public
    */
 
-  get etag() {
-    return this.get('ETag');
+  get etag () {
+    return this.get('ETag')
   },
 
   /**
@@ -379,10 +385,10 @@ module.exports = {
    * @api public
    */
 
-  get type() {
-    const type = this.get('Content-Type');
-    if (!type) return '';
-    return type.split(';', 1)[0];
+  get type () {
+    const type = this.get('Content-Type')
+    if (!type) return ''
+    return type.split(';', 1)[0]
   },
 
   /**
@@ -395,8 +401,8 @@ module.exports = {
    * @api public
    */
 
-  is(type, ...types) {
-    return typeis(this.type, type, ...types);
+  is (type, ...types) {
+    return typeis(this.type, type, ...types)
   },
 
   /**
@@ -411,12 +417,12 @@ module.exports = {
    *     // => "text/plain"
    *
    * @param {String} field
-   * @return {String}
+   * @return {any}
    * @api public
    */
 
-  get(field) {
-    return this.header[field.toLowerCase()] || '';
+  get (field) {
+    return this.res.getHeader(field)
   },
 
   /**
@@ -436,11 +442,11 @@ module.exports = {
    * @api public
    */
 
-  has(field) {
+  has (field) {
     return typeof this.res.hasHeader === 'function'
       ? this.res.hasHeader(field)
       // Node < 7.7
-      : field.toLowerCase() in this.headers;
+      : field.toLowerCase() in this.headers
   },
 
   /**
@@ -458,16 +464,16 @@ module.exports = {
    * @api public
    */
 
-  set(field, val) {
-    if (this.headerSent) return;
+  set (field, val) {
+    if (this.headerSent) return
 
-    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);
+    if (arguments.length === 2) {
+      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) {
-        this.set(key, field[key]);
+        this.set(key, field[key])
       }
     }
   },
@@ -488,16 +494,16 @@ module.exports = {
    * @api public
    */
 
-  append(field, val) {
-    const prev = this.get(field);
+  append (field, val) {
+    const prev = this.get(field)
 
     if (prev) {
       val = Array.isArray(prev)
         ? prev.concat(val)
-        : [prev].concat(val);
+        : [prev].concat(val)
     }
 
-    return this.set(field, val);
+    return this.set(field, val)
   },
 
   /**
@@ -507,10 +513,10 @@ module.exports = {
    * @api public
    */
 
-  remove(field) {
-    if (this.headerSent) return;
+  remove (field) {
+    if (this.headerSent) return
 
-    this.res.removeHeader(field);
+    this.res.removeHeader(field)
   },
 
   /**
@@ -522,19 +528,19 @@ module.exports = {
    * @api private
    */
 
-  get writable() {
+  get writable () {
     // can't write any more after response finished
     // response.writableEnded is available since Node > 12.9
     // https://nodejs.org/api/http.html#http_response_writableended
     // response.finished is undocumented feature of previous Node versions
     // https://stackoverflow.com/questions/16254385/undocumented-response-finished-in-node-js
-    if (this.res.writableEnded || this.res.finished) return false;
+    if (this.res.writableEnded || this.res.finished) return false
 
-    const socket = this.res.socket;
+    const socket = this.res.socket
     // There are already pending outgoing res, but still writable
     // https://github.com/nodejs/node/blob/v4.4.7/lib/_http_server.js#L486
-    if (!socket) return true;
-    return socket.writable;
+    if (!socket) return true
+    return socket.writable
   },
 
   /**
@@ -544,11 +550,11 @@ module.exports = {
    * @api public
    */
 
-  inspect() {
-    if (!this.res) return;
-    const o = this.toJSON();
-    o.body = this.body;
-    return o;
+  inspect () {
+    if (!this.res) return
+    const o = this.toJSON()
+    o.body = this.body
+    return o
   },
 
   /**
@@ -558,22 +564,22 @@ module.exports = {
    * @api public
    */
 
-  toJSON() {
+  toJSON () {
     return only(this, [
       'status',
       'message',
       'header'
-    ]);
+    ])
   },
 
   /**
    * Flush any set headers and begin the body
    */
 
-  flushHeaders() {
-    this.res.flushHeaders();
+  flushHeaders () {
+    this.res.flushHeaders()
   }
-};
+}
 
 /**
  * Custom inspection implementation for node 6+.
@@ -584,5 +590,5 @@ module.exports = {
 
 /* istanbul ignore else */
 if (util.inspect.custom) {
-  module.exports[util.inspect.custom] = module.exports.inspect;
+  module.exports[util.inspect.custom] = module.exports.inspect
 }

package/package.json

@@ -1,6 +1,9 @@
 {
   "name": "koa",
-  "version": "2.14.2",
+  "version": "3.0.0-alpha.1",
+  "publishConfig": {
+    "tag": "experimental"
+  },
   "description": "Koa web app framework",
   "main": "lib/application.js",
   "exports": {
@@ -8,14 +11,6 @@
       "require": "./lib/application.js",
       "import": "./dist/koa.mjs"
     },
-    "./lib/request": "./lib/request.js",
-    "./lib/request.js": "./lib/request.js",
-    "./lib/response": "./lib/response.js",
-    "./lib/response.js": "./lib/response.js",
-    "./lib/application": "./lib/application.js",
-    "./lib/application.js": "./lib/application.js",
-    "./lib/context": "./lib/context.js",
-    "./lib/context.js": "./lib/context.js",
     "./*": "./*.js",
     "./*.js": "./*.js",
     "./package": "./package.json",
@@ -47,16 +42,13 @@
     "cookies": "~0.8.0",
     "debug": "^4.3.2",
     "delegates": "^1.0.0",
-    "depd": "^2.0.0",
     "destroy": "^1.0.4",
     "encodeurl": "^1.0.2",
     "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": "^2.0.0",
     "on-finished": "^2.3.0",
     "only": "~0.0.2",
     "parseurl": "^1.3.2",
@@ -66,18 +58,17 @@
   },
   "devDependencies": {
     "eslint": "^7.32.0",
-    "eslint-config-koa": "^2.0.0",
     "eslint-config-standard": "^16.0.3",
     "eslint-plugin-import": "^2.18.2",
     "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"
+    "jest": "^28.1.2",
+    "supertest": "^6.2.4"
   },
   "engines": {
-    "node": "^4.8.4 || ^6.10.1 || ^7.10.1 || >= 8.1.4"
+    "node": ">= 12.17.0"
   },
   "files": [
     "dist",