Skip to content

The open alternative to Salesforce, designed for AI.

fix(front): prevent timeline "Invalid configuration" on update events without a diff (#21460)

Charles Bochet247e422eace6
diff --git a/packages/twenty-front/src/modules/activities/timeline-activities/utils/__tests__/filterOutInvalidTimelineActivities.test.ts b/packages/twenty-front/src/modules/activities/timeline-activities/utils/__tests__/filterOutInvalidTimelineActivities.test.ts
index 037c1537d33..6c5a8a94724 100644
--- a/packages/twenty-front/src/modules/activities/timeline-activities/utils/__tests__/filterOutInvalidTimelineActivities.test.ts
+++ b/packages/twenty-front/src/modules/activities/timeline-activities/utils/__tests__/filterOutInvalidTimelineActivities.test.ts
@@ -1,157 +1,145 @@
import { type TimelineActivity } from '@/activities/timeline-activities/types/TimelineActivity';
import { filterOutInvalidTimelineActivities } from '@/activities/timeline-activities/utils/filterOutInvalidTimelineActivities';
-import { CoreObjectNameSingular } from 'twenty-shared/types';
import { type EnrichedObjectMetadataItem } from '@/object-metadata/types/EnrichedObjectMetadataItem';
-const noteObjectMetadataItem = {
- nameSingular: CoreObjectNameSingular.Note,
- namePlural: 'notes',
+const mainObjectMetadataItem = {
+ nameSingular: 'company',
+ namePlural: 'companies',
fields: [{ name: 'field1' }, { name: 'field2' }, { name: 'field3' }],
readableFields: [{ name: 'field1' }, { name: 'field2' }, { name: 'field3' }],
updatableFields: [{ name: 'field1' }, { name: 'field2' }, { name: 'field3' }],
} as EnrichedObjectMetadataItem;
+const noteObjectMetadataItem = {
+ nameSingular: 'note',
+ namePlural: 'notes',
+ readableFields: [{ name: 'title' }, { name: 'body' }],
+} as EnrichedObjectMetadataItem;
+
+const filter = (events: TimelineActivity[]) =>
+ filterOutInvalidTimelineActivities(events, 'company', [
+ mainObjectMetadataItem,
+ noteObjectMetadataItem,
+ ]);
+
describe('filterOutInvalidTimelineActivities', () => {
- it('should filter out TimelineActivities with deleted fields from the properties diff', () => {
+ it('keeps update diffs as-is and trims fields not in the readable fields', () => {
const events = [
{
id: '1',
- name: 'event1',
+ name: 'company.updated',
properties: {
diff: {
field1: { before: 'value1', after: 'value2' },
field2: { before: 'value3', after: 'value4' },
- field3: { before: 'value5', after: 'value6' },
},
},
},
{
id: '2',
- name: 'event2',
+ name: 'company.updated',
properties: {
diff: {
field1: { before: 'value7', after: 'value8' },
- field2: { before: 'value9', after: 'value10' },
field4: { before: 'value11', after: 'value12' },
},
},
},
] as TimelineActivity[];
- const mainObjectMetadataItem = {
- nameSingular: 'objectNameSingular',
- namePlural: 'objectNamePlural',
- fields: [{ name: 'field1' }, { name: 'field2' }, { name: 'field3' }],
- readableFields: [
- { name: 'field1' },
- { name: 'field2' },
- { name: 'field3' },
- ],
- updatableFields: [
- { name: 'field1' },
- { name: 'field2' },
- { name: 'field3' },
- ],
- } as EnrichedObjectMetadataItem;
-
- const filteredEvents = filterOutInvalidTimelineActivities(
- events,
- 'objectNameSingular',
- [mainObjectMetadataItem, noteObjectMetadataItem],
- );
-
- expect(filteredEvents).toEqual([
+ expect(filter(events)).toEqual([
{
id: '1',
- name: 'event1',
+ name: 'company.updated',
properties: {
diff: {
field1: { before: 'value1', after: 'value2' },
field2: { before: 'value3', after: 'value4' },
- field3: { before: 'value5', after: 'value6' },
},
},
},
{
id: '2',
- name: 'event2',
+ name: 'company.updated',
properties: {
- diff: {
- field1: { before: 'value7', after: 'value8' },
- field2: { before: 'value9', after: 'value10' },
- },
+ diff: { field1: { before: 'value7', after: 'value8' } },
},
},
]);
});
- it('should return an empty array if all TimelineActivities have deleted fields in the properties diff', () => {
+ it('drops update events whose diff has no readable fields', () => {
const events = [
{
id: '1',
- name: 'event1',
+ name: 'company.updated',
properties: {
- diff: {
- field3: { before: 'value5', after: 'value6' },
- },
+ diff: { field4: { before: 'value11', after: 'value12' } },
},
},
+ ] as TimelineActivity[];
+
+ expect(filter(events)).toEqual([]);
+ });
+
+ it('drops update events that have no diff', () => {
+ const events = [
+ { id: '1', name: 'company.updated', properties: {} },
+ ] as TimelineActivity[];
+
+ expect(filter(events)).toEqual([]);
+ });
+
+ it('keeps non-update events that have no diff', () => {
+ const events = [
+ { id: '1', name: 'company.created', properties: {} },
+ { id: '2', name: 'company.deleted', properties: {} },
+ ] as TimelineActivity[];
+
+ expect(filter(events)).toEqual(events);
+ });
+
+ it('keeps linked note/task update events even without a diff', () => {
+ const events = [
+ { id: '1', name: 'linked-task.updated', properties: {} },
+ { id: '2', name: 'linked-note.updated', properties: {} },
+ ] as TimelineActivity[];
+
+ expect(filter(events)).toEqual(events);
+ });
+
+ it('validates linked note diffs against the note readable fields', () => {
+ const events = [
{
- id: '2',
- name: 'event2',
+ id: '1',
+ name: 'linked-note.updated',
properties: {
diff: {
- field4: { before: 'value11', after: 'value12' },
+ title: { before: 'a', after: 'b' },
+ field1: { before: 'c', after: 'd' },
},
},
},
] as TimelineActivity[];
- const mainObjectMetadataItem = {
- nameSingular: 'objectNameSingular',
- namePlural: 'objectNamePlural',
- fields: [{ name: 'field1' }, { name: 'field2' }],
- readableFields: [{ name: 'field1' }, { name: 'field2' }],
- updatableFields: [{ name: 'field1' }, { name: 'field2' }],
- } as EnrichedObjectMetadataItem;
-
- const filteredEvents = filterOutInvalidTimelineActivities(
- events,
- 'objectNameSingular',
- [mainObjectMetadataItem, noteObjectMetadataItem],
- );
-
- expect(filteredEvents).toEqual([]);
+ expect(filter(events)).toEqual([
+ {
+ id: '1',
+ name: 'linked-note.updated',
+ properties: { diff: { title: { before: 'a', after: 'b' } } },
+ },
+ ]);
});
- it('should return the same TimelineActivities if there are no properties diffs', () => {
+ it('drops linked note updates whose diff has no readable note fields', () => {
const events = [
{
id: '1',
- name: 'event1',
- properties: {},
- },
- {
- id: '2',
- name: 'event2',
- properties: {},
+ name: 'linked-note.updated',
+ properties: { diff: { field1: { before: 'c', after: 'd' } } },
},
] as TimelineActivity[];
- const mainObjectMetadataItem = {
- nameSingular: 'objectNameSingular',
- namePlural: 'objectNamePlural',
- fields: [{ name: 'field1' }, { name: 'field2' }],
- readableFields: [{ name: 'field1' }, { name: 'field2' }],
- updatableFields: [{ name: 'field1' }, { name: 'field2' }],
- } as EnrichedObjectMetadataItem;
-
- const filteredEvents = filterOutInvalidTimelineActivities(
- events,
- 'objectNameSingular',
- [mainObjectMetadataItem, noteObjectMetadataItem],
- );
-
- expect(filteredEvents).toEqual(events);
+ expect(filter(events)).toEqual([]);
});
});
diff --git a/packages/twenty-front/src/modules/activities/timeline-activities/utils/filterOutInvalidTimelineActivities.ts b/packages/twenty-front/src/modules/activities/timeline-activities/utils/filterOutInvalidTimelineActivities.ts
index 11dcd54a91a..35a86761be0 100644
--- a/packages/twenty-front/src/modules/activities/timeline-activities/utils/filterOutInvalidTimelineActivities.ts
+++ b/packages/twenty-front/src/modules/activities/timeline-activities/utils/filterOutInvalidTimelineActivities.ts
@@ -1,9 +1,32 @@
import { type TimelineActivity } from '@/activities/timeline-activities/types/TimelineActivity';
import { findFieldMetadataItemByDiffKey } from '@/activities/timeline-activities/utils/findFieldMetadataItemByDiffKey';
import { type EnrichedObjectMetadataItem } from '@/object-metadata/types/EnrichedObjectMetadataItem';
-import { CoreObjectNameSingular } from 'twenty-shared/types';
+import { type FieldMetadataItem } from '@/object-metadata/types/FieldMetadataItem';
import { isDefined } from 'twenty-shared/utils';
+const keepActivityWithReadableDiff = (
+ timelineActivity: TimelineActivity,
+ readableFields: FieldMetadataItem[],
+): TimelineActivity | undefined => {
+ const validDiffEntries = Object.entries(
+ timelineActivity.properties?.diff ?? {},
+ ).filter(([diffKey]) =>
+ isDefined(findFieldMetadataItemByDiffKey(readableFields, diffKey)),
+ );
+
+ if (validDiffEntries.length === 0) {
+ return undefined;
+ }
+
+ return {
+ ...timelineActivity,
+ properties: {
+ ...timelineActivity.properties,
+ diff: Object.fromEntries(validDiffEntries),
+ },
+ };
+};
+
export const filterOutInvalidTimelineActivities = (
timelineActivities: TimelineActivity[],
mainObjectSingularName: string,
@@ -14,46 +37,39 @@ export const filterOutInvalidTimelineActivities = (
objectMetadataItem.nameSingular === mainObjectSingularName,
);
- const noteObjectMetadataItem = objectMetadataItems.find(
- (objectMetadataItem) =>
- objectMetadataItem.nameSingular === CoreObjectNameSingular.Note,
- );
-
- if (!mainObjectMetadataItem || !noteObjectMetadataItem) {
- throw new Error('Object metadata items not found');
+ if (!isDefined(mainObjectMetadataItem)) {
+ throw new Error('Object metadata item not found');
}
- return timelineActivities.filter((timelineActivity) => {
- const diff = timelineActivity.properties?.diff;
- const canSkipValidation = !diff;
-
- if (canSkipValidation) {
- return true;
- }
+ return timelineActivities
+ .map((timelineActivity) => {
+ const [objectName, action] = timelineActivity.name.split('.');
- const isNoteOrTask =
- timelineActivity.name.startsWith('linked-note') ||
- timelineActivity.name.startsWith('linked-task');
+ if (objectName.startsWith('linked-')) {
+ if (!isDefined(timelineActivity.properties?.diff)) {
+ return timelineActivity;
+ }
- const fieldsToValidateAgainst = isNoteOrTask
- ? noteObjectMetadataItem.readableFields
- : mainObjectMetadataItem.readableFields;
+ const linkedObjectMetadataItem = objectMetadataItems.find(
+ (objectMetadataItem) =>
+ objectMetadataItem.nameSingular ===
+ objectName.replace('linked-', ''),
+ );
- const validDiffEntries = Object.entries(diff).filter(([diffKey]) =>
- isDefined(
- findFieldMetadataItemByDiffKey(fieldsToValidateAgainst, diffKey),
- ),
- );
+ return keepActivityWithReadableDiff(
+ timelineActivity,
+ linkedObjectMetadataItem?.readableFields ?? [],
+ );
+ }
- if (validDiffEntries.length === 0) {
- return false;
- }
-
- timelineActivity.properties = {
- ...timelineActivity.properties,
- diff: Object.fromEntries(validDiffEntries),
- };
+ if (action === 'updated') {
+ return keepActivityWithReadableDiff(
+ timelineActivity,
+ mainObjectMetadataItem.readableFields,
+ );
+ }
- return true;
- });
+ return timelineActivity;
+ })
+ .filter(isDefined);
};
diff --git a/packages/twenty-server/src/modules/timeline/repositories/timeline-activity.repository.ts b/packages/twenty-server/src/modules/timeline/repositories/timeline-activity.repository.ts
index c904b589804..4637db82406 100644
--- a/packages/twenty-server/src/modules/timeline/repositories/timeline-activity.repository.ts
+++ b/packages/twenty-server/src/modules/timeline/repositories/timeline-activity.repository.ts
@@ -1,7 +1,7 @@
import { Injectable } from '@nestjs/common';
-import { isDefined } from 'class-validator';
import { type ObjectRecord } from 'twenty-shared/types';
+import { isDefined } from 'twenty-shared/utils';
import { In, MoreThan } from 'typeorm';
import { objectRecordDiffMerge } from 'src/engine/core-modules/event-emitter/utils/object-record-diff-merge';
@@ -38,21 +38,23 @@ export class TimelineActivityRepository {
payloads,
});
- const payloadsWithDiff = payloads
- .filter(({ properties }) => {
- const isDiffEmpty =
- properties.diff !== null &&
- properties.diff &&
- Object.keys(properties.diff).length === 0;
-
- return !isDiffEmpty;
- })
- .map(({ properties, ...rest }) => ({
- ...rest,
- properties: isDefined(properties.diff)
- ? { diff: properties.diff }
- : {},
- }));
+ const payloadsToUpsert = payloads.flatMap(
+ ({ name, properties, ...rest }) => {
+ const [objectName, action] = name.split('.');
+ const { diff } = properties;
+ const hasDiff = isDefined(diff) && Object.keys(diff).length > 0;
+
+ if (objectName.startsWith('linked-')) {
+ return [{ ...rest, name, properties: hasDiff ? { diff } : {} }];
+ }
+
+ if (action === 'updated') {
+ return hasDiff ? [{ ...rest, name, properties: { diff } }] : [];
+ }
+
+ return [{ ...rest, name, properties: {} }];
+ },
+ );
const payloadsToInsert: TimelineActivityPayloadWorkspaceIdAndObjectSingularName['payloads'] =
[];
@@ -60,7 +62,7 @@ export class TimelineActivityRepository {
const timelineActivityPropertyName =
await this.getTimelineActivityPropertyName(objectSingularName);
- for (const payload of payloadsWithDiff) {
+ for (const payload of payloadsToUpsert) {
const recentTimelineActivity = recentTimelineActivities.find(
(timelineActivity) =>
timelineActivity[timelineActivityPropertyName] ===