New Timeline (#4936)
Refactored the code to introduce two different concepts: - AuditLogs (immutable, raw data) - TimelineActivities (user-friendly, transformed data) Still some work needed: - Add message, files, calendar events to timeline (~2 hours if done naively) - Refactor repository to try to abstract concept when we can (tbd, wait for Twenty ORM) - Introduce ability to display child timelines on parent timeline with filtering (~2 days) - Improve UI: add links to open note/task, improve diff display, etc (half a day) - Decide the path forward for Task vs Notes: either introduce a new field type "Record Type" and start going into that direction ; or split in two objects? - Trigger updates when a field is changed (will be solved by real-time / websockets: 2 weeks) - Integrate behavioral events (1 day for POC, 1 week for clean/documented) <img width="1248" alt="Screenshot 2024-04-12 at 09 24 49" src="https://github.com/twentyhq/twenty/assets/6399865/9428db1a-ab2b-492c-8b0b-d4d9a36e81fa">
This commit is contained in:
Félix Malfait
@ -1,58 +0,0 @@
|
||||
import { Injectable } from '@nestjs/common';
|
||||
|
||||
import { MessageQueueJob } from 'src/engine/integrations/message-queue/interfaces/message-queue-job.interface';
|
||||
|
||||
import { InjectObjectMetadataRepository } from 'src/engine/object-metadata-repository/object-metadata-repository.decorator';
|
||||
import { EventRepository } from 'src/modules/event/repositiories/event.repository';
|
||||
import { EventObjectMetadata } from 'src/modules/event/standard-objects/event.object-metadata';
|
||||
import { WorkspaceMemberRepository } from 'src/modules/workspace-member/repositories/workspace-member.repository';
|
||||
import { WorkspaceMemberObjectMetadata } from 'src/modules/workspace-member/standard-objects/workspace-member.object-metadata';
|
||||
|
||||
export type SaveEventToDbJobData = {
|
||||
workspaceId: string;
|
||||
recordId: string;
|
||||
userId: string | undefined;
|
||||
objectName: string;
|
||||
operation: string;
|
||||
details: any;
|
||||
};
|
||||
|
||||
@Injectable()
|
||||
export class SaveEventToDbJob implements MessageQueueJob<SaveEventToDbJobData> {
|
||||
constructor(
|
||||
@InjectObjectMetadataRepository(WorkspaceMemberObjectMetadata)
|
||||
private readonly workspaceMemberService: WorkspaceMemberRepository,
|
||||
@InjectObjectMetadataRepository(EventObjectMetadata)
|
||||
private readonly eventService: EventRepository,
|
||||
) {}
|
||||
|
||||
// TODO: need to support objects others than "person", "company", "opportunity"
|
||||
async handle(data: SaveEventToDbJobData): Promise<void> {
|
||||
let workspaceMemberId: string | null = null;
|
||||
|
||||
if (data.userId) {
|
||||
const workspaceMember = await this.workspaceMemberService.getByIdOrFail(
|
||||
data.userId,
|
||||
data.workspaceId,
|
||||
);
|
||||
|
||||
workspaceMemberId = workspaceMember.id;
|
||||
}
|
||||
|
||||
if (data.details.diff) {
|
||||
// we remove "before" and "after" property for a cleaner/slimmer event payload
|
||||
data.details = {
|
||||
diff: data.details.diff,
|
||||
};
|
||||
}
|
||||
|
||||
await this.eventService.insert(
|
||||
`${data.operation}.${data.objectName}`,
|
||||
data.details,
|
||||
workspaceMemberId,
|
||||
data.objectName,
|
||||
data.recordId,
|
||||
data.workspaceId,
|
||||
);
|
||||
}
|
||||
}
|
||||
@ -7,16 +7,15 @@ import { Repository } from 'typeorm';
|
||||
import { MessageQueue } from 'src/engine/integrations/message-queue/message-queue.constants';
|
||||
import { MessageQueueService } from 'src/engine/integrations/message-queue/services/message-queue.service';
|
||||
import { ObjectRecordCreateEvent } from 'src/engine/integrations/event-emitter/types/object-record-create.event';
|
||||
import {
|
||||
SaveEventToDbJobData,
|
||||
SaveEventToDbJob,
|
||||
} from 'src/engine/api/graphql/workspace-query-runner/jobs/save-event-to-db.job';
|
||||
import { CreateAuditLogFromInternalEvent } from 'src/modules/timeline/jobs/create-audit-log-from-internal-event';
|
||||
import {
|
||||
FeatureFlagEntity,
|
||||
FeatureFlagKeys,
|
||||
} from 'src/engine/core-modules/feature-flag/feature-flag.entity';
|
||||
import { objectRecordChangedValues } from 'src/engine/integrations/event-emitter/utils/object-record-changed-values';
|
||||
import { ObjectRecordUpdateEvent } from 'src/engine/integrations/event-emitter/types/object-record-update.event';
|
||||
import { ObjectRecordBaseEvent } from 'src/engine/integrations/event-emitter/types/object-record.base.event';
|
||||
import { UpsertTimelineActivityFromInternalEvent } from 'src/modules/timeline/jobs/upsert-timeline-activity-from-internal-event.job';
|
||||
|
||||
@Injectable()
|
||||
export class EntityEventsToDbListener {
|
||||
@ -29,26 +28,27 @@ export class EntityEventsToDbListener {
|
||||
|
||||
@OnEvent('*.created')
|
||||
async handleCreate(payload: ObjectRecordCreateEvent<any>) {
|
||||
return this.handle(payload, 'created');
|
||||
return this.handle(payload);
|
||||
}
|
||||
|
||||
@OnEvent('*.updated')
|
||||
async handleUpdate(payload: ObjectRecordUpdateEvent<any>) {
|
||||
payload.details.diff = objectRecordChangedValues(
|
||||
payload.details.before,
|
||||
payload.details.after,
|
||||
payload.properties.diff = objectRecordChangedValues(
|
||||
payload.properties.before,
|
||||
payload.properties.after,
|
||||
payload.objectMetadata,
|
||||
);
|
||||
|
||||
return this.handle(payload, 'updated');
|
||||
return this.handle(payload);
|
||||
}
|
||||
|
||||
// @OnEvent('*.deleted') - TODO: implement when we have soft deleted
|
||||
// @OnEvent('*.deleted') - TODO: implement when we soft delete has been implemented
|
||||
// ....
|
||||
|
||||
private async handle(
|
||||
payload: ObjectRecordCreateEvent<any>,
|
||||
operation: string,
|
||||
) {
|
||||
// @OnEvent('*.restored') - TODO: implement when we soft delete has been implemented
|
||||
// ....
|
||||
|
||||
private async handle(payload: ObjectRecordCreateEvent<any>) {
|
||||
if (!payload.objectMetadata.isAuditLogged) {
|
||||
return;
|
||||
}
|
||||
@ -67,13 +67,14 @@ export class EntityEventsToDbListener {
|
||||
return;
|
||||
}
|
||||
|
||||
this.messageQueueService.add<SaveEventToDbJobData>(SaveEventToDbJob.name, {
|
||||
workspaceId: payload.workspaceId,
|
||||
userId: payload.userId,
|
||||
recordId: payload.recordId,
|
||||
objectName: payload.objectMetadata.nameSingular,
|
||||
operation: operation,
|
||||
details: payload.details,
|
||||
});
|
||||
this.messageQueueService.add<ObjectRecordBaseEvent>(
|
||||
CreateAuditLogFromInternalEvent.name,
|
||||
payload,
|
||||
);
|
||||
|
||||
this.messageQueueService.add<ObjectRecordBaseEvent>(
|
||||
UpsertTimelineActivityFromInternalEvent.name,
|
||||
payload,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
@ -24,7 +24,7 @@ export class RecordPositionListener {
|
||||
return;
|
||||
}
|
||||
|
||||
if (hasPositionSet(payload.details.after)) {
|
||||
if (hasPositionSet(payload.properties.after)) {
|
||||
return;
|
||||
}
|
||||
|
||||
|
||||
@ -9,7 +9,6 @@ import { RecordPositionListener } from 'src/engine/api/graphql/workspace-query-r
|
||||
import { AuthModule } from 'src/engine/core-modules/auth/auth.module';
|
||||
import { FeatureFlagEntity } from 'src/engine/core-modules/feature-flag/feature-flag.entity';
|
||||
import { Workspace } from 'src/engine/core-modules/workspace/workspace.entity';
|
||||
import { EventObjectMetadata } from 'src/modules/event/standard-objects/event.object-metadata';
|
||||
import { WorkspaceMemberObjectMetadata } from 'src/modules/workspace-member/standard-objects/workspace-member.object-metadata';
|
||||
import { ObjectMetadataRepositoryModule } from 'src/engine/object-metadata-repository/object-metadata-repository.module';
|
||||
|
||||
@ -24,10 +23,7 @@ import { EntityEventsToDbListener } from './listeners/entity-events-to-db.listen
|
||||
WorkspaceDataSourceModule,
|
||||
WorkspacePreQueryHookModule,
|
||||
TypeOrmModule.forFeature([Workspace, FeatureFlagEntity], 'core'),
|
||||
ObjectMetadataRepositoryModule.forFeature([
|
||||
WorkspaceMemberObjectMetadata,
|
||||
EventObjectMetadata,
|
||||
]),
|
||||
ObjectMetadataRepositoryModule.forFeature([WorkspaceMemberObjectMetadata]),
|
||||
],
|
||||
providers: [
|
||||
WorkspaceQueryRunnerService,
|
||||
|
||||
@ -249,11 +249,12 @@ export class WorkspaceQueryRunnerService {
|
||||
|
||||
parsedResults.forEach((record) => {
|
||||
this.eventEmitter.emit(`${objectMetadataItem.nameSingular}.created`, {
|
||||
name: `${objectMetadataItem.nameSingular}.created`,
|
||||
workspaceId,
|
||||
userId,
|
||||
recordId: record.id,
|
||||
objectMetadata: objectMetadataItem,
|
||||
details: {
|
||||
properties: {
|
||||
after: record,
|
||||
},
|
||||
} satisfies ObjectRecordCreateEvent<any>);
|
||||
@ -306,11 +307,12 @@ export class WorkspaceQueryRunnerService {
|
||||
);
|
||||
|
||||
this.eventEmitter.emit(`${objectMetadataItem.nameSingular}.updated`, {
|
||||
name: `${objectMetadataItem.nameSingular}.updated`,
|
||||
workspaceId,
|
||||
userId,
|
||||
recordId: (existingRecord as Record).id,
|
||||
objectMetadata: objectMetadataItem,
|
||||
details: {
|
||||
properties: {
|
||||
before: this.removeNestedProperties(existingRecord as Record),
|
||||
after: this.removeNestedProperties(parsedResults?.[0]),
|
||||
},
|
||||
@ -397,11 +399,12 @@ export class WorkspaceQueryRunnerService {
|
||||
|
||||
parsedResults.forEach((record) => {
|
||||
this.eventEmitter.emit(`${objectMetadataItem.nameSingular}.deleted`, {
|
||||
name: `${objectMetadataItem.nameSingular}.deleted`,
|
||||
workspaceId,
|
||||
userId,
|
||||
recordId: record.id,
|
||||
objectMetadata: objectMetadataItem,
|
||||
details: {
|
||||
properties: {
|
||||
before: [this.removeNestedProperties(record)],
|
||||
},
|
||||
} satisfies ObjectRecordDeleteEvent<any>);
|
||||
@ -448,11 +451,12 @@ export class WorkspaceQueryRunnerService {
|
||||
);
|
||||
|
||||
this.eventEmitter.emit(`${objectMetadataItem.nameSingular}.deleted`, {
|
||||
name: `${objectMetadataItem.nameSingular}.deleted`,
|
||||
workspaceId,
|
||||
userId,
|
||||
recordId: args.id,
|
||||
objectMetadata: objectMetadataItem,
|
||||
details: {
|
||||
properties: {
|
||||
before: {
|
||||
...(deletedWorkspaceMember ?? {}),
|
||||
...this.removeNestedProperties(parsedResults?.[0]),
|
||||
|
||||
Reference in New Issue
Block a user