@naturalcycles/js-lib 15.33.0 → 15.33.2

package/dist/http/fetcher.d.ts

@@ -4,7 +4,7 @@
 import type { ReadableStream as WebReadableStream } from 'node:stream/web';
 import { HttpRequestError } from '../error/error.util.js';
 import type { ErrorDataTuple } from '../types.js';
-import type { FetcherAfterResponseHook, FetcherBeforeRequestHook, FetcherBeforeRetryHook, FetcherCfg, FetcherGraphQLOptions, FetcherNormalizedCfg, FetcherOnErrorHook, FetcherOptions, FetcherResponse, RequestInitNormalized } from './fetcher.model.js';
+import type { FetcherAfterResponseHook, FetcherBeforeRequestHook, FetcherBeforeRetryHook, FetcherCfg, FetcherGraphQLOptions, FetcherNormalizedCfg, FetcherOnErrorHook, FetcherOptions, FetcherResponse, FetchFunction, RequestInitNormalized } from './fetcher.model.js';
 /**
  * Experimental wrapper around Fetch.
  * Works in both Browser and Node, using `globalThis.fetch`.
@@ -92,7 +92,7 @@ export declare class Fetcher {
      * This method exists to be able to easily mock it.
      * It is static, so mocking applies to ALL instances (even future ones) of Fetcher at once.
      */
-    static callNativeFetch(url: string, init: RequestInitNormalized): Promise<Response>;
+    static callNativeFetch(url: string, init: RequestInitNormalized, fetchFn?: FetchFunction): Promise<Response>;
     private onNotOkResponse;
     private processRetry;
     private getRetryTimeout;

package/dist/http/fetcher.js

@@ -283,8 +283,7 @@ export class Fetcher {
                 }
             }
             try {
-                // Calls cfg.fetchFn if set, otherwise Fetcher.callNativeFetch
-                res.fetchResponse = await (this.cfg.fetchFn || Fetcher.callNativeFetch)(req.fullUrl, req.init);
+                res.fetchResponse = await (this.cfg.overrideFetchFn || Fetcher.callNativeFetch)(req.fullUrl, req.init, this.cfg.fetchFn);
                 res.ok = res.fetchResponse.ok;
                 // important to set it to undefined, otherwise it can keep the previous value (from previous try)
                 res.err = undefined;
@@ -400,8 +399,8 @@ export class Fetcher {
      * This method exists to be able to easily mock it.
      * It is static, so mocking applies to ALL instances (even future ones) of Fetcher at once.
      */
-    static async callNativeFetch(url, init) {
-        return await globalThis.fetch(url, init);
+    static async callNativeFetch(url, init, fetchFn) {
+        return await (fetchFn || globalThis.fetch)(url, init);
     }
     async onNotOkResponse(res) {
         let cause;

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

@@ -227,9 +227,23 @@ export interface FetcherOptions {
      */
     debug?: boolean;
     /**
-     * If provided - will be used instead of static `Fetcher.callNativeFetch`.
+     * If provided - will be used instead of `globalThis.fetch`.
+     * Can be used e.g to pass a `fetch` function from `undici` (in Node.js).
+     *
+     * This function IS called from `Fetcher.callNativeFetch`, so
+     * when `callNativeFetch` is mocked - fetchFn is NOT called.
      */
     fetchFn?: FetchFunction;
+    /**
+     * Allows to provide a fetch function that is NOT mocked by `Fetcher.callNativeFetch`.
+     *
+     * By default - consider `fetchFn`, that's what you would need most of the time.
+     *
+     * If you want to pass a fetch function that is NOT mockable - use `overrideFetchFn`.
+     * Example of where it is useful: in backend resourceTestService, which still needs to call
+     * native fetch, while allowing unit tests' fetch calls to be mocked.
+     */
+    overrideFetchFn?: FetchFunction;
     /**
      * Default to true.
      * Set to false to not throw on `!Response.ok`, but simply return `Response.body` as-is (json parsed, etc).
@@ -284,7 +298,26 @@ export type FetcherResponseType = 'json' | 'text' | 'void' | 'arrayBuffer' | 'bl
  * Used to be able to override and provide a different implementation,
  * e.g when mocking.
  */
-export type FetchFunction = (url: string, init: RequestInitNormalized) => Promise<Response>;
+export type FetchFunction = (url: string, init: RequestInit) => Promise<Response>;
+/**
+ * A subset of RequestInit that would match both:
+ *
+ * 1. RequestInit from dom types
+ * 2. RequestInit from undici types
+ */
+export interface RequestInitLike {
+    method?: string;
+    referrer?: string;
+    keepalive?: boolean;
+}
+/**
+ * A subset of Response type that matches both dom and undici types.
+ */
+export interface ResponseLike {
+    ok: boolean;
+    status: number;
+    statusText: string;
+}
 export type GraphQLResponse<DATA> = GraphQLSuccessResponse<DATA> | GraphQLErrorResponse;
 export interface GraphQLSuccessResponse<DATA> {
     data: DATA;

package/package.json

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

package/src/http/fetcher.model.ts

@@ -290,10 +290,25 @@ export interface FetcherOptions {
   debug?: boolean
 
   /**
-   * If provided - will be used instead of static `Fetcher.callNativeFetch`.
+   * If provided - will be used instead of `globalThis.fetch`.
+   * Can be used e.g to pass a `fetch` function from `undici` (in Node.js).
+   *
+   * This function IS called from `Fetcher.callNativeFetch`, so
+   * when `callNativeFetch` is mocked - fetchFn is NOT called.
    */
   fetchFn?: FetchFunction
 
+  /**
+   * Allows to provide a fetch function that is NOT mocked by `Fetcher.callNativeFetch`.
+   *
+   * By default - consider `fetchFn`, that's what you would need most of the time.
+   *
+   * If you want to pass a fetch function that is NOT mockable - use `overrideFetchFn`.
+   * Example of where it is useful: in backend resourceTestService, which still needs to call
+   * native fetch, while allowing unit tests' fetch calls to be mocked.
+   */
+  overrideFetchFn?: FetchFunction
+
   /**
    * Default to true.
    * Set to false to not throw on `!Response.ok`, but simply return `Response.body` as-is (json parsed, etc).
@@ -364,7 +379,28 @@ export type FetcherResponseType =
  * Used to be able to override and provide a different implementation,
  * e.g when mocking.
  */
-export type FetchFunction = (url: string, init: RequestInitNormalized) => Promise<Response>
+export type FetchFunction = (url: string, init: RequestInit) => Promise<Response>
+
+/**
+ * A subset of RequestInit that would match both:
+ *
+ * 1. RequestInit from dom types
+ * 2. RequestInit from undici types
+ */
+export interface RequestInitLike {
+  method?: string
+  referrer?: string
+  keepalive?: boolean
+}
+
+/**
+ * A subset of Response type that matches both dom and undici types.
+ */
+export interface ResponseLike {
+  ok: boolean
+  status: number
+  statusText: string
+}
 
 export type GraphQLResponse<DATA> = GraphQLSuccessResponse<DATA> | GraphQLErrorResponse
 

package/src/http/fetcher.ts

@@ -49,6 +49,7 @@ import type {
   FetcherResponse,
   FetcherResponseType,
   FetcherRetryOptions,
+  FetchFunction,
   GraphQLResponse,
   RequestInitNormalized,
 } from './fetcher.model.js'
@@ -369,10 +370,10 @@ export class Fetcher {
       }
 
       try {
-        // Calls cfg.fetchFn if set, otherwise Fetcher.callNativeFetch
-        res.fetchResponse = await (this.cfg.fetchFn || Fetcher.callNativeFetch)(
+        res.fetchResponse = await (this.cfg.overrideFetchFn || Fetcher.callNativeFetch)(
           req.fullUrl,
           req.init,
+          this.cfg.fetchFn,
         )
         res.ok = res.fetchResponse.ok
         // important to set it to undefined, otherwise it can keep the previous value (from previous try)
@@ -502,8 +503,12 @@ export class Fetcher {
    * This method exists to be able to easily mock it.
    * It is static, so mocking applies to ALL instances (even future ones) of Fetcher at once.
    */
-  static async callNativeFetch(url: string, init: RequestInitNormalized): Promise<Response> {
-    return await globalThis.fetch(url, init)
+  static async callNativeFetch(
+    url: string,
+    init: RequestInitNormalized,
+    fetchFn?: FetchFunction,
+  ): Promise<Response> {
+    return await (fetchFn || globalThis.fetch)(url, init)
   }
 
   private async onNotOkResponse(res: FetcherResponse): Promise<void> {