[connectors] Cast known Zendesk errors (#8917)

* add a few error types and checks * add `ZendeskCastKnownErrorsInterceptor` * add the interceptor to the worker * fix: remove redundant checks for known errors * fix: fix the error type of expired cursor errors
dust-tt · Nov 26, 2024 · 5406742 · 5406742
1 parent 237ee4f
commit 5406742
Show file tree

Hide file tree

Showing 6 changed files with 87 additions and 50 deletions.
diff --git a/connectors/src/connectors/zendesk/lib/errors.ts b/connectors/src/connectors/zendesk/lib/errors.ts
@@ -7,6 +7,11 @@ interface NodeZendeskError extends Error {
   result: string | null;
 }
 
+interface ZendeskApiError extends Error {
+  status: number;
+  description: string | null;
+}
+
 export function isNodeZendeskForbiddenError(
   err: unknown
 ): err is NodeZendeskError {
@@ -17,3 +22,26 @@ export function isNodeZendeskForbiddenError(
     err.statusCode === 403
   );
 }
+
+export function isZendeskExpiredCursorError(
+  err: unknown
+): err is ZendeskApiError {
+  return (
+    typeof err === "object" &&
+    err !== null &&
+    "status" in err &&
+    err.status === 422 &&
+    "description" in err &&
+    typeof err.description === "string" &&
+    err.description.includes("Invalid search: cursor has expired")
+  );
+}
+
+export function isZendeskEpipeError(err: unknown): err is NodeZendeskError {
+  return (
+    typeof err === "object" &&
+    err !== null &&
+    "code" in err &&
+    err.code === "EPIPE"
+  );
+}
diff --git a/connectors/src/connectors/zendesk/lib/zendesk_api.ts b/connectors/src/connectors/zendesk/lib/zendesk_api.ts
@@ -5,11 +5,9 @@ import { createClient } from "node-zendesk";
 import type {
   ZendeskFetchedArticle,
   ZendeskFetchedCategory,
-  ZendeskFetchedSection,
   ZendeskFetchedTicket,
   ZendeskFetchedUser,
 } from "@connectors/@types/node-zendesk";
-import { isNodeZendeskForbiddenError } from "@connectors/connectors/zendesk/lib/errors";
 import { ExternalOAuthTokenError } from "@connectors/lib/error";
 import logger from "@connectors/logger/logger";
 import type { ZendeskCategoryResource } from "@connectors/resources/zendesk_resources";
@@ -365,30 +363,3 @@ export async function fetchZendeskCurrentUser({
   const data = await response.json();
   return data.user;
 }
-
-/**
- * Fetches the Section and the User for an article.
- */
-export async function fetchArticleMetadata(
-  zendeskApiClient: Client,
-  article: ZendeskFetchedArticle
-): Promise<{ section: ZendeskFetchedSection; user: ZendeskFetchedUser }> {
-  try {
-    const { result: section } = await zendeskApiClient.helpcenter.sections.show(
-      article.section_id
-    );
-    const { result: user } = await zendeskApiClient.users.show(
-      article.author_id
-    );
-    return { section, user };
-  } catch (e) {
-    logger.error(
-      { articleId: article.id, error: e },
-      "[Zendesk] Error fetching article metadata"
-    );
-    if (isNodeZendeskForbiddenError(e)) {
-      throw new ExternalOAuthTokenError(e);
-    }
-    throw e;
-  }
-}
diff --git a/connectors/src/connectors/zendesk/temporal/activities.ts b/connectors/src/connectors/zendesk/temporal/activities.ts
@@ -1,7 +1,6 @@
 import type { ModelId } from "@dust-tt/types";
 import _ from "lodash";
 
-import { isNodeZendeskForbiddenError } from "@connectors/connectors/zendesk/lib/errors";
 import { syncArticle } from "@connectors/connectors/zendesk/lib/sync_article";
 import { syncCategory } from "@connectors/connectors/zendesk/lib/sync_category";
 import { syncTicket } from "@connectors/connectors/zendesk/lib/sync_ticket";
@@ -16,7 +15,6 @@ import {
 import { ZENDESK_BATCH_SIZE } from "@connectors/connectors/zendesk/temporal/config";
 import { dataSourceConfigFromConnector } from "@connectors/lib/api/data_source_config";
 import { concurrentExecutor } from "@connectors/lib/async_utils";
-import { ExternalOAuthTokenError } from "@connectors/lib/error";
 import { ZendeskTimestampCursor } from "@connectors/lib/models/zendesk";
 import { syncStarted, syncSucceeded } from "@connectors/lib/sync_status";
 import { heartbeat } from "@connectors/lib/temporal";
@@ -333,21 +331,11 @@ export async function syncZendeskArticleBatchActivity({
     `[Zendesk] Processing ${articles.length} articles in batch`
   );
 
-  let sections;
-  let users;
-  try {
-    sections =
-      await zendeskApiClient.helpcenter.sections.listByCategory(categoryId);
-    const { result: usersResult } = await zendeskApiClient.users.showMany(
-      articles.map((article) => article.author_id)
-    );
-    users = usersResult;
-  } catch (e) {
-    if (isNodeZendeskForbiddenError(e)) {
-      throw new ExternalOAuthTokenError(e);
-    }
-    throw e;
-  }
+  const sections =
+    await zendeskApiClient.helpcenter.sections.listByCategory(categoryId);
+  const { result: users } = await zendeskApiClient.users.showMany(
+    articles.map((article) => article.author_id)
+  );
 
   await concurrentExecutor(
     articles,

diff --git a/connectors/src/connectors/zendesk/temporal/cast_known_errors.ts b/connectors/src/connectors/zendesk/temporal/cast_known_errors.ts
@@ -0,0 +1,48 @@
+import type {
+  ActivityExecuteInput,
+  ActivityInboundCallsInterceptor,
+  Next,
+} from "@temporalio/worker";
+
+import {
+  isNodeZendeskForbiddenError,
+  isZendeskEpipeError,
+  isZendeskExpiredCursorError,
+} from "@connectors/connectors/zendesk/lib/errors";
+import {
+  DustConnectorWorkflowError,
+  ExternalOAuthTokenError,
+  ProviderWorkflowError,
+} from "@connectors/lib/error";
+
+export class ZendeskCastKnownErrorsInterceptor
+  implements ActivityInboundCallsInterceptor
+{
+  async execute(
+    input: ActivityExecuteInput,
+    next: Next<ActivityInboundCallsInterceptor, "execute">
+  ): Promise<unknown> {
+    try {
+      return await next(input);
+    } catch (err: unknown) {
+      if (isNodeZendeskForbiddenError(err)) {
+        throw new ExternalOAuthTokenError(err);
+      } else if (isZendeskExpiredCursorError(err)) {
+        throw new DustConnectorWorkflowError(
+          "Cursor expired",
+          "unhandled_internal_activity_error",
+          err
+        );
+      } else if (isZendeskEpipeError(err)) {
+        throw new ProviderWorkflowError(
+          "zendesk",
+          "EPIPE",
+          "transient_upstream_activity_error",
+          err
+        );
+      }
+
+      throw err;
+    }
+  }
+}
diff --git a/connectors/src/connectors/zendesk/temporal/incremental_activities.ts b/connectors/src/connectors/zendesk/temporal/incremental_activities.ts
@@ -9,7 +9,6 @@ import { getZendeskSubdomainAndAccessToken } from "@connectors/connectors/zendes
 import {
   changeZendeskClientSubdomain,
   createZendeskClient,
-  fetchArticleMetadata,
   fetchRecentlyUpdatedArticles,
   fetchRecentlyUpdatedTickets,
 } from "@connectors/connectors/zendesk/lib/zendesk_api";
@@ -113,9 +112,10 @@ export async function syncZendeskArticleUpdateBatchActivity({
   await concurrentExecutor(
     articles,
     async (article) => {
-      const { section, user } = await fetchArticleMetadata(
-        zendeskApiClient,
-        article
+      const { result: section } =
+        await zendeskApiClient.helpcenter.sections.show(article.section_id);
+      const { result: user } = await zendeskApiClient.users.show(
+        article.author_id
       );
 
       if (section.category_id) {

diff --git a/connectors/src/connectors/zendesk/temporal/worker.ts b/connectors/src/connectors/zendesk/temporal/worker.ts
@@ -2,6 +2,7 @@ import type { Context } from "@temporalio/activity";
 import { Worker } from "@temporalio/worker";
 import TsconfigPathsPlugin from "tsconfig-paths-webpack-plugin";
 
+import { ZendeskCastKnownErrorsInterceptor } from "@connectors/connectors/zendesk/temporal/cast_known_errors";
 import { getTemporalWorkerConnection } from "@connectors/lib/temporal";
 import { ActivityInboundLogInterceptor } from "@connectors/lib/temporal_monitoring";
 import logger from "@connectors/logger/logger";
@@ -26,6 +27,7 @@ export async function runZendeskWorkers() {
         (ctx: Context) => {
           return new ActivityInboundLogInterceptor(ctx, logger);
         },
+        () => new ZendeskCastKnownErrorsInterceptor(),
       ],
     },
     bundlerOptions: {