feat: add ability to rename standard object with sync command

twentyhq · Apr 9, 2024 · 7d46702 · 7d46702
1 parent b1242bb
commit 7d46702
Show file tree

Hide file tree

Showing 17 changed files with 327 additions and 154 deletions.
diff --git a/packages/twenty-server/src/engine/metadata-modules/field-metadata/field-metadata.service.ts b/packages/twenty-server/src/engine/metadata-modules/field-metadata/field-metadata.service.ts
@@ -18,6 +18,7 @@ import {
   WorkspaceMigrationColumnActionType,
   WorkspaceMigrationColumnDrop,
   WorkspaceMigrationTableAction,
+  WorkspaceMigrationTableActionType,
 } from 'src/engine/metadata-modules/workspace-migration/workspace-migration.entity';
 import { TypeORMService } from 'src/database/typeorm/typeorm.service';
 import { DataSourceService } from 'src/engine/metadata-modules/data-source/data-source.service';
@@ -152,7 +153,7 @@ export class FieldMetadataService extends TypeOrmQueryService<FieldMetadataEntit
           [
             {
               name: computeObjectTargetTable(objectMetadata),
-              action: 'alter',
+              action: WorkspaceMigrationTableActionType.ALTER,
               columns: this.workspaceMigrationFactory.createColumnActions(
                 WorkspaceMigrationColumnActionType.CREATE,
                 createdFieldMetadata,
@@ -328,7 +329,7 @@ export class FieldMetadataService extends TypeOrmQueryService<FieldMetadataEntit
           [
             {
               name: computeObjectTargetTable(objectMetadata),
-              action: 'alter',
+              action: WorkspaceMigrationTableActionType.ALTER,
               columns: this.workspaceMigrationFactory.createColumnActions(
                 WorkspaceMigrationColumnActionType.ALTER,
                 existingFieldMetadata,
@@ -399,7 +400,7 @@ export class FieldMetadataService extends TypeOrmQueryService<FieldMetadataEntit
         [
           {
             name: computeObjectTargetTable(objectMetadata),
-            action: 'alter',
+            action: WorkspaceMigrationTableActionType.ALTER,
             columns: [
               {
                 action: WorkspaceMigrationColumnActionType.DROP,

diff --git a/...ages/twenty-server/src/engine/metadata-modules/object-metadata/object-metadata.service.ts b/...ages/twenty-server/src/engine/metadata-modules/object-metadata/object-metadata.service.ts
@@ -16,6 +16,7 @@ import { WorkspaceMigrationRunnerService } from 'src/engine/workspace-manager/wo
 import {
   WorkspaceMigrationColumnActionType,
   WorkspaceMigrationColumnDrop,
+  WorkspaceMigrationTableActionType,
 } from 'src/engine/metadata-modules/workspace-migration/workspace-migration.entity';
 import {
   FieldMetadataEntity,
@@ -177,7 +178,7 @@ export class ObjectMetadataService extends TypeOrmQueryService<ObjectMetadataEnt
                 relationToDelete.toObjectName,
                 relationToDelete.toObjectMetadataIsCustom,
               ),
-              action: 'alter',
+              action: WorkspaceMigrationTableActionType.ALTER,
               columns: [
                 {
                   action: WorkspaceMigrationColumnActionType.DROP,
@@ -203,7 +204,7 @@ export class ObjectMetadataService extends TypeOrmQueryService<ObjectMetadataEnt
         [
           {
             name: computeObjectTargetTable(objectMetadata),
-            action: 'drop',
+            action: WorkspaceMigrationTableActionType.DROP,
           },
         ],
       );

diff --git a/...tadata-modules/object-metadata/utils/build-workspace-migrations-for-custom-object.util.ts b/...tadata-modules/object-metadata/utils/build-workspace-migrations-for-custom-object.util.ts
@@ -5,6 +5,7 @@ import {
   WorkspaceMigrationTableAction,
   WorkspaceMigrationColumnActionType,
   WorkspaceMigrationColumnCreate,
+  WorkspaceMigrationTableActionType,
 } from 'src/engine/metadata-modules/workspace-migration/workspace-migration.entity';
 import { computeObjectTargetTable } from 'src/engine/utils/compute-object-target-table.util';
 
@@ -17,12 +18,12 @@ export const buildWorkspaceMigrationsForCustomObject = (
 ): WorkspaceMigrationTableAction[] => [
   {
     name: computeObjectTargetTable(createdObjectMetadata),
-    action: 'create',
+    action: WorkspaceMigrationTableActionType.CREATE,
   } satisfies WorkspaceMigrationTableAction,
   // Add activity target relation
   {
     name: computeObjectTargetTable(activityTargetObjectMetadata),
-    action: 'alter',
+    action: WorkspaceMigrationTableActionType.ALTER,
     columns: [
       {
         action: WorkspaceMigrationColumnActionType.CREATE,
@@ -36,7 +37,7 @@ export const buildWorkspaceMigrationsForCustomObject = (
   },
   {
     name: computeObjectTargetTable(activityTargetObjectMetadata),
-    action: 'alter',
+    action: WorkspaceMigrationTableActionType.ALTER,
     columns: [
       {
         action: WorkspaceMigrationColumnActionType.CREATE_FOREIGN_KEY,
@@ -52,7 +53,7 @@ export const buildWorkspaceMigrationsForCustomObject = (
   // Add attachment relation
   {
     name: computeObjectTargetTable(attachmentObjectMetadata),
-    action: 'alter',
+    action: WorkspaceMigrationTableActionType.ALTER,
     columns: [
       {
         action: WorkspaceMigrationColumnActionType.CREATE,
@@ -66,7 +67,7 @@ export const buildWorkspaceMigrationsForCustomObject = (
   },
   {
     name: computeObjectTargetTable(attachmentObjectMetadata),
-    action: 'alter',
+    action: WorkspaceMigrationTableActionType.ALTER,
     columns: [
       {
         action: WorkspaceMigrationColumnActionType.CREATE_FOREIGN_KEY,
@@ -82,7 +83,7 @@ export const buildWorkspaceMigrationsForCustomObject = (
   // Add event relation
   {
     name: computeObjectTargetTable(eventObjectMetadata),
-    action: 'alter',
+    action: WorkspaceMigrationTableActionType.ALTER,
     columns: [
       {
         action: WorkspaceMigrationColumnActionType.CREATE,
@@ -96,7 +97,7 @@ export const buildWorkspaceMigrationsForCustomObject = (
   },
   {
     name: computeObjectTargetTable(eventObjectMetadata),
-    action: 'alter',
+    action: WorkspaceMigrationTableActionType.ALTER,
     columns: [
       {
         action: WorkspaceMigrationColumnActionType.CREATE_FOREIGN_KEY,
@@ -112,7 +113,7 @@ export const buildWorkspaceMigrationsForCustomObject = (
   // Add favorite relation
   {
     name: computeObjectTargetTable(favoriteObjectMetadata),
-    action: 'alter',
+    action: WorkspaceMigrationTableActionType.ALTER,
     columns: [
       {
         action: WorkspaceMigrationColumnActionType.CREATE,
@@ -126,7 +127,7 @@ export const buildWorkspaceMigrationsForCustomObject = (
   },
   {
     name: computeObjectTargetTable(favoriteObjectMetadata),
-    action: 'alter',
+    action: WorkspaceMigrationTableActionType.ALTER,
     columns: [
       {
         action: WorkspaceMigrationColumnActionType.CREATE_FOREIGN_KEY,
@@ -141,7 +142,7 @@ export const buildWorkspaceMigrationsForCustomObject = (
   },
   {
     name: computeObjectTargetTable(createdObjectMetadata),
-    action: 'alter',
+    action: WorkspaceMigrationTableActionType.ALTER,
     columns: [
       {
         action: WorkspaceMigrationColumnActionType.CREATE,
@@ -154,7 +155,7 @@ export const buildWorkspaceMigrationsForCustomObject = (
   // This is temporary until we implement mainIdentifier
   {
     name: computeObjectTargetTable(createdObjectMetadata),
-    action: 'alter',
+    action: WorkspaceMigrationTableActionType.ALTER,
     columns: [
       {
         action: WorkspaceMigrationColumnActionType.CREATE,

diff --git a/...tadata-modules/object-metadata/utils/build-workspace-migrations-for-remote-object.util.ts b/...tadata-modules/object-metadata/utils/build-workspace-migrations-for-remote-object.util.ts
@@ -6,6 +6,7 @@ import {
   WorkspaceMigrationTableAction,
   WorkspaceMigrationColumnActionType,
   WorkspaceMigrationColumnCreate,
+  WorkspaceMigrationTableActionType,
 } from 'src/engine/metadata-modules/workspace-migration/workspace-migration.entity';
 import { computeObjectTargetTable } from 'src/engine/utils/compute-object-target-table.util';
 
@@ -61,7 +62,7 @@ export const buildWorkspaceMigrationsForRemoteObject = async (
   return [
     {
       name: computeObjectTargetTable(activityTargetObjectMetadata),
-      action: 'alter',
+      action: WorkspaceMigrationTableActionType.ALTER,
       columns: [
         {
           action: WorkspaceMigrationColumnActionType.CREATE,
@@ -75,7 +76,7 @@ export const buildWorkspaceMigrationsForRemoteObject = async (
     },
     {
       name: computeObjectTargetTable(activityTargetObjectMetadata),
-      action: 'alter',
+      action: WorkspaceMigrationTableActionType.ALTER,
       columns: [
         {
           action: WorkspaceMigrationColumnActionType.CREATE,
@@ -88,7 +89,7 @@ export const buildWorkspaceMigrationsForRemoteObject = async (
     },
     {
       name: computeObjectTargetTable(activityTargetObjectMetadata),
-      action: 'alter',
+      action: WorkspaceMigrationTableActionType.ALTER,
       columns: [
         {
           action: WorkspaceMigrationColumnActionType.CREATE_COMMENT,
@@ -104,7 +105,7 @@ export const buildWorkspaceMigrationsForRemoteObject = async (
     // Add attachment relation
     {
       name: computeObjectTargetTable(attachmentObjectMetadata),
-      action: 'alter',
+      action: WorkspaceMigrationTableActionType.ALTER,
       columns: [
         {
           action: WorkspaceMigrationColumnActionType.CREATE,
@@ -118,7 +119,7 @@ export const buildWorkspaceMigrationsForRemoteObject = async (
     },
     {
       name: computeObjectTargetTable(attachmentObjectMetadata),
-      action: 'alter',
+      action: WorkspaceMigrationTableActionType.ALTER,
       columns: [
         {
           action: WorkspaceMigrationColumnActionType.CREATE,
@@ -131,7 +132,7 @@ export const buildWorkspaceMigrationsForRemoteObject = async (
     },
     {
       name: computeObjectTargetTable(attachmentObjectMetadata),
-      action: 'alter',
+      action: WorkspaceMigrationTableActionType.ALTER,
       columns: [
         {
           action: WorkspaceMigrationColumnActionType.CREATE_COMMENT,
@@ -147,7 +148,7 @@ export const buildWorkspaceMigrationsForRemoteObject = async (
     // Add event relation
     {
       name: computeObjectTargetTable(eventObjectMetadata),
-      action: 'alter',
+      action: WorkspaceMigrationTableActionType.ALTER,
       columns: [
         {
           action: WorkspaceMigrationColumnActionType.CREATE,
@@ -161,7 +162,7 @@ export const buildWorkspaceMigrationsForRemoteObject = async (
     },
     {
       name: computeObjectTargetTable(eventObjectMetadata),
-      action: 'alter',
+      action: WorkspaceMigrationTableActionType.ALTER,
       columns: [
         {
           action: WorkspaceMigrationColumnActionType.CREATE,
@@ -174,7 +175,7 @@ export const buildWorkspaceMigrationsForRemoteObject = async (
     },
     {
       name: computeObjectTargetTable(eventObjectMetadata),
-      action: 'alter',
+      action: WorkspaceMigrationTableActionType.ALTER,
       columns: [
         {
           action: WorkspaceMigrationColumnActionType.CREATE_COMMENT,
@@ -190,7 +191,7 @@ export const buildWorkspaceMigrationsForRemoteObject = async (
     // Add favorite relation
     {
       name: computeObjectTargetTable(favoriteObjectMetadata),
-      action: 'alter',
+      action: WorkspaceMigrationTableActionType.ALTER,
       columns: [
         {
           action: WorkspaceMigrationColumnActionType.CREATE,
@@ -204,7 +205,7 @@ export const buildWorkspaceMigrationsForRemoteObject = async (
     },
     {
       name: computeObjectTargetTable(favoriteObjectMetadata),
-      action: 'alter',
+      action: WorkspaceMigrationTableActionType.ALTER,
       columns: [
         {
           action: WorkspaceMigrationColumnActionType.CREATE,
@@ -217,7 +218,7 @@ export const buildWorkspaceMigrationsForRemoteObject = async (
     },
     {
       name: computeObjectTargetTable(favoriteObjectMetadata),
-      action: 'alter',
+      action: WorkspaceMigrationTableActionType.ALTER,
       columns: [
         {
           action: WorkspaceMigrationColumnActionType.CREATE_COMMENT,

diff --git a/.../twenty-server/src/engine/metadata-modules/relation-metadata/relation-metadata.service.ts b/.../twenty-server/src/engine/metadata-modules/relation-metadata/relation-metadata.service.ts
@@ -17,7 +17,10 @@ import { CreateRelationInput } from 'src/engine/metadata-modules/relation-metada
 import { WorkspaceMigrationRunnerService } from 'src/engine/workspace-manager/workspace-migration-runner/workspace-migration-runner.service';
 import { WorkspaceMigrationService } from 'src/engine/metadata-modules/workspace-migration/workspace-migration.service';
 import { FieldMetadataType } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
-import { WorkspaceMigrationColumnActionType } from 'src/engine/metadata-modules/workspace-migration/workspace-migration.entity';
+import {
+  WorkspaceMigrationColumnActionType,
+  WorkspaceMigrationTableActionType,
+} from 'src/engine/metadata-modules/workspace-migration/workspace-migration.entity';
 import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
 import { computeObjectTargetTable } from 'src/engine/utils/compute-object-target-table.util';
 import { generateMigrationName } from 'src/engine/metadata-modules/workspace-migration/utils/generate-migration-name.util';
@@ -171,7 +174,7 @@ export class RelationMetadataService extends TypeOrmQueryService<RelationMetadat
           name: computeObjectTargetTable(
             objectMetadataMap[relationMetadataInput.toObjectMetadataId],
           ),
-          action: 'alter',
+          action: WorkspaceMigrationTableActionType.ALTER,
           columns: [
             {
               action: WorkspaceMigrationColumnActionType.CREATE,
@@ -186,7 +189,7 @@ export class RelationMetadataService extends TypeOrmQueryService<RelationMetadat
           name: computeObjectTargetTable(
             objectMetadataMap[relationMetadataInput.toObjectMetadataId],
           ),
-          action: 'alter',
+          action: WorkspaceMigrationTableActionType.ALTER,
           columns: [
             {
               action: WorkspaceMigrationColumnActionType.CREATE_FOREIGN_KEY,

diff --git a/...enty-server/src/engine/metadata-modules/workspace-migration/workspace-migration.entity.ts b/...enty-server/src/engine/metadata-modules/workspace-migration/workspace-migration.entity.ts
@@ -80,14 +80,21 @@ export type WorkspaceMigrationColumnAction = {
   | WorkspaceMigrationCreateComment
 );
 
+/**
+ * Enum values are lowercase to avoid issues with already existing enum values
+ */
+export enum WorkspaceMigrationTableActionType {
+  CREATE = 'create',
+  ALTER = 'alter',
+  DROP = 'drop',
+  CREATE_FOREIGN_TABLE = 'create_foreign_table',
+  DROP_FOREIGN_TABLE = 'drop_foreign_table'
+}
+
 export type WorkspaceMigrationTableAction = {
   name: string;
-  action:
-    | 'create'
-    | 'alter'
-    | 'drop'
-    | 'create_foreign_table'
-    | 'drop_foreign_table';
+  newName?: string;
+  action: WorkspaceMigrationTableActionType;
   columns?: WorkspaceMigrationColumnAction[];
   foreignTable?: WorkspaceMigrationForeignTable;
 };

diff --git a/...kspace-manager/workspace-migration-builder/factories/workspace-migration-field.factory.ts b/...kspace-manager/workspace-migration-builder/factories/workspace-migration-field.factory.ts
@@ -11,6 +11,7 @@ import {
   WorkspaceMigrationColumnActionType,
   WorkspaceMigrationEntity,
   WorkspaceMigrationTableAction,
+  WorkspaceMigrationTableActionType,
 } from 'src/engine/metadata-modules/workspace-migration/workspace-migration.entity';
 import { computeObjectTargetTable } from 'src/engine/utils/compute-object-target-table.util';
 import { WorkspaceMigrationFactory } from 'src/engine/metadata-modules/workspace-migration/workspace-migration.factory';
@@ -94,7 +95,7 @@ export class WorkspaceMigrationFieldFactory {
           name: computeObjectTargetTable(
             originalObjectMetadataMap[fieldMetadata.objectMetadataId],
           ),
-          action: 'alter',
+          action: WorkspaceMigrationTableActionType.ALTER,
           columns: this.workspaceMigrationFactory.createColumnActions(
             WorkspaceMigrationColumnActionType.CREATE,
             fieldMetadata,
@@ -132,7 +133,7 @@ export class WorkspaceMigrationFieldFactory {
               fieldMetadataUpdate.current.objectMetadataId
             ],
           ),
-          action: 'alter',
+          action: WorkspaceMigrationTableActionType.ALTER,
           columns: this.workspaceMigrationFactory.createColumnActions(
             WorkspaceMigrationColumnActionType.ALTER,
             fieldMetadataUpdate.current,
@@ -171,7 +172,7 @@ export class WorkspaceMigrationFieldFactory {
           name: computeObjectTargetTable(
             originalObjectMetadataMap[fieldMetadata.objectMetadataId],
           ),
-          action: 'alter',
+          action: WorkspaceMigrationTableActionType.ALTER,
           columns: [
             {
               action: WorkspaceMigrationColumnActionType.DROP,