mongoose 5.5.2 → 5.5.3

package/History.md

@@ -1,3 +1,16 @@
+5.5.3 / 2019-04-22
+==================
+ * fix: add findAndModify deprecation warning that references the useFindAndModify option #7644
+ * fix(document): handle pushing a doc onto a discriminator that contains a doc array #7704
+ * fix(update): run setters on array elements when doing $set #7679
+ * fix: correct usage of arguments while buffering commands #7718 [rzymek](https://github.com/rzymek)
+ * fix(document): avoid error clearing modified subpaths if doc not defined #7715 [bitflower](https://github.com/bitflower)
+ * refactor(array): move `_parent` property behind a symbol #7726 #7700
+ * docs(model): list out all operations and options for `bulkWrite()` #7055
+ * docs(aggregate): use `eachAsync()` instead of nonexistent `each()` #7699
+ * docs(validation): add CastError validation example #7514
+ * docs(query+model): list out all options and callback details for Model.updateX() and Query#updateX() #7646
+
 5.5.2 / 2019-04-16
 ==================
  * fix(document): support setting nested path to non-POJO object #7639

package/lib/aggregate.js

@@ -802,7 +802,7 @@ Aggregate.prototype.option = function(value) {
  * ####Example:
  *
  *     var cursor = Model.aggregate(..).cursor({ batchSize: 1000 }).exec();
- *     cursor.each(function(error, doc) {
+ *     cursor.eachAsync(function(error, doc) {
  *       // use doc
  *     });
  *

package/lib/drivers/node-mongodb-native/collection.js

@@ -116,7 +116,7 @@ const syncCollectionMethods = { watch: true };
 function iter(i) {
   NativeCollection.prototype[i] = function() {
     const collection = this.collection;
-    const args = arguments;
+    const args = Array.from(arguments);
     const _this = this;
     const debug = get(_this, 'conn.base.options.debug');
     const lastArg = arguments[arguments.length - 1];
@@ -130,11 +130,11 @@ function iter(i) {
         throw new Error('Collection method ' + i + ' is synchronous');
       }
       if (typeof lastArg === 'function') {
-        this.addQueue(i, arguments);
+        this.addQueue(i, args);
         return;
       }
       return new this.Promise((resolve, reject) => {
-        this.addQueue(i, [].concat(arguments).concat([(err, res) => {
+        this.addQueue(i, [].concat(args).concat([(err, res) => {
           if (err != null) {
             return reject(err);
           }

package/lib/drivers/node-mongodb-native/index.js

@@ -8,4 +8,4 @@ exports.Binary = require('./binary');
 exports.Collection = require('./collection');
 exports.Decimal128 = require('./decimal128');
 exports.ObjectId = require('./objectid');
-exports.ReadPreference = require('./ReadPreference');
+exports.ReadPreference = require('./ReadPreference');

package/lib/helpers/document/cleanModifiedSubpaths.js

@@ -9,6 +9,9 @@ module.exports = function cleanModifiedSubpaths(doc, path, options) {
   const skipDocArrays = options.skipDocArrays;
 
   let deleted = 0;
+  if (!doc) {
+    return deleted;
+  }
   for (const modifiedPath of Object.keys(doc.$__.activePaths.states.modify)) {
     if (skipDocArrays) {
       const schemaType = doc.schema.path(modifiedPath);

package/lib/helpers/query/castUpdate.js

@@ -392,8 +392,6 @@ function castUpdateVal(schema, val, op, $conditional, context, path) {
       tmp = tmp[0];
     }
     return tmp;
-  } else if (cond && op === '$set') {
-    return schema.cast(val);
   }
 
   if (op in noCastOps) {

package/lib/helpers/symbols.js

@@ -1,13 +1,9 @@
 'use strict';
 
-exports.validatorErrorSymbol = Symbol.for('mongoose:validatorError');
-
+exports.arrayParentSymbol = Symbol('mongoose#Array#_parent');
 exports.documentArrayParent = Symbol.for('mongoose:documentArrayParent');
-
-exports.modelSymbol = Symbol.for('mongoose#Model');
-
 exports.getSymbol = Symbol.for('mongoose#Document#get');
-
+exports.modelSymbol = Symbol.for('mongoose#Model');
 exports.objectIdSymbol = Symbol.for('mongoose#ObjectId');
-
-exports.schemaTypeSymbol = Symbol.for('mongoose#schemaType');
+exports.schemaTypeSymbol = Symbol.for('mongoose#schemaType');
+exports.validatorErrorSymbol = Symbol.for('mongoose:validatorError');

package/lib/model.js

@@ -3168,7 +3168,32 @@ Model.$__insertMany = function(arr, options, callback) {
  *      console.log(res.insertedCount, res.modifiedCount, res.deletedCount);
  *     });
  *
+ * The [supported operations](https://docs.mongodb.com/manual/reference/method/db.collection.bulkWrite/#db.collection.bulkWrite) are:
+ *
+ * - `insertOne`
+ * - `updateOne`
+ * - `updateMany`
+ * - `deleteOne`
+ * - `deleteMany`
+ * - `replaceOne`
+ *
  * @param {Array} ops
+ * @param {Object} [ops.insertOne.document] The document to insert
+ * @param {Object} [opts.updateOne.filter] Update the first document that matches this filter
+ * @param {Object} [opts.updateOne.update] An object containing [update operators](https://docs.mongodb.com/manual/reference/operator/update/)
+ * @param {Boolean} [opts.updateOne.upsert=false] If true, insert a doc if none match
+ * @param {Object} [opts.updateOne.collation] The [MongoDB collation](https://thecodebarbarian.com/a-nodejs-perspective-on-mongodb-34-collations) to use
+ * @param {Array} [opts.updateOne.arrayFilters] The [array filters](https://thecodebarbarian.com/a-nodejs-perspective-on-mongodb-36-array-filters.html) used in `update`
+ * @param {Object} [opts.updateMany.filter] Update all the documents that match this filter
+ * @param {Object} [opts.updateMany.update] An object containing [update operators](https://docs.mongodb.com/manual/reference/operator/update/)
+ * @param {Boolean} [opts.updateMany.upsert=false] If true, insert a doc if no documents match `filter`
+ * @param {Object} [opts.updateMany.collation] The [MongoDB collation](https://thecodebarbarian.com/a-nodejs-perspective-on-mongodb-34-collations) to use
+ * @param {Array} [opts.updateMany.arrayFilters] The [array filters](https://thecodebarbarian.com/a-nodejs-perspective-on-mongodb-36-array-filters.html) used in `update`
+ * @param {Object} [opts.deleteOne.filter] Delete the first document that matches this filter
+ * @param {Object} [opts.deleteMany.filter] Delete all documents that match this filter
+ * @param {Object} [opts.replaceOne.filter] Replace the first document that matches this filter
+ * @param {Object} [opts.replaceOne.replacement] The replacement document
+ * @param {Boolean} [opts.replaceOne.upsert=false] If true, insert a doc if no documents match `filter`
  * @param {Object} [options]
  * @param {Boolean} [options.ordered=true] If true, execute writes in order and stop at the first error. If false, execute writes in parallel and continue until all writes have either succeeded or errored.
  * @param {ClientSession} [options.session=null] The session associated with this bulk write. See [transactions docs](/docs/transactions.html).
@@ -3305,9 +3330,17 @@ Model.hydrate = function(obj) {
  * @param {Object} conditions
  * @param {Object} doc
  * @param {Object} [options] optional see [`Query.prototype.setOptions()`](http://mongoosejs.com/docs/api.html#query_Query-setOptions)
+ * @param {Boolean|String} [options.strict] overwrites the schema's [strict mode option](http://mongoosejs.com/docs/guide.html#strict)
+ * @param {Boolean} [options.upsert=false] if true, and no documents found, insert a new document
+ * @param {Object} [options.writeConcern=null] sets the [write concern](https://docs.mongodb.com/manual/reference/write-concern/) for replica sets. Overrides the [schema-level write concern](/docs/guide.html#writeConcern)
+ * @param {Boolean} [options.omitUndefined=false] If true, delete any properties whose value is `undefined` when casting an update. In other words, if this is set, Mongoose will delete `baz` from the update in `Model.updateOne({}, { foo: 'bar', baz: undefined })` before sending the update to the server.
+ * @param {Boolean} [options.timestamps=null] If set to `false` and [schema-level timestamps](/docs/guide.html#timestamps) are enabled, skip timestamps for this update. Does nothing if schema-level timestamps are not set.
+ * @param {Function} [callback] params are (error, writeOpResult)
  * @param {Function} [callback]
  * @return {Query}
  * @see MongoDB docs https://docs.mongodb.com/manual/reference/command/update/#update-command-output
+ * @see writeOpResult http://mongodb.github.io/node-mongodb-native/2.2/api/Collection.html#~WriteOpResult
+ * @see Query docs https://mongoosejs.com/docs/queries.html
  * @api public
  */
 
@@ -3336,10 +3369,15 @@ Model.update = function update(conditions, doc, options, callback) {
  * @param {Object} doc
  * @param {Object} [options] optional see [`Query.prototype.setOptions()`](http://mongoosejs.com/docs/api.html#query_Query-setOptions)
  * @param {Boolean|String} [options.strict] overwrites the schema's [strict mode option](http://mongoosejs.com/docs/guide.html#strict)
+ * @param {Boolean} [options.upsert=false] if true, and no documents found, insert a new document
+ * @param {Object} [options.writeConcern=null] sets the [write concern](https://docs.mongodb.com/manual/reference/write-concern/) for replica sets. Overrides the [schema-level write concern](/docs/guide.html#writeConcern)
  * @param {Boolean} [options.omitUndefined=false] If true, delete any properties whose value is `undefined` when casting an update. In other words, if this is set, Mongoose will delete `baz` from the update in `Model.updateOne({}, { foo: 'bar', baz: undefined })` before sending the update to the server.
- * @param {Function} [callback]
+ * @param {Boolean} [options.timestamps=null] If set to `false` and [schema-level timestamps](/docs/guide.html#timestamps) are enabled, skip timestamps for this update. Does nothing if schema-level timestamps are not set.
+ * @param {Function} [callback] `function(error, res) {}` where `res` has 3 properties: `n`, `nModified`, `ok`.
  * @return {Query}
+ * @see Query docs https://mongoosejs.com/docs/queries.html
  * @see MongoDB docs https://docs.mongodb.com/manual/reference/command/update/#update-command-output
+ * @see writeOpResult http://mongodb.github.io/node-mongodb-native/2.2/api/Collection.html#~WriteOpResult
  * @api public
  */
 
@@ -3367,10 +3405,15 @@ Model.updateMany = function updateMany(conditions, doc, options, callback) {
  * @param {Object} doc
  * @param {Object} [options] optional see [`Query.prototype.setOptions()`](http://mongoosejs.com/docs/api.html#query_Query-setOptions)
  * @param {Boolean|String} [options.strict] overwrites the schema's [strict mode option](http://mongoosejs.com/docs/guide.html#strict)
+ * @param {Boolean} [options.upsert=false] if true, and no documents found, insert a new document
+ * @param {Object} [options.writeConcern=null] sets the [write concern](https://docs.mongodb.com/manual/reference/write-concern/) for replica sets. Overrides the [schema-level write concern](/docs/guide.html#writeConcern)
  * @param {Boolean} [options.omitUndefined=false] If true, delete any properties whose value is `undefined` when casting an update. In other words, if this is set, Mongoose will delete `baz` from the update in `Model.updateOne({}, { foo: 'bar', baz: undefined })` before sending the update to the server.
- * @param {Function} [callback]
+ * @param {Boolean} [options.timestamps=null] If set to `false` and [schema-level timestamps](/docs/guide.html#timestamps) are enabled, skip timestamps for this update. Does nothing if schema-level timestamps are not set.
+ * @param {Function} [callback] params are (error, writeOpResult)
  * @return {Query}
+ * @see Query docs https://mongoosejs.com/docs/queries.html
  * @see MongoDB docs https://docs.mongodb.com/manual/reference/command/update/#update-command-output
+ * @see writeOpResult http://mongodb.github.io/node-mongodb-native/2.2/api/Collection.html#~WriteOpResult
  * @api public
  */
 
@@ -3395,8 +3438,14 @@ Model.updateOne = function updateOne(conditions, doc, options, callback) {
  * @param {Object} doc
  * @param {Object} [options] optional see [`Query.prototype.setOptions()`](http://mongoosejs.com/docs/api.html#query_Query-setOptions)
  * @param {Boolean|String} [options.strict] overwrites the schema's [strict mode option](http://mongoosejs.com/docs/guide.html#strict)
+ * @param {Boolean} [options.upsert=false] if true, and no documents found, insert a new document
+ * @param {Object} [options.writeConcern=null] sets the [write concern](https://docs.mongodb.com/manual/reference/write-concern/) for replica sets. Overrides the [schema-level write concern](/docs/guide.html#writeConcern)
  * @param {Boolean} [options.omitUndefined=false] If true, delete any properties whose value is `undefined` when casting an update. In other words, if this is set, Mongoose will delete `baz` from the update in `Model.updateOne({}, { foo: 'bar', baz: undefined })` before sending the update to the server.
- * @param {Function} [callback]
+ * @param {Boolean} [options.timestamps=null] If set to `false` and [schema-level timestamps](/docs/guide.html#timestamps) are enabled, skip timestamps for this update. Does nothing if schema-level timestamps are not set.
+ * @param {Function} [callback] `function(error, res) {}` where `res` has 3 properties: `n`, `nModified`, `ok`.
+ * @return {Query}
+ * @see Query docs https://mongoosejs.com/docs/queries.html
+ * @see writeOpResult http://mongodb.github.io/node-mongodb-native/2.2/api/Collection.html#~WriteOpResult
  * @return {Query}
  * @api public
  */
@@ -4438,7 +4487,7 @@ function convertTo_id(val) {
       }
     }
     if (val.isMongooseArray && val._schema) {
-      return val._schema.cast(val, val._parent);
+      return val._schema.cast(val, val.$parent());
     }
 
     return [].concat(val);

package/lib/query.js

@@ -3419,12 +3419,7 @@ Query.prototype._findAndModify = function(type, callback) {
       if (error) {
         return callback(error);
       }
-      if (castedDoc && castedDoc.toBSON) {
-        castedDoc = castedDoc.toBSON();
-      }
-      _this._collection.findAndModify(castedQuery, castedDoc, opts, _wrapThunkCallback(_this, function(error, res) {
-        return cb(error, res ? res.value : res, res);
-      }));
+      _legacyFindAndModify.call(_this, castedQuery, castedDoc, opts, callback);
     };
 
     try {
@@ -3433,12 +3428,7 @@ Query.prototype._findAndModify = function(type, callback) {
       callback(error);
     }
   } else {
-    if (castedDoc && castedDoc.toBSON) {
-      castedDoc = castedDoc.toBSON();
-    }
-    this._collection.findAndModify(castedQuery, castedDoc, opts, _wrapThunkCallback(_this, function(error, res) {
-      return cb(error, res ? res.value : res, res);
-    }));
+    _legacyFindAndModify.call(_this, castedQuery, castedDoc, opts, callback);
   }
 
   return this;
@@ -3455,6 +3445,23 @@ function _completeOneLean(doc, res, opts, callback) {
   return callback(null, doc);
 }
 
+
+/*!
+ * ignore
+ */
+
+const _legacyFindAndModify = util.deprecate(function(filter, update, opts, cb) {
+  if (update && update.toBSON) {
+    update = update.toBSON();
+  }
+  const collection = this._collection;
+  collection.findAndModify(filter, update, opts, _wrapThunkCallback(this, function(error, res) {
+    return cb(error, res ? res.value : res, res);
+  }));
+}, 'Mongoose: `findOneAndUpdate()` and `findOneAndDelete()` without the ' +
+  '`useFindAndModify` option set to false are deprecated. See: ' +
+  'https://mongoosejs.com/docs/deprecations.html#-findandmodify-');
+
 /*!
  * Override mquery.prototype._mergeUpdate to handle mongoose objects in
  * updates.
@@ -3716,9 +3723,16 @@ Query.prototype._replaceOne = wrapThunk(function(callback) {
  * @param {Object} [doc] the update command
  * @param {Object} [options]
  * @param {Boolean} [options.multipleCastError] by default, mongoose only returns the first error that occurred in casting the query. Turn on this option to aggregate all the cast errors.
- * @param {Function} [callback] optional, params are (error, writeOpResult)
+ * @param {Boolean} [options.omitUndefined=false] If true, delete any properties whose value is `undefined` when casting an update. In other words, if this is set, Mongoose will delete `baz` from the update in `Model.updateOne({}, { foo: 'bar', baz: undefined })` before sending the update to the server.
+ * @param {Boolean|String} [options.strict] overwrites the schema's [strict mode option](http://mongoosejs.com/docs/guide.html#strict)
+ * @param {Boolean} [options.upsert=false] if true, and no documents found, insert a new document
+ * @param {Object} [options.writeConcern=null] sets the [write concern](https://docs.mongodb.com/manual/reference/write-concern/) for replica sets. Overrides the [schema-level write concern](/docs/guide.html#writeConcern)
+ * @param {Boolean} [options.omitUndefined=false] If true, delete any properties whose value is `undefined` when casting an update. In other words, if this is set, Mongoose will delete `baz` from the update in `Model.updateOne({}, { foo: 'bar', baz: undefined })` before sending the update to the server.
+ * @param {Boolean} [options.timestamps=null] If set to `false` and [schema-level timestamps](/docs/guide.html#timestamps) are enabled, skip timestamps for this update. Does nothing if schema-level timestamps are not set.
+ * @param {Function} [callback] params are (error, writeOpResult)
  * @return {Query} this
  * @see Model.update #model_Model.update
+ * @see Query docs https://mongoosejs.com/docs/queries.html
  * @see update http://docs.mongodb.org/manual/reference/method/db.collection.update/
  * @see writeOpResult http://mongodb.github.io/node-mongodb-native/2.2/api/Collection.html#~WriteOpResult
  * @see MongoDB docs https://docs.mongodb.com/manual/reference/command/update/#update-command-output
@@ -3776,9 +3790,15 @@ Query.prototype.update = function(conditions, doc, options, callback) {
  * @param {Object} [options]
  * @param {Boolean} [options.multipleCastError] by default, mongoose only returns the first error that occurred in casting the query. Turn on this option to aggregate all the cast errors.
  * @param {Boolean} [options.omitUndefined=false] If true, delete any properties whose value is `undefined` when casting an update. In other words, if this is set, Mongoose will delete `baz` from the update in `Model.updateOne({}, { foo: 'bar', baz: undefined })` before sending the update to the server.
- * @param {Function} [callback] optional params are (error, writeOpResult)
+ * @param {Boolean|String} [options.strict] overwrites the schema's [strict mode option](http://mongoosejs.com/docs/guide.html#strict)
+ * @param {Boolean} [options.upsert=false] if true, and no documents found, insert a new document
+ * @param {Object} [options.writeConcern=null] sets the [write concern](https://docs.mongodb.com/manual/reference/write-concern/) for replica sets. Overrides the [schema-level write concern](/docs/guide.html#writeConcern)
+ * @param {Boolean} [options.omitUndefined=false] If true, delete any properties whose value is `undefined` when casting an update. In other words, if this is set, Mongoose will delete `baz` from the update in `Model.updateOne({}, { foo: 'bar', baz: undefined })` before sending the update to the server.
+ * @param {Boolean} [options.timestamps=null] If set to `false` and [schema-level timestamps](/docs/guide.html#timestamps) are enabled, skip timestamps for this update. Does nothing if schema-level timestamps are not set.
+ * @param {Function} [callback] params are (error, writeOpResult)
  * @return {Query} this
  * @see Model.update #model_Model.update
+ * @see Query docs https://mongoosejs.com/docs/queries.html
  * @see update http://docs.mongodb.org/manual/reference/method/db.collection.update/
  * @see writeOpResult http://mongodb.github.io/node-mongodb-native/2.2/api/Collection.html#~WriteOpResult
  * @see MongoDB docs https://docs.mongodb.com/manual/reference/command/update/#update-command-output
@@ -3837,9 +3857,15 @@ Query.prototype.updateMany = function(conditions, doc, options, callback) {
  * @param {Object} [options]
  * @param {Boolean} [options.multipleCastError] by default, mongoose only returns the first error that occurred in casting the query. Turn on this option to aggregate all the cast errors.
  * @param {Boolean} [options.omitUndefined=false] If true, delete any properties whose value is `undefined` when casting an update. In other words, if this is set, Mongoose will delete `baz` from the update in `Model.updateOne({}, { foo: 'bar', baz: undefined })` before sending the update to the server.
+ * @param {Boolean|String} [options.strict] overwrites the schema's [strict mode option](http://mongoosejs.com/docs/guide.html#strict)
+ * @param {Boolean} [options.upsert=false] if true, and no documents found, insert a new document
+ * @param {Object} [options.writeConcern=null] sets the [write concern](https://docs.mongodb.com/manual/reference/write-concern/) for replica sets. Overrides the [schema-level write concern](/docs/guide.html#writeConcern)
+ * @param {Boolean} [options.omitUndefined=false] If true, delete any properties whose value is `undefined` when casting an update. In other words, if this is set, Mongoose will delete `baz` from the update in `Model.updateOne({}, { foo: 'bar', baz: undefined })` before sending the update to the server.
+ * @param {Boolean} [options.timestamps=null] If set to `false` and [schema-level timestamps](/docs/guide.html#timestamps) are enabled, skip timestamps for this update. Does nothing if schema-level timestamps are not set.
  * @param {Function} [callback] params are (error, writeOpResult)
  * @return {Query} this
  * @see Model.update #model_Model.update
+ * @see Query docs https://mongoosejs.com/docs/queries.html
  * @see update http://docs.mongodb.org/manual/reference/method/db.collection.update/
  * @see writeOpResult http://mongodb.github.io/node-mongodb-native/2.2/api/Collection.html#~WriteOpResult
  * @see MongoDB docs https://docs.mongodb.com/manual/reference/command/update/#update-command-output
@@ -3894,10 +3920,17 @@ Query.prototype.updateOne = function(conditions, doc, options, callback) {
  * @param {Object} [criteria]
  * @param {Object} [doc] the update command
  * @param {Object} [options]
+ * @param {Boolean} [options.multipleCastError] by default, mongoose only returns the first error that occurred in casting the query. Turn on this option to aggregate all the cast errors.
  * @param {Boolean} [options.omitUndefined=false] If true, delete any properties whose value is `undefined` when casting an update. In other words, if this is set, Mongoose will delete `baz` from the update in `Model.updateOne({}, { foo: 'bar', baz: undefined })` before sending the update to the server.
- * @param {Function} [callback] optional params are (error, writeOpResult)
+ * @param {Boolean|String} [options.strict] overwrites the schema's [strict mode option](http://mongoosejs.com/docs/guide.html#strict)
+ * @param {Boolean} [options.upsert=false] if true, and no documents found, insert a new document
+ * @param {Object} [options.writeConcern=null] sets the [write concern](https://docs.mongodb.com/manual/reference/write-concern/) for replica sets. Overrides the [schema-level write concern](/docs/guide.html#writeConcern)
+ * @param {Boolean} [options.omitUndefined=false] If true, delete any properties whose value is `undefined` when casting an update. In other words, if this is set, Mongoose will delete `baz` from the update in `Model.updateOne({}, { foo: 'bar', baz: undefined })` before sending the update to the server.
+ * @param {Boolean} [options.timestamps=null] If set to `false` and [schema-level timestamps](/docs/guide.html#timestamps) are enabled, skip timestamps for this update. Does nothing if schema-level timestamps are not set.
+ * @param {Function} [callback] params are (error, writeOpResult)
  * @return {Query} this
  * @see Model.update #model_Model.update
+ * @see Query docs https://mongoosejs.com/docs/queries.html
  * @see update http://docs.mongodb.org/manual/reference/method/db.collection.update/
  * @see writeOpResult http://mongodb.github.io/node-mongodb-native/2.2/api/Collection.html#~WriteOpResult
  * @see MongoDB docs https://docs.mongodb.com/manual/reference/command/update/#update-command-output

package/lib/schema/documentarray.js

@@ -13,6 +13,8 @@ const util = require('util');
 const utils = require('../utils');
 const getDiscriminatorByValue = require('../queryhelpers').getDiscriminatorByValue;
 
+const arrayParentSymbol = require('../helpers/symbols').arrayParentSymbol;
+
 let MongooseDocumentArray;
 let Subdocument;
 
@@ -290,8 +292,8 @@ DocumentArray.prototype.getDefault = function(scope) {
   }
 
   ret = new MongooseDocumentArray(ret, this.path, scope);
-  const _parent = ret._parent;
-  ret._parent = null;
+  const _parent = ret[arrayParentSymbol];
+  ret[arrayParentSymbol] = null;
 
   for (let i = 0; i < ret.length; ++i) {
     const Constructor = getConstructor(this, ret[i]);
@@ -299,7 +301,7 @@ DocumentArray.prototype.getDefault = function(scope) {
       undefined, i);
   }
 
-  ret._parent = _parent;
+  ret[arrayParentSymbol] = _parent;
 
   return ret;
 };
@@ -354,7 +356,7 @@ DocumentArray.prototype.cast = function(value, doc, init, prev, options) {
 
     // Check if the document has a different schema (re gh-3701)
     if ((value[i].$__) &&
-        value[i].schema !== Constructor.schema) {
+        !(value[i] instanceof Constructor)) {
       value[i] = value[i].toObject({ transform: false, virtuals: false });
     }
 
@@ -444,12 +446,12 @@ DocumentArray.prototype.clone = function() {
  */
 
 function _clearListeners(arr) {
-  if (arr == null || arr._parent == null) {
+  if (arr == null || arr[arrayParentSymbol] == null) {
     return;
   }
 
   for (const key in arr._handlers) {
-    arr._parent.removeListener(key, arr._handlers[key]);
+    arr[arrayParentSymbol].removeListener(key, arr._handlers[key]);
   }
 }
 

package/lib/types/array.js

@@ -13,6 +13,7 @@ const internalToObjectOptions = require('../options').internalToObjectOptions;
 const utils = require('../utils');
 const util = require('util');
 
+const arrayParentSymbol = require('../helpers/symbols').arrayParentSymbol;
 const isMongooseObject = utils.isMongooseObject;
 
 /**
@@ -53,7 +54,7 @@ function MongooseArray(values, path, doc) {
   // 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[arrayParentSymbol] = doc;
     arr._schema = doc.schema.path(path);
   }
 
@@ -77,15 +78,13 @@ MongooseArray.mixin = {
 
   _atomics: undefined,
 
-  /**
-   * Parent owner document
-   *
-   * @property _parent
-   * @api private
-   * @memberOf MongooseArray
+  /*!
+   * ignore
    */
 
-  _parent: undefined,
+  $parent: function() {
+    return this[arrayParentSymbol];
+  },
 
   /**
    * Casts a member based on this arrays schema.
@@ -101,8 +100,8 @@ MongooseArray.mixin = {
     let populated = false;
     let Model;
 
-    if (this._parent) {
-      populated = this._parent.populated(this._path, true);
+    if (this[arrayParentSymbol]) {
+      populated = this[arrayParentSymbol].populated(this._path, true);
     }
 
     if (populated && value !== null && value !== undefined) {
@@ -123,10 +122,10 @@ MongooseArray.mixin = {
       if (!isDisc) {
         value = new Model(value);
       }
-      return this._schema.caster.applySetters(value, this._parent, true);
+      return this._schema.caster.applySetters(value, this[arrayParentSymbol], true);
     }
 
-    return this._schema.caster.applySetters(value, this._parent, false);
+    return this._schema.caster.applySetters(value, this[arrayParentSymbol], false);
   },
 
   /**
@@ -142,7 +141,7 @@ MongooseArray.mixin = {
    */
 
   _markModified: function(elem, embeddedPath) {
-    const parent = this._parent;
+    const parent = this[arrayParentSymbol];
     let dirtyPath;
 
     if (parent) {
@@ -179,7 +178,7 @@ MongooseArray.mixin = {
       // $set takes precedence over all other ops.
       // mark entire array modified.
       this._atomics = {$set: val};
-      cleanModifiedSubpaths(this._parent, this._path);
+      cleanModifiedSubpaths(this[arrayParentSymbol], this._path);
       this._markModified();
       return this;
     }
@@ -189,7 +188,7 @@ MongooseArray.mixin = {
     // reset pop/shift after save
     if (op === '$pop' && !('$pop' in atomics)) {
       const _this = this;
-      this._parent.once('save', function() {
+      this[arrayParentSymbol].once('save', function() {
         _this._popped = _this._shifted = null;
       });
     }
@@ -322,7 +321,7 @@ MongooseArray.mixin = {
   push: function() {
     _checkManualPopulation(this, arguments);
     let values = [].map.call(arguments, this._mapCast, this);
-    values = this._schema.applySetters(values, this._parent, undefined,
+    values = this._schema.applySetters(values, this[arrayParentSymbol], undefined,
       undefined, { skipDocumentArrayCast: true });
     const ret = [].push.apply(this, values);
 
@@ -527,7 +526,7 @@ MongooseArray.mixin = {
 
   pull: function() {
     const values = [].map.call(arguments, this._cast, this);
-    const cur = this._parent.get(this._path);
+    const cur = this[arrayParentSymbol].get(this._path);
     let i = cur.length;
     let mem;
 
@@ -559,7 +558,7 @@ MongooseArray.mixin = {
     // `doc.children[1].name = 'test';` followed by
     // `doc.children.remove(doc.children[0]);`. In this case we fall back
     // to a `$set` on the whole array. See #3511
-    if (cleanModifiedSubpaths(this._parent, this._path) > 0) {
+    if (cleanModifiedSubpaths(this[arrayParentSymbol], this._path) > 0) {
       this._registerAtomic('$set', this);
     }
 
@@ -613,7 +612,7 @@ MongooseArray.mixin = {
     _checkManualPopulation(this, arguments);
 
     let values = [].map.call(arguments, this._cast, this);
-    values = this._schema.applySetters(values, this._parent);
+    values = this._schema.applySetters(values, this[arrayParentSymbol]);
     [].unshift.apply(this, values);
     this._registerAtomic('$set', this);
     this._markModified();
@@ -659,7 +658,7 @@ MongooseArray.mixin = {
     _checkManualPopulation(this, arguments);
 
     let values = [].map.call(arguments, this._mapCast, this);
-    values = this._schema.applySetters(values, this._parent);
+    values = this._schema.applySetters(values, this[arrayParentSymbol]);
     const added = [];
     let type = '';
     if (values[0] instanceof EmbeddedDocument) {
@@ -835,7 +834,7 @@ function _checkManualPopulation(arr, docs) {
   if (arr.length === 0 &&
       docs.length > 0) {
     if (_isAllSubdocs(docs, ref)) {
-      arr._parent.populated(arr._path, [], { model: docs[0].constructor });
+      arr[arrayParentSymbol].populated(arr._path, [], { model: docs[0].constructor });
     }
   }
 }

package/lib/types/documentarray.js

@@ -14,6 +14,7 @@ const internalToObjectOptions = require('../options').internalToObjectOptions;
 const util = require('util');
 const utils = require('../utils');
 
+const arrayParentSymbol = require('../helpers/symbols').arrayParentSymbol;
 const documentArrayParent = require('../helpers/symbols').documentArrayParent;
 
 /*!
@@ -56,7 +57,7 @@ function MongooseDocumentArray(values, path, doc) {
   if (Array.isArray(values)) {
     if (values instanceof CoreMongooseArray &&
         values._path === path &&
-        values._parent === doc) {
+        values[arrayParentSymbol] === doc) {
       props._atomics = Object.assign({}, values._atomics);
     }
     values.forEach(v => {
@@ -93,7 +94,7 @@ function MongooseDocumentArray(values, path, doc) {
   // 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[arrayParentSymbol] = doc;
     arr._schema = doc.schema.path(path);
 
     // `schema.path()` doesn't drill into nested arrays properly yet, see
@@ -153,7 +154,7 @@ MongooseDocumentArray.mixin = {
         (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[documentArrayParent] = this[arrayParentSymbol];
         value.__parentArray = this;
       }
       value.$setIndex(index);

package/lib/types/embedded.js

@@ -30,7 +30,7 @@ const validatorErrorSymbol = require('../helpers/symbols').validatorErrorSymbol;
 function EmbeddedDocument(obj, parentArr, skipId, fields, index) {
   if (parentArr) {
     this.__parentArray = parentArr;
-    this[documentArrayParent] = parentArr._parent;
+    this[documentArrayParent] = parentArr.$parent();
   } else {
     this.__parentArray = undefined;
     this[documentArrayParent] = undefined;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mongoose",
   "description": "Mongoose MongoDB ODM",
-  "version": "5.5.2",
+  "version": "5.5.3",
   "author": "Guillermo Rauch <guillermo@learnboost.com>",
   "keywords": [
     "mongodb",