Skip to content

The open alternative to Salesforce, designed for AI.

feat(event-logs): log record restores and permanent deletes (#26538)

martmull1dd50813deb7
diff --git a/packages/twenty-server/src/engine/api/graphql/workspace-query-runner/listeners/entity-events-to-db.listener.ts b/packages/twenty-server/src/engine/api/graphql/workspace-query-runner/listeners/entity-events-to-db.listener.ts
index f2f254cb2fc..58f4e9ca0ab 100644
--- a/packages/twenty-server/src/engine/api/graphql/workspace-query-runner/listeners/entity-events-to-db.listener.ts
+++ b/packages/twenty-server/src/engine/api/graphql/workspace-query-runner/listeners/entity-events-to-db.listener.ts
@@ -123,7 +123,7 @@ export class EntityEventsToDbListener {
);
}
- if (isAuditLogBatchEvent && action !== DatabaseEventAction.DESTROYED) {
+ if (isAuditLogBatchEvent) {
promises.push(this.enqueueEventLogIfEntitled(batchEvent));
}
diff --git a/packages/twenty-server/src/engine/core-modules/event-logs/emit/events.type.ts b/packages/twenty-server/src/engine/core-modules/event-logs/emit/events.type.ts
index e3fd25209ac..319334aebcf 100644
--- a/packages/twenty-server/src/engine/core-modules/event-logs/emit/events.type.ts
+++ b/packages/twenty-server/src/engine/core-modules/event-logs/emit/events.type.ts
@@ -14,6 +14,14 @@ import {
type OBJECT_RECORD_UPSERTED_EVENT,
type ObjectRecordUpsertedTrackEvent,
} from 'src/engine/core-modules/event-logs/emit/events/object-event/object-record-upserted';
+import {
+ type OBJECT_RECORD_RESTORED_EVENT,
+ type ObjectRecordRestoredTrackEvent,
+} from 'src/engine/core-modules/event-logs/emit/events/object-event/object-record-restored';
+import {
+ type OBJECT_RECORD_DESTROYED_EVENT,
+ type ObjectRecordDestroyedTrackEvent,
+} from 'src/engine/core-modules/event-logs/emit/events/object-event/object-record-destroyed';
import {
type CUSTOM_DOMAIN_ACTIVATED_EVENT,
type CustomDomainActivatedTrackEvent,
@@ -66,6 +74,8 @@ export type TrackEventName =
| typeof OBJECT_RECORD_UPDATED_EVENT
| typeof OBJECT_RECORD_DELETED_EVENT
| typeof OBJECT_RECORD_UPSERTED_EVENT
+ | typeof OBJECT_RECORD_RESTORED_EVENT
+ | typeof OBJECT_RECORD_DESTROYED_EVENT
| typeof USER_SIGNUP_EVENT
| typeof WORKSPACE_CREATED_EVENT
| typeof PAYMENT_RECEIVED_EVENT
@@ -83,6 +93,8 @@ export interface TrackEvents {
[OBJECT_RECORD_CREATED_EVENT]: ObjectRecordCreatedTrackEvent;
[OBJECT_RECORD_UPDATED_EVENT]: ObjectRecordUpdatedTrackEvent;
[OBJECT_RECORD_UPSERTED_EVENT]: ObjectRecordUpsertedTrackEvent;
+ [OBJECT_RECORD_RESTORED_EVENT]: ObjectRecordRestoredTrackEvent;
+ [OBJECT_RECORD_DESTROYED_EVENT]: ObjectRecordDestroyedTrackEvent;
[WORKSPACE_CREATED_EVENT]: WorkspaceCreatedTrackEvent;
[PAYMENT_RECEIVED_EVENT]: PaymentReceivedTrackEvent;
[SERVER_ADMIN_ACCESS_CHANGED_EVENT]: ServerAdminAccessChangedTrackEvent;
diff --git a/packages/twenty-server/src/engine/core-modules/event-logs/emit/events/object-event/object-record-destroyed.ts b/packages/twenty-server/src/engine/core-modules/event-logs/emit/events/object-event/object-record-destroyed.ts
new file mode 100644
index 00000000000..c374572178c
--- /dev/null
+++ b/packages/twenty-server/src/engine/core-modules/event-logs/emit/events/object-event/object-record-destroyed.ts
@@ -0,0 +1,15 @@
+import { z } from 'zod';
+
+import { registerEvent } from 'src/engine/core-modules/event-logs/emit/events/workspace-event/track';
+
+export const OBJECT_RECORD_DESTROYED_EVENT = 'Object Record Destroyed' as const;
+export const objectRecordDestroyedSchema = z.object({
+ event: z.literal(OBJECT_RECORD_DESTROYED_EVENT),
+ properties: z.looseObject({}),
+});
+
+export type ObjectRecordDestroyedTrackEvent = z.infer<
+ typeof objectRecordDestroyedSchema
+>;
+
+registerEvent(OBJECT_RECORD_DESTROYED_EVENT, objectRecordDestroyedSchema);
diff --git a/packages/twenty-server/src/engine/core-modules/event-logs/emit/events/object-event/object-record-restored.ts b/packages/twenty-server/src/engine/core-modules/event-logs/emit/events/object-event/object-record-restored.ts
new file mode 100644
index 00000000000..5014333ab86
--- /dev/null
+++ b/packages/twenty-server/src/engine/core-modules/event-logs/emit/events/object-event/object-record-restored.ts
@@ -0,0 +1,15 @@
+import { z } from 'zod';
+
+import { registerEvent } from 'src/engine/core-modules/event-logs/emit/events/workspace-event/track';
+
+export const OBJECT_RECORD_RESTORED_EVENT = 'Object Record Restored' as const;
+export const objectRecordRestoredSchema = z.object({
+ event: z.literal(OBJECT_RECORD_RESTORED_EVENT),
+ properties: z.looseObject({}),
+});
+
+export type ObjectRecordRestoredTrackEvent = z.infer<
+ typeof objectRecordRestoredSchema
+>;
+
+registerEvent(OBJECT_RECORD_RESTORED_EVENT, objectRecordRestoredSchema);
diff --git a/packages/twenty-server/src/engine/core-modules/event-logs/ingest/create-event-log-from-internal-event.spec.ts b/packages/twenty-server/src/engine/core-modules/event-logs/ingest/create-event-log-from-internal-event.spec.ts
index 141653ef526..6e2dfc0884f 100644
--- a/packages/twenty-server/src/engine/core-modules/event-logs/ingest/create-event-log-from-internal-event.spec.ts
+++ b/packages/twenty-server/src/engine/core-modules/event-logs/ingest/create-event-log-from-internal-event.spec.ts
@@ -44,6 +44,37 @@ describe('CreateEventLogFromInternalEvent', () => {
expect(ingestedEnvelopes[0].table).toBe('objectEvent');
});
+ it('logs record restores', async () => {
+ await handler.handle({ ...batch, name: 'company.restored' });
+
+ const ingestedEnvelopes = ingest.mock.calls[0]?.[0];
+
+ expect(ingest).toHaveBeenCalledTimes(1);
+ expect(ingestedEnvelopes[0].row.event).toBe('Object Record Restored');
+ });
+
+ it('logs permanent deletes without storing the record data', async () => {
+ const before = { id: 'record-1', name: 'Maple Consulting Inc.' };
+
+ await handler.handle({
+ ...batch,
+ name: 'company.destroyed',
+ events: [
+ { recordId: 'record-1', userId: 'user-1', properties: { before } },
+ ],
+ });
+
+ const ingestedEnvelopes = ingest.mock.calls[0]?.[0];
+
+ expect(ingest).toHaveBeenCalledTimes(1);
+ expect(ingestedEnvelopes[0].row).toMatchObject({
+ event: 'Object Record Destroyed',
+ recordId: 'record-1',
+ objectMetadataId: 'object-metadata-1',
+ });
+ expect(ingestedEnvelopes[0].row.properties).toEqual({});
+ });
+
it('requeues once on a transient ClickHouse network error instead of failing', async () => {
ingest.mockRejectedValue(transientError);
diff --git a/packages/twenty-server/src/engine/core-modules/event-logs/ingest/create-event-log-from-internal-event.ts b/packages/twenty-server/src/engine/core-modules/event-logs/ingest/create-event-log-from-internal-event.ts
index 5e4d6223fed..f0f5f627ed0 100644
--- a/packages/twenty-server/src/engine/core-modules/event-logs/ingest/create-event-log-from-internal-event.ts
+++ b/packages/twenty-server/src/engine/core-modules/event-logs/ingest/create-event-log-from-internal-event.ts
@@ -10,8 +10,11 @@ import {
buildObjectEventEnvelope,
computeEventContextFields,
} from 'src/engine/core-modules/event-logs/emit/build-event-envelope';
+import { type TrackEventName } from 'src/engine/core-modules/event-logs/emit/events.type';
import { OBJECT_RECORD_CREATED_EVENT } from 'src/engine/core-modules/event-logs/emit/events/object-event/object-record-created';
import { OBJECT_RECORD_DELETED_EVENT } from 'src/engine/core-modules/event-logs/emit/events/object-event/object-record-delete';
+import { OBJECT_RECORD_DESTROYED_EVENT } from 'src/engine/core-modules/event-logs/emit/events/object-event/object-record-destroyed';
+import { OBJECT_RECORD_RESTORED_EVENT } from 'src/engine/core-modules/event-logs/emit/events/object-event/object-record-restored';
import { OBJECT_RECORD_UPDATED_EVENT } from 'src/engine/core-modules/event-logs/emit/events/object-event/object-record-updated';
import { OBJECT_RECORD_UPSERTED_EVENT } from 'src/engine/core-modules/event-logs/emit/events/object-event/object-record-upserted';
import { InjectMessageQueue } from 'src/engine/core-modules/message-queue/decorators/message-queue.decorator';
@@ -33,6 +36,8 @@ const OBJECT_EVENT_BY_SUFFIX = {
'.updated': OBJECT_RECORD_UPDATED_EVENT,
'.deleted': OBJECT_RECORD_DELETED_EVENT,
'.upserted': OBJECT_RECORD_UPSERTED_EVENT,
+ '.restored': OBJECT_RECORD_RESTORED_EVENT,
+ '.destroyed': OBJECT_RECORD_DESTROYED_EVENT,
} as const;
@Processor(MessageQueue.eventLogQueue)
@@ -115,17 +120,22 @@ export class CreateEventLogFromInternalEvent {
userId: eventData.userId,
}),
event,
- this.objectProperties(batch, eventData),
+ this.objectProperties({ batch, eventData, event }),
),
);
}
- private objectProperties(
- batch: WorkspaceEventBatch<ObjectRecordEvent>,
- eventData: ObjectRecordEvent,
- ) {
+ private objectProperties({
+ batch,
+ eventData,
+ event,
+ }: {
+ batch: WorkspaceEventBatch<ObjectRecordEvent>;
+ eventData: ObjectRecordEvent;
+ event: TrackEventName;
+ }) {
return {
- ...eventData.properties,
+ ...(event === OBJECT_RECORD_DESTROYED_EVENT ? {} : eventData.properties),
recordId: eventData.recordId,
objectMetadataId: batch.objectMetadata.id,
};