connectors API: improve error handling (#3443)

* connectors API: improve error handling

* iterate on types

* re-align types

* WithConnectorsAPIErrorResponse

* move auth.ts to apiError

* lint

* nit

* fix typo

* nit typeguard

connectors/src/api/connector_config.ts

@@ -1,3 +1,4 @@
+import type { WithConnectorsAPIErrorReponse } from "@dust-tt/types";
 import type { Request, Response } from "express";
 import { isLeft } from "fp-ts/lib/Either";
 import * as t from "io-ts";
@@ -9,16 +10,17 @@ import {
 } from "@connectors/connectors";
 import { Connector } from "@connectors/lib/models";
 import { apiError, withLogging } from "@connectors/logger/withlogging";
-import type { ConnectorsAPIErrorResponse } from "@connectors/types/errors";
 
 const ConfigSetReqBodySchema = t.type({
   configValue: t.string,
 });
 type ConfigSetReqBody = t.TypeOf<typeof ConfigSetReqBodySchema>;
 
-type ConfigGetResBody =
-  | { connectorId: number; configKey: string; configValue: string }
-  | ConnectorsAPIErrorResponse;
+type ConfigGetResBody = WithConnectorsAPIErrorReponse<{
+  connectorId: number;
+  configKey: string;
+  configValue: string;
+}>;
 
 const _getConnectorConfig = async (
   req: Request<{ connector_id: string; config_key: string }>,

connectors/src/api/create_connector.ts

@@ -4,6 +4,7 @@ import type {
   CreateConnectorOAuthRequestBodySchema,
   CreateConnectorUrlRequestBodySchema,
   Result,
+  WithConnectorsAPIErrorReponse,
 } from "@dust-tt/types";
 import {
   assertNever,
@@ -24,9 +25,8 @@ import { errorFromAny } from "@connectors/lib/error";
 import { Connector } from "@connectors/lib/models";
 import logger from "@connectors/logger/logger";
 import { apiError, withLogging } from "@connectors/logger/withlogging";
-import type { ConnectorsAPIErrorResponse } from "@connectors/types/errors";
 
-type ConnectorCreateResBody = ConnectorType | ConnectorsAPIErrorResponse;
+type ConnectorCreateResBody = WithConnectorsAPIErrorReponse<ConnectorType>;
 
 const provider2createConnectorType: Record<ConnectorProvider, "oauth" | "url"> =
   {

connectors/src/api/delete_connector.ts

@@ -1,3 +1,4 @@
+import type { WithConnectorsAPIErrorReponse } from "@dust-tt/types";
 import type { Request, Response } from "express";
 
 import {
@@ -7,14 +8,13 @@ import {
 import { Connector } from "@connectors/lib/models";
 import { terminateAllWorkflowsForConnectorId } from "@connectors/lib/temporal";
 import { apiError, withLogging } from "@connectors/logger/withlogging";
-import type { ConnectorsAPIErrorResponse } from "@connectors/types/errors";
 
 type ConnectorDeleteReqBody = {
   dataSourceName: string;
   workspaceId: string;
 };
 
-type ConnectorDeleteResBody = { success: true } | ConnectorsAPIErrorResponse;
+type ConnectorDeleteResBody = WithConnectorsAPIErrorReponse<{ success: true }>;
 
 const _deleteConnectorAPIHandler = async (
   req: Request<

connectors/src/api/get_connector.ts

@@ -1,13 +1,15 @@
-import type { ConnectorType } from "@dust-tt/types";
+import type {
+  ConnectorType,
+  WithConnectorsAPIErrorReponse,
+} from "@dust-tt/types";
 import type { Request, Response } from "express";
 
 import { Connector } from "@connectors/lib/models";
 import { GithubDiscussion, GithubIssue } from "@connectors/lib/models/github";
 import { NotionPage } from "@connectors/lib/models/notion";
 import { apiError, withLogging } from "@connectors/logger/withlogging";
-import type { ConnectorsAPIErrorResponse } from "@connectors/types/errors";
 
-type GetConnectorRes = ConnectorType | ConnectorsAPIErrorResponse;
+type GetConnectorRes = WithConnectorsAPIErrorReponse<ConnectorType>;
 
 const _getConnector = async (
   req: Request<{ connector_id: string }, GetConnectorRes, undefined>,

connectors/src/api/get_connector_permissions.ts

@@ -1,17 +1,17 @@
+import type { WithConnectorsAPIErrorReponse } from "@dust-tt/types";
 import type { Request, Response } from "express";
 
 import { RETRIEVE_CONNECTOR_PERMISSIONS_BY_TYPE } from "@connectors/connectors";
 import { Connector } from "@connectors/lib/models";
 import { apiError, withLogging } from "@connectors/logger/withlogging";
-import type { ConnectorsAPIErrorResponse } from "@connectors/types/errors";
 import type {
   ConnectorPermission,
   ConnectorResource,
 } from "@connectors/types/resources";
 
-type GetConnectorPermissionsRes =
-  | { resources: ConnectorResource[] }
-  | ConnectorsAPIErrorResponse;
+type GetConnectorPermissionsRes = WithConnectorsAPIErrorReponse<{
+  resources: ConnectorResource[];
+}>;
 
 const _getConnectorPermissions = async (
   req: Request<{ connector_id: string }, GetConnectorPermissionsRes, undefined>,

connectors/src/api/get_resources_parents.ts

@@ -1,3 +1,4 @@
+import type { WithConnectorsAPIErrorReponse } from "@dust-tt/types";
 import type { Request, Response } from "express";
 import { zip } from "fp-ts/lib/Array";
 import { isLeft } from "fp-ts/lib/Either";
@@ -17,12 +18,12 @@ export type GetResourcesParentsRequestBody = t.TypeOf<
   typeof GetResourcesParentsRequestBodySchema
 >;
 
-type GetResourcesParentsResponseBody = {
+type GetResourcesParentsResponseBody = WithConnectorsAPIErrorReponse<{
   resources: {
     internalId: string;
     parents: string[] | null;
   }[];
-};
+}>;
 
 const _getResourcesParents = async (
   req: Request<

connectors/src/api/get_resources_titles.ts

@@ -1,3 +1,4 @@
+import type { WithConnectorsAPIErrorReponse } from "@dust-tt/types";
 import type { Request, Response } from "express";
 import { isLeft } from "fp-ts/lib/Either";
 import * as t from "io-ts";
@@ -15,12 +16,12 @@ type GetResourcesTitlesRequestBody = t.TypeOf<
   typeof GetResourcesTitlesRequestBodySchema
 >;
 
-type GetResourcesTitlesResponseBody = {
+type GetResourcesTitlesResponseBody = WithConnectorsAPIErrorReponse<{
   resources: {
     internalId: string;
     title: string | null;
   }[];
-};
+}>;
 
 const _getResourcesTitles = async (
   req: Request<

connectors/src/api/resume_connector.ts

@@ -1,15 +1,15 @@
+import type { WithConnectorsAPIErrorReponse } from "@dust-tt/types";
 import type { Request, Response } from "express";
 
 import { RESUME_CONNECTOR_BY_TYPE } from "@connectors/connectors";
 import { errorFromAny } from "@connectors/lib/error";
 import { Connector } from "@connectors/lib/models";
 import logger from "@connectors/logger/logger";
 import { apiError, withLogging } from "@connectors/logger/withlogging";
-import type { ConnectorsAPIErrorResponse } from "@connectors/types/errors";
 
-type ConnectorResumeResBody =
-  | { connectorId: string }
-  | ConnectorsAPIErrorResponse;
+type ConnectorResumeResBody = WithConnectorsAPIErrorReponse<{
+  connectorId: string;
+}>;
 
 const _resumeConnectorAPIHandler = async (
   req: Request<{ connector_id: string }, ConnectorResumeResBody>,

connectors/src/api/set_connector_permissions.ts

@@ -1,3 +1,4 @@
+import type { WithConnectorsAPIErrorReponse } from "@dust-tt/types";
 import type { Request, Response } from "express";
 import { isLeft } from "fp-ts/lib/Either";
 import * as t from "io-ts";
@@ -6,11 +7,10 @@ import * as reporter from "io-ts-reporters";
 import { SET_CONNECTOR_PERMISSIONS_BY_TYPE } from "@connectors/connectors";
 import { Connector } from "@connectors/lib/models";
 import { apiError, withLogging } from "@connectors/logger/withlogging";
-import type { ConnectorsAPIErrorResponse } from "@connectors/types/errors";
 
-type SetConnectorPermissionsRes =
-  | { success: true }
-  | ConnectorsAPIErrorResponse;
+type SetConnectorPermissionsRes = WithConnectorsAPIErrorReponse<{
+  success: true;
+}>;
 
 const SetConnectorPermissionsRequestBodySchema = t.type({
   resources: t.array(

connectors/src/api/slack_channels_linked_with_agent.ts

@@ -1,3 +1,4 @@
+import type { WithConnectorsAPIErrorReponse } from "@dust-tt/types";
 import type { Request, Response } from "express";
 import { isLeft } from "fp-ts/lib/Either";
 import * as t from "io-ts";
@@ -6,7 +7,6 @@ import { Op } from "sequelize";
 
 import { joinChannel } from "@connectors/connectors/slack/lib/channels";
 import { getChannels } from "@connectors/connectors/slack/temporal/activities";
-import type { APIErrorWithStatusCode } from "@connectors/lib/error";
 import { sequelize_conn } from "@connectors/lib/models";
 import { SlackChannel } from "@connectors/lib/models/slack";
 import { apiError, withLogging } from "@connectors/logger/withlogging";
@@ -21,9 +21,9 @@ type PatchSlackChannelsLinkedWithAgentReqBody = t.TypeOf<
   typeof PatchSlackChannelsLinkedWithAgentReqBodySchema
 >;
 
-type PatchSlackChannelsLinkedWithAgentResBody =
-  | { success: true }
-  | APIErrorWithStatusCode;
+type PatchSlackChannelsLinkedWithAgentResBody = WithConnectorsAPIErrorReponse<{
+  success: true;
+}>;
 
 const _patchSlackChannelsLinkedWithAgentHandler = async (
   req: Request<
@@ -152,22 +152,16 @@ export const patchSlackChannelsLinkedWithAgentHandler = withLogging(
   _patchSlackChannelsLinkedWithAgentHandler
 );
 
-type GetSlackChannelsLinkedWithAgentResBody =
-  | {
-      slackChannels: {
-        slackChannelId: string;
-        slackChannelName: string;
-        agentConfigurationId: string;
-      }[];
-    }
-  | APIErrorWithStatusCode;
+type GetSlackChannelsLinkedWithAgentResBody = WithConnectorsAPIErrorReponse<{
+  slackChannels: {
+    slackChannelId: string;
+    slackChannelName: string;
+    agentConfigurationId: string;
+  }[];
+}>;
 
 const _getSlackChannelsLinkedWithAgentHandler = async (
-  req: Request<
-    Record<string, string>,
-    { slackChannelIds: string[] } | APIErrorWithStatusCode,
-    undefined
-  >,
+  req: Request<Record<string, string>>,
   res: Response<GetSlackChannelsLinkedWithAgentResBody>
 ) => {
   const { connector_id: connectorId } = req.query;

connectors/src/api/stop_connector.ts

@@ -1,15 +1,15 @@
+import type { WithConnectorsAPIErrorReponse } from "@dust-tt/types";
 import type { Request, Response } from "express";
 
 import { STOP_CONNECTOR_BY_TYPE } from "@connectors/connectors";
 import { errorFromAny } from "@connectors/lib/error";
 import { Connector } from "@connectors/lib/models";
 import logger from "@connectors/logger/logger";
 import { apiError, withLogging } from "@connectors/logger/withlogging";
-import type { ConnectorsAPIErrorResponse } from "@connectors/types/errors";
 
-type ConnectorStopResBody =
-  | { connectorId: string }
-  | ConnectorsAPIErrorResponse;
+type ConnectorStopResBody = WithConnectorsAPIErrorReponse<{
+  connectorId: string;
+}>;
 
 const _stopConnectorAPIHandler = async (
   req: Request<{ connector_id: string }, ConnectorStopResBody>,

connectors/src/api/sync_connector.ts

@@ -1,11 +1,11 @@
+import type { WithConnectorsAPIErrorReponse } from "@dust-tt/types";
 import type { Request, Response } from "express";
 
 import { SYNC_CONNECTOR_BY_TYPE } from "@connectors/connectors";
 import { Connector } from "@connectors/lib/models";
 import { withLogging } from "@connectors/logger/withlogging";
-import type { ConnectorsAPIErrorResponse } from "@connectors/types/errors";
 
-type GetSyncStatusRes = { workflowId: string } | ConnectorsAPIErrorResponse;
+type GetSyncStatusRes = WithConnectorsAPIErrorReponse<{ workflowId: string }>;
 
 const _syncConnectorAPIHandler = async (
   req: Request<{ connector_id: string }, GetSyncStatusRes, undefined>,
@@ -14,6 +14,7 @@ const _syncConnectorAPIHandler = async (
   if (!req.params.connector_id) {
     res.status(400).send({
       error: {
+        type: "invalid_request_error",
         message: `Missing required parameters. Required : connector_id`,
       },
     });
@@ -25,6 +26,7 @@ const _syncConnectorAPIHandler = async (
   if (!connector) {
     res.status(404).send({
       error: {
+        type: "connector_not_found",
         message: `Connector with id ${req.params.connector_id} not found`,
       },
     });
@@ -37,6 +39,7 @@ const _syncConnectorAPIHandler = async (
   if (launchRes.isErr()) {
     res.status(500).send({
       error: {
+        type: "internal_server_error",
         message: launchRes.error.message,
       },
     });

connectors/src/api/update_connector.ts

@@ -1,16 +1,16 @@
+import type { WithConnectorsAPIErrorReponse } from "@dust-tt/types";
 import type { Request, Response } from "express";
 
 import { UPDATE_CONNECTOR_BY_TYPE } from "@connectors/connectors";
 import { Connector } from "@connectors/lib/models";
 import { apiError, withLogging } from "@connectors/logger/withlogging";
-import type { ConnectorsAPIErrorResponse } from "@connectors/types/errors";
 
 type ConnectorUpdateReqBody = {
   connectionId?: string | null;
 };
-type ConnectorUpdateResBody =
-  | { connectorId: string }
-  | ConnectorsAPIErrorResponse;
+type ConnectorUpdateResBody = WithConnectorsAPIErrorReponse<{
+  connectorId: string;
+}>;
 
 const _getConnectorUpdateAPIHandler = async (
   req: Request<{ connector_id: string }, ConnectorUpdateReqBody>,
@@ -44,23 +44,17 @@ const _getConnectorUpdateAPIHandler = async (
   });
 
   if (updateRes.isErr()) {
-    const errorRes = updateRes as { error: ConnectorsAPIErrorResponse };
-    const error = errorRes.error.error;
-
-    if (error.type === "connector_oauth_target_mismatch") {
+    if (updateRes.error.type === "connector_oauth_target_mismatch") {
       return apiError(req, res, {
-        api_error: {
-          type: error.type,
-          message: error.message,
-        },
+        api_error: updateRes.error,
         status_code: 401,
       });
     } else {
       return apiError(req, res, {
         status_code: 500,
         api_error: {
           type: "internal_server_error",
-          message: `Could not update the connector: ${error.message}`,
+          message: `Could not update the connector: ${updateRes.error.message}`,
         },
       });
     }

connectors/src/api/webhooks/webhook_github.ts

@@ -1,3 +1,4 @@
+import type { WithConnectorsAPIErrorReponse } from "@dust-tt/types";
 import { assertNever } from "@dust-tt/types";
 import type { Request, Response } from "express";
 import { isLeft } from "fp-ts/lib/Either";
@@ -29,7 +30,6 @@ import {
 } from "@connectors/lib/models/github";
 import mainLogger from "@connectors/logger/logger";
 import { withLogging } from "@connectors/logger/withlogging";
-import type { ConnectorsAPIErrorResponse } from "@connectors/types/errors";
 
 const HANDLED_WEBHOOKS = {
   installation_repositories: new Set(["added", "removed"]),
@@ -42,7 +42,7 @@ const HANDLED_WEBHOOKS = {
 
 const logger = mainLogger.child({ provider: "github" });
 
-type GithubWebhookResBody = null | ConnectorsAPIErrorResponse;
+type GithubWebhookResBody = WithConnectorsAPIErrorReponse<null>;
 
 const _webhookGithubAPIHandler = async (
   req: Request<
@@ -59,6 +59,7 @@ const _webhookGithubAPIHandler = async (
   if (!event || typeof event !== "string") {
     return res.status(400).json({
       error: {
+        type: "invalid_request_error",
         message: "Missing `x-github-event` header",
       },
     });

connectors/src/api/webhooks/webhook_google_drive.ts

@@ -1,13 +1,13 @@
+import type { WithConnectorsAPIErrorReponse } from "@dust-tt/types";
 import { RateLimitError } from "@dust-tt/types";
 import type { Request, Response } from "express";
 
 import { launchGoogleDriveIncrementalSyncWorkflow } from "@connectors/connectors/google_drive/temporal/client";
-import type { APIErrorWithStatusCode } from "@connectors/lib/error";
 import { GoogleDriveWebhook } from "@connectors/lib/models/google_drive";
 import logger from "@connectors/logger/logger";
 import { apiError, withLogging } from "@connectors/logger/withlogging";
 
-type GoogleDriveWebhookResBody = null | APIErrorWithStatusCode;
+type GoogleDriveWebhookResBody = WithConnectorsAPIErrorReponse<null>;
 
 const _webhookGoogleDriveAPIHandler = async (
   req: Request<Record<string, string>, GoogleDriveWebhookResBody>,