koa 3.0.0 → 3.0.1

package/Readme.md

@@ -19,8 +19,8 @@
 
 Koa requires __node v18.0.0__ or higher for ES2015 and async function support.
 
-```
-$ npm install koa
+```sh
+npm install koa
 ```
 
 ## Hello Koa
@@ -81,10 +81,9 @@ app.use((ctx, next) => {
 
 The middleware signature changed between v1.x and v2.x.  The older signature is deprecated.
 
-**Old signature middleware support will be removed in v3**
+**Old signature middleware support has been removed in v3**
 
-Please see the [Migration Guide](docs/migration.md) for more information on upgrading from v1.x and
-using v1.x middleware with v2.x.
+Please see the [Migration Guide from v2.x to v3.x](docs/migration-v2-to-v3.md) for information on upgrading from v2.x to v3.x, and the [Migration Guide from v1.x to v2.x](docs/migration-v1-to-v2.md) for information on upgrading from v1.x to v2.x.
 
 ## Context, Request and Response
 
@@ -96,7 +95,7 @@ as the parameter name for the context object.
 app.use(async (ctx, next) => { await next(); });
 ```
 
-Koa provides a `Request` object as the `request` property of the `Context`.  
+Koa provides a `Request` object as the `request` property of the `Context`.
 Koa's `Request` object provides helpful methods for working with
 http requests which delegate to an [IncomingMessage](https://nodejs.org/api/http.html#http_class_http_incomingmessage)
 from the node `http` module.
@@ -112,10 +111,10 @@ app.use(async (ctx, next) => {
 });
 ```
 
-Koa provides a `Response` object as the `response` property of the `Context`.  
+Koa provides a `Response` object as the `response` property of the `Context`.
 Koa's `Response` object provides helpful methods for working with
 http responses which delegate to a [ServerResponse](https://nodejs.org/api/http.html#http_class_http_serverresponse)
-.  
+.
 
 Koa's pattern of delegating to Node's request and response objects rather than extending them
 provides a cleaner interface and reduces conflicts between different middleware and with Node

package/lib/application.js

@@ -3,22 +3,23 @@
 /**
  * Module dependencies.
  */
+const util = require('node:util')
+const debug = util.debuglog('koa:application')
+const Emitter = require('node:events')
+const Stream = require('node:stream')
+const http = require('node:http')
+const { AsyncLocalStorage } = require('node:async_hooks')
 
-const debug = require('debug')('koa:application')
-const assert = require('assert')
 const onFinished = require('on-finished')
-const response = require('./response')
 const compose = require('koa-compose')
-const context = require('./context')
-const request = require('./request')
 const statuses = require('statuses')
-const Emitter = require('events')
-const util = require('util')
-const Stream = require('stream')
-const http = require('http')
+const { HttpError } = require('http-errors')
+
+const request = require('./request')
+const response = require('./response')
+const context = require('./context')
 const isStream = require('./is-stream.js')
 const only = require('./only.js')
-const { HttpError } = require('http-errors')
 
 /** @typedef {typeof import ('./context') & {
  *  app: Application
@@ -47,18 +48,18 @@ module.exports = class Application extends Emitter {
    */
 
   /**
-    *
-    * @param {object} [options] Application options
-    * @param {string} [options.env='development'] Environment
-    * @param {string[]} [options.keys] Signed cookie keys
-    * @param {boolean} [options.proxy] Trust proxy headers
-    * @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] Enable AsyncLocalStorage, default to false
-    *
-    */
+   *
+   * @param {object} [options] Application options
+   * @param {string} [options.env='development'] Environment
+   * @param {string[]} [options.keys] Signed cookie keys
+   * @param {boolean} [options.proxy] Trust proxy headers
+   * @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] Enable AsyncLocalStorage, default to false
+   *
+   */
 
   constructor (options) {
     super()
@@ -80,9 +81,11 @@ module.exports = class Application extends Emitter {
       this[util.inspect.custom] = this.inspect
     }
     if (options.asyncLocalStorage) {
-      const { AsyncLocalStorage } = require('async_hooks')
-      assert(AsyncLocalStorage, 'Requires node 12.17.0 or higher to enable asyncLocalStorage')
-      this.ctxStorage = new AsyncLocalStorage()
+      if (options.asyncLocalStorage instanceof AsyncLocalStorage) {
+        this.ctxStorage = options.asyncLocalStorage
+      } else {
+        this.ctxStorage = new AsyncLocalStorage()
+      }
     }
   }
 
@@ -111,11 +114,7 @@ module.exports = class Application extends Emitter {
    */
 
   toJSON () {
-    return only(this, [
-      'subdomainOffset',
-      'proxy',
-      'env'
-    ])
+    return only(this, ['subdomainOffset', 'proxy', 'env'])
   }
 
   /**
@@ -140,7 +139,7 @@ module.exports = class Application extends Emitter {
    */
 
   use (fn) {
-    if (typeof fn !== 'function') throw new TypeError('middleware must be a function!')
+    if (typeof fn !== 'function') { throw new TypeError('middleware must be a function!') }
     debug('use %s', fn._name || fn.name || '-')
     this.middleware.push(fn)
     return this
@@ -188,7 +187,7 @@ module.exports = class Application extends Emitter {
   handleRequest (ctx, fnMiddleware) {
     const res = ctx.res
     res.statusCode = 404
-    const onerror = err => ctx.onerror(err)
+    const onerror = (err) => ctx.onerror(err)
     const handleResponse = () => respond(ctx)
     onFinished(res, onerror)
     return fnMiddleware(ctx).then(handleResponse).catch(onerror)
@@ -204,9 +203,9 @@ module.exports = class Application extends Emitter {
     /** @type {Context} */
     const context = Object.create(this.context)
     /** @type {KoaRequest} */
-    const request = context.request = Object.create(this.request)
+    const request = (context.request = Object.create(this.request))
     /** @type {KoaResponse} */
-    const response = context.response = Object.create(this.response)
+    const response = (context.response = Object.create(this.response))
     context.app = request.app = response.app = this
     context.req = request.req = response.req = req
     context.res = request.res = response.res = res
@@ -232,7 +231,7 @@ module.exports = class Application extends Emitter {
     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 (!isNativeError) { throw new TypeError(util.format('non-error thrown: %j', err)) }
 
     if (err.status === 404 || err.expose) return
     if (this.silent) return
@@ -305,9 +304,9 @@ function respond (ctx) {
 
   if (Buffer.isBuffer(body)) return res.end(body)
   if (typeof body === 'string') return res.end(body)
-  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)
+  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) }
   if (isStream(body)) return body.pipe(res)
 
   // body: json

package/lib/response.js

@@ -4,20 +4,22 @@
  * Module dependencies.
  */
 
+const assert = require('node:assert')
+const extname = require('node:path').extname
+const util = require('node:util')
+
 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 encodeUrl = require('encodeurl')
 const vary = require('vary')
+const getType = require('mime-types').contentType
+
 const isStream = require('./is-stream.js')
 const only = require('./only.js')
-const util = require('util')
-const encodeUrl = require('encodeurl')
 
 /**
  * Prototype.
@@ -318,8 +320,24 @@ module.exports = {
    */
 
   back (alt) {
-    const url = this.ctx.get('Referrer') || alt || '/'
-    this.redirect(url)
+    const referrer = this.ctx.get('Referrer')
+    if (referrer) {
+      // referrer is a relative path
+      if (referrer.startsWith('/')) {
+        this.redirect(referrer)
+        return
+      }
+
+      // referrer is an absolute URL, check if it's the same origin
+      const url = new URL(referrer, this.ctx.href)
+      if (url.host === this.ctx.host) {
+        this.redirect(referrer)
+        return
+      }
+    }
+
+    // no referrer, use alt or '/'
+    this.redirect(alt || '/')
   },
 
   /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "koa",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "Koa web app framework",
   "main": "lib/application.js",
   "exports": {
@@ -18,6 +18,7 @@
     "test": "node --test",
     "test:coverage": "c8 --reporter=lcov --reporter=text-summary node --test",
     "lint": "standard",
+    "lint:fix": "standard --fix",
     "lint:pretty": "standard | snazzy",
     "authors": "git log --format='%aN <%aE>' | sort -u > AUTHORS",
     "build": "gen-esm-wrapper . ./dist/koa.mjs",
@@ -35,32 +36,31 @@
   ],
   "license": "MIT",
   "dependencies": {
-    "accepts": "^1.3.5",
-    "cache-content-type": "^1.0.0",
-    "content-disposition": "~0.5.2",
-    "content-type": "^1.0.4",
+    "accepts": "^1.3.8",
+    "content-disposition": "~0.5.4",
+    "content-type": "^1.0.5",
     "cookies": "~0.9.1",
-    "debug": "^4.3.2",
     "delegates": "^1.0.0",
-    "destroy": "^1.0.4",
+    "destroy": "^1.2.0",
     "encodeurl": "^2.0.0",
     "escape-html": "^1.0.3",
     "fresh": "~0.5.2",
-    "http-assert": "^1.3.0",
+    "http-assert": "^1.5.0",
     "http-errors": "^2.0.0",
     "koa-compose": "^4.1.0",
-    "on-finished": "^2.3.0",
-    "parseurl": "^1.3.2",
+    "mime-types": "^3.0.1",
+    "on-finished": "^2.4.1",
+    "parseurl": "^1.3.3",
     "statuses": "^2.0.1",
     "type-is": "^2.0.1",
     "vary": "^1.1.2"
   },
   "devDependencies": {
     "c8": "^10.1.3",
-    "gen-esm-wrapper": "^1.0.6",
+    "gen-esm-wrapper": "^1.1.3",
     "snazzy": "^9.0.0",
-    "standard": "^17.1.0",
-    "supertest": "^7.0.0"
+    "standard": "^17.1.2",
+    "supertest": "^7.1.1"
   },
   "engines": {
     "node": ">= 18"