Twenty standard and workspace custom applications 1/3 (#15625)

# Introduction related to https://github.com/twentyhq/core-team-issues/issues/1833 In this PR we're starting the sync-metadata and standardIds deprecation by introducing `twenty-standard` application that will regroup every standard object such as company and opportunities. But also the `custom-workspace-application` which is an app created at the same time as a workspace and that will regroup everything configure within the workspace ( custom objects fields etc ) ## What's done On both new workspace and seeded workspace creation: - Creating a custom workspace app - Creating a twenty standard app - Refactored the seed core schema and workspace creation to be run within a transaction in order to handle circular dependency foreignkey requirements ( which is deferred for app toward workspace ) - Updated workspace entity to have a custom workspace relation ( nullable for the moment until we implem an upgrade command to handle retro comp ) - Integration testing on user, workspace creation deletion and expected default apps creation - ~~Soft deleted user on `deleteUser`~~ Done by marie and rebased on it ## What's next - Update seeder to propagate the `twenty-standard` workspace `applicationId` to every standard synchronized entities ( cheap and fast iteration through the about to be deprecated sync-metadata as an easy way to synchronize standards metadata entities ). - Update seeder to propagate the `custom-workspace-application` workspace `applicationId` to anything custom ( `pets` and `rockets` ) - Prepend `custom-workspace-application` `applicationId` to every metadata API operations ( create a specific cache etc ) - Upgrade command on all existing workspace to create a custom app and associate its applicationId to any existing custom entities - Make `universalIdentifier` and `applicationId` required for any syncable entity
2025-11-10 16:13:12 +01:00
parent 9a80164cf3
commit 7a1e699fc8
106 changed files with 2167 additions and 985 deletions
@@ -0,0 +1,75 @@
+import { InjectRepository } from '@nestjs/typeorm';
+
+import { Command } from 'nest-commander';
+import { In, Repository } from 'typeorm';
+
+import {
+  ActiveOrSuspendedWorkspacesMigrationCommandRunner,
+  type RunOnWorkspaceArgs,
+} from 'src/database/commands/command-runners/active-or-suspended-workspaces-migration.command-runner';
+import { ApplicationEntity } from 'src/engine/core-modules/application/application.entity';
+import { ApplicationService } from 'src/engine/core-modules/application/application.service';
+import { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
+import { TwentyORMGlobalManager } from 'src/engine/twenty-orm/twenty-orm-global.manager';
+import { TWENTY_STANDARD_APPLICATION } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/twenty-standard-applications';
+
+@Command({
+  name: 'upgrade:1-11:create-twenty-standard-application',
+  description:
+    'Create twenty-standard application for workspaces that do not have them',
+})
+export class CreateTwentyStandardApplicationCommand extends ActiveOrSuspendedWorkspacesMigrationCommandRunner {
+  constructor(
+    @InjectRepository(WorkspaceEntity)
+    protected readonly workspaceRepository: Repository<WorkspaceEntity>,
+    protected readonly twentyORMGlobalManager: TwentyORMGlobalManager,
+    @InjectRepository(ApplicationEntity)
+    private readonly applicationRepository: Repository<ApplicationEntity>,
+    private readonly applicationService: ApplicationService,
+  ) {
+    super(workspaceRepository, twentyORMGlobalManager);
+  }
+
+  override async runOnWorkspace({
+    workspaceId,
+    options,
+  }: RunOnWorkspaceArgs): Promise<void> {
+    this.logger.log(
+      `Checking standard applications for workspace ${workspaceId}`,
+    );
+
+    const existingApplications = await this.applicationRepository.find({
+      where: {
+        workspaceId,
+        universalIdentifier: In([TWENTY_STANDARD_APPLICATION]),
+      },
+    });
+
+    const existingIds = new Set(
+      existingApplications.map((app) => app.universalIdentifier),
+    );
+
+    if (existingIds.has(TWENTY_STANDARD_APPLICATION.universalIdentifier)) {
+      this.logger.log(
+        `Skipping twenty standard application as it already exists`,
+      );
+
+      return;
+    }
+
+    this.logger.log(`About to seed twenty standard application`);
+    if (options.dryRun) {
+      return;
+    }
+
+    try {
+      await this.applicationService.createTwentyStandardApplication({
+        workspaceId,
+      });
+
+      this.logger.log(`Successfully seeded twenty standard`);
+    } catch (e) {
+      this.logger.error(`Failed to seed twenty standard`, e);
+    }
+  }
+}
@@ -3,6 +3,9 @@ import { TypeOrmModule } from '@nestjs/typeorm';

 import { CleanOrphanedRoleTargetsCommand } from 'src/database/commands/upgrade-version-command/1-11/1-11-clean-orphaned-role-targets.command';
 import { CleanOrphanedUserWorkspacesCommand } from 'src/database/commands/upgrade-version-command/1-11/1-11-clean-orphaned-user-workspaces.command';
+import { CreateTwentyStandardApplicationCommand } from 'src/database/commands/upgrade-version-command/1-11/1-11-create-twenty-standard-application.command';
+import { ApplicationEntity } from 'src/engine/core-modules/application/application.entity';
+import { ApplicationModule } from 'src/engine/core-modules/application/application.module';
 import { UserWorkspaceEntity } from 'src/engine/core-modules/user-workspace/user-workspace.entity';
 import { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
 import { FieldMetadataEntity } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
@@ -22,16 +25,20 @@ import { WorkspaceSchemaManagerModule } from 'src/engine/twenty-orm/workspace-sc
      ViewEntity,
      UserWorkspaceEntity,
      RoleTargetsEntity,
+      ApplicationEntity,
    ]),
    WorkspaceSchemaManagerModule,
+    ApplicationModule,
  ],
  providers: [
    CleanOrphanedUserWorkspacesCommand,
    CleanOrphanedRoleTargetsCommand,
+    CreateTwentyStandardApplicationCommand,
  ],
  exports: [
    CleanOrphanedUserWorkspacesCommand,
    CleanOrphanedRoleTargetsCommand,
+    CreateTwentyStandardApplicationCommand,
  ],
 })
 export class V1_11_UpgradeVersionCommandModule {}
@@ -21,6 +21,7 @@ import { RegenerateSearchVectorsCommand } from 'src/database/commands/upgrade-ve
 import { SeedDashboardViewCommand } from 'src/database/commands/upgrade-version-command/1-10/1-10-seed-dashboard-view.command';
 import { CleanOrphanedRoleTargetsCommand } from 'src/database/commands/upgrade-version-command/1-11/1-11-clean-orphaned-role-targets.command';
 import { CleanOrphanedUserWorkspacesCommand } from 'src/database/commands/upgrade-version-command/1-11/1-11-clean-orphaned-user-workspaces.command';
+import { CreateTwentyStandardApplicationCommand } from 'src/database/commands/upgrade-version-command/1-11/1-11-create-twenty-standard-application.command';
 import { FixLabelIdentifierPositionAndVisibilityCommand } from 'src/database/commands/upgrade-version-command/1-6/1-6-fix-label-identifier-position-and-visibility.command';
 import { BackfillWorkflowManualTriggerAvailabilityCommand } from 'src/database/commands/upgrade-version-command/1-7/1-7-backfill-workflow-manual-trigger-availability.command';
 import { DeduplicateUniqueFieldsCommand } from 'src/database/commands/upgrade-version-command/1-8/1-8-deduplicate-unique-fields.command';
@@ -75,6 +76,7 @@ export class UpgradeCommand extends UpgradeCommandRunner {
    // 1.11 Commands
    protected readonly cleanOrphanedUserWorkspacesCommand: CleanOrphanedUserWorkspacesCommand,
    protected readonly cleanOrphanedRoleTargetsCommand: CleanOrphanedRoleTargetsCommand,
+    protected readonly seedStandardApplicationsCommand: CreateTwentyStandardApplicationCommand,
  ) {
    super(
      workspaceRepository,
@@ -124,7 +126,7 @@ export class UpgradeCommand extends UpgradeCommandRunner {
    };

    const commands_1110: VersionCommands = {
-      beforeSyncMetadata: [],
+      beforeSyncMetadata: [this.seedStandardApplicationsCommand],
      afterSyncMetadata: [
        this.cleanOrphanedUserWorkspacesCommand,
        this.cleanOrphanedRoleTargetsCommand,