mongoose 5.4.0 → 5.4.4

package/lib/model.js

@@ -171,26 +171,49 @@ Model.prototype.baseModelName;
  *     MyModel.events.on('error', err => console.log(err.message));
  *
  *     // Prints a 'CastError' because of the above handler
- *     await MyModel.findOne({ _id: 'notanid' }).catch({} => {});
+ *     await MyModel.findOne({ _id: 'notanid' }).catch(noop);
  *
  * @api public
  * @fires error whenever any query or model function errors
- * @property events
  * @memberOf Model
- * @static
+ * @static events
  */
 
 Model.events;
 
+/*!
+ * Compiled middleware for this model. Set in `applyHooks()`.
+ *
+ * @api private
+ * @property _middleware
+ * @memberOf Model
+ * @static
+ */
+
+Model._middleware;
+
+/*!
+ * ignore
+ */
+
+function _applyCustomWhere(doc, where) {
+  if (doc.$where == null) {
+    return;
+  }
+
+  const keys = Object.keys(doc.$where);
+  const len = keys.length;
+  for (let i = 0; i < len; ++i) {
+    where[keys[i]] = doc.$where[keys[i]];
+  }
+}
+
 /*!
  * ignore
  */
 
 Model.prototype.$__handleSave = function(options, callback) {
   const _this = this;
-  let i;
-  let keys;
-  let len;
   let saveOptions = {};
 
   if ('safe' in options) {
@@ -274,13 +297,7 @@ Model.prototype.$__handleSave = function(options, callback) {
         return;
       }
 
-      if (this.$where) {
-        keys = Object.keys(this.$where);
-        len = keys.length;
-        for (i = 0; i < len; ++i) {
-          where[keys[i]] = this.$where[keys[i]];
-        }
-      }
+      _applyCustomWhere(this, where);
 
       this[modelCollectionSymbol].updateOne(where, delta[1], saveOptions, function(err, ret) {
         if (err) {
@@ -409,6 +426,7 @@ function generateVersionError(doc, modifiedPaths) {
  * @param {Boolean} [options.j] set to true for MongoDB to wait until this `save()` has been [journaled before resolving the returned promise](https://docs.mongodb.com/manual/reference/write-concern/#j-option). Overrides the [schema-level `writeConcern` option](/docs/guide.html#writeConcern)
  * @param {Number} [options.wtimeout] sets a [timeout for the write concern](https://docs.mongodb.com/manual/reference/write-concern/#wtimeout). Overrides the [schema-level `writeConcern` option](/docs/guide.html#writeConcern).
  * @param {Boolean} [options.checkKeys=true] the MongoDB driver prevents you from saving keys that start with '$' or contain '.' by default. Set this option to `false` to skip that check. See [restrictions on field names](https://docs.mongodb.com/manual/reference/limits/#Restrictions-on-Field-Names)
+ * @param {Boolean} [options.timestamps=true] if `false` and [timestamps](./guide.html#timestamps) are enabled, skip timestamps for this `save()`.
  * @param {Function} [fn] optional callback
  * @return {Promise|undefined} Returns undefined if used with callback or a Promise otherwise.
  * @api public
@@ -447,8 +465,11 @@ Model.prototype.save = function(options, fn) {
       return cb(parallelSave);
     }
 
+    this.$__.saveOptions = options;
+
     this.$__save(options, error => {
       this.$__.saving = undefined;
+      delete this.$__.saveOptions;
 
       if (error) {
         this.$__handleReject(error);
@@ -904,6 +925,8 @@ Model.prototype.$__remove = function $__remove(options, cb) {
     return cb(where);
   }
 
+  _applyCustomWhere(this, where);
+
   this[modelCollectionSymbol].deleteOne(where, options, err => {
     if (!err) {
       this.$__.isDeleted = true;
@@ -3750,7 +3773,11 @@ function populate(model, docs, options, callback) {
 
         for (const doc of docs) {
           try {
-            utils.setValue(mod.options.path, count, doc);
+            if (doc.$__ != null) {
+              doc.set(mod.options.path, count);
+            } else {
+              utils.setValue(mod.options.path, count, doc);
+            }
           } catch (err) {
             return callback(err);
           }
@@ -4370,7 +4397,7 @@ function valueFilter(val, assignmentOpts, populateOptions) {
     const numValues = val.length;
     for (let i = 0; i < numValues; ++i) {
       const subdoc = val[i];
-      if (!isDoc(subdoc) && (!populateOptions.retainNullValues || subdoc != null)) {
+      if (!isPopulatedObject(subdoc) && (!populateOptions.retainNullValues || subdoc != null)) {
         continue;
       }
       maybeRemoveId(subdoc, assignmentOpts);
@@ -4393,7 +4420,7 @@ function valueFilter(val, assignmentOpts, populateOptions) {
   }
 
   // findOne
-  if (isDoc(val)) {
+  if (isPopulatedObject(val)) {
     maybeRemoveId(val, assignmentOpts);
     return val;
   }
@@ -4422,34 +4449,19 @@ function maybeRemoveId(subdoc, assignmentOpts) {
 }
 
 /*!
- * Determine if `doc` is a document returned
- * by a populate query.
+ * Determine if `obj` is something we can set a populated path to. Can be a
+ * document, a lean document, or an array/map that contains docs.
  */
 
-function isDoc(doc) {
-  if (doc == null) {
-    return false;
-  }
-
-  const type = typeof doc;
-  if (type === 'string') {
+function isPopulatedObject(obj) {
+  if (obj == null) {
     return false;
   }
 
-  if (type === 'number') {
-    return false;
-  }
-
-  if (Buffer.isBuffer(doc)) {
-    return false;
-  }
-
-  if (doc.constructor.name === 'ObjectID') {
-    return false;
-  }
-
-  // only docs
-  return true;
+  return Array.isArray(obj) ||
+    obj.$isMongooseMap ||
+    obj.$__ != null ||
+    leanPopulateMap.has(obj);
 }
 
 /*!
@@ -4494,6 +4506,7 @@ Model.compile = function compile(name, schema, collectionName, connection, base)
   model.hooks = schema.s.hooks.clone();
   model.base = base;
   model.modelName = name;
+
   if (!(model.prototype instanceof Model)) {
     model.__proto__ = Model;
     model.prototype.__proto__ = Model.prototype;

package/lib/plugins/sharding.js

@@ -1,5 +1,6 @@
 'use strict';
 
+const objectIdSymbol = require('../helpers/symbols').objectIdSymbol;
 const utils = require('../utils');
 
 /*!
@@ -15,6 +16,10 @@ module.exports = function shardingPlugin(schema) {
     applyWhere.call(this);
     next();
   });
+  schema.pre('remove', function(next) {
+    applyWhere.call(this);
+    next();
+  });
   schema.post('save', function() {
     storeShard.call(this);
   });
@@ -63,11 +68,13 @@ function storeShard() {
 
   for (let i = 0; i < len; ++i) {
     val = this.getValue(paths[i]);
-    if (utils.isMongooseObject(val)) {
+    if (val == null) {
+      orig[paths[i]] = val;
+    } else if (utils.isMongooseObject(val)) {
       orig[paths[i]] = val.toObject({depopulate: true, _isNested: true});
-    } else if (val !== null && val !== undefined && val.valueOf &&
-    // Explicitly don't take value of dates
-        (!val.constructor || utils.getFunctionName(val.constructor) !== 'Date')) {
+    } else if (val instanceof Date || val[objectIdSymbol]) {
+      orig[paths[i]] = val;
+    } else if (typeof val.valueOf === 'function') {
       orig[paths[i]] = val.valueOf();
     } else {
       orig[paths[i]] = val;

package/lib/query.js

@@ -5,11 +5,13 @@
  */
 
 const CastError = require('./error/cast');
+const Kareem = require('kareem');
 const ObjectParameterError = require('./error/objectParameter');
 const QueryCursor = require('./cursor/QueryCursor');
 const ReadPreference = require('./driver').get().ReadPreference;
 const applyWriteConcern = require('./helpers/schema/applyWriteConcern');
 const cast = require('./cast');
+const castArrayFilters = require('./helpers/update/castArrayFilters');
 const castUpdate = require('./helpers/query/castUpdate');
 const completeMany = require('./helpers/query/completeMany');
 const get = require('./helpers/get');
@@ -23,6 +25,7 @@ const slice = require('sliced');
 const updateValidators = require('./helpers/updateValidators');
 const util = require('util');
 const utils = require('./utils');
+const wrapThunk = require('./helpers/query/wrapThunk');
 
 /**
  * Query constructor used for building queries. You do not need
@@ -55,6 +58,8 @@ function Query(conditions, options, model, collection) {
   options = options || {};
 
   this._transforms = [];
+  this._hooks = new Kareem();
+  this._executionCount = 0;
 
   // this is the case where we have a CustomQuery, we need to check if we got
   // options passed in, and if we did, merge them in
@@ -1724,6 +1729,18 @@ Query.prototype._castConditions = function() {
   }
 };
 
+/*!
+ * ignore
+ */
+
+function _castArrayFilters(query) {
+  try {
+    castArrayFilters(query);
+  } catch (err) {
+    query.error(err);
+  }
+}
+
 /**
  * Thunk around find()
  *
@@ -1731,7 +1748,7 @@ Query.prototype._castConditions = function() {
  * @return {Query} this
  * @api private
  */
-Query.prototype._find = function(callback) {
+Query.prototype._find = wrapThunk(function(callback) {
   this._castConditions();
 
   if (this.error() != null) {
@@ -1786,9 +1803,10 @@ Query.prototype._find = function(callback) {
   const options = this._optionsForExec();
   options.projection = this._fieldsForExec();
   const filter = this._conditions;
+
   this._collection.find(filter, options, cb);
   return null;
-};
+});
 
 /**
  * Find all documents that match `selector`. The result will be an array of documents.
@@ -1954,7 +1972,7 @@ Query.prototype._completeOne = function(doc, res, callback) {
  * @api private
  */
 
-Query.prototype._findOne = function(callback) {
+Query.prototype._findOne = wrapThunk(function(callback) {
   this._castConditions();
 
   if (this.error()) {
@@ -1974,7 +1992,7 @@ Query.prototype._findOne = function(callback) {
 
     this._completeOne(doc, null, _wrapThunkCallback(this, callback));
   });
-};
+});
 
 /**
  * Declares the query a findOne operation. When executed, the first found document is passed to the callback.
@@ -2064,7 +2082,7 @@ Query.prototype.findOne = function(conditions, projection, options, callback) {
  * @api private
  */
 
-Query.prototype._count = function(callback) {
+Query.prototype._count = wrapThunk(function(callback) {
   try {
     this.cast(this.model);
   } catch (err) {
@@ -2079,7 +2097,7 @@ Query.prototype._count = function(callback) {
   const options = this._optionsForExec();
 
   this._collection.count(conds, options, utils.tick(callback));
-};
+});
 
 /**
  * Thunk around countDocuments()
@@ -2089,7 +2107,7 @@ Query.prototype._count = function(callback) {
  * @api private
  */
 
-Query.prototype._countDocuments = function(callback) {
+Query.prototype._countDocuments = wrapThunk(function(callback) {
   try {
     this.cast(this.model);
   } catch (err) {
@@ -2104,7 +2122,7 @@ Query.prototype._countDocuments = function(callback) {
   const options = this._optionsForExec();
 
   this._collection.collection.countDocuments(conds, options, utils.tick(callback));
-};
+});
 
 /**
  * Thunk around estimatedDocumentCount()
@@ -2114,7 +2132,7 @@ Query.prototype._countDocuments = function(callback) {
  * @api private
  */
 
-Query.prototype._estimatedDocumentCount = function(callback) {
+Query.prototype._estimatedDocumentCount = wrapThunk(function(callback) {
   if (this.error()) {
     return callback(this.error());
   }
@@ -2122,7 +2140,7 @@ Query.prototype._estimatedDocumentCount = function(callback) {
   const options = this._optionsForExec();
 
   this._collection.collection.estimatedDocumentCount(options, utils.tick(callback));
-};
+});
 
 /**
  * Specifies this query as a `count` query.
@@ -2447,7 +2465,7 @@ Query.prototype.remove = function(filter, callback) {
  * ignore
  */
 
-Query.prototype._remove = function(callback) {
+Query.prototype._remove = wrapThunk(function(callback) {
   this._castConditions();
 
   if (this.error() != null) {
@@ -2458,7 +2476,7 @@ Query.prototype._remove = function(callback) {
   callback = _wrapThunkCallback(this, callback);
 
   return Query.base.remove.call(this, helpers.handleWriteOpResult(callback));
-};
+});
 
 /**
  * Declare and/or execute this query as a `deleteOne()` operation. Works like
@@ -2506,10 +2524,10 @@ Query.prototype.deleteOne = function(filter, callback) {
 };
 
 /*!
- * ignore
+ * Internal thunk for `deleteOne()`
  */
 
-Query.prototype._deleteOne = function(callback) {
+Query.prototype._deleteOne = wrapThunk(function(callback) {
   this._castConditions();
 
   if (this.error() != null) {
@@ -2520,7 +2538,7 @@ Query.prototype._deleteOne = function(callback) {
   callback = _wrapThunkCallback(this, callback);
 
   return Query.base.deleteOne.call(this, helpers.handleWriteOpResult(callback));
-};
+});
 
 /**
  * Declare and/or execute this query as a `deleteMany()` operation. Works like
@@ -2568,10 +2586,10 @@ Query.prototype.deleteMany = function(filter, callback) {
 };
 
 /*!
- * ignore
+ * Internal thunk around `deleteMany()`
  */
 
-Query.prototype._deleteMany = function(callback) {
+Query.prototype._deleteMany = wrapThunk(function(callback) {
   this._castConditions();
 
   if (this.error() != null) {
@@ -2582,7 +2600,7 @@ Query.prototype._deleteMany = function(callback) {
   callback = _wrapThunkCallback(this, callback);
 
   return Query.base.deleteMany.call(this, helpers.handleWriteOpResult(callback));
-};
+});
 
 /*!
  * hydrates a document
@@ -2762,13 +2780,13 @@ Query.prototype.findOneAndUpdate = function(criteria, doc, options, callback) {
  * @api private
  */
 
-Query.prototype._findOneAndUpdate = function(callback) {
+Query.prototype._findOneAndUpdate = wrapThunk(function(callback) {
   if (this.error() != null) {
     return callback(this.error());
   }
 
   this._findAndModify('update', callback);
-};
+});
 
 /**
  * Issues a mongodb [findAndModify](http://www.mongodb.org/display/DOCS/findAndModify+Command) remove command.
@@ -2938,7 +2956,7 @@ Query.prototype.findOneAndDelete = function(conditions, options, callback) {
  * @return {Query} this
  * @api private
  */
-Query.prototype._findOneAndDelete = function(callback) {
+Query.prototype._findOneAndDelete = wrapThunk(function(callback) {
   this._castConditions();
 
   if (this.error() != null) {
@@ -2968,7 +2986,7 @@ Query.prototype._findOneAndDelete = function(callback) {
 
     return this._completeOne(doc, res, callback);
   }));
-};
+});
 
 /**
  * Issues a MongoDB [findOneAndReplace](https://docs.mongodb.com/manual/reference/method/db.collection.findOneAndReplace/) command.
@@ -3053,7 +3071,7 @@ Query.prototype.findOneAndReplace = function(conditions, options, callback) {
  * @return {Query} this
  * @api private
  */
-Query.prototype._findOneAndReplace = function(callback) {
+Query.prototype._findOneAndReplace = wrapThunk(function(callback) {
   this._castConditions();
 
   if (this.error() != null) {
@@ -3083,7 +3101,7 @@ Query.prototype._findOneAndReplace = function(callback) {
 
     return this._completeOne(doc, res, callback);
   });
-};
+});
 
 /*!
  * Thunk around findOneAndRemove()
@@ -3092,14 +3110,14 @@ Query.prototype._findOneAndReplace = function(callback) {
  * @return {Query} this
  * @api private
  */
-Query.prototype._findOneAndRemove = function(callback) {
+Query.prototype._findOneAndRemove = wrapThunk(function(callback) {
   if (this.error() != null) {
     callback(this.error());
     return;
   }
 
   this._findAndModify('remove', callback);
-};
+});
 
 /*!
  * Get options from query opts, falling back to the base mongoose object.
@@ -3142,6 +3160,8 @@ Query.prototype._findAndModify = function(type, callback) {
     return callback(castedQuery);
   }
 
+  _castArrayFilters(this);
+
   const opts = this._optionsForExec(model);
 
   if ('strict' in opts) {
@@ -3380,6 +3400,8 @@ function _updateThunk(op, callback) {
 
   this._castConditions();
 
+  _castArrayFilters(this);
+
   if (this.error() != null) {
     callback(this.error());
     return null;
@@ -3391,6 +3413,8 @@ function _updateThunk(op, callback) {
   let castedDoc;
   const options = this._optionsForExec(this.model);
 
+  ++this._executionCount;
+
   this._update = utils.clone(this._update, options);
   const isOverwriting = this.options.overwrite && !hasDollarKeys(this._update);
   if (isOverwriting) {
@@ -3456,9 +3480,9 @@ function _updateThunk(op, callback) {
  * @see Model.update #model_Model.update
  * @api private
  */
-Query.prototype._execUpdate = function(callback) {
+Query.prototype._execUpdate = wrapThunk(function(callback) {
   return _updateThunk.call(this, 'update', callback);
-};
+});
 
 /*!
  * Internal thunk for .updateMany()
@@ -3467,9 +3491,9 @@ Query.prototype._execUpdate = function(callback) {
  * @see Model.update #model_Model.update
  * @api private
  */
-Query.prototype._updateMany = function(callback) {
+Query.prototype._updateMany = wrapThunk(function(callback) {
   return _updateThunk.call(this, 'updateMany', callback);
-};
+});
 
 /*!
  * Internal thunk for .updateOne()
@@ -3478,9 +3502,9 @@ Query.prototype._updateMany = function(callback) {
  * @see Model.update #model_Model.update
  * @api private
  */
-Query.prototype._updateOne = function(callback) {
+Query.prototype._updateOne = wrapThunk(function(callback) {
   return _updateThunk.call(this, 'updateOne', callback);
-};
+});
 
 /*!
  * Internal thunk for .replaceOne()
@@ -3489,9 +3513,9 @@ Query.prototype._updateOne = function(callback) {
  * @see Model.replaceOne #model_Model.replaceOne
  * @api private
  */
-Query.prototype._replaceOne = function(callback) {
+Query.prototype._replaceOne = wrapThunk(function(callback) {
   return _updateThunk.call(this, 'replaceOne', callback);
-};
+});
 
 /**
  * Declare and/or execute this query as an update() operation.
@@ -3972,13 +3996,23 @@ Query.prototype.exec = function exec(op, callback) {
       return;
     }
 
-    this[this.op].call(this, (error, res) => {
+    this._hooks.execPre('exec', this, [], (error) => {
       if (error) {
-        cb(error);
-        return;
+        return cb(error);
       }
+      this[this.op].call(this, (error, res) => {
+        if (error) {
+          return cb(error);
+        }
+
+        this._hooks.execPost('exec', this, [], {}, (error) => {
+          if (error) {
+            return cb(error);
+          }
 
-      cb(null, res);
+          cb(null, res);
+        });
+      });
     });
   }, this.model.events);
 };
@@ -4033,6 +4067,24 @@ Query.prototype.catch = function(reject) {
   return this.exec().then(null, reject);
 };
 
+/*!
+ * ignore
+ */
+
+Query.prototype._pre = function(fn) {
+  this._hooks.pre('exec', fn);
+  return this;
+};
+
+/*!
+ * ignore
+ */
+
+Query.prototype._post = function(fn) {
+  this._hooks.post('exec', fn);
+  return this;
+};
+
 /*!
  * Casts obj for an update command.
  *

package/lib/schema/boolean.js

@@ -43,19 +43,21 @@ SchemaBoolean.prototype.constructor = SchemaBoolean;
 SchemaBoolean._cast = castBoolean;
 
 /**
- * Get/set the function used to cast arbitrary values to objectids.
+ * Get/set the function used to cast arbitrary values to booleans.
  *
  * ####Example:
  *
- *     // Make Mongoose only try to cast strings
- *     const original = mongoose.ObjectId.cast();
- *     mongoose.ObjectId.cast(v => {
- *       assert.ok(v == null || typeof v === 'string');
+ *     // Make Mongoose cast empty string '' to false.
+ *     const original = mongoose.Schema.Boolean.cast();
+ *     mongoose.Schema.Boolean.cast(v => {
+ *       if (v === '') {
+ *         return false;
+ *       }
  *       return original(v);
  *     });
  *
  *     // Or disable casting entirely
- *     mongoose.ObjectId.cast(false);
+ *     mongoose.Schema.Boolean.cast(false);
  *
  * @param {Function} caster
  * @return {Function}
@@ -88,7 +90,7 @@ SchemaBoolean.cast = function cast(caster) {
 SchemaBoolean._checkRequired = v => v === true || v === false;
 
 /**
- * Override the function the required validator uses to check whether a string
+ * Override the function the required validator uses to check whether a boolean
  * passes the `required` check.
  *
  * @param {Function} fn

package/lib/schema/documentarray.js

@@ -35,6 +35,10 @@ function DocumentArray(key, schema, options, schemaOptions) {
   this.schema = schema;
   this.schemaOptions = schemaOptions || {};
   this.$isMongooseDocumentArray = true;
+  this.Constructor = EmbeddedDocument;
+
+  EmbeddedDocument.base = schema.base;
+
   const fn = this.defaultValue;
 
   if (!('defaultValue' in this) || fn !== void 0) {
@@ -254,6 +258,40 @@ DocumentArray.prototype.doValidateSync = function(array, scope) {
   return resultError;
 };
 
+/*!
+ * ignore
+ */
+
+DocumentArray.prototype.getDefault = function(scope) {
+  let ret = typeof this.defaultValue === 'function'
+    ? this.defaultValue.call(scope)
+    : this.defaultValue;
+
+  if (ret == null) {
+    return ret;
+  }
+
+  // lazy load
+  MongooseDocumentArray || (MongooseDocumentArray = require('../types/documentarray'));
+
+  if (!Array.isArray(ret)) {
+    ret = [ret];
+  }
+
+  ret = new MongooseDocumentArray(ret, this.path, scope);
+  const _parent = ret._parent;
+  ret._parent = null;
+
+  for (let i = 0; i < ret.length; ++i) {
+    ret[i] = new this.Constructor(ret[i], ret, undefined,
+      undefined, i);
+  }
+
+  ret._parent = _parent;
+
+  return ret;
+};
+
 /**
  * Casts contents
  *

package/lib/schema/embedded.js

@@ -32,6 +32,7 @@ module.exports = Embedded;
 
 function Embedded(schema, path, options) {
   this.caster = _createConstructor(schema);
+  this.caster.path = path;
   this.caster.prototype.$basePath = path;
   this.schema = schema;
   this.$isSingleNested = true;