fix(Zendesk) - improve error handling

connectors/src/connectors/zendesk/lib/errors.ts

@@ -46,6 +46,15 @@ export function isZendeskExpiredCursorError(
   );
 }
 
+/**
+ * Catches 404 errors that were already caught in fetchFromZendeskWithRetries and rethrown as ZendeskApiErrors.
+ * The idea is that we only try/catch the part where we call the API, without wrapping any of our code and from then
+ * only certain functions can actually handle 404 by returning a null.
+ */
+export function isZendeskNotFoundError(err: unknown): boolean {
+  return err instanceof ZendeskApiError && err.status === 404;
+}
+
 export function isNodeZendeskEpipeError(err: unknown): err is NodeZendeskError {
   return (
     typeof err === "object" &&

connectors/src/connectors/zendesk/lib/zendesk_api.ts

@@ -9,7 +9,10 @@ import type {
   ZendeskFetchedTicket,
   ZendeskFetchedUser,
 } from "@connectors/@types/node-zendesk";
-import { ZendeskApiError } from "@connectors/connectors/zendesk/lib/errors";
+import {
+  isZendeskNotFoundError,
+  ZendeskApiError,
+} from "@connectors/connectors/zendesk/lib/errors";
 import { setTimeoutAsync } from "@connectors/lib/async_utils";
 import logger from "@connectors/logger/logger";
 import type { ZendeskCategoryResource } from "@connectors/resources/zendesk_resources";
@@ -118,6 +121,7 @@ async function handleZendeskRateLimit(response: Response): Promise<boolean> {
 
 /**
  * Runs a GET request to the Zendesk API with a maximum number of retries before throwing.
+ * TODO(2024-12-20): add some basic io-ts validation here (pass a codec as argument and decode with it)
  */
 async function fetchFromZendeskWithRetries({
   url,
@@ -155,19 +159,13 @@ async function fetchFromZendeskWithRetries({
   try {
     response = await rawResponse.json();
   } catch (e) {
-    if (rawResponse.status === 404) {
-      return null;
-    }
     throw new ZendeskApiError(
       "Error parsing Zendesk API response",
       rawResponse.status,
       rawResponse
     );
   }
   if (!rawResponse.ok) {
-    if (rawResponse.status === 404) {
-      return null;
-    }
     throw new ZendeskApiError(
       "Zendesk API error.",
       rawResponse.status,
@@ -191,8 +189,15 @@ export async function fetchZendeskBrand({
   brandId: number;
 }): Promise<ZendeskFetchedBrand | null> {
   const url = `https://${subdomain}.zendesk.com/api/v2/brands/${brandId}`;
-  const response = await fetchFromZendeskWithRetries({ url, accessToken });
-  return response?.brand ?? null;
+  try {
+    const response = await fetchFromZendeskWithRetries({ url, accessToken });
+    return response?.brand ?? null;
+  } catch (e) {
+    if (isZendeskNotFoundError(e)) {
+      return null;
+    }
+    throw e;
+  }
 }
 
 /**
@@ -208,8 +213,15 @@ export async function fetchZendeskArticle({
   articleId: number;
 }): Promise<ZendeskFetchedArticle | null> {
   const url = `https://${brandSubdomain}.zendesk.com/api/v2/help_center/articles/${articleId}`;
-  const response = await fetchFromZendeskWithRetries({ url, accessToken });
-  return response?.article ?? null;
+  try {
+    const response = await fetchFromZendeskWithRetries({ url, accessToken });
+    return response?.article ?? null;
+  } catch (e) {
+    if (isZendeskNotFoundError(e)) {
+      return null;
+    }
+    throw e;
+  }
 }
 
 /**