koa 3.0.0-alpha.0 → 3.0.0-alpha.2

package/Readme.md

@@ -17,7 +17,7 @@
 
 ## Installation
 
-Koa requires __node v12.17.0__ or higher for ES2015 and async function support.
+Koa requires __node v18.0.0__ or higher for ES2015 and async function support.
 
 ```
 $ npm install koa

package/lib/application.js

@@ -1,4 +1,3 @@
-
 'use strict'
 
 /**
@@ -17,7 +16,7 @@ const Emitter = require('events')
 const util = require('util')
 const Stream = require('stream')
 const http = require('http')
-const only = require('only')
+const only = require('./only.js')
 const { HttpError } = require('http-errors')
 
 /** @typedef {typeof import ('./context') & {
@@ -55,6 +54,8 @@ module.exports = class Application extends Emitter {
     * @param {number} [options.subdomainOffset] Subdomain offset
     * @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)
+    * @param {function} [options.compose] Function to handle middleware composition
+    * @param {boolean} [options.asyncLocalStorage] Max IPs read from proxy IP header, default to 0 (means infinity)
     *
     */
 
@@ -81,7 +82,6 @@ module.exports = class Application extends Emitter {
       const { AsyncLocalStorage } = require('async_hooks')
       assert(AsyncLocalStorage, 'Requires node 12.17.0 or higher to enable asyncLocalStorage')
       this.ctxStorage = new AsyncLocalStorage()
-      this.use(this.createAsyncCtxStorageMiddleware())
     }
   }
 
@@ -160,7 +160,12 @@ module.exports = class Application extends Emitter {
 
     const handleRequest = (req, res) => {
       const ctx = this.createContext(req, res)
-      return this.handleRequest(ctx, fn)
+      if (!this.ctxStorage) {
+        return this.handleRequest(ctx, fn)
+      }
+      return this.ctxStorage.run(ctx, async () => {
+        return await this.handleRequest(ctx, fn)
+      })
     }
 
     return handleRequest
@@ -243,15 +248,6 @@ module.exports = class Application extends Emitter {
   static get default () {
     return Application
   }
-
-  createAsyncCtxStorageMiddleware () {
-    const app = this
-    return async function asyncCtxStorage (ctx, next) {
-      await app.ctxStorage.run(ctx, async () => {
-        return await next()
-      })
-    }
-  }
 }
 
 /**
@@ -284,7 +280,7 @@ function respond (ctx) {
   }
 
   // status body
-  if (body == null) {
+  if (body === null || body === undefined) {
     if (ctx.response._explicitNullBody) {
       ctx.response.remove('Content-Type')
       ctx.response.remove('Transfer-Encoding')
@@ -304,9 +300,13 @@ function respond (ctx) {
   }
 
   // responses
+
   if (Buffer.isBuffer(body)) return res.end(body)
   if (typeof body === 'string') return res.end(body)
   if (body instanceof Stream) return body.pipe(res)
+  if (body instanceof Blob) return Stream.Readable.from(body.stream()).pipe(res)
+  if (body instanceof ReadableStream) return Stream.Readable.from(body).pipe(res)
+  if (body instanceof Response) return Stream.Readable.from(body?.body || '').pipe(res)
 
   // body: json
   body = JSON.stringify(body)

package/lib/context.js

@@ -1,4 +1,3 @@
-
 'use strict'
 
 /**
@@ -155,10 +154,10 @@ const proto = module.exports = {
     if (err.code === 'ENOENT') statusCode = 404
 
     // default to 500
-    if (typeof statusCode !== 'number' || !statuses[statusCode]) statusCode = 500
+    if (typeof statusCode !== 'number' || !statuses.message[statusCode]) statusCode = 500
 
     // respond
-    const code = statuses[statusCode]
+    const code = statuses.message[statusCode]
     const msg = err.expose ? err.message : code
     this.status = err.status = statusCode
     this.length = Buffer.byteLength(msg)
@@ -205,6 +204,7 @@ delegate(proto, 'response')
   .method('set')
   .method('append')
   .method('flushHeaders')
+  .method('back')
   .access('status')
   .access('message')
   .access('body')

package/lib/only.js

@@ -0,0 +1,9 @@
+module.exports = (obj, keys) => {
+  const ret = {}
+  for (let i = 0; i < keys.length; i++) {
+    const key = keys[i]
+    if (obj[key] == null) continue
+    ret[key] = obj[key]
+  }
+  return ret
+}

package/lib/request.js

@@ -1,4 +1,3 @@
-
 'use strict'
 
 /**
@@ -11,10 +10,11 @@ const accepts = require('accepts')
 const contentType = require('content-type')
 const stringify = require('url').format
 const parse = require('parseurl')
-const qs = require('querystring')
+const sp = require('./search-params.js')
+
 const typeis = require('type-is')
 const fresh = require('fresh')
-const only = require('only')
+const only = require('./only.js')
 const util = require('util')
 
 const IP = Symbol('context#ip')
@@ -172,7 +172,7 @@ module.exports = {
   get query () {
     const str = this.querystring
     const c = this._querycache = this._querycache || {}
-    return c[str] || (c[str] = qs.parse(str))
+    return c[str] || (c[str] = sp.parse(str))
   },
 
   /**
@@ -183,7 +183,7 @@ module.exports = {
    */
 
   set query (obj) {
-    this.querystring = qs.stringify(obj)
+    this.querystring = sp.stringify(obj)
   },
 
   /**
@@ -211,7 +211,6 @@ module.exports = {
 
     url.search = str
     url.path = null
-
     this.url = stringify(url)
   },
 
@@ -376,7 +375,7 @@ module.exports = {
   /**
    * Return parsed Content-Length when present.
    *
-   * @return {Number}
+   * @return {Number|void}
    * @api public
    */
 
@@ -503,7 +502,7 @@ module.exports = {
   /**
    * Set accept object.
    *
-   * @param {Object}
+   * @param {Object} obj
    * @api private
    */
 

package/lib/response.js

@@ -1,4 +1,3 @@
-
 'use strict'
 
 /**
@@ -15,10 +14,11 @@ const destroy = require('destroy')
 const assert = require('assert')
 const extname = require('path').extname
 const vary = require('vary')
-const only = require('only')
+const only = require('./only.js')
 const util = require('util')
 const encodeUrl = require('encodeurl')
 const Stream = require('stream')
+const deprecate = require('depd')('koa')
 
 /**
  * Prototype.
@@ -87,7 +87,7 @@ module.exports = {
     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.req.httpVersionMajor < 2) this.res.statusMessage = statuses.message[code]
     if (this.body && statuses.empty[code]) this.body = null
   },
 
@@ -99,7 +99,7 @@ module.exports = {
    */
 
   get message () {
-    return this.res.statusMessage || statuses[this.status]
+    return this.res.statusMessage || statuses.message[this.status]
   },
 
   /**
@@ -127,15 +127,15 @@ module.exports = {
   /**
    * Set response body.
    *
-   * @param {String|Buffer|Object|Stream} val
+   * @param {String|Buffer|Object|Stream|ReadableStream|Blob|Response} val
    * @api public
    */
 
   set body (val) {
     const original = this._body
     this._body = val
-
     // no content
+
     if (val == null) {
       if (!statuses.empty[this.status]) {
         if (this.type === 'application/json') {
@@ -184,6 +184,31 @@ module.exports = {
       return
     }
 
+    // ReadableStream
+    if (val instanceof ReadableStream) {
+      if (setType) this.type = 'bin'
+      return
+    }
+
+    // blob
+    if (val instanceof Blob) {
+      if (setType) this.type = 'bin'
+      this.length = val.size
+      return
+    }
+
+    // Response
+    if (val instanceof Response) {
+      this.status = val.status
+      if (setType) this.type = 'bin'
+      const headers = val.headers
+      for (const key of headers.keys()) {
+        this.set(key, headers.get(key))
+      }
+
+      return
+    }
+
     // json
     this.remove('Content-Length')
     this.type = 'json'
@@ -235,7 +260,7 @@ module.exports = {
   /**
    * Vary on `field`.
    *
-   * @param {String} field
+   * @param {String|String[]} field
    * @api public
    */
 
@@ -266,7 +291,15 @@ module.exports = {
 
   redirect (url, alt) {
     // location
-    if (url === 'back') url = this.ctx.get('Referrer') || alt || '/'
+    if (url === 'back') {
+      deprecate('Special-cased string "back" through redirect will be removed in v3, ' +
+        'consider migrating usage to ctx.back() instead.')
+      url = this.ctx.get('Referrer') || alt || '/'
+    }
+    if (/^https?:\/\//i.test(url)) {
+      // formatting url again avoid security escapes
+      url = new URL(url).toString()
+    }
     this.set('Location', encodeUrl(url))
 
     // status
@@ -285,10 +318,31 @@ module.exports = {
     this.body = `Redirecting to ${url}.`
   },
 
+  /**
+   * Perform a special-cased "back" to provide Referrer support.
+   * When Referrer is not present, `alt` or "/" is used.
+   *
+   * Examples:
+   *
+   *    ctx.back()
+   *    ctx.back('/index.html')
+   *
+   * @param {String} [alt]
+   * @api public
+   */
+
+  back (alt) {
+    const url = this.ctx.get('Referrer') || alt || '/'
+    this.redirect(url)
+  },
+
   /**
    * Set Content-Disposition header to "attachment" with optional `filename`.
    *
-   * @param {String} filename
+   * @param {String} [filename]
+   * @param {object} [options]
+   * @param {string} [options.type=attachment]
+   * @param {string|boolean} [options.fallback=true]
    * @api public
    */
 
@@ -328,7 +382,7 @@ module.exports = {
    *     this.response.lastModified = new Date();
    *     this.response.lastModified = '2013-09-13';
    *
-   * @param {String|Date} type
+   * @param {String|Date} val
    * @api public
    */
 
@@ -357,7 +411,7 @@ module.exports = {
    *     this.response.etag = '"md5hashsum"';
    *     this.response.etag = 'W/"123456789"';
    *
-   * @param {String} etag
+   * @param {String} val
    * @api public
    */
 
@@ -460,7 +514,7 @@ module.exports = {
    *    this.set({ Accept: 'text/plain', 'X-API-Key': 'tobi' });
    *
    * @param {String|Object|Array} field
-   * @param {String} val
+   * @param {*} val
    * @api public
    */
 
@@ -490,7 +544,7 @@ module.exports = {
    * ```
    *
    * @param {String} field
-   * @param {String|Array} val
+   * @param {*} val
    * @api public
    */
 
@@ -509,7 +563,7 @@ module.exports = {
   /**
    * Remove header `field`.
    *
-   * @param {String} name
+   * @param {String} field
    * @api public
    */
 

package/lib/search-params.js

@@ -0,0 +1,33 @@
+const URLSearchParams = require('url').URLSearchParams
+
+module.exports = {
+  stringify: (obj) => {
+    const searchParams = new URLSearchParams()
+    const addKey = (k, v, params) => {
+      const val = typeof v === 'string' || typeof v === 'number' ? v : ''
+      params.append(k, val)
+    }
+
+    for (const [key, value] of Object.entries(obj)) {
+      if (Array.isArray(value)) {
+        const lgth = value.length
+        for (let i = 0; i < lgth; i++) {
+          addKey(key, value[i], searchParams)
+        }
+      } else {
+        addKey(key, value, searchParams)
+      }
+    }
+    return searchParams.toString()
+  },
+
+  parse: (str) => {
+    const searchParams = new URLSearchParams(str)
+    const obj = {}
+    for (const key of searchParams.keys()) {
+      const values = searchParams.getAll(key)
+      obj[key] = values.length <= 1 ? values[0] : values
+    }
+    return obj
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "koa",
-  "version": "3.0.0-alpha.0",
+  "version": "3.0.0-alpha.2",
   "publishConfig": {
     "tag": "experimental"
   },
@@ -9,7 +9,8 @@
   "exports": {
     ".": {
       "require": "./lib/application.js",
-      "import": "./dist/koa.mjs"
+      "import": "./dist/koa.mjs",
+      "default": "./dist/koa.mjs"
     },
     "./*": "./*.js",
     "./*.js": "./*.js",
@@ -17,8 +18,10 @@
     "./package.json": "./package.json"
   },
   "scripts": {
-    "test": "jest --forceExit",
-    "lint": "eslint --ignore-path .gitignore .",
+    "test": "node --test",
+    "test:coverage": "node --test --experimental-test-coverage",
+    "lint": "standard",
+    "lint:pretty": "standard | snazzy",
     "authors": "git log --format='%aN <%aE>' | sort -u > AUTHORS",
     "build": "gen-esm-wrapper . ./dist/koa.mjs",
     "prepare": "npm run build"
@@ -39,42 +42,33 @@
     "cache-content-type": "^1.0.0",
     "content-disposition": "~0.5.2",
     "content-type": "^1.0.4",
-    "cookies": "~0.8.0",
+    "cookies": "~0.9.1",
     "debug": "^4.3.2",
     "delegates": "^1.0.0",
     "destroy": "^1.0.4",
-    "encodeurl": "^1.0.2",
+    "encodeurl": "^2.0.0",
     "escape-html": "^1.0.3",
     "fresh": "~0.5.2",
     "http-assert": "^1.3.0",
-    "http-errors": "^1.6.3",
+    "http-errors": "^2.0.0",
     "koa-compose": "^4.1.0",
     "on-finished": "^2.3.0",
-    "only": "~0.0.2",
     "parseurl": "^1.3.2",
-    "statuses": "^1.5.0",
+    "statuses": "^2.0.1",
     "type-is": "^1.6.16",
     "vary": "^1.1.2"
   },
   "devDependencies": {
-    "eslint": "^7.32.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": "^28.1.2",
-    "supertest": "^6.2.4"
+    "snazzy": "^9.0.0",
+    "standard": "^17.1.0",
+    "supertest": "^7.0.0"
   },
   "engines": {
-    "node": ">= 12.17.0"
+    "node": ">= 18"
   },
   "files": [
     "dist",
     "lib"
-  ],
-  "jest": {
-    "testEnvironment": "node"
-  }
+  ]
 }