[BREAKING_CHANGE_VIEW_SORT] Refactor view sort to v2 (#17609)

Fixes https://github.com/twentyhq/core-team-issues/issues/2187 --------- Co-authored-by: prastoin <paul@twenty.com> Co-authored-by: Lucas Bordeau <bordeau.lucas@gmail.com>
2026-03-04 12:48:58 +00:00
parent 906a0aed38
commit c97d872b9f
135 changed files with 3262 additions and 815 deletions
@@ -1,4 +1,4 @@
-// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
+// Jest Snapshot v1, https://goo.gl/fbAQLP

 exports[`ALL_UNIVERSAL_FLAT_ENTITY_PROPERTIES_TO_COMPARE_AND_STRINGIFY should match snapshot 1`] = `
 {
@@ -299,6 +299,15 @@ exports[`ALL_UNIVERSAL_FLAT_ENTITY_PROPERTIES_TO_COMPARE_AND_STRINGIFY should ma
    ],
    "propertiesToStringify": [],
  },
+  "viewSort": {
+    "propertiesToCompare": [
+      "direction",
+      "fieldMetadataUniversalIdentifier",
+      "viewUniversalIdentifier",
+      "deletedAt",
+    ],
+    "propertiesToStringify": [],
+  },
  "webhook": {
    "propertiesToCompare": [
      "targetUrl",
@@ -1162,6 +1162,38 @@ export const ALL_ENTITY_PROPERTIES_CONFIGURATION_BY_METADATA_NAME = {
      universalProperty: undefined,
    },
  },
+  viewSort: {
+    direction: {
+      toCompare: true,
+      toStringify: false,
+      universalProperty: undefined,
+    },
+    fieldMetadataId: {
+      toCompare: true,
+      toStringify: false,
+      universalProperty: 'fieldMetadataUniversalIdentifier',
+    },
+    createdAt: {
+      toCompare: false,
+      toStringify: false,
+      universalProperty: undefined,
+    },
+    updatedAt: {
+      toCompare: false,
+      toStringify: false,
+      universalProperty: undefined,
+    },
+    viewId: {
+      toCompare: true,
+      toStringify: false,
+      universalProperty: 'viewUniversalIdentifier',
+    },
+    deletedAt: {
+      toCompare: true,
+      toStringify: false,
+      universalProperty: undefined,
+    },
+  },
  viewFilterGroup: {
    viewId: {
      toCompare: true,
@@ -240,6 +240,16 @@ export const ALL_MANY_TO_ONE_METADATA_FOREIGN_KEY = {
    workspace: null,
    application: null,
  },
+  viewSort: {
+    application: null,
+    workspace: null,
+    fieldMetadata: {
+      foreignKey: 'fieldMetadataId',
+    },
+    view: {
+      foreignKey: 'viewId',
+    },
+  },
 } as const satisfies ManyToOneMetadataRelationsProperties;

 // satisfies with complex mapped types involving nested generics doesn't always catch missing required keys
@@ -420,6 +420,24 @@ export const ALL_MANY_TO_ONE_METADATA_RELATIONS = {
    workspace: null,
    application: null,
  },
+  viewSort: {
+    application: null,
+    workspace: null,
+    fieldMetadata: {
+      foreignKey: 'fieldMetadataId',
+      universalForeignKey: 'fieldMetadataUniversalIdentifier',
+      inverseOneToManyProperty: null,
+      isNullable: false,
+      metadataName: 'fieldMetadata',
+    },
+    view: {
+      foreignKey: 'viewId',
+      universalForeignKey: 'viewUniversalIdentifier',
+      inverseOneToManyProperty: 'viewSorts',
+      isNullable: false,
+      metadataName: 'view',
+    },
+  },
 } as const satisfies ManyToOneMetadataRelationsProperties;

 // satisfies with complex mapped types involving nested generics doesn't always catch missing required keys
@@ -24,6 +24,7 @@ import { ViewFilterGroupEntity } from 'src/engine/metadata-modules/view-filter-g
 import { ViewFilterEntity } from 'src/engine/metadata-modules/view-filter/entities/view-filter.entity';
 import { ViewGroupEntity } from 'src/engine/metadata-modules/view-group/entities/view-group.entity';
 import { ViewEntity } from 'src/engine/metadata-modules/view/entities/view.entity';
+import { ViewSortEntity } from 'src/engine/metadata-modules/view-sort/entities/view-sort.entity';

 export const ALL_METADATA_ENTITY_BY_METADATA_NAME = {
  viewField: ViewFieldEntity,
@@ -49,4 +50,5 @@ export const ALL_METADATA_ENTITY_BY_METADATA_NAME = {
  commandMenuItem: CommandMenuItemEntity,
  navigationMenuItem: NavigationMenuItemEntity,
  webhook: WebhookEntity,
+  viewSort: ViewSortEntity,
 } as const satisfies Record<AllMetadataName, EntityTarget<ObjectLiteral>>;
@@ -53,6 +53,10 @@ export const ALL_METADATA_REQUIRED_METADATA_FOR_VALIDATION = {
  viewFilterGroup: {
    view: true,
  },
+  viewSort: {
+    fieldMetadata: true,
+    view: true,
+  },
  role: {},
  roleTarget: {
    role: true,
@@ -44,6 +44,7 @@ export const ALL_METADATA_SERIALIZED_RELATION = {
  rowLevelPermissionPredicate: {},
  rowLevelPermissionPredicateGroup: {},
  viewFilterGroup: {},
+  viewSort: {},
  frontComponent: {},
  webhook: {},
 } as const satisfies MetadataSerializedRelationProperties;
@@ -37,6 +37,11 @@ export const ALL_ONE_TO_MANY_METADATA_RELATIONS = {
  commandMenuItem: {},
  navigationMenuItem: {},
  fieldMetadata: {
+    viewSorts: {
+      flatEntityForeignKeyAggregator: 'viewSortIds',
+      metadataName: 'viewSort',
+      universalFlatEntityForeignKeyAggregator: 'viewSortUniversalIdentifiers',
+    },
    fieldPermissions: null,
    indexFieldMetadatas: null,
    viewFields: {
@@ -202,6 +207,7 @@ export const ALL_ONE_TO_MANY_METADATA_RELATIONS = {
  },
  frontComponent: {},
  webhook: {},
+  viewSort: {},
 } as const satisfies OneToManyMetadataRelationsProperties;

 // satisfies with complex mapped types involving nested generics doesn't always catch missing required keys
@@ -35,6 +35,8 @@ import { ViewFilterEntity } from 'src/engine/metadata-modules/view-filter/entiti
 import { ViewGroupEntity } from 'src/engine/metadata-modules/view-group/entities/view-group.entity';
 import { ViewEntity } from 'src/engine/metadata-modules/view/entities/view.entity';
 import { WorkspaceCacheModule } from 'src/engine/workspace-cache/workspace-cache.module';
+import { ViewSortEntity } from 'src/engine/metadata-modules/view-sort/entities/view-sort.entity';
+import { WorkspaceFlatViewSortMapCacheService } from 'src/engine/metadata-modules/flat-view-sort/services/workspace-flat-view-sort-map-cache.service';

@Module({
  imports: [
@@ -46,6 +48,7 @@ import { WorkspaceCacheModule } from 'src/engine/workspace-cache/workspace-cache
      ViewFilterEntity,
      ViewFilterGroupEntity,
      ViewGroupEntity,
+      ViewSortEntity,
      IndexMetadataEntity,
      IndexFieldMetadataEntity,
      FieldMetadataEntity,
@@ -71,6 +74,7 @@ import { WorkspaceCacheModule } from 'src/engine/workspace-cache/workspace-cache
    WorkspaceFlatIndexMapCacheService,
    WorkspaceFlatFieldMetadataMapCacheService,
    WorkspaceFlatViewGroupMapCacheService,
+    WorkspaceFlatViewSortMapCacheService,
    WorkspaceFlatPageLayoutMapCacheService,
    WorkspaceFlatPageLayoutTabMapCacheService,
    WorkspaceFlatPageLayoutWidgetMapCacheService,
@@ -88,6 +92,7 @@ import { WorkspaceCacheModule } from 'src/engine/workspace-cache/workspace-cache
    WorkspaceFlatIndexMapCacheService,
    WorkspaceFlatFieldMetadataMapCacheService,
    WorkspaceFlatViewGroupMapCacheService,
+    WorkspaceFlatViewSortMapCacheService,
    WorkspaceFlatPageLayoutMapCacheService,
    WorkspaceFlatPageLayoutTabMapCacheService,
    WorkspaceFlatPageLayoutWidgetMapCacheService,
@@ -17,7 +17,7 @@ type FieldMetadataOneToManySyncableRelations =
 type Assertions = [
  // FieldMetadataEntity OneToMany relations (all targets):
  // - indexFieldMetadatas, fieldPermissions, viewFields, viewFilters,
-  // - kanbanAggregateOperationViews, calendarViews, mainGroupByFieldMetadataViews
+  // - kanbanAggregateOperationViews, calendarViews, mainGroupByFieldMetadataViews, viewSorts
  Expect<
    Equal<
      FieldMetadataOneToManyRelations,
@@ -28,6 +28,7 @@ type Assertions = [
      | 'kanbanAggregateOperationViews'
      | 'calendarViews'
      | 'mainGroupByFieldMetadataViews'
+      | 'viewSorts'
    >
  >,

@@ -40,6 +41,7 @@ type Assertions = [
      | 'kanbanAggregateOperationViews'
      | 'calendarViews'
      | 'mainGroupByFieldMetadataViews'
+      | 'viewSorts'
    >
  >,
 ];
@@ -10,7 +10,7 @@ type FieldMetadataRelatedProperties =
 type Assertions = [
  // FieldMetadataEntity has both ManyToOne and OneToMany relations
  // ManyToOne: object, workspace, application, relationTargetFieldMetadata, relationTargetObjectMetadata
-  // OneToMany: indexFieldMetadatas, fieldPermissions, viewFields, viewFilters, kanbanAggregateOperationViews, calendarViews, mainGroupByFieldMetadataViews
+  // OneToMany: indexFieldMetadatas, fieldPermissions, viewFields, viewFilters, kanbanAggregateOperationViews, calendarViews, mainGroupByFieldMetadataViews, viewSorts
  Expect<
    Equal<
      FieldMetadataRelatedProperties,
@@ -26,6 +26,7 @@ type Assertions = [
      | 'kanbanAggregateOperationViews'
      | 'calendarViews'
      | 'mainGroupByFieldMetadataViews'
+      | 'viewSorts'
    >
  >,
 ];
@@ -33,6 +33,8 @@ import { type FlatViewFilterMaps } from 'src/engine/metadata-modules/flat-view-f
 import { type FlatViewFilter } from 'src/engine/metadata-modules/flat-view-filter/types/flat-view-filter.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';
+import { type FlatViewSortMaps } from 'src/engine/metadata-modules/flat-view-sort/types/flat-view-sort-maps.type';
+import { type FlatViewSort } from 'src/engine/metadata-modules/flat-view-sort/types/flat-view-sort.type';
 import { type FlatViewMaps } from 'src/engine/metadata-modules/flat-view/types/flat-view-maps.type';
 import { type FlatView } from 'src/engine/metadata-modules/flat-view/types/flat-view.type';
 import { type FlatWebhookMaps } from 'src/engine/metadata-modules/flat-webhook/types/flat-webhook-maps.type';
@@ -65,6 +67,7 @@ import { type UniversalFlatViewFilterGroup } from 'src/engine/workspace-manager/
 import { type UniversalFlatViewFilter } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-view-filter.type';
 import { type UniversalFlatViewGroup } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-view-group.type';
 import { type UniversalFlatView } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-view.type';
+import { type UniversalFlatViewSort } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-view-sort.type';
 import { type UniversalFlatWebhook } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-webhook.type';
 import {
  type FlatCreateAgentAction,
@@ -250,6 +253,14 @@ import {
  type UniversalDeleteWebhookAction,
  type UniversalUpdateWebhookAction,
 } from 'src/engine/workspace-manager/workspace-migration/workspace-migration-builder/builders/webhook/types/workspace-migration-webhook-action.type';
+import {
+  type FlatCreateViewSortAction,
+  type FlatDeleteViewSortAction,
+  type FlatUpdateViewSortAction,
+  type UniversalCreateViewSortAction,
+  type UniversalDeleteViewSortAction,
+  type UniversalUpdateViewSortAction,
+} from 'src/engine/workspace-manager/workspace-migration/workspace-migration-builder/builders/view-sort/types/workspace-migration-view-sort-action.type';

 export type AllFlatEntityTypesByMetadataName = {
  fieldMetadata: {
@@ -351,6 +362,22 @@ export type AllFlatEntityTypesByMetadataName = {
    universalFlatEntity: UniversalFlatViewGroup;
    entity: MetadataEntity<'viewGroup'>;
  };
+  viewSort: {
+    flatEntityMaps: FlatViewSortMaps;
+    universalActions: {
+      create: UniversalCreateViewSortAction;
+      update: UniversalUpdateViewSortAction;
+      delete: UniversalDeleteViewSortAction;
+    };
+    flatActions: {
+      create: FlatCreateViewSortAction;
+      update: FlatUpdateViewSortAction;
+      delete: FlatDeleteViewSortAction;
+    };
+    flatEntity: FlatViewSort;
+    universalFlatEntity: UniversalFlatViewSort;
+    entity: MetadataEntity<'viewSort'>;
+  };
  rowLevelPermissionPredicate: {
    flatEntityMaps: FlatRowLevelPermissionPredicateMaps;
    universalActions: {
@@ -1,4 +1,4 @@
-// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
+// Jest Snapshot v1, https://goo.gl/fbAQLP

 exports[`getMetadataRelatedMetadataNames should return related metadata names for agent 1`] = `[]`;

@@ -13,6 +13,7 @@ exports[`getMetadataRelatedMetadataNames should return related metadata names fo
 [
  "objectMetadata",
  "fieldMetadata",
+  "viewSort",
  "viewField",
  "viewFilter",
  "view",
@@ -149,4 +150,11 @@ exports[`getMetadataRelatedMetadataNames should return related metadata names fo
 ]
 `;

+exports[`getMetadataRelatedMetadataNames should return related metadata names for viewSort 1`] = `
+[
+  "fieldMetadata",
+  "view",
+]
+`;
+
 exports[`getMetadataRelatedMetadataNames should return related metadata names for webhook 1`] = `[]`;
@@ -8,6 +8,7 @@ exports[`sortMetadataNamesChildrenFirst should return metadata names sorted with
  "viewFilter",
  "commandMenuItem",
  "pageLayoutWidget",
+  "viewSort",
  "index",
  "pageLayout",
  "roleTarget",