mongoose 4.13.5 → 4.13.9

package/History.md

@@ -1,3 +1,37 @@
+4.13.9 / 2017-01-07
+===================
+ * chore: update marked (dev dependency) re: security vulnerability #5951 [ChristianMurphy](https://github.com/ChristianMurphy)
+ * fix: upgrade mongodb -> 2.2.34 for ipv6 and autoReconnect fixes #5794 #5760
+ * docs: use useMongooseAggCursor for aggregate docs #2955
+
+4.13.8 / 2017-12-27
+===================
+ * docs(guide): use more up-to-date syntax for autoIndex example #5933
+ * docs: fix grammar #5927 [abagh0703](https://github.com/abagh0703)
+ * fix: propagate lean options to child schemas #5914
+ * fix(populate): use correct model with discriminators + nested populate #5858
+
+4.13.7 / 2017-12-11
+===================
+ * docs(schematypes): fix typo #5889 [gokaygurcan](https://github.com/gokaygurcan)
+ * fix(cursor): handle `reject(null)` with eachAsync callback #5875 #5874 [ZacharyRSmith](https://github.com/ZacharyRSmith)
+ * fix: disallow setting `mongoose.connection` to invalid values #5871 [jinasonlin](https://github.com/jinasonlin)
+ * docs(middleware): suggest using `return next()` to stop middleware execution #5866
+ * docs(connection): improve connection string query param docs #5864
+ * fix(document): run validate hooks on array subdocs even if not directly modified #5861
+ * fix(discriminator): don't treat $meta as defining projection when querying #5859
+ * fix(types): handle Decimal128 when using bson-ext on server side #5850
+ * fix(document): ensure projection with only $slice isn't treated as inclusive for discriminators #4991
+ * fix(model): throw error when passing non-object to create() #2037
+
+4.13.6 / 2017-12-02
+===================
+ * fix(schema): support strictBool option in schema #5856 [ekulabuhov](https://github.com/ekulabuhov)
+ * fix(update): make upsert option consistently handle truthy values, not just booleans, for updateOne() #5839
+ * refactor: remove unnecessary constructor check #2057
+ * docs(query): correct function signature for .mod() helper #1806
+ * fix(query): report ObjectParameterError when passing non-object as filter to find() and findOne() #1698
+
 4.13.5 / 2017-11-24
 ===================
  * fix(model): handle update cast errors correctly with bulkWrite #5845 [Michael77](https://github.com/Michael77)

package/README.md

@@ -20,6 +20,16 @@ Mongoose is a [MongoDB](https://www.mongodb.org/) object modeling tool designed
   - [Help Forum](http://groups.google.com/group/mongoose-orm)
   - [MongoDB Support](https://docs.mongodb.org/manual/support/)
 
+## Importing
+
+```javascript
+// Using Node.js `require()`
+const mongoose = require('mongoose');
+
+// Using ES6 imports
+import mongoose from 'mongoose';
+```
+
 ## Plugins
 
 Check out the [plugins search site](http://plugins.mongoosejs.io/) to see hundreds of related modules from the community. Next, learn how to write your own plugin from the [docs](http://mongoosejs.com/docs/plugins.html) or [this blog post](http://thecodebarbarian.com/2015/03/06/guide-to-mongoose-plugins).

package/lib/aggregate.js

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

package/lib/document.js

@@ -7,11 +7,13 @@ var MongooseError = require('./error');
 var MixedSchema = require('./schema/mixed');
 var Schema = require('./schema');
 var ObjectExpectedError = require('./error/objectExpected');
+var ObjectParameterError = require('./error/objectParameter');
 var StrictModeError = require('./error/strict');
 var ValidatorError = require('./schematype').ValidatorError;
 var VirtualType = require('./virtualtype');
 var utils = require('./utils');
 var clone = utils.clone;
+var isDefiningProjection = require('./services/projection/isDefiningProjection');
 var isMongooseObject = utils.isMongooseObject;
 var inspect = require('util').inspect;
 var ValidationError = MongooseError.ValidationError;
@@ -48,6 +50,10 @@ function Document(obj, fields, skipId, options) {
   this.errors = undefined;
   this.$__.$options = options || {};
 
+  if (obj != null && typeof obj !== 'object') {
+    throw new ObjectParameterError(obj, 'obj', 'Document');
+  }
+
   var schema = this.schema;
 
   if (typeof fields === 'boolean') {
@@ -184,10 +190,7 @@ Document.prototype.$__buildDoc = function(obj, fields, skipId) {
       while (ki--) {
         // Does this projection explicitly define inclusion/exclusion?
         // Explicitly avoid `$meta` and `$slice`
-        var isDefiningProjection = !fields[keys[ki]] ||
-          typeof fields[keys[ki]] !== 'object' ||
-          fields[keys[ki]].$elemMatch != null;
-        if (keys[ki] !== '_id' && isDefiningProjection) {
+        if (keys[ki] !== '_id' && isDefiningProjection(fields[keys[ki]])) {
           exclude = !fields[keys[ki]];
           break;
         }
@@ -484,10 +487,11 @@ Document.prototype.update = function update() {
  * @param {Any} val the value to set
  * @param {Schema|String|Number|Buffer|*} [type] optionally specify a type for "on-the-fly" attributes
  * @param {Object} [options] optionally specify options that modify the behavior of the set
+ * @method $set
  * @api public
  */
 
-Document.prototype.$set = function(path, val, type, options) {
+Document.prototype.$set = function $set(path, val, type, options) {
   if (type && utils.getFunctionName(type.constructor) === 'Object') {
     options = type;
     type = undefined;
@@ -1175,6 +1179,7 @@ Document.prototype.$isDefault = function(path) {
  *
  * @param {Boolean} [val] optional, overrides whether mongoose thinks the doc is deleted
  * @return {Boolean} whether mongoose thinks this doc is deleted.
+ * @method $isDeleted
  * @api public
  */
 
@@ -1253,7 +1258,7 @@ Document.prototype.isSelected = function isSelected(path) {
       if (cur === '_id') {
         continue;
       }
-      if (this.$__.selected[cur] && this.$__.selected[cur].$meta) {
+      if (!isDefiningProjection(this.$__.selected[cur])) {
         continue;
       }
       inclusive = !!this.$__.selected[cur];
@@ -1330,7 +1335,7 @@ Document.prototype.isDirectSelected = function isDirectSelected(path) {
       if (cur === '_id') {
         continue;
       }
-      if (this.$__.selected[cur] && this.$__.selected[cur].$meta) {
+      if (!isDefiningProjection(this.$__.selected[cur])) {
         continue;
       }
       inclusive = !!this.$__.selected[cur];
@@ -1410,9 +1415,13 @@ function _getPathsToValidate(doc) {
     len = subdocs.length;
     for (i = 0; i < len; ++i) {
       subdoc = subdocs[i];
-      if (subdoc.$isSingleNested &&
-          doc.isModified(subdoc.$basePath) &&
+      if (doc.isModified(subdoc.$basePath) &&
           !doc.isDirectModified(subdoc.$basePath)) {
+        // Remove child paths for now, because we'll be validating the whole
+        // subdoc
+        paths = paths.filter(function(p) {
+          return p != null && p.indexOf(subdoc.$basePath + '.') !== 0;
+        });
         paths.push(subdoc.$basePath);
       }
     }
@@ -1496,8 +1505,8 @@ Document.prototype.$__validate = function(callback) {
     });
   }
 
-  var validating = {},
-      total = 0;
+  var validated = {};
+  var total = 0;
 
   var complete = function() {
     var error = _complete();
@@ -1510,11 +1519,11 @@ Document.prototype.$__validate = function(callback) {
   };
 
   var validatePath = function(path) {
-    if (validating[path]) {
+    if (path == null || validated[path]) {
       return;
     }
 
-    validating[path] = true;
+    validated[path] = true;
     total++;
 
     process.nextTick(function() {
@@ -1691,7 +1700,7 @@ Document.prototype.invalidate = function(path, err, val, kind) {
  * Marks a path as valid, removing existing validation errors.
  *
  * @param {String} path the field to mark as valid
- * @api private
+ * @api public
  * @method $markValid
  * @receiver Document
  */

package/lib/drivers/browser/decimal128.js

@@ -0,0 +1,5 @@
+/*!
+ * ignore
+ */
+
+module.exports = require('bson').Decimal128;

package/lib/drivers/browser/index.js

@@ -3,5 +3,6 @@
  */
 
 exports.Binary = require('./binary');
+exports.Decimal128 = require('./decimal128');
 exports.ObjectId = require('./objectid');
 exports.ReadPreference = require('./ReadPreference');

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

@@ -0,0 +1,5 @@
+/*!
+ * ignore
+ */
+
+module.exports = require('mongodb').Decimal128;

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

@@ -3,5 +3,6 @@
  */
 
 exports.Binary = require('./binary');
+exports.Decimal128 = require('./decimal128');
 exports.ObjectId = require('./objectid');
 exports.ReadPreference = require('./ReadPreference');

package/lib/index.js

@@ -528,7 +528,10 @@ Mongoose.prototype.__defineGetter__('connection', function() {
 });
 
 Mongoose.prototype.__defineSetter__('connection', function(v) {
-  this.connections[0] = v;
+  if (v instanceof Connection) {
+    this.connections[0] = v;
+    this.models = v.models;
+  }
 });
 
 /*!

package/lib/model.js

@@ -2043,7 +2043,7 @@ Model.create = function create(doc, callback) {
         var Model = _this.discriminators && doc[discriminatorKey] ?
           _this.discriminators[doc[discriminatorKey]] :
           _this;
-        var toSave = doc instanceof Model ? doc : new Model(doc);
+        var toSave = doc;
         var callbackWrapper = function(error, doc) {
           if (error) {
             if (!firstError) {
@@ -2054,6 +2054,14 @@ Model.create = function create(doc, callback) {
           callback(null, { doc: doc });
         };
 
+        if (!(toSave instanceof Model)) {
+          try {
+            toSave = new Model(toSave);
+          } catch (error) {
+            return callbackWrapper(error);
+          }
+        }
+
         // Hack to avoid getting a promise because of
         // $__registerHooksFromSchema
         if (toSave.$__original_save) {
@@ -3253,7 +3261,9 @@ function populate(model, docs, options, callback) {
       mod.options.options.limit = mod.options.options.limit * ids.length;
     }
 
-    var subPopulate = mod.options.populate;
+    var subPopulate = utils.clone(mod.options.populate, {
+      retainKeyOrder: true
+    });
     var query = mod.Model.find(match, select, mod.options.options);
 
     // If we're doing virtual populate and projection is inclusive and foreign

package/lib/query.js

@@ -531,17 +531,51 @@ Query.prototype.slice = function() {
  */
 
 /**
- * Specifies a `$mod` condition
+ * Specifies a `$mod` condition, filters documents for documents whose
+ * `path` property is a number that is equal to `remainder` modulo `divisor`.
+ *
+ * ####Example
+ *
+ *     // All find products whose inventory is odd
+ *     Product.find().mod('inventory', [2, 1]);
+ *     Product.find().where('inventory').mod([2, 1]);
+ *     // This syntax is a little strange, but supported.
+ *     Product.find().where('inventory').mod(2, 1);
  *
  * @method mod
  * @memberOf Query
  * @param {String} [path]
- * @param {Number} val
+ * @param {Array} val must be of length 2, first element is `divisor`, 2nd element is `remainder`.
  * @return {Query} this
  * @see $mod http://docs.mongodb.org/manual/reference/operator/mod/
  * @api public
  */
 
+Query.prototype.mod = function() {
+  var val;
+  var path;
+
+  if (arguments.length === 1) {
+    this._ensurePath('mod');
+    val = arguments[0];
+    path = this._path;
+  } else if (arguments.length === 2 && !Array.isArray(arguments[1])) {
+    this._ensurePath('mod');
+    val = slice(arguments);
+    path = this._path;
+  } else if (arguments.length === 3) {
+    val = slice(arguments, 1);
+    path = arguments[0];
+  } else {
+    val = arguments[1];
+    path = arguments[0];
+  }
+
+  var conds = this._conditions[path] || (this._conditions[path] = {});
+  conds.$mod = val;
+  return this;
+};
+
 /**
  * Specifies an `$exists` condition
  *
@@ -995,11 +1029,11 @@ Query.prototype.setOptions = function(options, overwrite) {
     return this;
   }
 
-  if (!(options && options.constructor.name === 'Object')) {
+  if (options == null) {
     return this;
   }
 
-  if (options && Array.isArray(options.populate)) {
+  if (Array.isArray(options.populate)) {
     var populate = options.populate;
     delete options.populate;
     var _numPopulate = populate.length;
@@ -1149,6 +1183,10 @@ Query.prototype._optionsForExec = function(model) {
     options.readPreference = model.schema.options.read;
   }
 
+  if (options.upsert !== void 0) {
+    options.upsert = !!options.upsert;
+  }
+
   return options;
 };
 
@@ -1321,7 +1359,7 @@ Query.prototype._find = function(callback) {
  *
  *     query.find({ name: 'Los Pollos Hermanos' }).find(callback)
  *
- * @param {Object} [criteria] mongodb selector
+ * @param {Object} [filter] mongodb selector
  * @param {Function} [callback]
  * @return {Query} this
  * @api public
@@ -1337,9 +1375,11 @@ Query.prototype.find = function(conditions, callback) {
 
   if (mquery.canMerge(conditions)) {
     this.merge(conditions);
-  }
 
-  prepareDiscriminatorCriteria(this);
+    prepareDiscriminatorCriteria(this);
+  } else if (conditions != null) {
+    this.error(new ObjectParameterError(conditions, 'filter', 'find'));
+  }
 
   // if we don't have a callback, then just return the query object
   if (!callback) {
@@ -1526,7 +1566,7 @@ Query.prototype._findOne = function(callback) {
  *       }
  *     });
  *
- * @param {Object|Query} [criteria] mongodb selector
+ * @param {Object} [filter] mongodb selector
  * @param {Object} [projection] optional fields to return
  * @param {Object} [options] see [`setOptions()`](http://mongoosejs.com/docs/api.html#query_Query-setOptions)
  * @param {Function} [callback] optional params are (error, document)
@@ -1566,18 +1606,17 @@ Query.prototype.findOne = function(conditions, projection, options, callback) {
 
   if (mquery.canMerge(conditions)) {
     this.merge(conditions);
-  } else if (conditions != null) {
-    throw new Error('Invalid argument to findOne(): ' +
-      util.inspect(conditions));
-  }
 
-  prepareDiscriminatorCriteria(this);
+    prepareDiscriminatorCriteria(this);
 
-  try {
-    this.cast(this.model);
-    this.error(null);
-  } catch (err) {
-    this.error(err);
+    try {
+      this.cast(this.model);
+      this.error(null);
+    } catch (err) {
+      this.error(err);
+    }
+  } else if (conditions != null) {
+    this.error(new ObjectParameterError(conditions, 'filter', 'findOne'));
   }
 
   if (!callback) {

package/lib/queryhelpers.js

@@ -4,6 +4,7 @@
  */
 
 var get = require('lodash.get');
+var isDefiningProjection = require('./services/projection/isDefiningProjection');
 var utils = require('./utils');
 
 /*!
@@ -18,7 +19,9 @@ exports.preparePopulationOptions = function preparePopulationOptions(query, opti
   var pop = utils.object.vals(query.options.populate);
 
   // lean options should trickle through all queries
-  if (options.lean) pop.forEach(makeLean);
+  if (options.lean) {
+    pop.forEach(makeLean(options.lean));
+  }
 
   return pop;
 };
@@ -36,7 +39,9 @@ exports.preparePopulationOptionsMQ = function preparePopulationOptionsMQ(query,
   var pop = utils.object.vals(query._mongooseOptions.populate);
 
   // lean options should trickle through all queries
-  if (options.lean) pop.forEach(makeLean);
+  if (options.lean) {
+    pop.forEach(makeLean(options.lean));
+  }
 
   return pop;
 };
@@ -90,7 +95,8 @@ exports.applyPaths = function applyPaths(fields, schema) {
         continue;
       }
       field = fields[keys[ki]];
-      if (typeof field === 'object' && field && field.$slice) {
+      // Skip `$meta` and `$slice`
+      if (!isDefiningProjection(field)) {
         continue;
       }
       exclude = field === 0;
@@ -205,7 +211,9 @@ exports.applyPaths = function applyPaths(fields, schema) {
  * @param {Object} option
  */
 
-function makeLean(option) {
-  option.options || (option.options = {});
-  option.options.lean = true;
+function makeLean(val) {
+  return function(option) {
+    option.options || (option.options = {});
+    option.options.lean = val;
+  };
 }

package/lib/schema/boolean.js

@@ -52,15 +52,25 @@ SchemaBoolean.prototype.checkRequired = function(value) {
  * Casts to boolean
  *
  * @param {Object} value
+ * @param {Object} model - this value is optional
  * @api private
  */
 
-SchemaBoolean.prototype.cast = function(value) {
+SchemaBoolean.prototype.cast = function(value, model) {
   if (value === null) {
     return value;
   }
 
-  if (!this.options.strictBool) {
+  if (this.options.strictBool || (model && model.schema.options.strictBool && this.options.strictBool !== false)) {
+    // strict mode (throws if value is not a boolean, instead of converting)
+    if (value === true || value === 'true' || value === 1 || value === '1') {
+      return true;
+    }
+    if (value === false || value === 'false' || value === 0 || value === '0') {
+      return false;
+    }
+    throw new CastError('boolean', value, this.path);
+  } else {
     // legacy mode
     if (value === '0') {
       return false;
@@ -72,15 +82,6 @@ SchemaBoolean.prototype.cast = function(value) {
       return false;
     }
     return !!value;
-  } else {
-    // strict mode (throws if value is not a boolean, instead of converting)
-    if (value === true || value === 'true' || value === 1 || value === '1') {
-      return true;
-    }
-    if (value === false || value === 'false' || value === 0 || value === '0') {
-      return false;
-    }
-    throw new CastError('boolean', value, this.path);
   }
 };
 

package/lib/schema/documentarray.js

@@ -27,6 +27,7 @@ var utils = require('../utils');
 
 function DocumentArray(key, schema, options) {
   var EmbeddedDocument = _createConstructor(schema, options);
+  EmbeddedDocument.prototype.$basePath = key;
 
   ArrayType.call(this, key, EmbeddedDocument, options);
 

package/lib/services/cursor/eachAsync.js

@@ -30,7 +30,7 @@ module.exports = function eachAsync(next, fn, options, callback) {
     if (promise && typeof promise.then === 'function') {
       promise.then(
         function() { callback(null); },
-        function(error) { callback(error); });
+        function(error) { callback(error || new Error('`eachAsync()` promise rejected without error')); });
     } else {
       callback(null);
     }

package/lib/services/projection/isDefiningProjection.js

@@ -0,0 +1,18 @@
+'use strict';
+
+/*!
+ * ignore
+ */
+
+module.exports = function isDefiningProjection(val) {
+  if (val == null) {
+    // `undefined` or `null` become exclusive projections
+    return true;
+  }
+  if (typeof val === 'object') {
+    // Only cases where a value does **not** define whether the whole projection
+    // is inclusive or exclusive are `$meta` and `$slice`.
+    return !('$meta' in val) && !('$slice' in val);
+  }
+  return true;
+};

package/lib/services/projection/isInclusive.js

@@ -1,5 +1,7 @@
 'use strict';
 
+var isDefiningProjection = require('./isDefiningProjection');
+
 /*!
  * ignore
  */
@@ -19,7 +21,7 @@ module.exports = function isInclusive(projection) {
     var prop = props[i];
     // If field is truthy (1, true, etc.) and not an object, then this
     // projection must be inclusive. If object, assume its $meta, $slice, etc.
-    if (typeof projection[prop] !== 'object' && !!projection[prop]) {
+    if (isDefiningProjection(projection[prop]) && !!projection[prop]) {
       return true;
     }
   }

package/lib/types/decimal128.js

@@ -8,4 +8,4 @@
  * @constructor ObjectId
  */
 
-module.exports = require('bson').Decimal128;
+module.exports = require('../drivers').Decimal128;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mongoose",
   "description": "Mongoose MongoDB ODM",
-  "version": "4.13.5",
+  "version": "4.13.9",
   "author": "Guillermo Rauch <guillermo@learnboost.com>",
   "keywords": [
     "mongodb",
@@ -24,7 +24,7 @@
     "hooks-fixed": "2.0.2",
     "kareem": "1.5.0",
     "lodash.get": "4.4.2",
-    "mongodb": "2.2.33",
+    "mongodb": "2.2.34",
     "mpath": "0.3.0",
     "mpromise": "0.5.5",
     "mquery": "2.3.3",
@@ -46,7 +46,7 @@
     "jade": "0.26.3",
     "lodash": "4.16.6",
     "markdown": "0.5.0",
-    "marked": "0.3.6",
+    "marked": "0.3.9",
     "mocha": "3.2.0",
     "mongoose-long": "0.1.1",
     "mongodb-topology-manager": "1.0.11",

package/release-items.md

@@ -1,9 +1,9 @@
 ## mongoose release procedure
 
 1.  tests must pass
-2.  update package.json version
-3.  update History.md using `git changelog` or similar. list the related ticket(s) #<TICKET_NUMBER> as well as a link to the github user who fixed it if applicable.
-4.  git commit -m 'release x.x.x'
+2.  update `package.json` and `package-lock.json` version
+3.  update History.md using `git changelog` or similar. Add #<TICKET_NUMBER> as well as a link to the github user who fixed it if applicable.
+4.  git commit -a -m 'release x.x.x'
 5.  git tag x.x.x
 6.  git push origin BRANCH --tags && npm publish
 7.  update mongoosejs.com (see "updating the website" below)
@@ -14,16 +14,16 @@
 
 ## updating the website
 
-For 4.x
+For 5.x
 
 0. Change to the master branch
 1. execute `make docs` (when this process completes you'll be on the gh-pages branch)
-2. `git commit -a -m 'chore: website 4.x.x'`
+2. `git commit -a -m 'chore: website 5.x.x'`
 3. `git push origin gh-pages`
 
-For 3.8.x:
+For 4.x
 
-0. Change to the 3.8.x branch
+0. Change to the 4.x branch
 1. execute `make docs_legacy` (when this process completes you'll be on the gh-pages branch)
-2. `git commit -a -m 'website; regen <x.x.x>'`
+2. `git commit -a -m 'chore: website 4.x.x'`
 3. `git push origin gh-pages`

package/.npmignore

@@ -1,19 +0,0 @@
-lib-cov
-**.swp
-*.sw*
-*.orig
-.DS_Store
-node_modules/
-benchmarks/
-docs/
-test/
-Makefile
-CNAME
-index.html
-index.jade
-bin/
-karma.*.js
-format_deps.js
-tools/31*
-*.key
-data/