123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360 |
- 'use strict';
-
- /*!
- * Module dependencies.
- */
-
- const Document = require('../document');
- const MongooseArray = require('./array');
- const ObjectId = require('./objectid');
- const castObjectId = require('../cast/objectid');
- const get = require('../helpers/get');
- const getDiscriminatorByValue = require('../queryhelpers').getDiscriminatorByValue;
- const internalToObjectOptions = require('../options').internalToObjectOptions;
- const util = require('util');
- const utils = require('../utils');
-
- const documentArrayParent = require('../helpers/symbols').documentArrayParent;
-
- /*!
- * ignore
- */
-
- class CoreMongooseArray extends Array {
- get isMongooseArray() {
- return true;
- }
-
- remove() {}
- }
-
- /**
- * DocumentArray constructor
- *
- * @param {Array} values
- * @param {String} path the path to this array
- * @param {Document} doc parent document
- * @api private
- * @return {MongooseDocumentArray}
- * @inherits MongooseArray
- * @see http://bit.ly/f6CnZU
- */
-
- function MongooseDocumentArray(values, path, doc) {
- // TODO: replace this with `new CoreMongooseArray().concat()` when we remove
- // support for node 4.x and 5.x, see https://i.imgur.com/UAAHk4S.png
- const arr = new CoreMongooseArray();
-
- const props = {
- isMongooseDocumentArray: true,
- validators: [],
- _atomics: {},
- _schema: void 0,
- _handlers: void 0
- };
-
- if (Array.isArray(values)) {
- if (values instanceof CoreMongooseArray &&
- values._path === path &&
- values._parent === doc) {
- props._atomics = Object.assign({}, values._atomics);
- }
- values.forEach(v => {
- arr.push(v);
- });
- }
- arr._path = path;
-
- // Values always have to be passed to the constructor to initialize, since
- // otherwise MongooseArray#push will mark the array as modified to the parent.
- const keysMA = Object.keys(MongooseArray.mixin);
- let numKeys = keysMA.length;
- for (let j = 0; j < numKeys; ++j) {
- arr[keysMA[j]] = MongooseArray.mixin[keysMA[j]];
- }
-
- const keysMDA = Object.keys(MongooseDocumentArray.mixin);
- numKeys = keysMDA.length;
- for (let i = 0; i < numKeys; ++i) {
- arr[keysMDA[i]] = MongooseDocumentArray.mixin[keysMDA[i]];
- }
- if (util.inspect.custom) {
- props[util.inspect.custom] = arr.inspect;
- }
-
- const keysP = Object.keys(props);
- numKeys = keysP.length;
- for (let k = 0; k < numKeys; ++k) {
- arr[keysP[k]] = props[keysP[k]];
- }
-
- // Because doc comes from the context of another function, doc === global
- // can happen if there was a null somewhere up the chain (see #3020 && #3034)
- // RB Jun 17, 2015 updated to check for presence of expected paths instead
- // to make more proof against unusual node environments
- if (doc && doc instanceof Document) {
- arr._parent = doc;
- arr._schema = doc.schema.path(path);
-
- // `schema.path()` doesn't drill into nested arrays properly yet, see
- // gh-6398, gh-6602. This is a workaround because nested arrays are
- // always plain non-document arrays, so once you get to a document array
- // nesting is done. Matryoshka code.
- while (get(arr, '_schema.$isMongooseArray') &&
- !get(arr, '_schema.$isMongooseDocumentArray')) {
- arr._schema = arr._schema.casterConstructor;
- }
-
- // Tricky but this may be a document array embedded in a normal array,
- // in which case `path` would point to the embedded array. See #6405, #6398
- if (arr._schema && !arr._schema.$isMongooseDocumentArray) {
- arr._schema = arr._schema.casterConstructor;
- }
-
- arr._handlers = {
- isNew: arr.notify('isNew'),
- save: arr.notify('save')
- };
-
- doc.on('save', arr._handlers.save);
- doc.on('isNew', arr._handlers.isNew);
- }
-
- return arr;
- }
-
- /*!
- * Inherits from MongooseArray
- */
-
- MongooseDocumentArray.mixin = {
- /*!
- * ignore
- */
- toBSON: function() {
- return this.toObject(internalToObjectOptions);
- },
-
- /**
- * Overrides MongooseArray#cast
- *
- * @method _cast
- * @api private
- * @receiver MongooseDocumentArray
- */
-
- _cast: function(value, index) {
- let Constructor = this._schema.casterConstructor;
- const isInstance = Constructor.$isMongooseDocumentArray ?
- value && value.isMongooseDocumentArray :
- value instanceof Constructor;
- if (isInstance ||
- // Hack re: #5001, see #5005
- (value && value.constructor && value.constructor.baseCasterConstructor === Constructor)) {
- if (!(value[documentArrayParent] && value.__parentArray)) {
- // value may have been created using array.create()
- value[documentArrayParent] = this._parent;
- value.__parentArray = this;
- }
- value.$setIndex(index);
- return value;
- }
-
- if (value === undefined || value === null) {
- return null;
- }
-
- // handle cast('string') or cast(ObjectId) etc.
- // only objects are permitted so we can safely assume that
- // non-objects are to be interpreted as _id
- if (Buffer.isBuffer(value) ||
- value instanceof ObjectId || !utils.isObject(value)) {
- value = {_id: value};
- }
-
- if (value &&
- Constructor.discriminators &&
- Constructor.schema &&
- Constructor.schema.options &&
- Constructor.schema.options.discriminatorKey) {
- if (typeof value[Constructor.schema.options.discriminatorKey] === 'string' &&
- Constructor.discriminators[value[Constructor.schema.options.discriminatorKey]]) {
- Constructor = Constructor.discriminators[value[Constructor.schema.options.discriminatorKey]];
- } else {
- const constructorByValue = getDiscriminatorByValue(Constructor, value[Constructor.schema.options.discriminatorKey]);
- if (constructorByValue) {
- Constructor = constructorByValue;
- }
- }
- }
-
- if (Constructor.$isMongooseDocumentArray) {
- return Constructor.cast(value, this, undefined, undefined, index);
- }
- return new Constructor(value, this, undefined, undefined, index);
- },
-
- /**
- * Searches array items for the first document with a matching _id.
- *
- * ####Example:
- *
- * var embeddedDoc = m.array.id(some_id);
- *
- * @return {EmbeddedDocument|null} the subdocument or null if not found.
- * @param {ObjectId|String|Number|Buffer} id
- * @TODO cast to the _id based on schema for proper comparison
- * @method id
- * @api public
- * @receiver MongooseDocumentArray
- */
-
- id: function(id) {
- let casted;
- let sid;
- let _id;
-
- try {
- casted = castObjectId(id).toString();
- } catch (e) {
- casted = null;
- }
-
- for (let i = 0, l = this.length; i < l; i++) {
- if (!this[i]) {
- continue;
- }
- _id = this[i].get('_id');
-
- if (_id === null || typeof _id === 'undefined') {
- continue;
- } else if (_id instanceof Document) {
- sid || (sid = String(id));
- if (sid == _id._id) {
- return this[i];
- }
- } else if (!(id instanceof ObjectId) && !(_id instanceof ObjectId)) {
- if (utils.deepEqual(id, _id)) {
- return this[i];
- }
- } else if (casted == _id) {
- return this[i];
- }
- }
-
- return null;
- },
-
- /**
- * Returns a native js Array of plain js objects
- *
- * ####NOTE:
- *
- * _Each sub-document is converted to a plain object by calling its `#toObject` method._
- *
- * @param {Object} [options] optional options to pass to each documents `toObject` method call during conversion
- * @return {Array}
- * @method toObject
- * @api public
- * @receiver MongooseDocumentArray
- */
-
- toObject: function(options) {
- return this.map(function(doc) {
- try {
- return doc.toObject(options);
- } catch (e) {
- return doc || null;
- }
- });
- },
-
- /**
- * Helper for console.log
- *
- * @method inspect
- * @api public
- * @receiver MongooseDocumentArray
- */
-
- inspect: function() {
- return this.toObject();
- },
-
- /**
- * Creates a subdocument casted to this schema.
- *
- * This is the same subdocument constructor used for casting.
- *
- * @param {Object} obj the value to cast to this arrays SubDocument schema
- * @method create
- * @api public
- * @receiver MongooseDocumentArray
- */
-
- create: function(obj) {
- let Constructor = this._schema.casterConstructor;
- if (obj &&
- Constructor.discriminators &&
- Constructor.schema &&
- Constructor.schema.options &&
- Constructor.schema.options.discriminatorKey) {
- if (typeof obj[Constructor.schema.options.discriminatorKey] === 'string' &&
- Constructor.discriminators[obj[Constructor.schema.options.discriminatorKey]]) {
- Constructor = Constructor.discriminators[obj[Constructor.schema.options.discriminatorKey]];
- } else {
- const constructorByValue = getDiscriminatorByValue(Constructor, obj[Constructor.schema.options.discriminatorKey]);
- if (constructorByValue) {
- Constructor = constructorByValue;
- }
- }
- }
-
- return new Constructor(obj);
- },
-
- /**
- * Creates a fn that notifies all child docs of `event`.
- *
- * @param {String} event
- * @return {Function}
- * @method notify
- * @api private
- * @receiver MongooseDocumentArray
- */
-
- notify: function notify(event) {
- const _this = this;
- return function notify(val, _arr) {
- _arr = _arr || _this;
- let i = _arr.length;
- while (i--) {
- if (_arr[i] == null) {
- continue;
- }
- switch (event) {
- // only swap for save event for now, we may change this to all event types later
- case 'save':
- val = _this[i];
- break;
- default:
- // NO-OP
- break;
- }
-
- if (_arr[i].isMongooseArray) {
- notify(val, _arr[i]);
- } else if (_arr[i]) {
- _arr[i].emit(event, val);
- }
- }
- };
- }
-
- };
-
- /*!
- * Module exports.
- */
-
- module.exports = MongooseDocumentArray;
|