Add workflow run entity (#6622)

- create a workflow run every time a workflow is triggered in
not_started status. This status will be helpful later for once workflows
will be scheduled
- update run status once workflow starts running
- complete status once the workflow finished running
- add a failed status if an error occurs

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,9 @@
+import { Module } from '@nestjs/common';
+
+import { WorkflowStatusWorkspaceService } from 'src/modules/workflow/workflow-status/workflow-status.workspace-service';
+
+@Module({
+  providers: [WorkflowStatusWorkspaceService],
+  exports: [WorkflowStatusWorkspaceService],
+})
+export class WorkflowStatusModule {}

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

@@ -0,0 +1,92 @@
+import { Injectable } from '@nestjs/common';
+
+import { ActorMetadata } from 'src/engine/metadata-modules/field-metadata/composite-types/actor.composite-type';
+import { TwentyORMManager } from 'src/engine/twenty-orm/twenty-orm.manager';
+import {
+  WorkflowRunStatus,
+  WorkflowRunWorkspaceEntity,
+} from 'src/modules/workflow/common/standard-objects/workflow-run.workspace-entity';
+import {
+  WorkflowStatusException,
+  WorkflowStatusExceptionCode,
+} from 'src/modules/workflow/workflow-status/workflow-status.exception';
+
+@Injectable()
+export class WorkflowStatusWorkspaceService {
+  constructor(private readonly twentyORMManager: TwentyORMManager) {}
+
+  async createWorkflowRun(workflowVersionId: string, createdBy: ActorMetadata) {
+    const workflowRunRepository =
+      await this.twentyORMManager.getRepository<WorkflowRunWorkspaceEntity>(
+        'workflowRun',
+      );
+
+    return (
+      await workflowRunRepository.save({
+        workflowVersionId,
+        createdBy,
+        status: WorkflowRunStatus.NOT_STARTED,
+      })
+    ).id;
+  }
+
+  async startWorkflowRun(workflowRunId: string) {
+    const workflowRunRepository =
+      await this.twentyORMManager.getRepository<WorkflowRunWorkspaceEntity>(
+        'workflowRun',
+      );
+
+    const workflowRunToUpdate = await workflowRunRepository.findOneBy({
+      id: workflowRunId,
+    });
+
+    if (!workflowRunToUpdate) {
+      throw new WorkflowStatusException(
+        'No workflow run to start',
+        WorkflowStatusExceptionCode.WORKFLOW_RUN_NOT_FOUND,
+      );
+    }
+
+    if (workflowRunToUpdate.status !== WorkflowRunStatus.NOT_STARTED) {
+      throw new WorkflowStatusException(
+        'Workflow run already started',
+        WorkflowStatusExceptionCode.INVALID_OPERATION,
+      );
+    }
+
+    return workflowRunRepository.update(workflowRunToUpdate.id, {
+      status: WorkflowRunStatus.RUNNING,
+      startedAt: new Date().toISOString(),
+    });
+  }
+
+  async endWorkflowRun(workflowRunId: string, status: WorkflowRunStatus) {
+    const workflowRunRepository =
+      await this.twentyORMManager.getRepository<WorkflowRunWorkspaceEntity>(
+        'workflowRun',
+      );
+
+    const workflowRunToUpdate = await workflowRunRepository.findOneBy({
+      id: workflowRunId,
+    });
+
+    if (!workflowRunToUpdate) {
+      throw new WorkflowStatusException(
+        'No workflow run to end',
+        WorkflowStatusExceptionCode.WORKFLOW_RUN_NOT_FOUND,
+      );
+    }
+
+    if (workflowRunToUpdate.status !== WorkflowRunStatus.RUNNING) {
+      throw new WorkflowStatusException(
+        'Workflow cannot be ended as it is not running',
+        WorkflowStatusExceptionCode.INVALID_OPERATION,
+      );
+    }
+
+    return workflowRunRepository.update(workflowRunToUpdate.id, {
+      status,
+      endedAt: new Date().toISOString(),
+    });
+  }
+}