mongoose 5.0.2 → 5.0.6

package/CONTRIBUTING.md

@@ -60,3 +60,32 @@ Visit `http://localhost:8088` and you should see the docs with your local change
 ### Plugins website
 
 The [plugins](http://plugins.mongoosejs.io/) site is also an [open source project](https://github.com/vkarpov15/mongooseplugins) that you can get involved with. Feel free to fork and improve it as well!
+
+
+## Financial contributions
+
+We also welcome financial contributions in full transparency on our [open collective](https://opencollective.com/mongoose).
+Anyone can file an expense. If the expense makes sense for the development of the community, it will be "merged" in the ledger of our open collective by the core contributors and the person who filed the expense will be reimbursed.
+
+
+## Credits
+
+
+### Contributors
+
+Thank you to all the people who have already contributed to mongoose!
+<a href="graphs/contributors"><img src="https://opencollective.com/mongoose/contributors.svg?width=890" /></a>
+
+
+### Backers
+
+Thank you to all our backers! [[Become a backer](https://opencollective.com/mongoose#backer)]
+
+<a href="https://opencollective.com/mongoose#backers" target="_blank"><img src="https://opencollective.com/mongoose/backers.svg?width=890"></a>
+
+
+### Sponsors
+
+Thank you to all our sponsors! (please ask your company to also support this open source project by [becoming a sponsor](https://opencollective.com/mongoose#sponsor))
+
+<a href="https://mixmax.com" target="_blank"><img src="http://mongoosejs.com/docs/images/mixmax.png"></a>

package/History.md

@@ -1,3 +1,49 @@
+5.0.6 / 2018-02-15
+==================
+ * refactor(query.castUpdate): avoid creating error until necessary #6137
+ * docs(api): fix missing api docs #6136 [lineus](https://github.com/lineus)
+ * fix(schema): copy virtuals when using `clone()` #6133
+ * fix(update): avoid digging into buffers with upsert and replaceOne #6124
+ * fix(schema): support `enum` on arrays of strings #6102
+ * fix(update): cast `$addToSet: [1, 2]` -> `$addToSet: { $each: [1, 2] }` #6086
+
+5.0.5 / 2018-02-13
+==================
+ * docs: make > show up correctly in API docs #6114
+ * fix(query): support `where()` overwriting primitive with object #6097
+ * fix(schematype): don't run internal `resetId` setter on queries with _id #6093
+ * fix(discriminator): don't copy `discriminators` property from base schema #6064
+ * fix(utils): respect `valueOf()` when merging object for update #6059
+ * docs(validation): fix typo 'maxLength' #4720
+ * fix(document): apply defaults after setting initial value so default functions don't see empty doc #3781
+
+5.0.4 / 2018-02-08
+==================
+ * docs: add lambda guide #6107
+ * fix(connection): add `dbName` option to work around `mongodb+srv` not supporting db name in URI #6106
+ * fix(schematype): fix regexp typo in ObjectId #6098 [JoshuaWise](https://github.com/JoshuaWise)
+ * perf(document): re-use the modifiedPaths list #6092 [tarun1793](https://github.com/tarun1793)
+ * fix: use console.info() instead of console.error() for debug output #6088 [yuristsepaniuk](https://github.com/yuristsepaniuk)
+ * docs(validation): clean up runValidators and isAsync options docs for 5.x #6083
+ * docs(model): use array instead of spread consistently for aggregate() #6070
+ * fix(schema): make aliases handle mongoose-lean-virtuals #6069
+ * docs(layout): add link to subdocs guide #6056
+ * fix(query): make strictQuery: true strip out fields that aren't in the schema #6032
+ * docs(guide): add notes for `strictQuery` option #6032
+
+4.13.11 / 2018-02-07
+====================
+ * docs: fix links in 4.x docs #6081
+ * chore: add release script that uses --tag for npm publish for 4.x releases #6063
+
+5.0.3 / 2018-01-31
+==================
+ * fix: consistently use process.nextTick() to avoid sinon.useFakeTimers() causing ops to hang #6074
+ * docs(aggregate): fix typo #6072 [adursun](https://github.com/adursun)
+ * chore: add return type to `mongoose.model()` docs [bryant1410](https://github.com/bryant1410)
+ * fix(document): depopulate push()-ed docs when saving #6048
+ * fix: upgrade mongodb -> 3.0.2 #6019
+
 5.0.2 / 2018-01-28
 ==================
  * fix(schema): do not overwrite default values in schema when nested timestamps are provided #6024 [cdeveas](https://github.com/cdeveas)

package/lib/aggregate.js

@@ -20,7 +20,7 @@ var read = Query.prototype.read;
  *     ]);
  *
  *     Model.
- *       aggregate({ $match: { age: { $gte: 21 }}}).
+ *       aggregate([{ $match: { age: { $gte: 21 }}}]).
  *       unwind('tags').
  *       exec(callback);
  *
@@ -392,7 +392,7 @@ Aggregate.prototype.graphLookup = function(options) {
 };
 
 /**
- * Appepnds new custom $sample operator(s) to this aggregate pipeline.
+ * Appends new custom $sample operator(s) to this aggregate pipeline.
  *
  * ####Examples:
  *

package/lib/cast.js

@@ -33,6 +33,8 @@ module.exports = function cast(schema, obj, options, context) {
   var type;
   var val;
 
+  options = options || {};
+
   while (i--) {
     path = paths[i];
     val = obj[path];
@@ -192,15 +194,17 @@ module.exports = function cast(schema, obj, options, context) {
           }
         }
 
-        if (options && options.upsert && options.strict && !schema.nested[path]) {
+        if (options.upsert && options.strict && !schema.nested[path]) {
           if (options.strict === 'throw') {
             throw new StrictModeError(path);
           }
           throw new StrictModeError(path, 'Path "' + path + '" is not in ' +
             'schema, strict mode is `true`, and upsert is `true`.');
-        } else if (options && options.strictQuery === 'throw') {
+        } else if (options.strictQuery === 'throw') {
           throw new StrictModeError(path, 'Path "' + path + '" is not in ' +
             'schema and strictQuery is true.');
+        } else if (options.strictQuery) {
+          delete obj[path];
         }
       } else if (val === null || val === undefined) {
         obj[path] = null;

package/lib/collection.js

@@ -1,9 +1,12 @@
+'use strict';
+
 /*!
  * Module dependencies.
  */
 
-var EventEmitter = require('events').EventEmitter;
-var STATES = require('./connectionstate');
+const EventEmitter = require('events').EventEmitter;
+const STATES = require('./connectionstate');
+const utils = require('./utils');
 
 /**
  * Abstract Collection constructor
@@ -81,7 +84,7 @@ Collection.prototype.conn;
 Collection.prototype.onOpen = function() {
   this.buffer = false;
   var _this = this;
-  setImmediate(function() {
+  utils.immediate(function() {
     _this.doQueue();
   });
 };

package/lib/connection.js

@@ -286,12 +286,12 @@ Connection.prototype.openUri = function(uri, options, callback) {
     options = null;
   }
 
-  var Promise = PromiseProvider.get();
-  var _this = this;
+  const Promise = PromiseProvider.get();
+  const _this = this;
 
   if (options) {
     options = utils.clone(options);
-    var autoIndex = options.config && options.config.autoIndex != null ?
+    const autoIndex = options.config && options.config.autoIndex != null ?
       options.config.autoIndex :
       options.autoIndex;
     if (autoIndex != null) {
@@ -325,8 +325,10 @@ Connection.prototype.openUri = function(uri, options, callback) {
   }
 
   this._connectionOptions = options;
+  let dbName = options.dbName;
+  delete options.dbName;
 
-  var promise = new Promise((resolve, reject) => {
+  const promise = new Promise((resolve, reject) => {
     parser(uri, options, (error, parsed) => {
       if (error) {
         if (_this.listeners('error').length > 0) {
@@ -335,7 +337,8 @@ Connection.prototype.openUri = function(uri, options, callback) {
         return reject(error);
       }
 
-      this.name = parsed.dbName;
+      dbName = dbName || parsed.dbName;
+      this.name = dbName;
       this.host = parsed.servers[0].host || parsed.servers[0].domain_socket;
       this.port = parsed.servers[0].port || 27017;
       if (parsed.auth) {
@@ -353,7 +356,7 @@ Connection.prototype.openUri = function(uri, options, callback) {
           }
           return reject(error);
         }
-        var db = client.db(parsed.dbName);
+        const db = client.db(dbName);
         _this.db = db;
         _this.client = client;
 
@@ -394,7 +397,7 @@ Connection.prototype.openUri = function(uri, options, callback) {
         delete _this.catch;
         _this.readyState = STATES.connected;
 
-        for (var i in _this.collections) {
+        for (let i in _this.collections) {
           if (utils.object.hasOwnProperty(_this.collections, i)) {
             _this.collections[i].onOpen();
           }

package/lib/document.js

@@ -16,6 +16,7 @@ var VirtualType = require('./virtualtype');
 var utils = require('./utils');
 var clone = utils.clone;
 var isDefiningProjection = require('./services/projection/isDefiningProjection');
+var isExclusive = require('./services/projection/isExclusive');
 var isMongooseObject = utils.isMongooseObject;
 var inspect = require('util').inspect;
 var internalToObjectOptions = require('./options').internalToObjectOptions;
@@ -71,7 +72,20 @@ function Document(obj, fields, skipId, options) {
   }
 
   this.$__.emitter.setMaxListeners(0);
-  this._doc = this.$__buildDoc(obj, fields, skipId);
+
+  let exclude = null;
+
+  // determine if this doc is a result of a query with
+  // excluded fields
+  if (fields && utils.getFunctionName(fields.constructor) === 'Object') {
+    exclude = isExclusive(fields);
+  }
+
+  let hasIncludedChildren = exclude === false && fields ?
+    $__hasIncludedChildren(fields) :
+    {};
+
+  this.$__buildDoc(obj, fields, skipId, exclude, hasIncludedChildren);
 
   if (obj) {
     if (obj instanceof Document) {
@@ -85,6 +99,8 @@ function Document(obj, fields, skipId, options) {
     }
   }
 
+  $__applyDefaults(this, fields, skipId, exclude, hasIncludedChildren);
+
   this.$__._id = this._id;
 
   if (!schema.options.strict && obj) {
@@ -163,91 +179,52 @@ Document.prototype.id;
 
 Document.prototype.errors;
 
-/**
- * Builds the default doc structure
- *
- * @param {Object} obj
- * @param {Object} [fields]
- * @param {Boolean} [skipId]
- * @return {Object}
- * @api private
- * @method $__buildDoc
- * @memberOf Document
+/*!
+ * ignore
  */
 
-Document.prototype.$__buildDoc = function(obj, fields, skipId) {
-  var doc = {};
-  var exclude = null;
-  var keys;
-  var ki;
-  var _this = this;
-
-  // determine if this doc is a result of a query with
-  // excluded fields
-
-  if (fields && utils.getFunctionName(fields.constructor) === 'Object') {
-    keys = Object.keys(fields);
-    ki = keys.length;
-
-    if (ki === 1 && keys[0] === '_id') {
-      exclude = !!fields[keys[ki]];
-    } else {
-      while (ki--) {
-        // Does this projection explicitly define inclusion/exclusion?
-        // Explicitly avoid `$meta` and `$slice`
-        if (keys[ki] !== '_id' && isDefiningProjection(fields[keys[ki]])) {
-          exclude = !fields[keys[ki]];
-          break;
-        }
-      }
+function $__hasIncludedChildren(fields) {
+  let hasIncludedChildren = {};
+  let keys = Object.keys(fields);
+  for (var j = 0; j < keys.length; ++j) {
+    let parts = keys[j].split('.');
+    let c = [];
+    for (var k = 0; k < parts.length; ++k) {
+      c.push(parts[k]);
+      hasIncludedChildren[c.join('.')] = 1;
     }
   }
 
-  var paths = Object.keys(this.schema.paths);
-  var plen = paths.length;
-  var ii = 0;
+  return hasIncludedChildren;
+}
 
-  var hasIncludedChildren = {};
-  if (exclude === false && fields) {
-    keys = Object.keys(fields);
-    for (var j = 0; j < keys.length; ++j) {
-      var parts = keys[j].split('.');
-      var c = [];
-      for (var k = 0; k < parts.length; ++k) {
-        c.push(parts[k]);
-        hasIncludedChildren[c.join('.')] = 1;
-      }
-    }
-  }
+/*!
+ * ignore
+ */
 
-  for (; ii < plen; ++ii) {
-    var p = paths[ii];
+function $__applyDefaults(doc, fields, skipId, exclude, hasIncludedChildren) {
+  const paths = Object.keys(doc.schema.paths);
+  const plen = paths.length;
 
-    if (p === '_id') {
-      if (skipId) {
-        continue;
-      }
-      if (obj && '_id' in obj) {
-        continue;
-      }
-    }
+  for (let i = 0; i < plen; ++i) {
+    let def;
+    let curPath = '';
+    let p = paths[i];
 
-    var type = this.schema.paths[p];
-    var path = p.split('.');
-    var len = path.length;
-    var last = len - 1;
-    var curPath = '';
-    var doc_ = doc;
-    var i = 0;
-    var included = false;
+    if (p === '_id' && skipId) {
+      continue;
+    }
 
-    for (; i < len; ++i) {
-      var piece = path[i],
-          def;
+    let type = doc.schema.paths[p];
+    let path = p.split('.');
+    let len = path.length;
+    let included = false;
+    let doc_ = doc._doc;
 
+    for (let j = 0; j < len; ++j) {
+      let piece = path[j];
       curPath += (!curPath.length ? '' : '.') + piece;
 
-      // support excluding intermediary levels
       if (exclude === true) {
         if (curPath in fields) {
           break;
@@ -260,7 +237,11 @@ Document.prototype.$__buildDoc = function(obj, fields, skipId) {
         }
       }
 
-      if (i === last) {
+      if (j === len - 1) {
+        if (doc_[piece] !== void 0) {
+          break;
+        }
+
         if (fields && exclude !== null) {
           if (exclude === true) {
             // apply defaults to all non-excluded fields
@@ -268,33 +249,95 @@ Document.prototype.$__buildDoc = function(obj, fields, skipId) {
               continue;
             }
 
-            def = type.getDefault(_this, false);
+            def = type.getDefault(doc, false);
             if (typeof def !== 'undefined') {
               doc_[piece] = def;
-              _this.$__.activePaths.default(p);
+              doc.$__.activePaths.default(p);
             }
           } else if (included) {
             // selected field
-            def = type.getDefault(_this, false);
+            def = type.getDefault(doc, false);
             if (typeof def !== 'undefined') {
               doc_[piece] = def;
-              _this.$__.activePaths.default(p);
+              doc.$__.activePaths.default(p);
             }
           }
         } else {
-          def = type.getDefault(_this, false);
+          def = type.getDefault(doc, false);
           if (typeof def !== 'undefined') {
             doc_[piece] = def;
-            _this.$__.activePaths.default(p);
+            doc.$__.activePaths.default(p);
           }
         }
       } else {
+        doc_ = doc_[piece];
+      }
+    }
+  }
+}
+
+/**
+ * Builds the default doc structure
+ *
+ * @param {Object} obj
+ * @param {Object} [fields]
+ * @param {Boolean} [skipId]
+ * @api private
+ * @method $__buildDoc
+ * @memberOf Document
+ */
+
+Document.prototype.$__buildDoc = function(obj, fields, skipId, exclude, hasIncludedChildren) {
+  const doc = {};
+
+  const paths = Object.keys(this.schema.paths);
+  const plen = paths.length;
+  let ii = 0;
+
+  for (; ii < plen; ++ii) {
+    var p = paths[ii];
+
+    if (p === '_id') {
+      if (skipId) {
+        continue;
+      }
+      if (obj && '_id' in obj) {
+        continue;
+      }
+    }
+
+    const path = p.split('.');
+    const len = path.length;
+    const last = len - 1;
+    let curPath = '';
+    let doc_ = doc;
+    let included = false;
+
+    for (let i = 0; i < len; ++i) {
+      const piece = path[i];
+
+      curPath += (!curPath.length ? '' : '.') + piece;
+
+      // support excluding intermediary levels
+      if (exclude === true) {
+        if (curPath in fields) {
+          break;
+        }
+      } else if (exclude === false && fields && !included) {
+        if (curPath in fields) {
+          included = true;
+        } else if (!hasIncludedChildren[curPath]) {
+          break;
+        }
+      }
+
+      if (i < last) {
         doc_ = doc_[piece] || (doc_[piece] = {});
       }
     }
   }
 
-  return doc;
+  this._doc = doc;
 };
 
 /*!
@@ -1103,12 +1146,12 @@ Document.prototype.modifiedPaths = function() {
  * @api public
  */
 
-Document.prototype.isModified = function(paths) {
+Document.prototype.isModified = function(paths, modifiedPaths) {
   if (paths) {
     if (!Array.isArray(paths)) {
       paths = paths.split(' ');
     }
-    var modified = this.modifiedPaths();
+    var modified = modifiedPaths || this.modifiedPaths();
     var directModifiedPaths = Object.keys(this.$__.activePaths.states.modify);
     var isModifiedChild = paths.some(function(path) {
       return !!~modified.indexOf(path);
@@ -1394,9 +1437,10 @@ function _getPathsToValidate(doc) {
     var subdocs = doc.$__getAllSubdocs();
     var subdoc;
     len = subdocs.length;
+    var modifiedPaths = doc.modifiedPaths();
     for (i = 0; i < len; ++i) {
       subdoc = subdocs[i];
-      if (doc.isModified(subdoc.$basePath) &&
+      if (doc.isModified(subdoc.$basePath, modifiedPaths) &&
           !doc.isDirectModified(subdoc.$basePath)) {
         // Remove child paths for now, because we'll be validating the whole
         // subdoc

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

@@ -182,7 +182,7 @@ NativeCollection.prototype.$print = function(name, i, args) {
   }
   var params = '(' + _args.join(', ') + ')';
 
-  console.error(moduleName + functionCall + params);
+  console.info(moduleName + functionCall + params);
 };
 
 /**

package/lib/index.js

@@ -285,6 +285,7 @@ Mongoose.prototype.pluralize = function(fn) {
  * @param {Schema} [schema]
  * @param {String} [collection] name (optional, inferred from model name)
  * @param {Boolean} [skipInit] whether to skip initialization (defaults to false)
+ * @return {Model}
  * @api public
  */
 

package/lib/model.js

@@ -770,7 +770,7 @@ Model.prototype.remove = function remove(options, fn) {
 
 Model.prototype.$__remove = function $__remove(options, cb) {
   if (this.$__.isDeleted) {
-    return setImmediate(() => cb(null, this));
+    return utils.immediate(() => cb(null, this));
   }
 
   var where = this.$__where();
@@ -1030,7 +1030,7 @@ function _ensureIndexes(model, options, callback) {
   };
 
   if (!indexes.length) {
-    setImmediate(function() {
+    utils.immediate(function() {
       done();
     });
     return;
@@ -1071,7 +1071,7 @@ function _ensureIndexes(model, options, callback) {
     }));
   };
 
-  setImmediate(function() {
+  utils.immediate(function() {
     // If buffering is off, do this manually.
     if (options._automatic && !model.collection.collection) {
       model.collection.addQueue(create, []);
@@ -2751,13 +2751,13 @@ Model.mapReduce = function mapReduce(o, callback) {
  * ####Example:
  *
  *     // Find the max balance of all accounts
- *     Users.aggregate(
+ *     Users.aggregate([
  *       { $group: { _id: null, maxBalance: { $max: '$balance' }}},
- *       { $project: { _id: 0, maxBalance: 1 }},
- *       function (err, res) {
- *         if (err) return handleError(err);
- *         console.log(res); // [ { maxBalance: 98000 } ]
- *       });
+ *       { $project: { _id: 0, maxBalance: 1 }}
+ *     ]).
+ *     then(function (res) {
+ *       console.log(res); // [ { maxBalance: 98000 } ]
+ *     });
  *
  *     // Or use the aggregation pipeline builder.
  *     Users.aggregate()
@@ -2766,7 +2766,7 @@ Model.mapReduce = function mapReduce(o, callback) {
  *       .exec(function (err, res) {
  *         if (err) return handleError(err);
  *         console.log(res); // [ { maxBalance: 98 } ]
- *     });
+ *       });
  *
  * ####NOTE:
  *
@@ -3036,7 +3036,7 @@ function populate(model, docs, options, callback) {
 
   modelsMap = getModelsMapForPopulate(model, docs, options);
   if (modelsMap instanceof Error) {
-    return setImmediate(function() {
+    return utils.immediate(function() {
       callback(modelsMap);
     });
   }

package/lib/schema/array.js

@@ -17,6 +17,7 @@ var Types = {
 };
 var Mixed = require('./mixed');
 var cast = require('../cast');
+var get = require('lodash.get');
 var util = require('util');
 var utils = require('../utils');
 var castToNumber = require('./operators/helpers').castToNumber;
@@ -119,6 +120,23 @@ SchemaArray.schemaName = 'Array';
 SchemaArray.prototype = Object.create(SchemaType.prototype);
 SchemaArray.prototype.constructor = SchemaArray;
 
+/**
+ * Adds an enum validator if this is an array of strings. Equivalent to
+ * `SchemaString.prototype.enum()`
+ *
+ * @param {String|Object} [args...] enumeration values
+ * @return {SchemaType} this
+ */
+
+SchemaArray.prototype.enum = function() {
+  const instance = get(this, 'caster.instance');
+  if (instance !== 'String') {
+    throw new Error('`enum` can only be set on an array of strings, not ' + instance);
+  }
+  this.caster.enum.apply(this.caster, arguments);
+  return this;
+};
+
 /**
  * Check if the given value satisfies a required validator. The given value
  * must be not null nor undefined, and have a positive length.

package/lib/schema/objectid.js

@@ -20,7 +20,7 @@ var SchemaType = require('../schematype'),
  */
 
 function ObjectId(key, options) {
-  var isKeyHexStr = typeof key === 'string' && key.length === 24 && /^a-f0-9$/i.test(key);
+  var isKeyHexStr = typeof key === 'string' && key.length === 24 && /^[a-f0-9]+$/i.test(key);
   var suppressWarning = options && options.suppressWarning;
   if ((isKeyHexStr || typeof key === 'undefined') && !suppressWarning) {
     console.warn('mongoose: To create a new ObjectId please try ' +
@@ -209,15 +209,16 @@ function defaultId() {
 function resetId(v) {
   Document || (Document = require('./../document'));
 
-  if (v === void 0) {
-    var _v = new oid;
-    this.$__._id = _v;
-    return _v;
-  }
-
   if (this instanceof Document) {
+    if (v === void 0) {
+      var _v = new oid;
+      this.$__._id = _v;
+      return _v;
+    }
+
     this.$__._id = v;
   }
+
   return v;
 }