Add db event emitter in twenty orm (#13167)

## Context
Add an eventEmitter instance to twenty datasources so we can emit DB
events.
Add input and output formatting to twenty orm (formatData, formatResult)
Those 2 elements simplified existing logic when we interact with the
ORM, input will be formatted by the ORM so we can directly use
field-like structure instead of column-like. The output will be
formatted, for builder queries it will be in `result.generatedMaps`
where `result.raw` preserves the previous column-like structure.

Important change: We now have an authContext that we can pass when we
get a repository, this will be used for the different events emitted in
the ORM. We also removed the caching for repositories as it was not
scaling well and not necessary imho

Note: An upcoming PR should handle the onDelete: cascade behavior where
we send DESTROY events in cascade when there is an onDelete: CASCADE on
the FK.

---------

Co-authored-by: Charles Bochet <charles@twenty.com>
This commit is contained in:
Weiko
2025-07-17 18:07:28 +02:00
committed by GitHub
parent 4a3139c9e0
commit 2deac9448e
79 changed files with 1061 additions and 2016 deletions
@@ -8,11 +8,11 @@ import { DeleteOneResolverArgs } from 'src/engine/api/graphql/workspace-resolver
import { DatabaseEventAction } from 'src/engine/api/graphql/graphql-query-runner/enums/database-event-action';
import { WorkspaceQueryHook } from 'src/engine/api/graphql/workspace-query-runner/workspace-query-hook/decorators/workspace-query-hook.decorator';
import { AuthContext } from 'src/engine/core-modules/auth/types/auth-context.type';
import { workspaceValidator } from 'src/engine/core-modules/workspace/workspace.validate';
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';
import { MessageChannelWorkspaceEntity } from 'src/modules/messaging/common/standard-objects/message-channel.workspace-entity';
import { workspaceValidator } from 'src/engine/core-modules/workspace/workspace.validate';
@WorkspaceQueryHook(`connectedAccount.destroyOne`)
export class ConnectedAccountDeleteOnePreQueryHook
@@ -52,6 +52,7 @@ export class ConnectedAccountDeleteOnePreQueryHook
},
});
// TODO: handle cascade events for delete
this.workspaceEventEmitter.emitDatabaseBatchEvent({
objectMetadataNameSingular: 'messageChannel',
action: DatabaseEventAction.DESTROYED,
@@ -1,18 +1,14 @@
import { Injectable } from '@nestjs/common';
import { InjectRepository } from '@nestjs/typeorm';
import { ConnectedAccountProvider } from 'twenty-shared/types';
import { v4 } from 'uuid';
import { DatabaseEventAction } from 'src/engine/api/graphql/graphql-query-runner/enums/database-event-action';
import { EmailAccountConnectionParameters } from 'src/engine/core-modules/imap-smtp-caldav-connection/dtos/imap-smtp-caldav-connection.dto';
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 { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
import { WorkspaceRepository } from 'src/engine/twenty-orm/repository/workspace.repository';
import { TwentyORMGlobalManager } from 'src/engine/twenty-orm/twenty-orm-global.manager';
import { WorkspaceEventEmitter } from 'src/engine/workspace-event-emitter/workspace-event-emitter';
import {
CalendarEventListFetchJob,
CalendarEventListFetchJobData,
@@ -42,9 +38,6 @@ export class ImapSmtpCalDavAPIService {
private readonly messageQueueService: MessageQueueService,
@InjectMessageQueue(MessageQueue.calendarQueue)
private readonly calendarQueueService: MessageQueueService,
private readonly workspaceEventEmitter: WorkspaceEventEmitter,
@InjectRepository(ObjectMetadataEntity, 'core')
private readonly objectMetadataRepository: WorkspaceRepository<ObjectMetadataEntity>,
) {}
async setupCompleteAccount(input: {
@@ -97,7 +90,6 @@ export class ImapSmtpCalDavAPIService {
await this.upsertConnectedAccount(
input,
accountId,
existingAccount,
connectedAccountRepository,
);
@@ -116,7 +108,6 @@ export class ImapSmtpCalDavAPIService {
await this.enqueueSyncJobs(
input,
accountId,
workspaceId,
createdMessageChannel,
createdCalendarChannel,
@@ -131,7 +122,6 @@ export class ImapSmtpCalDavAPIService {
connectionParameters: EmailAccountConnectionParameters;
},
accountId: string,
existingAccount: ConnectedAccountWorkspaceEntity | null,
connectedAccountRepository: WorkspaceRepository<ConnectedAccountWorkspaceEntity>,
) {
const accountData = {
@@ -142,48 +132,7 @@ export class ImapSmtpCalDavAPIService {
accountOwnerId: input.workspaceMemberId,
};
const savedAccount = await connectedAccountRepository.save(accountData, {});
const connectedAccountMetadata =
await this.objectMetadataRepository.findOneOrFail({
where: {
nameSingular: 'connectedAccount',
workspaceId: input.workspaceId,
},
});
if (existingAccount) {
this.workspaceEventEmitter.emitDatabaseBatchEvent({
objectMetadataNameSingular: 'connectedAccount',
action: DatabaseEventAction.UPDATED,
events: [
{
recordId: savedAccount.id,
objectMetadata: connectedAccountMetadata,
properties: {
before: existingAccount,
after: savedAccount,
},
},
],
workspaceId: input.workspaceId,
});
} else {
this.workspaceEventEmitter.emitDatabaseBatchEvent({
objectMetadataNameSingular: 'connectedAccount',
action: DatabaseEventAction.CREATED,
events: [
{
recordId: savedAccount.id,
objectMetadata: connectedAccountMetadata,
properties: {
after: savedAccount,
},
},
],
workspaceId: input.workspaceId,
});
}
await connectedAccountRepository.save(accountData, {});
}
private async setupMessageChannels(
@@ -226,29 +175,6 @@ export class ImapSmtpCalDavAPIService {
{},
);
const messageChannelMetadata =
await this.objectMetadataRepository.findOneOrFail({
where: {
nameSingular: 'messageChannel',
workspaceId: input.workspaceId,
},
});
this.workspaceEventEmitter.emitDatabaseBatchEvent({
objectMetadataNameSingular: 'messageChannel',
action: DatabaseEventAction.CREATED,
events: [
{
recordId: newMessageChannel.id,
objectMetadata: messageChannelMetadata,
properties: {
after: newMessageChannel,
},
},
],
workspaceId: input.workspaceId,
});
return shouldEnableSync ? newMessageChannel : null;
}
@@ -289,29 +215,6 @@ export class ImapSmtpCalDavAPIService {
{},
);
const calendarChannelMetadata =
await this.objectMetadataRepository.findOneOrFail({
where: {
nameSingular: 'calendarChannel',
workspaceId: input.workspaceId,
},
});
this.workspaceEventEmitter.emitDatabaseBatchEvent({
objectMetadataNameSingular: 'calendarChannel',
action: DatabaseEventAction.CREATED,
events: [
{
recordId: newCalendarChannel.id,
objectMetadata: calendarChannelMetadata,
properties: {
after: newCalendarChannel,
},
},
],
workspaceId: input.workspaceId,
});
return newCalendarChannel;
}
@@ -322,7 +225,6 @@ export class ImapSmtpCalDavAPIService {
input: {
connectionParameters: EmailAccountConnectionParameters;
},
accountId: string,
workspaceId: string,
messageChannel: MessageChannelWorkspaceEntity | null,
calendarChannel: CalendarChannelWorkspaceEntity | null,