Add system action executor

twentyhq · martmull · Sep 12, 2024 · Sep 9, 2024 · Sep 9, 2024 · Sep 10, 2024
commit 6339a4ebf91f0865ae99f0d7cc2c6b99f9cb5a6b
diff --git a/packages/twenty-server/src/modules/workflow/common/types/workflow-settings.type.ts b/packages/twenty-server/src/modules/workflow/common/types/workflow-settings.type.ts
@@ -1,3 +1,5 @@
+import { WorkflowSystemActionType } from 'src/modules/workflow/common/types/workflow-system-action.type';
+
 type BaseWorkflowSettings = {
   errorHandlingOptions: {
     retryOnFailure: {
@@ -12,3 +14,7 @@ type BaseWorkflowSettings = {
 export type WorkflowCodeSettings = BaseWorkflowSettings & {
   serverlessFunctionId: string;
 };
+
+export type WorkflowSystemActionSettings = BaseWorkflowSettings & {
+  systemActionType: WorkflowSystemActionType;
+};
diff --git a/...flow/common/types/workflow-result.type.ts → ...common/types/workflow-step-result.type.ts b/...flow/common/types/workflow-result.type.ts → ...common/types/workflow-step-result.type.ts
@@ -4,7 +4,7 @@ type WorkflowError = {
   stackTrace: string;
 };
 
-export type WorkflowResult = {
+export type WorkflowStepResult = {
   data: object | null;
   error?: WorkflowError;
 };
diff --git a/packages/twenty-server/src/modules/workflow/common/types/workflow-step.type.ts b/packages/twenty-server/src/modules/workflow/common/types/workflow-step.type.ts
@@ -1,7 +1,11 @@
-import { WorkflowCodeSettings } from 'src/modules/workflow/common/types/workflow-settings.type';
+import {
+  WorkflowCodeSettings,
+  WorkflowSystemActionSettings,
+} from 'src/modules/workflow/common/types/workflow-settings.type';
 
 export enum WorkflowStepType {
   CODE_ACTION = 'CODE_ACTION',
+  SYSTEM_ACTION = 'SYSTEM_ACTION',
 }
 
 type BaseWorkflowStep = {
@@ -15,4 +19,9 @@ export type WorkflowCodeStep = BaseWorkflowStep & {
   settings: WorkflowCodeSettings;
 };
 
-export type WorkflowStep = WorkflowCodeStep;
+export type WorkflowSystemStep = BaseWorkflowStep & {
+  type: WorkflowStepType.SYSTEM_ACTION;
+  settings: WorkflowSystemActionSettings;
+};
+
+export type WorkflowStep = WorkflowCodeStep | WorkflowSystemStep;
diff --git a/packages/twenty-server/src/modules/workflow/common/types/workflow-system-action.type.ts b/packages/twenty-server/src/modules/workflow/common/types/workflow-system-action.type.ts
@@ -0,0 +1,3 @@
+export enum WorkflowSystemActionType {
+  SEND_EMAIL = 'SEND_EMAIL',
+}
diff --git a/...enty-server/src/modules/workflow/workflow-step-executor/workflow-step-executor.factory.ts b/...enty-server/src/modules/workflow/workflow-step-executor/workflow-step-executor.factory.ts
@@ -7,15 +7,21 @@ import {
 } from 'src/modules/workflow/workflow-step-executor/workflow-step-executor.exception';
 import { WorkflowStepExecutor } from 'src/modules/workflow/workflow-step-executor/workflow-step-executor.interface';
 import { CodeActionExecutor } from 'src/modules/workflow/workflow-step-executor/workflow-step-executors/code-action-executor';
+import { SystemActionExecutor } from 'src/modules/workflow/workflow-step-executor/workflow-step-executors/system-action-executor';
 
 @Injectable()
 export class WorkflowStepExecutorFactory {
-  constructor(private readonly codeActionExecutor: CodeActionExecutor) {}
+  constructor(
+    private readonly codeActionExecutor: CodeActionExecutor,
+    private readonly systemActionExecutor: SystemActionExecutor,
+  ) {}
 
   get(stepType: WorkflowStepType): WorkflowStepExecutor {
     switch (stepType) {
       case WorkflowStepType.CODE_ACTION:
         return this.codeActionExecutor;
+      case WorkflowStepType.SYSTEM_ACTION:
+        return this.systemActionExecutor;
       default:
         throw new WorkflowStepExecutorException(
           `Workflow step executor not found for step type '${stepType}'`,

diff --git a/...ty-server/src/modules/workflow/workflow-step-executor/workflow-step-executor.interface.ts b/...ty-server/src/modules/workflow/workflow-step-executor/workflow-step-executor.interface.ts
@@ -1,4 +1,4 @@
-import { WorkflowResult } from 'src/modules/workflow/common/types/workflow-result.type';
+import { WorkflowStepResult } from 'src/modules/workflow/common/types/workflow-step-result.type';
 import { WorkflowStep } from 'src/modules/workflow/common/types/workflow-step.type';
 
 export interface WorkflowStepExecutor {
@@ -8,5 +8,5 @@ export interface WorkflowStepExecutor {
   }: {
     step: WorkflowStep;
     payload?: object;
-  }): Promise<WorkflowResult>;
+  }): Promise<WorkflowStepResult>;
 }
diff --git a/...wenty-server/src/modules/workflow/workflow-step-executor/workflow-step-executor.module.ts b/...wenty-server/src/modules/workflow/workflow-step-executor/workflow-step-executor.module.ts
@@ -4,12 +4,15 @@ import { ServerlessFunctionModule } from 'src/engine/metadata-modules/serverless
 import { ScopedWorkspaceContextFactory } from 'src/engine/twenty-orm/factories/scoped-workspace-context.factory';
 import { WorkflowStepExecutorFactory } from 'src/modules/workflow/workflow-step-executor/workflow-step-executor.factory';
 import { CodeActionExecutor } from 'src/modules/workflow/workflow-step-executor/workflow-step-executors/code-action-executor';
+import { SystemActionExecutor } from 'src/modules/workflow/workflow-step-executor/workflow-step-executors/system-action-executor';
+import { WorkflowSystemActionModule } from 'src/modules/workflow/workflow-system-action/workflow-system-action.module';
 
 @Module({
-  imports: [ServerlessFunctionModule],
+  imports: [ServerlessFunctionModule, WorkflowSystemActionModule],
   providers: [
     WorkflowStepExecutorFactory,
     CodeActionExecutor,
+    SystemActionExecutor,
     ScopedWorkspaceContextFactory,
   ],
   exports: [WorkflowStepExecutorFactory],

diff --git a/...c/modules/workflow/workflow-step-executor/workflow-step-executors/code-action-executor.ts b/...c/modules/workflow/workflow-step-executor/workflow-step-executors/code-action-executor.ts
@@ -2,7 +2,7 @@ import { Injectable } from '@nestjs/common';
 
 import { ServerlessFunctionService } from 'src/engine/metadata-modules/serverless-function/serverless-function.service';
 import { ScopedWorkspaceContextFactory } from 'src/engine/twenty-orm/factories/scoped-workspace-context.factory';
-import { WorkflowResult } from 'src/modules/workflow/common/types/workflow-result.type';
+import { WorkflowStepResult } from 'src/modules/workflow/common/types/workflow-step-result.type';
 import { WorkflowCodeStep } from 'src/modules/workflow/common/types/workflow-step.type';
 import {
   WorkflowStepExecutorException,
@@ -23,7 +23,7 @@ export class CodeActionExecutor implements WorkflowStepExecutor {
   }: {
     step: WorkflowCodeStep;
     payload?: object;
-  }): Promise<WorkflowResult> {
+  }): Promise<WorkflowStepResult> {
     const { workspaceId } = this.scopedWorkspaceContextFactory.create();
 
     if (!workspaceId) {

diff --git a/...modules/workflow/workflow-step-executor/workflow-step-executors/system-action-executor.ts b/...modules/workflow/workflow-step-executor/workflow-step-executors/system-action-executor.ts
@@ -0,0 +1,27 @@
+import { Injectable } from '@nestjs/common';
+
+import { WorkflowStepExecutor } from 'src/modules/workflow/workflow-step-executor/workflow-step-executor.interface';
+import { WorkflowSystemStep } from 'src/modules/workflow/common/types/workflow-step.type';
+import { WorkflowStepResult } from 'src/modules/workflow/common/types/workflow-step-result.type';
+import { WorkflowSystemActionFactory } from 'src/modules/workflow/workflow-system-action/workflow-system-action.factory';
+
+@Injectable()
+export class SystemActionExecutor implements WorkflowStepExecutor {
+  constructor(
+    private readonly workflowSystemActionFactory: WorkflowSystemActionFactory,
+  ) {}
+
+  async execute({
+    step,
+    payload,
+  }: {
+    step: WorkflowSystemStep;
+    payload?: object;
+  }): Promise<WorkflowStepResult> {
+    const workflowSystemAction = this.workflowSystemActionFactory.get(
+      step.settings.systemActionType,
+    );
+
+    return await workflowSystemAction.execute({ step, payload });
+  }
+}
diff --git a/...ty-server/src/modules/workflow/workflow-system-action/workflow-system-action.exception.ts b/...ty-server/src/modules/workflow/workflow-system-action/workflow-system-action.exception.ts
@@ -0,0 +1,12 @@
+import { CustomException } from 'src/utils/custom-exception';
+
+export class WorkflowSystemActionException extends CustomException {
+  code: WorkflowSystemActionExceptionCode;
+  constructor(message: string, code: WorkflowSystemActionExceptionCode) {
+    super(message, code);
+  }
+}
+
+export enum WorkflowSystemActionExceptionCode {
+  INVALID_SYSTEM_ACTION_TYPE = 'INVALID_SYSTEM_ACTION_TYPE',
+}
diff --git a/...enty-server/src/modules/workflow/workflow-system-action/workflow-system-action.factory.ts b/...enty-server/src/modules/workflow/workflow-system-action/workflow-system-action.factory.ts
@@ -0,0 +1,28 @@
+import { Injectable } from '@nestjs/common';
+
+import { WorkflowSystemAction } from 'src/modules/workflow/workflow-system-action/workflow-system-action.interface';
+import {
+  WorkflowSystemActionException,
+  WorkflowSystemActionExceptionCode,
+} from 'src/modules/workflow/workflow-system-action/workflow-system-action.exception';
+import { SendEmailAction } from 'src/modules/workflow/workflow-system-action/workflow-system-actions/send-email-action';
+import { WorkflowSystemActionType } from 'src/modules/workflow/common/types/workflow-system-action.type';
+
+@Injectable()
+export class WorkflowSystemActionFactory {
+  constructor(private readonly sendEmailAction: SendEmailAction) {}
+
+  get(
+    workflowSystemActionType: WorkflowSystemActionType,
+  ): WorkflowSystemAction {
+    switch (workflowSystemActionType) {
+      case WorkflowSystemActionType.SEND_EMAIL:
+        return this.sendEmailAction;
+      default:
+        throw new WorkflowSystemActionException(
+          `Workflow system action not found for system action type '${workflowSystemActionType}'`,
+          WorkflowSystemActionExceptionCode.INVALID_SYSTEM_ACTION_TYPE,
+        );
+    }
+  }
+}
diff --git a/...ty-server/src/modules/workflow/workflow-system-action/workflow-system-action.interface.ts b/...ty-server/src/modules/workflow/workflow-system-action/workflow-system-action.interface.ts
@@ -0,0 +1,12 @@
+import { WorkflowSystemStep } from 'src/modules/workflow/common/types/workflow-step.type';
+import { WorkflowStepResult } from 'src/modules/workflow/common/types/workflow-step-result.type';
+
+export interface WorkflowSystemAction {
+  execute({
+    step,
+    payload,
+  }: {
+    step: WorkflowSystemStep;
+    payload?: object;
+  }): Promise<WorkflowStepResult>;
+}
diff --git a/...wenty-server/src/modules/workflow/workflow-system-action/workflow-system-action.module.ts b/...wenty-server/src/modules/workflow/workflow-system-action/workflow-system-action.module.ts
@@ -0,0 +1,10 @@
+import { Module } from '@nestjs/common';
+
+import { WorkflowSystemActionFactory } from 'src/modules/workflow/workflow-system-action/workflow-system-action.factory';
+import { SendEmailAction } from 'src/modules/workflow/workflow-system-action/workflow-system-actions/send-email-action';
+
+@Module({
+  providers: [WorkflowSystemActionFactory, SendEmailAction],
+  exports: [WorkflowSystemActionFactory],
+})
+export class WorkflowSystemActionModule {}
diff --git a/.../src/modules/workflow/workflow-system-action/workflow-system-actions/send-email-action.ts b/.../src/modules/workflow/workflow-system-action/workflow-system-actions/send-email-action.ts
@@ -0,0 +1,23 @@
+import { Injectable } from '@nestjs/common';
+
+import { WorkflowSystemAction } from 'src/modules/workflow/workflow-system-action/workflow-system-action.interface';
+import { WorkflowStep } from 'src/modules/workflow/common/types/workflow-step.type';
+import { WorkflowStepResult } from 'src/modules/workflow/common/types/workflow-step-result.type';
+
+@Injectable()
+export class SendEmailAction implements WorkflowSystemAction {
+  async execute({
+    step,
+    payload,
+  }: {
+    step: WorkflowStep;
+    payload?: object;
+  }): Promise<WorkflowStepResult> {
+    return {
+      data: {
+        step,
+        payload,
+      },
+    };
+  }
+}