The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
Evict cached record queries when a field is renamed or deleted (#29593)
Charles Bochet321412fc59e3
diff --git a/packages/twenty-front/src/modules/browser-event/types/MetadataOperation.ts b/packages/twenty-front/src/modules/browser-event/types/MetadataOperation.tsindex e63e9743b2f..aa9ad5f0225 100644--- a/packages/twenty-front/src/modules/browser-event/types/MetadataOperation.ts+++ b/packages/twenty-front/src/modules/browser-event/types/MetadataOperation.ts@@ -11,4 +11,5 @@ export type MetadataOperation<T extends Record<string, unknown>> =| {type: 'delete';deletedRecordId: string;+ deletedRecord?: T;};diff --git a/packages/twenty-front/src/modules/browser-event/utils/__tests__/isObjectMetadataFieldRename.test.ts b/packages/twenty-front/src/modules/browser-event/utils/__tests__/isObjectMetadataFieldRename.test.tsnew file mode 100644index 00000000000..ffc5d555c4f--- /dev/null+++ b/packages/twenty-front/src/modules/browser-event/utils/__tests__/isObjectMetadataFieldRename.test.ts@@ -0,0 +1,54 @@+import { isObjectMetadataFieldRename } from '@/browser-event/utils/isObjectMetadataFieldRename';++const fieldRecord = {+ id: 'field-id',+ name: 'isRecurring',+ objectMetadataId: 'person-object-id',+};++describe('isObjectMetadataFieldRename', () => {+ it('is true for an update that changes the field name', () => {+ expect(+ isObjectMetadataFieldRename({+ type: 'update',+ updatedRecord: fieldRecord,+ updatedFields: ['name', 'label'],+ }),+ ).toBe(true);+ });++ it('is false for an update that keeps the field name', () => {+ expect(+ isObjectMetadataFieldRename({+ type: 'update',+ updatedRecord: fieldRecord,+ updatedFields: ['label'],+ }),+ ).toBe(false);+ });++ it('is false for an update without updated fields', () => {+ expect(+ isObjectMetadataFieldRename({+ type: 'update',+ updatedRecord: fieldRecord,+ }),+ ).toBe(false);+ });++ it('is false for other operations', () => {+ expect(+ isObjectMetadataFieldRename({+ type: 'delete',+ deletedRecordId: 'field-id',+ deletedRecord: fieldRecord,+ }),+ ).toBe(false);+ expect(+ isObjectMetadataFieldRename({+ type: 'create',+ createdRecord: fieldRecord,+ }),+ ).toBe(false);+ });+});diff --git a/packages/twenty-front/src/modules/browser-event/utils/isObjectMetadataFieldRename.ts b/packages/twenty-front/src/modules/browser-event/utils/isObjectMetadataFieldRename.tsnew file mode 100644index 00000000000..8adcca8fbd3--- /dev/null+++ b/packages/twenty-front/src/modules/browser-event/utils/isObjectMetadataFieldRename.ts@@ -0,0 +1,7 @@+import { type MetadataOperation } from '@/browser-event/types/MetadataOperation';++export const isObjectMetadataFieldRename = <T extends Record<string, unknown>>(+ operation: MetadataOperation<T>,+): operation is Extract<MetadataOperation<T>, { type: 'update' }> =>+ operation.type === 'update' &&+ (operation.updatedFields?.includes('name') ?? false);diff --git a/packages/twenty-front/src/modules/object-record/cache/components/RecordCacheStaleQueriesSSEEffect.tsx b/packages/twenty-front/src/modules/object-record/cache/components/RecordCacheStaleQueriesSSEEffect.tsxnew file mode 100644index 00000000000..0081ada963b--- /dev/null+++ b/packages/twenty-front/src/modules/object-record/cache/components/RecordCacheStaleQueriesSSEEffect.tsx@@ -0,0 +1,55 @@+import { useListenToMetadataOperationBrowserEvent } from '@/browser-event/hooks/useListenToMetadataOperationBrowserEvent';+import { type FlatFieldMetadataItem } from '@/metadata-store/types/FlatFieldMetadataItem';+import { useApolloCoreClient } from '@/object-metadata/hooks/useApolloCoreClient';+import { objectMetadataItemsSelector } from '@/object-metadata/states/objectMetadataItemsSelector';+import { isObjectMetadataFieldRename } from '@/browser-event/utils/isObjectMetadataFieldRename';+import { useStore } from 'jotai';+import { isDefined } from 'twenty-shared/utils';+import { AllMetadataName } from '~/generated-metadata/graphql';++export const RecordCacheStaleQueriesSSEEffect = () => {+ const store = useStore();+ const apolloCoreClient = useApolloCoreClient();++ useListenToMetadataOperationBrowserEvent<FlatFieldMetadataItem>({+ metadataName: AllMetadataName.fieldMetadata,+ onMetadataOperationBrowserEvent: ({ operation }) => {+ if (+ !isObjectMetadataFieldRename(operation) &&+ operation.type !== 'delete'+ ) {+ return;+ }++ const fieldMetadataItem =+ operation.type === 'delete'+ ? operation.deletedRecord+ : operation.updatedRecord;++ if (!isDefined(fieldMetadataItem)) {+ return;+ }++ const objectMetadataItem = store+ .get(objectMetadataItemsSelector.atom)+ .find((item) => item.id === fieldMetadataItem.objectMetadataId);++ if (!isDefined(objectMetadataItem)) {+ return;+ }++ for (const fieldName of [+ objectMetadataItem.namePlural,+ `${objectMetadataItem.namePlural}GroupBy`,+ ]) {+ apolloCoreClient.cache.evict({+ id: 'ROOT_QUERY',+ fieldName,+ broadcast: false,+ });+ }+ },+ });++ return null;+};diff --git a/packages/twenty-front/src/modules/sse-db-event/components/SSEProvider.tsx b/packages/twenty-front/src/modules/sse-db-event/components/SSEProvider.tsxindex 83df8bd3277..55898b09edd 100644--- a/packages/twenty-front/src/modules/sse-db-event/components/SSEProvider.tsx+++ b/packages/twenty-front/src/modules/sse-db-event/components/SSEProvider.tsx@@ -3,6 +3,7 @@ import { SSEClientEffect } from '@/sse-db-event/components/SSEClientEffect';import { SSEEventStreamEffect } from '@/sse-db-event/components/SSEEventStreamEffect';import { SSEKeepAliveEffect } from '@/sse-db-event/components/SSEKeepAliveEffect';import { SSEQuerySubscribeEffect } from '@/sse-db-event/components/SSEQuerySubscribeEffect';+import { RecordCacheStaleQueriesSSEEffect } from '@/object-record/cache/components/RecordCacheStaleQueriesSSEEffect';import { type ReactNode } from 'react';type SSEProviderProps = {@@ -17,6 +18,7 @@ export const SSEProvider = ({ children }: SSEProviderProps) => {<SSEQuerySubscribeEffect /><SSEKeepAliveEffect /><MetadataStoreSSEEffect />+ <RecordCacheStaleQueriesSSEEffect />{children}</>);diff --git a/packages/twenty-front/src/modules/sse-db-event/utils/turnSseMetadataEventsToMetadataOperationBrowserEvents.ts b/packages/twenty-front/src/modules/sse-db-event/utils/turnSseMetadataEventsToMetadataOperationBrowserEvents.tsindex da08f9213d6..a7791e28aec 100644--- a/packages/twenty-front/src/modules/sse-db-event/utils/turnSseMetadataEventsToMetadataOperationBrowserEvents.ts+++ b/packages/twenty-front/src/modules/sse-db-event/utils/turnSseMetadataEventsToMetadataOperationBrowserEvents.ts@@ -59,6 +59,7 @@ export const turnSseMetadataEventsToMetadataOperationBrowserEvents = <operation: {type: 'delete',deletedRecordId: event.recordId,+ deletedRecord: event.properties.before ?? undefined,},updatedCollectionHash,};