undici 5.4.0 → 5.5.0

package/README.md

@@ -185,13 +185,12 @@ Help us improve the test coverage by following instructions at [nodejs/undici/#9
 Basic usage example:
 
 ```js
-    import {fetch} from 'undici';
+import { fetch } from 'undici';
 
-    async function fetchJson() {
-        const res = await fetch('https://example.com')
-        const json = await res.json()
-        console.log(json);
-    }
+
+const res = await fetch('https://example.com')
+const json = await res.json()
+console.log(json);
 ```
 
 You can pass an optional dispatcher to `fetch` as:
@@ -235,9 +234,7 @@ const data = {
   },
 };
 
-(async () => {
-  await fetch("https://example.com", { body: data, method: 'POST' });
-})();
+await fetch("https://example.com", { body: data, method: 'POST' });
 ```
 
 #### `response.body`
@@ -245,14 +242,12 @@ const data = {
 Nodejs has two kinds of streams: [web streams](https://nodejs.org/dist/latest-v16.x/docs/api/webstreams.html), which follow the API of the WHATWG web standard found in browsers, and an older Node-specific [streams API](https://nodejs.org/api/stream.html). `response.body` returns a readable web stream. If you would prefer to work with a Node stream you can convert a web stream using `.fromWeb()`.
 
 ```js
-    import {fetch} from 'undici';
-    import {Readable} from 'node:stream';
+import { fetch } from 'undici';
+import { Readable } from 'node:stream';
 
-    async function fetchStream() {
-        const response = await fetch('https://example.com')
-        const readableWebStream = response.body;
-        const readableNodeStream = Readable.fromWeb(readableWebStream);
-    }
+const response = await fetch('https://example.com')
+const readableWebStream = response.body;
+const readableNodeStream = Readable.fromWeb(readableWebStream);
 ```
 
 #### Specification Compliance

package/lib/core/request.js

@@ -80,13 +80,12 @@ class Request {
       this.body = null
     } else if (util.isStream(body)) {
       this.body = body
-    } else if (body instanceof DataView) {
-      // TODO: Why is DataView special?
-      this.body = body.buffer.byteLength ? Buffer.from(body.buffer) : null
-    } else if (body instanceof ArrayBuffer || ArrayBuffer.isView(body)) {
-      this.body = body.byteLength ? Buffer.from(body) : null
     } else if (util.isBuffer(body)) {
       this.body = body.byteLength ? body : null
+    } else if (ArrayBuffer.isView(body)) {
+      this.body = body.buffer.byteLength ? Buffer.from(body.buffer, body.byteOffset, body.byteLength) : null
+    } else if (body instanceof ArrayBuffer) {
+      this.body = body.byteLength ? Buffer.from(body) : null
     } else if (typeof body === 'string') {
       this.body = body.length ? Buffer.from(body) : null
     } else if (util.isFormDataLike(body) || util.isIterable(body) || util.isBlobLike(body)) {

package/lib/fetch/body.js

@@ -9,7 +9,7 @@ const { kBodyUsed } = require('../core/symbols')
 const assert = require('assert')
 const { NotSupportedError } = require('../core/errors')
 const { isErrored } = require('../core/util')
-const { isUint8Array } = require('util/types')
+const { isUint8Array, isArrayBuffer } = require('util/types')
 
 let ReadableStream
 
@@ -61,7 +61,7 @@ function extractBody (object, keepalive = false) {
 
     // Set Content-Type to `application/x-www-form-urlencoded;charset=UTF-8`.
     contentType = 'application/x-www-form-urlencoded;charset=UTF-8'
-  } else if (object instanceof ArrayBuffer || ArrayBuffer.isView(object)) {
+  } else if (isArrayBuffer(object) || ArrayBuffer.isView(object)) {
     // BufferSource
 
     if (object instanceof DataView) {

package/lib/fetch/formdata.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const { isBlobLike, isFileLike, toUSVString } = require('./util')
+const { isBlobLike, isFileLike, toUSVString, makeIterator } = require('./util')
 const { kState } = require('./symbols')
 const { File, FileLike } = require('./file')
 const { Blob } = require('buffer')
@@ -187,45 +187,68 @@ class FormData {
     return this.constructor.name
   }
 
-  * entries () {
+  entries () {
     if (!(this instanceof FormData)) {
       throw new TypeError('Illegal invocation')
     }
 
-    for (const pair of this) {
-      yield pair
-    }
+    return makeIterator(
+      makeIterable(this[kState], 'entries'),
+      'FormData'
+    )
   }
 
-  * keys () {
+  keys () {
     if (!(this instanceof FormData)) {
       throw new TypeError('Illegal invocation')
     }
 
-    for (const [key] of this) {
-      yield key
+    return makeIterator(
+      makeIterable(this[kState], 'keys'),
+      'FormData'
+    )
+  }
+
+  values () {
+    if (!(this instanceof FormData)) {
+      throw new TypeError('Illegal invocation')
     }
+
+    return makeIterator(
+      makeIterable(this[kState], 'values'),
+      'FormData'
+    )
   }
 
-  * values () {
+  /**
+   * @param {(value: string, key: string, self: FormData) => void} callbackFn
+   * @param {unknown} thisArg
+   */
+  forEach (callbackFn, thisArg = globalThis) {
     if (!(this instanceof FormData)) {
       throw new TypeError('Illegal invocation')
     }
 
-    for (const [, value] of this) {
-      yield value
+    if (arguments.length < 1) {
+      throw new TypeError(
+        `Failed to execute 'forEach' on 'FormData': 1 argument required, but only ${arguments.length} present.`
+      )
     }
-  }
 
-  * [Symbol.iterator] () {
-    // The value pairs to iterate over are this’s entry list’s entries with
-    // the key being the name and the value being the value.
-    for (const { name, value } of this[kState]) {
-      yield [name, value]
+    if (typeof callbackFn !== 'function') {
+      throw new TypeError(
+        "Failed to execute 'forEach' on 'FormData': parameter 1 is not of type 'Function'."
+      )
+    }
+
+    for (const [key, value] of this) {
+      callbackFn.apply(thisArg, [value, key, this])
     }
   }
 }
 
+FormData.prototype[Symbol.iterator] = FormData.prototype.entries
+
 function makeEntry (name, value, filename) {
   // To create an entry for name, value, and optionally a filename, run these
   // steps:
@@ -267,4 +290,18 @@ function makeEntry (name, value, filename) {
   return entry
 }
 
+function * makeIterable (entries, type) {
+  // The value pairs to iterate over are this’s entry list’s entries
+  // with the key being the name and the value being the value.
+  for (const { name, value } of entries) {
+    if (type === 'entries') {
+      yield [name, value]
+    } else if (type === 'values') {
+      yield value
+    } else {
+      yield name
+    }
+  }
+}
+
 module.exports = { FormData }

package/lib/fetch/headers.js

@@ -6,6 +6,7 @@ const { validateHeaderName, validateHeaderValue } = require('http')
 const { kHeadersList } = require('../core/symbols')
 const { kGuard } = require('./symbols')
 const { kEnumerableProperty } = require('../core/util')
+const { makeIterator } = require('./util')
 
 const kHeadersMap = Symbol('headers map')
 const kHeadersSortedMap = Symbol('headers map sorted')
@@ -73,33 +74,6 @@ function fill (headers, object) {
   }
 }
 
-// https://tc39.es/ecma262/#sec-%25iteratorprototype%25-object
-const esIteratorPrototype = Object.getPrototypeOf(Object.getPrototypeOf([][Symbol.iterator]()))
-
-// https://webidl.spec.whatwg.org/#dfn-iterator-prototype-object
-function makeHeadersIterator (iterator) {
-  const i = {
-    next () {
-      if (Object.getPrototypeOf(this) !== i) {
-        throw new TypeError(
-          '\'next\' called on an object that does not implement interface Headers Iterator.'
-        )
-      }
-
-      return iterator.next()
-    },
-    // The class string of an iterator prototype object for a given interface is the
-    // result of concatenating the identifier of the interface and the string " Iterator".
-    [Symbol.toStringTag]: 'Headers Iterator'
-  }
-
-  // The [[Prototype]] internal slot of an iterator prototype object must be %IteratorPrototype%.
-  Object.setPrototypeOf(i, esIteratorPrototype)
-  // esIteratorPrototype needs to be the prototype of i
-  // which is the prototype of an empty object. Yes, it's confusing.
-  return Object.setPrototypeOf({}, i)
-}
-
 class HeadersList {
   constructor (init) {
     if (init instanceof HeadersList) {
@@ -306,7 +280,7 @@ class Headers {
       throw new TypeError('Illegal invocation')
     }
 
-    return makeHeadersIterator(this[kHeadersSortedMap].keys())
+    return makeIterator(this[kHeadersSortedMap].keys(), 'Headers')
   }
 
   values () {
@@ -314,7 +288,7 @@ class Headers {
       throw new TypeError('Illegal invocation')
     }
 
-    return makeHeadersIterator(this[kHeadersSortedMap].values())
+    return makeIterator(this[kHeadersSortedMap].values(), 'Headers')
   }
 
   entries () {
@@ -322,7 +296,7 @@ class Headers {
       throw new TypeError('Illegal invocation')
     }
 
-    return makeHeadersIterator(this[kHeadersSortedMap].entries())
+    return makeIterator(this[kHeadersSortedMap].entries(), 'Headers')
   }
 
   /**

package/lib/fetch/index.js

@@ -1164,7 +1164,7 @@ async function httpRedirectFetch (fetchParams, response) {
   if (
     ([301, 302].includes(actualResponse.status) && request.method === 'POST') ||
     (actualResponse.status === 303 &&
-      !['GET', 'HEADER'].includes(request.method))
+      !['GET', 'HEAD'].includes(request.method))
   ) {
     // then:
     // 1. Set request’s method to `GET` and request’s body to null.

package/lib/fetch/util.js

@@ -361,6 +361,33 @@ function serializeJavascriptValueToJSONString (value) {
   return result
 }
 
+// https://tc39.es/ecma262/#sec-%25iteratorprototype%25-object
+const esIteratorPrototype = Object.getPrototypeOf(Object.getPrototypeOf([][Symbol.iterator]()))
+
+// https://webidl.spec.whatwg.org/#dfn-iterator-prototype-object
+function makeIterator (iterator, name) {
+  const i = {
+    next () {
+      if (Object.getPrototypeOf(this) !== i) {
+        throw new TypeError(
+          `'next' called on an object that does not implement interface ${name} Iterator.`
+        )
+      }
+
+      return iterator.next()
+    },
+    // The class string of an iterator prototype object for a given interface is the
+    // result of concatenating the identifier of the interface and the string " Iterator".
+    [Symbol.toStringTag]: `${name} Iterator`
+  }
+
+  // The [[Prototype]] internal slot of an iterator prototype object must be %IteratorPrototype%.
+  Object.setPrototypeOf(i, esIteratorPrototype)
+  // esIteratorPrototype needs to be the prototype of i
+  // which is the prototype of an empty object. Yes, it's confusing.
+  return Object.setPrototypeOf({}, i)
+}
+
 module.exports = {
   isAborted,
   isCancelled,
@@ -390,5 +417,6 @@ module.exports = {
   isValidReasonPhrase,
   sameOrigin,
   normalizeMethod,
-  serializeJavascriptValueToJSONString
+  serializeJavascriptValueToJSONString,
+  makeIterator
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "undici",
-  "version": "5.4.0",
+  "version": "5.5.0",
   "description": "An HTTP/1.1 client, written from scratch for Node.js",
   "homepage": "https://undici.nodejs.org",
   "bugs": {

package/types/connector.d.ts

@@ -1,16 +1,15 @@
-import { URL } from 'url'
-import { TLSSocket, TlsOptions } from 'tls'
-import { Socket } from 'net'
+import {TLSSocket, ConnectionOptions} from 'tls'
+import {IpcNetConnectOpts, Socket, TcpNetConnectOpts} from 'net'
 
 export = buildConnector
 declare function buildConnector (options?: buildConnector.BuildOptions): typeof buildConnector.connector
 
 declare namespace buildConnector {
-  export interface BuildOptions extends TlsOptions {
+  export type BuildOptions = (ConnectionOptions | TcpNetConnectOpts | IpcNetConnectOpts) & {
     maxCachedSessions?: number | null;
     socketPath?: string | null;
     timeout?: number | null;
-    servername?: string | null;
+    port?: number;
   }
 
   export interface Options {

package/types/fetch.d.ts

@@ -38,21 +38,21 @@ export interface BodyMixin {
   readonly text: () => Promise<string>
 }
 
-export interface HeadersIterator<T, TReturn = any, TNext = undefined> {
+export interface SpecIterator<T, TReturn = any, TNext = undefined> {
   next(...args: [] | [TNext]): IteratorResult<T, TReturn>;
 }
 
-export interface HeadersIterableIterator<T> extends HeadersIterator<T> {
-  [Symbol.iterator](): HeadersIterableIterator<T>;
+export interface SpecIterableIterator<T> extends SpecIterator<T> {
+  [Symbol.iterator](): SpecIterableIterator<T>;
 }
 
-export interface HeadersIterable<T> {
-  [Symbol.iterator](): HeadersIterator<T>;
+export interface SpecIterable<T> {
+  [Symbol.iterator](): SpecIterator<T>;
 }
 
 export type HeadersInit = string[][] | Record<string, string | ReadonlyArray<string>> | Headers
 
-export declare class Headers implements HeadersIterable<[string, string]> {
+export declare class Headers implements SpecIterable<[string, string]> {
   constructor (init?: HeadersInit)
   readonly append: (name: string, value: string) => void
   readonly delete: (name: string) => void
@@ -64,10 +64,10 @@ export declare class Headers implements HeadersIterable<[string, string]> {
     thisArg?: unknown
   ) => void
 
-  readonly keys: () => HeadersIterableIterator<string>
-  readonly values: () => HeadersIterableIterator<string>
-  readonly entries: () => HeadersIterableIterator<[string, string]>
-  readonly [Symbol.iterator]: () => HeadersIterator<[string, string]>
+  readonly keys: () => SpecIterableIterator<string>
+  readonly values: () => SpecIterableIterator<string>
+  readonly entries: () => SpecIterableIterator<[string, string]>
+  readonly [Symbol.iterator]: () => SpecIterator<[string, string]>
 }
 
 export type RequestCache =

package/types/formdata.d.ts

@@ -2,6 +2,7 @@
 /// <reference types="node" />
 
 import { File } from './file'
+import { SpecIterator, SpecIterableIterator } from './fetch'
 
 /**
  * A `string` or `File` that represents a single value from a set of `FormData` key-value pairs.
@@ -73,32 +74,35 @@ export declare class FormData {
   delete(name: string): void
 
   /**
-   * Returns an [`iterator`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols) allowing to go through all keys contained in this `FormData` object.
-   * Each key is a `string`.
+   * Executes given callback function for each field of the FormData instance
    */
-  keys(): Generator<string>
+  forEach: (
+    callbackfn: (value: FormDataEntryValue, key: string, iterable: FormData) => void,
+    thisArg?: unknown
+  ) => void
 
   /**
-   * Returns an [`iterator`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols) allowing to go through the `FormData` key/value pairs.
-   * The key of each pair is a string; the value is a [`FormDataValue`](https://developer.mozilla.org/en-US/docs/Web/API/FormDataEntryValue).
+   * Returns an [`iterator`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols) allowing to go through all keys contained in this `FormData` object.
+   * Each key is a `string`.
    */
-  entries(): Generator<[string, FormDataEntryValue]>
+  keys: () => SpecIterableIterator<string>
 
   /**
    * Returns an [`iterator`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols) allowing to go through all values contained in this object `FormData` object.
    * Each value is a [`FormDataValue`](https://developer.mozilla.org/en-US/docs/Web/API/FormDataEntryValue).
    */
-  values(): Generator<FormDataEntryValue>
+  values: () => SpecIterableIterator<FormDataEntryValue>
 
   /**
-   * An alias for FormData#entries()
+   * Returns an [`iterator`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols) allowing to go through the `FormData` key/value pairs.
+   * The key of each pair is a string; the value is a [`FormDataValue`](https://developer.mozilla.org/en-US/docs/Web/API/FormDataEntryValue).
    */
-  [Symbol.iterator](): Generator<[string, FormDataEntryValue], void>
+  entries: () => SpecIterableIterator<[string, FormDataEntryValue]>
 
   /**
-   * Executes given callback function for each field of the FormData instance
+   * An alias for FormData#entries()
    */
-  forEach(callback: (value: FormDataEntryValue, key: string, formData: FormData) => void, thisArg?: unknown): void
+  [Symbol.iterator]: () => SpecIterableIterator<[string, FormDataEntryValue]>
 
   readonly [Symbol.toStringTag]: string
 }