Merge branch 'walkonsocial-include-db-call-spike'
This commit is contained in:
Raymond Feng
commit
1a88e9f71f
644
lib/include.js
644
lib/include.js
|
|
@ -2,6 +2,7 @@ var async = require('async');
|
|||
var utils = require('./utils');
|
||||
var isPlainObject = utils.isPlainObject;
|
||||
var defineCachedRelations = utils.defineCachedRelations;
|
||||
var debug = require('debug')('loopback:include');
|
||||
|
||||
/*!
|
||||
* Normalize the include to be an array
|
||||
|
|
@ -57,6 +58,52 @@ IncludeScope.prototype.include = function() {
|
|||
return this._include;
|
||||
};
|
||||
|
||||
/**
|
||||
* Find the idKey of a Model.
|
||||
* @param {ModelConstructor} m - Model Constructor
|
||||
* @returns {String}
|
||||
*/
|
||||
function idName(m) {
|
||||
return m.definition.idName() || 'id';
|
||||
}
|
||||
|
||||
/*!
|
||||
* 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);
|
||||
});
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
/*!
|
||||
* Include mixin for ./model.js
|
||||
*/
|
||||
|
|
@ -92,18 +139,19 @@ Inclusion.normalizeInclude = normalizeInclude;
|
|||
* `User.include(users, ['posts', 'passports'], function() {});`
|
||||
*
|
||||
* Load all passports owner (users), and all posts of each owner loaded:
|
||||
*```Passport.include(passports, {owner: 'posts'}, function() {});
|
||||
*``` Passport.include(passports, {owner: ['posts', 'passports']});
|
||||
*``` Passport.include(passports, {owner: [{posts: 'images'}, 'passports']});
|
||||
*```Passport.include(passports, {owner: 'posts'}, function() {});
|
||||
*``` Passport.include(passports, {owner: ['posts', 'passports']});
|
||||
*``` Passport.include(passports, {owner: [{posts: 'images'}, 'passports']});
|
||||
*
|
||||
* @param {Array} objects Array of instances
|
||||
* @param {String|Object|Array} include Which relations to load.
|
||||
* @param {Function} cb Callback called when relations are loaded
|
||||
*
|
||||
*
|
||||
*/
|
||||
Inclusion.include = function (objects, include, cb) {
|
||||
debug('include', include);
|
||||
var self = this;
|
||||
|
||||
|
||||
if (!include || (Array.isArray(include) && include.length === 0) ||
|
||||
(isPlainObject(include) && Object.keys(include).length === 0)) {
|
||||
// The objects are empty
|
||||
|
|
@ -113,7 +161,7 @@ Inclusion.include = function (objects, include, cb) {
|
|||
}
|
||||
|
||||
include = normalizeInclude(include);
|
||||
|
||||
|
||||
async.each(include, function(item, callback) {
|
||||
processIncludeItem(objects, item, callback);
|
||||
}, function(err) {
|
||||
|
|
@ -122,10 +170,10 @@ Inclusion.include = function (objects, include, cb) {
|
|||
|
||||
function processIncludeItem(objs, include, cb) {
|
||||
var relations = self.relations;
|
||||
|
||||
|
||||
var relationName;
|
||||
var subInclude = null, scope = null;
|
||||
|
||||
|
||||
if (isPlainObject(include)) {
|
||||
relationName = Object.keys(include)[0];
|
||||
if (include[relationName] instanceof IncludeScope) {
|
||||
|
|
@ -133,34 +181,540 @@ Inclusion.include = function (objects, include, cb) {
|
|||
subInclude = scope.include();
|
||||
} else {
|
||||
subInclude = include[relationName];
|
||||
//when include = {user:true}, it does not have subInclude
|
||||
if (subInclude === true) {
|
||||
subInclude = null;
|
||||
}
|
||||
}
|
||||
} else {
|
||||
}
|
||||
else {
|
||||
relationName = include;
|
||||
subInclude = null;
|
||||
}
|
||||
|
||||
|
||||
var relation = relations[relationName];
|
||||
if (!relation) {
|
||||
cb(new Error('Relation "' + relationName + '" is not defined for '
|
||||
+ self.modelName + ' model'));
|
||||
return;
|
||||
}
|
||||
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('Relation.modelTo is not defined for relation' +
|
||||
relationName + ' and is no polymorphic'));
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
// Just skip if inclusion is disabled
|
||||
if (relation.options.disableInclude) {
|
||||
cb();
|
||||
return;
|
||||
}
|
||||
|
||||
// Calling the relation method for each object
|
||||
async.each(objs, function (obj, callback) {
|
||||
if(relation.type === 'belongsTo') {
|
||||
//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);
|
||||
}
|
||||
});
|
||||
}
|
||||
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);
|
||||
}
|
||||
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);
|
||||
}
|
||||
//assuming all other relations with multiple=true as hasMany
|
||||
return includeHasMany(cb);
|
||||
}
|
||||
else {
|
||||
if (polymorphic) {
|
||||
return includePolymorphic(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: sourceIds
|
||||
};
|
||||
if (polymorphic) {
|
||||
//handle polymorphic hasMany (reverse) in which case we need to filter
|
||||
//by discriminator to filter other types
|
||||
throughFilter.where[polymorphic.discriminator] =
|
||||
relation.modelFrom.definition.name;
|
||||
}
|
||||
/**
|
||||
* 1st DB Call of 2 step process. Get through model objects first
|
||||
*/
|
||||
relation.modelThrough.find(throughFilter, 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: targetIds
|
||||
};
|
||||
//make sure that the modelToIdName is included if fields are specified
|
||||
if (Array.isArray(fields) && fields.indexOf(modelToIdName) === -1) {
|
||||
fields.push(modelToIdName);
|
||||
}
|
||||
else if (isPlainObject(fields) && !fields[modelToIdName]) {
|
||||
fields[modelToIdName] = true;
|
||||
}
|
||||
|
||||
/**
|
||||
* 2nd DB Call of 2 step process. Get modelTo (target) objects
|
||||
*/
|
||||
relation.modelTo.find(filter, targetsFetchHandler);
|
||||
function targetsFetchHandler(err, targets) {
|
||||
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, 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) {
|
||||
obj.__cachedRelations[relationName].push(target);
|
||||
processTargetObj(obj, next);
|
||||
}, next);
|
||||
}
|
||||
}
|
||||
|
||||
execTasksWithInterLeave(tasks, callback);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Handle inclusion of ReferencesMany relation
|
||||
* @param callback
|
||||
*/
|
||||
function includeReferencesMany(callback) {
|
||||
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) {
|
||||
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: allTargetIds
|
||||
};
|
||||
|
||||
/**
|
||||
* Make the DB Call, fetch all target objects
|
||||
*/
|
||||
relation.modelTo.find(filter, 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, next);
|
||||
});
|
||||
}
|
||||
//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) {
|
||||
obj.__cachedRelations[relationName].push(target);
|
||||
processTargetObj(obj, next);
|
||||
}, next);
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
execTasksWithInterLeave(tasks, callback);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 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: sourceIds
|
||||
};
|
||||
relation.modelTo.find(filter, 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, next);
|
||||
});
|
||||
}
|
||||
//process each target object
|
||||
tasks.push(targetLinkingTask);
|
||||
function targetLinkingTask(next) {
|
||||
async.each(targets, linkManyToOne, next);
|
||||
function linkManyToOne(target, next) {
|
||||
var obj = objIdMap[target[relation.keyTo].toString()];
|
||||
obj.__cachedRelations[relationName].push(target);
|
||||
processTargetObj(obj, next);
|
||||
}
|
||||
}
|
||||
|
||||
execTasksWithInterLeave(tasks, callback);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Handle Inclusion of Polymorphic BelongsTo/HasOne relation
|
||||
* @param callback
|
||||
*/
|
||||
function includePolymorphic(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) {
|
||||
var typeFilter = {where: {}};
|
||||
utils.mergeQuery(typeFilter, filter);
|
||||
var targetIds = targetIdsByType[modelType];
|
||||
typeFilter.where[relation.keyTo] = {
|
||||
inq: targetIds
|
||||
};
|
||||
var app = relation.modelFrom.app;
|
||||
var Model = lookupModel(relation.modelFrom.dataSource.modelBuilder.
|
||||
models, modelType);
|
||||
if (!Model) {
|
||||
callback(new Error('Discriminator type "' + modelType +
|
||||
' specified but no model exists with such name'));
|
||||
return;
|
||||
}
|
||||
Model.find(typeFilter, 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, 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()];
|
||||
async.each(objList, function (obj, next) {
|
||||
obj.__cachedRelations[relationName] = target;
|
||||
processTargetObj(obj, next);
|
||||
}, 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: targetIds
|
||||
};
|
||||
relation.modelTo.find(filter, 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, 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()];
|
||||
async.each(objList, function (obj, 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 inst = (obj instanceof self) ? obj : new self(obj);
|
||||
// Calling the relation method on the instance
|
||||
if (relation.type === 'belongsTo') {
|
||||
// If the belongsTo relation doesn't have an owner
|
||||
if(obj[relation.keyFrom] === null || obj[relation.keyFrom] === undefined) {
|
||||
if (obj[relation.keyFrom] === null || obj[relation.keyFrom] === undefined) {
|
||||
defineCachedRelations(obj);
|
||||
// Set to null if the owner doesn't exist
|
||||
obj.__cachedRelations[relationName] = null;
|
||||
if(obj === inst) {
|
||||
if (obj === inst) {
|
||||
obj.__data[relationName] = null;
|
||||
} else {
|
||||
obj[relationName] = null;
|
||||
|
|
@ -168,16 +722,35 @@ Inclusion.include = function (objects, include, cb) {
|
|||
return callback();
|
||||
}
|
||||
}
|
||||
|
||||
var inst = (obj instanceof self) ? obj : new self(obj);
|
||||
// Calling the relation method on the instance
|
||||
|
||||
/**
|
||||
* 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 (obj === inst) {
|
||||
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);
|
||||
}
|
||||
//If related objects are not cached by include Handlers, directly call
|
||||
//related accessor function even though it is not very efficient
|
||||
var related; // relation accessor function
|
||||
|
||||
|
||||
if ((relation.multiple || relation.type === 'belongsTo') && scope) {
|
||||
var includeScope = {};
|
||||
var filter = scope.conditions();
|
||||
|
||||
|
||||
// make sure not to miss any fields for sub includes
|
||||
if (filter.fields && Array.isArray(subInclude) && relation.modelTo.relations) {
|
||||
includeScope.fields = [];
|
||||
|
|
@ -188,39 +761,26 @@ Inclusion.include = function (objects, include, cb) {
|
|||
}
|
||||
});
|
||||
}
|
||||
|
||||
|
||||
utils.mergeQuery(filter, includeScope, {fields: false});
|
||||
|
||||
|
||||
related = inst[relationName].bind(inst, filter);
|
||||
} else {
|
||||
related = inst[relationName].bind(inst);
|
||||
}
|
||||
|
||||
|
||||
related(function (err, result) {
|
||||
if (err) {
|
||||
return callback(err);
|
||||
} else {
|
||||
|
||||
|
||||
defineCachedRelations(obj);
|
||||
obj.__cachedRelations[relationName] = result;
|
||||
|
||||
if(obj === inst) {
|
||||
obj.__data[relationName] = result;
|
||||
obj.setStrict(false);
|
||||
} else {
|
||||
obj[relationName] = result;
|
||||
}
|
||||
|
||||
if (subInclude && result) {
|
||||
var subItems = relation.multiple ? result : [result];
|
||||
// Recursively include the related models
|
||||
relation.modelTo.include(subItems, subInclude, callback);
|
||||
} else {
|
||||
callback(null, result);
|
||||
}
|
||||
|
||||
return setIncludeData(result, callback);
|
||||
}
|
||||
});
|
||||
}, cb);
|
||||
}
|
||||
|
||||
}
|
||||
};
|
||||
|
|
|
|||
|
|
@ -28,7 +28,8 @@
|
|||
"devDependencies": {
|
||||
"bluebird": "^2.9.9",
|
||||
"mocha": "^2.1.0",
|
||||
"should": "^5.0.0"
|
||||
"should": "^5.0.0",
|
||||
"sinon": "^1.14.1"
|
||||
},
|
||||
"dependencies": {
|
||||
"async": "^0.9.0",
|
||||
|
|
|
|||
|
|
@ -1,7 +1,9 @@
|
|||
// This test written in mocha+should.js
|
||||
var should = require('./init.js');
|
||||
var sinon = require('sinon');
|
||||
var async = require('async');
|
||||
|
||||
var db, User, AccessToken, Post, Passport, City, Street, Building, Assembly, Part;
|
||||
var db, User, Profile, AccessToken, Post, Passport, City, Street, Building, Assembly, Part;
|
||||
|
||||
describe('include', function () {
|
||||
|
||||
|
|
@ -334,20 +336,203 @@ describe('include', function () {
|
|||
});
|
||||
});
|
||||
|
||||
// Not implemented correctly, see: loopback-datasource-juggler/issues/166
|
||||
//
|
||||
// it('should support include scope on hasAndBelongsToMany', function (done) {
|
||||
// Assembly.find({include: { relation: 'parts', scope: {
|
||||
// where: { partNumber: 'engine' }
|
||||
// }}}, function (err, assemblies) {
|
||||
// assemblies.length.should.equal(1);
|
||||
// var parts = assemblies[0].parts();
|
||||
// parts.should.have.length(1);
|
||||
// parts[0].partNumber.should.equal('engine');
|
||||
// done();
|
||||
// });
|
||||
// });
|
||||
it('should fetch User - Profile (HasOne)', function (done) {
|
||||
User.find({include: ['profile']}, function (err, users) {
|
||||
should.not.exist(err);
|
||||
should.exist(users);
|
||||
users.length.should.be.ok;
|
||||
var usersWithProfile = 0;
|
||||
users.forEach(function (user) {
|
||||
// The relation should be promoted as the 'owner' property
|
||||
user.should.have.property('profile');
|
||||
var userObj = user.toJSON();
|
||||
var profile = user.profile();
|
||||
if (profile) {
|
||||
profile.should.be.an.instanceOf(Profile);
|
||||
usersWithProfile++;
|
||||
}
|
||||
else {
|
||||
(profile === null).should.be.true;
|
||||
}
|
||||
// The __cachedRelations should be removed from json output
|
||||
userObj.should.not.have.property('__cachedRelations');
|
||||
user.__cachedRelations.should.have.property('profile');
|
||||
if (user.__cachedRelations.profile) {
|
||||
user.__cachedRelations.profile.userId.should.eql(user.id);
|
||||
usersWithProfile++;
|
||||
}
|
||||
});
|
||||
usersWithProfile.should.equal(2 * 2);
|
||||
done();
|
||||
});
|
||||
});
|
||||
|
||||
|
||||
// Not implemented correctly, see: loopback-datasource-juggler/issues/166
|
||||
// fixed by DB optimization
|
||||
it('should support include scope on hasAndBelongsToMany', function (done) {
|
||||
Assembly.find({include: { relation: 'parts', scope: {
|
||||
where: { partNumber: 'engine' }
|
||||
}}}, function (err, assemblies) {
|
||||
assemblies.length.should.equal(1);
|
||||
var parts = assemblies[0].parts();
|
||||
parts.should.have.length(1);
|
||||
parts[0].partNumber.should.equal('engine');
|
||||
done();
|
||||
});
|
||||
});
|
||||
|
||||
describe(' performance - ', function () {
|
||||
beforeEach(function () {
|
||||
this.callSpy = sinon.spy(db.connector, 'all');
|
||||
});
|
||||
afterEach(function () {
|
||||
db.connector.all.restore();
|
||||
});
|
||||
it('including belongsTo should make only 2 db calls', function (done) {
|
||||
var self = this;
|
||||
Passport.find({include: 'owner'}, function (err, passports) {
|
||||
passports.length.should.be.ok;
|
||||
passports.forEach(function (p) {
|
||||
p.__cachedRelations.should.have.property('owner');
|
||||
// The relation should be promoted as the 'owner' property
|
||||
p.should.have.property('owner');
|
||||
// The __cachedRelations should be removed from json output
|
||||
p.toJSON().should.not.have.property('__cachedRelations');
|
||||
var owner = p.__cachedRelations.owner;
|
||||
if (!p.ownerId) {
|
||||
should.not.exist(owner);
|
||||
} else {
|
||||
should.exist(owner);
|
||||
owner.id.should.eql(p.ownerId);
|
||||
}
|
||||
});
|
||||
self.callSpy.calledTwice.should.be.true;
|
||||
done();
|
||||
});
|
||||
});
|
||||
|
||||
it('including hasManyThrough should make only 3 db calls', function (done) {
|
||||
var self = this;
|
||||
Assembly.create([{name: 'sedan'}, {name: 'hatchback'},
|
||||
{name: 'SUV'}],
|
||||
function (err, assemblies) {
|
||||
Part.create([{partNumber: 'engine'}, {partNumber: 'bootspace'},
|
||||
{partNumber: 'silencer'}],
|
||||
function (err, parts) {
|
||||
async.each(parts, function (part, next) {
|
||||
async.each(assemblies, function (assembly, next) {
|
||||
if (assembly.name === 'SUV') {
|
||||
return next();
|
||||
}
|
||||
if (assembly.name === 'hatchback' &&
|
||||
part.partNumber === 'bootspace') {
|
||||
return next();
|
||||
}
|
||||
assembly.parts.add(part, function (err, data) {
|
||||
next();
|
||||
});
|
||||
}, next);
|
||||
}, function (err) {
|
||||
self.callSpy.reset();
|
||||
Assembly.find({
|
||||
where: {
|
||||
name: {
|
||||
inq: ['sedan', 'hatchback', 'SUV']
|
||||
}
|
||||
},
|
||||
include: 'parts'
|
||||
}, function (err, result) {
|
||||
should.not.exist(err);
|
||||
should.exists(result);
|
||||
result.length.should.equal(3);
|
||||
//sedan
|
||||
result[0].parts().should.have.length(3);
|
||||
//hatcback
|
||||
result[1].parts().should.have.length(2);
|
||||
//SUV
|
||||
result[2].parts().should.have.length(0);
|
||||
self.callSpy.calledThrice.should.be.true;
|
||||
done();
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
it('including hasMany should make only 2 db calls', function (done) {
|
||||
var self = this;
|
||||
User.find({include: ['posts', 'passports']}, function (err, users) {
|
||||
should.not.exist(err);
|
||||
should.exist(users);
|
||||
users.length.should.be.ok;
|
||||
users.forEach(function (user) {
|
||||
// The relation should be promoted as the 'owner' property
|
||||
user.should.have.property('posts');
|
||||
user.should.have.property('passports');
|
||||
|
||||
var userObj = user.toJSON();
|
||||
userObj.should.have.property('posts');
|
||||
userObj.should.have.property('passports');
|
||||
userObj.posts.should.be.an.instanceOf(Array);
|
||||
userObj.passports.should.be.an.instanceOf(Array);
|
||||
|
||||
// The __cachedRelations should be removed from json output
|
||||
userObj.should.not.have.property('__cachedRelations');
|
||||
|
||||
user.__cachedRelations.should.have.property('posts');
|
||||
user.__cachedRelations.should.have.property('passports');
|
||||
user.__cachedRelations.posts.forEach(function (p) {
|
||||
p.userId.should.eql(user.id);
|
||||
});
|
||||
user.__cachedRelations.passports.forEach(function (pp) {
|
||||
pp.ownerId.should.eql(user.id);
|
||||
});
|
||||
});
|
||||
self.callSpy.calledThrice.should.be.true;
|
||||
done();
|
||||
});
|
||||
});
|
||||
|
||||
|
||||
it('should not make n+1 db calls in relation syntax',
|
||||
function (done) {
|
||||
var self = this;
|
||||
User.find({include: [{ relation: 'posts', scope: {
|
||||
where: {title: 'Post A'}
|
||||
}}, 'passports']}, function (err, users) {
|
||||
should.not.exist(err);
|
||||
should.exist(users);
|
||||
users.length.should.be.ok;
|
||||
users.forEach(function (user) {
|
||||
// The relation should be promoted as the 'owner' property
|
||||
user.should.have.property('posts');
|
||||
user.should.have.property('passports');
|
||||
|
||||
var userObj = user.toJSON();
|
||||
userObj.should.have.property('posts');
|
||||
userObj.should.have.property('passports');
|
||||
userObj.posts.should.be.an.instanceOf(Array);
|
||||
userObj.passports.should.be.an.instanceOf(Array);
|
||||
|
||||
// The __cachedRelations should be removed from json output
|
||||
userObj.should.not.have.property('__cachedRelations');
|
||||
|
||||
user.__cachedRelations.should.have.property('posts');
|
||||
user.__cachedRelations.should.have.property('passports');
|
||||
user.__cachedRelations.posts.forEach(function (p) {
|
||||
p.userId.should.eql(user.id);
|
||||
p.title.should.be.equal('Post A');
|
||||
});
|
||||
user.__cachedRelations.passports.forEach(function (pp) {
|
||||
pp.ownerId.should.eql(user.id);
|
||||
});
|
||||
});
|
||||
self.callSpy.calledThrice.should.be.true;
|
||||
done();
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
function setup(done) {
|
||||
|
|
@ -359,6 +544,9 @@ function setup(done) {
|
|||
name: String,
|
||||
age: Number
|
||||
});
|
||||
Profile = db.define('Profile', {
|
||||
profileName: String
|
||||
});
|
||||
AccessToken = db.define('AccessToken', {
|
||||
token: String
|
||||
});
|
||||
|
|
@ -376,6 +564,8 @@ function setup(done) {
|
|||
foreignKey: 'userId',
|
||||
options: {disableInclude: true}
|
||||
});
|
||||
Profile.belongsTo('user', {model: User});
|
||||
User.hasOne('profile', {foreignKey: 'userId'});
|
||||
Post.belongsTo('author', {model: User, foreignKey: 'userId'});
|
||||
|
||||
Assembly = db.define('Assembly', {
|
||||
|
|
@ -392,6 +582,7 @@ function setup(done) {
|
|||
db.automigrate(function () {
|
||||
var createdUsers = [];
|
||||
var createdPassports = [];
|
||||
var createdProfiles = [];
|
||||
var createdPosts = [];
|
||||
createUsers();
|
||||
function createUsers() {
|
||||
|
|
@ -438,6 +629,21 @@ function setup(done) {
|
|||
);
|
||||
}
|
||||
|
||||
function createProfiles() {
|
||||
clearAndCreate(
|
||||
Profile,
|
||||
[
|
||||
{profileName: 'Profile A', userId: createdUsers[0].id},
|
||||
{profileName: 'Profile B', userId: createdUsers[1].id},
|
||||
{profileName: 'Profile Z'}
|
||||
],
|
||||
function (items) {
|
||||
createdProfiles = items
|
||||
done();
|
||||
}
|
||||
);
|
||||
}
|
||||
|
||||
function createPosts() {
|
||||
clearAndCreate(
|
||||
Post,
|
||||
|
|
@ -450,7 +656,7 @@ function setup(done) {
|
|||
],
|
||||
function (items) {
|
||||
createdPosts = items;
|
||||
done();
|
||||
createProfiles();
|
||||
}
|
||||
);
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in New Issue