Migrate permission flag to syncable entity (#18567)

Closes [#2225](https://github.com/twentyhq/core-team-issues/issues/2225)
2026-03-18 18:55:52 +05:30
parent 58336fb70f
commit c7e89a18f0
69 changed files with 1821 additions and 163 deletions
@@ -178,6 +178,13 @@ exports[`ALL_UNIVERSAL_FLAT_ENTITY_PROPERTIES_TO_COMPARE_AND_STRINGIFY should ma
      "overrides",
    ],
  },
+  "permissionFlag": {
+    "propertiesToCompare": [
+      "flag",
+      "roleUniversalIdentifier",
+    ],
+    "propertiesToStringify": [],
+  },
  "role": {
    "propertiesToCompare": [
      "label",
@@ -1134,6 +1134,28 @@ export const ALL_ENTITY_PROPERTIES_CONFIGURATION_BY_METADATA_NAME = {
      universalProperty: 'targetObjectMetadataUniversalIdentifier',
    },
  },
+  permissionFlag: {
+    flag: {
+      toCompare: true,
+      toStringify: false,
+      universalProperty: undefined,
+    },
+    roleId: {
+      toCompare: true,
+      toStringify: false,
+      universalProperty: 'roleUniversalIdentifier',
+    },
+    createdAt: {
+      toCompare: false,
+      toStringify: false,
+      universalProperty: undefined,
+    },
+    updatedAt: {
+      toCompare: false,
+      toStringify: false,
+      universalProperty: undefined,
+    },
+  },
  rowLevelPermissionPredicate: {
    fieldMetadataId: {
      toCompare: true,
@@ -163,6 +163,13 @@ export const ALL_MANY_TO_ONE_METADATA_FOREIGN_KEY = {
    workspace: null,
    application: null,
  },
+  permissionFlag: {
+    workspace: null,
+    application: null,
+    role: {
+      foreignKey: 'roleId',
+    },
+  },
  pageLayout: {
    workspace: null,
    objectMetadata: {
@@ -280,6 +280,17 @@ export const ALL_MANY_TO_ONE_METADATA_RELATIONS = {
    workspace: null,
    application: null,
  },
+  permissionFlag: {
+    workspace: null,
+    application: null,
+    role: {
+      metadataName: 'role',
+      foreignKey: 'roleId',
+      inverseOneToManyProperty: 'permissionFlags',
+      isNullable: false,
+      universalForeignKey: 'roleUniversalIdentifier',
+    },
+  },
  pageLayout: {
    workspace: null,
    objectMetadata: {
@@ -12,6 +12,7 @@ import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadat
 import { PageLayoutTabEntity } from 'src/engine/metadata-modules/page-layout-tab/entities/page-layout-tab.entity';
 import { PageLayoutWidgetEntity } from 'src/engine/metadata-modules/page-layout-widget/entities/page-layout-widget.entity';
 import { PageLayoutEntity } from 'src/engine/metadata-modules/page-layout/entities/page-layout.entity';
+import { PermissionFlagEntity } from 'src/engine/metadata-modules/permission-flag/permission-flag.entity';
 import { RoleTargetEntity } from 'src/engine/metadata-modules/role-target/role-target.entity';
 import { RoleEntity } from 'src/engine/metadata-modules/role/role.entity';
 import { RowLevelPermissionPredicateGroupEntity } from 'src/engine/metadata-modules/row-level-permission-predicate/entities/row-level-permission-predicate-group.entity';
@@ -49,6 +50,7 @@ export const ALL_METADATA_ENTITY_BY_METADATA_NAME = {
  agent: AgentEntity,
  commandMenuItem: CommandMenuItemEntity,
  navigationMenuItem: NavigationMenuItemEntity,
+  permissionFlag: PermissionFlagEntity,
  webhook: WebhookEntity,
  viewSort: ViewSortEntity,
 } as const satisfies Record<AllMetadataName, EntityTarget<ObjectLiteral>>;
@@ -74,6 +74,9 @@ export const ALL_METADATA_REQUIRED_METADATA_FOR_VALIDATION = {
    objectMetadata: true,
    view: true,
  },
+  permissionFlag: {
+    role: true,
+  },
  pageLayout: {
    objectMetadata: true,
    pageLayoutTab: true,
@@ -33,6 +33,7 @@ export const ALL_METADATA_SERIALIZED_RELATION = {
  logicFunction: {},
  role: {},
  roleTarget: {},
+  permissionFlag: {},
  pageLayout: {},
  pageLayoutTab: {},
  pageLayoutWidget: {
@@ -145,7 +145,12 @@ export const ALL_ONE_TO_MANY_METADATA_RELATIONS = {
      universalFlatEntityForeignKeyAggregator: 'roleTargetUniversalIdentifiers',
    },
    objectPermissions: null,
-    permissionFlags: null,
+    permissionFlags: {
+      metadataName: 'permissionFlag',
+      flatEntityForeignKeyAggregator: 'permissionFlagIds',
+      universalFlatEntityForeignKeyAggregator:
+        'permissionFlagUniversalIdentifiers',
+    },
    fieldPermissions: null,
    rowLevelPermissionPredicates: {
      metadataName: 'rowLevelPermissionPredicate',
@@ -161,6 +166,7 @@ export const ALL_ONE_TO_MANY_METADATA_RELATIONS = {
    },
  },
  roleTarget: {},
+  permissionFlag: {},
  pageLayout: {
    tabs: {
      metadataName: 'pageLayoutTab',
@@ -25,6 +25,7 @@ import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadat
 import { PageLayoutTabEntity } from 'src/engine/metadata-modules/page-layout-tab/entities/page-layout-tab.entity';
 import { PageLayoutWidgetEntity } from 'src/engine/metadata-modules/page-layout-widget/entities/page-layout-widget.entity';
 import { PageLayoutEntity } from 'src/engine/metadata-modules/page-layout/entities/page-layout.entity';
+import { PermissionFlagEntity } from 'src/engine/metadata-modules/permission-flag/permission-flag.entity';
 import { RoleEntity } from 'src/engine/metadata-modules/role/role.entity';
 import { RowLevelPermissionPredicateGroupEntity } from 'src/engine/metadata-modules/row-level-permission-predicate/entities/row-level-permission-predicate-group.entity';
 import { RowLevelPermissionPredicateEntity } from 'src/engine/metadata-modules/row-level-permission-predicate/entities/row-level-permission-predicate.entity';
@@ -36,6 +37,7 @@ import { ViewGroupEntity } from 'src/engine/metadata-modules/view-group/entities
 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 { WorkspaceFlatPermissionFlagMapCacheService } from 'src/engine/metadata-modules/flat-permission-flag/services/workspace-flat-permission-flag-map-cache.service';
 import { WorkspaceFlatViewSortMapCacheService } from 'src/engine/metadata-modules/flat-view-sort/services/workspace-flat-view-sort-map-cache.service';

@Module({
@@ -56,6 +58,7 @@ import { WorkspaceFlatViewSortMapCacheService } from 'src/engine/metadata-module
      PageLayoutEntity,
      PageLayoutTabEntity,
      PageLayoutWidgetEntity,
+      PermissionFlagEntity,
      RowLevelPermissionPredicateEntity,
      RowLevelPermissionPredicateGroupEntity,
      ApplicationEntity,
@@ -74,6 +77,7 @@ import { WorkspaceFlatViewSortMapCacheService } from 'src/engine/metadata-module
    WorkspaceFlatIndexMapCacheService,
    WorkspaceFlatFieldMetadataMapCacheService,
    WorkspaceFlatViewGroupMapCacheService,
+    WorkspaceFlatPermissionFlagMapCacheService,
    WorkspaceFlatViewSortMapCacheService,
    WorkspaceFlatPageLayoutMapCacheService,
    WorkspaceFlatPageLayoutTabMapCacheService,
@@ -92,6 +96,7 @@ import { WorkspaceFlatViewSortMapCacheService } from 'src/engine/metadata-module
    WorkspaceFlatIndexMapCacheService,
    WorkspaceFlatFieldMetadataMapCacheService,
    WorkspaceFlatViewGroupMapCacheService,
+    WorkspaceFlatPermissionFlagMapCacheService,
    WorkspaceFlatViewSortMapCacheService,
    WorkspaceFlatPageLayoutMapCacheService,
    WorkspaceFlatPageLayoutTabMapCacheService,
@@ -15,6 +15,8 @@ import { type FlatObjectMetadata } from 'src/engine/metadata-modules/flat-object
 import { type FlatPageLayoutTabMaps } from 'src/engine/metadata-modules/flat-page-layout-tab/types/flat-page-layout-tab-maps.type';
 import { type FlatPageLayoutTab } from 'src/engine/metadata-modules/flat-page-layout-tab/types/flat-page-layout-tab.type';
 import { type FlatPageLayoutWidgetMaps } from 'src/engine/metadata-modules/flat-page-layout-widget/types/flat-page-layout-widget-maps.type';
+import { type FlatPermissionFlagMaps } from 'src/engine/metadata-modules/flat-permission-flag/types/flat-permission-flag-maps.type';
+import { type FlatPermissionFlag } from 'src/engine/metadata-modules/flat-permission-flag/types/flat-permission-flag.type';
 import { type FlatPageLayoutWidget } from 'src/engine/metadata-modules/flat-page-layout-widget/types/flat-page-layout-widget.type';
 import { type FlatPageLayoutMaps } from 'src/engine/metadata-modules/flat-page-layout/types/flat-page-layout-maps.type';
 import { type FlatPageLayout } from 'src/engine/metadata-modules/flat-page-layout/types/flat-page-layout.type';
@@ -54,6 +56,7 @@ import { type UniversalFlatLogicFunction } from 'src/engine/workspace-manager/wo
 import { type UniversalFlatNavigationMenuItem } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-navigation-menu-item.type';
 import { type UniversalFlatObjectMetadata } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-object-metadata.type';
 import { type UniversalFlatPageLayout } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-page-layout.type';
+import { type UniversalFlatPermissionFlag } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-permission-flag.type';
 import { type UniversalFlatPageLayoutTab } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-page-layout-tab.type';
 import { type UniversalFlatPageLayoutWidget } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-page-layout-widget.type';
 import { type UniversalFlatRole } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-role.type';
@@ -133,6 +136,14 @@ import {
  type UniversalDeleteObjectAction,
  type UniversalUpdateObjectAction,
 } from 'src/engine/workspace-manager/workspace-migration/workspace-migration-builder/builders/object/types/workspace-migration-object-action';
+import {
+  type FlatCreatePermissionFlagAction,
+  type FlatDeletePermissionFlagAction,
+  type FlatUpdatePermissionFlagAction,
+  type UniversalCreatePermissionFlagAction,
+  type UniversalDeletePermissionFlagAction,
+  type UniversalUpdatePermissionFlagAction,
+} from 'src/engine/workspace-manager/workspace-migration/workspace-migration-builder/builders/permission-flag/types/workspace-migration-permission-flag-action.type';
 import {
  type FlatCreatePageLayoutTabAction,
  type FlatDeletePageLayoutTabAction,
@@ -570,6 +581,22 @@ export type AllFlatEntityTypesByMetadataName = {
    universalFlatEntity: UniversalFlatNavigationMenuItem;
    entity: NavigationMenuItemEntity;
  };
+  permissionFlag: {
+    flatEntityMaps: FlatPermissionFlagMaps;
+    universalActions: {
+      create: UniversalCreatePermissionFlagAction;
+      update: UniversalUpdatePermissionFlagAction;
+      delete: UniversalDeletePermissionFlagAction;
+    };
+    flatActions: {
+      create: FlatCreatePermissionFlagAction;
+      update: FlatUpdatePermissionFlagAction;
+      delete: FlatDeletePermissionFlagAction;
+    };
+    flatEntity: FlatPermissionFlag;
+    universalFlatEntity: UniversalFlatPermissionFlag;
+    entity: MetadataEntity<'permissionFlag'>;
+  };
  pageLayout: {
    flatEntityMaps: FlatPageLayoutMaps;
    universalActions: {
@@ -67,9 +67,16 @@ exports[`getMetadataRelatedMetadataNames should return related metadata names fo
 ]
 `;

+exports[`getMetadataRelatedMetadataNames should return related metadata names for permissionFlag 1`] = `
+[
+  "role",
+]
+`;
+
 exports[`getMetadataRelatedMetadataNames should return related metadata names for role 1`] = `
 [
  "roleTarget",
+  "permissionFlag",
  "rowLevelPermissionPredicate",
  "rowLevelPermissionPredicateGroup",
 ]
@@ -11,6 +11,7 @@ exports[`sortMetadataNamesChildrenFirst should return metadata names sorted with
  "viewSort",
  "index",
  "pageLayout",
+  "permissionFlag",
  "roleTarget",
  "rowLevelPermissionPredicateGroup",
  "viewGroup",