Skip to content

The open alternative to Salesforce, designed for AI.

Fix app sync recreating search rows that already exist (#28494)

Adarsh1019579706ad
diff --git a/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/services/workspace-flat-field-metadata-map-cache.service.ts b/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/services/workspace-flat-field-metadata-map-cache.service.ts
index 2bc6d14e931..099a35c4e57 100644
--- a/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/services/workspace-flat-field-metadata-map-cache.service.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/services/workspace-flat-field-metadata-map-cache.service.ts
@@ -8,7 +8,7 @@ import { createEmptyFlatEntityMaps } from 'src/engine/metadata-modules/flat-enti
import { type FlatFieldMetadataMaps } from 'src/engine/metadata-modules/flat-field-metadata/types/flat-field-metadata-maps.type';
import { type CompactFlatFieldMetadataMaps } from 'src/engine/metadata-modules/flat-field-metadata/types/compact-flat-field-metadata-maps.type';
import { compactFlatFieldMetadataMaps } from 'src/engine/metadata-modules/flat-field-metadata/utils/compact-flat-field-metadata-maps.util';
-import { expandFlatFieldMetadataMaps } from 'src/engine/metadata-modules/flat-field-metadata/utils/expand-flat-field-metadata-maps.util';
+import { expandFlatFieldMetadataMapsOrThrow } from 'src/engine/metadata-modules/flat-field-metadata/utils/expand-flat-field-metadata-maps-or-throw.util';
import { fromFieldMetadataEntityToFlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/utils/from-field-metadata-entity-to-flat-field-metadata.util';
import { computeUniqueFieldMetadataIdsFromIndexes } from 'src/engine/metadata-modules/index-metadata/utils/compute-unique-field-metadata-ids-from-indexes.util';
import { WorkspaceCache } from 'src/engine/workspace-cache/decorators/workspace-cache.decorator';
@@ -76,7 +76,7 @@ export class WorkspaceFlatFieldMetadataMapCacheService extends MetadataFlatEntit
override expandFromStorage(
compactData: CompactFlatFieldMetadataMaps,
): FlatFieldMetadataMaps {
- return expandFlatFieldMetadataMaps(compactData);
+ return expandFlatFieldMetadataMapsOrThrow(compactData);
}
computeForCache({
diff --git a/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/__tests__/expand-flat-field-metadata-maps.util.spec.ts b/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/__tests__/expand-flat-field-metadata-maps-or-throw.util.spec.ts
similarity index 58%
rename from packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/__tests__/expand-flat-field-metadata-maps.util.spec.ts
rename to packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/__tests__/expand-flat-field-metadata-maps-or-throw.util.spec.ts
index 05e44671c1d..30232c9e166 100644
--- a/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/__tests__/expand-flat-field-metadata-maps.util.spec.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/__tests__/expand-flat-field-metadata-maps-or-throw.util.spec.ts
@@ -1,12 +1,13 @@
+import { FlatEntityMapsException } from 'src/engine/metadata-modules/flat-entity/exceptions/flat-entity-maps.exception';
import { type CompactFlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/types/compact-flat-field-metadata-maps.type';
import { compactFlatFieldMetadataMaps } from 'src/engine/metadata-modules/flat-field-metadata/utils/compact-flat-field-metadata-maps.util';
-import { expandFlatFieldMetadataMaps } from 'src/engine/metadata-modules/flat-field-metadata/utils/expand-flat-field-metadata-maps.util';
+import { expandFlatFieldMetadataMapsOrThrow } from 'src/engine/metadata-modules/flat-field-metadata/utils/expand-flat-field-metadata-maps-or-throw.util';
import { type FlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/types/flat-field-metadata.type';
const expandOne = (
compactFlatFieldMetadata: CompactFlatFieldMetadata,
): Partial<FlatFieldMetadata> | undefined =>
- expandFlatFieldMetadataMaps({
+ expandFlatFieldMetadataMapsOrThrow({
byUniversalIdentifier: { 'field-uid': compactFlatFieldMetadata },
universalIdentifierById: {},
universalIdentifiersByApplicationId: {},
@@ -19,28 +20,48 @@ const compactOne = (flatFieldMetadata: Partial<FlatFieldMetadata>) =>
universalIdentifiersByApplicationId: {},
});
-describe('expandFlatFieldMetadataMaps', () => {
+describe('expandFlatFieldMetadataMapsOrThrow', () => {
it('should restore a short code to its full key', () => {
- expect(expandOne({ $r: 'firstName' })).toMatchObject({
+ expect(expandOne({ $r: 'firstName', isSearchable: false })).toMatchObject({
name: 'firstName',
});
});
it('should restore an omitted relation array as empty', () => {
- expect(expandOne({})).toMatchObject({ viewFieldIds: [] });
+ expect(expandOne({ isSearchable: false })).toMatchObject({
+ viewFieldIds: [],
+ });
});
it('should keep an expanded relation array over the empty default', () => {
- expect(expandOne({ $H: ['view-field-1'] })).toMatchObject({
+ expect(
+ expandOne({ $H: ['view-field-1'], isSearchable: false }),
+ ).toMatchObject({
viewFieldIds: ['view-field-1'],
});
});
+ it('should keep a cached isSearchable whether true or false', () => {
+ expect(expandOne({ isSearchable: true })).toMatchObject({
+ isSearchable: true,
+ });
+ expect(expandOne({ isSearchable: false })).toMatchObject({
+ isSearchable: false,
+ });
+ });
+
+ it('should throw on an entry cached before isSearchable existed', () => {
+ expect(() => expandOne({ $B: ['search-field-1'] })).toThrow(
+ FlatEntityMapsException,
+ );
+ });
+
it('should round trip a field through JSON, as the cache storage layer does', () => {
const compacted = JSON.parse(
JSON.stringify(
compactOne({
name: 'firstName',
+ isSearchable: false,
viewFieldIds: ['view-field-1'],
viewFilterIds: [],
}),
@@ -48,10 +69,11 @@ describe('expandFlatFieldMetadataMaps', () => {
);
expect(
- expandFlatFieldMetadataMaps(compacted).byUniversalIdentifier,
+ expandFlatFieldMetadataMapsOrThrow(compacted).byUniversalIdentifier,
).toMatchObject({
'field-uid': {
name: 'firstName',
+ isSearchable: false,
viewFieldIds: ['view-field-1'],
viewFilterIds: [],
},
diff --git a/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/expand-flat-field-metadata-maps.util.ts b/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/expand-flat-field-metadata-maps-or-throw.util.ts
similarity index 77%
rename from packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/expand-flat-field-metadata-maps.util.ts
rename to packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/expand-flat-field-metadata-maps-or-throw.util.ts
index d1af24662ce..9aa984a7d06 100644
--- a/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/expand-flat-field-metadata-maps.util.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/expand-flat-field-metadata-maps-or-throw.util.ts
@@ -1,7 +1,13 @@
+import { isDefined } from 'twenty-shared/utils';
+
import {
FLAT_FIELD_METADATA_EMPTY_ARRAY_KEYS,
FLAT_FIELD_METADATA_KEY_LOOKUP,
} from 'src/engine/metadata-modules/flat-field-metadata/constants/flat-field-metadata-cache-codec.constant';
+import {
+ FlatEntityMapsException,
+ FlatEntityMapsExceptionCode,
+} from 'src/engine/metadata-modules/flat-entity/exceptions/flat-entity-maps.exception';
import { type FlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-maps.type';
import {
type CompactFlatFieldMetadata,
@@ -9,7 +15,7 @@ import {
} from 'src/engine/metadata-modules/flat-field-metadata/types/compact-flat-field-metadata-maps.type';
import { type FlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/types/flat-field-metadata.type';
-const expandFlatFieldMetadata = (
+const expandFlatFieldMetadataOrThrow = (
compacted: CompactFlatFieldMetadata | Partial<FlatFieldMetadata>,
): FlatFieldMetadata => {
const expanded: Partial<
@@ -27,10 +33,17 @@ const expandFlatFieldMetadata = (
}
}
+ if (!isDefined(expanded.isSearchable)) {
+ throw new FlatEntityMapsException(
+ 'Cached flat field metadata is missing isSearchable',
+ FlatEntityMapsExceptionCode.ENTITY_MALFORMED,
+ );
+ }
+
return expanded as FlatFieldMetadata;
};
-export const expandFlatFieldMetadataMaps = (
+export const expandFlatFieldMetadataMapsOrThrow = (
compacted: CompactFlatFieldMetadataMaps,
): FlatEntityMaps<FlatFieldMetadata> => {
const byUniversalIdentifier: FlatEntityMaps<FlatFieldMetadata>['byUniversalIdentifier'] =
@@ -39,7 +52,7 @@ export const expandFlatFieldMetadataMaps = (
for (const [universalIdentifier, compactFlatFieldMetadata] of Object.entries(
compacted.byUniversalIdentifier,
)) {
- byUniversalIdentifier[universalIdentifier] = expandFlatFieldMetadata(
+ byUniversalIdentifier[universalIdentifier] = expandFlatFieldMetadataOrThrow(
compactFlatFieldMetadata,
);
}
diff --git a/packages/twenty-server/test/integration/workspace-cache/flat-field-metadata-maps-cache.integration-spec.ts b/packages/twenty-server/test/integration/workspace-cache/flat-field-metadata-maps-cache.integration-spec.ts
new file mode 100644
index 00000000000..122e9e7d6d9
--- /dev/null
+++ b/packages/twenty-server/test/integration/workspace-cache/flat-field-metadata-maps-cache.integration-spec.ts
@@ -0,0 +1,74 @@
+import omit from 'lodash.omit';
+
+import { getAppProviderByClassName } from 'test/integration/utils/get-app-provider-by-class-name.util';
+
+import { type CacheStorageService } from 'src/engine/core-modules/cache-storage/services/cache-storage.service';
+import { CacheStorageNamespace } from 'src/engine/core-modules/cache-storage/types/cache-storage-namespace.enum';
+import { type CompactFlatFieldMetadataMaps } from 'src/engine/metadata-modules/flat-field-metadata/types/compact-flat-field-metadata-maps.type';
+import { type WorkspaceCacheService } from 'src/engine/workspace-cache/services/workspace-cache.service';
+import { SEED_APPLE_WORKSPACE_ID } from 'src/engine/workspace-manager/dev-seeder/core/constants/seeder-workspaces.constant';
+
+const FLAT_FIELD_METADATA_MAPS_DATA_KEY = `flatFieldMetadataMaps:${SEED_APPLE_WORKSPACE_ID}:data`;
+
+describe('Flat field metadata maps cache', () => {
+ let workspaceCacheService: WorkspaceCacheService;
+ let cacheStorage: CacheStorageService;
+
+ const getFlatFieldMetadataMaps = async () => {
+ const { flatFieldMetadataMaps } =
+ await workspaceCacheService.getOrRecompute(SEED_APPLE_WORKSPACE_ID, [
+ 'flatFieldMetadataMaps',
+ ]);
+
+ return flatFieldMetadataMaps;
+ };
+
+ beforeAll(() => {
+ workspaceCacheService = getAppProviderByClassName<WorkspaceCacheService>(
+ 'WorkspaceCacheService',
+ );
+ cacheStorage = global.app.get<CacheStorageService>(
+ CacheStorageNamespace.EngineWorkspace,
+ );
+ });
+
+ afterAll(async () => {
+ await workspaceCacheService.invalidateAndRecompute(
+ SEED_APPLE_WORKSPACE_ID,
+ ['flatFieldMetadataMaps'],
+ );
+ });
+
+ it('rebuilds an entry cached before isSearchable existed', async () => {
+ await workspaceCacheService.invalidateAndRecompute(
+ SEED_APPLE_WORKSPACE_ID,
+ ['flatFieldMetadataMaps'],
+ );
+
+ const flatFieldMetadataMaps = await getFlatFieldMetadataMaps();
+ const compactFlatFieldMetadataMaps =
+ await cacheStorage.get<CompactFlatFieldMetadataMaps>(
+ FLAT_FIELD_METADATA_MAPS_DATA_KEY,
+ );
+
+ await cacheStorage.set(FLAT_FIELD_METADATA_MAPS_DATA_KEY, {
+ ...compactFlatFieldMetadataMaps,
+ byUniversalIdentifier: Object.fromEntries(
+ Object.entries(
+ compactFlatFieldMetadataMaps?.byUniversalIdentifier ?? {},
+ ).map(([universalIdentifier, compactFlatFieldMetadata]) => [
+ universalIdentifier,
+ omit(compactFlatFieldMetadata, 'isSearchable'),
+ ]),
+ ),
+ });
+ await workspaceCacheService.evictWorkspaceFromLocalCache(
+ SEED_APPLE_WORKSPACE_ID,
+ );
+
+ expect(await getFlatFieldMetadataMaps()).toEqual(flatFieldMetadataMaps);
+ expect(await cacheStorage.get(FLAT_FIELD_METADATA_MAPS_DATA_KEY)).toEqual(
+ compactFlatFieldMetadataMaps,
+ );
+ });
+});