[BUG] Refactor actor composite type (#10232)

fixes #10200 

The FieldActor Zod schema was updated to correctly handle null context.

---------

Co-authored-by: prastoin <paul@twenty.com>

packages/twenty-server/src/database/commands/upgrade-version/0-42/0-42-standardization-of-actor-composite-context-type.ts

@@ -0,0 +1,114 @@
+import { InjectRepository } from '@nestjs/typeorm';
+
+import chalk from 'chalk';
+import { Command } from 'nest-commander';
+import { FieldMetadataType } from 'twenty-shared';
+import { IsNull, Repository } from 'typeorm';
+
+import {
+  ActiveWorkspacesCommandOptions,
+  ActiveWorkspacesCommandRunner,
+} from 'src/database/commands/active-workspaces.command';
+import { CommandLogger } from 'src/database/commands/logger';
+import { Workspace } from 'src/engine/core-modules/workspace/workspace.entity';
+import { FieldMetadataEntity } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
+import { WorkspaceMetadataVersionService } from 'src/engine/metadata-modules/workspace-metadata-version/services/workspace-metadata-version.service';
+import { TwentyORMGlobalManager } from 'src/engine/twenty-orm/twenty-orm-global.manager';
+
+@Command({
+  name: 'upgrade-0.42:standardization-of-actor-composite-context-type',
+  description: 'Add context to actor composite type.',
+})
+export class StandardizationOfActorCompositeContextTypeCommand extends ActiveWorkspacesCommandRunner {
+  protected readonly logger;
+
+  constructor(
+    @InjectRepository(Workspace, 'core')
+    protected readonly workspaceRepository: Repository<Workspace>,
+    private readonly twentyORMGlobalManager: TwentyORMGlobalManager,
+    @InjectRepository(FieldMetadataEntity, 'metadata')
+    private readonly fieldMetadataRepository: Repository<FieldMetadataEntity>,
+    private readonly workspaceMetadataVersionService: WorkspaceMetadataVersionService,
+  ) {
+    super(workspaceRepository);
+    this.logger = new CommandLogger({
+      constructorName: this.constructor.name,
+      verbose: false,
+    });
+    this.logger.setVerbose(false);
+  }
+
+  async executeActiveWorkspacesCommand(
+    _passedParam: string[],
+    options: ActiveWorkspacesCommandOptions,
+    workspaceIds: string[],
+  ): Promise<void> {
+    this.logger.log(`Running add-context-to-actor-composite-type command`);
+
+    if (options?.dryRun) {
+      this.logger.log(chalk.yellow('Dry run mode: No changes will be applied'));
+    }
+
+    for (const [index, workspaceId] of workspaceIds.entries()) {
+      try {
+        await this.execute(workspaceId, options?.dryRun);
+        this.logger.verbose(
+          `[${index + 1}/${workspaceIds.length}] Added for workspace: ${workspaceId}`,
+        );
+      } catch (error) {
+        this.logger.error(`Error for workspace: ${workspaceId}`, error);
+      }
+    }
+  }
+
+  private async execute(workspaceId: string, dryRun = false): Promise<void> {
+    this.logger.verbose(`Adding for workspace: ${workspaceId}`);
+    const actorFields = await this.fieldMetadataRepository.find({
+      where: {
+        type: FieldMetadataType.ACTOR,
+        workspaceId,
+      },
+      relations: ['object'],
+    });
+
+    for (const field of actorFields) {
+      if (!field || !field.object) {
+        this.logger.verbose(
+          'field.objectMetadata is null',
+          workspaceId,
+          field.id,
+        );
+        continue;
+      }
+
+      const fieldRepository =
+        await this.twentyORMGlobalManager.getRepositoryForWorkspace(
+          workspaceId,
+          field.object.nameSingular,
+        );
+
+      if (!dryRun) {
+        const rowsToUpdate = await fieldRepository.update(
+          {
+            [field.name + 'Context']: IsNull(),
+          },
+          {
+            [field.name + 'Context']: {},
+          },
+        );
+
+        this.logger.verbose(
+          `updated ${rowsToUpdate ? rowsToUpdate.affected : 0} rows`,
+        );
+      }
+    }
+
+    if (!dryRun) {
+      await this.workspaceMetadataVersionService.incrementMetadataVersion(
+        workspaceId,
+      );
+    }
+
+    this.twentyORMGlobalManager.destroyDataSourceForWorkspace(workspaceId);
+  }
+}

packages/twenty-server/src/database/commands/upgrade-version/0-42/0-42-upgrade-version.command.ts

@@ -8,6 +8,7 @@ import { BaseCommandOptions } from 'src/database/commands/base.command';
 import { FixBodyV2ViewFieldPositionCommand } from 'src/database/commands/upgrade-version/0-42/0-42-fix-body-v2-view-field-position.command';
 import { LimitAmountOfViewFieldCommand } from 'src/database/commands/upgrade-version/0-42/0-42-limit-amount-of-view-field';
 import { MigrateRichTextFieldCommand } from 'src/database/commands/upgrade-version/0-42/0-42-migrate-rich-text-field.command';
+import { StandardizationOfActorCompositeContextTypeCommand } from 'src/database/commands/upgrade-version/0-42/0-42-standardization-of-actor-composite-context-type';
 import { Workspace } from 'src/engine/core-modules/workspace/workspace.entity';
 import { SyncWorkspaceMetadataCommand } from 'src/engine/workspace-manager/workspace-sync-metadata/commands/sync-workspace-metadata.command';
 
@@ -28,6 +29,7 @@ export class UpgradeTo0_42Command extends ActiveWorkspacesCommandRunner {
     private readonly fixBodyV2ViewFieldPositionCommand: FixBodyV2ViewFieldPositionCommand,
     private readonly limitAmountOfViewFieldCommand: LimitAmountOfViewFieldCommand,
     private readonly syncWorkspaceMetadataCommand: SyncWorkspaceMetadataCommand,
+    private readonly standardizationOfActorCompositeContextType: StandardizationOfActorCompositeContextTypeCommand,
   ) {
     super(workspaceRepository);
   }
@@ -75,5 +77,11 @@ export class UpgradeTo0_42Command extends ActiveWorkspacesCommandRunner {
       },
       workspaceIds,
     );
+
+    await this.standardizationOfActorCompositeContextType.executeActiveWorkspacesCommand(
+      passedParam,
+      options,
+      workspaceIds,
+    );
   }
 }

packages/twenty-server/src/database/commands/upgrade-version/0-42/0-42-upgrade-version.module.ts

@@ -4,6 +4,7 @@ import { TypeOrmModule } from '@nestjs/typeorm';
 import { FixBodyV2ViewFieldPositionCommand } from 'src/database/commands/upgrade-version/0-42/0-42-fix-body-v2-view-field-position.command';
 import { LimitAmountOfViewFieldCommand } from 'src/database/commands/upgrade-version/0-42/0-42-limit-amount-of-view-field';
 import { MigrateRichTextFieldCommand } from 'src/database/commands/upgrade-version/0-42/0-42-migrate-rich-text-field.command';
+import { StandardizationOfActorCompositeContextTypeCommand } from 'src/database/commands/upgrade-version/0-42/0-42-standardization-of-actor-composite-context-type';
 import { UpgradeTo0_42Command } from 'src/database/commands/upgrade-version/0-42/0-42-upgrade-version.command';
 import { FeatureFlag } from 'src/engine/core-modules/feature-flag/feature-flag.entity';
 import { FeatureFlagModule } from 'src/engine/core-modules/feature-flag/feature-flag.module';
@@ -35,6 +36,7 @@ import { WorkspaceSyncMetadataCommandsModule } from 'src/engine/workspace-manage
     MigrateRichTextFieldCommand,
     FixBodyV2ViewFieldPositionCommand,
     LimitAmountOfViewFieldCommand,
+    StandardizationOfActorCompositeContextTypeCommand,
   ],
 })
 export class UpgradeTo0_42CommandModule {}

packages/twenty-server/src/database/commands/upgrade-version/0-43/0-43-upgrade-version.command.ts

@@ -5,6 +5,7 @@ import { Repository } from 'typeorm';
 
 import { ActiveWorkspacesCommandRunner } from 'src/database/commands/active-workspaces.command';
 import { BaseCommandOptions } from 'src/database/commands/base.command';
+import { StandardizationOfActorCompositeContextTypeCommand } from 'src/database/commands/upgrade-version/0-42/0-42-standardization-of-actor-composite-context-type';
 import { AddTasksAssignedToMeViewCommand } from 'src/database/commands/upgrade-version/0-43/0-43-add-tasks-assigned-to-me-view.command';
 import { Workspace } from 'src/engine/core-modules/workspace/workspace.entity';
 
@@ -17,6 +18,7 @@ export class UpgradeTo0_43Command extends ActiveWorkspacesCommandRunner {
     @InjectRepository(Workspace, 'core')
     protected readonly workspaceRepository: Repository<Workspace>,
     private readonly addTasksAssignedToMeViewCommand: AddTasksAssignedToMeViewCommand,
+    private readonly standardizationOfActorCompositeContextTypeCommand: StandardizationOfActorCompositeContextTypeCommand,
   ) {
     super(workspaceRepository);
   }
@@ -33,5 +35,12 @@ export class UpgradeTo0_43Command extends ActiveWorkspacesCommandRunner {
       options,
       workspaceIds,
     );
+
+    // Note: Introduced in 0.42, ran manually on prod. Introduced to self-host globally on 0.43
+    await this.standardizationOfActorCompositeContextTypeCommand.executeActiveWorkspacesCommand(
+      passedParam,
+      options,
+      workspaceIds,
+    );
   }
 }

packages/twenty-server/src/database/commands/upgrade-version/0-43/0-43-upgrade-version.module.ts

@@ -1,6 +1,7 @@
 import { Module } from '@nestjs/common';
 import { TypeOrmModule } from '@nestjs/typeorm';
 
+import { StandardizationOfActorCompositeContextTypeCommand } from 'src/database/commands/upgrade-version/0-42/0-42-standardization-of-actor-composite-context-type';
 import { AddTasksAssignedToMeViewCommand } from 'src/database/commands/upgrade-version/0-43/0-43-add-tasks-assigned-to-me-view.command';
 import { MigrateSearchVectorOnNoteAndTaskEntitiesCommand } from 'src/database/commands/upgrade-version/0-43/0-43-migrate-search-vector-on-note-and-task-entities.command';
 import { UpgradeTo0_43Command } from 'src/database/commands/upgrade-version/0-43/0-43-upgrade-version.command';
@@ -29,6 +30,7 @@ import { WorkspaceMigrationRunnerModule } from 'src/engine/workspace-manager/wor
     UpgradeTo0_43Command,
     AddTasksAssignedToMeViewCommand,
     MigrateSearchVectorOnNoteAndTaskEntitiesCommand,
+    StandardizationOfActorCompositeContextTypeCommand,
   ],
 })
 export class UpgradeTo0_43CommandModule {}