Merge pull request #1220 from Esri/f/request-option

feat(arcgis-rest-request): add option to override request function

Author: tomwayson

packages/arcgis-rest-request/src/request.ts

@@ -5,7 +5,10 @@ import { encodeFormData } from "./utils/encode-form-data.js";
 import { encodeQueryString } from "./utils/encode-query-string.js";
 import { requiresFormData } from "./utils/process-params.js";
 import { ArcGISRequestError } from "./utils/ArcGISRequestError.js";
-import { IRequestOptions } from "./utils/IRequestOptions.js";
+import {
+  IRequestOptions,
+  InternalRequestOptions
+} from "./utils/IRequestOptions.js";
 import { IParams } from "./utils/IParams.js";
 import { warn } from "./utils/warn.js";
 import { IRetryAuthError } from "./utils/retryAuthError.js";
@@ -211,7 +214,7 @@ export function checkForErrors(
  */
 export function internalRequest(
   url: string,
-  requestOptions: IRequestOptions
+  requestOptions: InternalRequestOptions
 ): Promise<any> {
   const defaults = getDefaultRequestOptions();
   const options: IRequestOptions = {
@@ -531,19 +534,23 @@ export function request(
   url: string,
   requestOptions: IRequestOptions = { params: { f: "json" } }
 ): Promise<any> {
-  return internalRequest(url, requestOptions).catch((e) => {
-    if (
-      e instanceof ArcGISAuthError &&
-      requestOptions.authentication &&
-      typeof requestOptions.authentication !== "string" &&
-      requestOptions.authentication.canRefresh &&
-      requestOptions.authentication.refreshCredentials
-    ) {
-      return e.retry(() => {
-        return (requestOptions.authentication as any).refreshCredentials();
-      }, 1);
-    } else {
-      return Promise.reject(e);
-    }
-  });
+  const { request, ...internalOptions } = requestOptions;
+  // if the user passed in a custom request function, use that instead of the default
+  return request
+    ? request(url, internalOptions)
+    : internalRequest(url, internalOptions).catch((e) => {
+        if (
+          e instanceof ArcGISAuthError &&
+          requestOptions.authentication &&
+          typeof requestOptions.authentication !== "string" &&
+          requestOptions.authentication.canRefresh &&
+          requestOptions.authentication.refreshCredentials
+        ) {
+          return e.retry(() => {
+            return (requestOptions.authentication as any).refreshCredentials();
+          }, 1);
+        } else {
+          return Promise.reject(e);
+        }
+      });
 }

packages/arcgis-rest-request/src/utils/IRequestOptions.ts

@@ -62,4 +62,19 @@ export interface IRequestOptions {
    * Suppress any ArcGIS REST JS related warnings for this request.
    */
   suppressWarnings?: boolean;
+
+  /**
+   * Override the default function for making the request. This is mainly useful for testing purposes (i.e. so you can pass in a spy).
+   * @param requestOptions
+   * @returns
+   */
+  request?: (
+    url: string,
+    requestOptions: InternalRequestOptions
+  ) => Promise<any>;
 }
+
+/**
+ * Options for the function that will be making the actual request.
+ */
+export type InternalRequestOptions = Omit<IRequestOptions, "request">;

packages/arcgis-rest-request/src/utils/append-custom-params.ts

@@ -23,7 +23,8 @@ export function appendCustomParams<T extends IRequestOptions>(
     "maxUrlLength",
     "headers",
     "signal",
-    "suppressWarnings"
+    "suppressWarnings",
+    "request"
   ];
 
   const options: T = {

packages/arcgis-rest-request/test/request.test.ts

@@ -779,4 +779,25 @@ describe("request()", () => {
       });
     });
   });
+
+  it("should use a passed in request function", (done) => {
+    const url =
+      "https://www.arcgis.com/sharing/rest/content/items/43a8e51789044d9480a20089a84129ad/data";
+    const options = {
+      httpMethod: "GET",
+      params: { f: "text" }
+    } as const;
+    const requestSpy = jasmine
+      .createSpy()
+      .and.returnValue(Promise.resolve(WebMapAsText));
+    request(url, { ...options, request: requestSpy })
+      .then(() => {
+        expect(requestSpy.calls.count()).toBe(1);
+        expect(requestSpy.calls.argsFor(0)).toEqual([url, options]);
+        done();
+      })
+      .catch((e) => {
+        fail(e);
+      });
+  });
 });