urllib 3.17.0 → 3.17.2

package/README.md

@@ -64,7 +64,8 @@ console.log('status: %s, body size: %d, headers: %j', res.status, data.length, r
   - ***dataType*** String - Type of response data. Could be `text` or `json`. If it's `text`, the `callback`ed `data` would be a String. If it's `json`, the `data` of callback would be a parsed JSON Object and will auto set `Accept: application/json` header. Default `callback`ed `data` would be a `Buffer`.
   - **fixJSONCtlChars** Boolean - Fix the control characters (U+0000 through U+001F) before JSON parse response. Default is `false`.
   - ***headers*** Object - Request headers.
-  - ***timeout*** Number | Array - Request timeout in milliseconds for connecting phase and response receiving phase. Defaults to `exports.TIMEOUT`, both are 5s. You can use `timeout: 5000` to tell urllib use same timeout on two phase or set them seperately such as `timeout: [3000, 5000]`, which will set connecting timeout to 3s and response 5s.
+  - ***timeout*** Number | Array - Request timeout in milliseconds for connecting phase and response receiving phase. Default is `5000`. You can use `timeout: 5000` to tell urllib use same timeout on two phase or set them seperately such as `timeout: [3000, 5000]`, which will set connecting timeout to 3s and response 5s.
+  - **keepAliveTimeout** `number | null` - Default is `4000`, 4 seconds - 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.
   - ***auth*** String - `username:password` used in HTTP Basic Authorization.
   - ***digestAuth*** String - `username:password` used in HTTP [Digest Authorization](https://en.wikipedia.org/wiki/Digest_access_authentication).
   - ***followRedirect*** Boolean - follow HTTP 3xx responses as redirects. defaults to false.
@@ -72,8 +73,8 @@ console.log('status: %s, body size: %d, headers: %j', res.status, data.length, r
   - ***formatRedirectUrl*** Function - Format the redirect url by your self. Default is `url.resolve(from, to)`.
   - ***beforeRequest*** Function - Before request hook, you can change every thing here.
   - ***streaming*** Boolean - let you get the `res` object when request  connected, default `false`. alias `customResponse`
-  - ***compressed*** Boolean - Accept `gzip, br` response content and auto decode it, default is `false`.
-  - ***timing*** Boolean - Enable timing or not, default is `false`.
+  - ***compressed*** Boolean - Accept `gzip, br` response content and auto decode it, default is `true`.
+  - ***timing*** Boolean - Enable timing or not, default is `true`.
   - ***socketPath*** String | null - request a unix socket service, default is `null`.
   - ***highWaterMark*** Number - default is `67108864`, 64 KiB.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "urllib",
-  "version": "3.17.0",
+  "version": "3.17.2",
   "publishConfig": {
     "tag": "latest"
   },
@@ -53,7 +53,7 @@
     "build:test": "npm run build && npm run build:cjs:test && npm run build:esm:test && npm run test-tsc",
     "test-tsc": "tsc -p ./test/fixtures/ts/tsconfig.json",
     "test": "npm run lint && vitest run",
-    "test-keepalive": "cross-env TEST_KEEPALIVE_COUNT=50 vitest run --test-timeout 120000 keep-alive-header.test.ts",
+    "test-keepalive": "cross-env TEST_KEEPALIVE_COUNT=50 vitest run --test-timeout 180000 keep-alive-header.test.ts",
     "cov": "vitest run --coverage",
     "ci": "npm run lint && npm run cov && npm run build:test",
     "contributor": "git-contributor",

package/src/HttpAgent.ts

@@ -37,8 +37,11 @@ export class HttpAgent extends Agent {
     /* eslint node/prefer-promises/dns: off*/
     const _lookup = options.lookup ?? dns.lookup;
     const lookup: LookupFunction = (hostname, dnsOptions, callback) => {
-      _lookup(hostname, dnsOptions, (err, address, family) => {
-        if (err) return callback(err, address, family);
+      _lookup(hostname, dnsOptions, (err, ...args: any[]) => {
+        // address will be array on Node.js >= 20
+        const address = args[0];
+        const family = args[1];
+        if (err) return (callback as any)(err, address, family);
         if (options.checkAddress) {
           // dnsOptions.all set to default on Node.js >= 20, dns.lookup will return address array object
           if (typeof address === 'string') {
@@ -55,7 +58,7 @@ export class HttpAgent extends Agent {
             }
           }
         }
-        callback(err, address, family);
+        (callback as any)(err, address, family);
       });
     };
     super({

package/src/HttpClient.ts

@@ -58,6 +58,8 @@ function noop() {
 }
 
 const debug = debuglog('urllib:HttpClient');
+// Node.js 14 or 16
+const isNode14Or16 = /v1[46]\./.test(process.version);
 
 export type ClientOptions = {
   defaultArgs?: RequestOptions;
@@ -138,6 +140,7 @@ function defaultIsRetry(response: HttpClientResponse) {
 
 type RequestContext = {
   retries: number;
+  socketErrorRetries: number;
   requestStartTime?: number;
 };
 
@@ -206,6 +209,7 @@ export class HttpClient extends EventEmitter {
     const headers: IncomingHttpHeaders = {};
     const args = {
       retry: 0,
+      socketErrorRetry: 1,
       timing: true,
       ...this.#defaultArgs,
       ...options,
@@ -215,6 +219,7 @@ export class HttpClient extends EventEmitter {
     };
     requestContext = {
       retries: 0,
+      socketErrorRetries: 0,
       ...requestContext,
     };
     if (!requestContext.requestStartTime) {
@@ -281,6 +286,8 @@ export class HttpClient extends EventEmitter {
       requestUrls: [],
       timing,
       socket: socketInfo,
+      retries: requestContext.retries,
+      socketErrorRetries: requestContext.socketErrorRetries,
     } as any as RawResponseWithMeta;
 
     let headersTimeout = 5000;
@@ -324,10 +331,19 @@ export class HttpClient extends EventEmitter {
     if (requestContext.retries > 0) {
       headers['x-urllib-retry'] = `${requestContext.retries}/${args.retry}`;
     }
+    if (requestContext.socketErrorRetries > 0) {
+      headers['x-urllib-retry-on-socket-error'] = `${requestContext.socketErrorRetries}/${args.socketErrorRetry}`;
+    }
     if (args.auth && !headers.authorization) {
       headers.authorization = `Basic ${Buffer.from(args.auth).toString('base64')}`;
     }
 
+    // streaming request should disable socketErrorRetry and retry
+    let isStreamingRequest = false;
+    if (args.dataType === 'stream' || args.writeStream) {
+      isStreamingRequest = true;
+    }
+
     try {
       const requestOptions: IUndiciRequestOption = {
         method,
@@ -356,9 +372,11 @@ export class HttpClient extends EventEmitter {
         if (isReadable(args.stream) && !(args.stream instanceof Readable)) {
           debug('Request#%d convert old style stream to Readable', requestId);
           args.stream = new Readable().wrap(args.stream);
+          isStreamingRequest = true;
         } else if (args.stream instanceof FormStream) {
           debug('Request#%d convert formstream to Readable', requestId);
           args.stream = new Readable().wrap(args.stream);
+          isStreamingRequest = true;
         }
         args.content = args.stream;
       }
@@ -402,6 +420,7 @@ export class HttpClient extends EventEmitter {
           } else if (file instanceof Readable || isReadable(file as any)) {
             const fileName = getFileName(file) || `streamfile${index}`;
             formData.append(field, new BlobFromStream(file, mime.lookup(fileName) || ''), fileName);
+            isStreamingRequest = true;
           }
         }
 
@@ -425,6 +444,7 @@ export class HttpClient extends EventEmitter {
           } else if (typeof args.content === 'string' && !headers['content-type']) {
             headers['content-type'] = 'text/plain;charset=UTF-8';
           }
+          isStreamingRequest = isReadable(args.content);
         }
       } else if (args.data) {
         const isStringOrBufferOrReadable = typeof args.data === 'string'
@@ -441,6 +461,7 @@ export class HttpClient extends EventEmitter {
         } else {
           if (isStringOrBufferOrReadable) {
             requestOptions.body = args.data;
+            isStreamingRequest = isReadable(args.data);
           } else {
             if (args.contentType === 'json'
               || args.contentType === 'application/json'
@@ -456,9 +477,13 @@ export class HttpClient extends EventEmitter {
           }
         }
       }
+      if (isStreamingRequest) {
+        args.retry = 0;
+        args.socketErrorRetry = 0;
+      }
 
-      debug('Request#%d %s %s, headers: %j, headersTimeout: %s, bodyTimeout: %s',
-        requestId, requestOptions.method, requestUrl.href, headers, headersTimeout, bodyTimeout);
+      debug('Request#%d %s %s, headers: %j, headersTimeout: %s, bodyTimeout: %s, isStreamingRequest: %s',
+        requestId, requestOptions.method, requestUrl.href, headers, headersTimeout, bodyTimeout, isStreamingRequest);
       requestOptions.headers = headers;
       channels.request.publish({
         request: reqMeta,
@@ -511,8 +536,6 @@ export class HttpClient extends EventEmitter {
 
       let data: any = null;
       if (args.dataType === 'stream') {
-        // streaming mode will disable retry
-        args.retry = 0;
         // only auto decompress on request args.compressed = true
         if (args.compressed === true && isCompressedContent) {
           // gzip or br
@@ -522,8 +545,9 @@ export class HttpClient extends EventEmitter {
           res = Object.assign(response.body, res);
         }
       } else if (args.writeStream) {
-        // streaming mode will disable retry
-        args.retry = 0;
+        if (isNode14Or16 && args.writeStream.destroyed) {
+          throw new Error('writeStream is destroyed');
+        }
         if (args.compressed === true && isCompressedContent) {
           const decoder = contentEncoding === 'gzip' ? createGunzip() : createBrotliDecompress();
           await pipelinePromise(response.body, decoder, args.writeStream);
@@ -608,11 +632,8 @@ export class HttpClient extends EventEmitter {
         err = new HttpClientRequestTimeoutError(bodyTimeout, { cause: e });
       } else if (err.code === 'UND_ERR_SOCKET' || err.code === 'ECONNRESET') {
         // auto retry on socket error, https://github.com/node-modules/urllib/issues/454
-        if (args.retry > 0 && requestContext.retries < args.retry) {
-          if (args.retryDelay) {
-            await sleep(args.retryDelay);
-          }
-          requestContext.retries++;
+        if (args.socketErrorRetry > 0 && requestContext.socketErrorRetries < args.socketErrorRetry) {
+          requestContext.socketErrorRetries++;
           return await this.#requestInternal(url, options, requestContext);
         }
       }

package/src/Request.ts

@@ -69,11 +69,16 @@ export type RequestOptions = {
   headers?: IncomingHttpHeaders;
   /**
    * Request timeout in milliseconds for connecting phase and response receiving phase.
-   * Defaults to exports.
-   * TIMEOUT, both are 5s. You can use timeout: 5000 to tell urllib use same timeout on two phase or set them seperately such as
+   * Defaults is `5000`, both are 5 seconds. You can use timeout: 5000 to tell urllib use same timeout on two phase or set them separately such as
    * timeout: [3000, 5000], which will set connecting timeout to 3s and response 5s.
    */
   timeout?: number | number[];
+  /**
+   * Default is `4000`,  4 seconds - 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.
+   */
+  keepAliveTimeout?: number;
   /**
    * username:password used in HTTP Basic Authorization.
    * Alias to `headers.authorization = xxx`
@@ -91,7 +96,7 @@ export type RequestOptions = {
   formatRedirectUrl?: (a: any, b: any) => void;
   /** Before request hook, you can change every thing here. */
   beforeRequest?: (...args: any[]) => void;
-  /** Accept `gzip, br` response content and auto decode it, default is false. */
+  /** Accept `gzip, br` response content and auto decode it, default is `true`. */
   compressed?: boolean;
   /**
    * @deprecated
@@ -99,11 +104,11 @@ export type RequestOptions = {
    * */
   gzip?: boolean;
   /**
-   * Enable timing or not, default is true.
+   * Enable timing or not, default is `true`.
    * */
   timing?: boolean;
   /**
-   * Auto retry times on 5xx response, default is 0. Don't work on streaming request
+   * Auto retry times on 5xx response, default is `0`. Don't work on streaming request
    * It's not supported by using retry and writeStream, because the retry request can't stop the stream which is consuming.
    **/
   retry?: number;
@@ -114,6 +119,11 @@ export type RequestOptions = {
    * It will retry when status >= 500 by default. Request error is not included.
    */
   isRetry?: (response: HttpClientResponse) => boolean;
+  /**
+   * Auto retry times on socket error, default is `1`. Don't work on streaming request
+   * It's not supported by using retry and writeStream, because the retry request can't stop the stream which is consuming.
+   **/
+  socketErrorRetry?: number;
   /** Default: `null` */
   opaque?: unknown;
   /**

package/src/Response.ts

@@ -49,6 +49,8 @@ export type RawResponseWithMeta = Readable & {
   rt: number;
   keepAliveSocket: boolean;
   requestUrls: string[];
+  retries: number;
+  socketErrorRetries: number;
 };
 
 export type HttpClientResponse<T = any> = {

package/src/cjs/HttpAgent.js

@@ -27,7 +27,10 @@ class HttpAgent extends undici_1.Agent {
         /* eslint node/prefer-promises/dns: off*/
         const _lookup = options.lookup ?? node_dns_1.default.lookup;
         const lookup = (hostname, dnsOptions, callback) => {
-            _lookup(hostname, dnsOptions, (err, address, family) => {
+            _lookup(hostname, dnsOptions, (err, ...args) => {
+                // address will be array on Node.js >= 20
+                const address = args[0];
+                const family = args[1];
                 if (err)
                     return callback(err, address, family);
                 if (options.checkAddress) {

package/src/cjs/HttpClient.js

@@ -44,6 +44,8 @@ function noop() {
     // noop
 }
 const debug = (0, node_util_1.debuglog)('urllib:HttpClient');
+// Node.js 14 or 16
+const isNode14Or16 = /v1[46]\./.test(process.version);
 // https://github.com/octet-stream/form-data
 class BlobFromStream {
     #stream;
@@ -70,7 +72,7 @@ class HttpClientRequestTimeoutError extends Error {
         Error.captureStackTrace(this, this.constructor);
     }
 }
-exports.HEADER_USER_AGENT = (0, default_user_agent_1.default)('node-urllib', '3.17.0');
+exports.HEADER_USER_AGENT = (0, default_user_agent_1.default)('node-urllib', '3.17.2');
 function getFileName(stream) {
     const filePath = stream.path;
     if (filePath) {
@@ -131,6 +133,7 @@ class HttpClient extends node_events_1.EventEmitter {
         const headers = {};
         const args = {
             retry: 0,
+            socketErrorRetry: 1,
             timing: true,
             ...this.#defaultArgs,
             ...options,
@@ -140,6 +143,7 @@ class HttpClient extends node_events_1.EventEmitter {
         };
         requestContext = {
             retries: 0,
+            socketErrorRetries: 0,
             ...requestContext,
         };
         if (!requestContext.requestStartTime) {
@@ -205,6 +209,8 @@ class HttpClient extends node_events_1.EventEmitter {
             requestUrls: [],
             timing,
             socket: socketInfo,
+            retries: requestContext.retries,
+            socketErrorRetries: requestContext.socketErrorRetries,
         };
         let headersTimeout = 5000;
         let bodyTimeout = 5000;
@@ -249,9 +255,17 @@ class HttpClient extends node_events_1.EventEmitter {
         if (requestContext.retries > 0) {
             headers['x-urllib-retry'] = `${requestContext.retries}/${args.retry}`;
         }
+        if (requestContext.socketErrorRetries > 0) {
+            headers['x-urllib-retry-on-socket-error'] = `${requestContext.socketErrorRetries}/${args.socketErrorRetry}`;
+        }
         if (args.auth && !headers.authorization) {
             headers.authorization = `Basic ${Buffer.from(args.auth).toString('base64')}`;
         }
+        // streaming request should disable socketErrorRetry and retry
+        let isStreamingRequest = false;
+        if (args.dataType === 'stream' || args.writeStream) {
+            isStreamingRequest = true;
+        }
         try {
             const requestOptions = {
                 method,
@@ -279,10 +293,12 @@ class HttpClient extends node_events_1.EventEmitter {
                 if ((0, utils_1.isReadable)(args.stream) && !(args.stream instanceof node_stream_1.Readable)) {
                     debug('Request#%d convert old style stream to Readable', requestId);
                     args.stream = new node_stream_1.Readable().wrap(args.stream);
+                    isStreamingRequest = true;
                 }
                 else if (args.stream instanceof formstream_1.default) {
                     debug('Request#%d convert formstream to Readable', requestId);
                     args.stream = new node_stream_1.Readable().wrap(args.stream);
+                    isStreamingRequest = true;
                 }
                 args.content = args.stream;
             }
@@ -330,6 +346,7 @@ class HttpClient extends node_events_1.EventEmitter {
                     else if (file instanceof node_stream_1.Readable || (0, utils_1.isReadable)(file)) {
                         const fileName = getFileName(file) || `streamfile${index}`;
                         formData.append(field, new BlobFromStream(file, mime_types_1.default.lookup(fileName) || ''), fileName);
+                        isStreamingRequest = true;
                     }
                 }
                 if (undici_1.FormData) {
@@ -355,6 +372,7 @@ class HttpClient extends node_events_1.EventEmitter {
                     else if (typeof args.content === 'string' && !headers['content-type']) {
                         headers['content-type'] = 'text/plain;charset=UTF-8';
                     }
+                    isStreamingRequest = (0, utils_1.isReadable)(args.content);
                 }
             }
             else if (args.data) {
@@ -374,6 +392,7 @@ class HttpClient extends node_events_1.EventEmitter {
                 else {
                     if (isStringOrBufferOrReadable) {
                         requestOptions.body = args.data;
+                        isStreamingRequest = (0, utils_1.isReadable)(args.data);
                     }
                     else {
                         if (args.contentType === 'json'
@@ -391,7 +410,11 @@ class HttpClient extends node_events_1.EventEmitter {
                     }
                 }
             }
-            debug('Request#%d %s %s, headers: %j, headersTimeout: %s, bodyTimeout: %s', requestId, requestOptions.method, requestUrl.href, headers, headersTimeout, bodyTimeout);
+            if (isStreamingRequest) {
+                args.retry = 0;
+                args.socketErrorRetry = 0;
+            }
+            debug('Request#%d %s %s, headers: %j, headersTimeout: %s, bodyTimeout: %s, isStreamingRequest: %s', requestId, requestOptions.method, requestUrl.href, headers, headersTimeout, bodyTimeout, isStreamingRequest);
             requestOptions.headers = headers;
             channels.request.publish({
                 request: reqMeta,
@@ -440,8 +463,6 @@ class HttpClient extends node_events_1.EventEmitter {
             }
             let data = null;
             if (args.dataType === 'stream') {
-                // streaming mode will disable retry
-                args.retry = 0;
                 // only auto decompress on request args.compressed = true
                 if (args.compressed === true && isCompressedContent) {
                     // gzip or br
@@ -453,8 +474,9 @@ class HttpClient extends node_events_1.EventEmitter {
                 }
             }
             else if (args.writeStream) {
-                // streaming mode will disable retry
-                args.retry = 0;
+                if (isNode14Or16 && args.writeStream.destroyed) {
+                    throw new Error('writeStream is destroyed');
+                }
                 if (args.compressed === true && isCompressedContent) {
                     const decoder = contentEncoding === 'gzip' ? (0, node_zlib_1.createGunzip)() : (0, node_zlib_1.createBrotliDecompress)();
                     await pipelinePromise(response.body, decoder, args.writeStream);
@@ -543,11 +565,8 @@ class HttpClient extends node_events_1.EventEmitter {
             }
             else if (err.code === 'UND_ERR_SOCKET' || err.code === 'ECONNRESET') {
                 // auto retry on socket error, https://github.com/node-modules/urllib/issues/454
-                if (args.retry > 0 && requestContext.retries < args.retry) {
-                    if (args.retryDelay) {
-                        await (0, utils_1.sleep)(args.retryDelay);
-                    }
-                    requestContext.retries++;
+                if (args.socketErrorRetry > 0 && requestContext.socketErrorRetries < args.socketErrorRetry) {
+                    requestContext.socketErrorRetries++;
                     return await this.#requestInternal(url, options, requestContext);
                 }
             }

package/src/cjs/Request.d.ts

@@ -67,11 +67,16 @@ export type RequestOptions = {
     headers?: IncomingHttpHeaders;
     /**
      * Request timeout in milliseconds for connecting phase and response receiving phase.
-     * Defaults to exports.
-     * TIMEOUT, both are 5s. You can use timeout: 5000 to tell urllib use same timeout on two phase or set them seperately such as
+     * Defaults is `5000`, both are 5 seconds. You can use timeout: 5000 to tell urllib use same timeout on two phase or set them separately such as
      * timeout: [3000, 5000], which will set connecting timeout to 3s and response 5s.
      */
     timeout?: number | number[];
+    /**
+     * Default is `4000`,  4 seconds - 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.
+     */
+    keepAliveTimeout?: number;
     /**
      * username:password used in HTTP Basic Authorization.
      * Alias to `headers.authorization = xxx`
@@ -89,7 +94,7 @@ export type RequestOptions = {
     formatRedirectUrl?: (a: any, b: any) => void;
     /** Before request hook, you can change every thing here. */
     beforeRequest?: (...args: any[]) => void;
-    /** Accept `gzip, br` response content and auto decode it, default is false. */
+    /** Accept `gzip, br` response content and auto decode it, default is `true`. */
     compressed?: boolean;
     /**
      * @deprecated
@@ -97,11 +102,11 @@ export type RequestOptions = {
      * */
     gzip?: boolean;
     /**
-     * Enable timing or not, default is true.
+     * Enable timing or not, default is `true`.
      * */
     timing?: boolean;
     /**
-     * Auto retry times on 5xx response, default is 0. Don't work on streaming request
+     * Auto retry times on 5xx response, default is `0`. Don't work on streaming request
      * It's not supported by using retry and writeStream, because the retry request can't stop the stream which is consuming.
      **/
     retry?: number;
@@ -112,6 +117,11 @@ export type RequestOptions = {
      * It will retry when status >= 500 by default. Request error is not included.
      */
     isRetry?: (response: HttpClientResponse) => boolean;
+    /**
+     * Auto retry times on socket error, default is `1`. Don't work on streaming request
+     * It's not supported by using retry and writeStream, because the retry request can't stop the stream which is consuming.
+     **/
+    socketErrorRetry?: number;
     /** Default: `null` */
     opaque?: unknown;
     /**

package/src/cjs/Response.d.ts

@@ -39,6 +39,8 @@ export type RawResponseWithMeta = Readable & {
     rt: number;
     keepAliveSocket: boolean;
     requestUrls: string[];
+    retries: number;
+    socketErrorRetries: number;
 };
 export type HttpClientResponse<T = any> = {
     opaque: unknown;

package/src/esm/HttpAgent.js

@@ -21,7 +21,10 @@ export class HttpAgent extends Agent {
         /* eslint node/prefer-promises/dns: off*/
         const _lookup = options.lookup ?? dns.lookup;
         const lookup = (hostname, dnsOptions, callback) => {
-            _lookup(hostname, dnsOptions, (err, address, family) => {
+            _lookup(hostname, dnsOptions, (err, ...args) => {
+                // address will be array on Node.js >= 20
+                const address = args[0];
+                const family = args[1];
                 if (err)
                     return callback(err, address, family);
                 if (options.checkAddress) {

package/src/esm/HttpClient.js

@@ -38,6 +38,8 @@ function noop() {
     // noop
 }
 const debug = debuglog('urllib:HttpClient');
+// Node.js 14 or 16
+const isNode14Or16 = /v1[46]\./.test(process.version);
 // https://github.com/octet-stream/form-data
 class BlobFromStream {
     #stream;
@@ -64,7 +66,7 @@ class HttpClientRequestTimeoutError extends Error {
         Error.captureStackTrace(this, this.constructor);
     }
 }
-export const HEADER_USER_AGENT = createUserAgent('node-urllib', '3.17.0');
+export const HEADER_USER_AGENT = createUserAgent('node-urllib', '3.17.2');
 function getFileName(stream) {
     const filePath = stream.path;
     if (filePath) {
@@ -125,6 +127,7 @@ export class HttpClient extends EventEmitter {
         const headers = {};
         const args = {
             retry: 0,
+            socketErrorRetry: 1,
             timing: true,
             ...this.#defaultArgs,
             ...options,
@@ -134,6 +137,7 @@ export class HttpClient extends EventEmitter {
         };
         requestContext = {
             retries: 0,
+            socketErrorRetries: 0,
             ...requestContext,
         };
         if (!requestContext.requestStartTime) {
@@ -199,6 +203,8 @@ export class HttpClient extends EventEmitter {
             requestUrls: [],
             timing,
             socket: socketInfo,
+            retries: requestContext.retries,
+            socketErrorRetries: requestContext.socketErrorRetries,
         };
         let headersTimeout = 5000;
         let bodyTimeout = 5000;
@@ -243,9 +249,17 @@ export class HttpClient extends EventEmitter {
         if (requestContext.retries > 0) {
             headers['x-urllib-retry'] = `${requestContext.retries}/${args.retry}`;
         }
+        if (requestContext.socketErrorRetries > 0) {
+            headers['x-urllib-retry-on-socket-error'] = `${requestContext.socketErrorRetries}/${args.socketErrorRetry}`;
+        }
         if (args.auth && !headers.authorization) {
             headers.authorization = `Basic ${Buffer.from(args.auth).toString('base64')}`;
         }
+        // streaming request should disable socketErrorRetry and retry
+        let isStreamingRequest = false;
+        if (args.dataType === 'stream' || args.writeStream) {
+            isStreamingRequest = true;
+        }
         try {
             const requestOptions = {
                 method,
@@ -273,10 +287,12 @@ export class HttpClient extends EventEmitter {
                 if (isReadable(args.stream) && !(args.stream instanceof Readable)) {
                     debug('Request#%d convert old style stream to Readable', requestId);
                     args.stream = new Readable().wrap(args.stream);
+                    isStreamingRequest = true;
                 }
                 else if (args.stream instanceof FormStream) {
                     debug('Request#%d convert formstream to Readable', requestId);
                     args.stream = new Readable().wrap(args.stream);
+                    isStreamingRequest = true;
                 }
                 args.content = args.stream;
             }
@@ -324,6 +340,7 @@ export class HttpClient extends EventEmitter {
                     else if (file instanceof Readable || isReadable(file)) {
                         const fileName = getFileName(file) || `streamfile${index}`;
                         formData.append(field, new BlobFromStream(file, mime.lookup(fileName) || ''), fileName);
+                        isStreamingRequest = true;
                     }
                 }
                 if (FormDataNative) {
@@ -349,6 +366,7 @@ export class HttpClient extends EventEmitter {
                     else if (typeof args.content === 'string' && !headers['content-type']) {
                         headers['content-type'] = 'text/plain;charset=UTF-8';
                     }
+                    isStreamingRequest = isReadable(args.content);
                 }
             }
             else if (args.data) {
@@ -368,6 +386,7 @@ export class HttpClient extends EventEmitter {
                 else {
                     if (isStringOrBufferOrReadable) {
                         requestOptions.body = args.data;
+                        isStreamingRequest = isReadable(args.data);
                     }
                     else {
                         if (args.contentType === 'json'
@@ -385,7 +404,11 @@ export class HttpClient extends EventEmitter {
                     }
                 }
             }
-            debug('Request#%d %s %s, headers: %j, headersTimeout: %s, bodyTimeout: %s', requestId, requestOptions.method, requestUrl.href, headers, headersTimeout, bodyTimeout);
+            if (isStreamingRequest) {
+                args.retry = 0;
+                args.socketErrorRetry = 0;
+            }
+            debug('Request#%d %s %s, headers: %j, headersTimeout: %s, bodyTimeout: %s, isStreamingRequest: %s', requestId, requestOptions.method, requestUrl.href, headers, headersTimeout, bodyTimeout, isStreamingRequest);
             requestOptions.headers = headers;
             channels.request.publish({
                 request: reqMeta,
@@ -434,8 +457,6 @@ export class HttpClient extends EventEmitter {
             }
             let data = null;
             if (args.dataType === 'stream') {
-                // streaming mode will disable retry
-                args.retry = 0;
                 // only auto decompress on request args.compressed = true
                 if (args.compressed === true && isCompressedContent) {
                     // gzip or br
@@ -447,8 +468,9 @@ export class HttpClient extends EventEmitter {
                 }
             }
             else if (args.writeStream) {
-                // streaming mode will disable retry
-                args.retry = 0;
+                if (isNode14Or16 && args.writeStream.destroyed) {
+                    throw new Error('writeStream is destroyed');
+                }
                 if (args.compressed === true && isCompressedContent) {
                     const decoder = contentEncoding === 'gzip' ? createGunzip() : createBrotliDecompress();
                     await pipelinePromise(response.body, decoder, args.writeStream);
@@ -537,11 +559,8 @@ export class HttpClient extends EventEmitter {
             }
             else if (err.code === 'UND_ERR_SOCKET' || err.code === 'ECONNRESET') {
                 // auto retry on socket error, https://github.com/node-modules/urllib/issues/454
-                if (args.retry > 0 && requestContext.retries < args.retry) {
-                    if (args.retryDelay) {
-                        await sleep(args.retryDelay);
-                    }
-                    requestContext.retries++;
+                if (args.socketErrorRetry > 0 && requestContext.socketErrorRetries < args.socketErrorRetry) {
+                    requestContext.socketErrorRetries++;
                     return await this.#requestInternal(url, options, requestContext);
                 }
             }

package/src/esm/Request.d.ts

@@ -67,11 +67,16 @@ export type RequestOptions = {
     headers?: IncomingHttpHeaders;
     /**
      * Request timeout in milliseconds for connecting phase and response receiving phase.
-     * Defaults to exports.
-     * TIMEOUT, both are 5s. You can use timeout: 5000 to tell urllib use same timeout on two phase or set them seperately such as
+     * Defaults is `5000`, both are 5 seconds. You can use timeout: 5000 to tell urllib use same timeout on two phase or set them separately such as
      * timeout: [3000, 5000], which will set connecting timeout to 3s and response 5s.
      */
     timeout?: number | number[];
+    /**
+     * Default is `4000`,  4 seconds - 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.
+     */
+    keepAliveTimeout?: number;
     /**
      * username:password used in HTTP Basic Authorization.
      * Alias to `headers.authorization = xxx`
@@ -89,7 +94,7 @@ export type RequestOptions = {
     formatRedirectUrl?: (a: any, b: any) => void;
     /** Before request hook, you can change every thing here. */
     beforeRequest?: (...args: any[]) => void;
-    /** Accept `gzip, br` response content and auto decode it, default is false. */
+    /** Accept `gzip, br` response content and auto decode it, default is `true`. */
     compressed?: boolean;
     /**
      * @deprecated
@@ -97,11 +102,11 @@ export type RequestOptions = {
      * */
     gzip?: boolean;
     /**
-     * Enable timing or not, default is true.
+     * Enable timing or not, default is `true`.
      * */
     timing?: boolean;
     /**
-     * Auto retry times on 5xx response, default is 0. Don't work on streaming request
+     * Auto retry times on 5xx response, default is `0`. Don't work on streaming request
      * It's not supported by using retry and writeStream, because the retry request can't stop the stream which is consuming.
      **/
     retry?: number;
@@ -112,6 +117,11 @@ export type RequestOptions = {
      * It will retry when status >= 500 by default. Request error is not included.
      */
     isRetry?: (response: HttpClientResponse) => boolean;
+    /**
+     * Auto retry times on socket error, default is `1`. Don't work on streaming request
+     * It's not supported by using retry and writeStream, because the retry request can't stop the stream which is consuming.
+     **/
+    socketErrorRetry?: number;
     /** Default: `null` */
     opaque?: unknown;
     /**

package/src/esm/Response.d.ts

@@ -39,6 +39,8 @@ export type RawResponseWithMeta = Readable & {
     rt: number;
     keepAliveSocket: boolean;
     requestUrls: string[];
+    retries: number;
+    socketErrorRetries: number;
 };
 export type HttpClientResponse<T = any> = {
     opaque: unknown;