feat: manually implement joinColumn (#6022)

This PR introduce a new decorator named `@WorkspaceJoinColumn`, the goal
of this one is to manually declare the join columns inside the workspace
entities, so we don't have to rely on `ObjectRecord` type.

This decorator can be used that way:

```typescript
  @WorkspaceRelation({
    standardId: ACTIVITY_TARGET_STANDARD_FIELD_IDS.company,
    type: RelationMetadataType.MANY_TO_ONE,
    label: 'Company',
    description: 'ActivityTarget company',
    icon: 'IconBuildingSkyscraper',
    inverseSideTarget: () => CompanyWorkspaceEntity,
    inverseSideFieldKey: 'activityTargets',
  })
  @WorkspaceIsNullable()
  company: Relation<CompanyWorkspaceEntity> | null;

  // The argument is the name of the relation above
  @WorkspaceJoinColumn('company')
  companyId: string | null;
```

packages/twenty-server/src/engine/twenty-orm/factories/entity-schema-column.factory.ts

@@ -4,6 +4,7 @@ import { ColumnType, EntitySchemaColumnOptions } from 'typeorm';
 
 import { WorkspaceFieldMetadataArgs } from 'src/engine/twenty-orm/interfaces/workspace-field-metadata-args.interface';
 import { WorkspaceRelationMetadataArgs } from 'src/engine/twenty-orm/interfaces/workspace-relation-metadata-args.interface';
+import { WorkspaceJoinColumnsMetadataArgs } from 'src/engine/twenty-orm/interfaces/workspace-join-columns-metadata-args.interface';
 
 import { fieldMetadataTypeToColumnType } from 'src/engine/metadata-modules/workspace-migration/utils/field-metadata-type-to-column-type.util';
 import { isEnumFieldMetadataType } from 'src/engine/metadata-modules/field-metadata/utils/is-enum-field-metadata-type.util';
@@ -12,6 +13,7 @@ import { computeCompositeColumnName } from 'src/engine/metadata-modules/field-me
 import { isCompositeFieldMetadataType } from 'src/engine/metadata-modules/field-metadata/utils/is-composite-field-metadata-type.util';
 import { compositeTypeDefintions } from 'src/engine/metadata-modules/field-metadata/composite-types';
 import { FieldMetadataType } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
+import { getJoinColumn } from 'src/engine/twenty-orm/utils/get-join-column.util';
 
 type EntitySchemaColumnMap = {
   [key: string]: EntitySchemaColumnOptions;
@@ -22,6 +24,7 @@ export class EntitySchemaColumnFactory {
   create(
     fieldMetadataArgsCollection: WorkspaceFieldMetadataArgs[],
     relationMetadataArgsCollection: WorkspaceRelationMetadataArgs[],
+    joinColumnsMetadataArgsCollection: WorkspaceJoinColumnsMetadataArgs[],
   ): EntitySchemaColumnMap {
     let entitySchemaColumnMap: EntitySchemaColumnMap = {};
 
@@ -56,9 +59,14 @@ export class EntitySchemaColumnFactory {
       };
 
       for (const relationMetadataArgs of relationMetadataArgsCollection) {
-        if (relationMetadataArgs.joinColumn) {
-          entitySchemaColumnMap[relationMetadataArgs.joinColumn] = {
-            name: relationMetadataArgs.joinColumn,
+        const joinColumn = getJoinColumn(
+          joinColumnsMetadataArgsCollection,
+          relationMetadataArgs,
+        );
+
+        if (joinColumn) {
+          entitySchemaColumnMap[joinColumn] = {
+            name: joinColumn,
             type: 'uuid',
             nullable: relationMetadataArgs.isNullable,
           };

packages/twenty-server/src/engine/twenty-orm/factories/entity-schema-relation.factory.ts

@@ -4,9 +4,11 @@ import { EntitySchemaRelationOptions } from 'typeorm';
 import { RelationType } from 'typeorm/metadata/types/RelationTypes';
 
 import { WorkspaceRelationMetadataArgs } from 'src/engine/twenty-orm/interfaces/workspace-relation-metadata-args.interface';
+import { WorkspaceJoinColumnsMetadataArgs } from 'src/engine/twenty-orm/interfaces/workspace-join-columns-metadata-args.interface';
 
 import { convertClassNameToObjectMetadataName } from 'src/engine/workspace-manager/workspace-sync-metadata/utils/convert-class-to-object-metadata-name.util';
 import { RelationMetadataType } from 'src/engine/metadata-modules/relation-metadata/relation-metadata.entity';
+import { getJoinColumn } from 'src/engine/twenty-orm/utils/get-join-column.util';
 
 type EntitySchemaRelationMap = {
   [key: string]: EntitySchemaRelationOptions;
@@ -18,6 +20,7 @@ export class EntitySchemaRelationFactory {
     // eslint-disable-next-line @typescript-eslint/ban-types
     target: Function,
     relationMetadataArgsCollection: WorkspaceRelationMetadataArgs[],
+    joinColumnsMetadataArgsCollection: WorkspaceJoinColumnsMetadataArgs[],
   ): EntitySchemaRelationMap {
     const entitySchemaRelationMap: EntitySchemaRelationMap = {};
 
@@ -27,16 +30,19 @@ export class EntitySchemaRelationFactory {
       const oppositeObjectName = convertClassNameToObjectMetadataName(
         oppositeTarget.name,
       );
-
       const relationType = this.getRelationType(relationMetadataArgs);
+      const joinColumn = getJoinColumn(
+        joinColumnsMetadataArgsCollection,
+        relationMetadataArgs,
+      );
 
       entitySchemaRelationMap[relationMetadataArgs.name] = {
         type: relationType,
         target: oppositeObjectName,
         inverseSide: relationMetadataArgs.inverseSideFieldKey ?? objectName,
-        joinColumn: relationMetadataArgs.joinColumn
+        joinColumn: joinColumn
           ? {
-              name: relationMetadataArgs.joinColumn,
+              name: joinColumn,
             }
           : undefined,
       };

packages/twenty-server/src/engine/twenty-orm/factories/entity-schema.factory.ts

@@ -23,17 +23,21 @@ export class EntitySchemaFactory {
 
     const fieldMetadataArgsCollection =
       metadataArgsStorage.filterFields(target);
+    const joinColumnsMetadataArgsCollection =
+      metadataArgsStorage.filterJoinColumns(target);
     const relationMetadataArgsCollection =
       metadataArgsStorage.filterRelations(target);
 
     const columns = this.entitySchemaColumnFactory.create(
       fieldMetadataArgsCollection,
       relationMetadataArgsCollection,
+      joinColumnsMetadataArgsCollection,
     );
 
     const relations = this.entitySchemaRelationFactory.create(
       target,
       relationMetadataArgsCollection,
+      joinColumnsMetadataArgsCollection,
     );
 
     const entitySchema = new EntitySchema({