Refactor flat entity maps to be universal oriented (#17665)

# Introduction
In preparation of the workspace agnostic builder, we're migrating
`FlatEntityMaps` to be universal identifier oriented and based
As in the builder context there're won't be any ids at all
Please also note that the FlatEntity is a UniversalFlatEntity superset

From
```ts
import { type SyncableFlatEntity } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-from.type';

export type FlatEntityMaps<T extends SyncableFlatEntity> = {
  byId: Partial<Record<string, T>>;
  idByUniversalIdentifier: Partial<Record<string, string>>;
  universalIdentifiersByApplicationId: Partial<Record<string, string[]>>;
};
```

To
```ts
export type FlatEntityMaps<
  T extends SyncableFlatEntity | UniversalSyncableFlatEntity,
> = {
  byUniversalIdentifier: Partial<Record<string, T>>;
  universalIdentifierById: Partial<Record<string, string>>;
  universalIdentifiersByApplicationId: Partial<Record<string, string[]>>; // this might make more sense to be migrated to universalIdentifiersByApplicationUniversalIdentifier but it's the main topic of this PR
};
```

## Low level maps tools
Had to refactor find | create | delete | replace | find-many | get-sub
tools ( through mutations and or throw equivalent )
This commit is contained in:
Paul Rastoin
2026-02-03 17:16:02 +01:00
committed by GitHub
parent 43042d55b2
commit 476bdf764c
202 changed files with 1853 additions and 909 deletions
@@ -23,6 +23,7 @@ import { CustomPermissionGuard } from 'src/engine/guards/custom-permission.guard
import { NoPermissionGuard } from 'src/engine/guards/no-permission.guard';
import { WorkspaceAuthGuard } from 'src/engine/guards/workspace-auth.guard';
import { WorkspaceManyOrAllFlatEntityMapsCacheService } from 'src/engine/metadata-modules/flat-entity/services/workspace-many-or-all-flat-entity-maps-cache.service';
import { findFlatEntityByIdInFlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/utils/find-flat-entity-by-id-in-flat-entity-maps.util';
import { resolveObjectMetadataStandardOverride } from 'src/engine/metadata-modules/object-metadata/utils/resolve-object-metadata-standard-override.util';
import { CreateViewPermissionGuard } from 'src/engine/metadata-modules/view-permissions/guards/create-view-permission.guard';
import { DeleteViewPermissionGuard } from 'src/engine/metadata-modules/view-permissions/guards/delete-view-permission.guard';
@@ -189,8 +190,10 @@ export class ViewController {
let processedName = view.name;
if (view.name.includes('{objectLabelPlural}')) {
const objectMetadata =
flatObjectMetadataMaps.byId[view.objectMetadataId];
const objectMetadata = findFlatEntityByIdInFlatEntityMaps({
flatEntityId: view.objectMetadataId,
flatEntityMaps: flatObjectMetadataMaps,
});
if (objectMetadata) {
const i18n = this.i18nService.getI18nInstance(locale ?? 'en');
@@ -21,30 +21,37 @@ describe('ViewQueryParamsService', () => {
const mockFieldMetadataId = 'field-metadata-id';
const mockFlatObjectMetadataMaps = {
byId: {
[mockObjectMetadataId]: {
byUniversalIdentifier: {
'object-universal-id': {
id: mockObjectMetadataId,
nameSingular: 'company',
namePlural: 'companies',
labelSingular: 'Company',
labelPlural: 'Companies',
universalIdentifier: 'object-universal-id',
},
},
byNameSingular: {},
byNamePlural: {},
universalIdentifierById: {
[mockObjectMetadataId]: 'object-universal-id',
},
universalIdentifiersByApplicationId: {},
};
const mockFlatFieldMetadataMaps = {
byId: {
[mockFieldMetadataId]: {
byUniversalIdentifier: {
'field-universal-id': {
id: mockFieldMetadataId,
name: 'name',
type: FieldMetadataType.TEXT,
label: 'Name',
options: null,
universalIdentifier: 'field-universal-id',
},
},
byNameAndObjectId: {},
universalIdentifierById: {
[mockFieldMetadataId]: 'field-universal-id',
},
universalIdentifiersByApplicationId: {},
};
beforeEach(async () => {
@@ -16,6 +16,7 @@ import { type ObjectRecordOrderBy } from 'src/engine/api/graphql/workspace-query
import { WorkspaceManyOrAllFlatEntityMapsCacheService } from 'src/engine/metadata-modules/flat-entity/services/workspace-many-or-all-flat-entity-maps-cache.service';
import { findFlatEntityByIdInFlatEntityMapsOrThrow } from 'src/engine/metadata-modules/flat-entity/utils/find-flat-entity-by-id-in-flat-entity-maps-or-throw.util';
import { findFlatEntityByIdInFlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/utils/find-flat-entity-by-id-in-flat-entity-maps.util';
import { ViewFilterGroupLogicalOperator } from 'src/engine/metadata-modules/view-filter-group/enums/view-filter-group-logical-operator';
import { ViewSortDirection } from 'src/engine/metadata-modules/view-sort/enums/view-sort-direction';
import { ViewType } from 'src/engine/metadata-modules/view/enums/view-type.enum';
@@ -62,7 +63,10 @@ export class ViewQueryParamsService {
const recordFilters: RecordFilter[] = (view.viewFilters ?? [])
.map((viewFilter) => {
const field = flatFieldMetadataMaps.byId[viewFilter.fieldMetadataId];
const field = findFlatEntityByIdInFlatEntityMaps({
flatEntityId: viewFilter.fieldMetadataId,
flatEntityMaps: flatFieldMetadataMaps,
});
if (!field) return null;
@@ -91,7 +95,10 @@ export class ViewQueryParamsService {
const fields = recordFilters
.map((filter) => {
const field = flatFieldMetadataMaps.byId[filter.fieldMetadataId];
const field = findFlatEntityByIdInFlatEntityMaps({
flatEntityId: filter.fieldMetadataId,
flatEntityMaps: flatFieldMetadataMaps,
});
if (!field) return null;
@@ -120,7 +127,10 @@ export class ViewQueryParamsService {
const orderBy: ObjectRecordOrderBy = (view.viewSorts ?? [])
.map((sort) => {
const field = flatFieldMetadataMaps.byId[sort.fieldMetadataId];
const field = findFlatEntityByIdInFlatEntityMaps({
flatEntityId: sort.fieldMetadataId,
flatEntityMaps: flatFieldMetadataMaps,
});
if (!field) return null;
@@ -33,16 +33,19 @@ describe('ViewToolsFactory', () => {
};
const mockFlatObjectMetadataMaps = {
byId: {
[mockObjectMetadataId]: {
byUniversalIdentifier: {
'object-universal-id': {
id: mockObjectMetadataId,
nameSingular: mockObjectNameSingular,
namePlural: 'companies',
labelSingular: 'Company',
labelPlural: 'Companies',
universalIdentifier: 'object-universal-id',
},
},
idByUniversalIdentifier: {},
universalIdentifierById: {
[mockObjectMetadataId]: 'object-universal-id',
},
universalIdentifiersByApplicationId: {},
};
@@ -88,9 +88,9 @@ export class ViewToolsFactory {
},
);
const objectMetadata = Object.values(flatObjectMetadataMaps.byId).find(
(obj) => obj?.nameSingular === objectNameSingular,
);
const objectMetadata = Object.values(
flatObjectMetadataMaps.byUniversalIdentifier,
).find((obj) => obj?.nameSingular === objectNameSingular);
if (!objectMetadata) {
throw new Error(