Scaffold empty workflow (#6926)

- Create a workflow version when the user visits an empty workflow.
- If the trigger is not defined yet and the user selects either the
standard object type or the event type first, we automatically select
the first option of the other value. Indeed, every state update is
automatically saved on the backend and we need both standard object and
event types to save the event name.
- Introduces a change in the backend. I removed the assertions that
throw when a workflow version is not complete, that is, when it doesn't
have a defined trigger, which is the case when scaffolding a new
workflow with a first empty workflow version.
- We should keep validating the workflow versions, at least when we
publish them. That should be done in a second step.

packages/twenty-server/src/modules/workflow/common/query-hooks/workflow-create-many.post-query.hook.ts

@@ -0,0 +1,42 @@
+import { WorkspaceQueryPostHookInstance } from 'src/engine/api/graphql/workspace-query-runner/workspace-query-hook/interfaces/workspace-query-hook.interface';
+
+import { WorkspaceQueryHook } from 'src/engine/api/graphql/workspace-query-runner/workspace-query-hook/decorators/workspace-query-hook.decorator';
+import { WorkspaceQueryHookType } from 'src/engine/api/graphql/workspace-query-runner/workspace-query-hook/types/workspace-query-hook.type';
+import { AuthContext } from 'src/engine/core-modules/auth/types/auth-context.type';
+import { TwentyORMManager } from 'src/engine/twenty-orm/twenty-orm.manager';
+import {
+  WorkflowVersionStatus,
+  WorkflowVersionWorkspaceEntity,
+} from 'src/modules/workflow/common/standard-objects/workflow-version.workspace-entity';
+import { WorkflowWorkspaceEntity } from 'src/modules/workflow/common/standard-objects/workflow.workspace-entity';
+
+@WorkspaceQueryHook({
+  key: `workflow.createMany`,
+  type: WorkspaceQueryHookType.PostHook,
+})
+export class WorkflowCreateManyPostQueryHook
+  implements WorkspaceQueryPostHookInstance
+{
+  constructor(private readonly twentyORMManager: TwentyORMManager) {}
+
+  async execute(
+    _authContext: AuthContext,
+    _objectName: string,
+    payload: WorkflowWorkspaceEntity[],
+  ): Promise<void> {
+    const workflowVersionRepository =
+      await this.twentyORMManager.getRepository<WorkflowVersionWorkspaceEntity>(
+        'workflowVersion',
+      );
+
+    await Promise.all(
+      payload.map((workflow) => {
+        return workflowVersionRepository.insert({
+          workflowId: workflow.id,
+          status: WorkflowVersionStatus.DRAFT,
+          name: 'v1',
+        });
+      }),
+    );
+  }
+}

packages/twenty-server/src/modules/workflow/common/query-hooks/workflow-create-one.post-query.hook.ts

@@ -0,0 +1,40 @@
+import { WorkspaceQueryPostHookInstance } from 'src/engine/api/graphql/workspace-query-runner/workspace-query-hook/interfaces/workspace-query-hook.interface';
+
+import { WorkspaceQueryHook } from 'src/engine/api/graphql/workspace-query-runner/workspace-query-hook/decorators/workspace-query-hook.decorator';
+import { WorkspaceQueryHookType } from 'src/engine/api/graphql/workspace-query-runner/workspace-query-hook/types/workspace-query-hook.type';
+import { AuthContext } from 'src/engine/core-modules/auth/types/auth-context.type';
+import { TwentyORMManager } from 'src/engine/twenty-orm/twenty-orm.manager';
+import {
+  WorkflowVersionStatus,
+  WorkflowVersionWorkspaceEntity,
+} from 'src/modules/workflow/common/standard-objects/workflow-version.workspace-entity';
+import { WorkflowWorkspaceEntity } from 'src/modules/workflow/common/standard-objects/workflow.workspace-entity';
+
+@WorkspaceQueryHook({
+  key: `workflow.createOne`,
+  type: WorkspaceQueryHookType.PostHook,
+})
+export class WorkflowCreateOnePostQueryHook
+  implements WorkspaceQueryPostHookInstance
+{
+  constructor(private readonly twentyORMManager: TwentyORMManager) {}
+
+  async execute(
+    _authContext: AuthContext,
+    _objectName: string,
+    payload: WorkflowWorkspaceEntity[],
+  ): Promise<void> {
+    const workflow = payload[0];
+
+    const workflowVersionRepository =
+      await this.twentyORMManager.getRepository<WorkflowVersionWorkspaceEntity>(
+        'workflowVersion',
+      );
+
+    await workflowVersionRepository.insert({
+      workflowId: workflow.id,
+      status: WorkflowVersionStatus.DRAFT,
+      name: 'v1',
+    });
+  }
+}

packages/twenty-server/src/modules/workflow/common/query-hooks/workflow-query-hook.module.ts

@@ -1,19 +1,20 @@
 import { Module } from '@nestjs/common';
 
+import { WorkflowCreateManyPostQueryHook } from 'src/modules/workflow/common/query-hooks/workflow-create-many.post-query.hook';
+import { WorkflowCreateManyPreQueryHook } from 'src/modules/workflow/common/query-hooks/workflow-create-many.pre-query.hook';
+import { WorkflowCreateOnePreQueryHook } from 'src/modules/workflow/common/query-hooks/workflow-create-one.pre-query.hook';
 import { WorkflowRunCreateManyPreQueryHook } from 'src/modules/workflow/common/query-hooks/workflow-run-create-many.pre-query.hook';
 import { WorkflowRunCreateOnePreQueryHook } from 'src/modules/workflow/common/query-hooks/workflow-run-create-one.pre-query.hook';
-import { WorkflowVersionValidationWorkspaceService } from 'src/modules/workflow/common/workspace-services/workflow-version-validation.workspace-service';
+import { WorkflowUpdateManyPreQueryHook } from 'src/modules/workflow/common/query-hooks/workflow-update-many.pre-query.hook';
+import { WorkflowUpdateOnePreQueryHook } from 'src/modules/workflow/common/query-hooks/workflow-update-one.pre-query.hook';
 import { WorkflowVersionCreateManyPreQueryHook } from 'src/modules/workflow/common/query-hooks/workflow-version-create-many.pre-query.hook';
 import { WorkflowVersionCreateOnePreQueryHook } from 'src/modules/workflow/common/query-hooks/workflow-version-create-one.pre-query.hook';
 import { WorkflowVersionDeleteManyPreQueryHook } from 'src/modules/workflow/common/query-hooks/workflow-version-delete-many.pre-query.hook';
 import { WorkflowVersionDeleteOnePreQueryHook } from 'src/modules/workflow/common/query-hooks/workflow-version-delete-one.pre-query.hook';
 import { WorkflowVersionUpdateManyPreQueryHook } from 'src/modules/workflow/common/query-hooks/workflow-version-update-many.pre-query.hook';
 import { WorkflowVersionUpdateOnePreQueryHook } from 'src/modules/workflow/common/query-hooks/workflow-version-update-one.pre-query.hook';
-import { WorkflowCreateManyPreQueryHook } from 'src/modules/workflow/common/query-hooks/workflow-create-many.pre-query.hook';
-import { WorkflowCreateOnePreQueryHook } from 'src/modules/workflow/common/query-hooks/workflow-create-one.pre-query.hook';
-import { WorkflowUpdateManyPreQueryHook } from 'src/modules/workflow/common/query-hooks/workflow-update-many.pre-query.hook';
-import { WorkflowUpdateOnePreQueryHook } from 'src/modules/workflow/common/query-hooks/workflow-update-one.pre-query.hook';
 import { WorkflowCommonWorkspaceService } from 'src/modules/workflow/common/workspace-services/workflow-common.workspace-service';
+import { WorkflowVersionValidationWorkspaceService } from 'src/modules/workflow/common/workspace-services/workflow-version-validation.workspace-service';
 
 @Module({
   providers: [
@@ -29,6 +30,7 @@ import { WorkflowCommonWorkspaceService } from 'src/modules/workflow/common/work
     WorkflowVersionUpdateManyPreQueryHook,
     WorkflowVersionDeleteOnePreQueryHook,
     WorkflowVersionDeleteManyPreQueryHook,
+    WorkflowCreateManyPostQueryHook,
     WorkflowVersionValidationWorkspaceService,
     WorkflowCommonWorkspaceService,
   ],

packages/twenty-server/src/modules/workflow/common/utils/assert-workflow-version-is-draft.util.ts

@@ -6,12 +6,9 @@ import {
   WorkflowVersionStatus,
   WorkflowVersionWorkspaceEntity,
 } from 'src/modules/workflow/common/standard-objects/workflow-version.workspace-entity';
-import { WorkflowTrigger } from 'src/modules/workflow/workflow-trigger/types/workflow-trigger.type';
 
 export const assertWorkflowVersionIsDraft = (
-  workflowVersion: Omit<WorkflowVersionWorkspaceEntity, 'trigger'> & {
-    trigger: WorkflowTrigger;
-  },
+  workflowVersion: WorkflowVersionWorkspaceEntity,
 ) => {
   if (workflowVersion.status !== WorkflowVersionStatus.DRAFT) {
     throw new WorkflowQueryValidationException(

packages/twenty-server/src/modules/workflow/common/utils/assert-workflow-version-trigger-is-defined.util.ts

@@ -0,0 +1,22 @@
+import { WorkflowVersionWorkspaceEntity } from 'src/modules/workflow/common/standard-objects/workflow-version.workspace-entity';
+import {
+  WorkflowTriggerException,
+  WorkflowTriggerExceptionCode,
+} from 'src/modules/workflow/workflow-trigger/exceptions/workflow-trigger.exception';
+import { WorkflowTrigger } from 'src/modules/workflow/workflow-trigger/types/workflow-trigger.type';
+
+export function assertWorkflowVersionTriggerIsDefined(
+  workflowVersion: WorkflowVersionWorkspaceEntity,
+): asserts workflowVersion is Omit<
+  WorkflowVersionWorkspaceEntity,
+  'trigger'
+> & {
+  trigger: WorkflowTrigger;
+} {
+  if (!workflowVersion.trigger) {
+    throw new WorkflowTriggerException(
+      'Workflow version does not contain trigger',
+      WorkflowTriggerExceptionCode.INVALID_WORKFLOW_VERSION,
+    );
+  }
+}

packages/twenty-server/src/modules/workflow/common/workspace-services/workflow-common.workspace-service.ts

@@ -2,7 +2,6 @@ import { Injectable } from '@nestjs/common';
 
 import { TwentyORMManager } from 'src/engine/twenty-orm/twenty-orm.manager';
 import { WorkflowVersionWorkspaceEntity } from 'src/modules/workflow/common/standard-objects/workflow-version.workspace-entity';
-import { WorkflowTrigger } from 'src/modules/workflow/workflow-trigger/types/workflow-trigger.type';
 import {
   WorkflowTriggerException,
   WorkflowTriggerExceptionCode,
@@ -12,11 +11,9 @@ import {
 export class WorkflowCommonWorkspaceService {
   constructor(private readonly twentyORMManager: TwentyORMManager) {}
 
-  async getWorkflowVersionOrFail(workflowVersionId: string): Promise<
-    Omit<WorkflowVersionWorkspaceEntity, 'trigger'> & {
-      trigger: WorkflowTrigger;
-    }
-  > {
+  async getWorkflowVersionOrFail(
+    workflowVersionId: string,
+  ): Promise<WorkflowVersionWorkspaceEntity> {
     if (!workflowVersionId) {
       throw new WorkflowTriggerException(
         'Workflow version ID is required',
@@ -40,11 +37,7 @@ export class WorkflowCommonWorkspaceService {
 
   async getValidWorkflowVersionOrFail(
     workflowVersion: WorkflowVersionWorkspaceEntity | null,
-  ): Promise<
-    Omit<WorkflowVersionWorkspaceEntity, 'trigger'> & {
-      trigger: WorkflowTrigger;
-    }
-  > {
+  ): Promise<WorkflowVersionWorkspaceEntity> {
     if (!workflowVersion) {
       throw new WorkflowTriggerException(
         'Workflow version not found',
@@ -52,12 +45,13 @@ export class WorkflowCommonWorkspaceService {
       );
     }
 
-    if (!workflowVersion.trigger) {
-      throw new WorkflowTriggerException(
-        'Workflow version does not contains trigger',
-        WorkflowTriggerExceptionCode.INVALID_WORKFLOW_VERSION,
-      );
-    }
+    // FIXME: For now we will make the trigger optional. Later, we'll have to ensure the trigger is defined when publishing the flow.
+    // if (!workflowVersion.trigger) {
+    //   throw new WorkflowTriggerException(
+    //     'Workflow version does not contains trigger',
+    //     WorkflowTriggerExceptionCode.INVALID_WORKFLOW_VERSION,
+    //   );
+    // }
 
     return { ...workflowVersion, trigger: workflowVersion.trigger };
   }

packages/twenty-server/src/modules/workflow/workflow-trigger/utils/assert-version-can-be-activated.util.ts

@@ -3,19 +3,14 @@ import {
   WorkflowVersionWorkspaceEntity,
 } from 'src/modules/workflow/common/standard-objects/workflow-version.workspace-entity';
 import { WorkflowWorkspaceEntity } from 'src/modules/workflow/common/standard-objects/workflow.workspace-entity';
-import {
-  WorkflowTrigger,
-  WorkflowTriggerType,
-} from 'src/modules/workflow/workflow-trigger/types/workflow-trigger.type';
 import {
   WorkflowTriggerException,
   WorkflowTriggerExceptionCode,
 } from 'src/modules/workflow/workflow-trigger/exceptions/workflow-trigger.exception';
+import { WorkflowTriggerType } from 'src/modules/workflow/workflow-trigger/types/workflow-trigger.type';
 
 export function assertVersionCanBeActivated(
-  workflowVersion: Omit<WorkflowVersionWorkspaceEntity, 'trigger'> & {
-    trigger: WorkflowTrigger;
-  },
+  workflowVersion: WorkflowVersionWorkspaceEntity,
   workflow: WorkflowWorkspaceEntity,
 ) {
   assertVersionIsValid(workflowVersion);
@@ -37,11 +32,7 @@ export function assertVersionCanBeActivated(
   }
 }
 
-function assertVersionIsValid(
-  workflowVersion: Omit<WorkflowVersionWorkspaceEntity, 'trigger'> & {
-    trigger: WorkflowTrigger;
-  },
-) {
+function assertVersionIsValid(workflowVersion: WorkflowVersionWorkspaceEntity) {
   if (!workflowVersion.trigger) {
     throw new WorkflowTriggerException(
       'Workflow version does not contain trigger',

packages/twenty-server/src/modules/workflow/workflow-trigger/workspace-services/workflow-trigger.workspace-service.ts

@@ -8,24 +8,22 @@ import { ScopedWorkspaceContextFactory } from 'src/engine/twenty-orm/factories/s
 import { WorkspaceRepository } from 'src/engine/twenty-orm/repository/workspace.repository';
 import { TwentyORMManager } from 'src/engine/twenty-orm/twenty-orm.manager';
 import { WorkspaceEventEmitter } from 'src/engine/workspace-event-emitter/workspace-event-emitter';
-import { WorkflowCommonWorkspaceService } from 'src/modules/workflow/common/workspace-services/workflow-common.workspace-service';
 import {
   WorkflowVersionStatus,
   WorkflowVersionWorkspaceEntity,
 } from 'src/modules/workflow/common/standard-objects/workflow-version.workspace-entity';
 import { WorkflowWorkspaceEntity } from 'src/modules/workflow/common/standard-objects/workflow.workspace-entity';
-import {
-  WorkflowTrigger,
-  WorkflowTriggerType,
-} from 'src/modules/workflow/workflow-trigger/types/workflow-trigger.type';
+import { assertWorkflowVersionTriggerIsDefined } from 'src/modules/workflow/common/utils/assert-workflow-version-trigger-is-defined.util';
+import { WorkflowCommonWorkspaceService } from 'src/modules/workflow/common/workspace-services/workflow-common.workspace-service';
 import { WorkflowRunnerWorkspaceService } from 'src/modules/workflow/workflow-runner/workspace-services/workflow-runner.workspace-service';
 import { WorkflowVersionStatusUpdate } from 'src/modules/workflow/workflow-status/jobs/workflow-statuses-update.job';
 import { DatabaseEventTriggerService } from 'src/modules/workflow/workflow-trigger/database-event-trigger/database-event-trigger.service';
-import { assertVersionCanBeActivated } from 'src/modules/workflow/workflow-trigger/utils/assert-version-can-be-activated.util';
 import {
   WorkflowTriggerException,
   WorkflowTriggerExceptionCode,
 } from 'src/modules/workflow/workflow-trigger/exceptions/workflow-trigger.exception';
+import { WorkflowTriggerType } from 'src/modules/workflow/workflow-trigger/types/workflow-trigger.type';
+import { assertVersionCanBeActivated } from 'src/modules/workflow/workflow-trigger/utils/assert-version-can-be-activated.util';
 
 @Injectable()
 export class WorkflowTriggerWorkspaceService {
@@ -158,9 +156,7 @@ export class WorkflowTriggerWorkspaceService {
 
   private async performActivationSteps(
     workflow: WorkflowWorkspaceEntity,
-    workflowVersion: Omit<WorkflowVersionWorkspaceEntity, 'trigger'> & {
-      trigger: WorkflowTrigger;
-    },
+    workflowVersion: WorkflowVersionWorkspaceEntity,
     workflowRepository: WorkspaceRepository<WorkflowWorkspaceEntity>,
     workflowVersionRepository: WorkspaceRepository<WorkflowVersionWorkspaceEntity>,
     manager: EntityManager,
@@ -217,9 +213,7 @@ export class WorkflowTriggerWorkspaceService {
   }
 
   private async setActiveVersionStatus(
-    workflowVersion: Omit<WorkflowVersionWorkspaceEntity, 'trigger'> & {
-      trigger: WorkflowTrigger;
-    },
+    workflowVersion: WorkflowVersionWorkspaceEntity,
     workflowVersionRepository: WorkspaceRepository<WorkflowVersionWorkspaceEntity>,
     manager: EntityManager,
   ) {
@@ -254,9 +248,7 @@ export class WorkflowTriggerWorkspaceService {
   }
 
   private async setDeactivatedVersionStatus(
-    workflowVersion: Omit<WorkflowVersionWorkspaceEntity, 'trigger'> & {
-      trigger: WorkflowTrigger;
-    },
+    workflowVersion: WorkflowVersionWorkspaceEntity,
     workflowVersionRepository: WorkspaceRepository<WorkflowVersionWorkspaceEntity>,
     manager: EntityManager,
   ) {
@@ -307,11 +299,11 @@ export class WorkflowTriggerWorkspaceService {
   }
 
   private async enableTrigger(
-    workflowVersion: Omit<WorkflowVersionWorkspaceEntity, 'trigger'> & {
-      trigger: WorkflowTrigger;
-    },
+    workflowVersion: WorkflowVersionWorkspaceEntity,
     manager: EntityManager,
   ) {
+    assertWorkflowVersionTriggerIsDefined(workflowVersion);
+
     switch (workflowVersion.trigger.type) {
       case WorkflowTriggerType.DATABASE_EVENT:
         await this.databaseEventTriggerService.createEventListener(
@@ -326,11 +318,11 @@ export class WorkflowTriggerWorkspaceService {
   }
 
   private async disableTrigger(
-    workflowVersion: Omit<WorkflowVersionWorkspaceEntity, 'trigger'> & {
-      trigger: WorkflowTrigger;
-    },
+    workflowVersion: WorkflowVersionWorkspaceEntity,
     manager: EntityManager,
   ) {
+    assertWorkflowVersionTriggerIsDefined(workflowVersion);
+
     switch (workflowVersion.trigger.type) {
       case WorkflowTriggerType.DATABASE_EVENT:
         await this.databaseEventTriggerService.deleteEventListener(