twenty/packages/twenty-server/src/engine/utils/__tests__/deduce-relation-direction.spec.ts

import { FieldMetadataType } from 'twenty-shared';

import { FieldMetadataInterface } from 'src/engine/metadata-modules/field-metadata/interfaces/field-metadata.interface';
import { RelationMetadataInterface } from 'src/engine/metadata-modules/field-metadata/interfaces/relation-metadata.interface';

import { RelationMetadataType } from 'src/engine/metadata-modules/relation-metadata/relation-metadata.entity';
import {
  deduceRelationDirection,
  RelationDirection,
} from 'src/engine/utils/deduce-relation-direction.util';

describe('deduceRelationDirection', () => {
  it('should return FROM when the current object Metadata ID matches fromObjectMetadataId and id matches fromFieldMetadataId', () => {
    const fieldMetadata: FieldMetadataInterface = {
      id: 'field_id',
      objectMetadataId: 'from_object_id',
      type: FieldMetadataType.RELATION,
      name: 'field_name',
      label: 'Field Name',
      description: 'Field Description',
    };

    const relationMetadata = {
      id: 'relation_id',
      fromObjectMetadataId: fieldMetadata.objectMetadataId,
      toObjectMetadataId: 'to_object_id',
      fromFieldMetadataId: fieldMetadata.id,
      toFieldMetadataId: 'to_field_id',
      relationType: RelationMetadataType.ONE_TO_ONE,
    };

    const result = deduceRelationDirection(
      fieldMetadata,
      relationMetadata as RelationMetadataInterface,
    );

    expect(result).toBe(RelationDirection.FROM);
  });

  it('should return TO when the current object Metadata ID matches toObjectMetadataId and id matches toFieldMetadataId', () => {
    // Arrange
    const fieldMetadata: FieldMetadataInterface = {
      id: 'field_id',
      objectMetadataId: 'to_object_id',
      type: FieldMetadataType.RELATION,
      name: 'field_name',
      label: 'Field Name',
      description: 'Field Description',
    };

    const relationMetadata = {
      id: 'relation_id',
      fromObjectMetadataId: 'from_object_id',
      toObjectMetadataId: fieldMetadata.objectMetadataId,
      fromFieldMetadataId: 'from_field_id',
      toFieldMetadataId: fieldMetadata.id,
      relationType: RelationMetadataType.ONE_TO_ONE,
    };

    const result = deduceRelationDirection(
      fieldMetadata,
      relationMetadata as RelationMetadataInterface,
    );

    expect(result).toBe(RelationDirection.TO);
  });

  it('should throw an error when the current object Metadata ID does not match any object metadata ID', () => {
    const fieldMetadata: FieldMetadataInterface = {
      id: 'field_id',
      objectMetadataId: 'unrelated_object_id',
      type: FieldMetadataType.RELATION,
      name: 'field_name',
      label: 'Field Name',
      description: 'Field Description',
    };

    const relationMetadata = {
      id: 'relation_id',
      fromObjectMetadataId: 'from_object_id',
      toObjectMetadataId: 'to_object_id',
      fromFieldMetadataId: 'from_field_id',
      toFieldMetadataId: 'to_field_id',
      relationType: RelationMetadataType.ONE_TO_ONE,
    };

    expect(() =>
      deduceRelationDirection(
        fieldMetadata,
        relationMetadata as RelationMetadataInterface,
      ),
    ).toThrow(
      `Relation metadata ${relationMetadata.id} is not related to object ${fieldMetadata.objectMetadataId}`,
    );
  });
});