GeezerVison

Refs: https://fetch.spec.whatwg.org/#atomic-http-redirect-handling

### Network address family autoselection.

If you experience problem when connecting to a remote server that is resolved by your DNS servers to a IPv6 (AAAA record)

first, there are chances that your local router or ISP might have problem connecting to IPv6 networks. In that case

undici will throw an error with code `UND_ERR_CONNECT_TIMEOUT`.

If the target server resolves to both a IPv6 and IPv4 (A records) address and you are using a compatible Node version

(18.3.0 and above), you can fix the problem by providing the `autoSelectFamily` option (support by both `undici.request`

and `undici.Agent`) which will enable the family autoselection algorithm when establishing the connection.

* [__Daniele Belardi__](https://github.com/dnlup), <https://www.npmjs.com/~dnlup>

* **bodyTimeout** `number | null` (optional) - Default: `30e3` - The timeout after which a request will time out, in milliseconds. Monitors time between receiving body data. Use `0` to disable it entirely. Defaults to 30 seconds.

* **headersTimeout** `number | null` (optional) - Default: `30e3` - The amount of time the parser will wait to receive the complete HTTP headers while not sending the request. Defaults to 30 seconds.

* **bodyTimeout** `number | null` (optional) - Default: `300e3` - The timeout after which a request will time out, in milliseconds. Monitors time between receiving body data. Use `0` to disable it entirely. Defaults to 300 seconds.

* **headersTimeout** `number | null` (optional) - Default: `300e3` - The amount of time the parser will wait to receive the complete HTTP headers while not sending the request. Defaults to 300 seconds.

* **keepAliveMaxTimeout** `number | null` (optional) - Default: `600e3` - The maximum allowed `keepAliveTimeout` when overridden by *keep-alive* hints from the server. Defaults to 10 minutes.

* **keepAliveTimeout** `number | null` (optional) - Default: `4e3` - The timeout after which a socket without active requests will time out. Monitors time between activity on a connected socket. This value may be overridden by *keep-alive* hints from the server. See [MDN: HTTP - Headers - Keep-Alive directives](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Keep-Alive#directives) for more details. Defaults to 4 seconds.

* **keepAliveTimeoutThreshold** `number | null` (optional) - Default: `1e3` - A number subtracted from server *keep-alive* hints when overriding `keepAliveTimeout` to account for timing inaccuracies caused by e.g. transport latency. Defaults to 1 second.

* **connect** `ConnectOptions | Function | null` (optional) - Default: `null`.

* **strictContentLength** `Boolean` (optional) - Default: `true` - Whether to treat request content length mismatches as errors. If true, an error is thrown when the request content-length header doesn't match the length of the request body.

* **interceptors** `{ Client: DispatchInterceptor[] }` - Default: `[RedirectInterceptor]` - A list of interceptors that are applied to the dispatch method. Additional logic can be applied (such as, but not limited to: 302 status code handling, authentication, cookies, compression and caching). Note that the behavior of interceptors is Experimental and might change at any given time.

* **autoSelectFamily**: `boolean` (optional) - Default: depends on local Node version, on Node 18.13.0 and above is `false`. Enables a family autodetection algorithm that loosely implements section 5 of [RFC 8305](https://tools.ietf.org/html/rfc8305#section-5). See [here](https://nodejs.org/api/net.html#socketconnectoptions-connectlistener) for more details. This option is ignored if not supported by the current Node version.

* **autoSelectFamilyAttemptTimeout**: `number` - Default: depends on local Node version, on Node 18.13.0 and above is `250`. The amount of time in milliseconds to wait for a connection attempt to finish before trying the next address when using the `autoSelectFamily` option. See [here](https://nodejs.org/api/net.html#socketconnectoptions-connectlistener) for more details.

* **statusCode** `number`

* **headers** `Record<string, string | string[]>`

* **headers** `Record<string, string | string[] | undefined>`

* **socket** `stream.Duplex`

* **opaque** `unknown`

* **idempotent** `boolean` (optional) - Default: `true` if `method` is `'HEAD'` or `'GET'` - Whether the requests can be safely retried or not. If `false` the request won't be sent until all preceding requests in the pipeline has completed.

* **blocking** `boolean` (optional) - Default: `false` - Whether the response is expected to take a long time and would end up blocking the pipeline. When this is set to `true` further pipelining will be avoided on the same connection until headers have been received.

* **upgrade** `string | null` (optional) - Default: `null` - Upgrade the request. Should be used to specify the kind of upgrade i.e. `'Websocket'`.

* **bodyTimeout** `number | null` (optional) - The timeout after which a request will time out, in milliseconds. Monitors time between receiving body data. Use `0` to disable it entirely. Defaults to 30 seconds.

* **headersTimeout** `number | null` (optional) - The amount of time the parser will wait to receive the complete HTTP headers while not sending the request. Defaults to 30 seconds.

* **bodyTimeout** `number | null` (optional) - The timeout after which a request will time out, in milliseconds. Monitors time between receiving body data. Use `0` to disable it entirely. Defaults to 300 seconds.

* **headersTimeout** `number | null` (optional) - The amount of time the parser will wait to receive the complete HTTP headers while not sending the request. Defaults to 300 seconds.

* **throwOnError** `boolean` (optional) - Default: `false` - Whether Undici should throw an error upon receiving a 4xx or 5xx response from the server.

* **statusCode** `number`

* **headers** `Record<string, string | string[]>`

* **headers** `Record<string, string | string[] | undefined>`

* **opaque** `unknown`

* **body** `stream.Readable`

* **context** `object`

* **statusCode** `number`

* **headers** `Record<string, string | string[]>`

* **headers** `Record<string, string | string[] | undefined>`

* **opaque** `unknown`

* **onInfo** `({statusCode: number, headers: Record<string, string | string[]>}) => void | null` (optional) - Default: `null` - Callback collecting all the info headers (HTTP 100-199) received.

* `Record<string, string | string[]> | string[] | null`

* `Record<string, string | string[] | undefined> | string[] | null`

Header arguments such as `options.headers` in [`Client.dispatch`](Client.md#clientdispatchoptions-handlers) can be specified in two forms; either as an object specified by the `Record<string, string | string[]>` (`IncomingHttpHeaders`) type, or an array of strings. An array representation of a header list must have an even length or an `InvalidArgumentError` will be thrown.

Header arguments such as `options.headers` in [`Client.dispatch`](Client.md#clientdispatchoptions-handlers) can be specified in two forms; either as an object specified by the `Record<string, string | string[] | undefined>` (`IncomingHttpHeaders`) type, or an array of strings. An array representation of a header list must have an even length or an `InvalidArgumentError` will be thrown.

Keys are lowercase and values are not modified.

const RedirectHandler = require('./lib/handler/RedirectHandler')

const createRedirectInterceptor = require('./lib/interceptor/redirectInterceptor')

const nodeVersion = process.versions.node.split('.')

const nodeMajor = Number(nodeVersion[0])

const nodeMinor = Number(nodeVersion[1])

let hasCrypto

try {

require('crypto')

module.exports.setGlobalDispatcher = setGlobalDispatcher

module.exports.getGlobalDispatcher = getGlobalDispatcher

if (nodeMajor > 16 || (nodeMajor === 16 && nodeMinor >= 8)) {

if (util.nodeMajor > 16 || (util.nodeMajor === 16 && util.nodeMinor >= 8)) {

let fetchImpl = null

module.exports.fetch = async function fetch (resource) {

if (!fetchImpl) {

module.exports.getGlobalOrigin = getGlobalOrigin

if (nodeMajor >= 16) {

if (util.nodeMajor >= 16) {

const { deleteCookie, getCookies, getSetCookies, setCookie } = require('./lib/cookies')

module.exports.deleteCookie = deleteCookie

module.exports.serializeAMimeType = serializeAMimeType

if (nodeMajor >= 18 && hasCrypto) {

if (util.nodeMajor >= 18 && hasCrypto) {

const { WebSocket } = require('./lib/websocket/websocket')

module.exports.WebSocket = WebSocket

connect,

maxRequestsPerClient,

localAddress,

maxResponseSize

maxResponseSize,

autoSelectFamily,

autoSelectFamilyAttemptTimeout

} = {}) {

super()

throw new InvalidArgumentError('maxResponseSize must be a positive number')

}

if (

autoSelectFamilyAttemptTimeout != null &&

(!Number.isInteger(autoSelectFamilyAttemptTimeout) || autoSelectFamilyAttemptTimeout < -1)

) {

throw new InvalidArgumentError('autoSelectFamilyAttemptTimeout must be a positive number')

}

if (typeof connect !== 'function') {

connect = buildConnector({

...tls,

maxCachedSessions,

socketPath,

timeout: connectTimeout,

...(util.nodeHasAutoSelectFamily && autoSelectFamily ? { autoSelectFamily, autoSelectFamilyAttemptTimeout } : undefined),

...connect

})

}

this[kResuming] = 0 // 0, idle, 1, scheduled, 2 resuming

this[kNeedDrain] = 0 // 0, idle, 1, scheduled, 2 resuming

this[kHostHeader] = `host: ${this[kUrl].hostname}${this[kUrl].port ? `:${this[kUrl].port}` : ''}\r\n`

this[kBodyTimeout] = bodyTimeout != null ? bodyTimeout : 30e3

this[kHeadersTimeout] = headersTimeout != null ? headersTimeout : 30e3

this[kBodyTimeout] = bodyTimeout != null ? bodyTimeout : 300e3

this[kHeadersTimeout] = headersTimeout != null ? headersTimeout : 300e3

this[kStrictContentLength] = strictContentLength == null ? true : strictContentLength

this[kMaxRedirections] = maxRedirections

this[kMaxRequests] = maxRequestsPerClient

const { maxNameValuePairSize, maxAttributeValueSize } = require('./constants')

const { isCTLExcludingHtab } = require('./util')

const { collectASequenceOfCodePoints } = require('../fetch/dataURL')

const { collectASequenceOfCodePointsFast } = require('../fetch/dataURL')

const assert = require('assert')

// (including the %x3B (";") in question).

const position = { position: 0 }

nameValuePair = collectASequenceOfCodePoints((char) => char !== ';', header, position)

nameValuePair = collectASequenceOfCodePointsFast(';', header, position)

unparsedAttributes = header.slice(position.position)

} else {

// Otherwise:

// empty) value string consists of the characters after the first

// %x3D ("=") character.

const position = { position: 0 }

name = collectASequenceOfCodePoints(

(char) => char !== '=',

name = collectASequenceOfCodePointsFast(

'=',

nameValuePair,

position

)

if (unparsedAttributes.includes(';')) {

// 1. Consume the characters of the unparsed-attributes up to, but

// not including, the first %x3B (";") character.

cookieAv = collectASequenceOfCodePoints(

(char) => char !== ';',

cookieAv = collectASequenceOfCodePointsFast(

';',

unparsedAttributes,

{ position: 0 }

)

// character.

const position = { position: 0 }

attributeName = collectASequenceOfCodePoints(

(char) => char !== '=',

attributeName = collectASequenceOfCodePointsFast(

'=',

cookieAv,

position

)

let extractBody

const nodeVersion = process.versions.node.split('.')

const nodeMajor = Number(nodeVersion[0])

const nodeMinor = Number(nodeVersion[1])

try {

const diagnosticsChannel = require('diagnostics_channel')

channels.create = diagnosticsChannel.channel('undici:request:create')

}

if (util.isFormDataLike(this.body)) {

if (nodeMajor < 16 || (nodeMajor === 16 && nodeMinor < 8)) {

if (util.nodeMajor < 16 || (util.nodeMajor === 16 && util.nodeMinor < 8)) {

throw new InvalidArgumentError('Form-Data bodies are only supported in node v16.8 and newer.')

}

const nodeUtil = require('util')

const { stringify } = require('querystring')

const [nodeMajor, nodeMinor] = process.versions.node.split('.').map(v => Number(v))

function nop () {}

function isStream (obj) {

validateHandler,

getSocketInfo,

isFormDataLike,

buildURL

buildURL,

nodeMajor,

nodeMinor,

nodeHasAutoSelectFamily: nodeMajor > 18 || (nodeMajor === 18 && nodeMinor >= 13)

dataURLProcessor,

URLSerializer,

collectASequenceOfCodePoints,

collectASequenceOfCodePointsFast,

stringPercentDecode,

parseMIMEType,

collectAnHTTPQuotedString,

if (init instanceof HeadersList) {

this[kHeadersMap] = new Map(init[kHeadersMap])

this[kHeadersSortedMap] = init[kHeadersSortedMap]

this.cookies = init.cookies

} else {

this[kHeadersMap] = new Map(init)

this[kHeadersSortedMap] = null