koa 3.2.1 → 3.3.0

package/dist/koa.mjs

@@ -2,3 +2,5 @@ import mod from "../lib/application.js";
 
 export default mod;
 export const HttpError = mod.HttpError;
+export const createHttpError = mod.createHttpError;
+export const isHttpError = mod.isHttpError;

package/lib/application.js

@@ -14,7 +14,7 @@ const { AsyncLocalStorage } = require('node:async_hooks')
 const onFinished = require('on-finished')
 const compose = require('koa-compose')
 const statuses = require('statuses')
-const { HttpError } = require('http-errors')
+const createHttpError = require('http-errors')
 
 const request = require('./request')
 const response = require('./response')
@@ -22,6 +22,26 @@ const context = require('./context')
 const isStream = require('./is-stream.js')
 const only = require('./only.js')
 
+function isHttpErrorLike (err) {
+  if (!err || typeof err !== 'object') return false
+  if (!(err instanceof Error)) return false
+  if (typeof err.expose !== 'boolean') return false
+  if (typeof err.statusCode !== 'number') return false
+
+  const hasMatchingStatusCode = err.status === err.statusCode
+  return hasMatchingStatusCode
+}
+
+Object.defineProperty(createHttpError.HttpError, Symbol.hasInstance, {
+  configurable: true,
+  value (err) {
+    const matchesPrototype = Function.prototype[Symbol.hasInstance].call(this, err)
+    if (matchesPrototype) return true
+    if (this !== createHttpError.HttpError) return false
+    return isHttpErrorLike(err)
+  }
+})
+
 /** @typedef {typeof import ('./context') & {
  *  app: Application
  *  req: import('http').IncomingMessage
@@ -58,14 +78,14 @@ module.exports = class Application extends Emitter {
   /**
    *
    * @param {object} [options] Application options
-   * @param {string} [options.env='development'] Environment
+   * @param {string} [options.env='development'] Environment. Defaults to `NODE_ENV` or `'development'`.
    * @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 {boolean} [options.proxy] When `true`, proxy header fields will be trusted.
+   * @param {number} [options.subdomainOffset] Subdomain offset, defaults to `2`
+   * @param {string} [options.proxyIpHeader] Proxy IP header, defaults to `X-Forwarded-For`
+   * @param {number} [options.maxIpsCount] Max IPs read from proxy IP header, defaults to `0` (means infinity)
    * @param {function} [options.compose] Function to handle middleware composition
-   * @param {boolean} [options.asyncLocalStorage] Enable AsyncLocalStorage, default to false
+   * @param {boolean|AsyncLocalStorage} [options.asyncLocalStorage] Pass `true` or an instance of `AsyncLocalStorage` to enable async local storage.
    *
    */
 
@@ -337,8 +357,9 @@ function respond (ctx) {
 }
 
 /**
- * Make HttpError available to consumers of the library so that consumers don't
- * have a direct dependency upon `http-errors`
+ * Expose HTTP error utilities for consumers.
+ * This avoids requiring consumers to depend directly on `http-errors`.
  */
-
-module.exports.HttpError = HttpError
+module.exports.createHttpError = createHttpError
+module.exports.HttpError = createHttpError.HttpError
+module.exports.isHttpError = createHttpError.isHttpError

package/lib/context.js

@@ -143,7 +143,13 @@ const proto = module.exports = {
     }
 
     // then set those specified
-    this.set(err.headers)
+    const headers = err.headers || {}
+    Object.keys(headers).forEach(name => {
+      const lowerName = name.toLowerCase()
+      const generatedHeader = lowerName === 'content-type' || lowerName === 'content-length'
+      if (generatedHeader) return
+      this.set(name, headers[name])
+    })
 
     // force text/plain
     this.type = 'text'

package/lib/request.js

@@ -18,6 +18,8 @@ const only = require('./only.js')
 const util = require('util')
 
 const IP = Symbol('context#ip')
+const HTTP_URL_PREFIX = /^https?:\/\//i
+const INVALID_IPV6_HOST_CHARACTERS = /[/?#\\\s]/
 
 /**
  * Prototype.
@@ -108,7 +110,7 @@ module.exports = {
 
   get href () {
     // support: `GET http://example.com/foo`
-    if (/^https?:\/\//i.test(this.originalUrl)) return this.originalUrl
+    if (HTTP_URL_PREFIX.test(this.originalUrl)) return this.originalUrl
     return this.protocol + '://' + this.host + this.originalUrl
   },
 
@@ -171,7 +173,7 @@ module.exports = {
 
   get query () {
     const str = this.querystring
-    const c = this._querycache = this._querycache || {}
+    const c = this._querycache = this._querycache || Object.create(null)
     return c[str] || (c[str] = sp.parse(str))
   },
 
@@ -281,8 +283,15 @@ module.exports = {
   get hostname () {
     const host = this.host
     if (!host) return ''
-    if (host[0] === '[') return this.URL.hostname || '' // IPv6
-    return host.split(':', 1)[0]
+    const isIPv6 = host[0] === '['
+    const hasInvalidIPv6Characters = isIPv6 && INVALID_IPV6_HOST_CHARACTERS.test(host)
+    if (hasInvalidIPv6Characters) return ''
+    try {
+      if (isIPv6) return new URL(`http://${host}`).hostname // IPv6
+      return host.split(':', 1)[0]
+    } catch {
+      return ''
+    }
   },
 
   /**
@@ -298,7 +307,9 @@ module.exports = {
     if (!this.memoizedURL) {
       const originalUrl = this.originalUrl || '' // avoid undefined in template string
       try {
-        this.memoizedURL = new URL(`${this.protocol}://${this.host}${originalUrl}`)
+        this.memoizedURL = HTTP_URL_PREFIX.test(originalUrl)
+          ? new URL(originalUrl)
+          : new URL(`${this.protocol}://${this.host}${originalUrl}`)
       } catch (err) {
         this.memoizedURL = Object.create(null)
       }
@@ -412,7 +423,7 @@ module.exports = {
     if (this.socket.encrypted) return 'https'
     if (!this.app.proxy) return 'http'
     const proto = this.get('X-Forwarded-Proto')
-    return proto ? splitCommaSeparatedValues(proto, 1)[0] : 'http'
+    return proto ? splitCommaSeparatedValues(proto, 1)[0].toLowerCase() : 'http'
   },
 
   /**
@@ -491,7 +502,9 @@ module.exports = {
   get subdomains () {
     const offset = this.app.subdomainOffset
     const hostname = this.hostname
-    if (net.isIP(hostname)) return []
+    const isIPv6 = hostname[0] === '['
+    const ip = isIPv6 ? hostname.slice(1, -1) : hostname
+    if (net.isIP(ip)) return []
     return hostname
       .split('.')
       .reverse()

package/lib/response.js

@@ -21,6 +21,19 @@ const getType = require('mime-types').contentType
 const isStream = require('./is-stream.js')
 const only = require('./only.js')
 
+function isSingleValueHeader (field) {
+  const name = field.toLowerCase()
+  return name === 'content-type' || name === 'content-length'
+}
+
+function normalizeHeader (field, value) {
+  const singletonArray = isSingleValueHeader(field) && Array.isArray(value)
+  if (!singletonArray) return [field, value]
+
+  assert(value.length === 1, `${field} must contain exactly one value`)
+  return [field, value[0]]
+}
+
 /**
  * Prototype.
  */
@@ -207,7 +220,7 @@ module.exports = {
 
     // blob
     if (val instanceof Blob) {
-      if (setType) this.type = 'bin'
+      if (setType) this.type = val.type || 'bin'
       this.length = val.size
       cleanupPreviousStream()
       return
@@ -537,11 +550,12 @@ module.exports = {
   set (field, val) {
     if (this.headerSent || !field) return
 
-    if (typeof field === 'string') {
-      this.res.setHeader(field, val)
-    } else {
-      Object.keys(field).forEach(header => this.res.setHeader(header, field[header]))
-    }
+    const entries = typeof field === 'string' ? [[field, val]] : Object.entries(field)
+    const headers = entries.map(([name, value]) => normalizeHeader(name, value))
+
+    headers.forEach(([name, value]) => {
+      this.res.setHeader(name, value)
+    })
   },
 
   /**

package/lib/search-params.js

@@ -4,7 +4,7 @@ module.exports = {
   stringify: (obj) => {
     const searchParams = new URLSearchParams()
     const addKey = (k, v, params) => {
-      const val = typeof v === 'string' || typeof v === 'number' ? v : ''
+      const val = typeof v === 'string' || typeof v === 'number' || typeof v === 'boolean' ? v : ''
       params.append(k, val)
     }
 
@@ -26,7 +26,13 @@ module.exports = {
     const obj = {}
     for (const key of searchParams.keys()) {
       const values = searchParams.getAll(key)
-      obj[key] = values.length <= 1 ? values[0] : values
+      const value = values.length <= 1 ? values[0] : values
+      Object.defineProperty(obj, key, {
+        value,
+        writable: true,
+        enumerable: true,
+        configurable: true
+      })
     }
     return obj
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "koa",
-  "version": "3.2.1",
+  "version": "3.3.0",
   "description": "Koa web app framework",
   "main": "lib/application.js",
   "exports": {
@@ -56,7 +56,7 @@
     "vary": "^1.1.2"
   },
   "devDependencies": {
-    "c8": "^10.1.3",
+    "c8": "^12.0.0",
     "gen-esm-wrapper": "^1.1.3",
     "snazzy": "^9.0.0",
     "standard": "^17.1.2",