Sync remote object (#4713)

* Sync objects

* Generate data for isRemote

* Add cache version update

* Add label identifier + fix field metadata input

---------

Co-authored-by: Thomas Trompette <thomast@twenty.com>

packages/twenty-server/src/engine/metadata-modules/object-metadata/dtos/create-object.input.ts

@@ -1,7 +1,13 @@
 import { Field, HideField, InputType } from '@nestjs/graphql';
 
 import { BeforeCreateOne } from '@ptc-org/nestjs-query-graphql';
-import { IsNotEmpty, IsOptional, IsString, IsUUID } from 'class-validator';
+import {
+  IsBoolean,
+  IsNotEmpty,
+  IsOptional,
+  IsString,
+  IsUUID,
+} from 'class-validator';
 
 import { IsValidMetadataName } from 'src/engine/decorators/metadata/is-valid-metadata-name.decorator';
 import { BeforeCreateOneObject } from 'src/engine/metadata-modules/object-metadata/hooks/before-create-one-object.hook';
@@ -56,4 +62,9 @@ export class CreateObjectInput {
   @IsOptional()
   @Field({ nullable: true })
   imageIdentifierFieldMetadataId?: string;
+
+  @IsBoolean()
+  @IsOptional()
+  @Field({ nullable: true })
+  isRemote?: boolean;
 }

packages/twenty-server/src/engine/metadata-modules/object-metadata/object-metadata.service.ts

@@ -139,9 +139,11 @@ export class ObjectMetadataService extends TypeOrmQueryService<ObjectMetadataEnt
       });
     }
 
-    await this.relationMetadataRepository.delete(
-      relationsToDelete.map((relation) => relation.id),
-    );
+    if (relationsToDelete.length > 0) {
+      await this.relationMetadataRepository.delete(
+        relationsToDelete.map((relation) => relation.id),
+      );
+    }
 
     for (const relationToDelete of relationsToDelete) {
       const foreignKeyFieldsToDelete = await this.fieldMetadataRepository.find({
@@ -192,17 +194,19 @@ export class ObjectMetadataService extends TypeOrmQueryService<ObjectMetadataEnt
 
     await this.objectMetadataRepository.delete(objectMetadata.id);
 
-    // DROP TABLE
-    await this.workspaceMigrationService.createCustomMigration(
-      generateMigrationName(`delete-${objectMetadata.nameSingular}`),
-      workspaceId,
-      [
-        {
-          name: computeObjectTargetTable(objectMetadata),
-          action: 'drop',
-        },
-      ],
-    );
+    if (!objectMetadata.isRemote) {
+      // DROP TABLE
+      await this.workspaceMigrationService.createCustomMigration(
+        generateMigrationName(`delete-${objectMetadata.nameSingular}`),
+        workspaceId,
+        [
+          {
+            name: computeObjectTargetTable(objectMetadata),
+            action: 'drop',
+          },
+        ],
+      );
+    }
 
     await this.workspaceMigrationRunnerService.executeMigrationFromPendingMigrations(
       workspaceId,
@@ -233,292 +237,296 @@ export class ObjectMetadataService extends TypeOrmQueryService<ObjectMetadataEnt
       dataSourceId: lastDataSourceMetadata.id,
       targetTableName: 'DEPRECATED',
       isActive: true,
-      isCustom: true,
+      isCustom: !objectMetadataInput.isRemote,
       isSystem: false,
-      isRemote: false,
-      fields:
-        // Creating default fields.
-        // No need to create a custom migration for this though as the default columns are already
-        // created with default values which is not supported yet by workspace migrations.
-        [
-          {
-            standardId: baseObjectStandardFieldIds.id,
-            type: FieldMetadataType.UUID,
-            name: 'id',
-            label: 'Id',
-            targetColumnMap: {
-              value: 'id',
+      isRemote: !!objectMetadataInput.isRemote,
+      fields: !objectMetadataInput.isRemote
+        ? // Creating default fields.
+          // No need to create a custom migration for this though as the default columns are already
+          // created with default values which is not supported yet by workspace migrations.
+          [
+            {
+              standardId: baseObjectStandardFieldIds.id,
+              type: FieldMetadataType.UUID,
+              name: 'id',
+              label: 'Id',
+              targetColumnMap: {
+                value: 'id',
+              },
+              icon: 'Icon123',
+              description: 'Id',
+              isNullable: false,
+              isActive: true,
+              isCustom: false,
+              isSystem: true,
+              workspaceId: objectMetadataInput.workspaceId,
+              defaultValue: 'uuid',
             },
-            icon: 'Icon123',
-            description: 'Id',
-            isNullable: false,
-            isActive: true,
-            isCustom: false,
-            isSystem: true,
-            workspaceId: objectMetadataInput.workspaceId,
-            defaultValue: 'uuid',
-          },
-          {
-            standardId: customObjectStandardFieldIds.name,
-            type: FieldMetadataType.TEXT,
-            name: 'name',
-            label: 'Name',
-            targetColumnMap: {
-              value: 'name',
+            {
+              standardId: customObjectStandardFieldIds.name,
+              type: FieldMetadataType.TEXT,
+              name: 'name',
+              label: 'Name',
+              targetColumnMap: {
+                value: 'name',
+              },
+              icon: 'IconAbc',
+              description: 'Name',
+              isNullable: false,
+              isActive: true,
+              isCustom: false,
+              workspaceId: objectMetadataInput.workspaceId,
+              defaultValue: "'Untitled'",
             },
-            icon: 'IconAbc',
-            description: 'Name',
-            isNullable: false,
-            isActive: true,
-            isCustom: false,
-            workspaceId: objectMetadataInput.workspaceId,
-            defaultValue: "'Untitled'",
-          },
-          {
-            standardId: baseObjectStandardFieldIds.createdAt,
-            type: FieldMetadataType.DATE_TIME,
-            name: 'createdAt',
-            label: 'Creation date',
-            targetColumnMap: {
-              value: 'createdAt',
+            {
+              standardId: baseObjectStandardFieldIds.createdAt,
+              type: FieldMetadataType.DATE_TIME,
+              name: 'createdAt',
+              label: 'Creation date',
+              targetColumnMap: {
+                value: 'createdAt',
+              },
+              icon: 'IconCalendar',
+              description: 'Creation date',
+              isNullable: false,
+              isActive: true,
+              isCustom: false,
+              workspaceId: objectMetadataInput.workspaceId,
+              defaultValue: 'now',
             },
-            icon: 'IconCalendar',
-            description: 'Creation date',
-            isNullable: false,
-            isActive: true,
-            isCustom: false,
-            workspaceId: objectMetadataInput.workspaceId,
-            defaultValue: 'now',
-          },
-          {
-            standardId: baseObjectStandardFieldIds.updatedAt,
-            type: FieldMetadataType.DATE_TIME,
-            name: 'updatedAt',
-            label: 'Update date',
-            targetColumnMap: {
-              value: 'updatedAt',
+            {
+              standardId: baseObjectStandardFieldIds.updatedAt,
+              type: FieldMetadataType.DATE_TIME,
+              name: 'updatedAt',
+              label: 'Update date',
+              targetColumnMap: {
+                value: 'updatedAt',
+              },
+              icon: 'IconCalendar',
+              description: 'Update date',
+              isNullable: false,
+              isActive: true,
+              isCustom: false,
+              isSystem: true,
+              workspaceId: objectMetadataInput.workspaceId,
+              defaultValue: 'now',
             },
-            icon: 'IconCalendar',
-            description: 'Update date',
-            isNullable: false,
-            isActive: true,
-            isCustom: false,
-            isSystem: true,
-            workspaceId: objectMetadataInput.workspaceId,
-            defaultValue: 'now',
-          },
-          {
-            standardId: customObjectStandardFieldIds.position,
-            type: FieldMetadataType.POSITION,
-            name: 'position',
-            label: 'Position',
-            targetColumnMap: {
-              value: 'position',
+            {
+              standardId: customObjectStandardFieldIds.position,
+              type: FieldMetadataType.POSITION,
+              name: 'position',
+              label: 'Position',
+              targetColumnMap: {
+                value: 'position',
+              },
+              icon: 'IconHierarchy2',
+              description: 'Position',
+              isNullable: true,
+              isActive: true,
+              isCustom: false,
+              isSystem: true,
+              workspaceId: objectMetadataInput.workspaceId,
+              defaultValue: null,
             },
-            icon: 'IconHierarchy2',
-            description: 'Position',
-            isNullable: true,
-            isActive: true,
-            isCustom: false,
-            isSystem: true,
-            workspaceId: objectMetadataInput.workspaceId,
-            defaultValue: null,
-          },
-        ],
+          ]
+        : // No fields for remote objects.
+          [],
     });
 
-    const { activityTargetObjectMetadata } =
-      await this.createActivityTargetRelation(
+    if (!objectMetadataInput.isRemote) {
+      const { eventObjectMetadata } = await this.createEventRelation(
         objectMetadataInput.workspaceId,
         createdObjectMetadata,
       );
 
-    const { favoriteObjectMetadata } = await this.createFavoriteRelation(
-      objectMetadataInput.workspaceId,
-      createdObjectMetadata,
-    );
+      const { activityTargetObjectMetadata } =
+        await this.createActivityTargetRelation(
+          objectMetadataInput.workspaceId,
+          createdObjectMetadata,
+        );
 
-    const { attachmentObjectMetadata } = await this.createAttachmentRelation(
-      objectMetadataInput.workspaceId,
-      createdObjectMetadata,
-    );
+      const { favoriteObjectMetadata } = await this.createFavoriteRelation(
+        objectMetadataInput.workspaceId,
+        createdObjectMetadata,
+      );
 
-    const { eventObjectMetadata } = await this.createEventRelation(
-      objectMetadataInput.workspaceId,
-      createdObjectMetadata,
-    );
+      const { attachmentObjectMetadata } = await this.createAttachmentRelation(
+        objectMetadataInput.workspaceId,
+        createdObjectMetadata,
+      );
 
-    await this.workspaceMigrationService.createCustomMigration(
-      generateMigrationName(`create-${createdObjectMetadata.nameSingular}`),
-      createdObjectMetadata.workspaceId,
-      [
-        {
-          name: computeObjectTargetTable(createdObjectMetadata),
-          action: 'create',
-        } satisfies WorkspaceMigrationTableAction,
-        // Add activity target relation
-        {
-          name: computeObjectTargetTable(activityTargetObjectMetadata),
-          action: 'alter',
-          columns: [
-            {
-              action: WorkspaceMigrationColumnActionType.CREATE,
-              columnName: `${computeCustomName(
-                createdObjectMetadata.nameSingular,
-                false,
-              )}Id`,
-              columnType: 'uuid',
-              isNullable: true,
-            } satisfies WorkspaceMigrationColumnCreate,
-          ],
-        },
-        {
-          name: computeObjectTargetTable(activityTargetObjectMetadata),
-          action: 'alter',
-          columns: [
-            {
-              action: WorkspaceMigrationColumnActionType.CREATE_FOREIGN_KEY,
-              columnName: `${computeCustomName(
-                createdObjectMetadata.nameSingular,
-                false,
-              )}Id`,
-              referencedTableName: computeObjectTargetTable(
-                createdObjectMetadata,
-              ),
-              referencedTableColumnName: 'id',
-              onDelete: RelationOnDeleteAction.CASCADE,
-            },
-          ],
-        },
-        // Add attachment relation
-        {
-          name: computeObjectTargetTable(attachmentObjectMetadata),
-          action: 'alter',
-          columns: [
-            {
-              action: WorkspaceMigrationColumnActionType.CREATE,
-              columnName: `${computeCustomName(
-                createdObjectMetadata.nameSingular,
-                false,
-              )}Id`,
-              columnType: 'uuid',
-              isNullable: true,
-            } satisfies WorkspaceMigrationColumnCreate,
-          ],
-        },
-        {
-          name: computeObjectTargetTable(attachmentObjectMetadata),
-          action: 'alter',
-          columns: [
-            {
-              action: WorkspaceMigrationColumnActionType.CREATE_FOREIGN_KEY,
-              columnName: `${computeCustomName(
-                createdObjectMetadata.nameSingular,
-                false,
-              )}Id`,
-              referencedTableName: computeObjectTargetTable(
-                createdObjectMetadata,
-              ),
-              referencedTableColumnName: 'id',
-              onDelete: RelationOnDeleteAction.CASCADE,
-            },
-          ],
-        },
-        // Add event relation
-        {
-          name: computeObjectTargetTable(eventObjectMetadata),
-          action: 'alter',
-          columns: [
-            {
-              action: WorkspaceMigrationColumnActionType.CREATE,
-              columnName: `${computeCustomName(
-                createdObjectMetadata.nameSingular,
-                false,
-              )}Id`,
-              columnType: 'uuid',
-              isNullable: true,
-            } satisfies WorkspaceMigrationColumnCreate,
-          ],
-        },
-        {
-          name: computeObjectTargetTable(eventObjectMetadata),
-          action: 'alter',
-          columns: [
-            {
-              action: WorkspaceMigrationColumnActionType.CREATE_FOREIGN_KEY,
-              columnName: `${computeCustomName(
-                createdObjectMetadata.nameSingular,
-                false,
-              )}Id`,
-              referencedTableName: computeObjectTargetTable(
-                createdObjectMetadata,
-              ),
-              referencedTableColumnName: 'id',
-              onDelete: RelationOnDeleteAction.CASCADE,
-            },
-          ],
-        },
-        // Add favorite relation
-        {
-          name: computeObjectTargetTable(favoriteObjectMetadata),
-          action: 'alter',
-          columns: [
-            {
-              action: WorkspaceMigrationColumnActionType.CREATE,
-              columnName: `${computeCustomName(
-                createdObjectMetadata.nameSingular,
-                false,
-              )}Id`,
-              columnType: 'uuid',
-              isNullable: true,
-            } satisfies WorkspaceMigrationColumnCreate,
-          ],
-        },
-        {
-          name: computeObjectTargetTable(favoriteObjectMetadata),
-          action: 'alter',
-          columns: [
-            {
-              action: WorkspaceMigrationColumnActionType.CREATE_FOREIGN_KEY,
-              columnName: `${computeCustomName(
-                createdObjectMetadata.nameSingular,
-                false,
-              )}Id`,
-              referencedTableName: computeObjectTargetTable(
-                createdObjectMetadata,
-              ),
-              referencedTableColumnName: 'id',
-              onDelete: RelationOnDeleteAction.CASCADE,
-            },
-          ],
-        },
-        {
-          name: computeObjectTargetTable(createdObjectMetadata),
-          action: 'alter',
-          columns: [
-            {
-              action: WorkspaceMigrationColumnActionType.CREATE,
-              columnName: 'position',
-              columnType: 'float',
-              isNullable: true,
-            } satisfies WorkspaceMigrationColumnCreate,
-          ],
-        } satisfies WorkspaceMigrationTableAction,
-        // This is temporary until we implement mainIdentifier
-        {
-          name: computeObjectTargetTable(createdObjectMetadata),
-          action: 'alter',
-          columns: [
-            {
-              action: WorkspaceMigrationColumnActionType.CREATE,
-              columnName: 'name',
-              columnType: 'text',
-              defaultValue: "'Untitled'",
-            } satisfies WorkspaceMigrationColumnCreate,
-          ],
-        } satisfies WorkspaceMigrationTableAction,
-      ],
-    );
+      await this.workspaceMigrationService.createCustomMigration(
+        generateMigrationName(`create-${createdObjectMetadata.nameSingular}`),
+        createdObjectMetadata.workspaceId,
+        [
+          {
+            name: computeObjectTargetTable(createdObjectMetadata),
+            action: 'create',
+          } satisfies WorkspaceMigrationTableAction,
+          // Add activity target relation
+          {
+            name: computeObjectTargetTable(activityTargetObjectMetadata),
+            action: 'alter',
+            columns: [
+              {
+                action: WorkspaceMigrationColumnActionType.CREATE,
+                columnName: `${computeCustomName(
+                  createdObjectMetadata.nameSingular,
+                  false,
+                )}Id`,
+                columnType: 'uuid',
+                isNullable: true,
+              } satisfies WorkspaceMigrationColumnCreate,
+            ],
+          },
+          {
+            name: computeObjectTargetTable(activityTargetObjectMetadata),
+            action: 'alter',
+            columns: [
+              {
+                action: WorkspaceMigrationColumnActionType.CREATE_FOREIGN_KEY,
+                columnName: `${computeCustomName(
+                  createdObjectMetadata.nameSingular,
+                  false,
+                )}Id`,
+                referencedTableName: computeObjectTargetTable(
+                  createdObjectMetadata,
+                ),
+                referencedTableColumnName: 'id',
+                onDelete: RelationOnDeleteAction.CASCADE,
+              },
+            ],
+          },
+          // Add attachment relation
+          {
+            name: computeObjectTargetTable(attachmentObjectMetadata),
+            action: 'alter',
+            columns: [
+              {
+                action: WorkspaceMigrationColumnActionType.CREATE,
+                columnName: `${computeCustomName(
+                  createdObjectMetadata.nameSingular,
+                  false,
+                )}Id`,
+                columnType: 'uuid',
+                isNullable: true,
+              } satisfies WorkspaceMigrationColumnCreate,
+            ],
+          },
+          {
+            name: computeObjectTargetTable(attachmentObjectMetadata),
+            action: 'alter',
+            columns: [
+              {
+                action: WorkspaceMigrationColumnActionType.CREATE_FOREIGN_KEY,
+                columnName: `${computeCustomName(
+                  createdObjectMetadata.nameSingular,
+                  false,
+                )}Id`,
+                referencedTableName: computeObjectTargetTable(
+                  createdObjectMetadata,
+                ),
+                referencedTableColumnName: 'id',
+                onDelete: RelationOnDeleteAction.CASCADE,
+              },
+            ],
+          },
+          // Add event relation
+          {
+            name: computeObjectTargetTable(eventObjectMetadata),
+            action: 'alter',
+            columns: [
+              {
+                action: WorkspaceMigrationColumnActionType.CREATE,
+                columnName: `${computeCustomName(
+                  createdObjectMetadata.nameSingular,
+                  false,
+                )}Id`,
+                columnType: 'uuid',
+                isNullable: true,
+              } satisfies WorkspaceMigrationColumnCreate,
+            ],
+          },
+          {
+            name: computeObjectTargetTable(eventObjectMetadata),
+            action: 'alter',
+            columns: [
+              {
+                action: WorkspaceMigrationColumnActionType.CREATE_FOREIGN_KEY,
+                columnName: `${computeCustomName(
+                  createdObjectMetadata.nameSingular,
+                  false,
+                )}Id`,
+                referencedTableName: computeObjectTargetTable(
+                  createdObjectMetadata,
+                ),
+                referencedTableColumnName: 'id',
+                onDelete: RelationOnDeleteAction.CASCADE,
+              },
+            ],
+          },
+          // Add favorite relation
+          {
+            name: computeObjectTargetTable(favoriteObjectMetadata),
+            action: 'alter',
+            columns: [
+              {
+                action: WorkspaceMigrationColumnActionType.CREATE,
+                columnName: `${computeCustomName(
+                  createdObjectMetadata.nameSingular,
+                  false,
+                )}Id`,
+                columnType: 'uuid',
+                isNullable: true,
+              } satisfies WorkspaceMigrationColumnCreate,
+            ],
+          },
+          {
+            name: computeObjectTargetTable(favoriteObjectMetadata),
+            action: 'alter',
+            columns: [
+              {
+                action: WorkspaceMigrationColumnActionType.CREATE_FOREIGN_KEY,
+                columnName: `${computeCustomName(
+                  createdObjectMetadata.nameSingular,
+                  false,
+                )}Id`,
+                referencedTableName: computeObjectTargetTable(
+                  createdObjectMetadata,
+                ),
+                referencedTableColumnName: 'id',
+                onDelete: RelationOnDeleteAction.CASCADE,
+              },
+            ],
+          },
+          {
+            name: computeObjectTargetTable(createdObjectMetadata),
+            action: 'alter',
+            columns: [
+              {
+                action: WorkspaceMigrationColumnActionType.CREATE,
+                columnName: 'position',
+                columnType: 'float',
+                isNullable: true,
+              } satisfies WorkspaceMigrationColumnCreate,
+            ],
+          } satisfies WorkspaceMigrationTableAction,
+          // This is temporary until we implement mainIdentifier
+          {
+            name: computeObjectTargetTable(createdObjectMetadata),
+            action: 'alter',
+            columns: [
+              {
+                action: WorkspaceMigrationColumnActionType.CREATE,
+                columnName: 'name',
+                columnType: 'text',
+                defaultValue: "'Untitled'",
+              } satisfies WorkspaceMigrationColumnCreate,
+            ],
+          } satisfies WorkspaceMigrationTableAction,
+        ],
+      );
+    }
 
     await this.workspaceMigrationRunnerService.executeMigrationFromPendingMigrations(
       createdObjectMetadata.workspaceId,