feat(javascript): add error to APIError if possible (#1234)

Author: millotp

clients/algoliasearch-client-javascript/bundlesize.config.json

@@ -2,47 +2,47 @@
   "files": [
     {
       "path": "packages/algoliasearch/dist/algoliasearch.umd.js",
-      "maxSize": "7.80KB"
+      "maxSize": "8.00KB"
     },
     {
       "path": "packages/algoliasearch/dist/lite/lite.umd.js",
-      "maxSize": "3.50KB"
+      "maxSize": "3.70KB"
     },
     {
       "path": "packages/client-abtesting/dist/client-abtesting.umd.js",
-      "maxSize": "3.65KB"
+      "maxSize": "3.85KB"
     },
     {
       "path": "packages/client-analytics/dist/client-analytics.umd.js",
-      "maxSize": "4.30KB"
+      "maxSize": "4.50KB"
     },
     {
       "path": "packages/client-insights/dist/client-insights.umd.js",
-      "maxSize": "3.50KB"
+      "maxSize": "3.65KB"
     },
     {
       "path": "packages/client-personalization/dist/client-personalization.umd.js",
-      "maxSize": "3.60KB"
+      "maxSize": "3.80KB"
     },
     {
       "path": "packages/client-query-suggestions/dist/client-query-suggestions.umd.js",
-      "maxSize": "3.70KB"
+      "maxSize": "3.85KB"
     },
     {
       "path": "packages/client-search/dist/client-search.umd.js",
-      "maxSize": "6.35KB"
+      "maxSize": "6.55KB"
     },
     {
       "path": "packages/ingestion/dist/ingestion.umd.js",
-      "maxSize": "3.50KB"
+      "maxSize": "4.30KB"
     },
     {
       "path": "packages/predict/dist/predict.umd.js",
-      "maxSize": "3.50KB"
+      "maxSize": "4.20KB"
     },
     {
       "path": "packages/recommend/dist/recommend.umd.js",
-      "maxSize": "3.50KB"
+      "maxSize": "3.70KB"
     }
   ]
 }

clients/algoliasearch-client-javascript/packages/client-common/src/transporter/errors.ts

@@ -35,8 +35,13 @@ export class RetryError extends ErrorWithStackTrace {
 export class ApiError extends ErrorWithStackTrace {
   status: number;
 
-  constructor(message: string, status: number, stackTrace: StackFrame[]) {
-    super(message, stackTrace, 'ApiError');
+  constructor(
+    message: string,
+    status: number,
+    stackTrace: StackFrame[],
+    name = 'ApiError'
+  ) {
+    super(message, stackTrace, name);
     this.status = status;
   }
 }
@@ -49,3 +54,34 @@ export class DeserializationError extends AlgoliaError {
     this.response = response;
   }
 }
+
+export type DetailedErrorWithMessage = {
+  message: string;
+  label: string;
+};
+
+export type DetailedErrorWithTypeID = {
+  id: string;
+  type: string;
+  name?: string;
+};
+
+export type DetailedError = {
+  code: string;
+  details?: DetailedErrorWithMessage[] | DetailedErrorWithTypeID[];
+};
+
+// DetailedApiError is only used by the ingestion client to return more informative error, other clients will use ApiClient.
+export class DetailedApiError extends ApiError {
+  error: DetailedError;
+
+  constructor(
+    message: string,
+    status: number,
+    error: DetailedError,
+    stackTrace: StackFrame[]
+  ) {
+    super(message, status, stackTrace, 'DetailedApiError');
+    this.error = error;
+  }
+}

clients/algoliasearch-client-javascript/packages/client-common/src/transporter/helpers.ts

@@ -8,7 +8,7 @@ import type {
   StackFrame,
 } from '../types';
 
-import { ApiError, DeserializationError } from './errors';
+import { ApiError, DeserializationError, DetailedApiError } from './errors';
 
 export function shuffle<TData>(array: TData[]): TData[] {
   const shuffledArray = array;
@@ -109,11 +109,19 @@ export function deserializeFailure(
   { content, status }: Response,
   stackFrame: StackFrame[]
 ): Error {
-  let message = content;
   try {
-    message = JSON.parse(content).message;
+    const parsed = JSON.parse(content);
+    if ('error' in parsed) {
+      return new DetailedApiError(
+        parsed.message,
+        status,
+        parsed.error,
+        stackFrame
+      );
+    }
+    return new ApiError(parsed.message, status, stackFrame);
   } catch (e) {
     // ..
   }
-  return new ApiError(message, status, stackFrame);
+  return new ApiError(content, status, stackFrame);
 }