Add workflow run entity

packages/twenty-server/src/engine/metadata-modules/field-metadata/composite-types/actor.composite-type.ts

@@ -8,6 +8,7 @@ import { FieldMetadataType } from 'src/engine/metadata-modules/field-metadata/fi
 export enum FieldActorSource {
   EMAIL = 'EMAIL',
   CALENDAR = 'CALENDAR',
+  WORKFLOW = 'WORKFLOW',
   API = 'API',
   IMPORT = 'IMPORT',
   MANUAL = 'MANUAL',

packages/twenty-server/src/engine/workspace-manager/workspace-sync-metadata/constants/standard-field-ids.ts

@@ -411,10 +411,19 @@ export const WORKFLOW_STANDARD_FIELD_IDS = {
   noteTargets: '20202020-40aa-4839-965e-972a2f72e08d',
 };
 
+export const WORKFLOW_RUN_STANDARD_FIELD_IDS = {
+  workflowVersion: '20202020-2f52-4ba8-8dc4-d0d6adb9578d',
+  startedAt: '20202020-a234-4e2d-bd15-85bcea6bb183',
+  endedAt: '20202020-e1c1-4b6b-bbbd-b2beaf2e159e',
+  status: '20202020-6b3e-4f9c-8c2b-2e5b8e6d6f3b',
+  createdBy: '20202020-6007-401a-8aa5-e6f38581a6f3',
+};
+
 export const WORKFLOW_VERSION_STANDARD_FIELD_IDS = {
   name: '20202020-a12f-4cca-9937-a2e40cc65509',
   workflow: '20202020-afa3-46c3-91b0-0631ca6aa1c8',
   trigger: '20202020-4eae-43e7-86e0-212b41a30b48',
+  runs: '20202020-1d08-46df-901a-85045f18099a',
 };
 
 export const WORKSPACE_MEMBER_STANDARD_FIELD_IDS = {

packages/twenty-server/src/engine/workspace-manager/workspace-sync-metadata/constants/standard-object-ids.ts

@@ -41,6 +41,7 @@ export const STANDARD_OBJECT_IDS = {
   webhook: '20202020-be4d-4e08-811d-0fffcd13ffd4',
   workflow: '20202020-62be-406c-b9ca-8caa50d51392',
   workflowEventListener: '20202020-92aa-462f-965c-a785b00e9989',
+  workflowRun: '20202020-4e28-4e95-a9d7-6c00874f843c',
   workflowVersion: '20202020-d65d-4ab9-9344-d77bfb376a3d',
   workspaceMember: '20202020-3319-4234-a34c-82d5c0e881a6',
 };

packages/twenty-server/src/engine/workspace-manager/workspace-sync-metadata/standard-objects/index.ts

@@ -32,6 +32,7 @@ import { ViewSortWorkspaceEntity } from 'src/modules/view/standard-objects/view-
 import { ViewWorkspaceEntity } from 'src/modules/view/standard-objects/view.workspace-entity';
 import { WebhookWorkspaceEntity } from 'src/modules/webhook/standard-objects/webhook.workspace-entity';
 import { WorkflowEventListenerWorkspaceEntity } from 'src/modules/workflow/common/standard-objects/workflow-event-listener.workspace-entity';
+import { WorkflowRunWorkspaceEntity } from 'src/modules/workflow/common/standard-objects/workflow-run.workspace-entity';
 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 { WorkspaceMemberWorkspaceEntity } from 'src/modules/workspace-member/standard-objects/workspace-member.workspace-entity';
@@ -64,6 +65,7 @@ export const standardObjectMetadataDefinitions = [
   WorkflowWorkspaceEntity,
   WorkflowEventListenerWorkspaceEntity,
   WorkflowVersionWorkspaceEntity,
+  WorkflowRunWorkspaceEntity,
   WorkspaceMemberWorkspaceEntity,
   MessageThreadWorkspaceEntity,
   MessageThreadSubscriberWorkspaceEntity,

packages/twenty-server/src/modules/workflow/common/standard-objects/workflow-run.workspace-entity.ts

@@ -0,0 +1,97 @@
+import { Relation } from 'src/engine/workspace-manager/workspace-sync-metadata/interfaces/relation.interface';
+
+import { FeatureFlagKey } from 'src/engine/core-modules/feature-flag/enums/feature-flag-key.enum';
+import {
+  ActorMetadata,
+  FieldActorSource,
+} from 'src/engine/metadata-modules/field-metadata/composite-types/actor.composite-type';
+import { FieldMetadataType } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
+import { RelationMetadataType } from 'src/engine/metadata-modules/relation-metadata/relation-metadata.entity';
+import { BaseWorkspaceEntity } from 'src/engine/twenty-orm/base.workspace-entity';
+import { WorkspaceEntity } from 'src/engine/twenty-orm/decorators/workspace-entity.decorator';
+import { WorkspaceField } from 'src/engine/twenty-orm/decorators/workspace-field.decorator';
+import { WorkspaceGate } from 'src/engine/twenty-orm/decorators/workspace-gate.decorator';
+import { WorkspaceIsNullable } from 'src/engine/twenty-orm/decorators/workspace-is-nullable.decorator';
+import { WorkspaceIsSystem } from 'src/engine/twenty-orm/decorators/workspace-is-system.decorator';
+import { WorkspaceJoinColumn } from 'src/engine/twenty-orm/decorators/workspace-join-column.decorator';
+import { WorkspaceRelation } from 'src/engine/twenty-orm/decorators/workspace-relation.decorator';
+import { WORKFLOW_RUN_STANDARD_FIELD_IDS } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-field-ids';
+import { STANDARD_OBJECT_IDS } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-object-ids';
+import { WorkflowVersionWorkspaceEntity } from 'src/modules/workflow/common/standard-objects/workflow-version.workspace-entity';
+
+export enum WorkflowRunStatus {
+  NOT_STARTED = 'NOT_STARTED',
+  RUNNING = 'RUNNING',
+  COMPLETED = 'COMPLETED',
+  FAILED = 'FAILED',
+}
+
+@WorkspaceEntity({
+  standardId: STANDARD_OBJECT_IDS.workflowRun,
+  namePlural: 'workflowRuns',
+  labelSingular: 'workflowRun',
+  labelPlural: 'WorkflowRuns',
+  description: 'A workflow run',
+})
+@WorkspaceGate({
+  featureFlag: FeatureFlagKey.IsWorkflowEnabled,
+})
+@WorkspaceIsSystem()
+export class WorkflowRunWorkspaceEntity extends BaseWorkspaceEntity {
+  @WorkspaceField({
+    standardId: WORKFLOW_RUN_STANDARD_FIELD_IDS.startedAt,
+    type: FieldMetadataType.DATE_TIME,
+    label: 'Workflow run started at',
+    description: 'Workflow run started at',
+    icon: 'IconHistory',
+  })
+  @WorkspaceIsNullable()
+  startedAt: string | null;
+
+  @WorkspaceField({
+    standardId: WORKFLOW_RUN_STANDARD_FIELD_IDS.endedAt,
+    type: FieldMetadataType.DATE_TIME,
+    label: 'Workflow run ended at',
+    description: 'Workflow run ended at',
+    icon: 'IconHistory',
+  })
+  @WorkspaceIsNullable()
+  endedAt: string | null;
+
+  @WorkspaceField({
+    standardId: WORKFLOW_RUN_STANDARD_FIELD_IDS.status,
+    type: FieldMetadataType.TEXT,
+    label: 'Workflow run status',
+    description: 'Workflow run status',
+    icon: 'IconHistory',
+  })
+  status: WorkflowRunStatus;
+
+  @WorkspaceField({
+    standardId: WORKFLOW_RUN_STANDARD_FIELD_IDS.createdBy,
+    type: FieldMetadataType.ACTOR,
+    label: 'Created by',
+    icon: 'IconCreativeCommonsSa',
+    description: 'The creator of the record',
+    defaultValue: {
+      source: `'${FieldActorSource.MANUAL}'`,
+      name: "''",
+    },
+  })
+  createdBy: ActorMetadata;
+
+  // Relations
+  @WorkspaceRelation({
+    standardId: WORKFLOW_RUN_STANDARD_FIELD_IDS.workflowVersion,
+    type: RelationMetadataType.MANY_TO_ONE,
+    label: 'Workflow',
+    description: 'WorkflowVersion workflow',
+    icon: 'IconVersions',
+    inverseSideTarget: () => WorkflowVersionWorkspaceEntity,
+    inverseSideFieldKey: 'runs',
+  })
+  workflowVersion: Relation<WorkflowVersionWorkspaceEntity>;
+
+  @WorkspaceJoinColumn('workflowVersion')
+  workflowVersionId: string;
+}

packages/twenty-server/src/modules/workflow/common/standard-objects/workflow-version.workspace-entity.ts

@@ -2,7 +2,10 @@ import { Relation } from 'src/engine/workspace-manager/workspace-sync-metadata/i
 
 import { FeatureFlagKey } from 'src/engine/core-modules/feature-flag/enums/feature-flag-key.enum';
 import { FieldMetadataType } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
-import { RelationMetadataType } from 'src/engine/metadata-modules/relation-metadata/relation-metadata.entity';
+import {
+  RelationMetadataType,
+  RelationOnDeleteAction,
+} from 'src/engine/metadata-modules/relation-metadata/relation-metadata.entity';
 import { BaseWorkspaceEntity } from 'src/engine/twenty-orm/base.workspace-entity';
 import { WorkspaceEntity } from 'src/engine/twenty-orm/decorators/workspace-entity.decorator';
 import { WorkspaceField } from 'src/engine/twenty-orm/decorators/workspace-field.decorator';
@@ -11,8 +14,12 @@ import { WorkspaceIsNullable } from 'src/engine/twenty-orm/decorators/workspace-
 import { WorkspaceIsSystem } from 'src/engine/twenty-orm/decorators/workspace-is-system.decorator';
 import { WorkspaceJoinColumn } from 'src/engine/twenty-orm/decorators/workspace-join-column.decorator';
 import { WorkspaceRelation } from 'src/engine/twenty-orm/decorators/workspace-relation.decorator';
-import { WORKFLOW_VERSION_STANDARD_FIELD_IDS } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-field-ids';
+import {
+  WORKFLOW_RUN_STANDARD_FIELD_IDS,
+  WORKFLOW_VERSION_STANDARD_FIELD_IDS,
+} from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-field-ids';
 import { STANDARD_OBJECT_IDS } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-object-ids';
+import { WorkflowRunWorkspaceEntity } from 'src/modules/workflow/common/standard-objects/workflow-run.workspace-entity';
 import { WorkflowWorkspaceEntity } from 'src/modules/workflow/common/standard-objects/workflow.workspace-entity';
 import { WorkflowTrigger } from 'src/modules/workflow/common/types/workflow-trigger.type';
 
@@ -64,4 +71,16 @@ export class WorkflowVersionWorkspaceEntity extends BaseWorkspaceEntity {
 
   @WorkspaceJoinColumn('workflow')
   workflowId: string;
+
+  @WorkspaceRelation({
+    standardId: WORKFLOW_RUN_STANDARD_FIELD_IDS.workflowVersion,
+    type: RelationMetadataType.ONE_TO_MANY,
+    label: 'Runs',
+    description: 'Workflow runs linked to the version.',
+    icon: 'IconVersions',
+    inverseSideTarget: () => WorkflowRunWorkspaceEntity,
+    onDelete: RelationOnDeleteAction.SET_NULL,
+  })
+  @WorkspaceIsNullable()
+  runs: Relation<WorkflowRunWorkspaceEntity>;
 }

packages/twenty-server/src/modules/workflow/workflow-runner/workflow-runner.job.ts

@@ -1,54 +1,51 @@
+import { Scope } from '@nestjs/common';
+
 import { Process } from 'src/engine/integrations/message-queue/decorators/process.decorator';
 import { Processor } from 'src/engine/integrations/message-queue/decorators/processor.decorator';
 import { MessageQueue } from 'src/engine/integrations/message-queue/message-queue.constants';
-import { TwentyORMGlobalManager } from 'src/engine/twenty-orm/twenty-orm-global.manager';
-import { WorkflowWorkspaceEntity } from 'src/modules/workflow/common/standard-objects/workflow.workspace-entity';
+import { WorkflowRunStatus } from 'src/modules/workflow/common/standard-objects/workflow-run.workspace-entity';
 import { WorkflowCommonService } from 'src/modules/workflow/common/workflow-common.services';
 import { WorkflowRunnerService } from 'src/modules/workflow/workflow-runner/workflow-runner.service';
+import { WorkflowStatusWorkspaceService } from 'src/modules/workflow/workflow-status/workflow-status.workspace-service';
 
 export type RunWorkflowJobData = {
   workspaceId: string;
-  workflowId: string;
+  workflowVersionId: string;
+  workflowRunId: string;
   payload: object;
 };
 
-@Processor(MessageQueue.workflowQueue)
+@Processor({ queueName: MessageQueue.workflowQueue, scope: Scope.REQUEST })
 export class WorkflowRunnerJob {
   constructor(
     private readonly workflowCommonService: WorkflowCommonService,
     private readonly workflowRunnerService: WorkflowRunnerService,
-    private readonly twentyORMGlobalManager: TwentyORMGlobalManager,
+    private readonly workflowStatusWorkspaceService: WorkflowStatusWorkspaceService,
   ) {}
 
   @Process(WorkflowRunnerJob.name)
   async handle({
     workspaceId,
-    workflowId,
+    workflowVersionId,
+    workflowRunId,
     payload,
   }: RunWorkflowJobData): Promise<void> {
-    const workflowRepository =
-      await this.twentyORMGlobalManager.getRepositoryForWorkspace<WorkflowWorkspaceEntity>(
-        workspaceId,
-        'workflow',
-      );
-
-    const workflow = await workflowRepository.findOneByOrFail({
-      id: workflowId,
-    });
-
-    if (!workflow.publishedVersionId) {
-      throw new Error('Workflow has no published version');
-    }
+    await this.workflowStatusWorkspaceService.startWorkflowRun(workflowRunId);
 
     const workflowVersion = await this.workflowCommonService.getWorkflowVersion(
       workspaceId,
-      workflow.publishedVersionId,
+      workflowVersionId,
     );
 
-    await this.workflowRunnerService.run({
+    const output = await this.workflowRunnerService.run({
       action: workflowVersion.trigger.nextAction,
       workspaceId,
       payload,
     });
+
+    await this.workflowStatusWorkspaceService.endWorkflowRun(
+      workflowRunId,
+      output.error ? WorkflowRunStatus.FAILED : WorkflowRunStatus.COMPLETED,
+    );
   }
 }

packages/twenty-server/src/modules/workflow/workflow-runner/workflow-runner.module.ts

@@ -1,12 +1,17 @@
 import { Module } from '@nestjs/common';
 
-import { WorkflowRunnerService } from 'src/modules/workflow/workflow-runner/workflow-runner.service';
-import { WorkflowRunnerJob } from 'src/modules/workflow/workflow-runner/workflow-runner.job';
 import { WorkflowCommonModule } from 'src/modules/workflow/common/workflow-common.module';
 import { WorkflowActionRunnerModule } from 'src/modules/workflow/workflow-action-runner/workflow-action-runner.module';
+import { WorkflowRunnerJob } from 'src/modules/workflow/workflow-runner/workflow-runner.job';
+import { WorkflowRunnerService } from 'src/modules/workflow/workflow-runner/workflow-runner.service';
+import { WorkflowStatusModule } from 'src/modules/workflow/workflow-status/workflow-status.module';
 
 @Module({
-  imports: [WorkflowCommonModule, WorkflowActionRunnerModule],
+  imports: [
+    WorkflowCommonModule,
+    WorkflowActionRunnerModule,
+    WorkflowStatusModule,
+  ],
   providers: [WorkflowRunnerService, WorkflowRunnerJob],
   exports: [WorkflowRunnerService],
 })

packages/twenty-server/src/modules/workflow/workflow-runner/workflow-runner.service.ts

@@ -5,6 +5,11 @@ import { WorkflowActionRunnerFactory } from 'src/modules/workflow/workflow-actio
 
 const MAX_RETRIES_ON_FAILURE = 3;
 
+export type WorkflowRunOutput = {
+  data?: object;
+  error?: object;
+};
+
 @Injectable()
 export class WorkflowRunnerService {
   constructor(
@@ -21,9 +26,11 @@ export class WorkflowRunnerService {
     workspaceId: string;
     payload?: object;
     attemptCount?: number;
-  }) {
+  }): Promise<WorkflowRunOutput> {
     if (!action) {
-      return payload;
+      return {
+        data: payload,
+      };
     }
 
     const workflowActionRunner = this.workflowActionRunnerFactory.get(
@@ -68,6 +75,8 @@ export class WorkflowRunnerService {
       });
     }
 
-    return result.error;
+    return {
+      error: result.error,
+    };
   }
 }

packages/twenty-server/src/modules/workflow/workflow-status/workflow-status.exception.ts

@@ -0,0 +1,13 @@
+import { CustomException } from 'src/utils/custom-exception';
+
+export class WorkflowStatusException extends CustomException {
+  code: WorkflowStatusExceptionCode;
+  constructor(message: string, code: WorkflowStatusExceptionCode) {
+    super(message, code);
+  }
+}
+
+export enum WorkflowStatusExceptionCode {
+  WORKFLOW_RUN_NOT_FOUND = 'WORKFLOW_RUN_NOT_FOUND',
+  INVALID_OPERATION = 'INVALID_OPERATION',
+}

packages/twenty-server/src/modules/workflow/workflow-status/workflow-status.module.ts

@@ -0,0 +1,12 @@
+import { Module } from '@nestjs/common';
+
+import { TwentyORMModule } from 'src/engine/twenty-orm/twenty-orm.module';
+import { WorkflowRunWorkspaceEntity } from 'src/modules/workflow/common/standard-objects/workflow-run.workspace-entity';
+import { WorkflowStatusWorkspaceService } from 'src/modules/workflow/workflow-status/workflow-status.workspace-service';
+
+@Module({
+  imports: [TwentyORMModule.forFeature([WorkflowRunWorkspaceEntity])],
+  providers: [WorkflowStatusWorkspaceService],
+  exports: [WorkflowStatusWorkspaceService],
+})
+export class WorkflowStatusModule {}