mongoose 5.0.18 → 5.1.0

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,19 @@
+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)

package/lib/document.js

@@ -326,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;
 
@@ -541,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
  *
@@ -978,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]];
@@ -1055,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) {
@@ -1485,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) {
@@ -1517,6 +1549,7 @@ function _getPathsToValidate(doc) {
           return p != null && p.indexOf(subdoc.$basePath + '.') !== 0;
         });
         paths.push(subdoc.$basePath);
+        skipSchemaValidators[subdoc.$basePath] = true;
       }
     }
   }
@@ -1563,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];
 }
 
 /*!
@@ -1590,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() {
@@ -1627,6 +1679,7 @@ Document.prototype.$__validate = function(callback) {
 
     process.nextTick(function() {
       const p = _this.schema.path(path);
+
       if (!p) {
         return --total || complete();
       }
@@ -1647,7 +1700,7 @@ Document.prototype.$__validate = function(callback) {
           _this.invalidate(path, err, undefined, true);
         }
         --total || complete();
-      }, scope);
+      }, scope, { skipSchemaValidators: skipSchemaValidators[path] });
     });
   };
 
@@ -1679,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 = [];
@@ -1716,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);
     }
@@ -2691,7 +2748,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.
@@ -248,6 +251,10 @@ function format(obj, sub) {
             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);
           }

package/lib/error/version.js

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

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
@@ -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;