Skip to content

The open alternative to Salesforce, designed for AI.

refactor(server): name workspace-cache transforms compact/serialize/pack (#24129)

Charles Bochet996ff174baa1
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 4a1c7d2ca41..ef7ec3563a9 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
@@ -10,9 +10,9 @@ import { FieldMetadataEntity } from 'src/engine/metadata-modules/field-metadata/
import { createEmptyFlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/constant/create-empty-flat-entity-maps.constant';
import { FlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-maps.type';
import { FlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/types/flat-field-metadata.type';
-import { type EncodedFlatFieldMetadataMaps } from 'src/engine/metadata-modules/flat-field-metadata/types/encoded-flat-field-metadata-maps.type';
-import { decodeFlatFieldMetadataMapsFromCache } from 'src/engine/metadata-modules/flat-field-metadata/utils/decode-flat-field-metadata-maps-from-cache.util';
-import { encodeFlatFieldMetadataMapsForCache } from 'src/engine/metadata-modules/flat-field-metadata/utils/encode-flat-field-metadata-maps-for-cache.util';
+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 { fromFieldMetadataEntityToFlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/utils/from-field-metadata-entity-to-flat-field-metadata.util';
import { IndexMetadataEntity } from 'src/engine/metadata-modules/index-metadata/index-metadata.entity';
import { computeUniqueFieldMetadataIdsFromIndexEntities } from 'src/engine/metadata-modules/index-metadata/utils/compute-unique-field-metadata-ids-from-index-entities.util';
@@ -34,7 +34,7 @@ import { ViewSortEntity } from 'src/engine/metadata-modules/view-sort/entities/v
@WorkspaceCache('flatFieldMetadataMaps', { packingPonderation: 64 })
export class WorkspaceFlatFieldMetadataMapCacheService extends WorkspaceCacheProvider<
FlatEntityMaps<FlatFieldMetadata>,
- EncodedFlatFieldMetadataMaps
+ CompactFlatFieldMetadataMaps
> {
constructor(
@InjectRepository(FieldMetadataEntity)
@@ -61,16 +61,16 @@ export class WorkspaceFlatFieldMetadataMapCacheService extends WorkspaceCachePro
super();
}
- override encodeForCacheStorage(
+ override compactForStorage(
data: FlatEntityMaps<FlatFieldMetadata>,
- ): EncodedFlatFieldMetadataMaps {
- return encodeFlatFieldMetadataMapsForCache(data);
+ ): CompactFlatFieldMetadataMaps {
+ return compactFlatFieldMetadataMaps(data);
}
- override decodeFromCacheStorage(
- rawData: EncodedFlatFieldMetadataMaps,
+ override expandFromStorage(
+ compactData: CompactFlatFieldMetadataMaps,
): FlatEntityMaps<FlatFieldMetadata> {
- return decodeFlatFieldMetadataMapsFromCache(rawData);
+ return expandFlatFieldMetadataMaps(compactData);
}
async computeForCache(
diff --git a/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/types/encoded-flat-field-metadata-maps.type.ts b/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/types/compact-flat-field-metadata-maps.type.ts
similarity index 84%
rename from packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/types/encoded-flat-field-metadata-maps.type.ts
rename to packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/types/compact-flat-field-metadata-maps.type.ts
index 7994eefa9d5..ceb6dc2bc28 100644
--- a/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/types/encoded-flat-field-metadata-maps.type.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/types/compact-flat-field-metadata-maps.type.ts
@@ -4,19 +4,19 @@ import { type FlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-m
type ShortCodeByKey = typeof FLAT_FIELD_METADATA_SHORT_CODE_BY_KEY;
-export type EncodedFlatFieldMetadata = {
+export type CompactFlatFieldMetadata = {
[Key in keyof FlatFieldMetadata as Key extends keyof ShortCodeByKey
? ShortCodeByKey[Key]
: Key]?: FlatFieldMetadata[Key];
};
-export type EncodedFlatFieldMetadataMaps = {
- byUniversalIdentifier: Record<string, EncodedFlatFieldMetadata>;
+export type CompactFlatFieldMetadataMaps = {
+ byUniversalIdentifier: Record<string, CompactFlatFieldMetadata>;
universalIdentifierById: FlatEntityMaps<FlatFieldMetadata>['universalIdentifierById'];
universalIdentifiersByApplicationId: FlatEntityMaps<FlatFieldMetadata>['universalIdentifiersByApplicationId'];
};
-export type EncodableFlatFieldMetadataMaps = {
+export type ExpandedFlatFieldMetadataMaps = {
byUniversalIdentifier: Partial<Record<string, Partial<FlatFieldMetadata>>>;
universalIdentifierById: FlatEntityMaps<FlatFieldMetadata>['universalIdentifierById'];
universalIdentifiersByApplicationId: FlatEntityMaps<FlatFieldMetadata>['universalIdentifiersByApplicationId'];
diff --git a/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/__tests__/compact-flat-field-metadata-maps.util.spec.ts b/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/__tests__/compact-flat-field-metadata-maps.util.spec.ts
new file mode 100644
index 00000000000..b6e81b7c12a
--- /dev/null
+++ b/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/__tests__/compact-flat-field-metadata-maps.util.spec.ts
@@ -0,0 +1,28 @@
+import { type CompactFlatFieldMetadata } 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';
+import { compactFlatFieldMetadataMaps } from 'src/engine/metadata-modules/flat-field-metadata/utils/compact-flat-field-metadata-maps.util';
+
+const compactOne = (
+ flatFieldMetadata: Partial<FlatFieldMetadata>,
+): CompactFlatFieldMetadata =>
+ compactFlatFieldMetadataMaps({
+ byUniversalIdentifier: { 'field-uid': flatFieldMetadata },
+ universalIdentifierById: {},
+ universalIdentifiersByApplicationId: {},
+ }).byUniversalIdentifier['field-uid'];
+
+describe('compactFlatFieldMetadataMaps', () => {
+ it('should replace a mapped key with its short code', () => {
+ expect(compactOne({ name: 'firstName' })).toEqual({ $r: 'firstName' });
+ });
+
+ it('should drop a relation array that is empty', () => {
+ expect(compactOne({ viewFieldIds: [] })).toEqual({});
+ });
+
+ it('should keep a relation array that is populated', () => {
+ expect(compactOne({ viewFieldIds: ['view-field-1'] })).toEqual({
+ $H: ['view-field-1'],
+ });
+ });
+});
diff --git a/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/__tests__/decode-flat-field-metadata-maps-from-cache.util.spec.ts b/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/__tests__/decode-flat-field-metadata-maps-from-cache.util.spec.ts
deleted file mode 100644
index 447fe05eb4a..00000000000
--- a/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/__tests__/decode-flat-field-metadata-maps-from-cache.util.spec.ts
+++ /dev/null
@@ -1,60 +0,0 @@
-import { type EncodedFlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/types/encoded-flat-field-metadata-maps.type';
-import { decodeFlatFieldMetadataMapsFromCache } from 'src/engine/metadata-modules/flat-field-metadata/utils/decode-flat-field-metadata-maps-from-cache.util';
-import { encodeFlatFieldMetadataMapsForCache } from 'src/engine/metadata-modules/flat-field-metadata/utils/encode-flat-field-metadata-maps-for-cache.util';
-import { type FlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/types/flat-field-metadata.type';
-
-const decodeOne = (
- encodedFlatFieldMetadata: EncodedFlatFieldMetadata,
-): Partial<FlatFieldMetadata> | undefined =>
- decodeFlatFieldMetadataMapsFromCache({
- byUniversalIdentifier: { 'field-uid': encodedFlatFieldMetadata },
- universalIdentifierById: {},
- universalIdentifiersByApplicationId: {},
- }).byUniversalIdentifier['field-uid'];
-
-const encodeOne = (flatFieldMetadata: Partial<FlatFieldMetadata>) =>
- encodeFlatFieldMetadataMapsForCache({
- byUniversalIdentifier: { 'field-uid': flatFieldMetadata },
- universalIdentifierById: {},
- universalIdentifiersByApplicationId: {},
- });
-
-describe('decodeFlatFieldMetadataMapsFromCache', () => {
- it('should restore a short code to its full key', () => {
- expect(decodeOne({ $r: 'firstName' })).toMatchObject({
- name: 'firstName',
- });
- });
-
- it('should restore an omitted relation array as empty', () => {
- expect(decodeOne({})).toMatchObject({ viewFieldIds: [] });
- });
-
- it('should keep a decoded relation array over the empty default', () => {
- expect(decodeOne({ $H: ['view-field-1'] })).toMatchObject({
- viewFieldIds: ['view-field-1'],
- });
- });
-
- it('should round trip a field through JSON, as the cache storage layer does', () => {
- const encoded = JSON.parse(
- JSON.stringify(
- encodeOne({
- name: 'firstName',
- viewFieldIds: ['view-field-1'],
- viewFilterIds: [],
- }),
- ),
- );
-
- expect(
- decodeFlatFieldMetadataMapsFromCache(encoded).byUniversalIdentifier,
- ).toMatchObject({
- 'field-uid': {
- name: 'firstName',
- viewFieldIds: ['view-field-1'],
- viewFilterIds: [],
- },
- });
- });
-});
diff --git a/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/__tests__/encode-flat-field-metadata-maps-for-cache.util.spec.ts b/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/__tests__/encode-flat-field-metadata-maps-for-cache.util.spec.ts
deleted file mode 100644
index 7ca91ebc2c0..00000000000
--- a/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/__tests__/encode-flat-field-metadata-maps-for-cache.util.spec.ts
+++ /dev/null
@@ -1,28 +0,0 @@
-import { type EncodedFlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/types/encoded-flat-field-metadata-maps.type';
-import { type FlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/types/flat-field-metadata.type';
-import { encodeFlatFieldMetadataMapsForCache } from 'src/engine/metadata-modules/flat-field-metadata/utils/encode-flat-field-metadata-maps-for-cache.util';
-
-const encodeOne = (
- flatFieldMetadata: Partial<FlatFieldMetadata>,
-): EncodedFlatFieldMetadata =>
- encodeFlatFieldMetadataMapsForCache({
- byUniversalIdentifier: { 'field-uid': flatFieldMetadata },
- universalIdentifierById: {},
- universalIdentifiersByApplicationId: {},
- }).byUniversalIdentifier['field-uid'];
-
-describe('encodeFlatFieldMetadataMapsForCache', () => {
- it('should replace a mapped key with its short code', () => {
- expect(encodeOne({ name: 'firstName' })).toEqual({ $r: 'firstName' });
- });
-
- it('should drop a relation array that is empty', () => {
- expect(encodeOne({ viewFieldIds: [] })).toEqual({});
- });
-
- it('should keep a relation array that is populated', () => {
- expect(encodeOne({ viewFieldIds: ['view-field-1'] })).toEqual({
- $H: ['view-field-1'],
- });
- });
-});
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.util.spec.ts
new file mode 100644
index 00000000000..05e44671c1d
--- /dev/null
+++ b/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/__tests__/expand-flat-field-metadata-maps.util.spec.ts
@@ -0,0 +1,60 @@
+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 { type FlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/types/flat-field-metadata.type';
+
+const expandOne = (
+ compactFlatFieldMetadata: CompactFlatFieldMetadata,
+): Partial<FlatFieldMetadata> | undefined =>
+ expandFlatFieldMetadataMaps({
+ byUniversalIdentifier: { 'field-uid': compactFlatFieldMetadata },
+ universalIdentifierById: {},
+ universalIdentifiersByApplicationId: {},
+ }).byUniversalIdentifier['field-uid'];
+
+const compactOne = (flatFieldMetadata: Partial<FlatFieldMetadata>) =>
+ compactFlatFieldMetadataMaps({
+ byUniversalIdentifier: { 'field-uid': flatFieldMetadata },
+ universalIdentifierById: {},
+ universalIdentifiersByApplicationId: {},
+ });
+
+describe('expandFlatFieldMetadataMaps', () => {
+ it('should restore a short code to its full key', () => {
+ expect(expandOne({ $r: 'firstName' })).toMatchObject({
+ name: 'firstName',
+ });
+ });
+
+ it('should restore an omitted relation array as empty', () => {
+ expect(expandOne({})).toMatchObject({ viewFieldIds: [] });
+ });
+
+ it('should keep an expanded relation array over the empty default', () => {
+ expect(expandOne({ $H: ['view-field-1'] })).toMatchObject({
+ viewFieldIds: ['view-field-1'],
+ });
+ });
+
+ it('should round trip a field through JSON, as the cache storage layer does', () => {
+ const compacted = JSON.parse(
+ JSON.stringify(
+ compactOne({
+ name: 'firstName',
+ viewFieldIds: ['view-field-1'],
+ viewFilterIds: [],
+ }),
+ ),
+ );
+
+ expect(
+ expandFlatFieldMetadataMaps(compacted).byUniversalIdentifier,
+ ).toMatchObject({
+ 'field-uid': {
+ name: 'firstName',
+ viewFieldIds: ['view-field-1'],
+ viewFilterIds: [],
+ },
+ });
+ });
+});
diff --git a/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/encode-flat-field-metadata-maps-for-cache.util.ts b/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/compact-flat-field-metadata-maps.util.ts
similarity index 64%
rename from packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/encode-flat-field-metadata-maps-for-cache.util.ts
rename to packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/compact-flat-field-metadata-maps.util.ts
index b6a88024f37..7d5a2e46bd6 100644
--- a/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/encode-flat-field-metadata-maps-for-cache.util.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/compact-flat-field-metadata-maps.util.ts
@@ -5,16 +5,16 @@ import {
FLAT_FIELD_METADATA_SHORT_CODE_LOOKUP,
} from 'src/engine/metadata-modules/flat-field-metadata/constants/flat-field-metadata-cache-codec.constant';
import {
- type EncodableFlatFieldMetadataMaps,
- type EncodedFlatFieldMetadata,
- type EncodedFlatFieldMetadataMaps,
-} from 'src/engine/metadata-modules/flat-field-metadata/types/encoded-flat-field-metadata-maps.type';
+ type CompactFlatFieldMetadata,
+ type CompactFlatFieldMetadataMaps,
+ type ExpandedFlatFieldMetadataMaps,
+} 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 encodeFlatFieldMetadata = (
+const compactFlatFieldMetadata = (
flatFieldMetadata: Partial<FlatFieldMetadata>,
-): EncodedFlatFieldMetadata => {
- const encoded: Partial<
+): CompactFlatFieldMetadata => {
+ const compacted: Partial<
Record<string, FlatFieldMetadata[keyof FlatFieldMetadata]>
> = {};
@@ -27,16 +27,16 @@ const encodeFlatFieldMetadata = (
continue;
}
- encoded[FLAT_FIELD_METADATA_SHORT_CODE_LOOKUP.get(key) ?? key] = value;
+ compacted[FLAT_FIELD_METADATA_SHORT_CODE_LOOKUP.get(key) ?? key] = value;
}
- return encoded;
+ return compacted;
};
-export const encodeFlatFieldMetadataMapsForCache = (
- flatEntityMaps: EncodableFlatFieldMetadataMaps,
-): EncodedFlatFieldMetadataMaps => {
- const byUniversalIdentifier: Record<string, EncodedFlatFieldMetadata> = {};
+export const compactFlatFieldMetadataMaps = (
+ flatEntityMaps: ExpandedFlatFieldMetadataMaps,
+): CompactFlatFieldMetadataMaps => {
+ const byUniversalIdentifier: Record<string, CompactFlatFieldMetadata> = {};
for (const [universalIdentifier, flatFieldMetadata] of Object.entries(
flatEntityMaps.byUniversalIdentifier,
@@ -46,7 +46,7 @@ export const encodeFlatFieldMetadataMapsForCache = (
}
byUniversalIdentifier[universalIdentifier] =
- encodeFlatFieldMetadata(flatFieldMetadata);
+ compactFlatFieldMetadata(flatFieldMetadata);
}
return {
diff --git a/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/decode-flat-field-metadata-maps-from-cache.util.ts b/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/decode-flat-field-metadata-maps-from-cache.util.ts
deleted file mode 100644
index 24fb04607e2..00000000000
--- a/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/decode-flat-field-metadata-maps-from-cache.util.ts
+++ /dev/null
@@ -1,52 +0,0 @@
-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 { type FlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-maps.type';
-import {
- type EncodedFlatFieldMetadata,
- type EncodedFlatFieldMetadataMaps,
-} from 'src/engine/metadata-modules/flat-field-metadata/types/encoded-flat-field-metadata-maps.type';
-import { type FlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/types/flat-field-metadata.type';
-
-const decodeFlatFieldMetadata = (
- encoded: EncodedFlatFieldMetadata | Partial<FlatFieldMetadata>,
-): FlatFieldMetadata => {
- const decoded: Partial<
- Record<string, FlatFieldMetadata[keyof FlatFieldMetadata]>
- > = {};
-
- for (const [shortCode, value] of Object.entries(encoded)) {
- decoded[FLAT_FIELD_METADATA_KEY_LOOKUP.get(shortCode) ?? shortCode] = value;
- }
-
- for (const key of FLAT_FIELD_METADATA_EMPTY_ARRAY_KEYS) {
- if (!(key in decoded)) {
- decoded[key] = [];
- }
- }
-
- return decoded as FlatFieldMetadata;
-};
-
-export const decodeFlatFieldMetadataMapsFromCache = (
- encoded: EncodedFlatFieldMetadataMaps,
-): FlatEntityMaps<FlatFieldMetadata> => {
- const byUniversalIdentifier: FlatEntityMaps<FlatFieldMetadata>['byUniversalIdentifier'] =
- {};
-
- for (const [universalIdentifier, encodedFlatFieldMetadata] of Object.entries(
- encoded.byUniversalIdentifier,
- )) {
- byUniversalIdentifier[universalIdentifier] = decodeFlatFieldMetadata(
- encodedFlatFieldMetadata,
- );
- }
-
- return {
- byUniversalIdentifier,
- universalIdentifierById: encoded.universalIdentifierById,
- universalIdentifiersByApplicationId:
- encoded.universalIdentifiersByApplicationId,
- };
-};
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.util.ts
new file mode 100644
index 00000000000..d1af24662ce
--- /dev/null
+++ b/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/expand-flat-field-metadata-maps.util.ts
@@ -0,0 +1,53 @@
+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 { type FlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-maps.type';
+import {
+ type CompactFlatFieldMetadata,
+ type CompactFlatFieldMetadataMaps,
+} 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 = (
+ compacted: CompactFlatFieldMetadata | Partial<FlatFieldMetadata>,
+): FlatFieldMetadata => {
+ const expanded: Partial<
+ Record<string, FlatFieldMetadata[keyof FlatFieldMetadata]>
+ > = {};
+
+ for (const [shortCode, value] of Object.entries(compacted)) {
+ expanded[FLAT_FIELD_METADATA_KEY_LOOKUP.get(shortCode) ?? shortCode] =
+ value;
+ }
+
+ for (const key of FLAT_FIELD_METADATA_EMPTY_ARRAY_KEYS) {
+ if (!(key in expanded)) {
+ expanded[key] = [];
+ }
+ }
+
+ return expanded as FlatFieldMetadata;
+};
+
+export const expandFlatFieldMetadataMaps = (
+ compacted: CompactFlatFieldMetadataMaps,
+): FlatEntityMaps<FlatFieldMetadata> => {
+ const byUniversalIdentifier: FlatEntityMaps<FlatFieldMetadata>['byUniversalIdentifier'] =
+ {};
+
+ for (const [universalIdentifier, compactFlatFieldMetadata] of Object.entries(
+ compacted.byUniversalIdentifier,
+ )) {
+ byUniversalIdentifier[universalIdentifier] = expandFlatFieldMetadata(
+ compactFlatFieldMetadata,
+ );
+ }
+
+ return {
+ byUniversalIdentifier,
+ universalIdentifierById: compacted.universalIdentifierById,
+ universalIdentifiersByApplicationId:
+ compacted.universalIdentifiersByApplicationId,
+ };
+};
diff --git a/packages/twenty-server/src/engine/workspace-cache/interfaces/workspace-cache-provider.service.ts b/packages/twenty-server/src/engine/workspace-cache/interfaces/workspace-cache-provider.service.ts
index 38b6d4d6a92..1247c3d92fc 100644
--- a/packages/twenty-server/src/engine/workspace-cache/interfaces/workspace-cache-provider.service.ts
+++ b/packages/twenty-server/src/engine/workspace-cache/interfaces/workspace-cache-provider.service.ts
@@ -10,15 +10,15 @@ type WorkspaceCacheDataType = WorkspaceCacheDataMap[WorkspaceCacheKeyName];
@Injectable()
export abstract class WorkspaceCacheProvider<
T extends WorkspaceCacheDataType = WorkspaceCacheDataType,
- TEncoded = T,
+ TCompact = T,
> {
abstract computeForCache(workspaceId: string): Promise<T>;
- encodeForCacheStorage(data: T): T | TEncoded {
+ compactForStorage(data: T): T | TCompact {
return data;
}
- decodeFromCacheStorage(rawData: T | TEncoded): T {
- return rawData as T;
+ expandFromStorage(compactData: T | TCompact): T {
+ return compactData as T;
}
}
diff --git a/packages/twenty-server/src/engine/workspace-cache/services/workspace-cache.service.ts b/packages/twenty-server/src/engine/workspace-cache/services/workspace-cache.service.ts
index 217b05a086f..ff1a1c992bb 100644
--- a/packages/twenty-server/src/engine/workspace-cache/services/workspace-cache.service.ts
+++ b/packages/twenty-server/src/engine/workspace-cache/services/workspace-cache.service.ts
@@ -42,6 +42,10 @@ import {
import { combineCacheHashes } from 'src/engine/workspace-cache/utils/combine-cache-hashes.util';
import { getKeyNameFromLocalCacheKey } from 'src/engine/workspace-cache/utils/get-key-name-from-local-cache-key.util';
import { packIdleVersions } from 'src/engine/workspace-cache/utils/pack-idle-versions.util';
+import {
+ deserializeCacheBlob,
+ serializeCacheBlob,
+} from 'src/engine/workspace-cache/utils/serialize-cache-blob.util';
import { sweepLocalCache } from 'src/engine/workspace-cache/utils/sweep-local-cache.util';
const LOCAL_TTL_MS = 100; // 100ms
@@ -472,11 +476,10 @@ export class WorkspaceCacheService implements OnModuleInit, OnModuleDestroy {
let data: CacheDataType;
try {
- data =
- this.getProviderOrThrow(keyName).decodeFromCacheStorage(rawData);
+ data = this.getProviderOrThrow(keyName).expandFromStorage(rawData);
} catch (error) {
this.logger.warn(
- `Failed to decode cached ${keyName} for workspace ${workspaceId}, recomputing`,
+ `Failed to expand cached ${keyName} for workspace ${workspaceId}, recomputing`,
error,
);
missingInRedis.push(keyName);
@@ -571,7 +574,7 @@ export class WorkspaceCacheService implements OnModuleInit, OnModuleDestroy {
if (!isLocalDataOnly) {
redisEntries.push({
key: `${baseKey}:data`,
- value: this.getProviderOrThrow(keyName).encodeForCacheStorage(data),
+ value: this.getProviderOrThrow(keyName).compactForStorage(data),
});
}
@@ -715,11 +718,8 @@ export class WorkspaceCacheService implements OnModuleInit, OnModuleDestroy {
localKey,
) as WorkspaceCacheKeyName;
- return Buffer.from(
- JSON.stringify(
- this.getProviderOrThrow(keyName).encodeForCacheStorage(data),
- ),
- 'utf8',
+ return serializeCacheBlob(
+ this.getProviderOrThrow(keyName).compactForStorage(data),
);
},
});
@@ -749,8 +749,8 @@ export class WorkspaceCacheService implements OnModuleInit, OnModuleDestroy {
}
const unpackStartedAt = performance.now();
- const data = this.getProviderOrThrow(keyName).decodeFromCacheStorage(
- JSON.parse(version.blob.toString('utf8')),
+ const data = this.getProviderOrThrow(keyName).expandFromStorage(
+ deserializeCacheBlob(version.blob),
);
entry.versions.set(hash, {
diff --git a/packages/twenty-server/src/engine/workspace-cache/types/workspace-cache-key.type.ts b/packages/twenty-server/src/engine/workspace-cache/types/workspace-cache-key.type.ts
index 60f48214029..191a819387b 100644
--- a/packages/twenty-server/src/engine/workspace-cache/types/workspace-cache-key.type.ts
+++ b/packages/twenty-server/src/engine/workspace-cache/types/workspace-cache-key.type.ts
@@ -4,7 +4,7 @@ import {
} from 'twenty-shared/types';
import { type EntityMetadata } from 'typeorm';
-import { type EncodedFlatFieldMetadataMaps } from 'src/engine/metadata-modules/flat-field-metadata/types/encoded-flat-field-metadata-maps.type';
+import { type CompactFlatFieldMetadataMaps } from 'src/engine/metadata-modules/flat-field-metadata/types/compact-flat-field-metadata-maps.type';
import { type ResolverNameMapEntry } from 'src/engine/api/graphql/direct-execution/utils/build-resolver-name-map.util';
import { type FlatApiKey } from 'src/engine/core-modules/api-key/types/flat-api-key.type';
import { type ApplicationVariableCacheMaps } from 'src/engine/core-modules/application/application-variable/types/application-variable-cache-maps.type';
@@ -57,5 +57,5 @@ export type WorkspaceCacheStoredDataMap = Omit<
> & {
flatFieldMetadataMaps:
| WorkspaceCacheDataMap['flatFieldMetadataMaps']
- | EncodedFlatFieldMetadataMaps;
+ | CompactFlatFieldMetadataMaps;
};
diff --git a/packages/twenty-server/src/engine/workspace-cache/utils/serialize-cache-blob.util.ts b/packages/twenty-server/src/engine/workspace-cache/utils/serialize-cache-blob.util.ts
new file mode 100644
index 00000000000..02b84996359
--- /dev/null
+++ b/packages/twenty-server/src/engine/workspace-cache/utils/serialize-cache-blob.util.ts
@@ -0,0 +1,5 @@
+export const serializeCacheBlob = (value: unknown): Buffer =>
+ Buffer.from(JSON.stringify(value), 'utf8');
+
+export const deserializeCacheBlob = <TValue>(blob: Buffer): TValue =>
+ JSON.parse(blob.toString('utf8')) as TValue;