undici 4.11.2 → 4.12.2

package/README.md

@@ -203,13 +203,13 @@ not support or does not fully implement.
 * https://fetch.spec.whatwg.org/#garbage-collection
 
 The [Fetch Standard](https://fetch.spec.whatwg.org) allows users to skip consuming the response body by relying on
-[garbage collection](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Memory_Management#garbage_collection) to release connection resources. Undici does the same. However,
-garbage collection in Node is less aggressive and deterministic (due to the lack
-of clear idle periods that browser have through the rendering refresh rate)
-which means that leaving the release of connection resources to the garbage collector
-can lead to excessive connection usage, reduced performance (due to less connection re-use),
-and even stalls or deadlocks when running out of connections. Therefore, it is highly
-recommended to always either consume or cancel the response body.
+[garbage collection](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Memory_Management#garbage_collection) to release connection resources. Undici does not do the same. Therefore, it is important to always either consume or cancel the response body.
+
+Garbage collection in Node is less aggressive and deterministic
+(due to the lack of clear idle periods that browser have through the rendering refresh rate)
+which means that leaving the release of connection resources to the garbage collector can lead
+to excessive connection usage, reduced performance (due to less connection re-use), and even
+stalls or deadlocks when running out of connections.
 
 ```js
 // Do
@@ -289,7 +289,7 @@ pipeline requests, without checking whether the connection is persistent.
 Hence, automatic fallback to HTTP/1.0 or HTTP/1.1 without pipelining is
 not supported.
 
-Undici will immediately pipeline when retrying requests afters a failed
+Undici will immediately pipeline when retrying requests after a failed
 connection. However, Undici will not retry the first remaining requests in
 the prior pipeline and instead error the corresponding callback/promise/stream.
 

package/docs/api/Dispatcher.md

@@ -571,7 +571,7 @@ try {
 
 A faster version of `Dispatcher.request`. This method expects the second argument `factory` to return a [`stream.Writable`](https://nodejs.org/api/stream.html#stream_class_stream_writable) stream which the response will be written to. This improves performance by avoiding creating an intermediate [`stream.Readable`](https://nodejs.org/api/stream.html#stream_readable_streams) stream when the user expects to directly pipe the response body to a [`stream.Writable`](https://nodejs.org/api/stream.html#stream_class_stream_writable) stream.
 
-As demonstrated in [Example 1 - Basic GET stream request](#example-1---basic-get-stream-request), it is recommended to use the `option.opaque` property to avoid creating a closure for the `factory` method. This pattern works well with Node.js Web Frameworks such as [Fastify](https://fastify.io). See [Example 2 - Stream to Fastify Response](#example-2---stream-to-fastify-response) for more details.
+As demonstrated in [Example 1 - Basic GET stream request](#example-1-basic-get-stream-request), it is recommended to use the `option.opaque` property to avoid creating a closure for the `factory` method. This pattern works well with Node.js Web Frameworks such as [Fastify](https://fastify.io). See [Example 2 - Stream to Fastify Response](#example-2-stream-to-fastify-response) for more details.
 
 Arguments:
 

package/docs/best-practices/mocking-request.md

@@ -1,6 +1,6 @@
 # Mocking Request
 
-Undici have its own mocking [utility](docs/api/MockAgent.md). It allow us to intercept undici HTTP request and return mocked value instead. It can be useful for testing purposes.
+Undici have its own mocking [utility](../api/MockAgent.md). It allow us to intercept undici HTTP request and return mocked value instead. It can be useful for testing purposes.
 
 Example:
 
@@ -70,7 +70,7 @@ const badRequest = await bankTransfer('1234567890', '100')
 assert.deepEqual(badRequest, { message: 'bank account not found' })
 ```
 
-Explore other MockAgent functionality [here](docs/api/MockAgent.md)
+Explore other MockAgent functionality [here](../api/MockAgent.md)
 
 ## Debug Mock Value
 

package/docs/best-practices/proxy.md

@@ -2,7 +2,7 @@
 
 Connecting through a proxy is possible by:
 
-- Using [AgentProxy](docs/api/ProxyAgent.md).
+- Using [AgentProxy](../api/ProxyAgent.md).
 - Configuring `Client` or `Pool` constructor.
 
 The proxy url should be passed to the `Client` or `Pool` constructor, while the upstream server url

package/lib/api/readable.js

@@ -3,7 +3,7 @@
 'use strict'
 
 const assert = require('assert')
-const { Readable, consumers } = require('stream')
+const { Readable } = require('stream')
 const { RequestAbortedError, NotSupportedError } = require('../core/errors')
 const util = require('../core/util')
 const { ReadableStreamFrom, toUSVString } = require('../core/util')
@@ -144,7 +144,7 @@ module.exports = class BodyReadable extends Readable {
     return this[kBody]
   }
 
-  async dump(opts) {
+  async dump (opts) {
     let limit = opts && Number.isFinite(opts.limit) ? opts.limit : 262144
     try {
       for await (const chunk of this) {

package/lib/balanced-pool.js

@@ -1,7 +1,7 @@
 'use strict'
 
 const {
-  BalancedPoolMissingUpstreamError,
+  BalancedPoolMissingUpstreamError
 } = require('./core/errors')
 const {
   PoolBase,
@@ -9,8 +9,8 @@ const {
   kNeedDrain,
   kAddClient,
   kRemoveClient,
-  kDispatch,
- } = require('./pool-base')
+  kGetDispatcher
+} = require('./pool-base')
 const Pool = require('./pool')
 const { kUrl } = require('./core/symbols')
 
@@ -65,7 +65,7 @@ class BalancedPool extends PoolBase {
       .map((p) => p[kUrl].origin)
   }
 
-  [kDispatch] () {
+  [kGetDispatcher] () {
     // We validate that pools is greater than 0,
     // otherwise we would have to wait until an upstream
     // is added, which might never happen.
@@ -73,7 +73,7 @@ class BalancedPool extends PoolBase {
       throw new BalancedPoolMissingUpstreamError()
     }
 
-    let dispatcher = this[kClients].find(dispatcher => (
+    const dispatcher = this[kClients].find(dispatcher => (
       !dispatcher[kNeedDrain] &&
       dispatcher.closed !== true &&
       dispatcher.destroyed !== true

package/lib/client.js

@@ -1016,7 +1016,7 @@ function onParserTimeout (parser) {
   }
 }
 
-function onSocketReadable (data) {
+function onSocketReadable () {
   const { [kParser]: parser } = this
   parser.readMore()
 }

package/lib/core/util.js

@@ -150,7 +150,7 @@ function isDestroyed (stream) {
   return !stream || !!(stream.destroyed || stream[kDestroyed])
 }
 
-function isAborted (stream) {
+function isReadableAborted (stream) {
   const state = stream && stream._readableState
   return isDestroyed(stream) && state && !state.endEmitted
 }
@@ -244,15 +244,32 @@ function validateHandler (handler, method, upgrade) {
 // A body is disturbed if it has been read from and it cannot
 // be re-used without losing state or data.
 function isDisturbed (body) {
-  const state = body && body._readableState
   return !!(body && (
-    (stream.isDisturbed && stream.isDisturbed(body)) ||
-    body[kBodyUsed] ||
-    body.readableDidRead || (state && state.dataEmitted) ||
-    isAborted(body)
+    stream.isDisturbed
+      ? stream.isDisturbed(body) || body[kBodyUsed] // TODO (fix): Why is body[kBodyUsed] needed?
+      : body[kBodyUsed] ||
+        body.readableDidRead ||
+        (body._readableState && body._readableState.dataEmitted) ||
+        isReadableAborted(body)
   ))
 }
 
+function isErrored (body) {
+  return !!(body && (
+    stream.isErrored
+      ? stream.isErrored(body)
+      : /state: 'errored'/.test(nodeUtil.inspect(body)
+  )))
+}
+
+function isReadable (body) {
+  return !!(body && (
+    stream.isReadable
+      ? stream.isReadable(body)
+      : /state: 'readable'/.test(nodeUtil.inspect(body)
+  )))
+}
+
 function getSocketInfo (socket) {
   return {
     localAddress: socket.localAddress,
@@ -310,8 +327,10 @@ module.exports = {
   kEnumerableProperty,
   nop,
   isDisturbed,
+  isErrored,
+  isReadable,
   toUSVString: nodeUtil.toUSVString || ((val) => `${val}`),
-  isAborted,
+  isReadableAborted,
   isBlobLike,
   parseOrigin,
   parseURL,

package/lib/fetch/body.js

@@ -3,12 +3,13 @@
 const util = require('../core/util')
 const { ReadableStreamFrom, toUSVString, isBlobLike } = require('./util')
 const { FormData } = require('./formdata')
-const { kState, kError } = require('./symbols')
+const { kState } = require('./symbols')
 const { Blob } = require('buffer')
 const { kBodyUsed } = require('../core/symbols')
 const assert = require('assert')
 const nodeUtil = require('util')
 const { NotSupportedError } = require('../core/errors')
+const { isErrored } = require('../core/util')
 
 let ReadableStream
 
@@ -187,7 +188,7 @@ function extractBody (object, keepalive = false) {
           // Whenever one or more bytes are available and stream is not errored,
           // enqueue a Uint8Array wrapping an ArrayBuffer containing the available
           // bytes into stream.
-          if (!/state: 'errored'/.test(nodeUtil.inspect(stream))) {
+          if (!isErrored(stream)) {
             controller.enqueue(new Uint8Array(value))
           }
         }
@@ -268,10 +269,6 @@ const methods = {
     if (this[kState].body) {
       const stream = this[kState].body.stream
 
-      if (stream[kError]) {
-        throw stream[kError]
-      }
-
       if (util.isDisturbed(stream)) {
         throw new TypeError('disturbed')
       }
@@ -352,19 +349,12 @@ const properties = {
   }
 }
 
-function cancelBody (body, reason) {
-  if (body.stream && !/state: 'errored'/.test(nodeUtil.inspect(body.stream))) {
-    body.stream.cancel(reason)
-  }
-}
-
 function mixinBody (prototype) {
   Object.assign(prototype, methods)
   Object.defineProperties(prototype, properties)
 }
 
 module.exports = {
-  cancelBody,
   extractBody,
   safelyExtractBody,
   cloneBody,

package/lib/fetch/constants.js

@@ -58,6 +58,7 @@ const requestCache = [
   'only-if-cached'
 ]
 
+// https://fetch.spec.whatwg.org/#forbidden-response-header-name
 const forbiddenResponseHeaderNames = ['set-cookie', 'set-cookie2']
 
 const requestBodyHeader = [

package/lib/fetch/file.js

@@ -118,6 +118,7 @@ class FileLike {
     this[kState] = {
       blobLike,
       name: n,
+      type: t,
       lastModified: d
     }
   }