Factorize from entity to flat entity utils (#21972)

## What Factorizes the two responsibilities that were copy‑pasted across every `from-<entity>-entity-to-flat-<entity>` util into two reusable tools. ### `fromEntityToScalarEntity` Projects a TypeORM entity into its scalar flat shape using an **allow‑list** driven by `ALL_ENTITY_PROPERTIES_CONFIGURATION_BY_METADATA_NAME` (plus the base columns `id`/`workspaceId`/`applicationId`/`universalIdentifier`). Only registered scalar columns are forwarded, `Date`s are serialized to ISO strings, and absent values are normalized to `null`. Replaces the previous deny‑list (`removePropertiesFromRecord`) approach, so unregistered/deprecated columns can no longer silently leak into the flat entity. ### `resolveManyToOneRelationIdsToUniversalIdentifiers` Resolves an entity's many‑to‑one foreign keys to their universal identifiers, driven by `ALL_MANY_TO_ONE_METADATA_RELATIONS`. Handles the always‑present `application`, nullable relations, and throws a `FlatEntityMapsException` when a referenced id is missing from its identifier map. Mirrors `resolveUniversalRelationIdentifiersToIds` in the opposite direction. Each `from-<entity>` util now reduces to: scalar spread + relation spread (+ explicit one‑to‑many id/universalIdentifier arrays where applicable). ### Note The allow‑list drops `isUIReadOnly` (a `WasRemovedInUpgrade` column not in the config) from `fieldMetadata`, which is the only integration‑snapshot change.  <a href="https://cubic.dev/pr/twentyhq/twenty/pull/21972?utm_source=github" target="_blank" rel="noopener noreferrer" data-no-image-dialog="true"><picture><source media="(prefers-color-scheme: dark)" srcset="https://www.cubic.dev/buttons/review-in-cubic-dark.svg"><source media="(prefers-color-scheme: light)" srcset="https://www.cubic.dev/buttons/review-in-cubic-light.svg"><img alt="Review in cubic" src="https://www.cubic.dev/buttons/review-in-cubic-dark.svg"></picture></a>
2026-06-24 12:20:09 +02:00
parent 41d1b478b0
commit d2387430a1
34 changed files with 1106 additions and 1614 deletions
@@ -1,118 +1,26 @@
-import { isDefined } from 'twenty-shared/utils';
-
-import {
-  FlatEntityMapsException,
-  FlatEntityMapsExceptionCode,
-} from 'src/engine/metadata-modules/flat-entity/exceptions/flat-entity-maps.exception';
+import { fromEntityToScalarEntity } from 'src/engine/metadata-modules/flat-entity/utils/from-entity-to-scalar-entity.util';
 import { type FlatNavigationMenuItem } from 'src/engine/metadata-modules/flat-navigation-menu-item/types/flat-navigation-menu-item.type';
 import { type FromEntityToFlatEntityArgs } from 'src/engine/workspace-cache/types/from-entity-to-flat-entity-args.type';
+import { resolveManyToOneRelationIdsToUniversalIdentifiers } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/utils/resolve-many-to-one-relation-ids-to-universal-identifiers.util';

-export const fromNavigationMenuItemEntityToFlatNavigationMenuItem = ({
-  entity: navigationMenuItemEntity,
-  applicationIdToUniversalIdentifierMap,
-  objectMetadataIdToUniversalIdentifierMap,
-  navigationMenuItemIdToUniversalIdentifierMap,
-  viewIdToUniversalIdentifierMap,
-  pageLayoutIdToUniversalIdentifierMap,
-}: FromEntityToFlatEntityArgs<'navigationMenuItem'>): FlatNavigationMenuItem => {
-  const applicationUniversalIdentifier =
-    applicationIdToUniversalIdentifierMap.get(
-      navigationMenuItemEntity.applicationId,
-    );
+export const fromNavigationMenuItemEntityToFlatNavigationMenuItem = (
+  args: FromEntityToFlatEntityArgs<'navigationMenuItem'>,
+): FlatNavigationMenuItem => {
+  const { entity: navigationMenuItemEntity } = args;

-  if (!isDefined(applicationUniversalIdentifier)) {
-    throw new FlatEntityMapsException(
-      `Application with id ${navigationMenuItemEntity.applicationId} not found for navigationMenuItem ${navigationMenuItemEntity.id}`,
-      FlatEntityMapsExceptionCode.ENTITY_NOT_FOUND,
-    );
-  }
+  const navigationMenuItemScalarEntity = fromEntityToScalarEntity({
+    metadataName: 'navigationMenuItem',
+    entity: navigationMenuItemEntity,
+  });

-  let targetObjectMetadataUniversalIdentifier: string | null = null;
-
-  if (isDefined(navigationMenuItemEntity.targetObjectMetadataId)) {
-    targetObjectMetadataUniversalIdentifier =
-      objectMetadataIdToUniversalIdentifierMap.get(
-        navigationMenuItemEntity.targetObjectMetadataId,
-      ) ?? null;
-
-    if (!isDefined(targetObjectMetadataUniversalIdentifier)) {
-      throw new FlatEntityMapsException(
-        `ObjectMetadata with id ${navigationMenuItemEntity.targetObjectMetadataId} not found for navigationMenuItem ${navigationMenuItemEntity.id}`,
-        FlatEntityMapsExceptionCode.ENTITY_NOT_FOUND,
-      );
-    }
-  }
-
-  let folderUniversalIdentifier: string | null = null;
-
-  if (isDefined(navigationMenuItemEntity.folderId)) {
-    folderUniversalIdentifier =
-      navigationMenuItemIdToUniversalIdentifierMap.get(
-        navigationMenuItemEntity.folderId,
-      ) ?? null;
-
-    if (!isDefined(folderUniversalIdentifier)) {
-      throw new FlatEntityMapsException(
-        `NavigationMenuItem (folder) with id ${navigationMenuItemEntity.folderId} not found for navigationMenuItem ${navigationMenuItemEntity.id}`,
-        FlatEntityMapsExceptionCode.ENTITY_NOT_FOUND,
-      );
-    }
-  }
-
-  let viewUniversalIdentifier: string | null = null;
-
-  if (isDefined(navigationMenuItemEntity.viewId)) {
-    viewUniversalIdentifier =
-      viewIdToUniversalIdentifierMap.get(navigationMenuItemEntity.viewId) ??
-      null;
-
-    if (!isDefined(viewUniversalIdentifier)) {
-      throw new FlatEntityMapsException(
-        `View with id ${navigationMenuItemEntity.viewId} not found for navigationMenuItem ${navigationMenuItemEntity.id}`,
-        FlatEntityMapsExceptionCode.ENTITY_NOT_FOUND,
-      );
-    }
-  }
-
-  let pageLayoutUniversalIdentifier: string | null = null;
-
-  if (isDefined(navigationMenuItemEntity.pageLayoutId)) {
-    pageLayoutUniversalIdentifier =
-      pageLayoutIdToUniversalIdentifierMap.get(
-        navigationMenuItemEntity.pageLayoutId,
-      ) ?? null;
-
-    if (!isDefined(pageLayoutUniversalIdentifier)) {
-      throw new FlatEntityMapsException(
-        `PageLayout with id ${navigationMenuItemEntity.pageLayoutId} not found for navigationMenuItem ${navigationMenuItemEntity.id}`,
-        FlatEntityMapsExceptionCode.ENTITY_NOT_FOUND,
-      );
-    }
-  }
+  const relationUniversalIdentifiers =
+    resolveManyToOneRelationIdsToUniversalIdentifiers({
+      metadataName: 'navigationMenuItem',
+      ...args,
+    });

  return {
-    id: navigationMenuItemEntity.id,
-    type: navigationMenuItemEntity.type,
-    userWorkspaceId: navigationMenuItemEntity.userWorkspaceId,
-    targetRecordId: navigationMenuItemEntity.targetRecordId,
-    targetObjectMetadataId: navigationMenuItemEntity.targetObjectMetadataId,
-    viewId: navigationMenuItemEntity.viewId,
-    folderId: navigationMenuItemEntity.folderId,
-    name: navigationMenuItemEntity.name,
-    link: navigationMenuItemEntity.link,
-    icon: navigationMenuItemEntity.icon,
-    color: navigationMenuItemEntity.color,
-    pageLayoutId: navigationMenuItemEntity.pageLayoutId,
-    position: navigationMenuItemEntity.position,
-    workspaceId: navigationMenuItemEntity.workspaceId,
-    universalIdentifier: navigationMenuItemEntity.universalIdentifier,
-    applicationId: navigationMenuItemEntity.applicationId,
-    createdAt: navigationMenuItemEntity.createdAt.toISOString(),
-    updatedAt: navigationMenuItemEntity.updatedAt.toISOString(),
-    applicationUniversalIdentifier,
-    targetObjectMetadataUniversalIdentifier,
-    folderUniversalIdentifier,
-    viewUniversalIdentifier,
-    pageLayoutUniversalIdentifier,
+    ...navigationMenuItemScalarEntity,
+    ...relationUniversalIdentifiers,
  };
 };