Spread in parent and requires FlatEntity.__universal (#17753)

# Introduction
Requiring the spreaded `__universal` record that aggregates all the
universal identifier ( relations fk and aggregators ) of an entity to
its root

It's blockin for https://github.com/twentyhq/twenty/pull/17687 to be
finalized because if we don't we would have to migrated all related
entities at once in order for them to always have the universal
properties

## `resolveEntityRelationUniversalIdentifiers`
Introduced `resolveEntityRelationUniversalIdentifiers` a centralized
utility that resolves foreign key IDs to universal identifiers using
ALL_METADATA_RELATIONS metadata. It provides strict typing for both
input (foreign keys) and output (universal identifiers), with
nullability dynamically inferred from entity relation types.
Strictly and dynamically typed for both output and input

To do so added a new type and const/runtime grain to
ALL_METADATA_RELATIONS `isNullable`to many-to-one entries, derived from
the entity relation property types. And fixed incorrectly typed typeorm
entities

### Usage
```ts
  const {
    availabilityObjectMetadataUniversalIdentifier,
    frontComponentUniversalIdentifier,
  } = resolveEntityRelationUniversalIdentifiers({
    metadataName: 'commandMenuItem',
    foreignKeyValues: {
      availabilityObjectMetadataId:
        createCommandMenuItemInput.availabilityObjectMetadataId,
      frontComponentId: createCommandMenuItemInput.frontComponentId,
    },
    flatEntityMaps: { flatObjectMetadataMaps, flatFrontComponentMaps },
  });
```
This commit is contained in:
Paul Rastoin
2026-02-06 18:02:02 +01:00
committed by GitHub
parent a494a7a902
commit 3dc5b162c7
133 changed files with 2141 additions and 1166 deletions
@@ -4,7 +4,9 @@ import {
} from 'twenty-shared/utils';
import { v4 } from 'uuid';
import { type FlatApplication } from 'src/engine/core-modules/application/types/flat-application.type';
import { type AllFlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/types/all-flat-entity-maps.type';
import { resolveEntityRelationUniversalIdentifiers } from 'src/engine/metadata-modules/flat-entity/utils/resolve-entity-relation-universal-identifiers.util';
import { type FlatViewGroup } from 'src/engine/metadata-modules/flat-view-group/types/flat-view-group.type';
import { computeFlatViewGroupsOnViewCreate } from 'src/engine/metadata-modules/flat-view-group/utils/compute-flat-view-groups-on-view-create.util';
import { type FlatView } from 'src/engine/metadata-modules/flat-view/types/flat-view.type';
@@ -17,14 +19,16 @@ export const fromCreateViewInputToFlatViewToCreate = ({
createViewInput: rawCreateViewInput,
workspaceId,
createdByUserWorkspaceId,
workspaceCustomApplicationId,
flatApplication,
flatFieldMetadataMaps,
flatObjectMetadataMaps,
}: {
createViewInput: CreateViewInput;
workspaceId: string;
createdByUserWorkspaceId?: string;
workspaceCustomApplicationId: string;
flatApplication: FlatApplication;
flatFieldMetadataMaps: AllFlatEntityMaps['flatFieldMetadataMaps'];
flatObjectMetadataMaps: AllFlatEntityMaps['flatObjectMetadataMaps'];
}): {
flatViewToCreate: FlatView;
flatViewGroupsToCreate: FlatViewGroup[];
@@ -38,9 +42,27 @@ export const fromCreateViewInputToFlatViewToCreate = ({
const createdAt = new Date().toISOString();
const viewId = createViewInput.id ?? v4();
const {
objectMetadataUniversalIdentifier,
calendarFieldMetadataUniversalIdentifier,
kanbanAggregateOperationFieldMetadataUniversalIdentifier,
mainGroupByFieldMetadataUniversalIdentifier,
} = resolveEntityRelationUniversalIdentifiers({
metadataName: 'view',
foreignKeyValues: {
objectMetadataId,
calendarFieldMetadataId: createViewInput.calendarFieldMetadataId,
kanbanAggregateOperationFieldMetadataId:
createViewInput.kanbanAggregateOperationFieldMetadataId,
mainGroupByFieldMetadataId: createViewInput.mainGroupByFieldMetadataId,
},
flatEntityMaps: { flatObjectMetadataMaps, flatFieldMetadataMaps },
});
const flatViewToCreate = {
id: viewId,
objectMetadataId,
objectMetadataUniversalIdentifier,
workspaceId,
name: createViewInput.name,
createdAt: createdAt,
@@ -49,6 +71,7 @@ export const fromCreateViewInputToFlatViewToCreate = ({
isCustom: true,
anyFieldFilterValue: createViewInput.anyFieldFilterValue ?? null,
calendarFieldMetadataId: createViewInput.calendarFieldMetadataId ?? null,
calendarFieldMetadataUniversalIdentifier,
calendarLayout: createViewInput.calendarLayout ?? null,
icon: createViewInput.icon,
isCompact: createViewInput.isCompact ?? false,
@@ -56,8 +79,10 @@ export const fromCreateViewInputToFlatViewToCreate = ({
kanbanAggregateOperation: createViewInput.kanbanAggregateOperation ?? null,
kanbanAggregateOperationFieldMetadataId:
createViewInput.kanbanAggregateOperationFieldMetadataId ?? null,
kanbanAggregateOperationFieldMetadataUniversalIdentifier,
mainGroupByFieldMetadataId:
createViewInput.mainGroupByFieldMetadataId ?? null,
mainGroupByFieldMetadataUniversalIdentifier,
key: createViewInput.key ?? null,
openRecordIn: createViewInput.openRecordIn ?? ViewOpenRecordIn.SIDE_PANEL,
position: createViewInput.position ?? 0,
@@ -66,10 +91,15 @@ export const fromCreateViewInputToFlatViewToCreate = ({
visibility: createViewInput.visibility ?? ViewVisibility.WORKSPACE,
createdByUserWorkspaceId: createdByUserWorkspaceId ?? null,
viewFieldIds: [],
viewFieldUniversalIdentifiers: [],
viewFilterIds: [],
viewFilterUniversalIdentifiers: [],
viewGroupIds: [],
viewGroupUniversalIdentifiers: [],
viewFilterGroupIds: [],
applicationId: workspaceCustomApplicationId,
viewFilterGroupUniversalIdentifiers: [],
applicationId: flatApplication.id,
applicationUniversalIdentifier: flatApplication.universalIdentifier,
};
let flatViewGroupsToCreate: FlatViewGroup[] = [];
@@ -77,6 +107,7 @@ export const fromCreateViewInputToFlatViewToCreate = ({
if (isDefined(flatViewToCreate.mainGroupByFieldMetadataId)) {
flatViewGroupsToCreate = computeFlatViewGroupsOnViewCreate({
flatViewToCreateId: flatViewToCreate.id,
flatViewToCreateUniversalIdentifier: flatViewToCreate.universalIdentifier,
mainGroupByFieldMetadataId: flatViewToCreate.mainGroupByFieldMetadataId,
flatFieldMetadataMaps,
});
@@ -7,6 +7,7 @@ import {
import { type FlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-maps.type';
import { findFlatEntityByIdInFlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/utils/find-flat-entity-by-id-in-flat-entity-maps.util';
import { resolveEntityRelationUniversalIdentifiers } from 'src/engine/metadata-modules/flat-entity/utils/resolve-entity-relation-universal-identifiers.util';
import { type FlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/types/flat-field-metadata.type';
import { type FlatViewGroupMaps } from 'src/engine/metadata-modules/flat-view-group/types/flat-view-group-maps.type';
import { type FlatViewGroup } from 'src/engine/metadata-modules/flat-view-group/types/flat-view-group.type';
@@ -67,6 +68,53 @@ export const fromUpdateViewInputToFlatViewToUpdateOrThrow = ({
update: updatedEditableFieldProperties,
});
if (
updatedEditableFieldProperties.kanbanAggregateOperationFieldMetadataId !==
undefined
) {
const { kanbanAggregateOperationFieldMetadataUniversalIdentifier } =
resolveEntityRelationUniversalIdentifiers({
metadataName: 'view',
foreignKeyValues: {
kanbanAggregateOperationFieldMetadataId:
flatViewToUpdate.kanbanAggregateOperationFieldMetadataId,
},
flatEntityMaps: { flatFieldMetadataMaps },
});
flatViewToUpdate.kanbanAggregateOperationFieldMetadataUniversalIdentifier =
kanbanAggregateOperationFieldMetadataUniversalIdentifier;
}
if (updatedEditableFieldProperties.calendarFieldMetadataId !== undefined) {
const { calendarFieldMetadataUniversalIdentifier } =
resolveEntityRelationUniversalIdentifiers({
metadataName: 'view',
foreignKeyValues: {
calendarFieldMetadataId: flatViewToUpdate.calendarFieldMetadataId,
},
flatEntityMaps: { flatFieldMetadataMaps },
});
flatViewToUpdate.calendarFieldMetadataUniversalIdentifier =
calendarFieldMetadataUniversalIdentifier;
}
if (updatedEditableFieldProperties.mainGroupByFieldMetadataId !== undefined) {
const { mainGroupByFieldMetadataUniversalIdentifier } =
resolveEntityRelationUniversalIdentifiers({
metadataName: 'view',
foreignKeyValues: {
mainGroupByFieldMetadataId:
flatViewToUpdate.mainGroupByFieldMetadataId,
},
flatEntityMaps: { flatFieldMetadataMaps },
});
flatViewToUpdate.mainGroupByFieldMetadataUniversalIdentifier =
mainGroupByFieldMetadataUniversalIdentifier;
}
// If changing visibility from WORKSPACE to UNLISTED, ensure createdByUserWorkspaceId is set
// This prevents the view from disappearing for the user making the change
if (
@@ -98,26 +98,23 @@ export const fromViewEntityToFlatView = ({
viewFilterIds: viewEntity.viewFilters.map(({ id }) => id),
viewGroupIds: viewEntity.viewGroups.map(({ id }) => id),
viewFilterGroupIds: viewEntity.viewFilterGroups?.map(({ id }) => id) ?? [],
__universal: {
universalIdentifier: viewEntity.universalIdentifier,
applicationUniversalIdentifier,
objectMetadataUniversalIdentifier,
kanbanAggregateOperationFieldMetadataUniversalIdentifier,
calendarFieldMetadataUniversalIdentifier,
mainGroupByFieldMetadataUniversalIdentifier,
viewFieldUniversalIdentifiers: viewEntity.viewFields.map(
applicationUniversalIdentifier,
objectMetadataUniversalIdentifier,
kanbanAggregateOperationFieldMetadataUniversalIdentifier,
calendarFieldMetadataUniversalIdentifier,
mainGroupByFieldMetadataUniversalIdentifier,
viewFieldUniversalIdentifiers: viewEntity.viewFields.map(
({ universalIdentifier }) => universalIdentifier,
),
viewFilterUniversalIdentifiers: viewEntity.viewFilters.map(
({ universalIdentifier }) => universalIdentifier,
),
viewGroupUniversalIdentifiers: viewEntity.viewGroups.map(
({ universalIdentifier }) => universalIdentifier,
),
viewFilterGroupUniversalIdentifiers:
viewEntity.viewFilterGroups?.map(
({ universalIdentifier }) => universalIdentifier,
),
viewFilterUniversalIdentifiers: viewEntity.viewFilters.map(
({ universalIdentifier }) => universalIdentifier,
),
viewGroupUniversalIdentifiers: viewEntity.viewGroups.map(
({ universalIdentifier }) => universalIdentifier,
),
viewFilterGroupUniversalIdentifiers:
viewEntity.viewFilterGroups?.map(
({ universalIdentifier }) => universalIdentifier,
) ?? [],
},
) ?? [],
};
};
@@ -51,6 +51,7 @@ export const handleFlatViewUpdateSideEffect = ({
sideEffectResult.flatViewGroupsToCreate = computeFlatViewGroupsOnViewCreate({
flatViewToCreateId: toFlatView.id,
flatViewToCreateUniversalIdentifier: toFlatView.universalIdentifier,
mainGroupByFieldMetadataId: newMainGroupByFieldMetadataId,
flatFieldMetadataMaps,
});