feat: populate join column for new relation

packages/twenty-server/src/database/commands/upgrade-version/0-41/0-41-migrate-relations-to-field-metadata.command.ts

@@ -3,7 +3,7 @@ import { InjectRepository } from '@nestjs/typeorm';
 import chalk from 'chalk';
 import { Command } from 'nest-commander';
 import { FieldMetadataType } from 'twenty-shared';
-import { Repository } from 'typeorm';
+import { In, Repository } from 'typeorm';
 
 import { RelationType } from 'src/engine/metadata-modules/field-metadata/interfaces/relation-type.interface';
 
@@ -18,6 +18,7 @@ import {
   deduceRelationDirection,
   RelationDirection,
 } from 'src/engine/utils/deduce-relation-direction.util';
+import { isFieldMetadataOfType } from 'src/engine/utils/is-field-metadata-of-type.util';
 
 @Command({
   name: 'upgrade-0.41:migrate-relations-to-field-metadata',
@@ -65,10 +66,13 @@ export class MigrateRelationsToFieldMetadataCommand extends ActiveWorkspacesComm
         `Running command for workspace ${workspaceId} ${index + 1}/${total}`,
       );
 
-      const fieldMetadataCollection = (await this.fieldMetadataRepository.find({
-        where: { workspaceId, type: FieldMetadataType.RELATION },
+      const fieldMetadataCollection = await this.fieldMetadataRepository.find({
+        where: {
+          workspaceId,
+          type: In([FieldMetadataType.RELATION, FieldMetadataType.UUID]),
+        },
         relations: ['fromRelationMetadata', 'toRelationMetadata'],
-      })) as unknown as FieldMetadataEntity<FieldMetadataType.RELATION>[];
+      });
 
       if (!fieldMetadataCollection.length) {
         this.logger.log(
@@ -80,10 +84,22 @@ export class MigrateRelationsToFieldMetadataCommand extends ActiveWorkspacesComm
         return;
       }
 
-      const fieldMetadataToUpdateCollection = fieldMetadataCollection.map(
-        (fieldMetadata) => this.mapFieldMetadata(fieldMetadata),
+      const joinColumnFieldMetadataCollection = fieldMetadataCollection.filter(
+        (fieldMetadata) =>
+          isFieldMetadataOfType(fieldMetadata, FieldMetadataType.UUID),
       );
 
+      const fieldMetadataToUpdateCollection = fieldMetadataCollection
+        .filter((fieldMetadata) =>
+          isFieldMetadataOfType(fieldMetadata, FieldMetadataType.RELATION),
+        )
+        .map((fieldMetadata) =>
+          this.updateRelationFieldMetadata(
+            joinColumnFieldMetadataCollection,
+            fieldMetadata,
+          ),
+        );
+
       if (fieldMetadataToUpdateCollection.length > 0) {
         await this.fieldMetadataRepository.save(
           fieldMetadataToUpdateCollection,
@@ -98,11 +114,16 @@ export class MigrateRelationsToFieldMetadataCommand extends ActiveWorkspacesComm
     }
   }
 
-  private mapFieldMetadata(
+  private updateRelationFieldMetadata(
+    joinColumnFieldMetadataCollection: FieldMetadataEntity<FieldMetadataType.UUID>[],
     fieldMetadata: FieldMetadataEntity<FieldMetadataType.RELATION>,
   ): FieldMetadataEntity<FieldMetadataType.RELATION> {
     const relationMetadata =
       fieldMetadata.fromRelationMetadata ?? fieldMetadata.toRelationMetadata;
+    const joinColumnFieldMetadata = joinColumnFieldMetadataCollection.find(
+      (joinColumnFieldMetadata) =>
+        joinColumnFieldMetadata.name === `${fieldMetadata.name}Id`,
+    );
 
     const relationDirection = deduceRelationDirection(
       fieldMetadata,
@@ -132,6 +153,7 @@ export class MigrateRelationsToFieldMetadataCommand extends ActiveWorkspacesComm
       settings: {
         relationType,
         onDelete: relationMetadata.onDeleteAction,
+        joinColumnName: joinColumnFieldMetadata?.name,
       },
       relationTargetFieldMetadataId,
       relationTargetObjectMetadataId,

packages/twenty-server/src/engine/api/graphql/graphql-query-runner/helpers/process-nested-relations-v2.helper.ts

@@ -1,5 +1,6 @@
 import { Injectable } from '@nestjs/common';
 
+import { FieldMetadataType } from 'twenty-shared';
 import {
   DataSource,
   FindOptionsRelations,
@@ -22,7 +23,7 @@ import { ObjectMetadataItemWithFieldMaps } from 'src/engine/metadata-modules/typ
 import { ObjectMetadataMaps } from 'src/engine/metadata-modules/types/object-metadata-maps';
 import { getObjectMetadataMapItemByNameSingular } from 'src/engine/metadata-modules/utils/get-object-metadata-map-item-by-name-singular.util';
 import { formatResult } from 'src/engine/twenty-orm/utils/format-result.util';
-import { isRelationFieldMetadata } from 'src/engine/utils/is-relation-field-metadata.util';
+import { isFieldMetadataOfType } from 'src/engine/utils/is-field-metadata-of-type.util';
 
 @Injectable()
 export class ProcessNestedRelationsV2Helper {
@@ -96,7 +97,9 @@ export class ProcessNestedRelationsV2Helper {
     const sourceFieldMetadata =
       parentObjectMetadataItem.fieldsByName[sourceFieldName];
 
-    if (!isRelationFieldMetadata(sourceFieldMetadata)) {
+    if (
+      !isFieldMetadataOfType(sourceFieldMetadata, FieldMetadataType.RELATION)
+    ) {
       // TODO: Maybe we should throw an error here ?
       return;
     }

packages/twenty-server/src/engine/api/graphql/workspace-query-runner/factories/query-result-getters/query-result-getters.factory.ts

@@ -1,6 +1,6 @@
 import { Injectable, Logger } from '@nestjs/common';
 
-import { isDefined } from 'twenty-shared';
+import { FieldMetadataType, isDefined } from 'twenty-shared';
 
 import { ObjectRecord } from 'src/engine/api/graphql/workspace-query-builder/interfaces/object-record.interface';
 import { QueryResultFieldValue } from 'src/engine/api/graphql/workspace-query-runner/factories/query-result-getters/interfaces/query-result-field-value';
@@ -22,7 +22,7 @@ import { FeatureFlagKey } from 'src/engine/core-modules/feature-flag/enums/featu
 import { FeatureFlagService } from 'src/engine/core-modules/feature-flag/services/feature-flag.service';
 import { FileService } from 'src/engine/core-modules/file/services/file.service';
 import { ObjectMetadataMaps } from 'src/engine/metadata-modules/types/object-metadata-maps';
-import { isRelationFieldMetadata } from 'src/engine/utils/is-relation-field-metadata.util';
+import { isFieldMetadataOfType } from 'src/engine/utils/is-field-metadata-of-type.util';
 
 // TODO: find a way to prevent conflict between handlers executing logic on object relations
 // And this factory that is also executing logic on object relations
@@ -150,7 +150,9 @@ export class QueryResultGettersFactory {
           objectMetadataMapItem.fieldsByName[recordFieldName],
       )
       .filter(isDefined)
-      .filter((fieldMetadata) => isRelationFieldMetadata(fieldMetadata));
+      .filter((fieldMetadata) =>
+        isFieldMetadataOfType(fieldMetadata, FieldMetadataType.RELATION),
+      );
 
     const relationFieldsProcessedMap = {} as Record<
       string,

packages/twenty-server/src/engine/api/graphql/workspace-schema-builder/factories/extend-object-type-definition-v2.factory.ts

@@ -5,6 +5,7 @@ import {
   GraphQLFieldConfigMap,
   GraphQLObjectType,
 } from 'graphql';
+import { FieldMetadataType } from 'twenty-shared';
 
 import { WorkspaceBuildSchemaOptions } from 'src/engine/api/graphql/workspace-schema-builder/interfaces/workspace-build-schema-optionts.interface';
 import { ObjectMetadataInterface } from 'src/engine/metadata-modules/field-metadata/interfaces/object-metadata.interface';
@@ -14,7 +15,7 @@ import { RelationTypeV2Factory } from 'src/engine/api/graphql/workspace-schema-b
 import { TypeDefinitionsStorage } from 'src/engine/api/graphql/workspace-schema-builder/storages/type-definitions.storage';
 import { getResolverArgs } from 'src/engine/api/graphql/workspace-schema-builder/utils/get-resolver-args.util';
 import { objectContainsRelationField } from 'src/engine/api/graphql/workspace-schema-builder/utils/object-contains-relation-field';
-import { isRelationFieldMetadata } from 'src/engine/utils/is-relation-field-metadata.util';
+import { isFieldMetadataOfType } from 'src/engine/utils/is-field-metadata-of-type.util';
 
 import { ArgsFactory } from './args.factory';
 
@@ -107,7 +108,7 @@ export class ExtendObjectTypeDefinitionV2Factory {
 
     for (const fieldMetadata of objectMetadata.fields) {
       // Ignore non-relation fields as they are already defined
-      if (!isRelationFieldMetadata(fieldMetadata)) {
+      if (!isFieldMetadataOfType(fieldMetadata, FieldMetadataType.RELATION)) {
         continue;
       }
 

packages/twenty-server/src/engine/metadata-modules/field-metadata/interfaces/field-metadata-settings.interface.ts

@@ -36,6 +36,7 @@ export type FieldMetadataDateTimeSettings = {
 export type FieldMetadataRelationSettings = {
   relationType: RelationType;
   onDelete?: RelationOnDeleteAction;
+  joinColumnName?: string;
 };
 
 type FieldMetadataSettingsMapping = {

packages/twenty-server/src/engine/utils/is-field-metadata-of-type.util.ts

@@ -0,0 +1,22 @@
+import { FieldMetadataType } from 'twenty-shared';
+
+import { FieldMetadataInterface } from 'src/engine/metadata-modules/field-metadata/interfaces/field-metadata.interface';
+
+import { FieldMetadataEntity } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
+
+export function isFieldMetadataOfType<T extends FieldMetadataType>(
+  fieldMetadata: FieldMetadataInterface<'default' | T>,
+  type: T,
+): fieldMetadata is FieldMetadataInterface<T>;
+export function isFieldMetadataOfType<T extends FieldMetadataType>(
+  fieldMetadata: FieldMetadataEntity<'default' | T>,
+  type: T,
+): fieldMetadata is FieldMetadataEntity<T>;
+export function isFieldMetadataOfType<T extends FieldMetadataType>(
+  fieldMetadata:
+    | FieldMetadataInterface<'default' | T>
+    | FieldMetadataEntity<'default' | T>,
+  type: T,
+): boolean {
+  return fieldMetadata.type === type;
+}