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

View File

@ -1,12 +1,18 @@
import { Injectable } from '@nestjs/common';
import { EventEmitter2 } from '@nestjs/event-emitter';
import { ObjectLiteral } from 'typeorm';
import { DatabaseEventAction } from 'src/engine/api/graphql/graphql-query-runner/enums/database-event-action';
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 { ObjectRecordDeleteEvent } from 'src/engine/core-modules/event-emitter/types/object-record-delete.event';
import { ObjectRecordDestroyEvent } from 'src/engine/core-modules/event-emitter/types/object-record-destroy.event';
import { ObjectRecordDiff } from 'src/engine/core-modules/event-emitter/types/object-record-diff';
import { ObjectRecordRestoreEvent } from 'src/engine/core-modules/event-emitter/types/object-record-restore.event';
import { ObjectRecordUpdateEvent } from 'src/engine/core-modules/event-emitter/types/object-record-update.event';
import { objectRecordChangedValues } from 'src/engine/core-modules/event-emitter/utils/object-record-changed-values';
import { ObjectMetadataItemWithFieldMaps } from 'src/engine/metadata-modules/types/object-metadata-item-with-field-maps';
import { CustomEventName } from 'src/engine/workspace-event-emitter/types/custom-event-name.type';
type ActionEventMap<T> = {
@ -21,6 +27,105 @@ type ActionEventMap<T> = {
export class WorkspaceEventEmitter {
constructor(private readonly eventEmitter: EventEmitter2) {}
async emitMutationEvent<T extends ObjectLiteral>({
action,
objectMetadataItem,
workspaceId,
authContext,
entities,
beforeEntities,
}: {
action: DatabaseEventAction;
objectMetadataItem: ObjectMetadataItemWithFieldMaps;
workspaceId: string;
authContext?: AuthContext;
entities: T | T[];
beforeEntities?: T | T[];
}) {
const objectMetadataNameSingular = objectMetadataItem.nameSingular;
const fields = Object.values(objectMetadataItem.fieldsById ?? {});
const entityArray = Array.isArray(entities) ? entities : [entities];
let events: (
| ObjectRecordCreateEvent<T>
| ObjectRecordUpdateEvent<T>
| ObjectRecordDeleteEvent<T>
)[] = [];
switch (action) {
case DatabaseEventAction.CREATED:
events = entityArray.map((after) => {
const event = new ObjectRecordCreateEvent<T>();
event.userId = authContext?.user?.id;
event.recordId = after.id;
event.objectMetadata = { ...objectMetadataItem, fields };
event.properties = { after };
return event;
});
break;
case DatabaseEventAction.UPDATED:
events = entityArray.map((after, idx) => {
if (!beforeEntities) {
throw new Error('beforeEntities is required for UPDATED action');
}
const before = Array.isArray(beforeEntities)
? beforeEntities?.[idx]
: beforeEntities;
const diff = objectRecordChangedValues(
before,
after,
objectMetadataItem,
) as Partial<ObjectRecordDiff<T>>;
const updatedFields = Object.keys(diff);
const event = new ObjectRecordUpdateEvent<T>();
event.userId = authContext?.user?.id;
event.recordId = after.id;
event.objectMetadata = { ...objectMetadataItem, fields };
event.properties = {
before,
after,
updatedFields,
diff,
};
return event;
});
break;
case DatabaseEventAction.DELETED:
events = entityArray.map((before) => {
const event = new ObjectRecordDeleteEvent<T>();
event.userId = authContext?.user?.id;
event.recordId = before.id;
event.objectMetadata = { ...objectMetadataItem, fields };
event.properties = { before };
return event;
});
break;
default:
return;
}
if (!events.length) {
return;
}
const eventName = `${objectMetadataNameSingular}.${action}`;
this.eventEmitter.emit(eventName, {
name: eventName,
workspaceId,
events,
});
}
public emitDatabaseBatchEvent<T, A extends keyof ActionEventMap<T>>({
objectMetadataNameSingular,
action,