@wiajs/request 3.0.2 → 3.0.5

package/index.js

@@ -1 +1 @@
-export {default} from './lib'
+export {default} from './lib/index.js'

package/lib/index.js

@@ -6,14 +6,15 @@
 import Request from './request.js';
 import utils from './utils.js';
 const log = Log({
-    env: `wia:req:${name(__filename)}`
-});
+    env: `wia:req:${name(import.meta.url)}`
+}) // __filename
+;
 (function detectUnsupportedEnvironment() {
     const looksLikeNode = typeof process !== 'undefined';
     const looksLikeBrowser = typeof window !== 'undefined' && typeof document !== 'undefined';
     const looksLikeV8 = utils.isFunction(Error.captureStackTrace);
     if (!looksLikeNode && (looksLikeBrowser || !looksLikeV8)) {
-        log.warn('The follow-redirects package should be excluded from browser builds.');
+        console.warn('The follow-redirects package should be excluded from browser builds.');
     }
 })();
 /**
@@ -27,6 +28,7 @@ const log = Log({
  * @param {*} callback
  * @returns
  */ function init(uri, options, callback) {
+    let R;
     try {
         // Parse parameters, ensuring that input is an object
         if (utils.isURL(uri)) uri = utils.spreadUrlObject(uri);
@@ -50,6 +52,7 @@ const log = Log({
             opts: options,
             cb: callback
         };
+    // log({R}, 'init')
     } catch (e) {
         log.err(e, 'init');
     }
@@ -66,15 +69,14 @@ const log = Log({
  * @param {*} callback/null
  * @returns
  */ function request(uri, options, callback) {
-    let R1 = null;
+    let R = null;
     try {
         const { opts, cb } = init(uri, options, callback);
-        // log.debug('request', {options})
-        R1 = new Request(opts, cb);
+        R = new Request(opts, cb);
     } catch (e) {
         log.err(e, 'request');
     }
-    return R1;
+    return R;
 }
 /**
  * 执行简单的非stream数据请求
@@ -84,6 +86,7 @@ const log = Log({
  * @returns {Request} Duplex 流
  */ function fn(verb) {
     const method = verb.toUpperCase();
+    // @ts-ignore
     return (uri, options, callback)=>{
         const { opts, cb } = init(uri, options, callback);
         opts.method = method;

package/lib/request.js

@@ -14,8 +14,9 @@ import ZlibTransform from './ZlibTransform.js';
 import utils from './utils.js';
 import Caseless from './caseless.js';
 const log = Log({
-    env: `wia:req:${name(__filename)}`
-});
+    env: `wia:req:${name(import.meta.url)}`
+}) // __filename
+;
 const httpModules = {
     'http:': http,
     'https:': https
@@ -51,7 +52,7 @@ const writeEventEmit = Object.create(null);
 for (const ev of writeEvents)writeEventEmit[ev] = function(...args) {
     const m = this // 事件回调，this === clientRequest 实例
     ;
-    log.debug('req event', {
+    log('req event', {
         ev
     });
     m.redirectReq.emit(ev, ...args) // req 事情映射到 redirectReq 上触发
@@ -71,7 +72,7 @@ const readEventEmit = Object.create(null);
 for (const ev of readEvents)readEventEmit[ev] = function(...args) {
     const m = this // 事件回调，this === clientRequest 实例
     ;
-    log.debug('res event', {
+    log('res event', {
         ev
     });
     m.redirectReq.emit(ev, ...args) // 向上触发事件
@@ -88,18 +89,19 @@ const WriteAfterEndError = utils.createErrorType('ERR_STREAM_WRITE_AFTER_END', '
  */ export default class Request extends Duplex {
     /**
    * responseCallback 原消息处理回调
-   * @param {*} options
+   * @param {*} opts
    * @param {*} resCallback
-   */ constructor(options, resCallback){
+   */ 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
         ;
         const m = this;
         // log({options}, 'constructor');
         // Initialize the request
-        m._sanitizeOptions(options);
-        m._options = options;
-        m.headers = options.headers;
+        m.sanitizeOptions(opts);
+        m.opt = opts;
+        m.headers = opts.headers;
+        // log({opts}, 'constructor')
         m._ended = false;
         m._ending = false;
         m._redirectCount = 0;
@@ -110,9 +112,9 @@ const WriteAfterEndError = utils.createErrorType('ERR_STREAM_WRITE_AFTER_END', '
         m.resCallback = resCallback;
         // React to responses of native requests
         // 接管 response 事件，非重定向，触发 response 事件
-        m._onResponse = (response)=>{
+        m._onResponse = (res)=>{
             try {
-                m.processResponse(response);
+                m.processResponse(res);
             } catch (cause) {
                 m.emit('error', cause instanceof RedirectionError ? cause : new RedirectionError({
                     cause: cause
@@ -150,30 +152,30 @@ const WriteAfterEndError = utils.createErrorType('ERR_STREAM_WRITE_AFTER_END', '
             });
         }
         // 流模式
-        if (options.stream) // 被 pipe 作为目标时触发，拷贝 src headers
-        m.on('pipe', /** @type {stream.Readable} */ (src)=>{
-            // m.ntick &&
-            if (m._currentRequest) {
-                m.emit('error', new Error('You cannot pipe to this stream after the outbound request has started.'));
-            }
-            m.pipesrc = src;
-            if (utils.isReadStream(src)) {
-                if (!m.hasHeader('content-type')) {
-                    m.setHeader('content-type', mime.lookup(src.path));
+        if (opts.stream) {
+            // 被 pipe 作为目标时触发，拷贝 src headers
+            m.on('pipe', /** @type {stream.Readable} */ (src)=>{
+                // m.ntick &&
+                if (m._currentRequest) {
+                    m.emit('error', new Error('You cannot pipe to this stream after the outbound request has started.'));
                 }
-            } else {
-                if (src.headers) {
-                    for (const h of src.headers){
-                        if (!m.hasHeader(h)) {
-                            m.setHeader(h, src.headers[h]);
+                m.pipesrc = src;
+                if (utils.isReadStream(src)) {
+                    if (!m.hasHeader('content-type')) {
+                        m.setHeader('content-type', mime.lookup(src.path));
+                    }
+                } else {
+                    if (src.headers) {
+                        for (const h of src.headers){
+                            if (!m.hasHeader(h)) {
+                                m.setHeader(h, src.headers[h]);
+                            }
                         }
                     }
+                    if (src.opt.method && !m.opt.method) m.opt.method = src.opt.method;
                 }
-            // if (src.method && !self.explicitMethod) {
-            //   m.method = src.method
-            // }
-            }
-        });
+            });
+        }
     // Perform the first request
     // m.request(); // 写入数据时执行，否则 pipe时无法写入header
     }
@@ -182,9 +184,10 @@ const WriteAfterEndError = utils.createErrorType('ERR_STREAM_WRITE_AFTER_END', '
    * @returns http(s) 实例
    */ request() {
         let R = null;
+        const m = this;
+        const { opt } = m;
         try {
-            const m = this;
-            // read stream
+            // reset read stream
             m.response = null;
             m.responseStarted = false;
             m.responseStream = null;
@@ -195,29 +198,28 @@ const WriteAfterEndError = utils.createErrorType('ERR_STREAM_WRITE_AFTER_END', '
             m._respended = false;
             // m.httpModule = httpModules[protocol];
             // Load the native protocol
-            let { protocol } = m._options;
-            const { agents } = m._options;
+            let { protocol } = opt;
+            const { agents } = opt;
             // 代理以目的网址协议为准
             // If specified, use the agent corresponding to the protocol
             // (HTTP and HTTPS use different types of agents)
             if (agents) {
                 const scheme = protocol.slice(0, -1);
-                m._options.agent = agents[scheme];
-            }
-            // http 非隧道代理模式，模块以代理主机为准，其他以目的网址为准
-            // 代理内部会根据代理协议选择 http(s) 发起请求创建连接
-            if (protocol === 'http:' && agents.http) {
-                protocol = agents.http.proxy && !agents.http.tunnel ? agents.http.proxy.protocol : protocol;
+                opt.agent = agents[scheme];
+                // http 非隧道代理模式，模块以代理主机为准，其他以目的网址为准
+                // 代理内部会根据代理协议选择 http(s) 发起请求创建连接
+                if (protocol === 'http:' && agents.http) {
+                    protocol = agents.http.proxy && !agents.http.tunnel ? agents.http.proxy.protocol : protocol;
+                }
             }
             const httpModule = httpModules[protocol];
             if (!httpModule) throw TypeError(`Unsupported protocol: ${protocol}`);
-            log.debug('request', {
-                options: m._options,
+            log({
+                opt,
                 protocol
-            });
-            debugger;
+            }, 'request');
             // Create the native request and set up its event handlers
-            const req = httpModule.request(m._options, m._onResponse);
+            const req = httpModule.request(opt, m._onResponse);
             m._currentRequest = req;
             req.redirectReq = m;
             // 接收req事件，转发 到 redirectReq 发射
@@ -226,7 +228,7 @@ const WriteAfterEndError = utils.createErrorType('ERR_STREAM_WRITE_AFTER_END', '
             // a client MUST send only the absolute path […] as the request-target.
             // When making a request to a proxy, […]
             // a client MUST send the target URI in absolute-form […].
-            m._currentUrl = /^\//.test(m._options.path) ? url.format(m._options) : m._options.path;
+            m._currentUrl = /^\//.test(opt.path) ? url.format(opt) : opt.path;
             // End a redirected request
             // (The first request must be ended explicitly with RedirectableRequest#end)
             if (m._isRedirect) {
@@ -302,7 +304,7 @@ const WriteAfterEndError = utils.createErrorType('ERR_STREAM_WRITE_AFTER_END', '
             return;
         }
         // Only write when we don't exceed the maximum body length
-        if (m._requestBodyLength + chunk.length <= m._options.maxBodyLength) {
+        if (m._requestBodyLength + chunk.length <= m.opt.maxBodyLength) {
             m._requestBodyLength += chunk.length;
             m._requestBodyBuffers.push({
                 data: chunk,
@@ -351,27 +353,27 @@ const WriteAfterEndError = utils.createErrorType('ERR_STREAM_WRITE_AFTER_END', '
    * @param {string} name
    * @returns
    */ hasHeader(name) {
-        return this._options.headers.includes(name);
+        return this.opt.headers.includes(name);
     }
     /**
    *
    * @param {string} name
    * @returns {string}
    */ getHeader(name) {
-        return this._options.headers[name];
+        return this.opt.headers[name];
     }
     /**
    * Sets a header value on the current native request
    * @param {string} name
    */ setHeader(name, value) {
-        this._options.headers[name] = value;
+        this.opt.headers[name] = value;
         this._currentRequest?.setHeader(name, value);
     }
     /**
    * Clears a header value on the current native request
    * @param {string} name
    */ removeHeader(name) {
-        delete this._options.headers[name];
+        delete this.opt.headers[name];
         this._currentRequest?.removeHeader(name);
     }
     /**
@@ -443,7 +445,7 @@ const WriteAfterEndError = utils.createErrorType('ERR_STREAM_WRITE_AFTER_END', '
         m.on('close', clearTimer);
         return m;
     }
-    _sanitizeOptions(options) {
+    sanitizeOptions(options) {
         // Ensure headers are always present
         if (!options.headers) options.headers = {};
         // Since http.request treats host as an alias of hostname,
@@ -475,7 +477,7 @@ const WriteAfterEndError = utils.createErrorType('ERR_STREAM_WRITE_AFTER_END', '
         const m = this;
         // Store the redirected response
         const { statusCode } = response;
-        if (m._options.trackRedirects) {
+        if (m.opt.trackRedirects) {
             m._redirects.push({
                 url: m._currentUrl,
                 headers: response.headers,
@@ -494,7 +496,7 @@ const WriteAfterEndError = utils.createErrorType('ERR_STREAM_WRITE_AFTER_END', '
             statusCode,
             headers: response.headers
         });
-        if (!location || m._options.followRedirects === false || statusCode < 300 || statusCode >= 400) {
+        if (!location || m.opt.followRedirects === false || statusCode < 300 || statusCode >= 400) {
             // 非重定向，返回给原始回调处理
             response.responseUrl = m._currentUrl;
             response.redirects = m._redirects;
@@ -526,34 +528,34 @@ const WriteAfterEndError = utils.createErrorType('ERR_STREAM_WRITE_AFTER_END', '
         response.destroy();
         // RFC7231§6.4: A client SHOULD detect and intervene
         // in cyclical redirections (i.e., "infinite" redirection loops).
-        if (++m._redirectCount > m._options.maxRedirects) throw new TooManyRedirectsError();
+        if (++m._redirectCount > m.opt.maxRedirects) throw new TooManyRedirectsError();
         // Store the request headers if applicable
         let requestHeaders;
-        const { beforeRedirect } = m._options;
+        const { beforeRedirect } = m.opt;
         if (beforeRedirect) {
             requestHeaders = {
                 // The Host header was set by nativeProtocol.request
                 Host: response.req.getHeader('host'),
-                ...m._options.headers
+                ...m.opt.headers
             };
         }
         // RFC7231§6.4: Automatic redirection needs to done with
         // care for methods not known to be safe, […]
         // RFC7231§6.4.2–3: For historical reasons, a user agent MAY change
         // the request method from POST to GET for the subsequent request.
-        const { method } = m._options;
-        if ((statusCode === 301 || statusCode === 302) && m._options.method === 'POST' || // RFC7231§6.4.4: The 303 (See Other) status code indicates that
+        const { method } = m.opt;
+        if ((statusCode === 301 || statusCode === 302) && m.opt.method === 'POST' || // RFC7231§6.4.4: The 303 (See Other) status code indicates that
         // the server is redirecting the user agent to a different resource […]
         // A user agent can perform a retrieval request targeting that URI
         // (a GET or HEAD request if using HTTP) […]
-        statusCode === 303 && !/^(?:GET|HEAD)$/.test(m._options.method)) {
-            m._options.method = 'GET';
+        statusCode === 303 && !/^(?:GET|HEAD)$/.test(m.opt.method)) {
+            m.opt.method = 'GET';
             // Drop a possible entity and headers related to it
             m._requestBodyBuffers = [];
-            removeMatchingHeaders(/^content-/i, m._options.headers);
+            removeMatchingHeaders(/^content-/i, m.opt.headers);
         }
         // Drop the Host header, as the redirect might lead to a different host
-        const currentHostHeader = removeMatchingHeaders(/^host$/i, m._options.headers);
+        const currentHostHeader = removeMatchingHeaders(/^host$/i, m.opt.headers);
         // If the redirect is relative, carry over the host of the last request
         const currentUrlParts = utils.parseUrl(m._currentUrl);
         const currentHost = currentHostHeader || currentUrlParts.host;
@@ -567,11 +569,11 @@ const WriteAfterEndError = utils.createErrorType('ERR_STREAM_WRITE_AFTER_END', '
         }, 'redirecting to');
         m._isRedirect = true;
         // 覆盖原 url 解析部分，包括 protocol、hostname、port等
-        utils.spreadUrlObject(redirectUrl, m._options);
+        utils.spreadUrlObject(redirectUrl, m.opt);
         // Drop confidential headers when redirecting to a less secure protocol
         // or to a different domain that is not a superdomain
         if (redirectUrl.protocol !== currentUrlParts.protocol && redirectUrl.protocol !== 'https:' || redirectUrl.host !== currentHost && !isSubdomain(redirectUrl.host, currentHost)) {
-            removeMatchingHeaders(/^(?:(?:proxy-)?authorization|cookie)$/i, this._options.headers);
+            removeMatchingHeaders(/^(?:(?:proxy-)?authorization|cookie)$/i, this.opt.headers);
         }
         // Evaluate the beforeRedirect callback
         if (utils.isFunction(beforeRedirect)) {
@@ -584,8 +586,8 @@ const WriteAfterEndError = utils.createErrorType('ERR_STREAM_WRITE_AFTER_END', '
                 method,
                 headers: requestHeaders
             };
-            beforeRedirect(m._options, responseDetails, requestDetails);
-            m._sanitizeOptions(m._options);
+            beforeRedirect(m.opt, responseDetails, requestDetails);
+            m.sanitizeOptions(m.opt);
         }
         // Perform the redirected request
         m.request() // 重新执行请求
@@ -597,7 +599,7 @@ const WriteAfterEndError = utils.createErrorType('ERR_STREAM_WRITE_AFTER_END', '
    * @param {*} res
    */ processStream(res) {
         const m = this;
-        const { _options: opts } = m;
+        const { opt: opts } = m;
         const streams = [
             res
         ];
@@ -746,7 +748,7 @@ const WriteAfterEndError = utils.createErrorType('ERR_STREAM_WRITE_AFTER_END', '
    * @param {*} dest
    */ pipeDest(dest) {
         const m = this;
-        const { response, _options } = m;
+        const { response } = m;
         // Called after the response is received
         if (response?.headers && dest.headers && !dest.headersSent) {
             const caseless = new Caseless(response.headers);
@@ -773,9 +775,9 @@ const WriteAfterEndError = utils.createErrorType('ERR_STREAM_WRITE_AFTER_END', '
             }
             dest.statusCode = response.statusCode;
         }
-    // if (m.pipefilter) {
-    //   m.pipefilter(response, dest)
-    // }
+        if (m.pipefilter) {
+            m.pipefilter(response, dest);
+        }
     }
     /**
    * 暂停read流

package/package.json

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