typeorm
Version:
Data-Mapper ORM for TypeScript and ES2021+. Supports MySQL/MariaDB, PostgreSQL, MS SQL Server, Oracle, SAP HANA, SQLite, MongoDB databases.
186 lines (184 loc) • 9 kB
JavaScript
import { FindRelationsNotFoundError } from "../error";
import { DriverUtils } from "../driver/DriverUtils";
import { EntityPropertyNotFoundError } from "../error";
/**
* Utilities to work with FindOptions.
*/
export class FindOptionsUtils {
// -------------------------------------------------------------------------
// Public Static Methods
// -------------------------------------------------------------------------
/**
* Checks if given object is really instance of FindOneOptions interface.
*/
static isFindOneOptions(obj) {
const possibleOptions = obj;
return (possibleOptions &&
(Array.isArray(possibleOptions.select) ||
Array.isArray(possibleOptions.relations) ||
typeof possibleOptions.select === "object" ||
typeof possibleOptions.relations === "object" ||
typeof possibleOptions.where === "object" ||
// typeof possibleOptions.where === "string" ||
typeof possibleOptions.join === "object" ||
typeof possibleOptions.order === "object" ||
typeof possibleOptions.cache === "object" ||
typeof possibleOptions.cache === "boolean" ||
typeof possibleOptions.cache === "number" ||
typeof possibleOptions.comment === "string" ||
typeof possibleOptions.lock === "object" ||
typeof possibleOptions.loadRelationIds === "object" ||
typeof possibleOptions.loadRelationIds === "boolean" ||
typeof possibleOptions.loadEagerRelations === "boolean" ||
typeof possibleOptions.withDeleted === "boolean" ||
typeof possibleOptions.relationLoadStrategy === "string" ||
typeof possibleOptions.transaction === "boolean"));
}
/**
* Checks if given object is really instance of FindManyOptions interface.
*/
static isFindManyOptions(obj) {
const possibleOptions = obj;
return (possibleOptions &&
(this.isFindOneOptions(possibleOptions) ||
typeof possibleOptions.skip ===
"number" ||
typeof possibleOptions.take ===
"number" ||
typeof possibleOptions.skip ===
"string" ||
typeof possibleOptions.take ===
"string"));
}
/**
* Checks if given object is really instance of FindOptions interface.
*/
static extractFindManyOptionsAlias(object) {
if (this.isFindManyOptions(object) && object.join)
return object.join.alias;
return undefined;
}
static applyOptionsToTreeQueryBuilder(qb, options) {
if (options?.relations) {
// Copy because `applyRelationsRecursively` modifies it
const allRelations = [...options.relations];
FindOptionsUtils.applyRelationsRecursively(qb, allRelations, qb.expressionMap.mainAlias.name, qb.expressionMap.mainAlias.metadata, "");
// recursive removes found relations from allRelations array
// if there are relations left in this array it means those relations were not found in the entity structure
// so, we give an exception about not found relations
if (allRelations.length > 0)
throw new FindRelationsNotFoundError(allRelations);
}
return qb;
}
// -------------------------------------------------------------------------
// Protected Static Methods
// -------------------------------------------------------------------------
/**
* Adds joins for all relations and sub-relations of the given relations provided in the find options.
*/
static applyRelationsRecursively(qb, allRelations, alias, metadata, prefix) {
// find all relations that match given prefix
let matchedBaseRelations = [];
if (prefix) {
const regexp = new RegExp("^" + prefix.replace(".", "\\.") + "\\.");
matchedBaseRelations = allRelations
.filter((relation) => relation.match(regexp))
.map((relation) => metadata.findRelationWithPropertyPath(relation.replace(regexp, "")))
.filter((entity) => entity);
}
else {
matchedBaseRelations = allRelations
.map((relation) => metadata.findRelationWithPropertyPath(relation))
.filter((entity) => entity);
}
// go through all matched relations and add join for them
matchedBaseRelations.forEach((relation) => {
// generate a relation alias
const relationAlias = DriverUtils.buildAlias(qb.connection.driver, { joiner: "__" }, alias, relation.propertyPath);
// add a join for the found relation
const selection = alias + "." + relation.propertyPath;
if (qb.expressionMap.relationLoadStrategy === "query") {
qb.concatRelationMetadata(relation);
}
else {
qb.leftJoinAndSelect(selection, relationAlias);
}
// remove added relations from the allRelations array, this is needed to find all not found relations at the end
allRelations.splice(allRelations.indexOf(prefix
? prefix + "." + relation.propertyPath
: relation.propertyPath), 1);
// try to find sub-relations
let relationMetadata;
let relationName;
if (qb.expressionMap.relationLoadStrategy === "query") {
relationMetadata = relation.inverseEntityMetadata;
relationName = relationAlias;
}
else {
const join = qb.expressionMap.joinAttributes.find((join) => join.entityOrProperty === selection);
relationMetadata = join.metadata;
relationName = join.alias.name;
}
if (!relationName || !relationMetadata) {
throw new EntityPropertyNotFoundError(relation.propertyPath, metadata);
}
this.applyRelationsRecursively(qb, allRelations, relationName, relationMetadata, prefix
? prefix + "." + relation.propertyPath
: relation.propertyPath);
// join the eager relations of the found relation
// Only supported for "join" relationLoadStrategy
if (qb.expressionMap.relationLoadStrategy === "join") {
const relMetadata = metadata.relations.find((metadata) => metadata.propertyName === relation.propertyPath);
if (relMetadata) {
this.joinEagerRelations(qb, relationAlias, relMetadata.inverseEntityMetadata);
}
}
});
}
static joinEagerRelations(qb, alias, metadata) {
metadata.eagerRelations.forEach((relation) => {
// generate a relation alias
let relationAlias = DriverUtils.buildAlias(qb.connection.driver, { joiner: "__" }, alias, relation.propertyName);
// add a join for the relation
// Checking whether the relation wasn't joined yet.
let addJoin = true;
// TODO: Review this validation
for (const join of qb.expressionMap.joinAttributes) {
if (join.condition !== undefined ||
join.mapToProperty !== undefined ||
join.isMappingMany !== undefined ||
join.direction !== "LEFT" ||
join.entityOrProperty !==
`${alias}.${relation.propertyPath}`) {
continue;
}
addJoin = false;
relationAlias = join.alias.name;
break;
}
const joinAlreadyAdded = Boolean(qb.expressionMap.joinAttributes.find((joinAttribute) => joinAttribute.alias.name === relationAlias));
if (addJoin && !joinAlreadyAdded) {
qb.leftJoin(alias + "." + relation.propertyPath, relationAlias);
}
// Checking whether the relation wasn't selected yet.
// This check shall be after the join check to detect relationAlias.
let addSelect = true;
for (const select of qb.expressionMap.selects) {
if (select.aliasName !== undefined ||
select.virtual !== undefined ||
select.selection !== relationAlias) {
continue;
}
addSelect = false;
break;
}
if (addSelect) {
qb.addSelect(relationAlias);
}
// (recursive) join the eager relations
this.joinEagerRelations(qb, relationAlias, relation.inverseEntityMetadata);
});
}
}
//# sourceMappingURL=FindOptionsUtils.js.map