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
2024-04-19 17:52:57 +02:00
committed by GitHub
parent 9c8cb52952
commit d145684966
56 changed files with 1314 additions and 368 deletions

View File

@ -122,7 +122,7 @@ export const companyStandardFieldIds = {
opportunities: '20202020-add3-4658-8e23-d70dccb6d0ec',
favorites: '20202020-4d1d-41ac-b13b-621631298d55',
attachments: '20202020-c1b5-4120-b0f0-987ca401ed53',
events: '20202020-0414-4daf-9c0d-64fe7b27f89f',
timelineActivities: '72d5d7d3-8782-446c-a54b-1c25024f55db',
};
export const connectedAccountStandardFieldIds = {
@ -146,6 +146,38 @@ export const eventStandardFieldIds = {
custom: '20202020-4a71-41b0-9f83-9cdcca3f8b14',
};
export const auditLogStandardFieldIds = {
name: '20202020-2462-4b9d-b5d9-745febb3b095',
properties: '20202020-5d36-470e-8fad-d56ea3ab2fd0',
context: '20202020-b9d1-4058-9a75-7469cab5ca8c',
objectName: '20202020-76ba-4c47-b7e5-96034005d00a',
recordId: '20202020-c578-4acf-bf94-eb53b035cea2',
workspaceMember: '20202020-6e96-4300-b3f5-67a707147385',
};
export const behavioralEventStandardFieldIds = {
name: '20202020-2462-4b9d-b5d9-745febb3b095',
properties: '20202020-5d36-470e-8fad-d56ea3ab2fd0',
context: '20202020-bd62-4b5b-8385-6caeed8f8078',
objectName: '20202020-a744-406c-a2e1-9d83d74f4341',
recordId: '20202020-6d8b-4ca5-9869-f882cb335673',
};
export const timelineActivityStandardFieldIds = {
happensAt: '20202020-9526-4993-b339-c4318c4d39f0',
type: '20202020-5e7b-4ccd-8b8a-86b94b474134',
name: '20202020-7207-46e8-9dab-849505ae8497',
properties: '20202020-f142-4b04-b91b-6a2b4af3bf11',
workspaceMember: '20202020-af23-4479-9a30-868edc474b36',
person: '20202020-c414-45b9-a60a-ac27aa96229f',
company: '20202020-04ad-4221-a744-7a8278a5ce21',
opportunity: '20202020-7664-4a35-a3df-580d389fd527',
custom: '20202020-4a71-41b0-9f83-9cdcca3f8b15',
linkedRecordCachedName: '20202020-cfdb-4bef-bbce-a29f41230934',
linkedRecordId: '20202020-2e0e-48c0-b445-ee6c1e61687d',
linkedObjectMetadataId: '20202020-c595-449d-9f89-562758c9ee69',
};
export const favoriteStandardFieldIds = {
position: '20202020-dd26-42c6-8c3c-2a7598c204f6',
workspaceMember: '20202020-ce63-49cb-9676-fdc0c45892cd',
@ -214,7 +246,7 @@ export const opportunityStandardFieldIds = {
favorites: '20202020-a1c2-4500-aaae-83ba8a0e827a',
activityTargets: '20202020-220a-42d6-8261-b2102d6eab35',
attachments: '20202020-87c7-4118-83d6-2f4031005209',
events: '20202020-30e2-421f-96c7-19c69d1cf631',
timelineActivities: '863a6f5c-493a-47c8-9e14-34ed929d2ba6',
};
export const personStandardFieldIds = {
@ -234,7 +266,7 @@ export const personStandardFieldIds = {
attachments: '20202020-cd97-451f-87fa-bcb789bdbf3a',
messageParticipants: '20202020-498e-4c61-8158-fa04f0638334',
calendarEventParticipants: '20202020-52ee-45e9-a702-b64b3753e3a9',
events: '20202020-a43e-4873-9c23-e522de906ce5',
timelineActivities: 'f23d6471-78e0-458a-bdd0-9a84cd7d0b70',
};
export const viewFieldStandardFieldIds = {
@ -295,7 +327,8 @@ export const workspaceMemberStandardFieldIds = {
messageParticipants: '20202020-8f99-48bc-a5eb-edd33dd54188',
blocklist: '20202020-6cb2-4161-9f29-a4b7f1283859',
calendarEventParticipants: '20202020-0dbc-4841-9ce1-3e793b5b3512',
events: '20202020-e15b-47b8-94fe-8200e3c66615',
timelineActivities: '20202020-f0d9-4ba3-a123-69cc2c185071',
auditLogs: '20202020-2f54-4739-a5e2-99563385e83d',
};
export const customObjectStandardFieldIds = {
@ -304,5 +337,5 @@ export const customObjectStandardFieldIds = {
activityTargets: '20202020-7f42-40ae-b96c-c8a61acc83bf',
favorites: '20202020-a4a7-4686-b296-1c6c3482ee21',
attachments: '20202020-8d59-46ca-b7b2-73d167712134',
events: '20202020-a508-4334-9724-5c2bf1b05998',
timelineActivities: '20202020-f1ef-4ba4-8f33-1a4577afa477',
};

View File

@ -11,6 +11,7 @@ export const standardObjectIds = {
apiKey: '20202020-4c00-401d-8cda-ec6a4c41cd7d',
attachment: '20202020-bd3d-4c60-8dca-571c71d4447a',
blocklist: '20202020-0408-4f38-b8a8-4d5e3e26e24d',
behavioralEvent: '20202020-983d-416b-a5ee-bdd0da3d0f8f',
calendarChannelEventAssociation: '20202020-491b-4aaa-9825-afd1bae6ae00',
calendarChannel: '20202020-e8f2-40e1-a39c-c0e0039c5034',
calendarEventParticipant: '20202020-a1c3-47a6-9732-27e5b1e8436d',
@ -18,8 +19,9 @@ export const standardObjectIds = {
comment: '20202020-435f-4de9-89b5-97e32233bf5f',
company: '20202020-b374-4779-a561-80086cb2e17f',
connectedAccount: '20202020-977e-46b2-890b-c3002ddfd5c5',
event: '20202020-6736-4337-b5c4-8b39fae325a5',
event: '20202020-6736-4337-b5c4-8b39fae325a5', // Todo: remove
favorite: '20202020-ab56-4e05-92a3-e2414a499860',
auditLog: '20202020-0566-476a-b4c4-a0f9781bd80a',
messageChannelMessageAssociation: '20202020-ad1e-4127-bccb-d83ae04d2ccb',
messageChannel: '20202020-fe8c-40bc-a681-b80b771449b7',
messageParticipant: '20202020-a433-4456-aa2d-fd9cb26b774a',
@ -27,6 +29,7 @@ export const standardObjectIds = {
message: '20202020-3f6b-4425-80ab-e468899ab4b2',
opportunity: '20202020-9549-49dd-b2b2-883999db8938',
person: '20202020-e674-48e5-a542-72570eee7213',
timelineActivity: '20202020-6736-4337-b5c4-8b39fae325a5',
viewField: '20202020-4d19-4655-95bf-b2a04cf206d4',
viewFilter: '20202020-6fb6-4631-aded-b7d67e952ec8',
viewSort: '20202020-e46a-47a8-939a-e5d911f83531',

View File

@ -13,7 +13,7 @@ import { RelationMetadata } from 'src/engine/workspace-manager/workspace-sync-me
import { FavoriteObjectMetadata } from 'src/modules/favorite/standard-objects/favorite.object-metadata';
import { AttachmentObjectMetadata } from 'src/modules/attachment/standard-objects/attachment.object-metadata';
import { customObjectStandardFieldIds } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-field-ids';
import { EventObjectMetadata } from 'src/modules/event/standard-objects/event.object-metadata';
import { TimelineActivityObjectMetadata } from 'src/modules/timeline/standard-objects/timeline-activity.object-metadata';
@BaseCustomObjectMetadata()
export class CustomObjectMetadata extends BaseObjectMetadata {
@ -88,18 +88,20 @@ export class CustomObjectMetadata extends BaseObjectMetadata {
attachments: AttachmentObjectMetadata[];
@FieldMetadata({
standardId: customObjectStandardFieldIds.events,
standardId: customObjectStandardFieldIds.timelineActivities,
type: FieldMetadataType.RELATION,
label: 'Events',
label: 'Timeline Activities',
description: (objectMetadata) =>
`Events tied to the ${objectMetadata.labelSingular}`,
icon: 'IconJson',
`Timeline Activities tied to the ${objectMetadata.labelSingular}`,
icon: 'IconIconTimelineEvent',
})
@RelationMetadata({
type: RelationMetadataType.ONE_TO_MANY,
inverseSideTarget: () => EventObjectMetadata,
inverseSideTarget: () => TimelineActivityObjectMetadata,
onDelete: RelationOnDeleteAction.CASCADE,
})
@IsNullable()
events: EventObjectMetadata[];
@IsSystem()
timelineActivities: TimelineActivityObjectMetadata[];
}

View File

@ -24,21 +24,29 @@ import { ViewObjectMetadata } from 'src/modules/view/standard-objects/view.objec
import { WebhookObjectMetadata } from 'src/modules/webhook/standard-objects/webhook.object-metadata';
import { WorkspaceMemberObjectMetadata } from 'src/modules/workspace-member/standard-objects/workspace-member.object-metadata';
import { CalendarChannelEventAssociationObjectMetadata } from 'src/modules/calendar/standard-objects/calendar-channel-event-association.object-metadata';
import { EventObjectMetadata } from 'src/modules/event/standard-objects/event.object-metadata';
import { AuditLogObjectMetadata } from 'src/modules/timeline/standard-objects/audit-log.object-metadata';
import { TimelineActivityObjectMetadata } from 'src/modules/timeline/standard-objects/timeline-activity.object-metadata';
import { BehavioralEventObjectMetadata } from 'src/modules/timeline/standard-objects/behavioral-event.object-metadata';
export const standardObjectMetadataDefinitions = [
ActivityTargetObjectMetadata,
ActivityObjectMetadata,
ApiKeyObjectMetadata,
AuditLogObjectMetadata,
AttachmentObjectMetadata,
BehavioralEventObjectMetadata,
BlocklistObjectMetadata,
CalendarEventObjectMetadata,
CalendarChannelObjectMetadata,
CalendarChannelEventAssociationObjectMetadata,
CalendarEventParticipantObjectMetadata,
CommentObjectMetadata,
CompanyObjectMetadata,
ConnectedAccountObjectMetadata,
EventObjectMetadata,
FavoriteObjectMetadata,
OpportunityObjectMetadata,
PersonObjectMetadata,
TimelineActivityObjectMetadata,
ViewFieldObjectMetadata,
ViewFilterObjectMetadata,
ViewSortObjectMetadata,
@ -50,8 +58,4 @@ export const standardObjectMetadataDefinitions = [
MessageChannelObjectMetadata,
MessageParticipantObjectMetadata,
MessageChannelMessageAssociationObjectMetadata,
CalendarEventObjectMetadata,
CalendarChannelObjectMetadata,
CalendarChannelEventAssociationObjectMetadata,
CalendarEventParticipantObjectMetadata,
];