undici 6.20.0 → 7.0.0-alpha.2

package/lib/core/constants.js

@@ -1,10 +1,9 @@
 'use strict'
 
-/** @type {Record<string, string | undefined>} */
-const headerNameLowerCasedRecord = {}
-
-// https://developer.mozilla.org/docs/Web/HTTP/Headers
-const wellknownHeaderNames = [
+/**
+ * @see https://developer.mozilla.org/docs/Web/HTTP/Headers
+ */
+const wellknownHeaderNames = /** @type {const} */ ([
   'Accept',
   'Accept-Encoding',
   'Accept-Language',
@@ -100,7 +99,13 @@ const wellknownHeaderNames = [
   'X-Powered-By',
   'X-Requested-With',
   'X-XSS-Protection'
-]
+])
+
+/** @type {Record<typeof wellknownHeaderNames[number]|Lowercase<typeof wellknownHeaderNames[number]>, string>} */
+const headerNameLowerCasedRecord = {}
+
+// Note: object prototypes should not be able to be referenced. e.g. `Object#hasOwnProperty`.
+Object.setPrototypeOf(headerNameLowerCasedRecord, null)
 
 for (let i = 0; i < wellknownHeaderNames.length; ++i) {
   const key = wellknownHeaderNames[i]
@@ -109,9 +114,6 @@ for (let i = 0; i < wellknownHeaderNames.length; ++i) {
     lowerCasedKey
 }
 
-// Note: object prototypes should not be able to be referenced. e.g. `Object#hasOwnProperty`.
-Object.setPrototypeOf(headerNameLowerCasedRecord, null)
-
 module.exports = {
   wellknownHeaderNames,
   headerNameLowerCasedRecord

package/lib/core/diagnostics.js

@@ -1,11 +1,12 @@
 'use strict'
+
 const diagnosticsChannel = require('node:diagnostics_channel')
 const util = require('node:util')
 
 const undiciDebugLog = util.debuglog('undici')
 const fetchDebuglog = util.debuglog('fetch')
 const websocketDebuglog = util.debuglog('websocket')
-let isClientSet = false
+
 const channels = {
   // Client
   beforeConnect: diagnosticsChannel.channel('undici:client:beforeConnect'),
@@ -26,102 +27,21 @@ const channels = {
   pong: diagnosticsChannel.channel('undici:websocket:pong')
 }
 
-if (undiciDebugLog.enabled || fetchDebuglog.enabled) {
-  const debuglog = fetchDebuglog.enabled ? fetchDebuglog : undiciDebugLog
-
-  // Track all Client events
-  diagnosticsChannel.channel('undici:client:beforeConnect').subscribe(evt => {
-    const {
-      connectParams: { version, protocol, port, host }
-    } = evt
-    debuglog(
-      'connecting to %s using %s%s',
-      `${host}${port ? `:${port}` : ''}`,
-      protocol,
-      version
-    )
-  })
-
-  diagnosticsChannel.channel('undici:client:connected').subscribe(evt => {
-    const {
-      connectParams: { version, protocol, port, host }
-    } = evt
-    debuglog(
-      'connected to %s using %s%s',
-      `${host}${port ? `:${port}` : ''}`,
-      protocol,
-      version
-    )
-  })
-
-  diagnosticsChannel.channel('undici:client:connectError').subscribe(evt => {
-    const {
-      connectParams: { version, protocol, port, host },
-      error
-    } = evt
-    debuglog(
-      'connection to %s using %s%s errored - %s',
-      `${host}${port ? `:${port}` : ''}`,
-      protocol,
-      version,
-      error.message
-    )
-  })
-
-  diagnosticsChannel.channel('undici:client:sendHeaders').subscribe(evt => {
-    const {
-      request: { method, path, origin }
-    } = evt
-    debuglog('sending request to %s %s/%s', method, origin, path)
-  })
-
-  // Track Request events
-  diagnosticsChannel.channel('undici:request:headers').subscribe(evt => {
-    const {
-      request: { method, path, origin },
-      response: { statusCode }
-    } = evt
-    debuglog(
-      'received response to %s %s/%s - HTTP %d',
-      method,
-      origin,
-      path,
-      statusCode
-    )
-  })
-
-  diagnosticsChannel.channel('undici:request:trailers').subscribe(evt => {
-    const {
-      request: { method, path, origin }
-    } = evt
-    debuglog('trailers received from %s %s/%s', method, origin, path)
-  })
-
-  diagnosticsChannel.channel('undici:request:error').subscribe(evt => {
-    const {
-      request: { method, path, origin },
-      error
-    } = evt
-    debuglog(
-      'request to %s %s/%s errored - %s',
-      method,
-      origin,
-      path,
-      error.message
-    )
-  })
-
-  isClientSet = true
-}
+let isTrackingClientEvents = false
 
-if (websocketDebuglog.enabled) {
-  if (!isClientSet) {
-    const debuglog = undiciDebugLog.enabled ? undiciDebugLog : websocketDebuglog
-    diagnosticsChannel.channel('undici:client:beforeConnect').subscribe(evt => {
+function trackClientEvents (debugLog = undiciDebugLog) {
+  if (isTrackingClientEvents) {
+    return
+  }
+
+  isTrackingClientEvents = true
+
+  diagnosticsChannel.subscribe('undici:client:beforeConnect',
+    evt => {
       const {
         connectParams: { version, protocol, port, host }
       } = evt
-      debuglog(
+      debugLog(
         'connecting to %s%s using %s%s',
         host,
         port ? `:${port}` : '',
@@ -130,11 +50,12 @@ if (websocketDebuglog.enabled) {
       )
     })
 
-    diagnosticsChannel.channel('undici:client:connected').subscribe(evt => {
+  diagnosticsChannel.subscribe('undici:client:connected',
+    evt => {
       const {
         connectParams: { version, protocol, port, host }
       } = evt
-      debuglog(
+      debugLog(
         'connected to %s%s using %s%s',
         host,
         port ? `:${port}` : '',
@@ -143,12 +64,13 @@ if (websocketDebuglog.enabled) {
       )
     })
 
-    diagnosticsChannel.channel('undici:client:connectError').subscribe(evt => {
+  diagnosticsChannel.subscribe('undici:client:connectError',
+    evt => {
       const {
         connectParams: { version, protocol, port, host },
         error
       } = evt
-      debuglog(
+      debugLog(
         'connection to %s%s using %s%s errored - %s',
         host,
         port ? `:${port}` : '',
@@ -158,43 +80,115 @@ if (websocketDebuglog.enabled) {
       )
     })
 
-    diagnosticsChannel.channel('undici:client:sendHeaders').subscribe(evt => {
+  diagnosticsChannel.subscribe('undici:client:sendHeaders',
+    evt => {
+      const {
+        request: { method, path, origin }
+      } = evt
+      debugLog('sending request to %s %s/%s', method, origin, path)
+    })
+}
+
+let isTrackingRequestEvents = false
+
+function trackRequestEvents (debugLog = undiciDebugLog) {
+  if (isTrackingRequestEvents) {
+    return
+  }
+
+  isTrackingRequestEvents = true
+
+  diagnosticsChannel.subscribe('undici:request:headers',
+    evt => {
+      const {
+        request: { method, path, origin },
+        response: { statusCode }
+      } = evt
+      debugLog(
+        'received response to %s %s/%s - HTTP %d',
+        method,
+        origin,
+        path,
+        statusCode
+      )
+    })
+
+  diagnosticsChannel.subscribe('undici:request:trailers',
+    evt => {
       const {
         request: { method, path, origin }
       } = evt
-      debuglog('sending request to %s %s/%s', method, origin, path)
+      debugLog('trailers received from %s %s/%s', method, origin, path)
+    })
+
+  diagnosticsChannel.subscribe('undici:request:error',
+    evt => {
+      const {
+        request: { method, path, origin },
+        error
+      } = evt
+      debugLog(
+        'request to %s %s/%s errored - %s',
+        method,
+        origin,
+        path,
+        error.message
+      )
     })
+}
+
+let isTrackingWebSocketEvents = false
+
+function trackWebSocketEvents (debugLog = websocketDebuglog) {
+  if (isTrackingWebSocketEvents) {
+    return
   }
 
-  // Track all WebSocket events
-  diagnosticsChannel.channel('undici:websocket:open').subscribe(evt => {
-    const {
-      address: { address, port }
-    } = evt
-    websocketDebuglog('connection opened %s%s', address, port ? `:${port}` : '')
-  })
-
-  diagnosticsChannel.channel('undici:websocket:close').subscribe(evt => {
-    const { websocket, code, reason } = evt
-    websocketDebuglog(
-      'closed connection to %s - %s %s',
-      websocket.url,
-      code,
-      reason
-    )
-  })
-
-  diagnosticsChannel.channel('undici:websocket:socket_error').subscribe(err => {
-    websocketDebuglog('connection errored - %s', err.message)
-  })
-
-  diagnosticsChannel.channel('undici:websocket:ping').subscribe(evt => {
-    websocketDebuglog('ping received')
-  })
-
-  diagnosticsChannel.channel('undici:websocket:pong').subscribe(evt => {
-    websocketDebuglog('pong received')
-  })
+  isTrackingWebSocketEvents = true
+
+  diagnosticsChannel.subscribe('undici:websocket:open',
+    evt => {
+      const {
+        address: { address, port }
+      } = evt
+      debugLog('connection opened %s%s', address, port ? `:${port}` : '')
+    })
+
+  diagnosticsChannel.subscribe('undici:websocket:close',
+    evt => {
+      const { websocket, code, reason } = evt
+      debugLog(
+        'closed connection to %s - %s %s',
+        websocket.url,
+        code,
+        reason
+      )
+    })
+
+  diagnosticsChannel.subscribe('undici:websocket:socket_error',
+    err => {
+      debugLog('connection errored - %s', err.message)
+    })
+
+  diagnosticsChannel.subscribe('undici:websocket:ping',
+    evt => {
+      debugLog('ping received')
+    })
+
+  diagnosticsChannel.subscribe('undici:websocket:pong',
+    evt => {
+      debugLog('pong received')
+    })
+}
+
+if (undiciDebugLog.enabled || fetchDebuglog.enabled) {
+  trackClientEvents(fetchDebuglog.enabled ? fetchDebuglog : undiciDebugLog)
+  trackRequestEvents(fetchDebuglog.enabled ? fetchDebuglog : undiciDebugLog)
+}
+
+if (websocketDebuglog.enabled) {
+  trackClientEvents(undiciDebugLog.enabled ? undiciDebugLog : websocketDebuglog)
+  trackWebSocketEvents(websocketDebuglog)
 }
 
 module.exports = {

package/lib/core/errors.js

@@ -1,8 +1,8 @@
 'use strict'
 
 class UndiciError extends Error {
-  constructor (message) {
-    super(message)
+  constructor (message, options) {
+    super(message, options)
     this.name = 'UndiciError'
     this.code = 'UND_ERR'
   }
@@ -208,8 +208,8 @@ class ResponseError extends UndiciError {
 }
 
 class SecureProxyConnectionError extends UndiciError {
-  constructor (cause, message, options) {
-    super(message, { cause, ...(options ?? {}) })
+  constructor (cause, message, options = {}) {
+    super(message, { cause, ...options })
     this.name = 'SecureProxyConnectionError'
     this.message = message || 'Secure Proxy Connection failed'
     this.code = 'UND_ERR_PRX_TLS'

package/lib/core/request.js

@@ -14,8 +14,8 @@ const {
   isFormDataLike,
   isIterable,
   isBlobLike,
-  buildURL,
-  validateHandler,
+  serializePathWithQuery,
+  assertRequestHandler,
   getServerName,
   normalizedMethodRecords
 } = require('./util')
@@ -40,9 +40,9 @@ class Request {
     headersTimeout,
     bodyTimeout,
     reset,
-    throwOnError,
     expectContinue,
-    servername
+    servername,
+    throwOnError
   }, handler) {
     if (typeof path !== 'string') {
       throw new InvalidArgumentError('path must be a string')
@@ -82,12 +82,14 @@ class Request {
       throw new InvalidArgumentError('invalid expectContinue')
     }
 
+    if (throwOnError != null) {
+      throw new InvalidArgumentError('invalid throwOnError')
+    }
+
     this.headersTimeout = headersTimeout
 
     this.bodyTimeout = bodyTimeout
 
-    this.throwOnError = throwOnError === true
-
     this.method = method
 
     this.abort = null
@@ -133,7 +135,7 @@ class Request {
 
     this.upgrade = upgrade || null
 
-    this.path = query ? buildURL(path, query) : path
+    this.path = query ? serializePathWithQuery(path, query) : path
 
     this.origin = origin
 
@@ -181,9 +183,9 @@ class Request {
       throw new InvalidArgumentError('headers must be an object or an array')
     }
 
-    validateHandler(handler, method, upgrade)
+    assertRequestHandler(handler, method, upgrade)
 
-    this.servername = servername || getServerName(this.host)
+    this.servername = servername || getServerName(this.host) || null
 
     this[kHandler] = handler
 

package/lib/core/symbols.js

@@ -1,3 +1,5 @@
+'use strict'
+
 module.exports = {
   kClose: Symbol('close'),
   kDestroy: Symbol('destroy'),
@@ -52,7 +54,6 @@ module.exports = {
   kMaxRequests: Symbol('maxRequestsPerClient'),
   kProxy: Symbol('proxy agent options'),
   kCounter: Symbol('socket request counter'),
-  kInterceptors: Symbol('dispatch interceptors'),
   kMaxResponseSize: Symbol('max response size'),
   kHTTP2Session: Symbol('http2Session'),
   kHTTP2SessionState: Symbol('http2Session state'),

package/lib/core/tree.js

@@ -40,6 +40,7 @@ class TstNode {
   /**
    * @param {string} key
    * @param {any} value
+   * @returns {void}
    */
   add (key, value) {
     const length = key.length
@@ -47,6 +48,9 @@ class TstNode {
       throw new TypeError('Unreachable')
     }
     let index = 0
+    /**
+     * @type {TstNode}
+     */
     let node = this
     while (true) {
       const code = key.charCodeAt(index)
@@ -87,6 +91,9 @@ class TstNode {
   search (key) {
     const keylength = key.length
     let index = 0
+    /**
+     * @type {TstNode|null}
+     */
     let node = this
     while (node !== null && index < keylength) {
       let code = key[index]
@@ -121,6 +128,7 @@ class TernarySearchTree {
   /**
    * @param {string} key
    * @param {any} value
+   * @returns {void}
    * */
   insert (key, value) {
     if (this.node === null) {
@@ -132,7 +140,7 @@ class TernarySearchTree {
 
   /**
    * @param {Uint8Array} key
-   * @return {any}
+   * @returns {any}
    */
   lookup (key) {
     return this.node?.search(key)?.value ?? null