@naturalcycles/js-lib 14.156.0 → 14.157.1

package/dist-esm/http/fetcher.js

@@ -1,15 +1,24 @@
 /// <reference lib="dom"/>
+/// <reference lib="dom.iterable"/>
 import { isServerSide } from '../env';
 import { _anyToError, _anyToErrorObject, _errorLikeToErrorObject } from '../error/error.util';
 import { HttpRequestError } from '../error/httpRequestError';
 import { _clamp } from '../number/number.util';
 import { _filterNullishValues, _filterUndefinedValues, _mapKeys, _merge, _omit, _pick, } from '../object/object.util';
 import { pDelay } from '../promise/pDelay';
-import { TimeoutError } from '../promise/pTimeout';
+import { pTimeout, TimeoutError } from '../promise/pTimeout';
 import { _jsonParse, _jsonParseIfPossible } from '../string/json.util';
 import { _stringifyAny } from '../string/stringifyAny';
-import { _since } from '../time/time.util';
+import { _ms, _since } from '../time/time.util';
 import { HTTP_METHODS } from './http.model';
+const acceptByResponseType = {
+    text: 'text/plain',
+    json: 'application/json',
+    void: '*/*',
+    readableStream: 'application/octet-stream',
+    arrayBuffer: 'application/octet-stream',
+    blob: 'application/octet-stream',
+};
 const defRetryOptions = {
     count: 2,
     timeout: 1000,
@@ -31,18 +40,18 @@ export class Fetcher {
             const m = method.toLowerCase();
             this[`${m}Void`] = async (url, opt) => {
                 return await this.fetch(Object.assign({ url,
-                    method, mode: 'void' }, opt));
+                    method, responseType: 'void' }, opt));
             };
             if (method === 'HEAD')
-                return // mode=text
+                return // responseType=text
                 ;
             this[`${m}Text`] = async (url, opt) => {
                 return await this.fetch(Object.assign({ url,
-                    method, mode: 'text' }, opt));
+                    method, responseType: 'text' }, opt));
             };
             this[m] = async (url, opt) => {
                 return await this.fetch(Object.assign({ url,
-                    method, mode: 'json' }, opt));
+                    method, responseType: 'json' }, opt));
             };
         });
     }
@@ -70,7 +79,7 @@ export class Fetcher {
     static create(cfg = {}) {
         return new Fetcher(cfg);
     }
-    // mode=readableStream
+    // responseType=readableStream
     /**
      * Returns raw fetchResponse.body, which is a ReadableStream<Uint8Array>
      *
@@ -78,7 +87,7 @@ export class Fetcher {
      * https://css-tricks.com/web-streams-everywhere-and-fetch-for-node-js/
      */
     async getReadableStream(url, opt) {
-        return await this.fetch(Object.assign({ url, mode: 'readableStream' }, opt));
+        return await this.fetch(Object.assign({ url, responseType: 'readableStream' }, opt));
     }
     async fetch(opt) {
         const res = await this.doFetch(opt);
@@ -97,19 +106,6 @@ export class Fetcher {
         const req = this.normalizeOptions(opt);
         const { logger } = this.cfg;
         const { timeoutSeconds, init: { method }, } = req;
-        // setup timeout
-        let timeout;
-        if (timeoutSeconds) {
-            const abortController = new AbortController();
-            req.init.signal = abortController.signal;
-            timeout = setTimeout(() => {
-                // Apparently, providing a `string` reason to abort() causes Undici to throw `invalid_argument` error,
-                // so, we're wrapping it in a TimeoutError instance
-                abortController.abort(new TimeoutError(`request timed out after ${timeoutSeconds} sec`));
-                // abortController.abort(`timeout of ${timeoutSeconds} sec`)
-                // abortController.abort()
-            }, timeoutSeconds * 1000);
-        }
         for (const hook of this.cfg.hooks.beforeRequest || []) {
             await hook(req);
         }
@@ -128,6 +124,18 @@ export class Fetcher {
         };
         while (!res.retryStatus.retryStopped) {
             req.started = Date.now();
+            // setup timeout
+            let timeoutId;
+            if (timeoutSeconds) {
+                const abortController = new AbortController();
+                req.init.signal = abortController.signal;
+                timeoutId = setTimeout(() => {
+                    // console.log(`actual request timed out in ${_since(req.started)}`)
+                    // Apparently, providing a `string` reason to abort() causes Undici to throw `invalid_argument` error,
+                    // so, we're wrapping it in a TimeoutError instance
+                    abortController.abort(new TimeoutError(`request timed out after ${timeoutSeconds} sec`));
+                }, timeoutSeconds * 1000);
+            }
             if (this.cfg.logRequest) {
                 const { retryAttempt } = res.retryStatus;
                 logger.log([' >>', signature, retryAttempt && `try#${retryAttempt + 1}/${req.retry.count + 1}`]
@@ -151,14 +159,30 @@ export class Fetcher {
                 // important to set it to undefined, otherwise it can keep the previous value (from previous try)
                 res.fetchResponse = undefined;
             }
+            finally {
+                clearTimeout(timeoutId);
+                // Separate Timeout will be introduced to "download and parse the body"
+            }
             res.statusFamily = this.getStatusFamily(res);
             res.statusCode = (_a = res.fetchResponse) === null || _a === void 0 ? void 0 : _a.status;
             if ((_b = res.fetchResponse) === null || _b === void 0 ? void 0 : _b.ok) {
-                await this.onOkResponse(res, timeout);
+                try {
+                    // We are applying a separate Timeout (as long as original Timeout for now) to "download and parse the body"
+                    await pTimeout(async () => await this.onOkResponse(res), {
+                        timeout: timeoutSeconds * 1000 || Number.POSITIVE_INFINITY,
+                        name: 'Fetcher.onOkResponse',
+                    });
+                }
+                catch (err) {
+                    // onOkResponse can still fail, e.g when loading/parsing json, text or doing other response manipulation
+                    res.err = _anyToError(err);
+                    res.ok = false;
+                    await this.onNotOkResponse(res);
+                }
             }
             else {
                 // !res.ok
-                await this.onNotOkResponse(res, timeout);
+                await this.onNotOkResponse(res);
             }
         }
         for (const hook of this.cfg.hooks.afterResponse || []) {
@@ -166,31 +190,17 @@ export class Fetcher {
         }
         return res;
     }
-    async onOkResponse(res, timeout) {
+    async onOkResponse(res) {
         const { req } = res;
-        const { mode } = res.req;
-        if (mode === 'json') {
+        const { responseType } = res.req;
+        // This function is subject to a separate timeout to "download and parse the data"
+        if (responseType === 'json') {
             if (res.fetchResponse.body) {
                 const text = await res.fetchResponse.text();
                 if (text) {
-                    try {
-                        res.body = text;
-                        res.body = _jsonParse(text, req.jsonReviver);
-                    }
-                    catch (err) {
-                        // Error while parsing json
-                        // res.err = _anyToError(err, HttpRequestError, {
-                        //   requestUrl: res.req.url,
-                        //   requestBaseUrl: this.cfg.baseUrl,
-                        //   requestMethod: res.req.init.method,
-                        //   requestSignature: res.signature,
-                        //   requestDuration: Date.now() - started,
-                        //   responseStatusCode: res.fetchResponse.status,
-                        // } satisfies HttpRequestErrorData)
-                        res.err = _anyToError(err);
-                        res.ok = false;
-                        return await this.onNotOkResponse(res, timeout);
-                    }
+                    res.body = text;
+                    res.body = _jsonParse(text, req.jsonReviver);
+                    // Error while parsing json can happen - it'll be handled upstream
                 }
                 else {
                     // Body had a '' (empty string)
@@ -203,24 +213,22 @@ export class Fetcher {
                 res.body = {};
             }
         }
-        else if (mode === 'text') {
+        else if (responseType === 'text') {
             res.body = res.fetchResponse.body ? await res.fetchResponse.text() : '';
         }
-        else if (mode === 'arrayBuffer') {
+        else if (responseType === 'arrayBuffer') {
             res.body = res.fetchResponse.body ? await res.fetchResponse.arrayBuffer() : {};
         }
-        else if (mode === 'blob') {
+        else if (responseType === 'blob') {
             res.body = res.fetchResponse.body ? await res.fetchResponse.blob() : {};
         }
-        else if (mode === 'readableStream') {
+        else if (responseType === 'readableStream') {
             res.body = res.fetchResponse.body;
             if (res.body === null) {
-                res.err = new Error(`fetchResponse.body is null`);
-                res.ok = false;
-                return await this.onNotOkResponse(res, timeout);
+                // Error is to be handled upstream
+                throw new Error(`fetchResponse.body is null`);
             }
         }
-        clearTimeout(timeout);
         res.retryStatus.retryStopped = true;
         // res.err can happen on `failed to fetch` type of error, e.g JSON.parse, CORS, unexpected redirect
         if (!res.err && this.cfg.logResponse) {
@@ -246,9 +254,8 @@ export class Fetcher {
     async callNativeFetch(url, init) {
         return await globalThis.fetch(url, init);
     }
-    async onNotOkResponse(res, timeout) {
+    async onNotOkResponse(res) {
         var _a, _b;
-        clearTimeout(timeout);
         let cause;
         if (res.err) {
             // This is only possible on JSON.parse error, or CORS error,
@@ -315,7 +322,11 @@ export class Fetcher {
             return;
         retryStatus.retryAttempt++;
         retryStatus.retryTimeout = _clamp(retryStatus.retryTimeout * timeoutMultiplier, 0, timeoutMax);
-        await pDelay(this.getRetryTimeout(res));
+        const timeout = this.getRetryTimeout(res);
+        if (res.req.debug) {
+            this.cfg.logger.log(` .. ${res.signature} waiting ${_ms(timeout)}`);
+        }
+        await pDelay(timeout);
     }
     getRetryTimeout(res) {
         var _a;
@@ -371,8 +382,9 @@ export class Fetcher {
         if (statusFamily === 3 && !retry3xx)
             return false;
         // should not retry on `unexpected redirect` in error.cause.cause
-        if ((_e = (_d = (_c = (_b = res.err) === null || _b === void 0 ? void 0 : _b.cause) === null || _c === void 0 ? void 0 : _c.cause) === null || _d === void 0 ? void 0 : _d.message) === null || _e === void 0 ? void 0 : _e.includes('unexpected redirect'))
+        if ((_e = (_d = (_c = (_b = res.err) === null || _b === void 0 ? void 0 : _b.cause) === null || _c === void 0 ? void 0 : _c.cause) === null || _d === void 0 ? void 0 : _d.message) === null || _e === void 0 ? void 0 : _e.includes('unexpected redirect')) {
             return false;
+        }
         return true; // default is true
     }
     getStatusFamily(res) {
@@ -412,14 +424,14 @@ export class Fetcher {
     normalizeCfg(cfg) {
         var _a;
         if ((_a = cfg.baseUrl) === null || _a === void 0 ? void 0 : _a.endsWith('/')) {
-            console.warn(`Fetcher: baseUrl should not end with /`);
+            console.warn(`Fetcher: baseUrl should not end with slash: ${cfg.baseUrl}`);
             cfg.baseUrl = cfg.baseUrl.slice(0, cfg.baseUrl.length - 1);
         }
         const { debug = false } = cfg;
         const norm = _merge({
             baseUrl: '',
             inputUrl: '',
-            mode: 'void',
+            responseType: 'void',
             searchParams: {},
             timeoutSeconds: 30,
             retryPost: false,
@@ -438,7 +450,7 @@ export class Fetcher {
             retry: Object.assign({}, defRetryOptions),
             init: {
                 method: cfg.method || 'GET',
-                headers: cfg.headers || {},
+                headers: Object.assign({ 'user-agent': 'fetcher' }, cfg.headers),
                 credentials: cfg.credentials,
                 redirect: cfg.redirect,
             },
@@ -448,17 +460,19 @@ export class Fetcher {
         return norm;
     }
     normalizeOptions(opt) {
+        var _a;
         const req = Object.assign(Object.assign(Object.assign(Object.assign({}, _pick(this.cfg, [
             'timeoutSeconds',
             'retryPost',
             'retry4xx',
             'retry5xx',
-            'mode',
+            'responseType',
             'jsonReviver',
             'logRequest',
             'logRequestBody',
             'logResponse',
             'logResponseBody',
+            'debug',
         ])), { started: Date.now() }), _omit(opt, ['method', 'headers', 'credentials'])), { inputUrl: opt.url || '', fullUrl: opt.url || '', retry: Object.assign(Object.assign({}, this.cfg.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: opt.redirect || this.cfg.init.redirect || 'follow' }), {
                 headers: _mapKeys(opt.headers || {}, k => k.toLowerCase()),
             }) });
@@ -485,9 +499,20 @@ export class Fetcher {
             req.init.body = opt.text;
             req.init.headers['content-type'] = 'text/plain';
         }
+        else if (opt.form) {
+            if (opt.form instanceof URLSearchParams || opt.form instanceof FormData) {
+                req.init.body = opt.form;
+            }
+            else {
+                req.init.body = new URLSearchParams(opt.form);
+            }
+            req.init.headers['content-type'] = 'application/x-www-form-urlencoded';
+        }
         else if (opt.body !== undefined) {
             req.init.body = opt.body;
         }
+        // Unless `accept` header was already set - set it based on responseType
+        (_a = req.init.headers)['accept'] || (_a['accept'] = acceptByResponseType[req.responseType]);
         return req;
     }
 }

package/dist-esm/index.js

@@ -80,6 +80,7 @@ export * from './http/fetcher';
 export * from './http/fetcher.model';
 export * from './string/hash.util';
 export * from './env/buildInfo';
+export * from './form.util';
 export * from './zod/zod.util';
 export * from './zod/zod.shared.schemas';
 import { z, ZodSchema, ZodError } from 'zod';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/js-lib",
-  "version": "14.156.0",
+  "version": "14.157.1",
   "scripts": {
     "prepare": "husky install",
     "build-prod": "build-prod-esm-cjs",
@@ -21,7 +21,6 @@
     "crypto-js": "^4.1.1",
     "jest": "^29.0.0",
     "prettier": "^3.0.0",
-    "rxjs": "^7.0.1",
     "vuepress": "^1.7.1",
     "vuepress-plugin-typescript": "^0.3.1"
   },

package/src/form.util.ts

@@ -0,0 +1,17 @@
+import type { AnyObject } from './types'
+
+/**
+ * Convert any object to FormData.
+ * Please note that every key and value of FormData is `string`.
+ * Even if you pass a number - it'll be converted to string.
+ * Think URLSearchParams.
+ */
+export function objectToFormData(obj: AnyObject = {}): FormData {
+  const fd = new FormData()
+  Object.entries(obj).forEach(([k, v]) => fd.append(k, v))
+  return fd
+}
+
+export function formDataToObject<T extends AnyObject>(formData: FormData): T {
+  return Object.fromEntries(formData) as T
+}

package/src/http/fetcher.model.ts

@@ -1,6 +1,6 @@
 import type { CommonLogger } from '../log/commonLogger'
 import type { Promisable } from '../typeFest'
-import type { Reviver, UnixTimestampMillisNumber } from '../types'
+import type { AnyObject, NumberOfMilliseconds, Reviver, UnixTimestampMillisNumber } from '../types'
 import type { HttpMethod, HttpStatusFamily } from './http.model'
 
 export interface FetcherNormalizedCfg
@@ -13,6 +13,7 @@ export interface FetcherNormalizedCfg
       | 'logRequestBody'
       | 'logResponse'
       | 'logResponseBody'
+      | 'debug'
       | 'redirect'
       | 'credentials'
     > {
@@ -93,14 +94,14 @@ export interface FetcherCfg {
 
 export interface FetcherRetryStatus {
   retryAttempt: number
-  retryTimeout: number
+  retryTimeout: NumberOfMilliseconds
   retryStopped: boolean
 }
 
 export interface FetcherRetryOptions {
   count: number
-  timeout: number
-  timeoutMax: number
+  timeout: NumberOfMilliseconds
+  timeoutMax: NumberOfMilliseconds
   timeoutMultiplier: number
 }
 
@@ -116,7 +117,7 @@ export interface FetcherRequest
    */
   fullUrl: string
   init: RequestInitNormalized
-  mode: FetcherMode
+  responseType: FetcherResponseType
   timeoutSeconds: number
   retry: FetcherRetryOptions
   retryPost: boolean
@@ -145,8 +146,6 @@ export interface FetcherOptions {
    */
   timeoutSeconds?: number
 
-  json?: any
-  text?: string
   /**
    * Supports all the types that RequestInit.body supports.
    *
@@ -154,6 +153,26 @@ export interface FetcherOptions {
    */
   body?: Blob | BufferSource | FormData | URLSearchParams | string
 
+  /**
+   * Same as `body`, but also conveniently sets the
+   * Content-Type header to `text/plain`
+   */
+  text?: string
+
+  /**
+   * Same as `body`, but:
+   * 1. JSON.stringifies the passed variable
+   * 2. Conveniently sets the Content-Type header to `application/json`
+   */
+  json?: any
+
+  /**
+   * Same as `body`, but:
+   * 1. Transforms the passed plain js object into URLSearchParams and passes it to `body`
+   * 2. Conveniently sets the Content-Type header to `application/x-www-form-urlencoded`
+   */
+  form?: FormData | URLSearchParams | AnyObject
+
   credentials?: RequestCredentials
   /**
    * Default to 'follow'.
@@ -167,7 +186,7 @@ export interface FetcherOptions {
   // init?: Partial<RequestInitNormalized>
 
   headers?: Record<string, any>
-  mode?: FetcherMode // default to 'void'
+  responseType?: FetcherResponseType // default to 'void'
 
   searchParams?: Record<string, any>
 
@@ -201,6 +220,10 @@ export interface FetcherOptions {
   logRequestBody?: boolean
   logResponse?: boolean
   logResponseBody?: boolean
+  /**
+   * If true - enables all possible logging.
+   */
+  debug?: boolean
 }
 
 export type RequestInitNormalized = Omit<RequestInit, 'method' | 'headers'> & {
@@ -236,4 +259,10 @@ export type FetcherResponse<BODY = unknown> =
   | FetcherSuccessResponse<BODY>
   | FetcherErrorResponse<BODY>
 
-export type FetcherMode = 'json' | 'text' | 'void' | 'arrayBuffer' | 'blob' | 'readableStream'
+export type FetcherResponseType =
+  | 'json'
+  | 'text'
+  | 'void'
+  | 'arrayBuffer'
+  | 'blob'
+  | 'readableStream'