@wiajs/request 3.0.8 → 3.0.16

package/dist/request.cjs

@@ -1,5 +1,5 @@
 /*!
-  * wia request v3.0.8
+  * wia request v3.0.16
   * (c) 2022-2024 Sibyl Yu and contributors
   * Released under the MIT License.
   */
@@ -422,10 +422,36 @@ const brotliOptions = {
 
 const isBrotliSupported = utils.isFunction(zlib.createBrotliDecompress);
 
+// clientRequest 属性转发
+const writeProps = [
+  'protocol',
+  'method',
+  'path',
+  'host',
+  'reusedSocket',
+  'socket',
+  'closed',
+  'destroyed',
+  'writable',
+  'writableAborted',
+  'writableEnded',
+  'writableCorked',
+  'errored',
+  'writableFinished',
+  'writableHighWaterMark',
+  'writableLength',
+  'writableNeedDrain',
+  'writableObjectMode',
+];
+
+// clientReq 方法转发
+const writeMethods = ['cork', 'flushHeaders', 'setNoDelay', 'setSocketKeepAlive'];
+
 // Create handlers that pass events from native requests
+// 在 clientRequest 事件转发
 const writeEvents = [
-  'abort', // 弃用
-  'aborted', // 弃用
+  // 'abort', // 弃用
+  // 'aborted', // 弃用
   'close',
   'connect',
   'continue',
@@ -449,7 +475,7 @@ for (const ev of writeEvents)
     m.redirectReq.emit(ev, ...args); // req 事情映射到 redirectReq 上触发
   };
 
-// stream.Readable
+// stream.Readable，在响应流上转发读流取事件
 // data 单独处理
 const readEvents = ['close', 'end', 'error', 'pause', 'readable', 'resume'];
 const readEventEmit = Object.create(null);
@@ -512,13 +538,15 @@ class Request extends stream.Duplex {
     super();
     const m = this;
 
-    // log({options}, 'constructor');
+    // log({opts}, 'constructor');
 
     // Initialize the request
     m.sanitizeOptions(opts);
     m.opt = opts;
     m.headers = opts.headers;
+
     // log({opts}, 'constructor')
+
     m._ended = false;
     m._ending = false;
     m._redirectCount = 0;
@@ -540,8 +568,31 @@ class Request extends stream.Duplex {
       }
     };
 
-    // 流模式
+    // Proxy all other public ClientRequest methods 'getHeader'
+    for (const method of writeMethods) {
+      // @ts-ignore
+      m[method] = (a, b) => {
+        log$1(method, {a, b});
+        // @ts-ignore
+        m._currentRequest?.[method](a, b);
+      };
+    }
+
+    // Proxy all public ClientRequest properties
+    // 'aborted', 'connection' 弃用
+    for (const property of writeProps) {
+      Object.defineProperty(m, property, {
+        get() {
+          // @ts-ignore
+          const val = m._currentRequest?.[property];
+          log$1('get property', {property});
+          return val
+        },
+      });
+    }
+
     if (opts.stream) {
+      // 流模式
       // 被 pipe 作为目标时触发，拷贝 src headers
       m.on(
         'pipe',
@@ -573,7 +624,7 @@ class Request extends stream.Duplex {
     }
 
     // Perform the first request
-    // m.request(); // 写入数据时执行，否则 pipe时无法写入header
+    // m.request(); // 写入数据时执行，否则 pipe 时无法写入header
   }
 
   /**
@@ -625,25 +676,6 @@ class Request extends stream.Duplex {
       m._currentRequest = req;
       req.redirectReq = m;
 
-      // Proxy all other public ClientRequest methods
-      for (const method of ['flushHeaders', 'setNoDelay', 'setSocketKeepAlive']) {
-        m[method] = (a, b) => {
-          log$1(method, {a, b});
-          m._currentRequest[method](a, b);
-        };
-      }
-
-      // Proxy all public ClientRequest properties
-      for (const property of ['aborted', 'connection', 'socket']) {
-        Object.defineProperty(m, property, {
-          get() {
-            const val = m._currentRequest[property];
-            log$1('get property', {property});
-            return val
-          },
-        });
-      }
-
       // 启动 startTimer
       if (m.startTimer) m._currentRequest.once('socket', m.startTimer);
 
@@ -704,8 +736,8 @@ class Request extends stream.Duplex {
   destroy(error) {
     const m = this;
     if (!m._ended) m.end();
-    else if (m.response) m.response.destroy();
-    else if (m.responseStream) m.responseStream.destroy();
+    if (m.response) m.response.destroy();
+    if (m.responseStream) m.responseStream.destroy();
 
     // m.clearTimeout();
     destroyRequest(m._currentRequest, error);
@@ -724,7 +756,7 @@ class Request extends stream.Duplex {
   write(chunk, encoding, cb) {
     const m = this;
 
-    log$1.debug('write', {data: chunk, encoding, callback: cb});
+    log$1({data: chunk, encoding, callback: cb}, 'write');
 
     // Writing is not allowed if end has been called
     if (m._ending) throw new WriteAfterEndError()
@@ -951,6 +983,7 @@ class Request extends stream.Duplex {
    */
   processResponse(response) {
     const m = this;
+    const {opt} = m;
 
     // Store the redirected response
     const {statusCode} = response;
@@ -972,18 +1005,20 @@ class Request extends stream.Duplex {
     // If the response is not a redirect; return it as-is
     const {location} = response.headers;
 
-    log$1('processResponse', {statusCode, headers: response.headers});
+    log$1({statusCode, headers: response.headers}, 'processResponse');
 
     if (!location || m.opt.followRedirects === false || statusCode < 300 || statusCode >= 400) {
       // 非重定向，返回给原始回调处理
       response.responseUrl = m._currentUrl;
       response.redirects = m._redirects;
-      m.response = response;
+
+      if (opt.stream) m.response = response;
+
       // Be a good stream and emit end when the response is finished.
       // Hack to emit end on close because of a core bug that never fires end
       response.on('close', () => {
         if (!m._respended) {
-          m.response.emit('end');
+          response.emit('end');
         }
       });
 
@@ -1440,9 +1475,8 @@ function request(uri, options, callback) {
   let R = null;
 
   try {
-    log({uri, options}, 'request');
-
     const {opts, cb} = init(uri, options, callback);
+    // log({uri, options, opts}, 'request')
     R = new Request(opts, cb);
   } catch (e) {
     log.err(e, 'request');

package/dist/request.mjs

@@ -1,5 +1,5 @@
 /*!
-  * wia request v3.0.8
+  * wia request v3.0.16
   * (c) 2022-2024 Sibyl Yu and contributors
   * Released under the MIT License.
   */
@@ -419,10 +419,36 @@ const brotliOptions = {
 
 const isBrotliSupported = utils.isFunction(zlib.createBrotliDecompress);
 
+// clientRequest 属性转发
+const writeProps = [
+  'protocol',
+  'method',
+  'path',
+  'host',
+  'reusedSocket',
+  'socket',
+  'closed',
+  'destroyed',
+  'writable',
+  'writableAborted',
+  'writableEnded',
+  'writableCorked',
+  'errored',
+  'writableFinished',
+  'writableHighWaterMark',
+  'writableLength',
+  'writableNeedDrain',
+  'writableObjectMode',
+];
+
+// clientReq 方法转发
+const writeMethods = ['cork', 'flushHeaders', 'setNoDelay', 'setSocketKeepAlive'];
+
 // Create handlers that pass events from native requests
+// 在 clientRequest 事件转发
 const writeEvents = [
-  'abort', // 弃用
-  'aborted', // 弃用
+  // 'abort', // 弃用
+  // 'aborted', // 弃用
   'close',
   'connect',
   'continue',
@@ -446,7 +472,7 @@ for (const ev of writeEvents)
     m.redirectReq.emit(ev, ...args); // req 事情映射到 redirectReq 上触发
   };
 
-// stream.Readable
+// stream.Readable，在响应流上转发读流取事件
 // data 单独处理
 const readEvents = ['close', 'end', 'error', 'pause', 'readable', 'resume'];
 const readEventEmit = Object.create(null);
@@ -509,13 +535,15 @@ class Request extends Duplex {
     super();
     const m = this;
 
-    // log({options}, 'constructor');
+    // log({opts}, 'constructor');
 
     // Initialize the request
     m.sanitizeOptions(opts);
     m.opt = opts;
     m.headers = opts.headers;
+
     // log({opts}, 'constructor')
+
     m._ended = false;
     m._ending = false;
     m._redirectCount = 0;
@@ -537,8 +565,31 @@ class Request extends Duplex {
       }
     };
 
-    // 流模式
+    // Proxy all other public ClientRequest methods 'getHeader'
+    for (const method of writeMethods) {
+      // @ts-ignore
+      m[method] = (a, b) => {
+        log$1(method, {a, b});
+        // @ts-ignore
+        m._currentRequest?.[method](a, b);
+      };
+    }
+
+    // Proxy all public ClientRequest properties
+    // 'aborted', 'connection' 弃用
+    for (const property of writeProps) {
+      Object.defineProperty(m, property, {
+        get() {
+          // @ts-ignore
+          const val = m._currentRequest?.[property];
+          log$1('get property', {property});
+          return val
+        },
+      });
+    }
+
     if (opts.stream) {
+      // 流模式
       // 被 pipe 作为目标时触发，拷贝 src headers
       m.on(
         'pipe',
@@ -570,7 +621,7 @@ class Request extends Duplex {
     }
 
     // Perform the first request
-    // m.request(); // 写入数据时执行，否则 pipe时无法写入header
+    // m.request(); // 写入数据时执行，否则 pipe 时无法写入header
   }
 
   /**
@@ -622,25 +673,6 @@ class Request extends Duplex {
       m._currentRequest = req;
       req.redirectReq = m;
 
-      // Proxy all other public ClientRequest methods
-      for (const method of ['flushHeaders', 'setNoDelay', 'setSocketKeepAlive']) {
-        m[method] = (a, b) => {
-          log$1(method, {a, b});
-          m._currentRequest[method](a, b);
-        };
-      }
-
-      // Proxy all public ClientRequest properties
-      for (const property of ['aborted', 'connection', 'socket']) {
-        Object.defineProperty(m, property, {
-          get() {
-            const val = m._currentRequest[property];
-            log$1('get property', {property});
-            return val
-          },
-        });
-      }
-
       // 启动 startTimer
       if (m.startTimer) m._currentRequest.once('socket', m.startTimer);
 
@@ -701,8 +733,8 @@ class Request extends Duplex {
   destroy(error) {
     const m = this;
     if (!m._ended) m.end();
-    else if (m.response) m.response.destroy();
-    else if (m.responseStream) m.responseStream.destroy();
+    if (m.response) m.response.destroy();
+    if (m.responseStream) m.responseStream.destroy();
 
     // m.clearTimeout();
     destroyRequest(m._currentRequest, error);
@@ -721,7 +753,7 @@ class Request extends Duplex {
   write(chunk, encoding, cb) {
     const m = this;
 
-    log$1.debug('write', {data: chunk, encoding, callback: cb});
+    log$1({data: chunk, encoding, callback: cb}, 'write');
 
     // Writing is not allowed if end has been called
     if (m._ending) throw new WriteAfterEndError()
@@ -948,6 +980,7 @@ class Request extends Duplex {
    */
   processResponse(response) {
     const m = this;
+    const {opt} = m;
 
     // Store the redirected response
     const {statusCode} = response;
@@ -969,18 +1002,20 @@ class Request extends Duplex {
     // If the response is not a redirect; return it as-is
     const {location} = response.headers;
 
-    log$1('processResponse', {statusCode, headers: response.headers});
+    log$1({statusCode, headers: response.headers}, 'processResponse');
 
     if (!location || m.opt.followRedirects === false || statusCode < 300 || statusCode >= 400) {
       // 非重定向，返回给原始回调处理
       response.responseUrl = m._currentUrl;
       response.redirects = m._redirects;
-      m.response = response;
+
+      if (opt.stream) m.response = response;
+
       // Be a good stream and emit end when the response is finished.
       // Hack to emit end on close because of a core bug that never fires end
       response.on('close', () => {
         if (!m._respended) {
-          m.response.emit('end');
+          response.emit('end');
         }
       });
 
@@ -1437,9 +1472,8 @@ function request(uri, options, callback) {
   let R = null;
 
   try {
-    log({uri, options}, 'request');
-
     const {opts, cb} = init(uri, options, callback);
+    // log({uri, options, opts}, 'request')
     R = new Request(opts, cb);
   } catch (e) {
     log.err(e, 'request');

package/package.json

@@ -2,7 +2,7 @@
   "name": "@wiajs/request",
   "description": "Stream HTTP request client.",
   "keywords": ["http", "simple", "util", "utility"],
-  "version": "3.0.8",
+  "version": "3.0.16",
   "type": "module",
   "main": "index.js",
   "exports": {