urllib 3.19.2 → 3.20.0

package/README.md

@@ -16,7 +16,7 @@
 [download-url]: https://npmjs.org/package/urllib
 
 Request HTTP URLs in a complex world — basic
-and digest authentication, redirections, cookies, timeout and more.
+and digest authentication, redirections, timeout and more.
 
 ## Install
 
@@ -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/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

@@ -73,7 +73,7 @@ class HttpClientRequestTimeoutError extends Error {
         Error.captureStackTrace(this, this.constructor);
     }
 }
-exports.HEADER_USER_AGENT = (0, default_user_agent_1.default)('node-urllib', '3.19.2');
+exports.HEADER_USER_AGENT = (0, default_user_agent_1.default)('node-urllib', '3.20.0');
 function getFileName(stream) {
     const filePath = stream.path;
     if (filePath) {
@@ -94,15 +94,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);
     }
@@ -126,7 +137,8 @@ class HttpClient extends node_events_1.EventEmitter {
                 requestUrl = new URL((0, node_url_1.format)(url));
             }
             else {
-                requestUrl = url;
+                // or even if not, we clone to avoid mutating it
+                requestUrl = new URL(url.toString());
             }
         }
         const method = (options?.method ?? 'GET').toUpperCase();

package/dist/commonjs/index.js

@@ -25,7 +25,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);

package/dist/commonjs/package.json

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

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/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>>;
 }

package/dist/esm/HttpClient.js

@@ -10,7 +10,7 @@ import { basename } from 'node:path';
 import { createReadStream } from 'node:fs';
 import { format as urlFormat } from 'node:url';
 import { performance } from 'node:perf_hooks';
-import { FormData as FormDataNative, request as undiciRequest, } from 'undici';
+import { FormData as FormDataNative, request as undiciRequest, Agent, getGlobalDispatcher, } from 'undici';
 import { FormData as FormDataNode } from 'formdata-node';
 import { FormDataEncoder } from 'form-data-encoder';
 import createUserAgent from 'default-user-agent';
@@ -67,7 +67,7 @@ class HttpClientRequestTimeoutError extends Error {
         Error.captureStackTrace(this, this.constructor);
     }
 }
-export const HEADER_USER_AGENT = createUserAgent('node-urllib', '3.19.2');
+export const HEADER_USER_AGENT = createUserAgent('node-urllib', '3.20.0');
 function getFileName(stream) {
     const filePath = stream.path;
     if (filePath) {
@@ -88,15 +88,26 @@ export class HttpClient extends EventEmitter {
     constructor(clientOptions) {
         super();
         this.#defaultArgs = clientOptions?.defaultArgs;
-        if (clientOptions?.lookup || clientOptions?.checkAddress || clientOptions?.connect) {
+        if (clientOptions?.lookup || clientOptions?.checkAddress) {
             this.#dispatcher = new HttpAgent({
                 lookup: clientOptions.lookup,
                 checkAddress: clientOptions.checkAddress,
                 connect: clientOptions.connect,
             });
         }
+        else if (clientOptions?.connect) {
+            this.#dispatcher = new Agent({
+                connect: clientOptions.connect,
+            });
+        }
         initDiagnosticsChannel();
     }
+    getDispatcher() {
+        return this.#dispatcher ?? getGlobalDispatcher();
+    }
+    setDispatcher(dispatcher) {
+        this.#dispatcher = dispatcher;
+    }
     async request(url, options) {
         return await this.#requestInternal(url, options);
     }
@@ -120,7 +131,8 @@ export class HttpClient extends EventEmitter {
                 requestUrl = new URL(urlFormat(url));
             }
             else {
-                requestUrl = url;
+                // or even if not, we clone to avoid mutating it
+                requestUrl = new URL(url.toString());
             }
         }
         const method = (options?.method ?? 'GET').toUpperCase();

package/dist/esm/index.js

@@ -18,7 +18,7 @@ export async function request(url, options) {
     }
     return await httpclient.request(url, options);
 }
-// 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);

package/dist/esm/package.json

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

package/dist/esm/utils.js

@@ -2,12 +2,12 @@ import { randomBytes, createHash } from 'node:crypto';
 import { Readable } from 'node:stream';
 import { performance } from '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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "urllib",
-  "version": "3.19.2",
+  "version": "3.20.0",
   "publishConfig": {
     "tag": "latest"
   },
@@ -18,30 +18,6 @@
   ],
   "author": "fengmk2 <fengmk2@gmail.com> (https://github.com/fengmk2)",
   "homepage": "https://github.com/node-modules/urllib",
-  "type": "module",
-  "tshy": {
-    "exports": {
-      ".": "./src/index.ts",
-      "./package.json": "./package.json"
-    }
-  },
-  "exports": {
-    ".": {
-      "import": {
-        "types": "./dist/esm/index.d.ts",
-        "default": "./dist/esm/index.js"
-      },
-      "require": {
-        "types": "./dist/commonjs/index.d.ts",
-        "default": "./dist/commonjs/index.js"
-      }
-    },
-    "./package.json": "./package.json"
-  },
-  "files": [
-    "dist",
-    "src"
-  ],
   "repository": {
     "type": "git",
     "url": "git://github.com/node-modules/urllib.git"
@@ -62,6 +38,7 @@
     "test": "npm run lint && vitest run",
     "test-keepalive": "cross-env TEST_KEEPALIVE_COUNT=50 vitest run --test-timeout 180000 keep-alive-header.test.ts",
     "cov": "vitest run --coverage",
+    "preci": "node scripts/pre_test.js",
     "ci": "npm run lint && npm run cov && node scripts/build_test.js",
     "contributor": "git-contributor",
     "clean": "rm -rf dist",
@@ -91,7 +68,7 @@
     "@types/qs": "^6.9.7",
     "@types/selfsigned": "^2.0.1",
     "@types/tar-stream": "^2.2.2",
-    "@vitest/coverage-v8": "^0.32.0",
+    "@vitest/coverage-v8": "beta",
     "busboy": "^1.6.0",
     "cross-env": "^7.0.3",
     "eslint": "^8.25.0",
@@ -101,14 +78,39 @@
     "proxy": "^1.0.2",
     "selfsigned": "^2.0.1",
     "tar-stream": "^2.2.0",
-    "tshy": "^1.0.0-3",
+    "tshy": "^1.0.0",
     "tshy-after": "^1.0.0",
     "typescript": "^5.0.4",
-    "vitest": "^0.32.0"
+    "vitest": "beta"
   },
   "engines": {
     "node": ">= 14.19.3"
   },
   "license": "MIT",
-  "types": "./dist/commonjs/index.d.ts"
+  "type": "module",
+  "tshy": {
+    "exports": {
+      ".": "./src/index.ts",
+      "./package.json": "./package.json"
+    }
+  },
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "require": {
+        "types": "./dist/commonjs/index.d.ts",
+        "default": "./dist/commonjs/index.js"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "types": "./dist/commonjs/index.d.ts",
+  "main": "./dist/commonjs/index.js"
 }

package/src/HttpClient.ts

@@ -20,6 +20,8 @@ import {
   FormData as FormDataNative,
   request as undiciRequest,
   Dispatcher,
+  Agent,
+  getGlobalDispatcher,
 } from 'undici';
 import { FormData as FormDataNode } from 'formdata-node';
 import { FormDataEncoder } from 'form-data-encoder';
@@ -86,11 +88,14 @@ export type ClientOptions = {
     * An 'error' event is emitted if verification fails.Default: true.
     */
     rejectUnauthorized?: boolean;
-
     /**
      * 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;
   },
 };
 
@@ -168,16 +173,28 @@ export class HttpClient extends EventEmitter {
   constructor(clientOptions?: ClientOptions) {
     super();
     this.#defaultArgs = clientOptions?.defaultArgs;
-    if (clientOptions?.lookup || clientOptions?.checkAddress || clientOptions?.connect) {
+    if (clientOptions?.lookup || clientOptions?.checkAddress) {
       this.#dispatcher = new HttpAgent({
         lookup: clientOptions.lookup,
         checkAddress: clientOptions.checkAddress,
         connect: clientOptions.connect,
       });
+    } else if (clientOptions?.connect) {
+      this.#dispatcher = new Agent({
+        connect: clientOptions.connect,
+      });
     }
     initDiagnosticsChannel();
   }
 
+  getDispatcher() {
+    return this.#dispatcher ?? getGlobalDispatcher();
+  }
+
+  setDispatcher(dispatcher: Dispatcher) {
+    this.#dispatcher = dispatcher;
+  }
+
   async request<T = any>(url: RequestURL, options?: RequestOptions) {
     return await this.#requestInternal<T>(url, options);
   }
@@ -201,7 +218,8 @@ export class HttpClient extends EventEmitter {
         // url maybe url.parse(url) object in urllib2
         requestUrl = new URL(urlFormat(url));
       } else {
-        requestUrl = url;
+        // or even if not, we clone to avoid mutating it
+        requestUrl = new URL(url.toString());
       }
     }
 

package/src/index.ts

@@ -4,6 +4,7 @@ import { RequestOptions, RequestURL } from './Request.js';
 
 let httpclient: HttpClient;
 const domainSocketHttpclients = new LRU(50);
+
 export async function request<T = any>(url: RequestURL, options?: RequestOptions) {
   if (options?.socketPath) {
     let domainSocketHttpclient = domainSocketHttpclients.get<HttpClient>(options.socketPath);
@@ -22,7 +23,7 @@ export async function request<T = any>(url: RequestURL, options?: RequestOptions
   return await httpclient.request<T>(url, options);
 }
 
-// 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);
@@ -53,7 +54,6 @@ export {
   IncomingHttpHeaders,
 } from './IncomingHttpHeaders.js';
 
-
 export default {
   request,
   curl,