Files
twenty_crm/packages/twenty-server/src/engine/twenty-orm/utils/determine-schema-relation-details.util.ts
Marie 8c6569be3b Add relation exceptions (#12185)
Introducing a class of RelationException extending CustomException to
help grouping those exception in sentries by ExceptionCode.
I did not introduce a filter as these are thrown in utils that can be
used in multiple places now or in the future, and filters are to be
added at resolver-level.
2025-05-21 15:53:25 +02:00

76 lines
2.4 KiB
TypeScript

import { FieldMetadataType } from 'twenty-shared/types';
import { RelationType } from 'typeorm/metadata/types/RelationTypes';
import { FieldMetadataInterface } from 'src/engine/metadata-modules/field-metadata/interfaces/field-metadata.interface';
import { ObjectMetadataMaps } from 'src/engine/metadata-modules/types/object-metadata-maps';
import {
RelationException,
RelationExceptionCode,
} from 'src/engine/twenty-orm/exceptions/relation.exception';
import { converRelationTypeToTypeORMRelationType } from 'src/engine/twenty-orm/utils/convert-relation-type-to-typeorm-relation-type.util';
interface RelationDetails {
relationType: RelationType;
target: string;
inverseSide: string;
joinColumn: { name: string } | undefined;
}
export async function determineSchemaRelationDetails(
fieldMetadata: FieldMetadataInterface<FieldMetadataType.RELATION>,
objectMetadataMaps: ObjectMetadataMaps,
): Promise<RelationDetails> {
if (!fieldMetadata.settings) {
throw new Error('Field metadata settings are missing');
}
const relationType = converRelationTypeToTypeORMRelationType(
fieldMetadata.settings.relationType,
);
if (!fieldMetadata.relationTargetObjectMetadataId) {
throw new RelationException(
'Relation target object metadata ID is missing',
RelationExceptionCode.RELATION_OBJECT_METADATA_NOT_FOUND,
);
}
const sourceObjectMetadata =
objectMetadataMaps.byId[fieldMetadata.objectMetadataId];
const targetObjectMetadata =
objectMetadataMaps.byId[fieldMetadata.relationTargetObjectMetadataId];
if (!sourceObjectMetadata || !targetObjectMetadata) {
throw new RelationException(
`Object metadata not found for field ${fieldMetadata.id}`,
RelationExceptionCode.RELATION_OBJECT_METADATA_NOT_FOUND,
);
}
if (!fieldMetadata.relationTargetFieldMetadataId) {
throw new RelationException(
'Relation target field metadata ID is missing',
RelationExceptionCode.RELATION_TARGET_FIELD_METADATA_ID_NOT_FOUND,
);
}
const targetFieldMetadata =
targetObjectMetadata.fieldsById[
fieldMetadata.relationTargetFieldMetadataId
];
if (!targetFieldMetadata) {
throw new Error('Target field metadata not found');
}
return {
relationType,
target: targetObjectMetadata.nameSingular,
inverseSide: targetFieldMetadata.name,
joinColumn: fieldMetadata.settings.joinColumnName
? { name: fieldMetadata.settings.joinColumnName }
: undefined,
};
}