CARTO: requestWithParameters to store received json response in Carto…

…APIError (#8920)
visgl · May 24, 2024 · a51fc69 · a51fc69
1 parent 8629f34
commit a51fc69
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 3 deletions.
diff --git a/modules/carto/src/api/carto-api-error.ts b/modules/carto/src/api/carto-api-error.ts
@@ -16,7 +16,15 @@ export class CartoAPIError extends Error {
   /** Response from server */
   response?: Response;
 
-  constructor(error: Error, errorContext: APIErrorContext, response?: Response) {
+  /** JSON Response from server */
+  responseJson?: any;
+
+  constructor(
+    error: Error,
+    errorContext: APIErrorContext,
+    response?: Response,
+    responseJson?: any
+  ) {
     let responseString = 'Failed to connect';
     if (response) {
       responseString = 'Server returned: ';
@@ -46,6 +54,7 @@ export class CartoAPIError extends Error {
 
     this.name = 'CartoAPIError';
     this.response = response;
+    this.responseJson = responseJson;
     this.error = error;
     this.errorContext = errorContext;
   }

diff --git a/modules/carto/src/api/request-with-parameters.ts b/modules/carto/src/api/request-with-parameters.ts
@@ -41,20 +41,22 @@ export async function requestWithParameters<T = any>({
       : fetch(url, {headers});
 
   let response: Response | undefined;
+  let responseJson;
   const jsonPromise: Promise<T> = fetchPromise
     .then((_response: Response) => {
       response = _response;
       return response.json();
     })
     .then((json: any) => {
+      responseJson = json;
       if (!response || !response.ok) {
         throw new Error(json.error);
       }
       return json;
     })
     .catch((error: Error) => {
       REQUEST_CACHE.delete(key);
-      throw new CartoAPIError(error, errorContext, response);
+      throw new CartoAPIError(error, errorContext, response, responseJson);
     });
 
   REQUEST_CACHE.set(key, jsonPromise);

diff --git a/test/modules/carto/api/request-with-parameters.spec.ts b/test/modules/carto/api/request-with-parameters.spec.ts
@@ -88,6 +88,12 @@ test('requestWithParameters#nocacheErrorContext', async t => {
         error2 = error as Error;
       }
 
+      t.deepEquals(
+        (error1 as CartoAPIError).responseJson,
+        {error: 'CustomError', customData: {abc: 'def'}},
+        'responseJson',
+        'propagates actual JSON error response '
+      );
       t.equals(calls.length, 2, '2 unique requests, failures not cached');
       t.true(error1 instanceof CartoAPIError, 'error #1 type');
       t.is((error1 as CartoAPIError).errorContext.requestType, 'Map data', 'error #1 context');
@@ -96,7 +102,10 @@ test('requestWithParameters#nocacheErrorContext', async t => {
     },
     // @ts-ignore
     (url: string, headers: HeadersInit) => {
-      return Promise.reject(new Error('404 Not Found'));
+      return Promise.resolve({
+        ok: false,
+        json: () => Promise.resolve({error: 'CustomError', customData: {abc: 'def'}})
+      });
     }
   );
   t.end();