urllib 3.19.3 → 3.21.0

package/README.md

@@ -290,14 +290,15 @@ Fork [undici benchmarks script](https://github.com/fengmk2/undici/blob/urllib-be
 
 |[<img src="https://avatars.githubusercontent.com/u/156269?v=4" width="100px;"/><br/><sub><b>fengmk2</b></sub>](https://github.com/fengmk2)<br/>|[<img src="https://avatars.githubusercontent.com/u/985607?v=4" width="100px;"/><br/><sub><b>dead-horse</b></sub>](https://github.com/dead-horse)<br/>|[<img src="https://avatars.githubusercontent.com/u/32174276?v=4" width="100px;"/><br/><sub><b>semantic-release-bot</b></sub>](https://github.com/semantic-release-bot)<br/>|[<img src="https://avatars.githubusercontent.com/u/288288?v=4" width="100px;"/><br/><sub><b>xingrz</b></sub>](https://github.com/xingrz)<br/>|[<img src="https://avatars.githubusercontent.com/u/360661?v=4" width="100px;"/><br/><sub><b>popomore</b></sub>](https://github.com/popomore)<br/>|[<img src="https://avatars.githubusercontent.com/u/327019?v=4" width="100px;"/><br/><sub><b>JacksonTian</b></sub>](https://github.com/JacksonTian)<br/>|
 | :---: | :---: | :---: | :---: | :---: | :---: |
-|[<img src="https://avatars.githubusercontent.com/u/543405?v=4" width="100px;"/><br/><sub><b>ibigbug</b></sub>](https://github.com/ibigbug)<br/>|[<img src="https://avatars.githubusercontent.com/u/14790466?v=4" width="100px;"/><br/><sub><b>greenkeeperio-bot</b></sub>](https://github.com/greenkeeperio-bot)<br/>|[<img src="https://avatars.githubusercontent.com/u/227713?v=4" width="100px;"/><br/><sub><b>atian25</b></sub>](https://github.com/atian25)<br/>|[<img src="https://avatars.githubusercontent.com/u/6897780?v=4" width="100px;"/><br/><sub><b>killagu</b></sub>](https://github.com/killagu)<br/>|[<img src="https://avatars.githubusercontent.com/u/5381764?v=4" width="100px;"/><br/><sub><b>paambaati</b></sub>](https://github.com/paambaati)<br/>|[<img src="https://avatars.githubusercontent.com/u/1433247?v=4" width="100px;"/><br/><sub><b>denghongcai</b></sub>](https://github.com/denghongcai)<br/>|
-|[<img src="https://avatars.githubusercontent.com/u/4635838?v=4" width="100px;"/><br/><sub><b>gemwuu</b></sub>](https://github.com/gemwuu)<br/>|[<img src="https://avatars.githubusercontent.com/u/2842176?v=4" width="100px;"/><br/><sub><b>XadillaX</b></sub>](https://github.com/XadillaX)<br/>|[<img src="https://avatars.githubusercontent.com/u/1147375?v=4" width="100px;"/><br/><sub><b>alsotang</b></sub>](https://github.com/alsotang)<br/>|[<img src="https://avatars.githubusercontent.com/u/546535?v=4" width="100px;"/><br/><sub><b>leoner</b></sub>](https://github.com/leoner)<br/>|[<img src="https://avatars.githubusercontent.com/u/19908330?v=4" width="100px;"/><br/><sub><b>hyj1991</b></sub>](https://github.com/hyj1991)<br/>|[<img src="https://avatars.githubusercontent.com/u/1747852?v=4" width="100px;"/><br/><sub><b>isayme</b></sub>](https://github.com/isayme)<br/>|
-|[<img src="https://avatars.githubusercontent.com/u/252317?v=4" width="100px;"/><br/><sub><b>cyjake</b></sub>](https://github.com/cyjake)<br/>|[<img src="https://avatars.githubusercontent.com/u/5856440?v=4" width="100px;"/><br/><sub><b>whxaxes</b></sub>](https://github.com/whxaxes)<br/>|[<img src="https://avatars.githubusercontent.com/u/309219?v=4" width="100px;"/><br/><sub><b>chadxz</b></sub>](https://github.com/chadxz)<br/>|[<img src="https://avatars.githubusercontent.com/u/2055702?v=4" width="100px;"/><br/><sub><b>adapt0</b></sub>](https://github.com/adapt0)<br/>|[<img src="https://avatars.githubusercontent.com/u/5139554?v=4" width="100px;"/><br/><sub><b>danielwpz</b></sub>](https://github.com/danielwpz)<br/>|[<img src="https://avatars.githubusercontent.com/u/5127897?v=4" width="100px;"/><br/><sub><b>danielsss</b></sub>](https://github.com/danielsss)<br/>|
-|[<img src="https://avatars.githubusercontent.com/u/3367820?v=4" width="100px;"/><br/><sub><b>Jeff-Tian</b></sub>](https://github.com/Jeff-Tian)<br/>|[<img src="https://avatars.githubusercontent.com/u/17075261?v=4" width="100px;"/><br/><sub><b>nick-ng</b></sub>](https://github.com/nick-ng)<br/>|[<img src="https://avatars.githubusercontent.com/u/1706595?v=4" width="100px;"/><br/><sub><b>rishavsharan</b></sub>](https://github.com/rishavsharan)<br/>|[<img src="https://avatars.githubusercontent.com/u/1886161?v=4" width="100px;"/><br/><sub><b>willizm</b></sub>](https://github.com/willizm)<br/>|[<img src="https://avatars.githubusercontent.com/u/7227589?v=4" width="100px;"/><br/><sub><b>davidkhala</b></sub>](https://github.com/davidkhala)<br/>|[<img src="https://avatars.githubusercontent.com/u/535479?v=4" width="100px;"/><br/><sub><b>aleafs</b></sub>](https://github.com/aleafs)<br/>|
-|[<img src="https://avatars.githubusercontent.com/u/3689968?v=4" width="100px;"/><br/><sub><b>Amunu</b></sub>](https://github.com/Amunu)<br/>|[<img src="https://avatars.githubusercontent.com/in/9426?v=4" width="100px;"/><br/><sub><b>azure-pipelines[bot]</b></sub>](https://github.com/apps/azure-pipelines)<br/>|[<img src="https://avatars.githubusercontent.com/u/108602490?v=4" width="100px;"/><br/><sub><b>capsice</b></sub>](https://github.com/capsice)<br/>|[<img src="https://avatars.githubusercontent.com/u/1281323?v=4" width="100px;"/><br/><sub><b>changzhiwin</b></sub>](https://github.com/changzhiwin)<br/>|[<img src="https://avatars.githubusercontent.com/u/929503?v=4" width="100px;"/><br/><sub><b>yuzhigang33</b></sub>](https://github.com/yuzhigang33)<br/>|[<img src="https://avatars.githubusercontent.com/u/5574625?v=4" width="100px;"/><br/><sub><b>elrrrrrrr</b></sub>](https://github.com/elrrrrrrr)<br/>|
-[<img src="https://avatars.githubusercontent.com/u/981128?v=4" width="100px;"/><br/><sub><b>fishbar</b></sub>](https://github.com/fishbar)<br/>|[<img src="https://avatars.githubusercontent.com/u/1207064?v=4" width="100px;"/><br/><sub><b>gxcsoccer</b></sub>](https://github.com/gxcsoccer)<br/>|[<img src="https://avatars.githubusercontent.com/u/17476119?v=4" width="100px;"/><br/><sub><b>mars-coder</b></sub>](https://github.com/mars-coder)<br/>|[<img src="https://avatars.githubusercontent.com/u/929179?v=4" width="100px;"/><br/><sub><b>rockdai</b></sub>](https://github.com/rockdai)<br/>|[<img src="https://avatars.githubusercontent.com/u/2196373?v=4" width="100px;"/><br/><sub><b>dickeylth</b></sub>](https://github.com/dickeylth)<br/>|[<img src="https://avatars.githubusercontent.com/u/13050025?v=4" width="100px;"/><br/><sub><b>aladdin-add</b></sub>](https://github.com/aladdin-add)<br/>
-
-This project follows the git-contributor [spec](https://github.com/xudafeng/git-contributor), auto updated at `Sat Sep 16 2023 01:02:26 GMT+0800`.
+|[<img src="https://avatars.githubusercontent.com/u/543405?v=4" width="100px;"/><br/><sub><b>ibigbug</b></sub>](https://github.com/ibigbug)<br/>|[<img src="https://avatars.githubusercontent.com/u/14790466?v=4" width="100px;"/><br/><sub><b>greenkeeperio-bot</b></sub>](https://github.com/greenkeeperio-bot)<br/>|[<img src="https://avatars.githubusercontent.com/u/227713?v=4" width="100px;"/><br/><sub><b>atian25</b></sub>](https://github.com/atian25)<br/>|[<img src="https://avatars.githubusercontent.com/u/6897780?v=4" width="100px;"/><br/><sub><b>killagu</b></sub>](https://github.com/killagu)<br/>|[<img src="https://avatars.githubusercontent.com/u/5381764?v=4" width="100px;"/><br/><sub><b>paambaati</b></sub>](https://github.com/paambaati)<br/>|[<img src="https://avatars.githubusercontent.com/u/199635?v=4" width="100px;"/><br/><sub><b>tremby</b></sub>](https://github.com/tremby)<br/>|
+|[<img src="https://avatars.githubusercontent.com/u/1433247?v=4" width="100px;"/><br/><sub><b>denghongcai</b></sub>](https://github.com/denghongcai)<br/>|[<img src="https://avatars.githubusercontent.com/u/4635838?v=4" width="100px;"/><br/><sub><b>gemwuu</b></sub>](https://github.com/gemwuu)<br/>|[<img src="https://avatars.githubusercontent.com/u/2842176?v=4" width="100px;"/><br/><sub><b>XadillaX</b></sub>](https://github.com/XadillaX)<br/>|[<img src="https://avatars.githubusercontent.com/u/1147375?v=4" width="100px;"/><br/><sub><b>alsotang</b></sub>](https://github.com/alsotang)<br/>|[<img src="https://avatars.githubusercontent.com/u/546535?v=4" width="100px;"/><br/><sub><b>leoner</b></sub>](https://github.com/leoner)<br/>|[<img src="https://avatars.githubusercontent.com/u/19908330?v=4" width="100px;"/><br/><sub><b>hyj1991</b></sub>](https://github.com/hyj1991)<br/>|
+|[<img src="https://avatars.githubusercontent.com/u/1747852?v=4" width="100px;"/><br/><sub><b>isayme</b></sub>](https://github.com/isayme)<br/>|[<img src="https://avatars.githubusercontent.com/u/252317?v=4" width="100px;"/><br/><sub><b>cyjake</b></sub>](https://github.com/cyjake)<br/>|[<img src="https://avatars.githubusercontent.com/u/5856440?v=4" width="100px;"/><br/><sub><b>whxaxes</b></sub>](https://github.com/whxaxes)<br/>|[<img src="https://avatars.githubusercontent.com/u/309219?v=4" width="100px;"/><br/><sub><b>chadxz</b></sub>](https://github.com/chadxz)<br/>|[<img src="https://avatars.githubusercontent.com/u/2055702?v=4" width="100px;"/><br/><sub><b>adapt0</b></sub>](https://github.com/adapt0)<br/>|[<img src="https://avatars.githubusercontent.com/u/5139554?v=4" width="100px;"/><br/><sub><b>danielwpz</b></sub>](https://github.com/danielwpz)<br/>|
+|[<img src="https://avatars.githubusercontent.com/u/5127897?v=4" width="100px;"/><br/><sub><b>danielsss</b></sub>](https://github.com/danielsss)<br/>|[<img src="https://avatars.githubusercontent.com/u/3367820?v=4" width="100px;"/><br/><sub><b>Jeff-Tian</b></sub>](https://github.com/Jeff-Tian)<br/>|[<img src="https://avatars.githubusercontent.com/u/17075261?v=4" width="100px;"/><br/><sub><b>nick-ng</b></sub>](https://github.com/nick-ng)<br/>|[<img src="https://avatars.githubusercontent.com/u/1706595?v=4" width="100px;"/><br/><sub><b>rishavsharan</b></sub>](https://github.com/rishavsharan)<br/>|[<img src="https://avatars.githubusercontent.com/u/1886161?v=4" width="100px;"/><br/><sub><b>willizm</b></sub>](https://github.com/willizm)<br/>|[<img src="https://avatars.githubusercontent.com/u/7227589?v=4" width="100px;"/><br/><sub><b>davidkhala</b></sub>](https://github.com/davidkhala)<br/>|
+|[<img src="https://avatars.githubusercontent.com/u/535479?v=4" width="100px;"/><br/><sub><b>aleafs</b></sub>](https://github.com/aleafs)<br/>|[<img src="https://avatars.githubusercontent.com/u/3689968?v=4" width="100px;"/><br/><sub><b>Amunu</b></sub>](https://github.com/Amunu)<br/>|[<img src="https://avatars.githubusercontent.com/in/9426?v=4" width="100px;"/><br/><sub><b>azure-pipelines[bot]</b></sub>](https://github.com/apps/azure-pipelines)<br/>|[<img src="https://avatars.githubusercontent.com/u/108602490?v=4" width="100px;"/><br/><sub><b>capsice</b></sub>](https://github.com/capsice)<br/>|[<img src="https://avatars.githubusercontent.com/u/1281323?v=4" width="100px;"/><br/><sub><b>changzhiwin</b></sub>](https://github.com/changzhiwin)<br/>|[<img src="https://avatars.githubusercontent.com/u/929503?v=4" width="100px;"/><br/><sub><b>yuzhigang33</b></sub>](https://github.com/yuzhigang33)<br/>|
+|[<img src="https://avatars.githubusercontent.com/u/5574625?v=4" width="100px;"/><br/><sub><b>elrrrrrrr</b></sub>](https://github.com/elrrrrrrr)<br/>|[<img src="https://avatars.githubusercontent.com/u/981128?v=4" width="100px;"/><br/><sub><b>fishbar</b></sub>](https://github.com/fishbar)<br/>|[<img src="https://avatars.githubusercontent.com/u/1207064?v=4" width="100px;"/><br/><sub><b>gxcsoccer</b></sub>](https://github.com/gxcsoccer)<br/>|[<img src="https://avatars.githubusercontent.com/u/17476119?v=4" width="100px;"/><br/><sub><b>mars-coder</b></sub>](https://github.com/mars-coder)<br/>|[<img src="https://avatars.githubusercontent.com/u/929179?v=4" width="100px;"/><br/><sub><b>rockdai</b></sub>](https://github.com/rockdai)<br/>|[<img src="https://avatars.githubusercontent.com/u/2196373?v=4" width="100px;"/><br/><sub><b>dickeylth</b></sub>](https://github.com/dickeylth)<br/>|
+[<img src="https://avatars.githubusercontent.com/u/13050025?v=4" width="100px;"/><br/><sub><b>aladdin-add</b></sub>](https://github.com/aladdin-add)<br/>
+
+This project follows the git-contributor [spec](https://github.com/xudafeng/git-contributor), auto updated at `Mon Dec 04 2023 00:13:39 GMT+0800`.
 
 <!-- GITCONTRIBUTOR_END -->
 

package/dist/commonjs/HttpAgent.js

@@ -68,7 +68,7 @@ class HttpAgent extends undici_1.Agent {
             }
             const family = (0, node_net_1.isIP)(hostname);
             if (family === 4 || family === 6) {
-                // if request hostname is ip, custom lookup won't excute
+                // if request hostname is ip, custom lookup won't execute
                 if (!this.#checkAddress(hostname, family)) {
                     throw new IllegalAddressError(hostname, hostname, family);
                 }

package/dist/commonjs/HttpClient.d.ts

@@ -3,6 +3,7 @@
 /// <reference types="node" />
 import { EventEmitter } from 'node:events';
 import { LookupFunction } from 'node:net';
+import { Dispatcher } from 'undici';
 import { CheckAddressFunction } from './HttpAgent.js';
 import { RequestURL, RequestOptions, RequestMeta } from './Request.js';
 import { RawResponseWithMeta, HttpClientResponse } from './Response.js';
@@ -34,6 +35,10 @@ export type ClientOptions = {
          * socketPath string | null (optional) - Default: null - An IPC endpoint, either Unix domain socket or Windows named pipe
          */
         socketPath?: string | null;
+        /**
+         * connect timeout, default is 10000ms
+         */
+        timeout?: number;
     };
 };
 export declare const HEADER_USER_AGENT: string;
@@ -48,6 +53,8 @@ export type ResponseDiagnosticsMessage = {
 export declare class HttpClient extends EventEmitter {
     #private;
     constructor(clientOptions?: ClientOptions);
+    getDispatcher(): Dispatcher;
+    setDispatcher(dispatcher: Dispatcher): void;
     request<T = any>(url: RequestURL, options?: RequestOptions): Promise<HttpClientResponse<T>>;
     curl<T = any>(url: RequestURL, options?: RequestOptions): Promise<HttpClientResponse<T>>;
 }

package/dist/commonjs/HttpClient.js

@@ -29,6 +29,7 @@ const HttpAgent_js_1 = require("./HttpAgent.js");
 const utils_js_1 = require("./utils.js");
 const symbols_js_1 = __importDefault(require("./symbols.js"));
 const diagnosticsChannel_js_1 = require("./diagnosticsChannel.js");
+const HttpClientError_js_1 = require("./HttpClientError.js");
 const PROTO_RE = /^https?:\/\//i;
 const FormData = undici_1.FormData ?? formdata_node_1.FormData;
 // impl promise pipeline on Node.js 14
@@ -65,15 +66,7 @@ class BlobFromStream {
         return 'Blob';
     }
 }
-class HttpClientRequestTimeoutError extends Error {
-    constructor(timeout, options) {
-        const message = `Request timeout for ${timeout} ms`;
-        super(message, options);
-        this.name = this.constructor.name;
-        Error.captureStackTrace(this, this.constructor);
-    }
-}
-exports.HEADER_USER_AGENT = (0, default_user_agent_1.default)('node-urllib', '3.19.3');
+exports.HEADER_USER_AGENT = (0, default_user_agent_1.default)('node-urllib', '3.21.0');
 function getFileName(stream) {
     const filePath = stream.path;
     if (filePath) {
@@ -94,15 +87,26 @@ class HttpClient extends node_events_1.EventEmitter {
     constructor(clientOptions) {
         super();
         this.#defaultArgs = clientOptions?.defaultArgs;
-        if (clientOptions?.lookup || clientOptions?.checkAddress || clientOptions?.connect) {
+        if (clientOptions?.lookup || clientOptions?.checkAddress) {
             this.#dispatcher = new HttpAgent_js_1.HttpAgent({
                 lookup: clientOptions.lookup,
                 checkAddress: clientOptions.checkAddress,
                 connect: clientOptions.connect,
             });
         }
+        else if (clientOptions?.connect) {
+            this.#dispatcher = new undici_1.Agent({
+                connect: clientOptions.connect,
+            });
+        }
         (0, diagnosticsChannel_js_1.initDiagnosticsChannel)();
     }
+    getDispatcher() {
+        return this.#dispatcher ?? (0, undici_1.getGlobalDispatcher)();
+    }
+    setDispatcher(dispatcher) {
+        this.#dispatcher = dispatcher;
+    }
     async request(url, options) {
         return await this.#requestInternal(url, options);
     }
@@ -569,14 +573,17 @@ class HttpClient extends node_events_1.EventEmitter {
             }
             return clientResponse;
         }
-        catch (e) {
-            debug('Request#%d throw error: %s', requestId, e);
-            let err = e;
+        catch (rawError) {
+            debug('Request#%d throw error: %s', requestId, rawError);
+            let err = rawError;
             if (err.name === 'HeadersTimeoutError') {
-                err = new HttpClientRequestTimeoutError(headersTimeout, { cause: e });
+                err = new HttpClientError_js_1.HttpClientRequestTimeoutError(headersTimeout, { cause: err });
             }
             else if (err.name === 'BodyTimeoutError') {
-                err = new HttpClientRequestTimeoutError(bodyTimeout, { cause: e });
+                err = new HttpClientError_js_1.HttpClientRequestTimeoutError(bodyTimeout, { cause: err });
+            }
+            else if (err.code === 'UND_ERR_CONNECT_TIMEOUT') {
+                err = new HttpClientError_js_1.HttpClientConnectTimeoutError(err.message, err.code, { cause: err });
             }
             else if (err.code === 'UND_ERR_SOCKET' || err.code === 'ECONNRESET') {
                 // auto retry on socket error, https://github.com/node-modules/urllib/issues/454
@@ -599,7 +606,7 @@ class HttpClient extends node_events_1.EventEmitter {
                 res.requestUrls.push(requestUrl.href);
             }
             res.rt = (0, utils_js_1.performanceTime)(requestStartTime);
-            this.#updateSocketInfo(socketInfo, internalOpaque);
+            this.#updateSocketInfo(socketInfo, internalOpaque, rawError);
             channels.response.publish({
                 request: reqMeta,
                 response: res,
@@ -620,21 +627,38 @@ class HttpClient extends node_events_1.EventEmitter {
             throw err;
         }
     }
-    #updateSocketInfo(socketInfo, internalOpaque) {
-        const socket = internalOpaque[symbols_js_1.default.kRequestSocket];
+    #updateSocketInfo(socketInfo, internalOpaque, err) {
+        const socket = internalOpaque[symbols_js_1.default.kRequestSocket] ?? err?.[symbols_js_1.default.kErrorSocket];
         if (socket) {
             socketInfo.id = socket[symbols_js_1.default.kSocketId];
             socketInfo.handledRequests = socket[symbols_js_1.default.kHandledRequests];
             socketInfo.handledResponses = socket[symbols_js_1.default.kHandledResponses];
-            socketInfo.localAddress = socket[symbols_js_1.default.kSocketLocalAddress];
-            socketInfo.localPort = socket[symbols_js_1.default.kSocketLocalPort];
-            socketInfo.remoteAddress = socket.remoteAddress;
-            socketInfo.remotePort = socket.remotePort;
-            socketInfo.remoteFamily = socket.remoteFamily;
+            if (socket[symbols_js_1.default.kSocketLocalAddress]) {
+                socketInfo.localAddress = socket[symbols_js_1.default.kSocketLocalAddress];
+                socketInfo.localPort = socket[symbols_js_1.default.kSocketLocalPort];
+            }
+            if (socket.remoteAddress) {
+                socketInfo.remoteAddress = socket.remoteAddress;
+                socketInfo.remotePort = socket.remotePort;
+                socketInfo.remoteFamily = socket.remoteFamily;
+            }
             socketInfo.bytesRead = socket.bytesRead;
             socketInfo.bytesWritten = socket.bytesWritten;
-            socketInfo.connectedTime = socket[symbols_js_1.default.kSocketConnectedTime];
-            socketInfo.lastRequestEndTime = socket[symbols_js_1.default.kSocketRequestEndTime];
+            if (socket[symbols_js_1.default.kSocketConnectErrorTime]) {
+                socketInfo.connectErrorTime = socket[symbols_js_1.default.kSocketConnectErrorTime];
+                if (Array.isArray(socket.autoSelectFamilyAttemptedAddresses)) {
+                    socketInfo.attemptedRemoteAddresses = socket.autoSelectFamilyAttemptedAddresses;
+                }
+                socketInfo.connectProtocol = socket[symbols_js_1.default.kSocketConnectProtocol];
+                socketInfo.connectHost = socket[symbols_js_1.default.kSocketConnectHost];
+                socketInfo.connectPort = socket[symbols_js_1.default.kSocketConnectPort];
+            }
+            if (socket[symbols_js_1.default.kSocketConnectedTime]) {
+                socketInfo.connectedTime = socket[symbols_js_1.default.kSocketConnectedTime];
+            }
+            if (socket[symbols_js_1.default.kSocketRequestEndTime]) {
+                socketInfo.lastRequestEndTime = socket[symbols_js_1.default.kSocketRequestEndTime];
+            }
             socket[symbols_js_1.default.kSocketRequestEndTime] = new Date();
         }
     }

package/dist/commonjs/HttpClientError.d.ts

@@ -0,0 +1,19 @@
+import type { RawResponseWithMeta, SocketInfo } from './Response.js';
+import type { IncomingHttpHeaders } from './IncomingHttpHeaders.js';
+interface ErrorOptions {
+    cause?: Error;
+}
+export declare class HttpClientRequestError extends Error {
+    status?: number;
+    headers?: IncomingHttpHeaders;
+    socket?: SocketInfo;
+    res?: RawResponseWithMeta;
+}
+export declare class HttpClientRequestTimeoutError extends HttpClientRequestError {
+    constructor(timeout: number, options: ErrorOptions);
+}
+export declare class HttpClientConnectTimeoutError extends HttpClientRequestError {
+    code: string;
+    constructor(message: string, code: string, options: ErrorOptions);
+}
+export {};

package/dist/commonjs/HttpClientError.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpClientConnectTimeoutError = exports.HttpClientRequestTimeoutError = exports.HttpClientRequestError = void 0;
+class HttpClientRequestError extends Error {
+    status;
+    headers;
+    socket;
+    res;
+}
+exports.HttpClientRequestError = HttpClientRequestError;
+class HttpClientRequestTimeoutError extends HttpClientRequestError {
+    constructor(timeout, options) {
+        const message = `Request timeout for ${timeout} ms`;
+        super(message, options);
+        this.name = this.constructor.name;
+        Error.captureStackTrace(this, this.constructor);
+    }
+}
+exports.HttpClientRequestTimeoutError = HttpClientRequestTimeoutError;
+class HttpClientConnectTimeoutError extends HttpClientRequestError {
+    code;
+    constructor(message, code, options) {
+        super(message, options);
+        this.name = this.constructor.name;
+        this.code = code;
+        Error.captureStackTrace(this, this.constructor);
+    }
+}
+exports.HttpClientConnectTimeoutError = HttpClientConnectTimeoutError;

package/dist/commonjs/Response.d.ts

@@ -13,7 +13,12 @@ export type SocketInfo = {
     handledRequests: number;
     handledResponses: number;
     connectedTime?: Date;
+    connectErrorTime?: Date;
     lastRequestEndTime?: Date;
+    attemptedRemoteAddresses?: string[];
+    connectProtocol?: string;
+    connectHost?: string;
+    connectPort?: string;
 };
 /**
  * https://eggjs.org/en/core/httpclient.html#timing-boolean

package/dist/commonjs/diagnosticsChannel.js

@@ -7,6 +7,7 @@ exports.initDiagnosticsChannel = void 0;
 const node_diagnostics_channel_1 = __importDefault(require("node:diagnostics_channel"));
 const node_perf_hooks_1 = require("node:perf_hooks");
 const node_util_1 = require("node:util");
+const node_net_1 = require("node:net");
 const symbols_js_1 = __importDefault(require("./symbols.js"));
 const utils_js_1 = require("./utils.js");
 const debug = (0, node_util_1.debuglog)('urllib:DiagnosticsChannel');
@@ -38,8 +39,23 @@ function formatSocket(socket) {
         localPort: socket[symbols_js_1.default.kSocketLocalPort],
         remoteAddress: socket.remoteAddress,
         remotePort: socket.remotePort,
+        attemptedAddresses: socket.autoSelectFamilyAttemptedAddresses,
+        connecting: socket.connecting,
     };
 }
+// make sure error contains socket info
+const kDestroy = Symbol('kDestroy');
+node_net_1.Socket.prototype[kDestroy] = node_net_1.Socket.prototype.destroy;
+node_net_1.Socket.prototype.destroy = function (err) {
+    if (err) {
+        Object.defineProperty(err, symbols_js_1.default.kErrorSocket, {
+            // don't show on console log
+            enumerable: false,
+            value: this,
+        });
+    }
+    return this[kDestroy](err);
+};
 function initDiagnosticsChannel() {
     // makre sure init global DiagnosticsChannel once
     if (initedDiagnosticsChannel)
@@ -69,10 +85,34 @@ function initDiagnosticsChannel() {
         opaque[symbols_js_1.default.kRequestTiming].queuing = (0, utils_js_1.performanceTime)(opaque[symbols_js_1.default.kRequestStartTime]);
     });
     // diagnosticsChannel.channel('undici:client:beforeConnect')
-    // diagnosticsChannel.channel('undici:client:connectError')
+    subscribe('undici:client:connectError', (message, name) => {
+        const { error, connectParams } = message;
+        let { socket } = message;
+        if (!socket && error[symbols_js_1.default.kErrorSocket]) {
+            socket = error[symbols_js_1.default.kErrorSocket];
+        }
+        if (socket) {
+            socket[symbols_js_1.default.kSocketId] = (0, utils_js_1.globalId)('UndiciSocket');
+            socket[symbols_js_1.default.kSocketConnectErrorTime] = new Date();
+            socket[symbols_js_1.default.kHandledRequests] = 0;
+            socket[symbols_js_1.default.kHandledResponses] = 0;
+            // copy local address to symbol, avoid them be reset after request error throw
+            if (socket.localAddress) {
+                socket[symbols_js_1.default.kSocketLocalAddress] = socket.localAddress;
+                socket[symbols_js_1.default.kSocketLocalPort] = socket.localPort;
+            }
+            socket[symbols_js_1.default.kSocketConnectProtocol] = connectParams.protocol;
+            socket[symbols_js_1.default.kSocketConnectHost] = connectParams.host;
+            socket[symbols_js_1.default.kSocketConnectPort] = connectParams.port;
+            debug('[%s] Socket#%d connectError, connectParams: %o, error: %s, (sock: %o)', name, socket[symbols_js_1.default.kSocketId], connectParams, error.message, formatSocket(socket));
+        }
+        else {
+            debug('[%s] connectError, connectParams: %o, error: %o', name, connectParams, error);
+        }
+    });
     // This message is published after a connection is established.
     subscribe('undici:client:connected', (message, name) => {
-        const { socket } = message;
+        const { socket, connectParams } = message;
         socket[symbols_js_1.default.kSocketId] = (0, utils_js_1.globalId)('UndiciSocket');
         socket[symbols_js_1.default.kSocketStartTime] = node_perf_hooks_1.performance.now();
         socket[symbols_js_1.default.kSocketConnectedTime] = new Date();
@@ -81,6 +121,9 @@ function initDiagnosticsChannel() {
         // copy local address to symbol, avoid them be reset after request error throw
         socket[symbols_js_1.default.kSocketLocalAddress] = socket.localAddress;
         socket[symbols_js_1.default.kSocketLocalPort] = socket.localPort;
+        socket[symbols_js_1.default.kSocketConnectProtocol] = connectParams.protocol;
+        socket[symbols_js_1.default.kSocketConnectHost] = connectParams.host;
+        socket[symbols_js_1.default.kSocketConnectPort] = connectParams.port;
         debug('[%s] Socket#%d connected (sock: %o)', name, socket[symbols_js_1.default.kSocketId], formatSocket(socket));
     });
     // This message is published right before the first byte of the request is written to the socket.

package/dist/commonjs/index.d.ts

@@ -6,6 +6,7 @@ export { HttpClient, HttpClient as HttpClient2, HEADER_USER_AGENT as USER_AGENT,
 export { RequestOptions, RequestOptions as RequestOptions2, RequestURL, HttpMethod, FixJSONCtlCharsHandler, FixJSONCtlChars, } from './Request.js';
 export { SocketInfo, Timing, RawResponseWithMeta, HttpClientResponse, } from './Response.js';
 export { IncomingHttpHeaders, } from './IncomingHttpHeaders.js';
+export * from './HttpClientError.js';
 declare const _default: {
     request: typeof request;
     curl: typeof curl;

package/dist/commonjs/index.js

@@ -1,4 +1,18 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -25,7 +39,7 @@ async function request(url, options) {
     return await httpclient.request(url, options);
 }
 exports.request = request;
-// export curl method is keep compatible with urlib.curl()
+// export curl method is keep compatible with urllib.curl()
 // ```ts
 // import * as urllib from 'urllib';
 // urllib.curl(url);
@@ -46,6 +60,7 @@ var HttpClient_js_2 = require("./HttpClient.js");
 Object.defineProperty(exports, "HttpClient", { enumerable: true, get: function () { return HttpClient_js_2.HttpClient; } });
 Object.defineProperty(exports, "HttpClient2", { enumerable: true, get: function () { return HttpClient_js_2.HttpClient; } });
 Object.defineProperty(exports, "USER_AGENT", { enumerable: true, get: function () { return HttpClient_js_2.HEADER_USER_AGENT; } });
+__exportStar(require("./HttpClientError.js"), exports);
 exports.default = {
     request,
     curl,

package/dist/commonjs/package.json

@@ -1 +1,3 @@
-{"type":"commonjs"}
+{
+  "type": "commonjs"
+}

package/dist/commonjs/symbols.d.ts

@@ -2,9 +2,13 @@ declare const _default: {
     kSocketId: symbol;
     kSocketStartTime: symbol;
     kSocketConnectedTime: symbol;
+    kSocketConnectErrorTime: symbol;
     kSocketRequestEndTime: symbol;
     kSocketLocalAddress: symbol;
     kSocketLocalPort: symbol;
+    kSocketConnectHost: symbol;
+    kSocketConnectPort: symbol;
+    kSocketConnectProtocol: symbol;
     kHandledRequests: symbol;
     kHandledResponses: symbol;
     kRequestSocket: symbol;
@@ -13,5 +17,6 @@ declare const _default: {
     kEnableRequestTiming: symbol;
     kRequestTiming: symbol;
     kRequestOriginalOpaque: symbol;
+    kErrorSocket: symbol;
 };
 export default _default;

package/dist/commonjs/symbols.js

@@ -4,9 +4,13 @@ exports.default = {
     kSocketId: Symbol('socket id'),
     kSocketStartTime: Symbol('socket start time'),
     kSocketConnectedTime: Symbol('socket connected time'),
+    kSocketConnectErrorTime: Symbol('socket connectError time'),
     kSocketRequestEndTime: Symbol('socket request end time'),
     kSocketLocalAddress: Symbol('socket local address'),
     kSocketLocalPort: Symbol('socket local port'),
+    kSocketConnectHost: Symbol('socket connect params: host'),
+    kSocketConnectPort: Symbol('socket connect params: port'),
+    kSocketConnectProtocol: Symbol('socket connect params: protocol'),
     kHandledRequests: Symbol('handled requests per socket'),
     kHandledResponses: Symbol('handled responses per socket'),
     kRequestSocket: Symbol('request on the socket'),
@@ -15,4 +19,5 @@ exports.default = {
     kEnableRequestTiming: Symbol('enable request timing or not'),
     kRequestTiming: Symbol('request timing'),
     kRequestOriginalOpaque: Symbol('request original opaque'),
+    kErrorSocket: Symbol('socket of error'),
 };

package/dist/commonjs/utils.js

@@ -5,12 +5,12 @@ const node_crypto_1 = require("node:crypto");
 const node_stream_1 = require("node:stream");
 const node_perf_hooks_1 = require("node:perf_hooks");
 const JSONCtlCharsMap = {
-    '"': '\\"',
-    '\\': '\\\\',
-    '\b': '\\b',
-    '\f': '\\f',
-    '\n': '\\n',
-    '\r': '\\r',
+    '"': '\\"', // \u0022
+    '\\': '\\\\', // \u005c
+    '\b': '\\b', // \u0008
+    '\f': '\\f', // \u000c
+    '\n': '\\n', // \u000a
+    '\r': '\\r', // \u000d
     '\t': '\\t', // \u0009
 };
 /* eslint no-control-regex: "off"*/

package/dist/esm/HttpAgent.js

@@ -62,7 +62,7 @@ export class HttpAgent extends Agent {
             }
             const family = isIP(hostname);
             if (family === 4 || family === 6) {
-                // if request hostname is ip, custom lookup won't excute
+                // if request hostname is ip, custom lookup won't execute
                 if (!this.#checkAddress(hostname, family)) {
                     throw new IllegalAddressError(hostname, hostname, family);
                 }

package/dist/esm/HttpClient.d.ts

@@ -3,6 +3,7 @@
 /// <reference types="node" resolution-mode="require"/>
 import { EventEmitter } from 'node:events';
 import { LookupFunction } from 'node:net';
+import { Dispatcher } from 'undici';
 import { CheckAddressFunction } from './HttpAgent.js';
 import { RequestURL, RequestOptions, RequestMeta } from './Request.js';
 import { RawResponseWithMeta, HttpClientResponse } from './Response.js';
@@ -34,6 +35,10 @@ export type ClientOptions = {
          * socketPath string | null (optional) - Default: null - An IPC endpoint, either Unix domain socket or Windows named pipe
          */
         socketPath?: string | null;
+        /**
+         * connect timeout, default is 10000ms
+         */
+        timeout?: number;
     };
 };
 export declare const HEADER_USER_AGENT: string;
@@ -48,6 +53,8 @@ export type ResponseDiagnosticsMessage = {
 export declare class HttpClient extends EventEmitter {
     #private;
     constructor(clientOptions?: ClientOptions);
+    getDispatcher(): Dispatcher;
+    setDispatcher(dispatcher: Dispatcher): void;
     request<T = any>(url: RequestURL, options?: RequestOptions): Promise<HttpClientResponse<T>>;
     curl<T = any>(url: RequestURL, options?: RequestOptions): Promise<HttpClientResponse<T>>;
 }