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
@@ -0,0 +1,112 @@
+import { InjectDataSource, InjectRepository } from '@nestjs/typeorm';
+
+import { Command } from 'nest-commander';
+import { DataSource, IsNull, type Repository } from 'typeorm';
+import { v4 } from 'uuid';
+
+import { isDefined } from 'twenty-shared/utils';
+
+import { ActiveOrSuspendedWorkspacesMigrationCommandRunner } from 'src/database/commands/command-runners/active-or-suspended-workspaces-migration.command-runner';
+import { RunOnWorkspaceArgs } from 'src/database/commands/command-runners/workspaces-migration.command-runner';
+import { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
+import { DataSourceService } from 'src/engine/metadata-modules/data-source/data-source.service';
+import { PermissionFlagEntity } from 'src/engine/metadata-modules/permission-flag/permission-flag.entity';
+import { GlobalWorkspaceOrmManager } from 'src/engine/twenty-orm/global-workspace-datasource/global-workspace-orm.manager';
+
+@Command({
+  name: 'upgrade:1-20:identify-permission-flag-metadata',
+  description:
+    'Identify permission flag metadata (backfill universalIdentifier and applicationId)',
+})
+export class IdentifyPermissionFlagMetadataCommand extends ActiveOrSuspendedWorkspacesMigrationCommandRunner {
+  private hasRunOnce = false;
+
+  constructor(
+    @InjectRepository(WorkspaceEntity)
+    protected readonly workspaceRepository: Repository<WorkspaceEntity>,
+    protected readonly twentyORMGlobalManager: GlobalWorkspaceOrmManager,
+    protected readonly dataSourceService: DataSourceService,
+    @InjectDataSource()
+    private readonly coreDataSource: DataSource,
+  ) {
+    super(workspaceRepository, twentyORMGlobalManager, dataSourceService);
+  }
+
+  override async runOnWorkspace({
+    options,
+  }: RunOnWorkspaceArgs): Promise<void> {
+    if (this.hasRunOnce) {
+      this.logger.log(
+        'Skipping has already been run once IdentifyPermissionFlagMetadataCommand',
+      );
+
+      return;
+    }
+
+    if (options.dryRun) {
+      return;
+    }
+
+    const queryRunner = this.coreDataSource.createQueryRunner();
+
+    await queryRunner.connect();
+    await queryRunner.startTransaction();
+
+    try {
+      const repository =
+        queryRunner.manager.getRepository(PermissionFlagEntity);
+      const withNullApplicationId = await repository.find({
+        where: {
+          applicationId: IsNull(),
+        },
+        relations: ['role'],
+      });
+
+      const toUpdate = withNullApplicationId.filter((permissionFlag) =>
+        isDefined(permissionFlag.role?.applicationId),
+      );
+      const toRemove = withNullApplicationId.filter(
+        (permissionFlag) => !isDefined(permissionFlag.role?.applicationId),
+      );
+
+      for (const permissionFlag of toUpdate) {
+        const flag = permissionFlag;
+        flag.applicationId = permissionFlag.role.applicationId;
+        flag.universalIdentifier = flag.universalIdentifier ?? v4();
+      }
+
+      if (toUpdate.length > 0) {
+        await repository.save(toUpdate);
+      }
+      if (toRemove.length > 0) {
+        await repository.remove(toRemove);
+      }
+
+      const withNullUniversalIdentifier = await repository.find({
+        where: {
+          universalIdentifier: IsNull(),
+        },
+      });
+
+      for (const permissionFlag of withNullUniversalIdentifier) {
+        permissionFlag.universalIdentifier = v4();
+      }
+
+      if (withNullUniversalIdentifier.length > 0) {
+        await repository.save(withNullUniversalIdentifier);
+      }
+
+      await queryRunner.commitTransaction();
+      this.logger.log('Successfully run IdentifyPermissionFlagMetadataCommand');
+      this.hasRunOnce = true;
+    } catch (error) {
+      await queryRunner.rollbackTransaction();
+      this.logger.error(
+        `Rolling back IdentifyPermissionFlagMetadataCommand: ${error.message}`,
+      );
+      throw error;
+    } finally {
+      await queryRunner.release();
+    }
+  }
+}
@@ -0,0 +1,72 @@
+import { InjectDataSource, InjectRepository } from '@nestjs/typeorm';
+
+import { Command } from 'nest-commander';
+import { DataSource, type Repository } from 'typeorm';
+
+import { ActiveOrSuspendedWorkspacesMigrationCommandRunner } from 'src/database/commands/command-runners/active-or-suspended-workspaces-migration.command-runner';
+import { RunOnWorkspaceArgs } from 'src/database/commands/command-runners/workspaces-migration.command-runner';
+import { makePermissionFlagUniversalIdentifierAndApplicationIdNotNullQueries } from 'src/database/typeorm/core/migrations/utils/1773232418467-make-permission-flag-universal-identifier-and-application-id-not-null.util';
+import { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
+import { DataSourceService } from 'src/engine/metadata-modules/data-source/data-source.service';
+import { GlobalWorkspaceOrmManager } from 'src/engine/twenty-orm/global-workspace-datasource/global-workspace-orm.manager';
+
+@Command({
+  name: 'upgrade:1-20:make-permission-flag-universal-identifier-and-application-id-not-nullable-migration',
+  description:
+    'Set NOT NULL on permissionFlag universalIdentifier and applicationId, add unique index and FK (run identify-permission-flag-metadata first)',
+})
+export class MakePermissionFlagUniversalIdentifierAndApplicationIdNotNullableMigrationCommand extends ActiveOrSuspendedWorkspacesMigrationCommandRunner {
+  private hasRunOnce = false;
+
+  constructor(
+    @InjectRepository(WorkspaceEntity)
+    protected readonly workspaceRepository: Repository<WorkspaceEntity>,
+    protected readonly twentyORMGlobalManager: GlobalWorkspaceOrmManager,
+    protected readonly dataSourceService: DataSourceService,
+    @InjectDataSource()
+    private readonly coreDataSource: DataSource,
+  ) {
+    super(workspaceRepository, twentyORMGlobalManager, dataSourceService);
+  }
+
+  override async runOnWorkspace({
+    options,
+  }: RunOnWorkspaceArgs): Promise<void> {
+    if (this.hasRunOnce) {
+      this.logger.log(
+        'Skipping has already been run once MakePermissionFlagUniversalIdentifierAndApplicationIdNotNullableMigrationCommand',
+      );
+
+      return;
+    }
+
+    if (options.dryRun) {
+      return;
+    }
+
+    const queryRunner = this.coreDataSource.createQueryRunner();
+
+    await queryRunner.connect();
+    await queryRunner.startTransaction();
+
+    try {
+      await makePermissionFlagUniversalIdentifierAndApplicationIdNotNullQueries(
+        queryRunner,
+      );
+
+      await queryRunner.commitTransaction();
+      this.logger.log(
+        'Successfully run MakePermissionFlagUniversalIdentifierAndApplicationIdNotNullableMigrationCommand',
+      );
+      this.hasRunOnce = true;
+    } catch (error) {
+      await queryRunner.rollbackTransaction();
+      this.logger.error(
+        `Rolling back MakePermissionFlagUniversalIdentifierAndApplicationIdNotNullableMigrationCommand: ${error.message}`,
+      );
+      throw error;
+    } finally {
+      await queryRunner.release();
+    }
+  }
+}
@@ -4,9 +4,11 @@ import { TypeOrmModule } from '@nestjs/typeorm';
 import { BackfillCommandMenuItemsCommand } from 'src/database/commands/upgrade-version-command/1-20/1-20-backfill-command-menu-items.command';
 import { BackfillNavigationMenuItemTypeCommand } from 'src/database/commands/upgrade-version-command/1-20/1-20-backfill-navigation-menu-item-type.command';
 import { BackfillPageLayoutsCommand } from 'src/database/commands/upgrade-version-command/1-20/1-20-backfill-page-layouts.command';
+import { IdentifyPermissionFlagMetadataCommand } from 'src/database/commands/upgrade-version-command/1-20/1-20-identify-permission-flag-metadata.command';
+import { MakePermissionFlagUniversalIdentifierAndApplicationIdNotNullableMigrationCommand } from 'src/database/commands/upgrade-version-command/1-20/1-20-make-permission-flag-universal-identifier-and-application-id-not-nullable-migration.command';
+import { MigrateRichTextToTextCommand } from 'src/database/commands/upgrade-version-command/1-20/1-20-migrate-rich-text-to-text.command';
 import { SeedCliApplicationRegistrationCommand } from 'src/database/commands/upgrade-version-command/1-20/1-20-seed-cli-application-registration.command';
 import { ApplicationRegistrationModule } from 'src/engine/core-modules/application/application-registration/application-registration.module';
-import { MigrateRichTextToTextCommand } from 'src/database/commands/upgrade-version-command/1-20/1-20-migrate-rich-text-to-text.command';
 import { ApplicationModule } from 'src/engine/core-modules/application/application.module';
 import { FeatureFlagModule } from 'src/engine/core-modules/feature-flag/feature-flag.module';
 import { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
@@ -31,6 +33,8 @@ import { WorkspaceMigrationModule } from 'src/engine/workspace-manager/workspace
    FeatureFlagModule,
  ],
  providers: [
+    IdentifyPermissionFlagMetadataCommand,
+    MakePermissionFlagUniversalIdentifierAndApplicationIdNotNullableMigrationCommand,
    BackfillCommandMenuItemsCommand,
    BackfillNavigationMenuItemTypeCommand,
    BackfillPageLayoutsCommand,
@@ -38,6 +42,8 @@ import { WorkspaceMigrationModule } from 'src/engine/workspace-manager/workspace
    MigrateRichTextToTextCommand,
  ],
  exports: [
+    IdentifyPermissionFlagMetadataCommand,
+    MakePermissionFlagUniversalIdentifierAndApplicationIdNotNullableMigrationCommand,
    BackfillCommandMenuItemsCommand,
    BackfillNavigationMenuItemTypeCommand,
    BackfillPageLayoutsCommand,
@@ -30,14 +30,16 @@ import { MigrateWorkspacePicturesCommand } from 'src/database/commands/upgrade-v
 import { AddMissingSystemFieldsToStandardObjectsCommand } from 'src/database/commands/upgrade-version-command/1-19/1-19-add-missing-system-fields-to-standard-objects.command';
 import { BackfillMessageChannelMessageAssociationMessageFolderCommand } from 'src/database/commands/upgrade-version-command/1-19/1-19-backfill-message-channel-message-association-message-folder.command';
 import { BackfillMissingStandardViewsCommand } from 'src/database/commands/upgrade-version-command/1-19/1-19-backfill-missing-standard-views.command';
-import { BackfillNavigationMenuItemTypeCommand } from 'src/database/commands/upgrade-version-command/1-20/1-20-backfill-navigation-menu-item-type.command';
 import { BackfillSystemFieldsIsSystemCommand } from 'src/database/commands/upgrade-version-command/1-19/1-19-backfill-system-fields-is-system.command';
 import { FixInvalidStandardUniversalIdentifiersCommand } from 'src/database/commands/upgrade-version-command/1-19/1-19-fix-invalid-standard-universal-identifiers.command';
 import { SeedServerIdCommand } from 'src/database/commands/upgrade-version-command/1-19/1-19-seed-server-id.command';
 import { BackfillCommandMenuItemsCommand } from 'src/database/commands/upgrade-version-command/1-20/1-20-backfill-command-menu-items.command';
+import { BackfillNavigationMenuItemTypeCommand } from 'src/database/commands/upgrade-version-command/1-20/1-20-backfill-navigation-menu-item-type.command';
 import { BackfillPageLayoutsCommand } from 'src/database/commands/upgrade-version-command/1-20/1-20-backfill-page-layouts.command';
-import { SeedCliApplicationRegistrationCommand } from 'src/database/commands/upgrade-version-command/1-20/1-20-seed-cli-application-registration.command';
+import { IdentifyPermissionFlagMetadataCommand } from 'src/database/commands/upgrade-version-command/1-20/1-20-identify-permission-flag-metadata.command';
+import { MakePermissionFlagUniversalIdentifierAndApplicationIdNotNullableMigrationCommand } from 'src/database/commands/upgrade-version-command/1-20/1-20-make-permission-flag-universal-identifier-and-application-id-not-nullable-migration.command';
 import { MigrateRichTextToTextCommand } from 'src/database/commands/upgrade-version-command/1-20/1-20-migrate-rich-text-to-text.command';
+import { SeedCliApplicationRegistrationCommand } from 'src/database/commands/upgrade-version-command/1-20/1-20-seed-cli-application-registration.command';
 import { TwentyConfigService } from 'src/engine/core-modules/twenty-config/twenty-config.service';
 import { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
 import { DataSourceService } from 'src/engine/metadata-modules/data-source/data-source.service';
@@ -88,6 +90,8 @@ export class UpgradeCommand extends UpgradeCommandRunner {
    protected readonly seedServerIdCommand: SeedServerIdCommand,

    // 1.20 Commands
+    protected readonly identifyPermissionFlagMetadataCommand: IdentifyPermissionFlagMetadataCommand,
+    protected readonly makePermissionFlagUniversalIdentifierAndApplicationIdNotNullableMigrationCommand: MakePermissionFlagUniversalIdentifierAndApplicationIdNotNullableMigrationCommand,
    protected readonly backfillNavigationMenuItemTypeCommand: BackfillNavigationMenuItemTypeCommand,
    protected readonly backfillCommandMenuItemsCommand: BackfillCommandMenuItemsCommand,
    protected readonly backfillPageLayoutsCommand: BackfillPageLayoutsCommand,
@@ -135,10 +139,14 @@ export class UpgradeCommand extends UpgradeCommandRunner {
      this.addMissingSystemFieldsToStandardObjectsCommand,
      this.backfillMessageChannelMessageAssociationMessageFolderCommand,
      this.backfillMissingStandardViewsCommand,
+      this.fixRoleAndAgentUniversalIdentifiersCommand,
      this.seedServerIdCommand,
    ];

    const commands_1200: VersionCommands = [
+      this.identifyPermissionFlagMetadataCommand,
+      this
+        .makePermissionFlagUniversalIdentifierAndApplicationIdNotNullableMigrationCommand,
      this.backfillNavigationMenuItemTypeCommand,
      this.migrateRichTextToTextCommand,
      this.backfillCommandMenuItemsCommand,