undici 6.20.0 → 7.0.0-alpha.2

package/lib/dispatcher/client.js

@@ -1,5 +1,3 @@
-// @ts-check
-
 'use strict'
 
 const assert = require('node:assert')
@@ -43,13 +41,11 @@ const {
   kBodyTimeout,
   kStrictContentLength,
   kConnector,
-  kMaxRedirections,
   kMaxRequests,
   kCounter,
   kClose,
   kDestroy,
   kDispatch,
-  kInterceptors,
   kLocalAddress,
   kMaxResponseSize,
   kOnError,
@@ -59,10 +55,18 @@ const {
 } = require('../core/symbols.js')
 const connectH1 = require('./client-h1.js')
 const connectH2 = require('./client-h2.js')
-let deprecatedInterceptorWarned = false
 
 const kClosedResolve = Symbol('kClosedResolve')
 
+const getDefaultNodeMaxHeaderSize = http &&
+  http.maxHeaderSize &&
+  Number.isInteger(http.maxHeaderSize) &&
+  http.maxHeaderSize > 0
+  ? () => http.maxHeaderSize
+  : () => { throw new InvalidArgumentError('http module not available or http.maxHeaderSize invalid') }
+
+const noop = () => {}
+
 function getPipelining (client) {
   return client[kPipelining] ?? client[kHTTPContext]?.defaultPipelining ?? 1
 }
@@ -77,7 +81,6 @@ class Client extends DispatcherBase {
    * @param {import('../../types/client.js').Client.Options} options
    */
   constructor (url, {
-    interceptors,
     maxHeaderSize,
     headersTimeout,
     socketTimeout,
@@ -95,7 +98,6 @@ class Client extends DispatcherBase {
     tls,
     strictContentLength,
     maxCachedSessions,
-    maxRedirections,
     connect,
     maxRequestsPerClient,
     localAddress,
@@ -106,8 +108,6 @@ class Client extends DispatcherBase {
     maxConcurrentStreams,
     allowH2
   } = {}) {
-    super()
-
     if (keepAlive !== undefined) {
       throw new InvalidArgumentError('unsupported keepAlive, use pipelining=0 instead')
     }
@@ -128,8 +128,14 @@ class Client extends DispatcherBase {
       throw new InvalidArgumentError('unsupported maxKeepAliveTimeout, use keepAliveMaxTimeout instead')
     }
 
-    if (maxHeaderSize != null && !Number.isFinite(maxHeaderSize)) {
-      throw new InvalidArgumentError('invalid maxHeaderSize')
+    if (maxHeaderSize != null) {
+      if (!Number.isInteger(maxHeaderSize) || maxHeaderSize < 1) {
+        throw new InvalidArgumentError('invalid maxHeaderSize')
+      }
+    } else {
+      // If maxHeaderSize is not provided, use the default value from the http module
+      // or if that is not available, throw an error.
+      maxHeaderSize = getDefaultNodeMaxHeaderSize()
     }
 
     if (socketPath != null && typeof socketPath !== 'string') {
@@ -164,10 +170,6 @@ class Client extends DispatcherBase {
       throw new InvalidArgumentError('connect must be a function or an object')
     }
 
-    if (maxRedirections != null && (!Number.isInteger(maxRedirections) || maxRedirections < 0)) {
-      throw new InvalidArgumentError('maxRedirections must be a positive number')
-    }
-
     if (maxRequestsPerClient != null && (!Number.isInteger(maxRequestsPerClient) || maxRequestsPerClient < 0)) {
       throw new InvalidArgumentError('maxRequestsPerClient must be a positive number')
     }
@@ -196,6 +198,8 @@ class Client extends DispatcherBase {
       throw new InvalidArgumentError('maxConcurrentStreams must be a positive integer, greater than 0')
     }
 
+    super()
+
     if (typeof connect !== 'function') {
       connect = buildConnector({
         ...tls,
@@ -208,22 +212,10 @@ class Client extends DispatcherBase {
       })
     }
 
-    if (interceptors?.Client && Array.isArray(interceptors.Client)) {
-      this[kInterceptors] = interceptors.Client
-      if (!deprecatedInterceptorWarned) {
-        deprecatedInterceptorWarned = true
-        process.emitWarning('Client.Options#interceptor is deprecated. Use Dispatcher#compose instead.', {
-          code: 'UNDICI-CLIENT-INTERCEPTOR-DEPRECATED'
-        })
-      }
-    } else {
-      this[kInterceptors] = [createRedirectInterceptor({ maxRedirections })]
-    }
-
     this[kUrl] = util.parseOrigin(url)
     this[kConnector] = connect
     this[kPipelining] = pipelining != null ? pipelining : 1
-    this[kMaxHeadersSize] = maxHeaderSize || http.maxHeaderSize
+    this[kMaxHeadersSize] = maxHeaderSize
     this[kKeepAliveDefaultTimeout] = keepAliveTimeout == null ? 4e3 : keepAliveTimeout
     this[kKeepAliveMaxTimeout] = keepAliveMaxTimeout == null ? 600e3 : keepAliveMaxTimeout
     this[kKeepAliveTimeoutThreshold] = keepAliveTimeoutThreshold == null ? 2e3 : keepAliveTimeoutThreshold
@@ -236,7 +228,6 @@ class Client extends DispatcherBase {
     this[kBodyTimeout] = bodyTimeout != null ? bodyTimeout : 300e3
     this[kHeadersTimeout] = headersTimeout != null ? headersTimeout : 300e3
     this[kStrictContentLength] = strictContentLength == null ? true : strictContentLength
-    this[kMaxRedirections] = maxRedirections
     this[kMaxRequests] = maxRequestsPerClient
     this[kClosedResolve] = null
     this[kMaxResponseSize] = maxResponseSize > -1 ? maxResponseSize : -1
@@ -362,8 +353,6 @@ class Client extends DispatcherBase {
   }
 }
 
-const createRedirectInterceptor = require('../interceptor/redirect-interceptor.js')
-
 function onError (client, err) {
   if (
     client[kRunning] === 0 &&
@@ -402,7 +391,7 @@ async function connect (client) {
     assert(idx !== -1)
     const ip = hostname.substring(1, idx)
 
-    assert(net.isIP(ip))
+    assert(net.isIPv6(ip))
     hostname = ip
   }
 
@@ -442,7 +431,7 @@ async function connect (client) {
     })
 
     if (client.destroyed) {
-      util.destroy(socket.on('error', () => {}), new ClientDestroyedError())
+      util.destroy(socket.on('error', noop), new ClientDestroyedError())
       return
     }
 
@@ -453,7 +442,7 @@ async function connect (client) {
         ? await connectH2(client, socket)
         : await connectH1(client, socket)
     } catch (err) {
-      socket.destroy().on('error', () => {})
+      socket.destroy().on('error', noop)
       throw err
     }
 

package/lib/dispatcher/dispatcher-base.js

@@ -6,11 +6,10 @@ const {
   ClientClosedError,
   InvalidArgumentError
 } = require('../core/errors')
-const { kDestroy, kClose, kClosed, kDestroyed, kDispatch, kInterceptors } = require('../core/symbols')
+const { kDestroy, kClose, kClosed, kDestroyed, kDispatch } = require('../core/symbols')
 
 const kOnDestroyed = Symbol('onDestroyed')
 const kOnClosed = Symbol('onClosed')
-const kInterceptedDispatch = Symbol('Intercepted Dispatch')
 
 class DispatcherBase extends Dispatcher {
   constructor () {
@@ -30,23 +29,6 @@ class DispatcherBase extends Dispatcher {
     return this[kClosed]
   }
 
-  get interceptors () {
-    return this[kInterceptors]
-  }
-
-  set interceptors (newInterceptors) {
-    if (newInterceptors) {
-      for (let i = newInterceptors.length - 1; i >= 0; i--) {
-        const interceptor = this[kInterceptors][i]
-        if (typeof interceptor !== 'function') {
-          throw new InvalidArgumentError('interceptor must be an function')
-        }
-      }
-    }
-
-    this[kInterceptors] = newInterceptors
-  }
-
   close (callback) {
     if (callback === undefined) {
       return new Promise((resolve, reject) => {
@@ -142,20 +124,6 @@ class DispatcherBase extends Dispatcher {
     })
   }
 
-  [kInterceptedDispatch] (opts, handler) {
-    if (!this[kInterceptors] || this[kInterceptors].length === 0) {
-      this[kInterceptedDispatch] = this[kDispatch]
-      return this[kDispatch](opts, handler)
-    }
-
-    let dispatch = this[kDispatch].bind(this)
-    for (let i = this[kInterceptors].length - 1; i >= 0; i--) {
-      dispatch = this[kInterceptors][i](dispatch)
-    }
-    this[kInterceptedDispatch] = dispatch
-    return dispatch(opts, handler)
-  }
-
   dispatch (opts, handler) {
     if (!handler || typeof handler !== 'object') {
       throw new InvalidArgumentError('handler must be an object')
@@ -174,7 +142,7 @@ class DispatcherBase extends Dispatcher {
         throw new ClientClosedError()
       }
 
-      return this[kInterceptedDispatch](opts, handler)
+      return this[kDispatch](opts, handler)
     } catch (err) {
       if (typeof handler.onError !== 'function') {
         throw new InvalidArgumentError('invalid onError method')

package/lib/dispatcher/dispatcher.js

@@ -35,30 +35,9 @@ class Dispatcher extends EventEmitter {
       }
     }
 
-    return new ComposedDispatcher(this, dispatch)
-  }
-}
-
-class ComposedDispatcher extends Dispatcher {
-  #dispatcher = null
-  #dispatch = null
-
-  constructor (dispatcher, dispatch) {
-    super()
-    this.#dispatcher = dispatcher
-    this.#dispatch = dispatch
-  }
-
-  dispatch (...args) {
-    this.#dispatch(...args)
-  }
-
-  close (...args) {
-    return this.#dispatcher.close(...args)
-  }
-
-  destroy (...args) {
-    return this.#dispatcher.destroy(...args)
+    return new Proxy(this, {
+      get: (target, key) => key === 'dispatch' ? dispatch : target[key]
+    })
   }
 }
 

package/lib/dispatcher/fixed-queue.js

@@ -1,12 +1,10 @@
-/* eslint-disable */
-
 'use strict'
 
 // Extracted from node/lib/internal/fixed_queue.js
 
 // Currently optimal queue size, tested on V8 6.0 - 6.6. Must be power of two.
-const kSize = 2048;
-const kMask = kSize - 1;
+const kSize = 2048
+const kMask = kSize - 1
 
 // The FixedQueue is implemented as a singly-linked list of fixed-size
 // circular buffers. It looks something like this:
@@ -17,18 +15,18 @@ const kMask = kSize - 1;
 // +-----------+ <-----\       +-----------+ <------\         +-----------+
 // |  [null]   |        \----- |   next    |         \------- |   next    |
 // +-----------+               +-----------+                  +-----------+
-// |   item    | <-- bottom    |   item    | <-- bottom       |  [empty]  |
-// |   item    |               |   item    |                  |  [empty]  |
-// |   item    |               |   item    |                  |  [empty]  |
-// |   item    |               |   item    |                  |  [empty]  |
+// |   item    | <-- bottom    |   item    | <-- bottom       | undefined |
+// |   item    |               |   item    |                  | undefined |
+// |   item    |               |   item    |                  | undefined |
+// |   item    |               |   item    |                  | undefined |
 // |   item    |               |   item    |       bottom --> |   item    |
 // |   item    |               |   item    |                  |   item    |
 // |    ...    |               |    ...    |                  |    ...    |
 // |   item    |               |   item    |                  |   item    |
 // |   item    |               |   item    |                  |   item    |
-// |  [empty]  | <-- top       |   item    |                  |   item    |
-// |  [empty]  |               |   item    |                  |   item    |
-// |  [empty]  |               |  [empty]  | <-- top  top --> |  [empty]  |
+// | undefined | <-- top       |   item    |                  |   item    |
+// | undefined |               |   item    |                  |   item    |
+// | undefined |               | undefined | <-- top  top --> | undefined |
 // +-----------+               +-----------+                  +-----------+
 //
 // Or, if there is only one circular buffer, it looks something
@@ -40,12 +38,12 @@ const kMask = kSize - 1;
 // +-----------+                               +-----------+
 // |  [null]   |                               |  [null]   |
 // +-----------+                               +-----------+
-// |  [empty]  |                               |   item    |
-// |  [empty]  |                               |   item    |
-// |   item    | <-- bottom            top --> |  [empty]  |
-// |   item    |                               |  [empty]  |
-// |  [empty]  | <-- top            bottom --> |   item    |
-// |  [empty]  |                               |   item    |
+// | undefined |                               |   item    |
+// | undefined |                               |   item    |
+// |   item    | <-- bottom            top --> | undefined |
+// |   item    |                               | undefined |
+// | undefined | <-- top            bottom --> |   item    |
+// | undefined |                               |   item    |
 // +-----------+                               +-----------+
 //
 // Adding a value means moving `top` forward by one, removing means
@@ -56,62 +54,106 @@ const kMask = kSize - 1;
 // `top + 1 === bottom` it's full. This wastes a single space of storage
 // but allows much quicker checks.
 
+/**
+ * @type {FixedCircularBuffer}
+ * @template T
+ */
 class FixedCircularBuffer {
-  constructor() {
-    this.bottom = 0;
-    this.top = 0;
-    this.list = new Array(kSize);
-    this.next = null;
+  constructor () {
+    /**
+     * @type {number}
+     */
+    this.bottom = 0
+    /**
+     * @type {number}
+     */
+    this.top = 0
+    /**
+     * @type {Array<T|undefined>}
+     */
+    this.list = new Array(kSize).fill(undefined)
+    /**
+     * @type {T|null}
+     */
+    this.next = null
   }
 
-  isEmpty() {
-    return this.top === this.bottom;
+  /**
+   * @returns {boolean}
+   */
+  isEmpty () {
+    return this.top === this.bottom
   }
 
-  isFull() {
-    return ((this.top + 1) & kMask) === this.bottom;
+  /**
+   * @returns {boolean}
+   */
+  isFull () {
+    return ((this.top + 1) & kMask) === this.bottom
   }
 
-  push(data) {
-    this.list[this.top] = data;
-    this.top = (this.top + 1) & kMask;
+  /**
+   * @param {T} data
+   * @returns {void}
+   */
+  push (data) {
+    this.list[this.top] = data
+    this.top = (this.top + 1) & kMask
   }
 
-  shift() {
-    const nextItem = this.list[this.bottom];
-    if (nextItem === undefined)
-      return null;
-    this.list[this.bottom] = undefined;
-    this.bottom = (this.bottom + 1) & kMask;
-    return nextItem;
+  /**
+   * @returns {T|null}
+   */
+  shift () {
+    const nextItem = this.list[this.bottom]
+    if (nextItem === undefined) { return null }
+    this.list[this.bottom] = undefined
+    this.bottom = (this.bottom + 1) & kMask
+    return nextItem
   }
 }
 
+/**
+ * @template T
+ */
 module.exports = class FixedQueue {
-  constructor() {
-    this.head = this.tail = new FixedCircularBuffer();
+  constructor () {
+    /**
+     * @type {FixedCircularBuffer<T>}
+     */
+    this.head = this.tail = new FixedCircularBuffer()
   }
 
-  isEmpty() {
-    return this.head.isEmpty();
+  /**
+   * @returns {boolean}
+   */
+  isEmpty () {
+    return this.head.isEmpty()
   }
 
-  push(data) {
+  /**
+   * @param {T} data
+   */
+  push (data) {
     if (this.head.isFull()) {
       // Head is full: Creates a new queue, sets the old queue's `.next` to it,
       // and sets it as the new main queue.
-      this.head = this.head.next = new FixedCircularBuffer();
+      this.head = this.head.next = new FixedCircularBuffer()
     }
-    this.head.push(data);
+    this.head.push(data)
   }
 
-  shift() {
-    const tail = this.tail;
-    const next = tail.shift();
+  /**
+   * @returns {T|null}
+   */
+  shift () {
+    const tail = this.tail
+    const next = tail.shift()
     if (tail.isEmpty() && tail.next !== null) {
       // If there is another queue, it forms the new tail.
-      this.tail = tail.next;
+      this.tail = tail.next
+      tail.next = null
     }
-    return next;
+    return next
   }
-};
+}

package/lib/dispatcher/pool-stats.js

@@ -1,3 +1,5 @@
+'use strict'
+
 const { kFree, kConnected, kPending, kQueued, kRunning, kSize } = require('../core/symbols')
 const kPool = Symbol('pool')
 

package/lib/dispatcher/pool.js

@@ -12,7 +12,7 @@ const {
   InvalidArgumentError
 } = require('../core/errors')
 const util = require('../core/util')
-const { kUrl, kInterceptors } = require('../core/symbols')
+const { kUrl } = require('../core/symbols')
 const buildConnector = require('../core/connect')
 
 const kOptions = Symbol('options')
@@ -37,8 +37,6 @@ class Pool extends PoolBase {
     allowH2,
     ...options
   } = {}) {
-    super()
-
     if (connections != null && (!Number.isFinite(connections) || connections < 0)) {
       throw new InvalidArgumentError('invalid connections')
     }
@@ -51,6 +49,8 @@ class Pool extends PoolBase {
       throw new InvalidArgumentError('connect must be a function or an object')
     }
 
+    super()
+
     if (typeof connect !== 'function') {
       connect = buildConnector({
         ...tls,
@@ -63,9 +63,6 @@ class Pool extends PoolBase {
       })
     }
 
-    this[kInterceptors] = options.interceptors?.Pool && Array.isArray(options.interceptors.Pool)
-      ? options.interceptors.Pool
-      : []
     this[kConnections] = connections || null
     this[kUrl] = util.parseOrigin(origin)
     this[kOptions] = { ...util.deepClone(options), connect, allowH2 }

package/lib/dispatcher/proxy-agent.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const { kProxy, kClose, kDestroy, kInterceptors } = require('../core/symbols')
+const { kProxy, kClose, kDestroy } = require('../core/symbols')
 const { URL } = require('node:url')
 const Agent = require('./agent')
 const Pool = require('./pool')
@@ -23,10 +23,10 @@ function defaultFactory (origin, opts) {
   return new Pool(origin, opts)
 }
 
+const noop = () => {}
+
 class ProxyAgent extends DispatcherBase {
   constructor (opts) {
-    super()
-
     if (!opts || (typeof opts === 'object' && !(opts instanceof URL) && !opts.uri)) {
       throw new InvalidArgumentError('Proxy uri is mandatory')
     }
@@ -36,13 +36,12 @@ class ProxyAgent extends DispatcherBase {
       throw new InvalidArgumentError('Proxy opts.clientFactory must be a function.')
     }
 
+    super()
+
     const url = this.#getUrl(opts)
     const { href, origin, port, protocol, username, password, hostname: proxyHostname } = url
 
     this[kProxy] = { uri: href, protocol }
-    this[kInterceptors] = opts.interceptors?.ProxyAgent && Array.isArray(opts.interceptors.ProxyAgent)
-      ? opts.interceptors.ProxyAgent
-      : []
     this[kRequestTls] = opts.requestTls
     this[kProxyTls] = opts.proxyTls
     this[kProxyHeaders] = opts.headers || {}
@@ -81,7 +80,7 @@ class ProxyAgent extends DispatcherBase {
             servername: this[kProxyTls]?.servername || proxyHostname
           })
           if (statusCode !== 200) {
-            socket.on('error', () => {}).destroy()
+            socket.on('error', noop).destroy()
             callback(new RequestAbortedError(`Proxy response (${statusCode}) !== 200 when HTTP Tunneling`))
           }
           if (opts.protocol !== 'https:') {

package/lib/handler/decorator-handler.js

@@ -1,7 +1,11 @@
 'use strict'
 
+const assert = require('node:assert')
+
 module.exports = class DecoratorHandler {
   #handler
+  #onCompleteCalled = false
+  #onErrorCalled = false
 
   constructor (handler) {
     if (typeof handler !== 'object' || handler === null) {
@@ -15,30 +19,50 @@ module.exports = class DecoratorHandler {
   }
 
   onError (...args) {
+    this.#onErrorCalled = true
     return this.#handler.onError?.(...args)
   }
 
   onUpgrade (...args) {
+    assert(!this.#onCompleteCalled)
+    assert(!this.#onErrorCalled)
+
     return this.#handler.onUpgrade?.(...args)
   }
 
   onResponseStarted (...args) {
+    assert(!this.#onCompleteCalled)
+    assert(!this.#onErrorCalled)
+
     return this.#handler.onResponseStarted?.(...args)
   }
 
   onHeaders (...args) {
+    assert(!this.#onCompleteCalled)
+    assert(!this.#onErrorCalled)
+
     return this.#handler.onHeaders?.(...args)
   }
 
   onData (...args) {
+    assert(!this.#onCompleteCalled)
+    assert(!this.#onErrorCalled)
+
     return this.#handler.onData?.(...args)
   }
 
   onComplete (...args) {
+    assert(!this.#onCompleteCalled)
+    assert(!this.#onErrorCalled)
+
+    this.#onCompleteCalled = true
     return this.#handler.onComplete?.(...args)
   }
 
   onBodySent (...args) {
+    assert(!this.#onCompleteCalled)
+    assert(!this.#onErrorCalled)
+
     return this.#handler.onBodySent?.(...args)
   }
 }

package/lib/handler/redirect-handler.js

@@ -24,12 +24,21 @@ class BodyAsyncIterable {
 }
 
 class RedirectHandler {
+  static buildDispatch (dispatcher, maxRedirections) {
+    if (maxRedirections != null && (!Number.isInteger(maxRedirections) || maxRedirections < 0)) {
+      throw new InvalidArgumentError('maxRedirections must be a positive number')
+    }
+
+    const dispatch = dispatcher.dispatch.bind(dispatcher)
+    return (opts, originalHandler) => dispatch(opts, new RedirectHandler(dispatch, maxRedirections, opts, originalHandler))
+  }
+
   constructor (dispatch, maxRedirections, opts, handler) {
     if (maxRedirections != null && (!Number.isInteger(maxRedirections) || maxRedirections < 0)) {
       throw new InvalidArgumentError('maxRedirections must be a positive number')
     }
 
-    util.validateHandler(handler, opts.method, opts.upgrade)
+    util.assertRequestHandler(handler, opts.method, opts.upgrade)
 
     this.dispatch = dispatch
     this.location = null
@@ -137,7 +146,7 @@ class RedirectHandler {
 
         TLDR: undici always ignores 3xx response bodies.
 
-        Redirection is used to serve the requested resource from another URL, so it is assumes that
+        Redirection is used to serve the requested resource from another URL, so it assumes that
         no body is generated (and thus can be ignored). Even though generating a body is not prohibited.
 
         For status 301, 302, 303, 307 and 308 (the latter from RFC 7238), the specs mention that the body usually

package/lib/handler/retry-handler.js

@@ -194,8 +194,8 @@ class RetryHandler {
 
       // Only Partial Content 206 supposed to provide Content-Range,
       // any other status code that partially consumed the payload
-      // should not be retry because it would result in downstream
-      // wrongly concatanete multiple responses.
+      // should not be retried because it would result in downstream
+      // wrongly concatenate multiple responses.
       if (statusCode !== 206 && (this.start > 0 || statusCode !== 200)) {
         this.abort(
           new RequestRetryError('server does not support the range header and the payload was partially consumed', statusCode, {
@@ -281,7 +281,11 @@ class RetryHandler {
       // Weak etags are not useful for comparison nor cache
       // for instance not safe to assume if the response is byte-per-byte
       // equal
-      if (this.etag != null && this.etag.startsWith('W/')) {
+      if (
+        this.etag != null &&
+        this.etag[0] === 'W' &&
+        this.etag[1] === '/'
+      ) {
         this.etag = null
       }
 
@@ -339,6 +343,11 @@ class RetryHandler {
       onRetry.bind(this)
     )
 
+    /**
+     * @this {RetryHandler}
+     * @param {Error} [err]
+     * @returns
+     */
     function onRetry (err) {
       if (err != null || this.aborted || isDisturbed(this.opts.body)) {
         return this.handler.onError(err)