'use strict'; const _ = require('lodash/fp'); const types = require('./types'); const { createField } = require('./fields'); const { createQueryBuilder } = require('./query'); const { createRepository } = require('./entity-repository'); const { isBidirectional, isOneToAny } = require('./metadata/relations'); const toId = value => value.id || value; const toIds = value => _.castArray(value || []).map(toId); const isValidId = value => _.isString(value) || _.isInteger(value); const toAssocs = data => { return _.castArray(data) .filter(datum => !_.isNil(datum)) .map(datum => { // if it is a string or an integer return an obj with id = to datum if (isValidId(datum)) { return { id: datum, __pivot: {} }; } // if it is an object check it has at least a valid id if (!_.has('id', datum) || !isValidId(datum.id)) { throw new Error(`Invalid id, expected a string or integer, got ${datum}`); } return datum; }); }; // TODO: handle programmatic defaults const toRow = (metadata, data = {}, { withDefaults = false } = {}) => { const { attributes } = metadata; const obj = {}; for (const attributeName in attributes) { const attribute = attributes[attributeName]; // TODO: convert to column name if (types.isScalar(attribute.type)) { const field = createField(attribute); if (_.isUndefined(data[attributeName])) { if (!_.isUndefined(attribute.default) && withDefaults) { if (typeof attribute.default === 'function') { obj[attributeName] = attribute.default(); } else { obj[attributeName] = attribute.default; } } continue; } if (typeof field.validate === 'function' && data[attributeName] !== null) { field.validate(data[attributeName]); } const val = data[attributeName] === null ? null : field.toDB(data[attributeName]); obj[attributeName] = val; } if (types.isRelation(attribute.type)) { // oneToOne & manyToOne if (attribute.joinColumn && attribute.owner) { // TODO: ensure joinColumn name respect convention ? const joinColumnName = attribute.joinColumn.name; // allow setting to null const attrValue = !_.isUndefined(data[attributeName]) ? data[attributeName] : data[joinColumnName]; if (!_.isUndefined(attrValue)) { obj[joinColumnName] = attrValue; } continue; } if (attribute.morphColumn && attribute.owner) { const { idColumn, typeColumn, typeField = '__type' } = attribute.morphColumn; const value = data[attributeName]; if (value === null) { Object.assign(obj, { [idColumn.name]: null, [typeColumn.name]: null, }); continue; } if (!_.isUndefined(value)) { if (!_.has('id', value) || !_.has(typeField, value)) { throw new Error(`Expects properties ${typeField} an id to make a morph association`); } Object.assign(obj, { [idColumn.name]: value.id, [typeColumn.name]: value[typeField], }); } } } } return obj; }; const createEntityManager = db => { const repoMap = {}; return { async findOne(uid, params) { await db.lifecycles.run('beforeFindOne', uid, { params }); const result = await this.createQueryBuilder(uid) .init(params) .first() .execute(); await db.lifecycles.run('afterFindOne', uid, { params, result }); return result; }, // should we name it findOne because people are used to it ? async findMany(uid, params) { await db.lifecycles.run('beforeFindMany', uid, { params }); const result = await this.createQueryBuilder(uid) .init(params) .execute(); await db.lifecycles.run('afterFindMany', uid, { params, result }); return result; }, async count(uid, params = {}) { await db.lifecycles.run('beforeCount', uid, { params }); const res = await this.createQueryBuilder(uid) .init(_.pick(['_q', 'where'], params)) .count() .first() .execute(); const result = Number(res.count); await db.lifecycles.run('afterCount', uid, { params, result }); return result; }, async create(uid, params = {}) { await db.lifecycles.run('beforeCreate', uid, { params }); const metadata = db.metadata.get(uid); const { data } = params; if (!_.isPlainObject(data)) { throw new Error('Create expects a data object'); } const dataToInsert = toRow(metadata, data, { withDefaults: true }); const [id] = await this.createQueryBuilder(uid) .insert(dataToInsert) .execute(); await this.attachRelations(uid, id, data); // TODO: in case there is not select or populate specified return the inserted data ? // TODO: do not trigger the findOne lifecycles ? const result = await this.findOne(uid, { where: { id }, select: params.select, populate: params.populate, }); await db.lifecycles.run('afterCreate', uid, { params, result }); return result; }, // TODO: where do we handle relation processing for many queries ? async createMany(uid, params = {}) { await db.lifecycles.run('beforeCreateMany', uid, { params }); const metadata = db.metadata.get(uid); const { data } = params; if (!_.isArray(data)) { throw new Error('CreateMany expects data to be an array'); } const dataToInsert = data.map(datum => toRow(metadata, datum, { withDefaults: true })); if (_.isEmpty(dataToInsert)) { throw new Error('Nothing to insert'); } await this.createQueryBuilder(uid) .insert(dataToInsert) .execute(); const result = { count: data.length }; await db.lifecycles.run('afterCreateMany', uid, { params, result }); return result; }, async update(uid, params = {}) { await db.lifecycles.run('beforeUpdate', uid, { params }); const metadata = db.metadata.get(uid); const { where, data } = params; if (!_.isPlainObject(data)) { throw new Error('Update requires a data object'); } if (_.isEmpty(where)) { throw new Error('Update requires a where parameter'); } const entity = await this.createQueryBuilder(uid) .select('id') .where(where) .first() .execute(); if (!entity) { return null; } const { id } = entity; const dataToUpdate = toRow(metadata, data); if (!_.isEmpty(dataToUpdate)) { await this.createQueryBuilder(uid) .where({ id }) .update(dataToUpdate) .execute(); } await this.updateRelations(uid, id, data); // TODO: do not trigger the findOne lifecycles ? const result = await this.findOne(uid, { where: { id }, select: params.select, populate: params.populate, }); await db.lifecycles.run('afterUpdate', uid, { params, result }); return result; }, // TODO: where do we handle relation processing for many queries ? async updateMany(uid, params = {}) { await db.lifecycles.run('beforeUpdateMany', uid, { params }); const metadata = db.metadata.get(uid); const { where, data } = params; const dataToUpdate = toRow(metadata, data); if (_.isEmpty(dataToUpdate)) { throw new Error('Update requires data'); } const updatedRows = await this.createQueryBuilder(uid) .where(where) .update(dataToUpdate) .execute(); const result = { count: updatedRows }; await db.lifecycles.run('afterUpdateMany', uid, { params, result }); return result; }, async delete(uid, params = {}) { await db.lifecycles.run('beforeDelete', uid, { params }); const { where, select, populate } = params; if (_.isEmpty(where)) { throw new Error('Delete requires a where parameter'); } // TODO: avoid trigger the findOne lifecycles in the case ? const entity = await this.findOne(uid, { select: select && ['id'].concat(select), where, populate, }); if (!entity) { return null; } const { id } = entity; await this.createQueryBuilder(uid) .where({ id }) .delete() .execute(); await this.deleteRelations(uid, id); await db.lifecycles.run('afterDelete', uid, { params, result: entity }); return entity; }, // TODO: where do we handle relation processing for many queries ? async deleteMany(uid, params = {}) { await db.lifecycles.run('beforeDeleteMany', uid, { params }); const { where } = params; const deletedRows = await this.createQueryBuilder(uid) .where(where) .delete() .execute(); const result = { count: deletedRows }; await db.lifecycles.run('afterDelete', uid, { params, result }); return result; }, /** * Attach relations to a new entity * * @param {EntityManager} em - entity manager instance * @param {Metadata} metadata - model metadta * @param {ID} id - entity ID * @param {object} data - data received for creation */ // TODO: wrap Transaction async attachRelations(uid, id, data) { const { attributes } = db.metadata.get(uid); for (const attributeName in attributes) { const attribute = attributes[attributeName]; const isValidLink = _.has(attributeName, data) && !_.isNil(data[attributeName]); if (attribute.type !== 'relation' || !isValidLink) { continue; } if (attribute.relation === 'morphOne' || attribute.relation === 'morphMany') { const { target, morphBy } = attribute; const targetAttribute = db.metadata.get(target).attributes[morphBy]; if (targetAttribute.relation === 'morphToOne') { // set columns const { idColumn, typeColumn } = targetAttribute.morphColumn; await this.createQueryBuilder(target) .update({ [idColumn.name]: id, [typeColumn.name]: uid }) .where({ id: toId(data[attributeName]) }) .execute(); } else if (targetAttribute.relation === 'morphToMany') { const { joinTable } = targetAttribute; const { joinColumn, morphColumn } = joinTable; const { idColumn, typeColumn } = morphColumn; const rows = toAssocs(data[attributeName]).map((data, idx) => { return { [joinColumn.name]: data.id, [idColumn.name]: id, [typeColumn.name]: uid, ...(joinTable.on || {}), ...(data.__pivot || {}), order: idx + 1, field: attributeName, }; }); if (_.isEmpty(rows)) { continue; } await this.createQueryBuilder(joinTable.name) .insert(rows) .execute(); } continue; } else if (attribute.relation === 'morphToOne') { // handled on the entry itself continue; } else if (attribute.relation === 'morphToMany') { const { joinTable } = attribute; const { joinColumn, morphColumn } = joinTable; const { idColumn, typeColumn, typeField = '__type' } = morphColumn; const rows = toAssocs(data[attributeName]).map(data => ({ [joinColumn.name]: id, [idColumn.name]: data.id, [typeColumn.name]: data[typeField], ...(joinTable.on || {}), ...(data.__pivot || {}), })); if (_.isEmpty(rows)) { continue; } await this.createQueryBuilder(joinTable.name) .insert(rows) .execute(); continue; } if (attribute.joinColumn && attribute.owner) { if ( attribute.relation === 'oneToOne' && isBidirectional(attribute) && data[attributeName] ) { await this.createQueryBuilder(uid) .where({ [attribute.joinColumn.name]: data[attributeName], id: { $ne: id } }) .update({ [attribute.joinColumn.name]: null }) .execute(); } continue; } // oneToOne oneToMany on the non owning side if (attribute.joinColumn && !attribute.owner) { // need to set the column on the target const { target } = attribute; // TODO: check it is an id & the entity exists (will throw due to FKs otherwise so not a big pbl in SQL) await this.createQueryBuilder(target) .where({ [attribute.joinColumn.referencedColumn]: id }) .update({ [attribute.joinColumn.referencedColumn]: null }) .execute(); await this.createQueryBuilder(target) .update({ [attribute.joinColumn.referencedColumn]: id }) // NOTE: works if it is an array or a single id .where({ id: data[attributeName] }) .execute(); } if (attribute.joinTable) { // need to set the column on the target const { joinTable } = attribute; const { joinColumn, inverseJoinColumn } = joinTable; // TODO: validate logic of delete if (isOneToAny(attribute) && isBidirectional(attribute)) { await this.createQueryBuilder(joinTable.name) .delete() .where({ [inverseJoinColumn.name]: _.castArray(data[attributeName]) }) .where(joinTable.on || {}) .execute(); } const insert = toAssocs(data[attributeName]).map(data => { return { [joinColumn.name]: id, [inverseJoinColumn.name]: data.id, ...(joinTable.on || {}), ...(data.__pivot || {}), }; }); // if there is nothing to insert if (insert.length === 0) { continue; } await this.createQueryBuilder(joinTable.name) .insert(insert) .execute(); } } }, /** * Updates relations of an existing entity * * @param {EntityManager} em - entity manager instance * @param {Metadata} metadata - model metadta * @param {ID} id - entity ID * @param {object} data - data received for creation */ // TODO: check relation exists (handled by FKs except for polymorphics) // TODO: wrap Transaction async updateRelations(uid, id, data) { const { attributes } = db.metadata.get(uid); for (const attributeName in attributes) { const attribute = attributes[attributeName]; if (attribute.type !== 'relation' || !_.has(attributeName, data)) { continue; } if (attribute.relation === 'morphOne' || attribute.relation === 'morphMany') { const { target, morphBy } = attribute; const targetAttribute = db.metadata.get(target).attributes[morphBy]; if (targetAttribute.relation === 'morphToOne') { // set columns const { idColumn, typeColumn } = targetAttribute.morphColumn; await this.createQueryBuilder(target) .update({ [idColumn.name]: null, [typeColumn.name]: null }) .where({ [idColumn.name]: id, [typeColumn.name]: uid }) .execute(); if (!_.isNull(data[attributeName])) { await this.createQueryBuilder(target) .update({ [idColumn.name]: id, [typeColumn.name]: uid }) .where({ id: toId(data[attributeName]) }) .execute(); } } else if (targetAttribute.relation === 'morphToMany') { const { joinTable } = targetAttribute; const { joinColumn, morphColumn } = joinTable; const { idColumn, typeColumn } = morphColumn; await this.createQueryBuilder(joinTable.name) .delete() .where({ [idColumn.name]: id, [typeColumn.name]: uid, ...(joinTable.on || {}), field: attributeName, }) .execute(); const rows = toAssocs(data[attributeName]).map((data, idx) => ({ [joinColumn.name]: data.id, [idColumn.name]: id, [typeColumn.name]: uid, ...(joinTable.on || {}), ...(data.__pivot || {}), order: idx + 1, field: attributeName, })); if (_.isEmpty(rows)) { continue; } await this.createQueryBuilder(joinTable.name) .insert(rows) .execute(); } continue; } if (attribute.relation === 'morphToOne') { // handled on the entry itself continue; } if (attribute.relation === 'morphToMany') { const { joinTable } = attribute; const { joinColumn, morphColumn } = joinTable; const { idColumn, typeColumn, typeField = '__type' } = morphColumn; await this.createQueryBuilder(joinTable.name) .delete() .where({ [joinColumn.name]: id, ...(joinTable.on || {}), }) .execute(); const rows = toAssocs(data[attributeName]).map(data => ({ [joinColumn.name]: id, [idColumn.name]: data.id, [typeColumn.name]: data[typeField], ...(joinTable.on || {}), ...(data.__pivot || {}), })); if (_.isEmpty(rows)) { continue; } await this.createQueryBuilder(joinTable.name) .insert(rows) .execute(); continue; } if (attribute.joinColumn && attribute.owner) { // handled in the row itslef continue; } // oneToOne oneToMany on the non owning side. // Since it is a join column no need to remove previous relations if (attribute.joinColumn && !attribute.owner) { // need to set the column on the target const { target } = attribute; await this.createQueryBuilder(target) .where({ [attribute.joinColumn.referencedColumn]: id }) .update({ [attribute.joinColumn.referencedColumn]: null }) .execute(); if (!_.isNull(data[attributeName])) { await this.createQueryBuilder(target) // NOTE: works if it is an array or a single id .where({ id: data[attributeName] }) .update({ [attribute.joinColumn.referencedColumn]: id }) .execute(); } } if (attribute.joinTable) { const { joinTable } = attribute; const { joinColumn, inverseJoinColumn } = joinTable; // clear previous associations in the joinTable await this.createQueryBuilder(joinTable.name) .delete() .where({ [joinColumn.name]: id }) .where(joinTable.on || {}) .execute(); if (['oneToOne', 'oneToMany'].includes(attribute.relation)) { await this.createQueryBuilder(joinTable.name) .delete() .where({ [inverseJoinColumn.name]: toIds(data[attributeName]) }) .where(joinTable.on || {}) .execute(); } if (!_.isNull(data[attributeName])) { const insert = toAssocs(data[attributeName]).map(data => { return { [joinColumn.name]: id, [inverseJoinColumn.name]: data.id, ...(joinTable.on || {}), ...(data.__pivot || {}), }; }); // if there is nothing to insert if (insert.length === 0) { continue; } await this.createQueryBuilder(joinTable.name) .insert(insert) .execute(); } } } }, /** * Delete relational associations of an existing entity * This removes associations but doesn't do cascade deletions for components for example. This will be handled on the entity service layer instead * NOTE: Most of the deletion should be handled by ON DELETE CASCADE for dialects that have FKs * * @param {EntityManager} em - entity manager instance * @param {Metadata} metadata - model metadta * @param {ID} id - entity ID */ // TODO: wrap Transaction async deleteRelations(uid, id) { const { attributes } = db.metadata.get(uid); for (const attributeName in attributes) { const attribute = attributes[attributeName]; if (attribute.type !== 'relation') { continue; } /* if morphOne | morphMany if morphBy is morphToOne set null if morphBy is morphToOne delete links */ if (attribute.relation === 'morphOne' || attribute.relation === 'morphMany') { const { target, morphBy } = attribute; const targetAttribute = db.metadata.get(target).attributes[morphBy]; if (targetAttribute.relation === 'morphToOne') { // set columns const { idColumn, typeColumn } = targetAttribute.morphColumn; await this.createQueryBuilder(target) .update({ [idColumn.name]: null, [typeColumn.name]: null }) .where({ [idColumn.name]: id, [typeColumn.name]: uid }) .execute(); } else if (targetAttribute.relation === 'morphToMany') { const { joinTable } = targetAttribute; const { morphColumn } = joinTable; const { idColumn, typeColumn } = morphColumn; await this.createQueryBuilder(joinTable.name) .delete() .where({ [idColumn.name]: id, [typeColumn.name]: uid, ...(joinTable.on || {}), field: attributeName, }) .execute(); } continue; } /* if morphToOne nothing to do */ if (attribute.relation === 'morphToOne') { // do nothing } /* if morphToMany delete links */ if (attribute.relation === 'morphToMany') { const { joinTable } = attribute; const { joinColumn } = joinTable; await this.createQueryBuilder(joinTable.name) .delete() .where({ [joinColumn.name]: id, ...(joinTable.on || {}), }) .execute(); continue; } if (db.dialect.usesForeignKeys()) { return; } // NOTE: we do not remove existing associations with the target as it should handled by unique FKs instead if (attribute.joinColumn && attribute.owner) { // nothing to do => relation already added on the table continue; } // oneToOne oneToMany on the non owning side. if (attribute.joinColumn && !attribute.owner) { // need to set the column on the target const { target } = attribute; await this.createQueryBuilder(target) .where({ [attribute.joinColumn.referencedColumn]: id }) .update({ [attribute.joinColumn.referencedColumn]: null }) .execute(); } if (attribute.joinTable) { const { joinTable } = attribute; const { joinColumn } = joinTable; await this.createQueryBuilder(joinTable.name) .delete() .where({ [joinColumn.name]: id }) .where(joinTable.on || {}) .execute(); } } }, // TODO: support multiple relations at once with the populate syntax // TODO: add lifecycle events async populate(uid, entity, populate) { const entry = await this.findOne(uid, { select: ['id'], where: { id: entity.id }, populate: populate, }); return Object.assign({}, entity, entry); }, // TODO: support multiple relations at once with the populate syntax // TODO: add lifecycle events async load(uid, entity, field, params) { const { attributes } = db.metadata.get(uid); const attribute = attributes[field]; if (!attribute || attribute.type !== 'relation') { throw new Error('Invalid load. Expected a relational attribute'); } const entry = await this.findOne(uid, { select: ['id'], where: { id: entity.id }, populate: { [field]: params || true, }, }); return entry[field]; }, // cascading // aggregations // -> avg // -> min // -> max // -> grouping // formulas // custom queries // utilities // -> map result // -> map input // extra features // -> virtuals // -> private createQueryBuilder(uid) { return createQueryBuilder(uid, db); }, getRepository(uid) { if (!repoMap[uid]) { repoMap[uid] = createRepository(uid, db); } return repoMap[uid]; }, clearRepositories() { repoMap.clear(); }, }; }; module.exports = { createEntityManager, };