loopback-datasource-juggler/lib/include.js

928 lines
31 KiB
JavaScript
Raw Normal View History

2016-04-06 14:51:49 +00:00
// Copyright IBM Corp. 2013,2015. All Rights Reserved.
// Node module: loopback-datasource-juggler
// This file is licensed under the MIT License.
// License text available at https://opensource.org/licenses/MIT
2016-10-19 21:35:26 +00:00
'use strict';
2016-04-06 14:51:49 +00:00
2014-03-13 23:43:38 +00:00
var async = require('async');
var g = require('strong-globalize')();
var utils = require('./utils');
var List = require('./list');
2015-08-24 13:07:43 +00:00
var includeUtils = require('./include_utils');
var isPlainObject = utils.isPlainObject;
var defineCachedRelations = utils.defineCachedRelations;
2015-05-29 17:50:37 +00:00
var uniq = utils.uniq;
var idName = utils.idName;
2014-10-10 10:28:39 +00:00
/*!
* Normalize the include to be an array
* @param include
* @returns {*}
*/
function normalizeInclude(include) {
var newInclude;
2014-10-10 10:28:39 +00:00
if (typeof include === 'string') {
return [include];
} else if (isPlainObject(include)) {
// Build an array of key/value pairs
newInclude = [];
2014-10-10 12:32:14 +00:00
var rel = include.rel || include.relation;
var obj = {};
if (typeof rel === 'string') {
2014-10-10 12:32:14 +00:00
obj[rel] = new IncludeScope(include.scope);
2014-10-10 10:28:39 +00:00
newInclude.push(obj);
} else {
for (var key in include) {
obj[key] = include[key];
newInclude.push(obj);
}
}
return newInclude;
} else if (Array.isArray(include)) {
newInclude = [];
for (var i = 0, n = include.length; i < n; i++) {
var subIncludes = normalizeInclude(include[i]);
newInclude = newInclude.concat(subIncludes);
}
return newInclude;
2014-10-10 10:28:39 +00:00
} else {
return include;
}
}
function IncludeScope(scope) {
this._scope = utils.deepMerge({}, scope || {});
if (this._scope.include) {
this._include = normalizeInclude(this._scope.include);
delete this._scope.include;
} else {
this._include = null;
}
};
IncludeScope.prototype.conditions = function() {
return utils.deepMerge({}, this._scope);
};
IncludeScope.prototype.include = function() {
return this._include;
};
/*!
* Look up a model by name from the list of given models
* @param {Object} models Models keyed by name
* @param {String} modelName The model name
* @returns {*} The matching model class
*/
function lookupModel(models, modelName) {
if (models[modelName]) {
return models[modelName];
}
var lookupClassName = modelName.toLowerCase();
for (var name in models) {
if (name.toLowerCase() === lookupClassName) {
return models[name];
}
}
}
/**
* Utility Function to allow interleave before and after high computation tasks
* @param tasks
* @param callback
*/
function execTasksWithInterLeave(tasks, callback) {
//let's give others some time to process.
//Context Switch BEFORE Heavy Computation
process.nextTick(function() {
//Heavy Computation
async.parallel(tasks, function(err, info) {
//Context Switch AFTER Heavy Computation
process.nextTick(function() {
callback(err, info);
});
});
});
}
2014-03-12 23:28:46 +00:00
/*!
2013-04-11 23:23:34 +00:00
* Include mixin for ./model.js
*/
2013-05-28 05:20:30 +00:00
module.exports = Inclusion;
2014-03-12 23:28:46 +00:00
/**
* Inclusion - Model mixin.
*
* @class
*/
2013-05-28 05:20:30 +00:00
function Inclusion() {
}
2013-04-11 23:23:34 +00:00
/**
* Normalize includes - used in DataAccessObject
*
*/
Inclusion.normalizeInclude = normalizeInclude;
2013-04-11 23:23:34 +00:00
/**
2014-03-12 23:28:46 +00:00
* Enables you to load relations of several objects and optimize numbers of requests.
2013-04-11 23:23:34 +00:00
*
* Examples:
*
2014-03-12 23:28:46 +00:00
* Load all users' posts with only one additional request:
* `User.include(users, 'posts', function() {});`
* Or
* `User.include(users, ['posts'], function() {});`
*
* Load all users posts and passports with two additional requests:
* `User.include(users, ['posts', 'passports'], function() {});`
*
* Load all passports owner (users), and all posts of each owner loaded:
2015-05-13 23:10:07 +00:00
*```Passport.include(passports, {owner: 'posts'}, function() {});
*``` Passport.include(passports, {owner: ['posts', 'passports']});
*``` Passport.include(passports, {owner: [{posts: 'images'}, 'passports']});
2013-04-11 23:23:34 +00:00
*
2014-03-12 23:28:46 +00:00
* @param {Array} objects Array of instances
2014-06-18 23:42:00 +00:00
* @param {String|Object|Array} include Which relations to load.
* @param {Object} [options] Options for CRUD
2014-03-12 23:28:46 +00:00
* @param {Function} cb Callback called when relations are loaded
2015-05-13 23:10:07 +00:00
*
2013-04-11 23:23:34 +00:00
*/
Inclusion.include = function(objects, include, options, cb) {
if (typeof options === 'function' && cb === undefined) {
cb = options;
options = {};
}
2014-01-24 17:09:53 +00:00
var self = this;
2015-05-13 23:10:07 +00:00
2014-03-13 23:43:38 +00:00
if (!include || (Array.isArray(include) && include.length === 0) ||
2015-11-05 01:13:12 +00:00
(Array.isArray(objects) && objects.length === 0) ||
2014-03-13 23:43:38 +00:00
(isPlainObject(include) && Object.keys(include).length === 0)) {
// The objects are empty
return process.nextTick(function() {
cb && cb(null, objects);
});
2014-01-24 17:09:53 +00:00
}
2014-03-13 23:43:38 +00:00
include = normalizeInclude(include);
2015-05-13 23:10:07 +00:00
2014-03-13 23:43:38 +00:00
async.each(include, function(item, callback) {
processIncludeItem(objects, item, options, callback);
2014-03-13 23:43:38 +00:00
}, function(err) {
cb && cb(err, objects);
});
function processIncludeItem(objs, include, options, cb) {
2014-01-24 17:09:53 +00:00
var relations = self.relations;
2015-05-13 23:10:07 +00:00
2014-10-10 10:28:39 +00:00
var relationName;
var subInclude = null, scope = null;
2015-05-13 23:10:07 +00:00
if (isPlainObject(include)) {
relationName = Object.keys(include)[0];
2014-10-10 10:28:39 +00:00
if (include[relationName] instanceof IncludeScope) {
scope = include[relationName];
subInclude = scope.include();
} else {
subInclude = include[relationName];
//when include = {user:true}, it does not have subInclude
if (subInclude === true) {
subInclude = null;
}
2014-10-10 10:28:39 +00:00
}
2016-05-10 21:25:33 +00:00
} else {
relationName = include;
2014-03-13 23:43:38 +00:00
subInclude = null;
2014-01-24 17:09:53 +00:00
}
2015-05-13 23:10:07 +00:00
var relation = relations[relationName];
2014-01-24 17:09:53 +00:00
if (!relation) {
cb(new Error(g.f('Relation "%s" is not defined for %s model', relationName, self.modelName)));
return;
2013-04-11 23:23:34 +00:00
}
var polymorphic = relation.polymorphic;
//if (polymorphic && !polymorphic.discriminator) {
// cb(new Error('Relation "' + relationName + '" is polymorphic but ' +
// 'discriminator is not present'));
// return;
//}
if (!relation.modelTo) {
if (!relation.polymorphic) {
cb(new Error(g.f('{{Relation.modelTo}} is not defined for relation %s and is no {{polymorphic}}',
relationName)));
return;
}
}
2013-04-11 23:23:34 +00:00
// Just skip if inclusion is disabled
if (relation.options.disableInclude) {
return cb();
}
//prepare filter and fields for making DB Call
var filter = (scope && scope.conditions()) || {};
if ((relation.multiple || relation.type === 'belongsTo') && scope) {
var includeScope = {};
// make sure not to miss any fields for sub includes
if (filter.fields && Array.isArray(subInclude) &&
relation.modelTo.relations) {
includeScope.fields = [];
subInclude.forEach(function(name) {
var rel = relation.modelTo.relations[name];
if (rel && rel.type === 'belongsTo') {
includeScope.fields.push(rel.keyFrom);
}
});
}
2016-10-19 21:04:05 +00:00
utils.mergeQuery(filter, includeScope, {fields: false});
}
//Let's add a placeholder where query
filter.where = filter.where || {};
//if fields are specified, make sure target foreign key is present
var fields = filter.fields;
if (Array.isArray(fields) && fields.indexOf(relation.keyTo) === -1) {
fields.push(relation.keyTo);
2016-05-10 21:25:33 +00:00
} else if (isPlainObject(fields) && !fields[relation.keyTo]) {
fields[relation.keyTo] = true;
}
/**
* call relation specific include functions
*/
if (relation.multiple) {
if (relation.modelThrough) {
//hasManyThrough needs separate handling
return includeHasManyThrough(cb);
}
//This will also include embedsMany with belongsTo.
//Might need to optimize db calls for this.
if (relation.type === 'embedsMany') {
//embedded docs are part of the objects, no need to make db call.
//proceed as implemented earlier.
return includeEmbeds(cb);
}
if (relation.type === 'referencesMany') {
return includeReferencesMany(cb);
}
2015-08-24 13:07:43 +00:00
//This handles exactly hasMany. Fast and straightforward. Without parallel, each and other boilerplate.
if (relation.type === 'hasMany' && relation.multiple && !subInclude) {
2015-08-24 13:07:43 +00:00
return includeHasManySimple(cb);
}
//assuming all other relations with multiple=true as hasMany
return includeHasMany(cb);
2016-05-10 21:25:33 +00:00
} else {
if (polymorphic) {
if (relation.type === 'hasOne') {
return includePolymorphicHasOne(cb);
}
return includePolymorphicBelongsTo(cb);
}
if (relation.type === 'embedsOne') {
return includeEmbeds(cb);
}
//hasOne or belongsTo
return includeOneToOne(cb);
}
/**
* Handle inclusion of HasManyThrough/HasAndBelongsToMany/Polymorphic
* HasManyThrough relations
* @param callback
*/
function includeHasManyThrough(callback) {
var sourceIds = [];
//Map for Indexing objects by their id for faster retrieval
var objIdMap = {};
for (var i = 0; i < objs.length; i++) {
var obj = objs[i];
// one-to-many: foreign key reference is modelTo -> modelFrom.
// use modelFrom.keyFrom in where filter later
var sourceId = obj[relation.keyFrom];
if (sourceId) {
sourceIds.push(sourceId);
objIdMap[sourceId.toString()] = obj;
}
// sourceId can be null. but cache empty data as result
defineCachedRelations(obj);
obj.__cachedRelations[relationName] = [];
}
//default filters are not applicable on through model. should be applied
//on modelTo later in 2nd DB call.
var throughFilter = {
where: {},
};
throughFilter.where[relation.keyTo] = {
inq: uniq(sourceIds),
};
if (polymorphic) {
var throughModel = polymorphic.invert ?
relation.modelTo :
relation.modelFrom;
//handle polymorphic hasMany (reverse) in which case we need to filter
//by discriminator to filter other types
throughFilter.where[polymorphic.discriminator] =
throughModel.definition.name;
}
/**
* 1st DB Call of 2 step process. Get through model objects first
*/
2015-06-23 23:08:07 +00:00
relation.modelThrough.find(throughFilter, options, throughFetchHandler);
/**
* Handle the results of Through model objects and fetch the modelTo items
* @param err
* @param {Array<Model>} throughObjs
* @returns {*}
*/
function throughFetchHandler(err, throughObjs) {
if (err) {
return callback(err);
}
// start preparing for 2nd DB call.
var targetIds = [];
var targetObjsMap = {};
for (var i = 0; i < throughObjs.length; i++) {
var throughObj = throughObjs[i];
var targetId = throughObj[relation.keyThrough];
if (targetId) {
//save targetIds for 2nd DB Call
targetIds.push(targetId);
var sourceObj = objIdMap[throughObj[relation.keyTo]];
var targetIdStr = targetId.toString();
//Since targetId can be duplicates, multiple source objs are put
//into buckets.
var objList = targetObjsMap[targetIdStr] =
targetObjsMap[targetIdStr] || [];
objList.push(sourceObj);
}
}
//Polymorphic relation does not have idKey of modelTo. Find it manually
var modelToIdName = idName(relation.modelTo);
filter.where[modelToIdName] = {
inq: uniq(targetIds),
};
//make sure that the modelToIdName is included if fields are specified
if (Array.isArray(fields) && fields.indexOf(modelToIdName) === -1) {
fields.push(modelToIdName);
2016-05-10 21:25:33 +00:00
} else if (isPlainObject(fields) && !fields[modelToIdName]) {
fields[modelToIdName] = true;
}
/**
* 2nd DB Call of 2 step process. Get modelTo (target) objects
*/
2015-06-23 23:08:07 +00:00
relation.modelTo.find(filter, options, targetsFetchHandler);
function targetsFetchHandler(err, targets) {
2015-05-13 23:10:07 +00:00
if (err) {
return callback(err);
}
var tasks = [];
//simultaneously process subIncludes. Call it first as it is an async
//process.
if (subInclude && targets) {
tasks.push(function subIncludesTask(next) {
relation.modelTo.include(targets, subInclude, options, next);
});
}
//process & link each target with object
tasks.push(targetLinkingTask);
function targetLinkingTask(next) {
async.each(targets, linkManyToMany, next);
function linkManyToMany(target, next) {
var targetId = target[modelToIdName];
var objList = targetObjsMap[targetId.toString()];
async.each(objList, function(obj, next) {
if (!obj) return next();
obj.__cachedRelations[relationName].push(target);
processTargetObj(obj, next);
}, next);
}
}
execTasksWithInterLeave(tasks, callback);
}
}
}
/**
* Handle inclusion of ReferencesMany relation
* @param callback
*/
function includeReferencesMany(callback) {
2015-06-30 18:48:09 +00:00
var modelToIdName = idName(relation.modelTo);
var allTargetIds = [];
//Map for Indexing objects by their id for faster retrieval
var targetObjsMap = {};
for (var i = 0; i < objs.length; i++) {
var obj = objs[i];
// one-to-many: foreign key reference is modelTo -> modelFrom.
// use modelFrom.keyFrom in where filter later
var targetIds = obj[relation.keyFrom];
if (targetIds) {
2015-05-13 23:10:07 +00:00
if (typeof targetIds === 'string') {
// For relational DBs, the array is stored as stringified json
// Please note obj is a plain object at this point
targetIds = JSON.parse(targetIds);
}
//referencesMany has multiple targetIds per obj. We need to concat
// them into allTargetIds before DB Call
allTargetIds = allTargetIds.concat(targetIds);
for (var j = 0; j < targetIds.length; j++) {
var targetId = targetIds[j];
var targetIdStr = targetId.toString();
var objList = targetObjsMap[targetIdStr] =
targetObjsMap[targetIdStr] || [];
objList.push(obj);
}
}
// sourceId can be null. but cache empty data as result
defineCachedRelations(obj);
obj.__cachedRelations[relationName] = [];
}
filter.where[relation.keyTo] = {
inq: uniq(allTargetIds),
};
relation.applyScope(null, filter);
/**
* Make the DB Call, fetch all target objects
*/
2015-06-23 23:08:07 +00:00
relation.modelTo.find(filter, options, targetFetchHandler);
/**
* Handle the fetched target objects
* @param err
* @param {Array<Model>}targets
* @returns {*}
*/
function targetFetchHandler(err, targets) {
if (err) {
return callback(err);
}
var tasks = [];
//simultaneously process subIncludes
if (subInclude && targets) {
tasks.push(function subIncludesTask(next) {
relation.modelTo.include(targets, subInclude, options, next);
});
}
2015-06-30 18:48:09 +00:00
targets = utils.sortObjectsByIds(modelToIdName, allTargetIds, targets);
//process each target object
tasks.push(targetLinkingTask);
function targetLinkingTask(next) {
async.each(targets, linkManyToMany, next);
function linkManyToMany(target, next) {
var objList = targetObjsMap[target[relation.keyTo].toString()];
async.each(objList, function(obj, next) {
if (!obj) return next();
obj.__cachedRelations[relationName].push(target);
processTargetObj(obj, next);
}, next);
}
}
execTasksWithInterLeave(tasks, callback);
}
}
2015-08-24 13:07:43 +00:00
/**
* Handle inclusion of HasMany relation
* @param callback
*/
function includeHasManySimple(callback) {
//Map for Indexing objects by their id for faster retrieval
var objIdMap2 = includeUtils.buildOneToOneIdentityMapWithOrigKeys(objs, relation.keyFrom);
2015-08-24 13:07:43 +00:00
filter.where[relation.keyTo] = {
inq: uniq(objIdMap2.getKeys()),
2015-08-24 13:07:43 +00:00
};
relation.applyScope(null, filter);
2015-08-24 17:45:41 +00:00
relation.modelTo.find(filter, options, targetFetchHandler);
2015-08-24 13:07:43 +00:00
2015-08-24 17:45:41 +00:00
function targetFetchHandler(err, targets) {
if (err) {
2015-08-24 13:07:43 +00:00
return callback(err);
}
2015-10-30 15:15:48 +00:00
var targetsIdMap = includeUtils.buildOneToManyIdentityMapWithOrigKeys(targets, relation.keyTo);
includeUtils.join(objIdMap2, targetsIdMap, function(obj1, valueToMergeIn) {
2015-08-24 17:45:41 +00:00
defineCachedRelations(obj1);
obj1.__cachedRelations[relationName] = valueToMergeIn;
processTargetObj(obj1, function() {});
2015-08-24 13:07:43 +00:00
});
callback(err, objs);
}
}
/**
* Handle inclusion of HasMany relation
* @param callback
*/
function includeHasMany(callback) {
var sourceIds = [];
//Map for Indexing objects by their id for faster retrieval
var objIdMap = {};
for (var i = 0; i < objs.length; i++) {
var obj = objs[i];
// one-to-many: foreign key reference is modelTo -> modelFrom.
// use modelFrom.keyFrom in where filter later
var sourceId = obj[relation.keyFrom];
if (sourceId) {
sourceIds.push(sourceId);
objIdMap[sourceId.toString()] = obj;
}
// sourceId can be null. but cache empty data as result
defineCachedRelations(obj);
obj.__cachedRelations[relationName] = [];
}
filter.where[relation.keyTo] = {
inq: uniq(sourceIds),
};
relation.applyScope(null, filter);
options.partitionBy = relation.keyTo;
2015-06-23 23:08:07 +00:00
relation.modelTo.find(filter, options, targetFetchHandler);
/**
* Process fetched related objects
* @param err
* @param {Array<Model>} targets
* @returns {*}
*/
function targetFetchHandler(err, targets) {
if (err) {
return callback(err);
}
var tasks = [];
//simultaneously process subIncludes
if (subInclude && targets) {
tasks.push(function subIncludesTask(next) {
relation.modelTo.include(targets, subInclude, options, next);
});
}
//process each target object
tasks.push(targetLinkingTask);
function targetLinkingTask(next) {
if (targets.length === 0) {
return async.each(objs, function(obj, next) {
processTargetObj(obj, next);
}, next);
}
async.each(targets, linkManyToOne, next);
function linkManyToOne(target, next) {
//fix for bug in hasMany with referencesMany
var targetIds = [].concat(target[relation.keyTo]);
async.each(targetIds, function(targetId, next) {
var obj = objIdMap[targetId.toString()];
if (!obj) return next();
obj.__cachedRelations[relationName].push(target);
processTargetObj(obj, next);
}, function(err, processedTargets) {
if (err) {
return next(err);
}
var objsWithEmptyRelation = objs.filter(function(obj) {
return obj.__cachedRelations[relationName].length === 0;
});
async.each(objsWithEmptyRelation, function(obj, next) {
processTargetObj(obj, next);
}, function(err) {
next(err, processedTargets);
});
});
}
}
execTasksWithInterLeave(tasks, callback);
}
}
/**
* Handle Inclusion of Polymorphic BelongsTo relation
* @param callback
*/
function includePolymorphicBelongsTo(callback) {
var targetIdsByType = {};
//Map for Indexing objects by their type and targetId for faster retrieval
var targetObjMapByType = {};
for (var i = 0; i < objs.length; i++) {
var obj = objs[i];
var discriminator = polymorphic.discriminator;
var modelType = obj[discriminator];
if (modelType) {
targetIdsByType[modelType] = targetIdsByType[modelType] || [];
targetObjMapByType[modelType] = targetObjMapByType[modelType] || {};
var targetIds = targetIdsByType[modelType];
var targetObjsMap = targetObjMapByType[modelType];
var targetId = obj[relation.keyFrom];
if (targetId) {
targetIds.push(targetId);
var targetIdStr = targetId.toString();
targetObjsMap[targetIdStr] = targetObjsMap[targetIdStr] || [];
//Is belongsTo. Multiple objects can have the same
//targetId and therefore map value is an array
targetObjsMap[targetIdStr].push(obj);
}
}
defineCachedRelations(obj);
obj.__cachedRelations[relationName] = null;
}
async.each(Object.keys(targetIdsByType), processPolymorphicType,
callback);
/**
* Process Polymorphic objects of each type (modelType)
* @param {String} modelType
* @param callback
*/
function processPolymorphicType(modelType, callback) {
2016-10-19 21:04:05 +00:00
var typeFilter = {where: {}};
utils.mergeQuery(typeFilter, filter);
2015-05-13 23:10:07 +00:00
var targetIds = targetIdsByType[modelType];
typeFilter.where[relation.keyTo] = {
inq: uniq(targetIds),
};
var Model = lookupModel(relation.modelFrom.dataSource.modelBuilder.
models, modelType);
if (!Model) {
callback(new Error(g.f('Discriminator type %s specified but no model exists with such name',
modelType)));
return;
}
relation.applyScope(null, typeFilter);
2015-06-23 23:08:07 +00:00
Model.find(typeFilter, options, targetFetchHandler);
/**
* Process fetched related objects
* @param err
* @param {Array<Model>} targets
* @returns {*}
*/
function targetFetchHandler(err, targets) {
if (err) {
return callback(err);
}
var tasks = [];
//simultaneously process subIncludes
if (subInclude && targets) {
tasks.push(function subIncludesTask(next) {
Model.include(targets, subInclude, options, next);
});
}
//process each target object
tasks.push(targetLinkingTask);
function targetLinkingTask(next) {
var targetObjsMap = targetObjMapByType[modelType];
async.each(targets, linkOneToMany, next);
function linkOneToMany(target, next) {
var objList = targetObjsMap[target[relation.keyTo].toString()];
if (!objList) return next();
async.each(objList, function(obj, next) {
if (!obj) return next();
obj.__cachedRelations[relationName] = target;
processTargetObj(obj, next);
}, next);
}
}
execTasksWithInterLeave(tasks, callback);
}
}
}
/**
* Handle Inclusion of Polymorphic HasOne relation
* @param callback
*/
function includePolymorphicHasOne(callback) {
var sourceIds = [];
//Map for Indexing objects by their id for faster retrieval
var objIdMap = {};
for (var i = 0; i < objs.length; i++) {
var obj = objs[i];
// one-to-one: foreign key reference is modelTo -> modelFrom.
// use modelFrom.keyFrom in where filter later
var sourceId = obj[relation.keyFrom];
if (sourceId) {
sourceIds.push(sourceId);
objIdMap[sourceId.toString()] = obj;
}
// sourceId can be null. but cache empty data as result
defineCachedRelations(obj);
obj.__cachedRelations[relationName] = null;
}
filter.where[relation.keyTo] = {
inq: uniq(sourceIds),
};
relation.applyScope(null, filter);
2015-06-23 23:08:07 +00:00
relation.modelTo.find(filter, options, targetFetchHandler);
/**
* Process fetched related objects
* @param err
* @param {Array<Model>} targets
* @returns {*}
*/
function targetFetchHandler(err, targets) {
if (err) {
return callback(err);
}
var tasks = [];
//simultaneously process subIncludes
if (subInclude && targets) {
tasks.push(function subIncludesTask(next) {
relation.modelTo.include(targets, subInclude, options, next);
});
}
//process each target object
tasks.push(targetLinkingTask);
function targetLinkingTask(next) {
async.each(targets, linkOneToOne, next);
function linkOneToOne(target, next) {
var sourceId = target[relation.keyTo];
if (!sourceId) return next();
var obj = objIdMap[sourceId.toString()];
if (!obj) return next();
obj.__cachedRelations[relationName] = target;
processTargetObj(obj, next);
}
}
execTasksWithInterLeave(tasks, callback);
}
}
/**
* Handle Inclusion of BelongsTo/HasOne relation
* @param callback
*/
function includeOneToOne(callback) {
var targetIds = [];
var objTargetIdMap = {};
for (var i = 0; i < objs.length; i++) {
var obj = objs[i];
if (relation.type === 'belongsTo') {
if (obj[relation.keyFrom] === null ||
obj[relation.keyFrom] === undefined) {
defineCachedRelations(obj);
obj.__cachedRelations[relationName] = null;
continue;
}
}
var targetId = obj[relation.keyFrom];
if (targetId) {
targetIds.push(targetId);
var targetIdStr = targetId.toString();
objTargetIdMap[targetIdStr] = objTargetIdMap[targetIdStr] || [];
objTargetIdMap[targetIdStr].push(obj);
}
defineCachedRelations(obj);
obj.__cachedRelations[relationName] = null;
}
filter.where[relation.keyTo] = {
inq: uniq(targetIds),
};
relation.applyScope(null, filter);
2015-06-23 23:08:07 +00:00
relation.modelTo.find(filter, options, targetFetchHandler);
/**
* Process fetched related objects
* @param err
* @param {Array<Model>} targets
* @returns {*}
*/
function targetFetchHandler(err, targets) {
if (err) {
return callback(err);
}
var tasks = [];
//simultaneously process subIncludes
if (subInclude && targets) {
tasks.push(function subIncludesTask(next) {
relation.modelTo.include(targets, subInclude, options, next);
});
}
//process each target object
tasks.push(targetLinkingTask);
function targetLinkingTask(next) {
async.each(targets, linkOneToMany, next);
function linkOneToMany(target, next) {
var targetId = target[relation.keyTo];
var objList = objTargetIdMap[targetId.toString()];
if (!objList) return next();
async.each(objList, function(obj, next) {
if (!obj) return next();
obj.__cachedRelations[relationName] = target;
processTargetObj(obj, next);
}, next);
}
}
execTasksWithInterLeave(tasks, callback);
}
}
/**
* Handle Inclusion of EmbedsMany/EmbedsManyWithBelongsTo/EmbedsOne
* Relations. Since Embedded docs are part of parents, no need to make
* db calls. Let the related function be called for each object to fetch
* the results from cache.
*
* TODO: Optimize EmbedsManyWithBelongsTo relation DB Calls
* @param callback
*/
function includeEmbeds(callback) {
async.each(objs, function(obj, next) {
processTargetObj(obj, next);
}, callback);
}
/**
* Process Each Model Object and make sure specified relations are included
* @param {Model} obj - Single Mode object for which inclusion is needed
* @param callback
* @returns {*}
*/
function processTargetObj(obj, callback) {
var isInst = obj instanceof self;
// Calling the relation method on the instance
if (relation.type === 'belongsTo') {
2014-03-13 23:43:38 +00:00
// If the belongsTo relation doesn't have an owner
if (obj[relation.keyFrom] === null || obj[relation.keyFrom] === undefined) {
2014-03-13 23:43:38 +00:00
defineCachedRelations(obj);
// Set to null if the owner doesn't exist
obj.__cachedRelations[relationName] = null;
if (isInst) {
obj.__data[relationName] = null;
} else {
obj[relationName] = null;
}
2014-03-13 23:43:38 +00:00
return callback();
2013-04-11 23:23:34 +00:00
}
2014-01-24 17:09:53 +00:00
}
/**
* Sets the related objects as a property of Parent Object
* @param {Array<Model>|Model|null} result - Related Object/Objects
* @param cb
*/
function setIncludeData(result, cb) {
if (isInst) {
if (Array.isArray(result) && !(result instanceof List)) {
result = new List(result, relation.modelTo);
}
obj.__data[relationName] = result;
obj.setStrict(false);
} else {
obj[relationName] = result;
}
cb(null, result);
}
//obj.__cachedRelations[relationName] can be null if no data was returned
if (obj.__cachedRelations &&
obj.__cachedRelations[relationName] !== undefined) {
return setIncludeData(obj.__cachedRelations[relationName],
callback);
}
var inst = (obj instanceof self) ? obj : new self(obj);
//If related objects are not cached by include Handlers, directly call
//related accessor function even though it is not very efficient
2014-10-10 10:28:39 +00:00
var related; // relation accessor function
2015-05-13 23:10:07 +00:00
2014-10-14 20:47:59 +00:00
if ((relation.multiple || relation.type === 'belongsTo') && scope) {
2014-10-10 10:28:39 +00:00
var includeScope = {};
var filter = scope.conditions();
2015-05-13 23:10:07 +00:00
2014-10-10 10:28:39 +00:00
// make sure not to miss any fields for sub includes
if (filter.fields && Array.isArray(subInclude) && relation.modelTo.relations) {
includeScope.fields = [];
subInclude.forEach(function(name) {
var rel = relation.modelTo.relations[name];
if (rel && rel.type === 'belongsTo') {
includeScope.fields.push(rel.keyFrom);
}
});
}
2015-05-13 23:10:07 +00:00
2016-10-19 21:04:05 +00:00
utils.mergeQuery(filter, includeScope, {fields: false});
2015-05-13 23:10:07 +00:00
2014-10-10 10:28:39 +00:00
related = inst[relationName].bind(inst, filter);
} else {
related = inst[relationName].bind(inst, undefined);
2014-10-10 10:28:39 +00:00
}
2015-05-13 23:10:07 +00:00
related(options, function(err, result) {
2014-03-13 23:43:38 +00:00
if (err) {
return callback(err);
} else {
defineCachedRelations(obj);
obj.__cachedRelations[relationName] = result;
2015-05-13 23:10:07 +00:00
return setIncludeData(result, callback);
2014-03-13 23:43:38 +00:00
}
});
}
2014-01-24 17:09:53 +00:00
}
};