Check workflow version is valid before publishing

twentyhq · Aug 20, 2024 · a7b6aaa · a7b6aaa
1 parent db54469
commit a7b6aaa
Show file tree

Hide file tree

Showing 4 changed files with 72 additions and 10 deletions.
diff --git a/...engine/core-modules/workflow/utils/workflow-trigger-graphql-api-exception-handler.util.ts b/...engine/core-modules/workflow/utils/workflow-trigger-graphql-api-exception-handler.util.ts
@@ -11,10 +11,10 @@ export const workflowTriggerGraphqlApiExceptionHandler = (error: Error) => {
   if (error instanceof WorkflowTriggerException) {
     switch (error.code) {
       case WorkflowTriggerExceptionCode.INVALID_INPUT:
-        throw new UserInputError(error.message);
       case WorkflowTriggerExceptionCode.INVALID_WORKFLOW_TRIGGER:
       case WorkflowTriggerExceptionCode.INVALID_WORKFLOW_VERSION:
       case WorkflowTriggerExceptionCode.INVALID_ACTION_TYPE:
+        throw new UserInputError(error.message);
       default:
         throw new InternalServerError(error.message);
     }

diff --git a/packages/twenty-server/src/modules/workflow/common/workflow-common.workspace-service.ts b/packages/twenty-server/src/modules/workflow/common/workflow-common.workspace-service.ts
@@ -35,7 +35,7 @@ export class WorkflowCommonWorkspaceService {
       );
     }
 
-    if (!workflowVersion.trigger || !workflowVersion.trigger?.type) {
+    if (!workflowVersion.trigger) {
       throw new WorkflowTriggerException(
         'Workflow version does not contains trigger',
         WorkflowTriggerExceptionCode.INVALID_WORKFLOW_VERSION,

diff --git a/...ty-server/src/modules/workflow/workflow-trigger/utils/assert-workflow-version-is-valid.ts b/...ty-server/src/modules/workflow/workflow-trigger/utils/assert-workflow-version-is-valid.ts
@@ -0,0 +1,66 @@
+import { WorkflowVersionWorkspaceEntity } from 'src/modules/workflow/common/standard-objects/workflow-version.workspace-entity';
+import {
+  WorkflowTrigger,
+  WorkflowTriggerType,
+} from 'src/modules/workflow/common/types/workflow-trigger.type';
+import {
+  WorkflowTriggerException,
+  WorkflowTriggerExceptionCode,
+} from 'src/modules/workflow/workflow-trigger/workflow-trigger.exception';
+
+export function assertWorkflowVersionIsValid(
+  workflowVersion: Omit<WorkflowVersionWorkspaceEntity, 'trigger'> & {
+    trigger: WorkflowTrigger;
+  },
+) {
+  if (!workflowVersion.trigger) {
+    throw new WorkflowTriggerException(
+      'Workflow version does not contains trigger',
+      WorkflowTriggerExceptionCode.INVALID_WORKFLOW_VERSION,
+    );
+  }
+
+  if (!workflowVersion.trigger.type) {
+    throw new WorkflowTriggerException(
+      'No trigger type provided',
+      WorkflowTriggerExceptionCode.INVALID_WORKFLOW_TRIGGER,
+    );
+  }
+
+  if (!workflowVersion.trigger.nextAction) {
+    throw new WorkflowTriggerException(
+      'No next action provided in database event trigger',
+      WorkflowTriggerExceptionCode.INVALID_WORKFLOW_TRIGGER,
+    );
+  }
+
+  assertTriggerSettingsAreValid(
+    workflowVersion.trigger.type,
+    workflowVersion.trigger.settings,
+  );
+}
+
+function assertTriggerSettingsAreValid(
+  triggerType: WorkflowTriggerType,
+  settings: any,
+) {
+  switch (triggerType) {
+    case WorkflowTriggerType.DATABASE_EVENT:
+      assertDatabaseEventTriggerSettingsAreValid(settings);
+      break;
+    default:
+      throw new WorkflowTriggerException(
+        'Invalid trigger type for enabling workflow trigger',
+        WorkflowTriggerExceptionCode.INVALID_WORKFLOW_TRIGGER,
+      );
+  }
+}
+
+function assertDatabaseEventTriggerSettingsAreValid(settings: any) {
+  if (!settings?.eventName) {
+    throw new WorkflowTriggerException(
+      'No event name provided in database event trigger',
+      WorkflowTriggerExceptionCode.INVALID_WORKFLOW_TRIGGER,
+    );
+  }
+}
diff --git a/...twenty-server/src/modules/workflow/workflow-trigger/workflow-trigger.workspace-service.ts b/...twenty-server/src/modules/workflow/workflow-trigger/workflow-trigger.workspace-service.ts
@@ -9,6 +9,7 @@ import {
 } from 'src/modules/workflow/common/types/workflow-trigger.type';
 import { WorkflowCommonWorkspaceService } from 'src/modules/workflow/common/workflow-common.workspace-service';
 import { WorkflowRunnerWorkspaceService } from 'src/modules/workflow/workflow-runner/workflow-runner.workspace-service';
+import { assertWorkflowVersionIsValid } from 'src/modules/workflow/workflow-trigger/utils/assert-workflow-version-is-valid';
 import {
   WorkflowTriggerException,
   WorkflowTriggerExceptionCode,
@@ -47,6 +48,8 @@ export class WorkflowTriggerWorkspaceService {
         workflowVersionId,
       );
 
+    assertWorkflowVersionIsValid(workflowVersion);
+
     switch (workflowVersion.trigger.type) {
       case WorkflowTriggerType.DATABASE_EVENT:
         await this.upsertEventListenerAndPublishVersion(
@@ -67,14 +70,7 @@ export class WorkflowTriggerWorkspaceService {
     workflowVersionId: string,
     trigger: WorkflowDatabaseEventTrigger,
   ) {
-    const eventName = trigger?.settings?.eventName;
-
-    if (!eventName) {
-      throw new WorkflowTriggerException(
-        'No event name provided in database event trigger',
-        WorkflowTriggerExceptionCode.INVALID_WORKFLOW_TRIGGER,
-      );
-    }
+    const eventName = trigger.settings.eventName;
 
     const workflowEventListenerRepository =
       await this.twentyORMManager.getRepository<WorkflowEventListenerWorkspaceEntity>(