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.

<!-- This is an auto-generated description by cubic. -->
<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>
<!-- End of auto-generated description by cubic. -->
This commit is contained in:
Paul Rastoin
2026-06-24 12:20:09 +02:00
committed by GitHub
parent 41d1b478b0
commit d2387430a1
34 changed files with 1106 additions and 1614 deletions
@@ -1,14 +1,10 @@
import { isDefined } from 'twenty-shared/utils';
import {
FlatEntityMapsException,
FlatEntityMapsExceptionCode,
} from 'src/engine/metadata-modules/flat-entity/exceptions/flat-entity-maps.exception';
import { type MetadataEntity } from 'src/engine/metadata-modules/flat-entity/types/metadata-entity.type';
import { fromEntityToScalarEntity } from 'src/engine/metadata-modules/flat-entity/utils/from-entity-to-scalar-entity.util';
import { type FlatRole } from 'src/engine/metadata-modules/flat-role/types/flat-role.type';
import { type EntityManyToOneIdByUniversalIdentifierMaps } from 'src/engine/workspace-cache/types/entity-many-to-one-id-by-universal-identifier-maps.type';
import { type EntityWithRegroupedOneToManyRelations } from 'src/engine/workspace-cache/types/entity-with-regrouped-one-to-many-relations.type';
import { type RegroupedEntity } from 'src/engine/workspace-cache/utils/regroup-entities-by-related-entity-id';
import { resolveManyToOneRelationIdsToUniversalIdentifiers } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/utils/resolve-many-to-one-relation-ids-to-universal-identifiers.util';
type FromRoleEntityToFlatRoleArgs = {
entity: Omit<
@@ -21,40 +17,25 @@ type FromRoleEntityToFlatRoleArgs = {
};
} & EntityManyToOneIdByUniversalIdentifierMaps<'role'>;
export const fromRoleEntityToFlatRole = ({
entity: roleEntity,
applicationIdToUniversalIdentifierMap,
}: FromRoleEntityToFlatRoleArgs): FlatRole => {
const applicationUniversalIdentifier =
applicationIdToUniversalIdentifierMap.get(roleEntity.applicationId);
export const fromRoleEntityToFlatRole = (
args: FromRoleEntityToFlatRoleArgs,
): FlatRole => {
const { entity: roleEntity } = args;
if (!isDefined(applicationUniversalIdentifier)) {
throw new FlatEntityMapsException(
`Application with id ${roleEntity.applicationId} not found for role ${roleEntity.id}`,
FlatEntityMapsExceptionCode.ENTITY_NOT_FOUND,
);
}
const roleScalarEntity = fromEntityToScalarEntity({
metadataName: 'role',
entity: roleEntity,
});
const relationUniversalIdentifiers =
resolveManyToOneRelationIdsToUniversalIdentifiers({
metadataName: 'role',
...args,
});
return {
id: roleEntity.id,
label: roleEntity.label,
description: roleEntity.description,
icon: roleEntity.icon,
isEditable: roleEntity.isEditable,
canUpdateAllSettings: roleEntity.canUpdateAllSettings,
canAccessAllTools: roleEntity.canAccessAllTools,
canReadAllObjectRecords: roleEntity.canReadAllObjectRecords,
canUpdateAllObjectRecords: roleEntity.canUpdateAllObjectRecords,
canSoftDeleteAllObjectRecords: roleEntity.canSoftDeleteAllObjectRecords,
canDestroyAllObjectRecords: roleEntity.canDestroyAllObjectRecords,
canBeAssignedToUsers: roleEntity.canBeAssignedToUsers,
canBeAssignedToAgents: roleEntity.canBeAssignedToAgents,
canBeAssignedToApiKeys: roleEntity.canBeAssignedToApiKeys,
workspaceId: roleEntity.workspaceId,
createdAt: roleEntity.createdAt.toISOString(),
updatedAt: roleEntity.updatedAt.toISOString(),
universalIdentifier: roleEntity.universalIdentifier,
applicationId: roleEntity.applicationId,
...roleScalarEntity,
...relationUniversalIdentifiers,
roleTargetIds: roleEntity.roleTargets.map(({ id }) => id),
objectPermissionIds: roleEntity.objectPermissions.map(({ id }) => id),
rolePermissionFlagIds: roleEntity.rolePermissionFlags.map(({ id }) => id),
@@ -64,7 +45,6 @@ export const fromRoleEntityToFlatRole = ({
),
rowLevelPermissionPredicateGroupIds:
roleEntity.rowLevelPermissionPredicateGroups.map(({ id }) => id),
applicationUniversalIdentifier,
roleTargetUniversalIdentifiers: roleEntity.roleTargets.map(
({ universalIdentifier }) => universalIdentifier,
),