mongoose 5.0.17 → 5.1.2

package/.travis.yml

@@ -1,6 +1,7 @@
 language: node_js
 sudo: false
 node_js:
+  - "10"
   - "9"
   - "8"
   - "7"
@@ -8,11 +9,11 @@ node_js:
   - "5"
   - "4"
 before_script:
-  - wget http://fastdl.mongodb.org/linux/mongodb-linux-x86_64-3.0.15.tgz
-  - tar -zxvf mongodb-linux-x86_64-3.0.15.tgz
+  - wget http://fastdl.mongodb.org/linux/mongodb-linux-x86_64-3.6.4.tgz
+  - tar -zxvf mongodb-linux-x86_64-3.6.4.tgz
   - mkdir -p ./data/db/27017
   - mkdir -p ./data/db/27000
-  - ./mongodb-linux-x86_64-3.0.15/bin/mongod --storageEngine mmapv1 --fork --nopreallocj --dbpath ./data/db/27017 --syslog --port 27017
+  - ./mongodb-linux-x86_64-3.6.4/bin/mongod --fork --nopreallocj --dbpath ./data/db/27017 --syslog --port 27017
 script:
   - npm test
   - npm run lint

package/History.md

@@ -1,3 +1,64 @@
+5.1.2 / 2018-05-21
+==================
+ * docs(guide): add missing SchemaTypes #6490 [distancesprinter](https://github.com/distancesprinter)
+ * fix(map): make MongooseMap.toJSON return a serialized object #6486 #6478 [lineus](https://github.com/lineus)
+ * fix(query): make CustomQuery inherit from model.Query for hooks #6483 #6455 [lineus](https://github.com/lineus)
+ * fix(document): prevent default falses from being skipped by $__dirty #6481 #6477 [lineus](https://github.com/lineus)
+ * docs(connection): document `useDb()` #6480
+ * fix(model): skip redundant clone in insertMany #6479 [d1manson](https://github.com/d1manson)
+ * fix(aggregate): let replaceRoot accept objects as well as strings #6475 #6474 [lineus](https://github.com/lineus)
+ * docs(model): clarify `emit()` in mapReduce and how map/reduce are run #6465
+ * fix(populate): flatten array to handle multi-level nested `refPath` #6457
+ * fix(date): cast small numeric strings as years #6444 [AbdelrahmanHafez](https://github.com/AbdelrahmanHafez)
+ * fix(populate): remove unmatched ids when using virtual populate on already hydrated document #6435
+ * fix(array): use custom array class to avoid clobbered property names #6431
+ * fix(model): handle hooks for custom methods that return promises #6385
+
+4.13.13 / 2018-05-17
+====================
+ * fix(update): stop clobbering $in when casting update #6441 #6339
+ * fix: upgrade async -> 2.6.0 re: security warning
+
+5.1.1 / 2018-05-14
+==================
+ * docs(schema): add notes in api and guide about schema.methods object #6470 #6440 [lineus](https://github.com/lineus)
+ * fix(error): add modified paths to VersionError #6464 #6433 [paglias](https://github.com/paglias)
+ * fix(populate): only call populate with full param signature when match is not present #6458 #6451 [lineus](https://github.com/lineus)
+ * docs: fix geoNear link in migration guide #6450 [kawache](https://github.com/kawache)
+ * fix(discriminator): throw readable error when `create()` with a non-existent discriminator key #6434
+ * fix(populate): add `retainNullValues` option to avoid stripping out null keys #6432
+ * fix(populate): handle populate in embedded discriminators underneath nested paths #6411
+ * docs(model): add change streams and ToC, make terminology more consistent #5888
+
+5.1.0 / 2018-05-10
+==================
+ * feat(ObjectId): add `_id` getter so you can get a usable id whether or not the path is populated #6415 #6115
+ * feat(model): add Model.startSession() #6362
+ * feat(document): add doc.$session() and set session on doc after query #6362
+ * feat: add Map type that supports arbitrary keys #6287 #681
+ * feat: add `cloneSchemas` option to mongoose global to opt in to always cloning schemas before use #6274
+ * feat(model): add `findOneAndDelete()` and `findByIdAndDelete()` #6164
+ * feat(document): support `$ignore()` on single nested and array subdocs #6152
+ * feat(document): add warning about calling `save()` on subdocs #6152
+ * fix(model): make `save()` use `updateOne()` instead of `update()` #6031
+ * feat(error): add version number to VersionError #5966
+ * fix(query): allow `[]` as a value for `$in` when casting #5913
+ * fix(document): avoid running validators on single nested paths if only a child path is modified #5885
+ * feat(schema): print warning if method conflicts with mongoose internals #5860
+
+5.0.18 / 2018-05-09
+===================
+ * fix(update): stop clobbering $in when casting update #6441 #6339 [lineus](https://github.com/lineus)
+ * fix: upgrade mongodb driver -> 3.0.8 to fix session issue #6437 #6357 [simllll](https://github.com/simllll)
+ * fix: upgrade bson -> 1.0.5 re: https://snyk.io/vuln/npm:bson:20180225 #6423 [ChristianMurphy](https://github.com/ChristianMurphy)
+ * fix: look for `valueOf()` when casting to Decimal128 #6419 #6418 [lineus](https://github.com/lineus)
+ * fix: populate array of objects with space separated paths #6414 [lineus](https://github.com/lineus)
+ * test: add coverage for `mongoose.pluralize()` #6412 [FastDeath](https://github.com/FastDeath)
+ * fix(document): avoid running default functions on init() if path has value #6410
+ * fix(document): allow saving document with `null` id #6406
+ * fix: prevent casting of populated docs in document.init #6390 [lineus](https://github.com/lineus)
+ * fix: remove `toHexString()` helper that was added in 5.0.15 #6359
+
 5.0.17 / 2018-04-30
 ===================
  * docs(migration): certain chars in passwords may cause connection failures #6401 [markstos](https://github.com/markstos)

package/lib/aggregate.js

@@ -342,23 +342,34 @@ Aggregate.prototype.unwind = function() {
 /**
  * Appends a new $replaceRoot operator to this aggregate pipeline.
  *
- * Note that the `$replaceRoot` operator requires the new root to start with '$'.
- * Mongoose will prepend '$' if the specified field doesn't start '$'.
+ * Note that the `$replaceRoot` operator requires field strings to start with '$'.
+ * If you are passing in a string Mongoose will prepend '$' if the specified field doesn't start '$'.
+ * If you are passing in an object the strings in your expression will not be altered.
  *
  * ####Examples:
  *
  *     aggregate.replaceRoot("user");
  *
+ *     aggregate.replaceRoot({ x: { $concat: ['$this', '$that'] } });
+ *
  * @see $replaceRoot https://docs.mongodb.org/manual/reference/operator/aggregation/replaceRoot
- * @param {String} the field which will become the new root document
+ * @param {String|Object} the field or document which will become the new root document
  * @return {Aggregate}
  * @api public
  */
 
 Aggregate.prototype.replaceRoot = function(newRoot) {
+  var ret;
+
+  if (typeof newRoot === 'string') {
+    ret = newRoot.startsWith('$') ? newRoot : '$' + newRoot;
+  } else {
+    ret = newRoot;
+  }
+
   return this.append({
     $replaceRoot: {
-      newRoot: (newRoot && newRoot.charAt(0) === '$') ? newRoot : '$' + newRoot
+      newRoot: ret
     }
   });
 };

package/lib/connection.js

@@ -770,6 +770,18 @@ Connection.prototype.optionsProvideAuthenticationData = function(options) {
       ((options.pass) || this.authMechanismDoesNotRequirePassword());
 };
 
+/**
+ * Switches to a different database using the same connection pool.
+ *
+ * Returns a new connection object, with the new db.
+ *
+ * @method useDb
+ * @memberOf Connection
+ * @param {String} name The database name
+ * @return {Connection} New Connection Object
+ * @api public
+ */
+
 /*!
  * Module exports.
  */

package/lib/document.js

@@ -94,7 +94,7 @@ function Document(obj, fields, skipId, options) {
     $__hasIncludedChildren(fields) :
     {};
 
-  this.$__buildDoc(obj, fields, skipId, exclude, hasIncludedChildren);
+  this.$__buildDoc(obj, fields, skipId, exclude, hasIncludedChildren, false);
 
   // By default, defaults get applied **before** setting initial values
   // Re: gh-6155
@@ -115,7 +115,7 @@ function Document(obj, fields, skipId, options) {
   // Function defaults get applied **after** setting initial values so they
   // see the full doc rather than an empty one, unless they opt out.
   // Re: gh-3781, gh-6155
-  $__applyDefaults(this, fields, skipId, exclude, hasIncludedChildren, false);
+  $__applyDefaults(this, fields, skipId, exclude, hasIncludedChildren, false, options.skipDefaults);
 
   this.$__._id = this._id;
 
@@ -218,7 +218,7 @@ function $__hasIncludedChildren(fields) {
  * ignore
  */
 
-function $__applyDefaults(doc, fields, skipId, exclude, hasIncludedChildren, isBeforeSetters) {
+function $__applyDefaults(doc, fields, skipId, exclude, hasIncludedChildren, isBeforeSetters, pathsToSkip) {
   const paths = Object.keys(doc.schema.paths);
   const plen = paths.length;
 
@@ -274,6 +274,10 @@ function $__applyDefaults(doc, fields, skipId, exclude, hasIncludedChildren, isB
           continue;
         }
 
+        if (pathsToSkip && pathsToSkip[curPath]) {
+          break;
+        }
+
         if (fields && exclude !== null) {
           if (exclude === true) {
             // apply defaults to all non-excluded fields
@@ -322,7 +326,10 @@ function $__applyDefaults(doc, fields, skipId, exclude, hasIncludedChildren, isB
 Document.prototype.$__buildDoc = function(obj, fields, skipId, exclude, hasIncludedChildren) {
   const doc = {};
 
-  const paths = Object.keys(this.schema.paths);
+  const paths = Object.keys(this.schema.paths).
+    // Don't build up any paths that are underneath a map, we don't know
+    // what the keys will be
+    filter(p => !p.includes('$*'));
   const plen = paths.length;
   let ii = 0;
 
@@ -486,7 +493,9 @@ function init(self, obj, doc, prefix) {
       if (obj[i] === null) {
         doc[i] = null;
       } else if (obj[i] !== undefined) {
-        if (schema) {
+        let intCache = obj[i].$__ || {};
+        let wasPopulated = intCache.wasPopulated || null;
+        if (schema && !wasPopulated) {
           try {
             doc[i] = schema.cast(obj[i], self, true);
           } catch (e) {
@@ -535,6 +544,26 @@ Document.prototype.update = function update() {
   return this.constructor.update.apply(this.constructor, args);
 };
 
+/**
+ * Getter/setter around the session associated with this document. Used to
+ * automatically set `session` if you `save()` a doc that you got from a
+ * query with an associated session.
+ *
+ * @param {ClientSession} [session] overwrite the current session
+ * @return {ClientSession}
+ * @method $session
+ * @api public
+ * @memberOf Document
+ */
+
+Document.prototype.$session = function $session(session) {
+  if (arguments.length === 0) {
+    return this.$__.session;
+  }
+  this.$__.session = session;
+  return session;
+};
+
 /**
  * Alias for `set()`, used internally to avoid conflicts
  *
@@ -972,7 +1001,11 @@ Document.prototype.$__set = function(pathToMark, path, constructing, parts, sche
     cur += (cur ? '.' + parts[i] : parts[i]);
 
     if (last) {
-      obj[parts[i]] = val;
+      if (obj instanceof Map) {
+        obj.set(parts[i], val);
+      } else {
+        obj[parts[i]] = val;
+      }
     } else {
       if (obj[parts[i]] && utils.getFunctionName(obj[parts[i]].constructor) === 'Object') {
         obj = obj[parts[i]];
@@ -1049,9 +1082,13 @@ Document.prototype.get = function(path, type, options) {
   }
 
   for (var i = 0, l = pieces.length; i < l; i++) {
-    obj = obj === null || obj === void 0
-      ? undefined
-      : obj[pieces[i]];
+    if (obj == null) {
+      obj = void 0;
+    } else if (obj instanceof Map) {
+      obj = obj.get(pieces[i]);
+    } else {
+      obj = obj[pieces[i]];
+    }
   }
 
   if (adhoc) {
@@ -1479,6 +1516,7 @@ Document.prototype.validate = function(options, callback) {
 function _getPathsToValidate(doc) {
   var i;
   var len;
+  var skipSchemaValidators = {};
 
   // only validate required fields when necessary
   var paths = Object.keys(doc.$__.activePaths.states.require).filter(function(path) {
@@ -1511,6 +1549,7 @@ function _getPathsToValidate(doc) {
           return p != null && p.indexOf(subdoc.$basePath + '.') !== 0;
         });
         paths.push(subdoc.$basePath);
+        skipSchemaValidators[subdoc.$basePath] = true;
       }
     }
   }
@@ -1557,7 +1596,24 @@ function _getPathsToValidate(doc) {
     }
   }
 
-  return paths;
+  len = paths.length;
+  for (i = 0; i < len; ++i) {
+    const path = paths[i];
+    const _pathType = doc.schema.path(path);
+    if (!_pathType || !_pathType.$isSchemaMap) {
+      continue;
+    }
+
+    const val = doc.getValue(path);
+    if (val == null) {
+      continue;
+    }
+    for (let key of val.keys()) {
+      paths.push(path + '.' + key);
+    }
+  }
+
+  return [paths, skipSchemaValidators];
 }
 
 /*!
@@ -1584,7 +1640,9 @@ Document.prototype.$__validate = function(callback) {
   };
 
   // only validate required fields when necessary
-  const paths = _getPathsToValidate(this);
+  const pathDetails = _getPathsToValidate(this);
+  const paths = pathDetails[0];
+  const skipSchemaValidators = pathDetails[1];
 
   if (paths.length === 0) {
     return process.nextTick(function() {
@@ -1621,6 +1679,7 @@ Document.prototype.$__validate = function(callback) {
 
     process.nextTick(function() {
       const p = _this.schema.path(path);
+
       if (!p) {
         return --total || complete();
       }
@@ -1641,7 +1700,7 @@ Document.prototype.$__validate = function(callback) {
           _this.invalidate(path, err, undefined, true);
         }
         --total || complete();
-      }, scope);
+      }, scope, { skipSchemaValidators: skipSchemaValidators[path] });
     });
   };
 
@@ -1673,14 +1732,16 @@ Document.prototype.$__validate = function(callback) {
  */
 
 Document.prototype.validateSync = function(pathsToValidate) {
-  var _this = this;
+  const _this = this;
 
   if (typeof pathsToValidate === 'string') {
     pathsToValidate = pathsToValidate.split(' ');
   }
 
   // only validate required fields when necessary
-  var paths = _getPathsToValidate(this);
+  const pathDetails = _getPathsToValidate(this);
+  let paths = pathDetails[0];
+  const skipSchemaValidators = pathDetails[1];
 
   if (pathsToValidate && pathsToValidate.length) {
     var tmp = [];
@@ -1710,7 +1771,9 @@ Document.prototype.validateSync = function(pathsToValidate) {
     }
 
     var val = _this.getValue(path);
-    var err = p.doValidateSync(val, _this);
+    var err = p.doValidateSync(val, _this, {
+      skipSchemaValidators: skipSchemaValidators[path]
+    });
     if (err) {
       _this.invalidate(path, err, undefined, true);
     }
@@ -1940,7 +2003,7 @@ Document.prototype.$__dirty = function() {
   // gh-2558: if we had to set a default and the value is not undefined,
   // we have to save as well
   all = all.concat(this.$__.activePaths.map('default', function(path) {
-    if (path === '_id' || !_this.getValue(path)) {
+    if (path === '_id' || _this.getValue(path) == null) {
       return;
     }
     return {
@@ -2617,7 +2680,6 @@ Document.prototype.populate = function populate() {
   if (fn) {
     var paths = utils.object.vals(pop);
     this.$__.populate = undefined;
-    paths.__noPromise = true;
     var topLevelModel = this.constructor;
     if (this.$__isNested) {
       topLevelModel = this.$__.scope.constructor;
@@ -2685,7 +2747,6 @@ Document.prototype.execPopulate = function() {
 
 Document.prototype.populated = function(path, val, options) {
   // val and options are internal
-
   if (val === null || val === void 0) {
     if (!this.$__.populated) {
       return undefined;

package/lib/drivers/browser/objectid.js

@@ -7,6 +7,18 @@
 
 var ObjectId = require('bson').ObjectID;
 
+/*!
+ * Getter for convenience with populate, see gh-6115
+ */
+
+Object.defineProperty(ObjectId.prototype, '_id', {
+  enumerable: false,
+  configurable: true,
+  get: function() {
+    return this;
+  }
+});
+
 /*!
  * ignore
  */

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

@@ -1,10 +1,13 @@
+'use strict';
+
 /*!
  * Module dependencies.
  */
 
-var MongooseCollection = require('../../collection');
-var Collection = require('mongodb').Collection;
-var utils = require('../../utils');
+const MongooseCollection = require('../../collection');
+const Collection = require('mongodb').Collection;
+const get = require('lodash.get');
+const utils = require('../../utils');
 
 /**
  * A [node-mongodb-native](https://github.com/mongodb/node-mongodb-native) collection implementation.
@@ -217,44 +220,52 @@ function format(obj, sub) {
   if (obj && typeof obj.toBSON === 'function') {
     obj = obj.toBSON();
   }
+  if (obj == null) {
+    return obj;
+  }
+
   var x = utils.clone(obj, {transform: false});
   var representation;
 
-  if (x != null) {
-    if (x.constructor.name === 'Binary') {
-      x = 'BinData(' + x.sub_type + ', "' + x.toString('base64') + '")';
-    } else if (x.constructor.name === 'ObjectID') {
-      representation = 'ObjectId("' + x.toHexString() + '")';
-      x = {inspect: function() { return representation; }};
-    } else if (x.constructor.name === 'Date') {
-      representation = 'new Date("' + x.toUTCString() + '")';
-      x = {inspect: function() { return representation; }};
-    } else if (x.constructor.name === 'Object') {
-      var keys = Object.keys(x);
-      var numKeys = keys.length;
-      var key;
-      for (var i = 0; i < numKeys; ++i) {
-        key = keys[i];
-        if (x[key]) {
-          if (typeof x[key].toBSON === 'function') {
-            x[key] = x[key].toBSON();
-          }
-          if (x[key].constructor.name === 'Binary') {
-            x[key] = 'BinData(' + x[key].sub_type + ', "' +
-              x[key].buffer.toString('base64') + '")';
-          } else if (x[key].constructor.name === 'Object') {
-            x[key] = format(x[key], true);
-          } else if (x[key].constructor.name === 'ObjectID') {
-            formatObjectId(x, key);
-          } else if (x[key].constructor.name === 'Date') {
-            formatDate(x, key);
-          } else if (Array.isArray(x[key])) {
-            x[key] = x[key].map(map);
-          }
+  if (x.constructor.name === 'Binary') {
+    x = 'BinData(' + x.sub_type + ', "' + x.toString('base64') + '")';
+  } else if (x.constructor.name === 'ObjectID') {
+    representation = 'ObjectId("' + x.toHexString() + '")';
+    x = {inspect: function() { return representation; }};
+  } else if (x.constructor.name === 'Date') {
+    representation = 'new Date("' + x.toUTCString() + '")';
+    x = {inspect: function() { return representation; }};
+  } else if (x.constructor.name === 'Object') {
+    var keys = Object.keys(x);
+    var numKeys = keys.length;
+    var key;
+    for (var i = 0; i < numKeys; ++i) {
+      key = keys[i];
+      if (x[key]) {
+        if (typeof x[key].toBSON === 'function') {
+          x[key] = x[key].toBSON();
+        }
+        if (x[key].constructor.name === 'Binary') {
+          x[key] = 'BinData(' + x[key].sub_type + ', "' +
+            x[key].buffer.toString('base64') + '")';
+        } else if (x[key].constructor.name === 'Object') {
+          x[key] = format(x[key], true);
+        } else if (x[key].constructor.name === 'ObjectID') {
+          formatObjectId(x, key);
+        } else if (x[key].constructor.name === 'Date') {
+          formatDate(x, key);
+        } else if (x[key].constructor.name === 'ClientSession') {
+          representation = 'ClientSession("' +
+            get(x[key], 'id.id.buffer', '').toString('hex') + '")';
+          x[key] = {inspect: function() { return representation; }};
+        } else if (Array.isArray(x[key])) {
+          x[key] = x[key].map(map);
         }
       }
     }
-    if (sub) return x;
+  }
+  if (sub) {
+    return x;
   }
 
   return require('util')

package/lib/error/version.js

@@ -13,10 +13,12 @@ var MongooseError = require('./');
  * @api private
  */
 
-function VersionError(doc) {
+function VersionError(doc, currentVersion, modifiedPaths) {
   MongooseError.call(this, 'No matching document found for id "' + doc._id +
-    '"');
+    '" version ' + currentVersion);
   this.name = 'VersionError';
+  this.version = currentVersion;
+  this.modifiedPaths = modifiedPaths;
 }
 
 /*!

package/lib/index.js

@@ -80,6 +80,7 @@ Mongoose.prototype.STATES = STATES;
  * - 'debug': prints the operations mongoose sends to MongoDB to the console
  * - 'bufferCommands': enable/disable mongoose's buffering mechanism for all connections and models
  * - 'useFindAndModify': true by default. Set to `false` to make `findOneAndUpdate()` and `findOneAndRemove()` use native `findOneAndUpdate()` rather than `findAndModify()`.
+ * - 'cloneSchemas': false by default. Set to `true` to `clone()` all schemas before compiling into a model.
  *
  * @param {String} key
  * @param {String|Function|Boolean} value
@@ -237,8 +238,8 @@ Mongoose.prototype.disconnect = function(callback) {
 /**
  * Getter/setter around function for pluralizing collection names.
  *
- * @param {Function|null} [fn] overwrites the function used to pluralize connection names
- * @return {Function|null} the current function used to pluralize connection names, `undefined` by default.
+ * @param {Function|null} [fn] overwrites the function used to pluralize collection names
+ * @return {Function|null} the current function used to pluralize collection names, defaults to the legacy function from `mongoose-legacy-pluralize`.
  * @api public
  */
 
@@ -291,7 +292,7 @@ Mongoose.prototype.pluralize = function(fn) {
  */
 
 Mongoose.prototype.model = function(name, schema, collection, skipInit) {
-  var model;
+  let model;
   if (typeof name === 'function') {
     model = name;
     name = model.name;
@@ -319,7 +320,7 @@ Mongoose.prototype.model = function(name, schema, collection, skipInit) {
   }
 
   // handle internal options from connection.model()
-  var options;
+  let options;
   if (skipInit && utils.isObject(skipInit)) {
     options = skipInit;
     skipInit = true;
@@ -337,16 +338,20 @@ Mongoose.prototype.model = function(name, schema, collection, skipInit) {
     }
   }
 
+  const originalSchema = schema;
   if (schema) {
+    if (this.get('cloneSchemas')) {
+      schema = schema.clone();
+    }
     this._applyPlugins(schema);
   }
 
-  var sub;
+  let sub;
 
   // connection.model() may be passing a different schema for
   // an existing model name. in this case don't read from cache.
   if (this.models[name] && options.cache !== false) {
-    if (schema && schema.instanceOfSchema && schema !== this.models[name].schema) {
+    if (originalSchema && originalSchema.instanceOfSchema && originalSchema !== this.models[name].schema) {
       throw new mongoose.Error.OverwriteModelError(name);
     }
 
@@ -380,7 +385,7 @@ Mongoose.prototype.model = function(name, schema, collection, skipInit) {
       utils.toCollectionName(name, this.pluralize());
   }
 
-  var connection = options.connection || this.connection;
+  const connection = options.connection || this.connection;
   model = this.Model.compile(model || name, schema, collection, connection, this);
 
   if (!skipInit) {

package/lib/internal.js

@@ -25,6 +25,7 @@ function InternalCache() {
   this.scope = undefined;
   this.activePaths = new ActiveRoster;
   this.pathsToScopes = {};
+  this.session = null;
 
   // embedded docs
   this.ownerDocument = undefined;