8643 fix sentry error (#8644)

- fixes missing data in event payload when adding a new workspaceMember
- add strong typing to database event emitters
This commit is contained in:
martmull
2024-11-21 17:09:36 +01:00
committed by GitHub
parent 395da91071
commit 39373b4a28
61 changed files with 460 additions and 311 deletions

View File

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

View File

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

View File

@ -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,
);