feat: add raise_error option to API requests for better error handling

Author: ruturaj-browserstack

src/lib/api.ts

@@ -19,6 +19,7 @@ export async function getLatestO11YBuildInfo(
     headers: {
       Authorization: `Basic ${auth}`,
     },
+    raise_error: false,
   });
 
   if (!buildsResponse.ok) {

src/lib/apiClient.ts

@@ -5,6 +5,7 @@ type RequestOptions = {
   headers?: Record<string, string>;
   params?: Record<string, string | number>;
   body?: any;
+  raise_error?: boolean; // default: true
 };
 
 class ApiResponse<T = any> {
@@ -56,61 +57,79 @@ class ApiResponse<T = any> {
 class ApiClient {
   private instance = axios.create();
 
+  private async requestWrapper<T>(
+    fn: () => Promise<AxiosResponse<T>>,
+    raise_error: boolean = true,
+  ): Promise<ApiResponse<T>> {
+    try {
+      const res = await fn();
+      return new ApiResponse<T>(res);
+    } catch (error: any) {
+      if (error.response && !raise_error) {
+        return new ApiResponse<T>(error.response);
+      }
+      throw error;
+    }
+  }
+
   async get<T = any>({
     url,
     headers,
     params,
+    raise_error = true,
   }: RequestOptions): Promise<ApiResponse<T>> {
-    const res = await this.instance.get<T>(url, {
-      headers,
-      params,
-    });
-    return new ApiResponse<T>(res);
+    return this.requestWrapper<T>(
+      () => this.instance.get<T>(url, { headers, params }),
+      raise_error,
+    );
   }
 
   async post<T = any>({
     url,
     headers,
     body,
+    raise_error = true,
   }: RequestOptions): Promise<ApiResponse<T>> {
-    const res = await this.instance.post<T>(url, body, {
-      headers,
-    });
-    return new ApiResponse<T>(res);
+    return this.requestWrapper<T>(
+      () => this.instance.post<T>(url, body, { headers }),
+      raise_error,
+    );
   }
 
   async put<T = any>({
     url,
     headers,
     body,
+    raise_error = true,
   }: RequestOptions): Promise<ApiResponse<T>> {
-    const res = await this.instance.put<T>(url, body, {
-      headers,
-    });
-    return new ApiResponse<T>(res);
+    return this.requestWrapper<T>(
+      () => this.instance.put<T>(url, body, { headers }),
+      raise_error,
+    );
   }
 
   async patch<T = any>({
     url,
     headers,
     body,
+    raise_error = true,
   }: RequestOptions): Promise<ApiResponse<T>> {
-    const res = await this.instance.patch<T>(url, body, {
-      headers,
-    });
-    return new ApiResponse<T>(res);
+    return this.requestWrapper<T>(
+      () => this.instance.patch<T>(url, body, { headers }),
+      raise_error,
+    );
   }
 
   async delete<T = any>({
     url,
     headers,
     params,
+    raise_error = true,
   }: RequestOptions): Promise<ApiResponse<T>> {
-    const res = await this.instance.delete<T>(url, {
-      headers,
-      params,
-    });
-    return new ApiResponse<T>(res);
+    return this.requestWrapper<T>(
+      () => this.instance.delete<T>(url, { headers, params }),
+      raise_error,
+    );
   }
 }
 

src/lib/device-cache.ts

@@ -49,7 +49,7 @@ export async function getDevicesAndBrowsers(
     }
   }
 
-  const liveRes = await apiClient.get({ url: URLS[type] });
+  const liveRes = await apiClient.get({ url: URLS[type], raise_error: false });
 
   if (!liveRes.ok) {
     throw new Error(

src/tools/accessiblity-utils/accessibility-rag.ts

@@ -33,6 +33,7 @@ export async function queryAccessibilityRAG(
     body: {
       query: userQuery,
     },
+    raise_error: false,
   });
 
   if (!response.ok) {

src/tools/failurelogs-utils/app-automate.ts

@@ -19,6 +19,7 @@ export async function retrieveDeviceLogs(
       "Content-Type": "application/json",
       Authorization: `Basic ${auth}`,
     },
+    raise_error: false,
   });
 
   const validationError = validateLogResponse(response, "device logs");
@@ -50,6 +51,7 @@ export async function retrieveAppiumLogs(
       "Content-Type": "application/json",
       Authorization: `Basic ${auth}`,
     },
+    raise_error: false,
   });
 
   const validationError = validateLogResponse(response, "Appium logs");
@@ -81,6 +83,7 @@ export async function retrieveCrashLogs(
       "Content-Type": "application/json",
       Authorization: `Basic ${auth}`,
     },
+    raise_error: false,
   });
 
   const validationError = validateLogResponse(response, "crash logs");

src/tools/failurelogs-utils/automate.ts

@@ -23,6 +23,7 @@ export async function retrieveNetworkFailures(
       "Content-Type": "application/json",
       Authorization: `Basic ${auth}`,
     },
+    raise_error: false,
   });
 
   const validationError = validateLogResponse(response, "network logs");
@@ -74,6 +75,7 @@ export async function retrieveSessionFailures(
       "Content-Type": "application/json",
       Authorization: `Basic ${auth}`,
     },
+    raise_error: false,
   });
 
   const validationError = validateLogResponse(response, "session logs");
@@ -104,6 +106,7 @@ export async function retrieveConsoleFailures(
       "Content-Type": "application/json",
       Authorization: `Basic ${auth}`,
     },
+    raise_error: false,
   });
 
   const validationError = validateLogResponse(response, "console logs");

src/tools/failurelogs-utils/utils.ts

@@ -1,3 +1,5 @@
+import type { ApiResponse } from "../../lib/apiClient.js";
+
 export interface LogResponse {
   logs?: any[];
   message?: string;
@@ -25,7 +27,6 @@ export interface HarEntry {
   time?: number;
 }
 
-import type { ApiResponse } from "../../lib/apiClient.js";
 export function validateLogResponse(
   response: Response | ApiResponse,
   logType: string,