feat: sync command missing ability to rename standard object (#4819)

We've introduced in PR #4373 standard ids to be able to rename standard fields and objects. Fields part was working properly, but objects part was not yet implemented. This PR is adding the missing parts to make it work.
2024-04-09 10:20:34 +02:00
parent b1242bb850
commit 35717fce8b
16 changed files with 322 additions and 148 deletions
--- a/packages/twenty-server/src/engine/workspace-manager/workspace-sync-metadata/commands/sync-workspace-metadata.command.ts
+++ b/packages/twenty-server/src/engine/workspace-manager/workspace-sync-metadata/commands/sync-workspace-metadata.command.ts
@ -42,27 +42,39 @@ export class SyncWorkspaceMetadataCommand extends CommandRunner {
      : await this.workspaceService.getWorkspaceIds();

    for (const workspaceId of workspaceIds) {
-      const issues = await this.workspaceHealthService.healthCheck(workspaceId);
+      try {
+        const issues =
+          await this.workspaceHealthService.healthCheck(workspaceId);

-      // Security: abort if there are issues.
-      if (issues.length > 0) {
+        // Security: abort if there are issues.
+        if (issues.length > 0) {
+          if (!options.force) {
+            this.logger.error(
+              `Workspace contains ${issues.length} issues, aborting.`,
+            );
+
+            this.logger.log(
+              'If you want to force the migration, use --force flag',
+            );
+            this.logger.log(
+              'Please use `workspace:health` command to check issues and fix them before running this command.',
+            );
+
+            return;
+          }
+
+          this.logger.warn(
+            `Workspace contains ${issues.length} issues, sync has been forced.`,
+          );
+        }
+      } catch (error) {
        if (!options.force) {
-          this.logger.error(
-            `Workspace contains ${issues.length} issues, aborting.`,
-          );
-
-          this.logger.log(
-            'If you want to force the migration, use --force flag',
-          );
-          this.logger.log(
-            'Please use `workspace:health` command to check issues and fix them before running this command.',
-          );
-
-          return;
+          throw error;
        }

        this.logger.warn(
-          `Workspace contains ${issues.length} issues, sync has been forced.`,
+          `Workspace health check failed with error, but sync has been forced.`,
+          error,
        );
      }

--- a/packages/twenty-server/src/engine/workspace-manager/workspace-sync-metadata/interfaces/comparator.interface.ts
+++ b/packages/twenty-server/src/engine/workspace-manager/workspace-sync-metadata/interfaces/comparator.interface.ts
@ -33,7 +33,9 @@ export interface ComparatorDeleteResult<T> {
 export type ObjectComparatorResult =
  | ComparatorSkipResult
  | ComparatorCreateResult<ComputedPartialObjectMetadata>
-  | ComparatorUpdateResult<Partial<ComputedPartialObjectMetadata>>;
+  | ComparatorUpdateResult<
+      Partial<ComputedPartialObjectMetadata> & { id: string }
+    >;

 export type FieldComparatorResult =
  | ComparatorSkipResult
--- a/packages/twenty-server/src/engine/workspace-manager/workspace-sync-metadata/services/workspace-metadata-updater.service.ts
+++ b/packages/twenty-server/src/engine/workspace-manager/workspace-sync-metadata/services/workspace-metadata-updater.service.ts
@ -1,8 +1,13 @@
 import { Injectable, Logger } from '@nestjs/common';

-import { EntityManager, In } from 'typeorm';
+import {
+  EntityManager,
+  EntityTarget,
+  FindOptionsWhere,
+  In,
+  ObjectLiteral,
+} from 'typeorm';
 import { v4 as uuidV4 } from 'uuid';
-import omit from 'lodash.omit';

 import { PartialFieldMetadata } from 'src/engine/workspace-manager/workspace-sync-metadata/interfaces/partial-field-metadata.interface';

@ -14,6 +19,8 @@ import {
 import { RelationMetadataEntity } from 'src/engine/metadata-modules/relation-metadata/relation-metadata.entity';
 import { FieldMetadataComplexOption } from 'src/engine/metadata-modules/field-metadata/dtos/options.input';
 import { WorkspaceSyncStorage } from 'src/engine/workspace-manager/workspace-sync-metadata/storage/workspace-sync.storage';
+import { FieldMetadataUpdate } from 'src/engine/workspace-manager/workspace-migration-builder/factories/workspace-migration-field.factory';
+import { ObjectMetadataUpdate } from 'src/engine/workspace-manager/workspace-migration-builder/factories/workspace-migration-object.factory';

@Injectable()
 export class WorkspaceMetadataUpdaterService {
@ -24,7 +31,7 @@ export class WorkspaceMetadataUpdaterService {
    storage: WorkspaceSyncStorage,
  ): Promise<{
    createdObjectMetadataCollection: ObjectMetadataEntity[];
-    updatedObjectMetadataCollection: ObjectMetadataEntity[];
+    updatedObjectMetadataCollection: ObjectMetadataUpdate[];
  }> {
    const objectMetadataRepository =
      manager.getRepository(ObjectMetadataEntity);
@ -56,10 +63,17 @@ export class WorkspaceMetadataUpdaterService {
    /**
     * Update object metadata
     */
-    const updatedObjectMetadataCollection = await objectMetadataRepository.save(
-      storage.objectMetadataUpdateCollection.map((objectMetadata) =>
-        omit(objectMetadata, ['fields']),
-      ),
+    const updatedObjectMetadataCollection = await this.updateEntities(
+      manager,
+      ObjectMetadataEntity,
+      storage.objectMetadataUpdateCollection,
+      [
+        'fields',
+        'dataSourceId',
+        'workspaceId',
+        'labelIdentifierFieldMetadataId',
+        'imageIdentifierFieldMetadataId',
+      ],
    );

    /**
@ -108,10 +122,7 @@ export class WorkspaceMetadataUpdaterService {
    storage: WorkspaceSyncStorage,
  ): Promise<{
    createdFieldMetadataCollection: FieldMetadataEntity[];
-    updatedFieldMetadataCollection: {
-      current: FieldMetadataEntity;
-      altered: FieldMetadataEntity;
-    }[];
+    updatedFieldMetadataCollection: FieldMetadataUpdate[];
  }> {
    const fieldMetadataRepository = manager.getRepository(FieldMetadataEntity);

@ -127,41 +138,12 @@ export class WorkspaceMetadataUpdaterService {
    /**
     * Update field metadata
     */
-    const oldFieldMetadataCollection = await fieldMetadataRepository.findBy({
-      id: In(storage.fieldMetadataUpdateCollection.map((field) => field.id)),
-    });
-    // Pre-process old collection into a mapping for quick access
-    const oldFieldMetadataMap = new Map(
-      oldFieldMetadataCollection.map((field) => [field.id, field]),
-    );
-    // Combine old and new field metadata to get whole updated entities
-    const fieldMetadataUpdateCollection =
-      storage.fieldMetadataUpdateCollection.map((updateFieldMetadata) => {
-        const oldFieldMetadata = oldFieldMetadataMap.get(
-          updateFieldMetadata.id,
-        );
-
-        if (!oldFieldMetadata) {
-          throw new Error(`
-            Field ${updateFieldMetadata.id} not found in oldFieldMetadataCollection`);
-        }
-
-        // TypeORM 😢
-        // If we didn't provide the old value, it will be set to null fields that are not in the updateFieldMetadata
-        // and override the old value with null in the DB.
-        // Also save method doesn't return the whole entity if you give a partial one.
-        // https://github.com/typeorm/typeorm/issues/3490
-        // To avoid calling update in a for loop, we did this hack.
-        return {
-          ...omit(oldFieldMetadata, ['objectMetadataId', 'workspaceId']),
-          ...omit(updateFieldMetadata, ['objectMetadataId', 'workspaceId']),
-          options: updateFieldMetadata.options ?? oldFieldMetadata.options,
-        };
-      });
-
-    const updatedFieldMetadataCollection = await fieldMetadataRepository.save(
-      fieldMetadataUpdateCollection,
-    );
+    const updatedFieldMetadataCollection = await this.updateEntities<
+      FieldMetadataEntity<'default'>
+    >(manager, FieldMetadataEntity, storage.objectMetadataUpdateCollection, [
+      'objectMetadataId',
+      'workspaceId',
+    ]);

    /**
     * Delete field metadata
@ -183,28 +165,7 @@ export class WorkspaceMetadataUpdaterService {
    return {
      createdFieldMetadataCollection:
        createdFieldMetadataCollection as FieldMetadataEntity[],
-      updatedFieldMetadataCollection: updatedFieldMetadataCollection.map(
-        (alteredFieldMetadata) => {
-          const oldFieldMetadata = oldFieldMetadataMap.get(
-            alteredFieldMetadata.id,
-          );
-
-          if (!oldFieldMetadata) {
-            throw new Error(`
-              Field ${alteredFieldMetadata.id} not found in oldFieldMetadataCollection
-            `);
-          }
-
-          return {
-            current: oldFieldMetadata as FieldMetadataEntity,
-            altered: {
-              ...alteredFieldMetadata,
-              objectMetadataId: oldFieldMetadata.objectMetadataId,
-              workspaceId: oldFieldMetadata.workspaceId,
-            } as FieldMetadataEntity,
-          };
-        },
-      ),
+      updatedFieldMetadataCollection,
    };
  }

@ -267,4 +228,83 @@ export class WorkspaceMetadataUpdaterService {
      updatedRelationMetadataCollection,
    };
  }
+
+  /**
+   * Update entities in the database
+   * @param manager EntityManager
+   * @param entityClass Entity class
+   * @param updateCollection Update collection
+   * @param keysToOmit keys to omit in the merge process
+   * @returns Promise<{ current: Entity; altered: Entity }[]>
+   */
+  private async updateEntities<Entity extends ObjectLiteral & { id: string }>(
+    manager: EntityManager,
+    entityClass: EntityTarget<Entity>,
+    updateCollection: Array<
+      DeepPartial<Omit<Entity, 'fields'>> & { id: string }
+    >,
+    keysToOmit: (keyof Entity)[] = [],
+  ): Promise<{ current: Entity; altered: Entity }[]> {
+    const repository = manager.getRepository(entityClass);
+
+    const oldEntities = await repository.findBy({
+      id: In(updateCollection.map((updateItem) => updateItem.id)),
+    } as FindOptionsWhere<Entity>);
+
+    // Pre-process old collection into a mapping for quick access
+    const oldEntitiesMap = new Map(
+      oldEntities.map((oldEntity) => [oldEntity.id, oldEntity]),
+    );
+
+    // Combine old and new field metadata to get whole updated entities
+    const entityUpdateCollection = updateCollection.map((updateItem) => {
+      const oldEntity = oldEntitiesMap.get(updateItem.id);
+
+      if (!oldEntity) {
+        throw new Error(`
+              Entity ${updateItem.id} not found in oldEntities`);
+      }
+
+      // TypeORM 😢
+      // If we didn't provide the old value, it will be set to null objects that are not in the updateObjectMetadata
+      // and override the old value with null in the DB.
+      // Also save method doesn't return the whole entity if you give a partial one.
+      // https://github.com/typeorm/typeorm/issues/3490
+      // To avoid calling update in a for loop, we did this hack.
+      const mergedUpdate = {
+        ...oldEntity,
+        ...updateItem,
+      };
+
+      // Omit keys that we don't want to override
+      keysToOmit.forEach((key) => {
+        delete mergedUpdate[key];
+      });
+
+      return mergedUpdate;
+    });
+
+    const updatedEntities = await repository.save(entityUpdateCollection);
+
+    return updatedEntities.map((updatedEntity) => {
+      const oldEntity = oldEntitiesMap.get(updatedEntity.id);
+
+      if (!oldEntity) {
+        throw new Error(`
+            Entity ${updatedEntity.id} not found in oldEntitiesMap
+          `);
+      }
+
+      return {
+        current: oldEntity,
+        altered: {
+          ...updatedEntity,
+          ...keysToOmit.reduce(
+            (acc, key) => ({ ...acc, [key]: oldEntity[key] }),
+            {},
+          ),
+        },
+      };
+    });
+  }
 }
--- a/packages/twenty-server/src/engine/workspace-manager/workspace-sync-metadata/services/workspace-sync-object-metadata.service.ts
+++ b/packages/twenty-server/src/engine/workspace-manager/workspace-sync-metadata/services/workspace-sync-object-metadata.service.ts
@ -154,6 +154,12 @@ export class WorkspaceSyncObjectMetadataService {
        WorkspaceMigrationBuilderAction.CREATE,
      );

+    const updateObjectWorkspaceMigrations =
+      await this.workspaceMigrationObjectFactory.create(
+        metadataObjectUpdaterResult.updatedObjectMetadataCollection,
+        WorkspaceMigrationBuilderAction.UPDATE,
+      );
+
    const deleteObjectWorkspaceMigrations =
      await this.workspaceMigrationObjectFactory.create(
        storage.objectMetadataDeleteCollection,
@ -164,6 +170,7 @@ export class WorkspaceSyncObjectMetadataService {

    return [
      ...createObjectWorkspaceMigrations,
+      ...updateObjectWorkspaceMigrations,
      ...deleteObjectWorkspaceMigrations,
    ];
  }
--- a/packages/twenty-server/src/engine/workspace-manager/workspace-sync-metadata/storage/workspace-sync.storage.ts
+++ b/packages/twenty-server/src/engine/workspace-manager/workspace-sync-metadata/storage/workspace-sync.storage.ts
@ -10,8 +10,9 @@ export class WorkspaceSyncStorage {
  // Object metadata
  private readonly _objectMetadataCreateCollection: ComputedPartialObjectMetadata[] =
    [];
-  private readonly _objectMetadataUpdateCollection: Partial<ComputedPartialObjectMetadata>[] =
-    [];
+  private readonly _objectMetadataUpdateCollection: (Partial<ComputedPartialObjectMetadata> & {
+    id: string;
+  })[] = [];
  private readonly _objectMetadataDeleteCollection: ObjectMetadataEntity[] = [];

  // Field metadata
@ -72,7 +73,9 @@ export class WorkspaceSyncStorage {
    this._objectMetadataCreateCollection.push(object);
  }

-  addUpdateObjectMetadata(object: Partial<ComputedPartialObjectMetadata>) {
+  addUpdateObjectMetadata(
+    object: Partial<ComputedPartialObjectMetadata> & { id: string },
+  ) {
    this._objectMetadataUpdateCollection.push(object);
  }