[REQUIRES_FULL_CACHE_FLUSH_WHEN_RELEASED] Refactor FlatEntity to be UniversalFlatEntity superset (#17452)

# Introduction In this PR we're refactoring the `FlatEntity` type to become a superset of the `UniversalFlatEntity`. Right now we're storing all the extra properties in `__universal` property, at some point it might just be sibling to other entity and we might rely on the `propertiesToCompare` constants and TypeScript allowing passing a superset type into a smaller subset type ## FromTo utils The entity to flat entity method now computes the universal information, standardized a typing and pattern to do ## Example Also strictly type ```ts "bbb019ea-6205-498c-aea5-67bc53bce8a9": { "workspaceId": "20202020-1c25-4d02-bf25-6aeccf7ea419", "universalIdentifier": "20202020-d111-4d11-8d11-da5ab0a11002", "applicationId": "d01b010d-b984-465b-b40b-370e954e5188", "id": "bbb019ea-6205-498c-aea5-67bc53bce8a9", "pageLayoutTabId": "791a512f-169f-4209-b731-aa86716668c6", "title": "Deals by Company", "type": "GRAPH", "objectMetadataId": "9e14efea-df5b-4c0e-aba9-cfe455f32397", "gridPosition": { "row": 0, "column": 6, "rowSpan": 6, "columnSpan": 6 }, "configuration": { "color": "orange", "orderBy": "FIELD_ASC", "timezone": "UTC", "displayLegend": true, "displayDataLabel": false, "showCenterMetric": true, "configurationType": "PIE_CHART", "firstDayOfTheWeek": 0, "aggregateOperation": "COUNT", "groupBySubFieldName": "name", "groupByFieldMetadataId": "6673ff18-63d2-47a1-8f85-2b9b09ca27a5", "aggregateFieldMetadataId": "8d64ee41-5dd4-4de6-945a-7c0c18399715" }, "createdAt": "2026-01-28T14:08:52.140Z", "updatedAt": "2026-01-28T14:08:52.140Z", "deletedAt": null, "__universal": { "universalIdentifier": "20202020-d111-4d11-8d11-da5ab0a11002", "applicationUniversalIdentifier": "20202020-64aa-4b6f-b003-9c74b97cee20", "pageLayoutTabUniversalIdentifier": "20202020-d011-4d11-8d11-da5ab0a01001", "objectMetadataUniversalIdentifier": "20202020-9549-49dd-b2b2-883999db8938", "gridPosition": { "row": 0, "column": 6, "rowSpan": 6, "columnSpan": 6 }, "configuration": { "color": "orange", "orderBy": "FIELD_ASC", "timezone": "UTC", "displayLegend": true, "displayDataLabel": false, "showCenterMetric": true, "configurationType": "PIE_CHART", "firstDayOfTheWeek": 0, "aggregateOperation": "COUNT", "groupBySubFieldName": "name", "aggregateFieldMetadataUniversalIdentifier": "20202020-d01a-4131-8a31-f123456789ab", "groupByFieldMetadataUniversalIdentifier": "20202020-cbac-457e-b565-adece5fc815f" } } }, ```
2026-01-28 17:46:34 +01:00
parent 81eaee81a8
commit fe9d6f34ff
90 changed files with 3058 additions and 538 deletions
@@ -5,6 +5,7 @@ import { Repository } from 'typeorm';

 import { WorkspaceCacheProvider } from 'src/engine/workspace-cache/interfaces/workspace-cache-provider.service';

+import { ApplicationEntity } from 'src/engine/core-modules/application/application.entity';
 import { FieldMetadataEntity } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
 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';
@@ -14,6 +15,7 @@ import { IndexMetadataEntity } from 'src/engine/metadata-modules/index-metadata/
 import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
 import { ViewEntity } from 'src/engine/metadata-modules/view/entities/view.entity';
 import { WorkspaceCache } from 'src/engine/workspace-cache/decorators/workspace-cache.decorator';
+import { createIdToUniversalIdentifierMap } from 'src/engine/workspace-cache/utils/create-id-to-universal-identifier-map.util';
 import { regroupEntitiesByRelatedEntityId } from 'src/engine/workspace-cache/utils/regroup-entities-by-related-entity-id';
 import { addFlatEntityToFlatEntityMapsThroughMutationOrThrow } from 'src/engine/workspace-manager/workspace-migration/utils/add-flat-entity-to-flat-entity-maps-through-mutation-or-throw.util';

@@ -25,6 +27,8 @@ export class WorkspaceFlatObjectMetadataMapCacheService extends WorkspaceCachePr
  constructor(
    @InjectRepository(ObjectMetadataEntity)
    private readonly objectMetadataRepository: Repository<ObjectMetadataEntity>,
+    @InjectRepository(ApplicationEntity)
+    private readonly applicationRepository: Repository<ApplicationEntity>,
    @InjectRepository(FieldMetadataEntity)
    private readonly fieldMetadataRepository: Repository<FieldMetadataEntity>,
    @InjectRepository(IndexMetadataEntity)
@@ -38,27 +42,33 @@ export class WorkspaceFlatObjectMetadataMapCacheService extends WorkspaceCachePr
  async computeForCache(
    workspaceId: string,
  ): Promise<FlatEntityMaps<FlatObjectMetadata>> {
-    const [objectMetadatas, fields, indexMetadatas, views] = await Promise.all([
-      this.objectMetadataRepository.find({
-        where: { workspaceId },
-        withDeleted: true,
-      }),
-      this.fieldMetadataRepository.find({
-        where: { workspaceId },
-        select: ['id', 'objectMetadataId'],
-        withDeleted: true,
-      }),
-      this.indexMetadataRepository.find({
-        where: { workspaceId },
-        select: ['id', 'objectMetadataId'],
-        withDeleted: true,
-      }),
-      this.viewRepository.find({
-        where: { workspaceId },
-        select: ['id', 'objectMetadataId'],
-        withDeleted: true,
-      }),
-    ]);
+    const [objectMetadatas, applications, fields, indexMetadatas, views] =
+      await Promise.all([
+        this.objectMetadataRepository.find({
+          where: { workspaceId },
+          withDeleted: true,
+        }),
+        this.applicationRepository.find({
+          where: { workspaceId },
+          select: ['id', 'universalIdentifier'],
+          withDeleted: true,
+        }),
+        this.fieldMetadataRepository.find({
+          where: { workspaceId },
+          select: ['id', 'universalIdentifier', 'objectMetadataId'],
+          withDeleted: true,
+        }),
+        this.indexMetadataRepository.find({
+          where: { workspaceId },
+          select: ['id', 'universalIdentifier', 'objectMetadataId'],
+          withDeleted: true,
+        }),
+        this.viewRepository.find({
+          where: { workspaceId },
+          select: ['id', 'universalIdentifier', 'objectMetadataId'],
+          withDeleted: true,
+        }),
+      ]);

    const [fieldsByObjectId, indexesByObjectId, viewsByObjectId] = (
      [
@@ -77,15 +87,24 @@ export class WorkspaceFlatObjectMetadataMapCacheService extends WorkspaceCachePr
      ] as const
    ).map(regroupEntitiesByRelatedEntityId);

+    const applicationIdToUniversalIdentifierMap =
+      createIdToUniversalIdentifierMap(applications);
+    const fieldMetadataIdToUniversalIdentifierMap =
+      createIdToUniversalIdentifierMap(fields);
+
    const flatObjectMetadataMaps = createEmptyFlatEntityMaps();

    for (const objectMetadataEntity of objectMetadatas) {
      const flatObjectMetadata = fromObjectMetadataEntityToFlatObjectMetadata({
-        ...objectMetadataEntity,
-        fields: fieldsByObjectId.get(objectMetadataEntity.id) || [],
-        indexMetadatas: indexesByObjectId.get(objectMetadataEntity.id) || [],
-        views: viewsByObjectId.get(objectMetadataEntity.id) || [],
-      } as ObjectMetadataEntity);
+        entity: {
+          ...objectMetadataEntity,
+          fields: fieldsByObjectId.get(objectMetadataEntity.id) || [],
+          indexMetadatas: indexesByObjectId.get(objectMetadataEntity.id) || [],
+          views: viewsByObjectId.get(objectMetadataEntity.id) || [],
+        },
+        applicationIdToUniversalIdentifierMap,
+        fieldMetadataIdToUniversalIdentifierMap,
+      });

      addFlatEntityToFlatEntityMapsThroughMutationOrThrow({
        flatEntity: flatObjectMetadata,
@@ -1,6 +1,13 @@
 import { type FlatEntityFrom } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';
 import { type ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';

-export type FlatObjectMetadata = FlatEntityFrom<
+type BaseFlatObjectMetadata = FlatEntityFrom<
  Omit<ObjectMetadataEntity, 'targetRelationFields' | 'dataSourceId'>
 >;
+export type FlatObjectMetadata = Omit<BaseFlatObjectMetadata, '__universal'> & {
+  __universal?: BaseFlatObjectMetadata['__universal'] & {
+    // TODO remove once https://github.com/twentyhq/core-team-issues/issues/2172 has been resolved
+    labelIdentifierFieldMetadataUniversalIdentifier: string | null;
+    imageIdentifierFieldMetadataUniversalIdentifier: string | null;
+  };
+};
@@ -1,27 +1,99 @@
-import { removePropertiesFromRecord } from 'twenty-shared/utils';
+import { isDefined, removePropertiesFromRecord } from 'twenty-shared/utils';

+import {
+  FlatEntityMapsException,
+  FlatEntityMapsExceptionCode,
+} from 'src/engine/metadata-modules/flat-entity/exceptions/flat-entity-maps.exception';
 import { getMetadataEntityRelationProperties } from 'src/engine/metadata-modules/flat-entity/utils/get-metadata-entity-relation-properties.util';
 import { type FlatObjectMetadata } from 'src/engine/metadata-modules/flat-object-metadata/types/flat-object-metadata.type';
-import { type ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
+import { type FromEntityToFlatEntityArgs } from 'src/engine/workspace-cache/types/from-entity-to-flat-entity-args.type';

-export const fromObjectMetadataEntityToFlatObjectMetadata = (
-  objectMetadataEntity: ObjectMetadataEntity,
-): FlatObjectMetadata => {
+type FromObjectMetadataEntityToFlatObjectMetadataArgs =
+  FromEntityToFlatEntityArgs<'objectMetadata'> & {
+    fieldMetadataIdToUniversalIdentifierMap: Map<string, string>;
+  };
+
+export const fromObjectMetadataEntityToFlatObjectMetadata = ({
+  entity: objectMetadataEntity,
+  applicationIdToUniversalIdentifierMap,
+  fieldMetadataIdToUniversalIdentifierMap,
+}: FromObjectMetadataEntityToFlatObjectMetadataArgs): FlatObjectMetadata => {
  const objectMetadataEntityWithoutRelations = removePropertiesFromRecord(
    objectMetadataEntity,
    getMetadataEntityRelationProperties('objectMetadata'),
  );

+  const applicationUniversalIdentifier =
+    applicationIdToUniversalIdentifierMap.get(
+      objectMetadataEntity.applicationId,
+    );
+
+  if (!isDefined(applicationUniversalIdentifier)) {
+    throw new FlatEntityMapsException(
+      `Application with id ${objectMetadataEntity.applicationId} not found when building flat object metadata for object ${objectMetadataEntity.id}`,
+      FlatEntityMapsExceptionCode.ENTITY_NOT_FOUND,
+    );
+  }
+
+  let labelIdentifierFieldMetadataUniversalIdentifier: string | null = null;
+
+  if (isDefined(objectMetadataEntity.labelIdentifierFieldMetadataId)) {
+    labelIdentifierFieldMetadataUniversalIdentifier =
+      fieldMetadataIdToUniversalIdentifierMap.get(
+        objectMetadataEntity.labelIdentifierFieldMetadataId,
+      ) ?? null;
+
+    if (!isDefined(labelIdentifierFieldMetadataUniversalIdentifier)) {
+      throw new FlatEntityMapsException(
+        `Label identifier field metadata with id ${objectMetadataEntity.labelIdentifierFieldMetadataId} not found when building flat object metadata for object ${objectMetadataEntity.id}`,
+        FlatEntityMapsExceptionCode.ENTITY_NOT_FOUND,
+      );
+    }
+  }
+
+  let imageIdentifierFieldMetadataUniversalIdentifier: string | null = null;
+
+  if (isDefined(objectMetadataEntity.imageIdentifierFieldMetadataId)) {
+    imageIdentifierFieldMetadataUniversalIdentifier =
+      fieldMetadataIdToUniversalIdentifierMap.get(
+        objectMetadataEntity.imageIdentifierFieldMetadataId,
+      ) ?? null;
+
+    if (!isDefined(imageIdentifierFieldMetadataUniversalIdentifier)) {
+      throw new FlatEntityMapsException(
+        `Image identifier field metadata with id ${objectMetadataEntity.imageIdentifierFieldMetadataId} not found when building flat object metadata for object ${objectMetadataEntity.id}`,
+        FlatEntityMapsExceptionCode.ENTITY_NOT_FOUND,
+      );
+    }
+  }
+
  return {
    ...objectMetadataEntityWithoutRelations,
    universalIdentifier:
      objectMetadataEntityWithoutRelations.universalIdentifier,
    createdAt: objectMetadataEntity.createdAt.toISOString(),
    updatedAt: objectMetadataEntity.updatedAt.toISOString(),
-    viewIds: objectMetadataEntity.views.map((viewEntity) => viewEntity.id),
-    indexMetadataIds: objectMetadataEntity.indexMetadatas.map(
-      (indexEntity) => indexEntity.id,
-    ),
-    fieldIds: objectMetadataEntity.fields.map((fieldEntity) => fieldEntity.id),
+    viewIds: objectMetadataEntity.views.map(({ id }) => id),
+    indexMetadataIds: objectMetadataEntity.indexMetadatas.map(({ id }) => id),
+    fieldIds: objectMetadataEntity.fields.map(({ id }) => id),
+    __universal: {
+      universalIdentifier:
+        objectMetadataEntityWithoutRelations.universalIdentifier,
+      applicationUniversalIdentifier,
+      labelIdentifierFieldMetadataUniversalIdentifier,
+      imageIdentifierFieldMetadataUniversalIdentifier,
+      fieldUniversalIdentifiers: objectMetadataEntity.fields.map(
+        ({ universalIdentifier }) => universalIdentifier,
+      ),
+      indexMetadataUniversalIdentifiers:
+        objectMetadataEntity.indexMetadatas.map(
+          ({ universalIdentifier }) => universalIdentifier,
+        ),
+      viewUniversalIdentifiers: objectMetadataEntity.views.map(
+        ({ universalIdentifier }) => universalIdentifier,
+      ),
+      standardOverrides: objectMetadataEntityWithoutRelations.standardOverrides,
+      duplicateCriteria: objectMetadataEntityWithoutRelations.duplicateCriteria,
+    },
  };
 };