@naturalcycles/js-lib 15.50.1 → 15.52.0

package/dist/error/error.model.d.ts

@@ -56,6 +56,15 @@ export interface ErrorData {
      * Sentry takes string[], but for convenience we allow to pass a singe string.
      */
     fingerprint?: string;
+    /**
+     * Similar to fingerprint, with one important difference.
+     *
+     * fingerprint means FINAL fingerprint that'll be used for error reporting as is.
+     *
+     * errorGroup is meant to be used as a COMPONENT to construct a fingerprint, but not
+     * an exhaustive fingerprint by itself.
+     */
+    errorGroup?: string;
     /**
      * Set when throwing an error from your backend code, to indicate desired http status code.
      * e.g throw new AppError('oj', { backendResponseStatusCode: 401 })
@@ -86,6 +95,9 @@ export interface HttpRequestErrorData extends ErrorData {
      * Non-enumerable.
      */
     response?: Response;
+    /**
+     * Full request url, inclusing baseUrl, inputUrl, searchParams, etc.
+     */
     requestUrl: string;
     requestBaseUrl?: string;
     requestMethod: HttpMethod;
@@ -95,6 +107,15 @@ export interface HttpRequestErrorData extends ErrorData {
      * GET /some/url
      */
     requestSignature: string;
+    /**
+     * FetcherOptions.requestName, if it was provided.
+     * Allows to construct errorGroup/fingerprint.
+     */
+    requestName?: string;
+    /**
+     * FetcherCfg.name if it was provided, for the purpose of constructing an error fingerprint.
+     */
+    fetcherName?: string;
     /**
      * Can be set to 0 if request "failed to start" or "failed to reach the server".
      */

package/dist/http/fetcher.js

@@ -160,6 +160,8 @@ export class Fetcher {
                 requestBaseUrl: this.cfg.baseUrl,
                 requestMethod: res.req.init.method,
                 requestSignature: res.signature,
+                requestName: res.req.requestName,
+                fetcherName: this.cfg.name,
                 requestDuration: Date.now() - res.req.started,
             });
         }
@@ -440,6 +442,8 @@ export class Fetcher {
             requestBaseUrl: this.cfg.baseUrl || undefined,
             requestMethod: res.req.init.method,
             requestSignature: res.signature,
+            requestName: res.req.requestName,
+            fetcherName: this.cfg.name,
             requestDuration: Date.now() - res.req.started,
         }), {
             cause,
@@ -580,13 +584,14 @@ export class Fetcher {
         return shortUrl;
     }
     normalizeCfg(cfg) {
+        const { debug = false, logger = console } = cfg;
         if (cfg.baseUrl?.endsWith('/')) {
-            console.warn(`Fetcher: baseUrl should not end with slash: ${cfg.baseUrl}`);
+            logger.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: '',
+            name: '',
             inputUrl: '',
             responseType: 'json',
             searchParams: {},
@@ -595,8 +600,7 @@ export class Fetcher {
             retry3xx: false,
             retry4xx: false,
             retry5xx: true,
-            // logger: console, Danger! doing this mutates console!
-            logger: cfg.logger || console,
+            logger,
             debug,
             logRequest: debug,
             logRequestBody: debug,
@@ -665,11 +669,12 @@ export class Fetcher {
         // setup url
         const baseUrl = opt.baseUrl || this.cfg.baseUrl;
         if (baseUrl) {
-            if (req.fullUrl.startsWith('/')) {
-                console.warn('Fetcher: url should not start with / when baseUrl is specified');
-                req.fullUrl = req.fullUrl.slice(1);
+            let { inputUrl } = req;
+            if (inputUrl.startsWith('/')) {
+                this.cfg.logger.warn('Fetcher: url should not start with / when baseUrl is specified');
+                inputUrl = inputUrl.slice(1);
             }
-            req.fullUrl = `${baseUrl}/${req.inputUrl}`;
+            req.fullUrl = `${baseUrl}/${inputUrl}`;
         }
         const searchParams = _filterUndefinedValues({
             ...this.cfg.searchParams,

package/dist/http/fetcher.model.d.ts

@@ -26,6 +26,12 @@ export interface FetcherCfg {
      * Should **not** contain trailing slash.
      */
     baseUrl?: string;
+    /**
+     * "Name" of the fetcher.
+     * Accessible inside HttpRequestError, to be able to construct a good fingerprint.
+     * If name is not provided - baseUrl is used to identify a Fetcher.
+     */
+    name?: string;
     /**
      * Default rule is that you **are allowed** to mutate req, res, res.retryStatus
      * properties of hook function arguments.
@@ -263,6 +269,12 @@ export interface FetcherOptions {
      * Cannot cancel/prevent the error - AfterResponseHook can be used for that instead.
      */
     onError?: FetcherOnErrorHook;
+    /**
+     * If provided - will be passed further to HttpRequestError if error happens,
+     * allowing to construct an errorGroup/fingerprint to be able to group errors
+     * related to "this type of request".
+     */
+    requestName?: string;
 }
 export type RequestInitNormalized = Omit<RequestInit, 'method' | 'headers'> & {
     method: HttpMethod;

package/dist/string/stringify.d.ts

@@ -13,6 +13,7 @@ import type { Reviver } from '../types.js';
  * It's recommended that this function is circular-reference-safe.
  */
 export declare function setGlobalStringifyFunction(fn: JsonStringifyFunction): void;
+export declare function resetGlobalStringifyFunction(): void;
 export type JsonStringifyFunction = (obj: any, reviver?: Reviver, space?: number) => string;
 export interface StringifyOptions {
     /**

package/dist/string/stringify.js

@@ -20,6 +20,9 @@ let globalStringifyFunction = _safeJsonStringify;
 export function setGlobalStringifyFunction(fn) {
     globalStringifyFunction = fn;
 }
+export function resetGlobalStringifyFunction() {
+    globalStringifyFunction = _safeJsonStringify;
+}
 /**
  * Inspired by `_inspect` from nodejs-lib, which is based on util.inpect that is not available in the Browser.
  * Potentially can do this (with extra 2Kb gz size): https://github.com/deecewan/browser-util-inspect

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@naturalcycles/js-lib",
   "type": "module",
-  "version": "15.50.1",
+  "version": "15.52.0",
   "dependencies": {
     "tslib": "^2",
     "undici": "^7",
@@ -13,7 +13,7 @@
     "@types/semver": "^7",
     "crypto-js": "^4",
     "dayjs": "^1",
-    "@naturalcycles/dev-lib": "20.12.10"
+    "@naturalcycles/dev-lib": "18.4.2"
   },
   "exports": {
     ".": "./dist/index.js",

package/src/error/error.model.ts

@@ -65,6 +65,16 @@ export interface ErrorData {
    */
   fingerprint?: string
 
+  /**
+   * Similar to fingerprint, with one important difference.
+   *
+   * fingerprint means FINAL fingerprint that'll be used for error reporting as is.
+   *
+   * errorGroup is meant to be used as a COMPONENT to construct a fingerprint, but not
+   * an exhaustive fingerprint by itself.
+   */
+  errorGroup?: string
+
   /**
    * Set when throwing an error from your backend code, to indicate desired http status code.
    * e.g throw new AppError('oj', { backendResponseStatusCode: 401 })
@@ -100,7 +110,9 @@ export interface HttpRequestErrorData extends ErrorData {
    * Non-enumerable.
    */
   response?: Response
-
+  /**
+   * Full request url, inclusing baseUrl, inputUrl, searchParams, etc.
+   */
   requestUrl: string
   requestBaseUrl?: string
   requestMethod: HttpMethod
@@ -110,6 +122,15 @@ export interface HttpRequestErrorData extends ErrorData {
    * GET /some/url
    */
   requestSignature: string
+  /**
+   * FetcherOptions.requestName, if it was provided.
+   * Allows to construct errorGroup/fingerprint.
+   */
+  requestName?: string
+  /**
+   * FetcherCfg.name if it was provided, for the purpose of constructing an error fingerprint.
+   */
+  fetcherName?: string
   /**
    * Can be set to 0 if request "failed to start" or "failed to reach the server".
    */

package/src/http/fetcher.model.ts

@@ -57,6 +57,13 @@ export interface FetcherCfg {
    */
   baseUrl?: string
 
+  /**
+   * "Name" of the fetcher.
+   * Accessible inside HttpRequestError, to be able to construct a good fingerprint.
+   * If name is not provided - baseUrl is used to identify a Fetcher.
+   */
+  name?: string
+
   /**
    * Default rule is that you **are allowed** to mutate req, res, res.retryStatus
    * properties of hook function arguments.
@@ -333,6 +340,13 @@ export interface FetcherOptions {
    * Cannot cancel/prevent the error - AfterResponseHook can be used for that instead.
    */
   onError?: FetcherOnErrorHook
+
+  /**
+   * If provided - will be passed further to HttpRequestError if error happens,
+   * allowing to construct an errorGroup/fingerprint to be able to group errors
+   * related to "this type of request".
+   */
+  requestName?: string
 }
 
 export type RequestInitNormalized = Omit<RequestInit, 'method' | 'headers'> & {

package/src/http/fetcher.ts

@@ -221,6 +221,8 @@ export class Fetcher {
         requestBaseUrl: this.cfg.baseUrl,
         requestMethod: res.req.init.method,
         requestSignature: res.signature,
+        requestName: res.req.requestName,
+        fetcherName: this.cfg.name,
         requestDuration: Date.now() - res.req.started,
       })
     }
@@ -551,6 +553,8 @@ export class Fetcher {
         requestBaseUrl: this.cfg.baseUrl || undefined,
         requestMethod: res.req.init.method,
         requestSignature: res.signature,
+        requestName: res.req.requestName,
+        fetcherName: this.cfg.name,
         requestDuration: Date.now() - res.req.started,
       }),
       {
@@ -712,15 +716,17 @@ export class Fetcher {
   }
 
   private normalizeCfg(cfg: FetcherCfg & FetcherOptions): FetcherNormalizedCfg {
+    const { debug = false, logger = console } = cfg
+
     if (cfg.baseUrl?.endsWith('/')) {
-      console.warn(`Fetcher: baseUrl should not end with slash: ${cfg.baseUrl}`)
+      logger.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: FetcherNormalizedCfg = _merge(
       {
         baseUrl: '',
+        name: '',
         inputUrl: '',
         responseType: 'json',
         searchParams: {},
@@ -729,8 +735,7 @@ export class Fetcher {
         retry3xx: false,
         retry4xx: false,
         retry5xx: true,
-        // logger: console, Danger! doing this mutates console!
-        logger: cfg.logger || console,
+        logger,
         debug,
         logRequest: debug,
         logRequestBody: debug,
@@ -809,11 +814,12 @@ export class Fetcher {
     // setup url
     const baseUrl = opt.baseUrl || this.cfg.baseUrl
     if (baseUrl) {
-      if (req.fullUrl.startsWith('/')) {
-        console.warn('Fetcher: url should not start with / when baseUrl is specified')
-        req.fullUrl = req.fullUrl.slice(1)
+      let { inputUrl } = req
+      if (inputUrl.startsWith('/')) {
+        this.cfg.logger.warn('Fetcher: url should not start with / when baseUrl is specified')
+        inputUrl = inputUrl.slice(1)
       }
-      req.fullUrl = `${baseUrl}/${req.inputUrl}`
+      req.fullUrl = `${baseUrl}/${inputUrl}`
     }
 
     const searchParams = _filterUndefinedValues({

package/src/string/stringify.ts

@@ -26,6 +26,10 @@ export function setGlobalStringifyFunction(fn: JsonStringifyFunction): void {
   globalStringifyFunction = fn
 }
 
+export function resetGlobalStringifyFunction(): void {
+  globalStringifyFunction = _safeJsonStringify
+}
+
 export type JsonStringifyFunction = (obj: any, reviver?: Reviver, space?: number) => string
 
 export interface StringifyOptions {