@naturalcycles/js-lib 14.124.1 → 14.126.0

package/dist/http/fetcher.d.ts

@@ -43,6 +43,16 @@ export interface FetcherCfg {
     logRequestBody?: boolean;
     logResponse?: boolean;
     logResponseBody?: boolean;
+    /**
+     * Default to true.
+     * Set to false to exclude `prefixUrl` from logs (both success and error)
+     */
+    logWithPrefixUrl?: boolean;
+    /**
+     * Default to true.
+     * Set to false to strip searchParams from url when logging (both success and error)
+     */
+    logWithSearchParams?: boolean;
     /**
      * Defaults to `console`.
      */
@@ -89,6 +99,10 @@ export interface FetcherOptions {
      */
     body?: Blob | BufferSource | FormData | URLSearchParams | string;
     credentials?: RequestCredentials;
+    /**
+     * Default to true.
+     */
+    followRedirects?: boolean;
     headers?: Record<string, any>;
     mode?: FetcherMode;
     searchParams?: Record<string, any>;
@@ -166,6 +180,10 @@ export declare class Fetcher {
     deleteVoid: (url: string, opt?: FetcherOptions) => Promise<void>;
     headVoid: (url: string, opt?: FetcherOptions) => Promise<void>;
     fetch<T = unknown>(url: string, opt?: FetcherOptions): Promise<T>;
+    /**
+     * Returns FetcherResponse.
+     * Never throws, returns `err` property in the response instead.
+     */
     rawFetch<T = unknown>(url: string, rawOpt?: FetcherOptions): Promise<FetcherResponse<T>>;
     private processRetry;
     /**

package/dist/http/fetcher.js

@@ -88,6 +88,10 @@ class Fetcher {
         }
         return res.body;
     }
+    /**
+     * Returns FetcherResponse.
+     * Never throws, returns `err` property in the response instead.
+     */
     async rawFetch(url, rawOpt = {}) {
         const { logger } = this.cfg;
         const req = this.normalizeOptions(url, rawOpt);
@@ -112,7 +116,8 @@ class Fetcher {
                 retryTimeout: req.retry.timeout,
             },
         };
-        const shortUrl = this.getShortUrl(req.url);
+        const fullUrl = new URL(req.url);
+        const shortUrl = this.getShortUrl(fullUrl);
         const signature = [method.toUpperCase(), shortUrl].join(' ');
         /* eslint-disable no-await-in-loop */
         while (!res.retryStatus.retryStopped) {
@@ -276,9 +281,18 @@ class Fetcher {
      */
     getShortUrl(url) {
         const { baseUrl } = this.cfg;
-        if (!baseUrl)
-            return url;
-        return url.split('?')[0].slice(baseUrl.length);
+        if (url.password) {
+            url = new URL(url.toString()); // prevent original url mutation
+            url.password = '[redacted]';
+        }
+        let shortUrl = url.toString();
+        if (!this.cfg.logWithSearchParams) {
+            shortUrl = shortUrl.split('?')[0];
+        }
+        if (!this.cfg.logWithPrefixUrl && baseUrl && shortUrl.startsWith(baseUrl)) {
+            shortUrl = shortUrl.slice(baseUrl.length);
+        }
+        return shortUrl;
     }
     normalizeCfg(cfg) {
         if (cfg.baseUrl?.endsWith('/')) {
@@ -302,6 +316,8 @@ class Fetcher {
             logRequestBody: debug,
             logResponse: debug,
             logResponseBody: debug,
+            logWithPrefixUrl: true,
+            logWithSearchParams: true,
             retry: { ...defRetryOptions },
             init: {
                 method: cfg.method || 'get',
@@ -332,6 +348,7 @@ class Fetcher {
                 ...this.cfg.init,
                 method: opt.method || this.cfg.init.method,
                 credentials: opt.credentials || this.cfg.init.credentials,
+                redirect: opt.followRedirects ?? this.cfg.followRedirects ?? true ? 'follow' : 'error',
             }, {
                 headers: (0, object_util_1._mapKeys)(opt.headers || {}, k => k.toLowerCase()),
             }),

package/dist-esm/http/fetcher.js

@@ -77,6 +77,10 @@ export class Fetcher {
         }
         return res.body;
     }
+    /**
+     * Returns FetcherResponse.
+     * Never throws, returns `err` property in the response instead.
+     */
     async rawFetch(url, rawOpt = {}) {
         var _a, e_1, _b, _c, _d, e_2, _e, _f;
         var _g, _h, _j;
@@ -120,7 +124,8 @@ export class Fetcher {
                 retryTimeout: req.retry.timeout,
             },
         };
-        const shortUrl = this.getShortUrl(req.url);
+        const fullUrl = new URL(req.url);
+        const shortUrl = this.getShortUrl(fullUrl);
         const signature = [method.toUpperCase(), shortUrl].join(' ');
         /* eslint-disable no-await-in-loop */
         while (!res.retryStatus.retryStopped) {
@@ -316,9 +321,18 @@ export class Fetcher {
      */
     getShortUrl(url) {
         const { baseUrl } = this.cfg;
-        if (!baseUrl)
-            return url;
-        return url.split('?')[0].slice(baseUrl.length);
+        if (url.password) {
+            url = new URL(url.toString()); // prevent original url mutation
+            url.password = '[redacted]';
+        }
+        let shortUrl = url.toString();
+        if (!this.cfg.logWithSearchParams) {
+            shortUrl = shortUrl.split('?')[0];
+        }
+        if (!this.cfg.logWithPrefixUrl && baseUrl && shortUrl.startsWith(baseUrl)) {
+            shortUrl = shortUrl.slice(baseUrl.length);
+        }
+        return shortUrl;
     }
     normalizeCfg(cfg) {
         var _a;
@@ -343,6 +357,8 @@ export class Fetcher {
             logRequestBody: debug,
             logResponse: debug,
             logResponseBody: debug,
+            logWithPrefixUrl: true,
+            logWithSearchParams: true,
             retry: Object.assign({}, defRetryOptions),
             init: {
                 method: cfg.method || 'get',
@@ -355,6 +371,7 @@ export class Fetcher {
         return norm;
     }
     normalizeOptions(url, opt) {
+        var _a, _b;
         const { baseUrl, timeoutSeconds, throwHttpErrors, retryPost, retry4xx, retry5xx, retry, mode } = this.cfg;
         const req = Object.assign(Object.assign({ mode,
             url,
@@ -362,7 +379,7 @@ export class Fetcher {
             throwHttpErrors,
             retryPost,
             retry4xx,
-            retry5xx }, _omit(opt, ['method', 'headers', 'credentials'])), { retry: Object.assign(Object.assign({}, retry), _filterUndefinedValues(opt.retry || {})), init: _merge(Object.assign(Object.assign({}, this.cfg.init), { method: opt.method || this.cfg.init.method, credentials: opt.credentials || this.cfg.init.credentials }), {
+            retry5xx }, _omit(opt, ['method', 'headers', 'credentials'])), { retry: Object.assign(Object.assign({}, retry), _filterUndefinedValues(opt.retry || {})), init: _merge(Object.assign(Object.assign({}, this.cfg.init), { method: opt.method || this.cfg.init.method, credentials: opt.credentials || this.cfg.init.credentials, redirect: ((_b = (_a = opt.followRedirects) !== null && _a !== void 0 ? _a : this.cfg.followRedirects) !== null && _b !== void 0 ? _b : true) ? 'follow' : 'error' }), {
                 headers: _mapKeys(opt.headers || {}, k => k.toLowerCase()),
             }) });
         // setup url

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/js-lib",
-  "version": "14.124.1",
+  "version": "14.126.0",
   "scripts": {
     "prepare": "husky install",
     "build-prod": "build-prod-esm-cjs",

package/src/http/fetcher.ts

@@ -65,6 +65,18 @@ export interface FetcherCfg {
   logResponse?: boolean
   logResponseBody?: boolean
 
+  /**
+   * Default to true.
+   * Set to false to exclude `prefixUrl` from logs (both success and error)
+   */
+  logWithPrefixUrl?: boolean
+
+  /**
+   * Default to true.
+   * Set to false to strip searchParams from url when logging (both success and error)
+   */
+  logWithSearchParams?: boolean
+
   /**
    * Defaults to `console`.
    */
@@ -117,6 +129,10 @@ export interface FetcherOptions {
   body?: Blob | BufferSource | FormData | URLSearchParams | string
 
   credentials?: RequestCredentials
+  /**
+   * Default to true.
+   */
+  followRedirects?: boolean
 
   // Removing RequestInit from options to simplify FetcherOptions interface.
   // Will instead only add hand-picked useful options, such as `credentials`.
@@ -287,6 +303,10 @@ export class Fetcher {
     return res.body!
   }
 
+  /**
+   * Returns FetcherResponse.
+   * Never throws, returns `err` property in the response instead.
+   */
   async rawFetch<T = unknown>(
     url: string,
     rawOpt: FetcherOptions = {},
@@ -323,7 +343,8 @@ export class Fetcher {
       },
     }
 
-    const shortUrl = this.getShortUrl(req.url)
+    const fullUrl = new URL(req.url)
+    const shortUrl = this.getShortUrl(fullUrl)
     const signature = [method.toUpperCase(), shortUrl].join(' ')
 
     /* eslint-disable no-await-in-loop */
@@ -506,11 +527,25 @@ export class Fetcher {
   /**
    * Returns url without baseUrl and before ?queryString
    */
-  private getShortUrl(url: string): string {
+  private getShortUrl(url: URL): string {
     const { baseUrl } = this.cfg
-    if (!baseUrl) return url
 
-    return url.split('?')[0]!.slice(baseUrl.length)
+    if (url.password) {
+      url = new URL(url.toString()) // prevent original url mutation
+      url.password = '[redacted]'
+    }
+
+    let shortUrl = url.toString()
+
+    if (!this.cfg.logWithSearchParams) {
+      shortUrl = shortUrl.split('?')[0]!
+    }
+
+    if (!this.cfg.logWithPrefixUrl && baseUrl && shortUrl.startsWith(baseUrl)) {
+      shortUrl = shortUrl.slice(baseUrl.length)
+    }
+
+    return shortUrl
   }
 
   private normalizeCfg(cfg: FetcherCfg & FetcherOptions): FetcherNormalizedCfg {
@@ -537,6 +572,8 @@ export class Fetcher {
         logRequestBody: debug,
         logResponse: debug,
         logResponseBody: debug,
+        logWithPrefixUrl: true,
+        logWithSearchParams: true,
         retry: { ...defRetryOptions },
         init: {
           method: cfg.method || 'get',
@@ -575,6 +612,7 @@ export class Fetcher {
           ...this.cfg.init,
           method: opt.method || this.cfg.init.method,
           credentials: opt.credentials || this.cfg.init.credentials,
+          redirect: opt.followRedirects ?? this.cfg.followRedirects ?? true ? 'follow' : 'error',
         },
         {
           headers: _mapKeys(opt.headers || {}, k => k.toLowerCase()),