twenty_crm/packages/twenty-server/src/engine/twenty-orm/utils/get-join-column.util.ts

import { RelationType } from 'src/engine/metadata-modules/field-metadata/interfaces/relation-type.interface';
import { WorkspaceJoinColumnsMetadataArgs } from 'src/engine/twenty-orm/interfaces/workspace-join-columns-metadata-args.interface';
import { WorkspaceRelationMetadataArgs } from 'src/engine/twenty-orm/interfaces/workspace-relation-metadata-args.interface';

import {
  RelationException,
  RelationExceptionCode,
} from 'src/engine/twenty-orm/exceptions/relation.exception';
import { metadataArgsStorage } from 'src/engine/twenty-orm/storage/metadata-args.storage';

export const getJoinColumn = (
  joinColumnsMetadataArgsCollection: WorkspaceJoinColumnsMetadataArgs[],
  relationMetadataArgs: WorkspaceRelationMetadataArgs,
  opposite = false,
): string | null => {
  if (relationMetadataArgs.type === RelationType.ONE_TO_MANY) {
    return null;
  }

  const inverseSideTarget = relationMetadataArgs.inverseSideTarget();
  const inverseSideJoinColumnsMetadataArgsCollection =
    metadataArgsStorage.filterJoinColumns(inverseSideTarget);
  const filteredJoinColumnsMetadataArgsCollection =
    joinColumnsMetadataArgsCollection.filter(
      (joinColumnsMetadataArgs) =>
        joinColumnsMetadataArgs.relationName === relationMetadataArgs.name,
    );
  const oppositeFilteredJoinColumnsMetadataArgsCollection =
    inverseSideJoinColumnsMetadataArgsCollection.filter(
      (joinColumnsMetadataArgs) =>
        joinColumnsMetadataArgs.relationName === relationMetadataArgs.name,
    );

  if (
    filteredJoinColumnsMetadataArgsCollection.length > 0 &&
    oppositeFilteredJoinColumnsMetadataArgsCollection.length > 0
  ) {
    throw new RelationException(
      `Join column for ${relationMetadataArgs.name} relation is present on both sides`,
      RelationExceptionCode.RELATION_JOIN_COLUMN_ON_BOTH_SIDES,
    );
  }

  // If we're in a ONE_TO_ONE relation and there are no join columns, we need to find the join column on the inverse side
  if (
    relationMetadataArgs.type === RelationType.ONE_TO_ONE &&
    filteredJoinColumnsMetadataArgsCollection.length === 0 &&
    !opposite
  ) {
    const inverseSideRelationMetadataArgsCollection =
      metadataArgsStorage.filterRelations(inverseSideTarget);
    const inverseSideRelationMetadataArgs =
      inverseSideRelationMetadataArgsCollection.find(
        (inverseSideRelationMetadataArgs) =>
          inverseSideRelationMetadataArgs.inverseSideFieldKey ===
          relationMetadataArgs.name,
      );

    if (!inverseSideRelationMetadataArgs) {
      throw new RelationException(
        `Inverse side join column of relation ${relationMetadataArgs.name} is missing`,
        RelationExceptionCode.MISSING_RELATION_JOIN_COLUMN,
      );
    }

    return getJoinColumn(
      inverseSideJoinColumnsMetadataArgsCollection,
      inverseSideRelationMetadataArgs,
      // Avoid infinite recursion
      true,
    );
  }

  // Check if there are multiple join columns for the relation
  if (filteredJoinColumnsMetadataArgsCollection.length > 1) {
    throw new RelationException(
      `Multiple join columns found for relation ${relationMetadataArgs.name}`,
      RelationExceptionCode.MULTIPLE_JOIN_COLUMNS_FOUND,
    );
  }

  const joinColumnsMetadataArgs = filteredJoinColumnsMetadataArgsCollection[0];

  if (!joinColumnsMetadataArgs) {
    throw new RelationException(
      `Join column is missing for relation ${relationMetadataArgs.name}`,
      RelationExceptionCode.MISSING_RELATION_JOIN_COLUMN,
    );
  }

  return joinColumnsMetadataArgs.joinColumn;
};