@wiajs/request 3.0.6 → 3.0.8

package/README.md

@@ -1,11 +1,23 @@
-# Deprecated!
+# Rebirth!
 
-As of Feb 11th 2020, request is fully deprecated. No new changes are expected to land. In fact, none have landed for some time.
+The `request` library is undoubtedly one of the most influential libraries in Node.js. It was first released in 2011 as one of the earliest libraries in Node.js and npm, and it reached 25.7k stars on GitHub by 2019. Unfortunately, the author announced its deprecation in 2019. The reason was not due to any functional issues; in fact, its stream functionality is still among the best. Neither of its successors, Axios nor Got, comes close to request in this regard. The author believed the code was outdated and didn’t have the energy to rewrite the entire library using ES6.
+
+`@wiajs/request` has forked `request` and rewritten the entire library using `ES6` and the latest Node.js `http`, `https`, and `stream.Duplex`. The focus was to retain its powerful stream capabilities.
+
+How does it compare to the currently most popular library, `Axios`?
+
+`Axios` lacks stream functionality, and the goal of rewriting request was precisely to fork `Axios` and replace Axios's transport layer to make up for this shortcoming.
+
+- `@wiajs/request` (forked from `request`) provides powerful stream capabilities.
+- `@wiajs/req` (forked from `axios`) provides powerful data handling capabilities.
+- `@wiajs/request`, as the default transport for `@wiajs/req`, provides both powerful data handling and stream capabilities, as well as perfect proxy support.
+- `@wiajs/request` is the rebirth version of request.
+- `@wiajs/req` is a better version of axios.
 
 For more information about why request is deprecated and possible alternatives refer to
 [this issue](https://github.com/request/request/issues/3142).
 
-# Request - Simplified HTTP client
+# @wiajs/Request - Simplified HTTP client
 
 [![npm package](https://nodei.co/npm/request.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/request/)
 

package/dist/request.cjs

@@ -1,5 +1,5 @@
 /*!
-  * wia request v3.0.5
+  * wia request v3.0.8
   * (c) 2022-2024 Sibyl Yu and contributors
   * Released under the MIT License.
   */
@@ -500,6 +500,8 @@ class Request extends stream.Duplex {
   pipesrc = null // 被 pipe 时的 src stream
   /** @type {stream.Writable[]} */
   pipedests = [] // pipe dest
+  /** @type {*} */
+  startTimer = null
 
   /**
    * responseCallback 原消息处理回调
@@ -538,25 +540,6 @@ class Request extends stream.Duplex {
       }
     };
 
-    // Proxy all other public ClientRequest methods
-    for (const method of ['flushHeaders', 'setNoDelay', 'setSocketKeepAlive']) {
-      m[method] = (a, b) => {
-        log$1.debug(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.debug('get property', {property});
-          return val
-        },
-      });
-    }
-
     // 流模式
     if (opts.stream) {
       // 被 pipe 作为目标时触发，拷贝 src headers
@@ -640,8 +623,30 @@ class Request extends stream.Duplex {
       // Create the native request and set up its event handlers
       const req = httpModule.request(opt, m._onResponse);
       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);
+
       // 接收req事件，转发 到 redirectReq 发射
       for (const ev of writeEvents) req.on(ev, writeEventEmit[ev]);
 
@@ -838,9 +843,8 @@ class Request extends stream.Duplex {
     return this._currentRequest?.headersSent
   }
 
-  // Global timeout for all underlying requests
   /**
-   *
+   * Global timeout for all underlying requests
    * @param {*} msecs
    * @param {*} callback
    * @returns
@@ -848,9 +852,8 @@ class Request extends stream.Duplex {
   setTimeout(msecs, callback) {
     const m = this;
 
-    // Destroys the socket on timeout
     /**
-     *
+     * Destroys the socket on timeout
      * @param {*} socket
      */
     function destroyOnTimeout(socket) {
@@ -859,19 +862,20 @@ class Request extends stream.Duplex {
       socket.addListener('timeout', socket.destroy);
     }
 
-    // Sets up a timer to trigger a timeout event
     /**
-     *
+     * Sets up a timer to trigger a timeout event
      * @param {*} socket
      */
     function startTimer(socket) {
-      if (m._timeout) {
-        clearTimeout(m._timeout);
-      }
+      if (m.startTimer) m.startTimer = null;
+
+      if (m._timeout) clearTimeout(m._timeout);
+
       m._timeout = setTimeout(() => {
         m.emit('timeout');
         clearTimer();
       }, msecs);
+
       destroyOnTimeout(socket);
     }
 
@@ -902,7 +906,7 @@ class Request extends stream.Duplex {
 
     // Start the timer if or when the socket is opened
     if (m.socket) startTimer(m.socket);
-    else m._currentRequest.once('socket', startTimer);
+    else m.startTimer = startTimer; // 未连接，先登记，连接后启动
 
     // Clean up on events
     m.on('socket', destroyOnTimeout);
@@ -1436,6 +1440,8 @@ function request(uri, options, callback) {
   let R = null;
 
   try {
+    log({uri, options}, 'request');
+
     const {opts, cb} = init(uri, options, callback);
     R = new Request(opts, cb);
   } catch (e) {

package/dist/request.mjs

@@ -1,5 +1,5 @@
 /*!
-  * wia request v3.0.5
+  * wia request v3.0.8
   * (c) 2022-2024 Sibyl Yu and contributors
   * Released under the MIT License.
   */
@@ -497,6 +497,8 @@ class Request extends Duplex {
   pipesrc = null // 被 pipe 时的 src stream
   /** @type {stream.Writable[]} */
   pipedests = [] // pipe dest
+  /** @type {*} */
+  startTimer = null
 
   /**
    * responseCallback 原消息处理回调
@@ -535,25 +537,6 @@ class Request extends Duplex {
       }
     };
 
-    // Proxy all other public ClientRequest methods
-    for (const method of ['flushHeaders', 'setNoDelay', 'setSocketKeepAlive']) {
-      m[method] = (a, b) => {
-        log$1.debug(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.debug('get property', {property});
-          return val
-        },
-      });
-    }
-
     // 流模式
     if (opts.stream) {
       // 被 pipe 作为目标时触发，拷贝 src headers
@@ -637,8 +620,30 @@ class Request extends Duplex {
       // Create the native request and set up its event handlers
       const req = httpModule.request(opt, m._onResponse);
       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);
+
       // 接收req事件，转发 到 redirectReq 发射
       for (const ev of writeEvents) req.on(ev, writeEventEmit[ev]);
 
@@ -835,9 +840,8 @@ class Request extends Duplex {
     return this._currentRequest?.headersSent
   }
 
-  // Global timeout for all underlying requests
   /**
-   *
+   * Global timeout for all underlying requests
    * @param {*} msecs
    * @param {*} callback
    * @returns
@@ -845,9 +849,8 @@ class Request extends Duplex {
   setTimeout(msecs, callback) {
     const m = this;
 
-    // Destroys the socket on timeout
     /**
-     *
+     * Destroys the socket on timeout
      * @param {*} socket
      */
     function destroyOnTimeout(socket) {
@@ -856,19 +859,20 @@ class Request extends Duplex {
       socket.addListener('timeout', socket.destroy);
     }
 
-    // Sets up a timer to trigger a timeout event
     /**
-     *
+     * Sets up a timer to trigger a timeout event
      * @param {*} socket
      */
     function startTimer(socket) {
-      if (m._timeout) {
-        clearTimeout(m._timeout);
-      }
+      if (m.startTimer) m.startTimer = null;
+
+      if (m._timeout) clearTimeout(m._timeout);
+
       m._timeout = setTimeout(() => {
         m.emit('timeout');
         clearTimer();
       }, msecs);
+
       destroyOnTimeout(socket);
     }
 
@@ -899,7 +903,7 @@ class Request extends Duplex {
 
     // Start the timer if or when the socket is opened
     if (m.socket) startTimer(m.socket);
-    else m._currentRequest.once('socket', startTimer);
+    else m.startTimer = startTimer; // 未连接，先登记，连接后启动
 
     // Clean up on events
     m.on('socket', destroyOnTimeout);
@@ -1433,6 +1437,8 @@ function request(uri, options, callback) {
   let R = null;
 
   try {
+    log({uri, options}, 'request');
+
     const {opts, cb} = init(uri, options, callback);
     R = new Request(opts, cb);
   } catch (e) {

package/lib/index.js

@@ -71,6 +71,10 @@ const log = Log({
  */ function request(uri, options, callback) {
     let R = null;
     try {
+        log({
+            uri,
+            options
+        }, 'request');
         const { opts, cb } = init(uri, options, callback);
         R = new Request(opts, cb);
     } catch (e) {

package/lib/request.js

@@ -94,7 +94,7 @@ const WriteAfterEndError = utils.createErrorType('ERR_STREAM_WRITE_AFTER_END', '
    */ constructor(opts, resCallback){
         super(), this._timeout = 0, /** @type {*} */ this.socket = null, /** @type {http.ClientRequest} */ this._currentRequest = null, /** @type {stream.Readable} */ this.response = null, /** @type {stream.Readable} */ this.responseStream = null, this.timing = false, this.responseStarted = false, this.responseStartTime = 0, this._destdata = false, this._paused = false, this._respended = false, /** @type {stream.Readable} */ this.pipesrc = null // 被 pipe 时的 src stream
         , /** @type {stream.Writable[]} */ this.pipedests = [] // pipe dest
-        ;
+        , /** @type {*} */ this.startTimer = null;
         const m = this;
         // log({options}, 'constructor');
         // Initialize the request
@@ -121,36 +121,6 @@ const WriteAfterEndError = utils.createErrorType('ERR_STREAM_WRITE_AFTER_END', '
                 }));
             }
         };
-        // Proxy all other public ClientRequest methods
-        for (const method of [
-            'flushHeaders',
-            'setNoDelay',
-            'setSocketKeepAlive'
-        ]){
-            m[method] = (a, b)=>{
-                log.debug(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.debug('get property', {
-                        property
-                    });
-                    return val;
-                }
-            });
-        }
         // 流模式
         if (opts.stream) {
             // 被 pipe 作为目标时触发，拷贝 src headers
@@ -222,6 +192,38 @@ const WriteAfterEndError = utils.createErrorType('ERR_STREAM_WRITE_AFTER_END', '
             const req = httpModule.request(opt, m._onResponse);
             m._currentRequest = req;
             req.redirectReq = m;
+            // Proxy all other public ClientRequest methods
+            for (const method of [
+                'flushHeaders',
+                'setNoDelay',
+                'setSocketKeepAlive'
+            ]){
+                m[method] = (a, b)=>{
+                    log(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('get property', {
+                            property
+                        });
+                        return val;
+                    }
+                });
+            }
+            // 启动 startTimer
+            if (m.startTimer) m._currentRequest.once('socket', m.startTimer);
             // 接收req事件，转发 到 redirectReq 发射
             for (const ev of writeEvents)req.on(ev, writeEventEmit[ev]);
             // RFC7230§5.3.1: When making a request directly to an origin server, […]
@@ -382,31 +384,27 @@ const WriteAfterEndError = utils.createErrorType('ERR_STREAM_WRITE_AFTER_END', '
    */ get headersSent() {
         return this._currentRequest?.headersSent;
     }
-    // Global timeout for all underlying requests
     /**
-   *
+   * Global timeout for all underlying requests
    * @param {*} msecs
    * @param {*} callback
    * @returns
    */ setTimeout(msecs, callback) {
         const m = this;
-        // Destroys the socket on timeout
         /**
-     *
+     * Destroys the socket on timeout
      * @param {*} socket
      */ function destroyOnTimeout(socket) {
             socket.setTimeout(msecs);
             socket.removeListener('timeout', socket.destroy);
             socket.addListener('timeout', socket.destroy);
         }
-        // Sets up a timer to trigger a timeout event
         /**
-     *
+     * Sets up a timer to trigger a timeout event
      * @param {*} socket
      */ function startTimer(socket) {
-            if (m._timeout) {
-                clearTimeout(m._timeout);
-            }
+            if (m.startTimer) m.startTimer = null;
+            if (m._timeout) clearTimeout(m._timeout);
             m._timeout = setTimeout(()=>{
                 m.emit('timeout');
                 clearTimer();
@@ -436,7 +434,8 @@ const WriteAfterEndError = utils.createErrorType('ERR_STREAM_WRITE_AFTER_END', '
         if (callback) m.on('timeout', callback);
         // Start the timer if or when the socket is opened
         if (m.socket) startTimer(m.socket);
-        else m._currentRequest.once('socket', startTimer);
+        else m.startTimer = startTimer // 未连接，先登记，连接后启动
+        ;
         // Clean up on events
         m.on('socket', destroyOnTimeout);
         m.on('abort', clearTimer);

package/package.json

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