Remove useless factory

twentyhq · martmull · Sep 12, 2024 · Sep 9, 2024 · Sep 9, 2024 · Sep 10, 2024
commit 77e78a853001daa291e491dfd4da5a35fc33339d
diff --git a/...s/twenty-server/src/modules/workflow/common/types/settings/workflow-base-settings.type.ts b/...s/twenty-server/src/modules/workflow/common/types/settings/workflow-base-settings.type.ts
diff --git a/...s/twenty-server/src/modules/workflow/common/types/settings/workflow-code-settings.type.ts b/...s/twenty-server/src/modules/workflow/common/types/settings/workflow-code-settings.type.ts
diff --git a/...server/src/modules/workflow/common/types/settings/workflow-system-action-settings.type.ts b/...server/src/modules/workflow/common/types/settings/workflow-system-action-settings.type.ts
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,11 +1,19 @@
-import { WorkflowCodeSettings } from 'src/modules/workflow/common/types/settings/workflow-code-settings.type';
-import { WorkflowSystemActionSettings } from 'src/modules/workflow/common/types/settings/workflow-system-action-settings.type';
-
 export enum WorkflowStepType {
   CODE_ACTION = 'CODE_ACTION',
-  SYSTEM_ACTION = 'SYSTEM_ACTION',
+  SEND_EMAIL_ACTION = 'SEND_EMAIL_ACTION',
 }
 
+type BaseWorkflowSettings = {
+  errorHandlingOptions: {
+    retryOnFailure: {
+      value: boolean;
+    };
+    continueOnFailure: {
+      value: boolean;
+    };
+  };
+};
+
 type BaseWorkflowStep = {
   id: string;
   name: string;
@@ -14,12 +22,22 @@ type BaseWorkflowStep = {
 
 export type WorkflowCodeStep = BaseWorkflowStep & {
   type: WorkflowStepType.CODE_ACTION;
-  settings: WorkflowCodeSettings;
+  settings: BaseWorkflowSettings & {
+    serverlessFunctionId: string;
+  };
 };
 
-export type WorkflowSystemStep = BaseWorkflowStep & {
-  type: WorkflowStepType.SYSTEM_ACTION;
-  settings: WorkflowSystemActionSettings;
+export type WorkflowSendEmailStep = BaseWorkflowStep & {
+  type: WorkflowStepType.SEND_EMAIL_ACTION;
+  settings: BaseWorkflowSettings & {
+    subject?: string;
+    template?: string;
+    title?: string;
+    callToAction?: {
+      value: string;
+      href: string;
+    };
+  };
 };
 
-export type WorkflowStep = WorkflowCodeStep | WorkflowSystemStep;
+export type WorkflowStep = WorkflowCodeStep | WorkflowSendEmailStep;
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
diff --git a/...ow-step-executors/code-action-executor.ts → ...factories/code-action-executor.factory.ts b/...ow-step-executors/code-action-executor.ts → ...factories/code-action-executor.factory.ts
@@ -8,10 +8,9 @@ import {
   WorkflowStepExecutorException,
   WorkflowStepExecutorExceptionCode,
 } from 'src/modules/workflow/workflow-step-executor/workflow-step-executor.exception';
-import { WorkflowStepExecutor } from 'src/modules/workflow/workflow-step-executor/workflow-step-executor.interface';
 
 @Injectable()
-export class CodeActionExecutor implements WorkflowStepExecutor {
+export class CodeActionExecutorFactory {
   constructor(
     private readonly serverlessFunctionService: ServerlessFunctionService,
     private readonly scopedWorkspaceContextFactory: ScopedWorkspaceContextFactory,

diff --git a/...c/modules/workflow/workflow-step-executor/factories/send-email-action-executor.factory.ts b/...c/modules/workflow/workflow-step-executor/factories/send-email-action-executor.factory.ts
@@ -0,0 +1,77 @@
+import { Injectable, Logger } from '@nestjs/common';
+
+import { z } from 'zod';
+import Handlebars from 'handlebars';
+import { JSDOM } from 'jsdom';
+import DOMPurify from 'dompurify';
+import { WorkflowActionEmail } from 'twenty-emails';
+import { render } from '@react-email/components';
+
+import { WorkflowStepResult } from 'src/modules/workflow/common/types/workflow-step-result.type';
+import { WorkflowSendEmailStep } from 'src/modules/workflow/common/types/workflow-step.type';
+import { EnvironmentService } from 'src/engine/integrations/environment/environment.service';
+import { EmailService } from 'src/engine/integrations/email/email.service';
+
+@Injectable()
+export class SendEmailActionExecutorFactory {
+  private readonly logger = new Logger(SendEmailActionExecutorFactory.name);
+  constructor(
+    private readonly environmentService: EnvironmentService,
+    private readonly emailService: EmailService,
+  ) {}
+
+  async execute({
+    step,
+    payload,
+  }: {
+    step: WorkflowSendEmailStep;
+    payload: {
+      email: string;
+      [key: string]: string;
+    };
+  }): Promise<WorkflowStepResult> {
+    try {
+      const emailSchema = z.string().trim().email('Invalid email');
+
+      const result = emailSchema.safeParse(payload.email);
+
+      if (!result.success) {
+        this.logger.warn(`Email '${payload.email}' invalid`);
+
+        return { data: { success: false } };
+      }
+
+      const mainText = Handlebars.compile(step.settings.template)(payload);
+
+      const window = new JSDOM('').window;
+      const purify = DOMPurify(window);
+      const safeHTML = purify.sanitize(mainText || '');
+
+      const email = WorkflowActionEmail({
+        dangerousHTML: safeHTML,
+        title: step.settings.title,
+        callToAction: step.settings.callToAction,
+      });
+      const html = render(email, {
+        pretty: true,
+      });
+      const text = render(email, {
+        plainText: true,
+      });
+
+      await this.emailService.send({
+        from: `${this.environmentService.get(
+          'EMAIL_FROM_NAME',
+        )} <${this.environmentService.get('EMAIL_FROM_ADDRESS')}>`,
+        to: payload.email,
+        subject: step.settings.subject || '',
+        text,
+        html,
+      });
+
+      return { data: { success: true } };
+    } catch (error) {
+      return { error };
+    }
+  }
+}
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
@@ -6,22 +6,22 @@ import {
   WorkflowStepExecutorExceptionCode,
 } 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';
+import { CodeActionExecutorFactory } from 'src/modules/workflow/workflow-step-executor/factories/code-action-executor.factory';
+import { SendEmailActionExecutorFactory } from 'src/modules/workflow/workflow-step-executor/factories/send-email-action-executor.factory';
 
 @Injectable()
 export class WorkflowStepExecutorFactory {
   constructor(
-    private readonly codeActionExecutor: CodeActionExecutor,
-    private readonly systemActionExecutor: SystemActionExecutor,
+    private readonly codeActionExecutor: CodeActionExecutorFactory,
+    private readonly sendEmailActionExecutor: SendEmailActionExecutorFactory,
   ) {}
 
   get(stepType: WorkflowStepType): WorkflowStepExecutor {
     switch (stepType) {
       case WorkflowStepType.CODE_ACTION:
         return this.codeActionExecutor;
-      case WorkflowStepType.SYSTEM_ACTION:
-        return this.systemActionExecutor;
+      case WorkflowStepType.SEND_EMAIL_ACTION:
+        return this.sendEmailActionExecutor;
       default:
         throw new WorkflowStepExecutorException(
           `Workflow step executor not found for step type '${stepType}'`,

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
@@ -3,16 +3,15 @@ import { Module } from '@nestjs/common';
 import { ServerlessFunctionModule } from 'src/engine/metadata-modules/serverless-function/serverless-function.module';
 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';
+import { CodeActionExecutorFactory } from 'src/modules/workflow/workflow-step-executor/factories/code-action-executor.factory';
+import { SendEmailActionExecutorFactory } from 'src/modules/workflow/workflow-step-executor/factories/send-email-action-executor.factory';
 
 @Module({
-  imports: [ServerlessFunctionModule, WorkflowSystemActionModule],
+  imports: [ServerlessFunctionModule],
   providers: [
     WorkflowStepExecutorFactory,
-    CodeActionExecutor,
-    SystemActionExecutor,
+    CodeActionExecutorFactory,
+    SendEmailActionExecutorFactory,
     ScopedWorkspaceContextFactory,
   ],
   exports: [WorkflowStepExecutorFactory],

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
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
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
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
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