@wiajs/request 3.0.28 → 3.0.30

package/lib/request.js

@@ -33,14 +33,14 @@ const log = Log({
  * @prop {*} [beforeRedirect]
  * @prop {boolean} [followRedirects]
  * @prop {number} [maxRedirects=21]
- * @prop {number} [maxBodyLength = 0]
+ * @prop {number} [maxBodyLength = -1]
  * @prop {*} [trackRedirects]
  * @prop {*} [data]
  */ /** @typedef {object} ResponseExt
  * @prop {*[]} [redirects]
  * @prop {string} [responseUrl]
  * @prop {number} [responseStartTime]
- */ /** @typedef { http.IncomingMessage & ResponseExt} Response*/ const httpModules = {
+ */ /** @typedef { http.IncomingMessage & ResponseExt} Response */ const httpModules = {
     'http:': http,
     'https:': https
 };
@@ -90,7 +90,7 @@ const writeEvents = [
     'connect',
     'continue',
     'drain',
-    'error',
+    // 'error', // 单独处理，未注册 'error' 事件处理程序，错误将冒泡到全局导致程序崩溃
     'finish',
     'information',
     'pipe',
@@ -105,7 +105,7 @@ for (const ev of writeEvents)writeEventEmit[ev] = /** @param  {...any} args */ f
     const m = this // 事件回调，this === clientRequest 实例
     ;
     // log('req event', {ev})
-    m.redirectReq.emit(ev, ...args) // req 事情映射到 redirectReq 上触发
+    m.redirectReq.emit(ev, ...args) // 内部请求req 事情转发到 Request
     ;
 };
 // stream.Readable，在响应流上转发读流取事件
@@ -131,6 +131,11 @@ const RedirectionError = utils.createErrorType('ERR_FR_REDIRECTION_FAILURE', 'Re
 const TooManyRedirectsError = utils.createErrorType('ERR_FR_TOO_MANY_REDIRECTS', 'Maximum number of redirects exceeded', RedirectionError);
 const MaxBodyLengthExceededError = utils.createErrorType('ERR_FR_MAX_BODY_LENGTH_EXCEEDED', 'Request body larger than maxBodyLength limit');
 const WriteAfterEndError = utils.createErrorType('ERR_STREAM_WRITE_AFTER_END', 'write after end');
+// request err
+const HostNotfoundError = utils.createErrorType('ERR_HOSTNOTFOUND', 'DNS 解析失败，主机名可能无效');
+const ConnRefusedError = utils.createErrorType('ERR_CONNREFUSED', '连接被拒绝，目标服务器可能不可用');
+const ConnTimedoutError = utils.createErrorType('ERR_CONNTIMEDOUT', '请求超时，请检查网络连接或服务器负载');
+const ConnResetError = utils.createErrorType('ERR_CONNRESET', '连接被重置，可能是网络问题或服务器关闭了连接');
 /**
  * An HTTP(S) request that can be redirected
  * wrap http.ClientRequest
@@ -266,7 +271,37 @@ const WriteAfterEndError = utils.createErrorType('ERR_STREAM_WRITE_AFTER_END', '
             req.redirectReq = m;
             // 启动 startTimer
             if (m.startTimer) m._currentRequest.once('socket', m.startTimer);
-            // 接收req事件，转发 到 redirectReq 发射
+            // set tcp keep alive to prevent drop connection by peer
+            req.on('socket', /** @param {*} socket */ (socket)=>{
+                // default interval of sending ack packet is 1 minute
+                socket.setKeepAlive(true, 1000 * 60);
+            });
+            // 请求error单独处理
+            // 'error' 事件处理，避免错误将冒泡到全局导致程序崩溃
+            req.on('error', (err)=>{
+                destroyRequest(req) // 释放资源
+                ;
+                log.error({
+                    errcode: err.code
+                }, 'request');
+                switch(err.code){
+                    case 'ENOTFOUND':
+                        m.emit('error', new HostNotfoundError());
+                        break;
+                    case 'ECONNREFUSED':
+                        m.emit('error', new ConnRefusedError());
+                        break;
+                    case 'ETIMEDOUT':
+                        m.emit('error', new ConnTimedoutError());
+                        break;
+                    case 'ECONNRESET':
+                        m.emit('error', new ConnResetError());
+                        break;
+                    default:
+                        m.emit('error', utils.createErrorType('ERR_CONNOTHER', `网络错误: ${err.message}`));
+                }
+            });
+            // 接收req事件，转发 到 request 上发射，网络关闭事件，触发 error
             for (const ev of writeEvents)req.on(ev, writeEventEmit[ev]);
             // RFC7230§5.3.1: When making a request directly to an origin server, […]
             // a client MUST send only the absolute path […] as the request-target.
@@ -302,9 +337,10 @@ const WriteAfterEndError = utils.createErrorType('ERR_STREAM_WRITE_AFTER_END', '
         }
         return R;
     }
-    abort() {
+    /**
+   * 写入错误，释放请求，触发 abort 终止事件
+   */ abort() {
         destroyRequest(this._currentRequest);
-        this._currentRequest.abort();
         this.emit('abort');
     }
     /**
@@ -359,7 +395,11 @@ const WriteAfterEndError = utils.createErrorType('ERR_STREAM_WRITE_AFTER_END', '
         const m = this;
         // log({data: chunk, encoding, cb}, 'write')
         // Writing is not allowed if end has been called
-        if (m._ending) throw new WriteAfterEndError();
+        if (m._ending) {
+            // throw new WriteAfterEndError()
+            m.emit('error', new WriteAfterEndError());
+            return;
+        }
         // ! 数据写入时连接，pipe 时可设置 header
         if (!m._currentRequest) m.request();
         // Validate input and shift parameters if necessary
@@ -673,13 +713,15 @@ const WriteAfterEndError = utils.createErrorType('ERR_STREAM_WRITE_AFTER_END', '
     /**
    * 处理响应stream
    * 自动解压，透传流，需设置 decompress = false，避免解压数据
-   * @param {*} res
+   * @param {Response} res
+   * @returns {Response | stream.Readable}
    */ processStream(res) {
         const m = this;
         const { opt } = m;
         const streams = [
             res
         ];
+        let responseStream = res;
         // 'transfer-encoding': 'chunked'时，无content-length，axios v1.2 不能自动解压
         const responseLength = +res.headers['content-length'];
         // log('processStream', {
@@ -707,19 +749,23 @@ const WriteAfterEndError = utils.createErrorType('ERR_STREAM_WRITE_AFTER_END', '
                 case 'compress':
                 case 'x-compress':
                     // add the unzipper to the body stream processing pipeline
+                    // @ts-ignore
                     streams.push(zlib.createUnzip(zlibOptions));
                     // remove the content-encoding in order to not confuse downstream operations
                     res.headers['content-encoding'] = undefined;
                     break;
                 case 'deflate':
+                    // @ts-ignore
                     streams.push(new ZlibTransform());
                     // add the unzipper to the body stream processing pipeline
+                    // @ts-ignore
                     streams.push(zlib.createUnzip(zlibOptions));
                     // remove the content-encoding in order to not confuse downstream operations
                     res.headers['content-encoding'] = undefined;
                     break;
                 case 'br':
                     if (isBrotliSupported) {
+                        // @ts-ignore
                         streams.push(zlib.createBrotliDecompress(brotliOptions));
                         res.headers['content-encoding'] = undefined;
                     }
@@ -728,9 +774,12 @@ const WriteAfterEndError = utils.createErrorType('ERR_STREAM_WRITE_AFTER_END', '
             }
         }
         // 响应流，用于读
-        const responseStream = streams.length > 1 ? stream.pipeline(streams, utils.noop) : streams[0];
+        // @ts-ignore
+        responseStream = streams.length > 1 ? stream.pipeline(streams, utils.noop) : streams[0];
         // 将内部 responseStream 可读流 映射到 redirectReq
+        // @ts-ignore
         m.responseStream = responseStream;
+        // @ts-ignore
         responseStream.redirectReq = m // 事情触发时引用
         ;
         // stream 模式，事件透传到 请求类
@@ -880,7 +929,9 @@ const WriteAfterEndError = utils.createErrorType('ERR_STREAM_WRITE_AFTER_END', '
     }
 }
 /**
- *
+ * 释放请求，触发error事件
+ *  'error' event, and emit a 'close' event.
+ * Calling this will cause remaining data in the response to be dropped and the socket to be destroyed.
  * @param {*} request
  * @param {*} error
  */ function destroyRequest(request, error) {
@@ -888,7 +939,8 @@ const WriteAfterEndError = utils.createErrorType('ERR_STREAM_WRITE_AFTER_END', '
         request.removeListener(ev, writeEventEmit[ev]);
     }
     request.on('error', utils.noop);
-    request.destroy(error);
+    request.destroy(error) // 触发 error 事件
+    ;
 }
 /**
  *

package/package.json

@@ -2,7 +2,7 @@
   "name": "@wiajs/request",
   "description": "Stream HTTP request client.",
   "keywords": ["http", "simple", "util", "utility"],
-  "version": "3.0.28",
+  "version": "3.0.30",
   "type": "module",
   "main": "index.js",
   "types": "types/index.d.ts",

package/types/index.d.ts

@@ -1,14 +1,40 @@
 export default request;
-declare function request(uri: any, options: any, callback: any): Request;
+export type Response = import("./request").Response;
+export type Opts = {
+    headers?: {
+        [x: string]: string;
+    };
+    url?: string;
+    protocol?: "http:" | "https:";
+    host?: string;
+    family?: string;
+    path?: string;
+    method?: string;
+    agent?: any;
+    agents?: any;
+    body?: any;
+    data?: any;
+    stream?: boolean;
+    decompress?: boolean;
+    transformStream?: any;
+    beforeRedirect?: any;
+    followRedirects?: boolean;
+    maxRedirects?: number;
+    maxBodyLength?: number;
+    trackRedirects?: any;
+};
+export type Cb = (res: Response, stream?: stream.Readable) => void;
+declare function request(uri: string | Opts, options?: Opts | Cb, callback?: Cb): Request;
 declare namespace request {
-    export let get: Request;
-    export let head: Request;
-    export let options: Request;
-    export let post: Request;
-    export let put: Request;
-    export let patch: Request;
-    export let del: Request;
-    let _delete: Request;
+    export let get: (url: string | Opts, opts?: Opts | Cb, cb?: Cb) => void;
+    export let head: (url: string | Opts, opts?: Opts | Cb, cb?: Cb) => void;
+    export let options: (url: string | Opts, opts?: Opts | Cb, cb?: Cb) => void;
+    export let post: (url: string | Opts, opts?: Opts | Cb, cb?: Cb) => void;
+    export let put: (url: string | Opts, opts?: Opts | Cb, cb?: Cb) => void;
+    export let patch: (url: string | Opts, opts?: Opts | Cb, cb?: Cb) => void;
+    export let del: (url: string | Opts, opts?: Opts | Cb, cb?: Cb) => void;
+    let _delete: (url: string | Opts, opts?: Opts | Cb, cb?: Cb) => void;
     export { _delete as delete };
 }
+import stream from 'node:stream';
 import Request from './request.js';

package/types/request.d.ts

@@ -31,7 +31,8 @@ export default class Request extends stream.Duplex {
     request(): http.ClientRequest;
     abort(): void;
     destroy(error: any): this;
-    override write(chunk: any, encodingOrCallback?: BufferEncoding | ((error: Error | null) => void), cb?: (error: Error | null) => void): boolean;
+    send(): void;
+    override write(chunk: any, encoding?: BufferEncoding | ((error: Error | null) => void), cb?: (error: Error | null) => void): boolean;
     override end(chunk?: any, encoding?: BufferEncoding | (() => void), cb?: () => void): this;
     hasHeader(name: string): boolean;
     getHeader(name: string): string;
@@ -42,7 +43,7 @@ export default class Request extends stream.Duplex {
     sanitizeOptions(options: any): void;
     processResponse(response: Response): void;
     _isRedirect: boolean;
-    processStream(res: any): any;
+    processStream(res: Response): Response | stream.Readable;
     override pipe<T>(dest: T & stream.Writable, opts?: {
         end?: boolean;
     }): T;
@@ -70,6 +71,7 @@ export type Opts = {
     maxRedirects?: number;
     maxBodyLength?: number;
     trackRedirects?: any;
+    data?: any;
 };
 export type ResponseExt = {
     redirects?: any[];

package/types/utils.d.ts

@@ -11,6 +11,7 @@ declare namespace _default {
     export { isObject };
     export { isURL };
     export { isReadStream };
+    export { isStream };
     export { noop };
     export { parseUrl };
     export { spreadUrlObject };
@@ -38,6 +39,7 @@ declare function isFunction(thing: any): boolean;
 declare function isObject(thing: any): boolean;
 declare function isURL(value: any): boolean;
 declare function isReadStream(rs: any): any;
+declare function isStream(val: any): boolean;
 declare function noop(): void;
 declare function parseUrl(input: any): any;
 declare function spreadUrlObject(urlObject: any, target: any): any;