8643 fix sentry error (#8644)

- fixes missing data in event payload when adding a new workspaceMember - add strong typing to database event emitters
2024-11-21 17:09:36 +01:00
parent 395da91071
commit 39373b4a28
61 changed files with 460 additions and 311 deletions
--- a/packages/twenty-server/src/modules/workflow/common/query-hooks/workflow-create-many.post-query.hook.ts
+++ b/packages/twenty-server/src/modules/workflow/common/query-hooks/workflow-create-many.post-query.hook.ts
@ -7,7 +7,6 @@ import { WorkspaceQueryPostHookInstance } from 'src/engine/api/graphql/workspace
 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 { ObjectRecordCreateEvent } from 'src/engine/core-modules/event-emitter/types/object-record-create.event';
 import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
 import { TwentyORMManager } from 'src/engine/twenty-orm/twenty-orm.manager';
 import { WorkspaceEventEmitter } from 'src/engine/workspace-event-emitter/workspace-event-emitter';
@ -62,9 +61,10 @@ export class WorkflowCreateManyPostQueryHook
      },
    });

-    this.workspaceEventEmitter.emit(
-      `workflowVersion.${DatabaseEventAction.CREATED}`,
-      workflowVersionsToCreate.map((workflowVersionToCreate) => {
+    this.workspaceEventEmitter.emitDatabaseBatchEvent({
+      objectMetadataNameSingular: 'workflowVersion',
+      action: DatabaseEventAction.CREATED,
+      events: workflowVersionsToCreate.map((workflowVersionToCreate) => {
        return {
          userId: authContext.user?.id,
          recordId: workflowVersionToCreate.id,
@ -72,9 +72,9 @@ export class WorkflowCreateManyPostQueryHook
          properties: {
            after: workflowVersionToCreate,
          },
-        } satisfies ObjectRecordCreateEvent<any>;
+        };
      }),
-      authContext.workspace.id,
-    );
+      workspaceId: authContext.workspace.id,
+    });
  }
 }
--- a/packages/twenty-server/src/modules/workflow/common/query-hooks/workflow-create-one.post-query.hook.ts
+++ b/packages/twenty-server/src/modules/workflow/common/query-hooks/workflow-create-one.post-query.hook.ts
@ -7,7 +7,6 @@ import { WorkspaceQueryPostHookInstance } from 'src/engine/api/graphql/workspace
 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 { ObjectRecordCreateEvent } from 'src/engine/core-modules/event-emitter/types/object-record-create.event';
 import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
 import { TwentyORMManager } from 'src/engine/twenty-orm/twenty-orm.manager';
 import { WorkspaceEventEmitter } from 'src/engine/workspace-event-emitter/workspace-event-emitter';
@ -58,9 +57,10 @@ export class WorkflowCreateOnePostQueryHook
      },
    });

-    this.workspaceEventEmitter.emit(
-      `workflowVersion.${DatabaseEventAction.CREATED}`,
-      [
+    this.workspaceEventEmitter.emitDatabaseBatchEvent({
+      objectMetadataNameSingular: 'workflowVersion',
+      action: DatabaseEventAction.CREATED,
+      events: [
        {
          userId: authContext.user?.id,
          recordId: workflowVersionToCreate.id,
@ -68,9 +68,9 @@ export class WorkflowCreateOnePostQueryHook
          properties: {
            after: workflowVersionToCreate,
          },
-        } satisfies ObjectRecordCreateEvent<any>,
+        },
      ],
-      authContext.workspace.id,
-    );
+      workspaceId: authContext.workspace.id,
+    });
  }
 }
--- a/packages/twenty-server/src/modules/workflow/workflow-status/constants/workflow-version-status-updated.constants.ts
+++ b/packages/twenty-server/src/modules/workflow/workflow-status/constants/workflow-version-status-updated.constants.ts
@ -0,0 +1,2 @@
+export const WORKFLOW_VERSION_STATUS_UPDATED =
+  'workflow_version_status_updated';
--- a/packages/twenty-server/src/modules/workflow/workflow-status/listeners/workflow-version-status.listener.ts
+++ b/packages/twenty-server/src/modules/workflow/workflow-status/listeners/workflow-version-status.listener.ts
@ -5,7 +5,7 @@ import { ObjectRecordDeleteEvent } from 'src/engine/core-modules/event-emitter/t
 import { InjectMessageQueue } from 'src/engine/core-modules/message-queue/decorators/message-queue.decorator';
 import { MessageQueue } from 'src/engine/core-modules/message-queue/message-queue.constants';
 import { MessageQueueService } from 'src/engine/core-modules/message-queue/services/message-queue.service';
-import { WorkspaceEventBatch } from 'src/engine/workspace-event-emitter/workspace-event.type';
+import { WorkspaceEventBatch } from 'src/engine/workspace-event-emitter/types/workspace-event.type';
 import {
  WorkflowVersionStatus,
  WorkflowVersionWorkspaceEntity,
@ -16,8 +16,10 @@ import {
  WorkflowVersionEventType,
  WorkflowVersionStatusUpdate,
 } from 'src/modules/workflow/workflow-status/jobs/workflow-statuses-update.job';
-import { OnDatabaseEvent } from 'src/engine/api/graphql/graphql-query-runner/decorators/on-database-event.decorator';
+import { OnDatabaseBatchEvent } from 'src/engine/api/graphql/graphql-query-runner/decorators/on-database-batch-event.decorator';
 import { DatabaseEventAction } from 'src/engine/api/graphql/graphql-query-runner/enums/database-event-action';
+import { WORKFLOW_VERSION_STATUS_UPDATED } from 'src/modules/workflow/workflow-status/constants/workflow-version-status-updated.constants';
+import { OnCustomBatchEvent } from 'src/engine/api/graphql/graphql-query-runner/decorators/on-custom-batch-event.decorator';

@Injectable()
 export class WorkflowVersionStatusListener {
@ -26,13 +28,13 @@ export class WorkflowVersionStatusListener {
    private readonly messageQueueService: MessageQueueService,
  ) {}

-  @OnDatabaseEvent('workflowVersion', DatabaseEventAction.CREATED)
+  @OnDatabaseBatchEvent('workflowVersion', DatabaseEventAction.CREATED)
  async handleWorkflowVersionCreated(
-    payload: WorkspaceEventBatch<
+    batchEvent: WorkspaceEventBatch<
      ObjectRecordCreateEvent<WorkflowVersionWorkspaceEntity>
    >,
  ): Promise<void> {
-    const workflowIds = payload.events
+    const workflowIds = batchEvent.events
      .filter(
        (event) =>
          !event.properties.after.status ||
@ -48,33 +50,33 @@ export class WorkflowVersionStatusListener {
      WorkflowStatusesUpdateJob.name,
      {
        type: WorkflowVersionEventType.CREATE,
-        workspaceId: payload.workspaceId,
+        workspaceId: batchEvent.workspaceId,
        workflowIds,
      },
    );
  }

-  @OnDatabaseEvent('workflowVersion', DatabaseEventAction.UPDATED)
+  @OnCustomBatchEvent(WORKFLOW_VERSION_STATUS_UPDATED)
  async handleWorkflowVersionUpdated(
-    payload: WorkspaceEventBatch<WorkflowVersionStatusUpdate>,
+    batchEvent: WorkspaceEventBatch<WorkflowVersionStatusUpdate>,
  ): Promise<void> {
    await this.messageQueueService.add<WorkflowVersionBatchEvent>(
      WorkflowStatusesUpdateJob.name,
      {
        type: WorkflowVersionEventType.STATUS_UPDATE,
-        workspaceId: payload.workspaceId,
-        statusUpdates: payload.events,
+        workspaceId: batchEvent.workspaceId,
+        statusUpdates: batchEvent.events,
      },
    );
  }

-  @OnDatabaseEvent('workflowVersion', DatabaseEventAction.DELETED)
+  @OnDatabaseBatchEvent('workflowVersion', DatabaseEventAction.DELETED)
  async handleWorkflowVersionDeleted(
-    payload: WorkspaceEventBatch<
+    batchEvent: WorkspaceEventBatch<
      ObjectRecordDeleteEvent<WorkflowVersionWorkspaceEntity>
    >,
  ): Promise<void> {
-    const workflowIds = payload.events
+    const workflowIds = batchEvent.events
      .filter(
        (event) =>
          event.properties.before.status === WorkflowVersionStatus.DRAFT,
@ -89,7 +91,7 @@ export class WorkflowVersionStatusListener {
      WorkflowStatusesUpdateJob.name,
      {
        type: WorkflowVersionEventType.DELETE,
-        workspaceId: payload.workspaceId,
+        workspaceId: batchEvent.workspaceId,
        workflowIds,
      },
    );
--- a/packages/twenty-server/src/modules/workflow/workflow-trigger/database-event-trigger/listeners/database-event-trigger.listener.ts
+++ b/packages/twenty-server/src/modules/workflow/workflow-trigger/database-event-trigger/listeners/database-event-trigger.listener.ts
@ -10,13 +10,13 @@ import { InjectMessageQueue } from 'src/engine/core-modules/message-queue/decora
 import { MessageQueue } from 'src/engine/core-modules/message-queue/message-queue.constants';
 import { MessageQueueService } from 'src/engine/core-modules/message-queue/services/message-queue.service';
 import { TwentyORMGlobalManager } from 'src/engine/twenty-orm/twenty-orm-global.manager';
-import { WorkspaceEventBatch } from 'src/engine/workspace-event-emitter/workspace-event.type';
+import { WorkspaceEventBatch } from 'src/engine/workspace-event-emitter/types/workspace-event.type';
 import { WorkflowEventListenerWorkspaceEntity } from 'src/modules/workflow/common/standard-objects/workflow-event-listener.workspace-entity';
 import {
  WorkflowEventTriggerJob,
  WorkflowEventTriggerJobData,
 } from 'src/modules/workflow/workflow-trigger/jobs/workflow-event-trigger.job';
-import { OnDatabaseEvent } from 'src/engine/api/graphql/graphql-query-runner/decorators/on-database-event.decorator';
+import { OnDatabaseBatchEvent } from 'src/engine/api/graphql/graphql-query-runner/decorators/on-database-batch-event.decorator';
 import { DatabaseEventAction } from 'src/engine/api/graphql/graphql-query-runner/enums/database-event-action';

@Injectable()
@ -30,40 +30,40 @@ export class DatabaseEventTriggerListener {
    private readonly isFeatureFlagEnabledService: FeatureFlagService,
  ) {}

-  @OnDatabaseEvent('*', DatabaseEventAction.CREATED)
+  @OnDatabaseBatchEvent('*', DatabaseEventAction.CREATED)
  async handleObjectRecordCreateEvent(
-    payload: WorkspaceEventBatch<ObjectRecordCreateEvent<any>>,
+    payload: WorkspaceEventBatch<ObjectRecordCreateEvent>,
  ) {
    await this.handleEvent(payload);
  }

-  @OnDatabaseEvent('*', DatabaseEventAction.UPDATED)
+  @OnDatabaseBatchEvent('*', DatabaseEventAction.UPDATED)
  async handleObjectRecordUpdateEvent(
-    payload: WorkspaceEventBatch<ObjectRecordUpdateEvent<any>>,
+    payload: WorkspaceEventBatch<ObjectRecordUpdateEvent>,
  ) {
    await this.handleEvent(payload);
  }

-  @OnDatabaseEvent('*', DatabaseEventAction.DELETED)
+  @OnDatabaseBatchEvent('*', DatabaseEventAction.DELETED)
  async handleObjectRecordDeleteEvent(
-    payload: WorkspaceEventBatch<ObjectRecordDeleteEvent<any>>,
+    payload: WorkspaceEventBatch<ObjectRecordDeleteEvent>,
  ) {
    await this.handleEvent(payload);
  }

-  @OnDatabaseEvent('*', DatabaseEventAction.DESTROYED)
+  @OnDatabaseBatchEvent('*', DatabaseEventAction.DESTROYED)
  async handleObjectRecordDestroyEvent(
-    payload: WorkspaceEventBatch<ObjectRecordDestroyEvent<any>>,
+    payload: WorkspaceEventBatch<ObjectRecordDestroyEvent>,
  ) {
    await this.handleEvent(payload);
  }

  private async handleEvent(
    payload: WorkspaceEventBatch<
-      | ObjectRecordCreateEvent<any>
-      | ObjectRecordUpdateEvent<any>
-      | ObjectRecordDeleteEvent<any>
-      | ObjectRecordDestroyEvent<any>
+      | ObjectRecordCreateEvent
+      | ObjectRecordUpdateEvent
+      | ObjectRecordDeleteEvent
+      | ObjectRecordDestroyEvent
    >,
  ) {
    const workspaceId = payload.workspaceId;
--- a/packages/twenty-server/src/modules/workflow/workflow-trigger/workflow-trigger.module.ts
+++ b/packages/twenty-server/src/modules/workflow/workflow-trigger/workflow-trigger.module.ts
@ -1,17 +1,21 @@
 import { Module } from '@nestjs/common';

+import { NestjsQueryTypeOrmModule } from '@ptc-org/nestjs-query-typeorm';
+
 import { ScopedWorkspaceContextFactory } from 'src/engine/twenty-orm/factories/scoped-workspace-context.factory';
 import { WorkflowCommonModule } from 'src/modules/workflow/common/workflow-common.module';
 import { WorkflowRunnerModule } from 'src/modules/workflow/workflow-runner/workflow-runner.module';
 import { DatabaseEventTriggerModule } from 'src/modules/workflow/workflow-trigger/database-event-trigger/database-event-trigger.module';
 import { WorkflowEventTriggerJob } from 'src/modules/workflow/workflow-trigger/jobs/workflow-event-trigger.job';
 import { WorkflowTriggerWorkspaceService } from 'src/modules/workflow/workflow-trigger/workspace-services/workflow-trigger.workspace-service';
+import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';

@Module({
  imports: [
    WorkflowCommonModule,
    WorkflowRunnerModule,
    DatabaseEventTriggerModule,
+    NestjsQueryTypeOrmModule.forFeature([ObjectMetadataEntity], 'metadata'),
  ],
  providers: [
    WorkflowTriggerWorkspaceService,
--- a/packages/twenty-server/src/modules/workflow/workflow-trigger/workspace-services/workflow-trigger.workspace-service.ts
+++ b/packages/twenty-server/src/modules/workflow/workflow-trigger/workspace-services/workflow-trigger.workspace-service.ts
@ -1,6 +1,7 @@
 import { Injectable } from '@nestjs/common';
+import { InjectRepository } from '@nestjs/typeorm';

-import { EntityManager } from 'typeorm';
+import { EntityManager, Repository } from 'typeorm';

 import { buildCreatedByFromWorkspaceMember } from 'src/engine/core-modules/actor/utils/build-created-by-from-workspace-member.util';
 import { User } from 'src/engine/core-modules/user/user.entity';
@ -16,7 +17,6 @@ import { WorkflowWorkspaceEntity } from 'src/modules/workflow/common/standard-ob
 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 {
  WorkflowTriggerException,
@ -26,6 +26,8 @@ import { WorkflowTriggerType } from 'src/modules/workflow/workflow-trigger/types
 import { assertVersionCanBeActivated } from 'src/modules/workflow/workflow-trigger/utils/assert-version-can-be-activated.util';
 import { assertNever } from 'src/utils/assert';
 import { DatabaseEventAction } from 'src/engine/api/graphql/graphql-query-runner/enums/database-event-action';
+import { WORKFLOW_VERSION_STATUS_UPDATED } from 'src/modules/workflow/workflow-status/constants/workflow-version-status-updated.constants';
+import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';

@Injectable()
 export class WorkflowTriggerWorkspaceService {
@ -36,14 +38,11 @@ export class WorkflowTriggerWorkspaceService {
    private readonly workflowRunnerWorkspaceService: WorkflowRunnerWorkspaceService,
    private readonly databaseEventTriggerService: DatabaseEventTriggerService,
    private readonly workspaceEventEmitter: WorkspaceEventEmitter,
+    @InjectRepository(ObjectMetadataEntity, 'metadata')
+    private readonly objectMetadataRepository: Repository<ObjectMetadataEntity>,
  ) {}

-  async runWorkflowVersion(
-    workflowVersionId: string,
-    payload: object,
-    workspaceMemberId: string,
-    user: User,
-  ) {
+  private getWorkspaceId() {
    const workspaceId = this.scopedWorkspaceContextFactory.create().workspaceId;

    if (!workspaceId) {
@ -53,12 +52,21 @@ export class WorkflowTriggerWorkspaceService {
      );
    }

+    return workspaceId;
+  }
+
+  async runWorkflowVersion(
+    workflowVersionId: string,
+    payload: object,
+    workspaceMemberId: string,
+    user: User,
+  ) {
    await this.workflowCommonWorkspaceService.getWorkflowVersionOrFail(
      workflowVersionId,
    );

    return await this.workflowRunnerWorkspaceService.run(
-      workspaceId,
+      this.getWorkspaceId(),
      workflowVersionId,
      payload,
      buildCreatedByFromWorkspaceMember(workspaceMemberId, user),
@ -246,10 +254,10 @@ export class WorkflowTriggerWorkspaceService {
      manager,
    );

-    this.emitStatusUpdateEventOrThrow(
-      workflowVersion.workflowId,
-      workflowVersion.status,
+    await this.emitStatusUpdateEvents(
+      workflowVersion,
      WorkflowVersionStatus.ACTIVE,
+      this.getWorkspaceId(),
    );
  }

@ -271,10 +279,10 @@ export class WorkflowTriggerWorkspaceService {
      manager,
    );

-    this.emitStatusUpdateEventOrThrow(
-      workflowVersion.workflowId,
-      workflowVersion.status,
+    await this.emitStatusUpdateEvents(
+      workflowVersion,
      WorkflowVersionStatus.DEACTIVATED,
+      this.getWorkspaceId(),
    );
  }

@ -348,28 +356,45 @@ export class WorkflowTriggerWorkspaceService {
    }
  }

-  private emitStatusUpdateEventOrThrow(
-    workflowId: string,
-    previousStatus: WorkflowVersionStatus,
+  private async emitStatusUpdateEvents(
+    workflowVersion: WorkflowVersionWorkspaceEntity,
    newStatus: WorkflowVersionStatus,
+    workspaceId: string,
  ) {
-    const workspaceId = this.scopedWorkspaceContextFactory.create().workspaceId;
+    const objectMetadata = await this.objectMetadataRepository.findOneOrFail({
+      where: {
+        nameSingular: 'workflowVersion',
+      },
+    });

-    if (!workspaceId) {
-      throw new WorkflowTriggerException(
-        'No workspace id found',
-        WorkflowTriggerExceptionCode.INTERNAL_ERROR,
-      );
-    }
+    this.workspaceEventEmitter.emitDatabaseBatchEvent({
+      objectMetadataNameSingular: 'workflowVersion',
+      action: DatabaseEventAction.UPDATED,
+      events: [
+        {
+          recordId: workflowVersion.id,
+          objectMetadata,
+          properties: {
+            before: workflowVersion,
+            after: { ...workflowVersion, status: newStatus },
+            updatedFields: ['status'],
+            diff: {
+              status: { before: workflowVersion.status, after: newStatus },
+            },
+          },
+        },
+      ],
+      workspaceId,
+    });

-    this.workspaceEventEmitter.emit(
-      `workflowVersion.${DatabaseEventAction.UPDATED}`,
+    this.workspaceEventEmitter.emitCustomBatchEvent(
+      WORKFLOW_VERSION_STATUS_UPDATED,
      [
        {
-          workflowId,
-          previousStatus,
+          workflowId: workflowVersion.workflowId,
+          previousStatus: workflowVersion.status,
          newStatus,
-        } satisfies WorkflowVersionStatusUpdate,
+        },
      ],
      workspaceId,
    );