'use strict'; /*! * Module dependencies */ const checkEmbeddedDiscriminatorKeyProjection = require('./helpers/discriminator/checkEmbeddedDiscriminatorKeyProjection'); const get = require('./helpers/get'); const isDefiningProjection = require('./helpers/projection/isDefiningProjection'); const utils = require('./utils'); /*! * Prepare a set of path options for query population. * * @param {Query} query * @param {Object} options * @return {Array} */ exports.preparePopulationOptions = function preparePopulationOptions(query, options) { const pop = utils.object.vals(query.options.populate); // lean options should trickle through all queries if (options.lean != null) { pop. filter(p => get(p, 'options.lean') == null). forEach(makeLean(options.lean)); } return pop; }; /*! * Prepare a set of path options for query population. This is the MongooseQuery * version * * @param {Query} query * @param {Object} options * @return {Array} */ exports.preparePopulationOptionsMQ = function preparePopulationOptionsMQ(query, options) { const pop = utils.object.vals(query._mongooseOptions.populate); // lean options should trickle through all queries if (options.lean != null) { pop. filter(p => get(p, 'options.lean') == null). forEach(makeLean(options.lean)); } const session = get(query, 'options.session', null); if (session != null) { pop.forEach(path => { if (path.options == null) { path.options = { session: session }; return; } if (!('session' in path.options)) { path.options.session = session; } }); } const projection = query._fieldsForExec(); pop.forEach(p => { p._queryProjection = projection; }); return pop; }; /*! * returns discriminator by discriminatorMapping.value * * @param {Model} model * @param {string} value */ function getDiscriminatorByValue(model, value) { let discriminator = null; if (!model.discriminators) { return discriminator; } for (const name in model.discriminators) { const it = model.discriminators[name]; if ( it.schema && it.schema.discriminatorMapping && it.schema.discriminatorMapping.value == value ) { discriminator = it; break; } } return discriminator; } exports.getDiscriminatorByValue = getDiscriminatorByValue; /*! * If the document is a mapped discriminator type, it returns a model instance for that type, otherwise, * it returns an instance of the given model. * * @param {Model} model * @param {Object} doc * @param {Object} fields * * @return {Model} */ exports.createModel = function createModel(model, doc, fields, userProvidedFields) { model.hooks.execPreSync('createModel', doc); const discriminatorMapping = model.schema ? model.schema.discriminatorMapping : null; const key = discriminatorMapping && discriminatorMapping.isRoot ? discriminatorMapping.key : null; const value = doc[key]; if (key && value && model.discriminators) { const discriminator = model.discriminators[value] || getDiscriminatorByValue(model, value); if (discriminator) { const _fields = utils.clone(userProvidedFields); exports.applyPaths(_fields, discriminator.schema); return new discriminator(undefined, _fields, true); } } return new model(undefined, fields, { skipId: true, isNew: false, willInit: true }); }; /*! * ignore */ exports.applyPaths = function applyPaths(fields, schema) { // determine if query is selecting or excluding fields let exclude; let keys; let ki; let field; if (fields) { keys = Object.keys(fields); ki = keys.length; while (ki--) { if (keys[ki][0] === '+') { continue; } field = fields[keys[ki]]; // Skip `$meta` and `$slice` if (!isDefiningProjection(field)) { continue; } exclude = field === 0; break; } } // if selecting, apply default schematype select:true fields // if excluding, apply schematype select:false fields const selected = []; const excluded = []; const stack = []; const analyzePath = function(path, type) { const plusPath = '+' + path; const hasPlusPath = fields && plusPath in fields; if (hasPlusPath) { // forced inclusion delete fields[plusPath]; } if (typeof type.selected !== 'boolean') return; if (hasPlusPath) { // forced inclusion delete fields[plusPath]; // if there are other fields being included, add this one // if no other included fields, leave this out (implied inclusion) if (exclude === false && keys.length > 1 && !~keys.indexOf(path)) { fields[path] = 1; } return; } // check for parent exclusions const pieces = path.split('.'); const root = pieces[0]; if (~excluded.indexOf(root)) { return; } // Special case: if user has included a parent path of a discriminator key, // don't explicitly project in the discriminator key because that will // project out everything else under the parent path if (!exclude && get(type, 'options.$skipDiscriminatorCheck', false)) { let cur = ''; for (let i = 0; i < pieces.length; ++i) { cur += (cur.length === 0 ? '' : '.') + pieces[i]; const projection = get(fields, cur, false); if (projection && typeof projection !== 'object') { return; } } } (type.selected ? selected : excluded).push(path); return path; }; analyzeSchema(schema); switch (exclude) { case true: for (let i = 0; i < excluded.length; ++i) { fields[excluded[i]] = 0; } break; case false: if (schema && schema.paths['_id'] && schema.paths['_id'].options && schema.paths['_id'].options.select === false) { fields._id = 0; } for (let i = 0; i < selected.length; ++i) { fields[selected[i]] = 1; } break; case undefined: if (fields == null) { break; } // Any leftover plus paths must in the schema, so delete them (gh-7017) for (const key of Object.keys(fields || {})) { if (key.startsWith('+')) { delete fields[key]; } } // user didn't specify fields, implies returning all fields. // only need to apply excluded fields and delete any plus paths for (let i = 0; i < excluded.length; ++i) { fields[excluded[i]] = 0; } break; } function analyzeSchema(schema, prefix) { prefix || (prefix = ''); // avoid recursion if (stack.indexOf(schema) !== -1) { return []; } stack.push(schema); const addedPaths = []; schema.eachPath(function(path, type) { if (prefix) path = prefix + '.' + path; const addedPath = analyzePath(path, type); if (addedPath != null) { addedPaths.push(addedPath); } // nested schemas if (type.schema) { const _addedPaths = analyzeSchema(type.schema, path); // Special case: if discriminator key is the only field that would // be projected in, remove it. if (exclude === false) { checkEmbeddedDiscriminatorKeyProjection(fields, path, type.schema, selected, _addedPaths); } } }); stack.pop(); return addedPaths; } }; /*! * Set each path query option to lean * * @param {Object} option */ function makeLean(val) { return function(option) { option.options || (option.options = {}); option.options.lean = val; }; } /*! * Handle the `WriteOpResult` from the server */ exports.handleDeleteWriteOpResult = function handleDeleteWriteOpResult(callback) { return function _handleDeleteWriteOpResult(error, res) { if (error) { return callback(error); } const mongooseResult = Object.assign({}, res.result); if (get(res, 'result.n', null) != null) { mongooseResult.deletedCount = res.result.n; } if (res.deletedCount != null) { mongooseResult.deletedCount = res.deletedCount; } return callback(null, mongooseResult); }; };