mongoose 4.13.8 → 4.13.12

package/History.md

@@ -1,3 +1,28 @@
+4.13.12 / 2018-03-13
+====================
+ * fix(document): make virtual get() return undefined instead of null if no getters #6223
+ * docs: fix url in useMongoClient error message #6219 #6217 [lineus](https://github.com/lineus)
+ * fix(discriminator): don't copy `discriminators` property from base schema #6122 #6064
+
+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
+
+4.13.10 / 2018-01-28
+====================
+ * docs(model+query): add lean() option to Model helpers #5996 [aguyinmontreal](https://github.com/aguyinmontreal)
+ * fix: use lazy loading so we can build mongoose with webpack #5993 #5842
+ * docs(connections): clarify multi-mongos with useMongoClient for 4.x docs #5984
+ * fix(populate): handle populating embedded discriminator paths #5970
+ * docs(query+aggregate): add more detail re: maxTimeMS #4066
+
+4.13.9 / 2018-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

package/README.md

@@ -5,8 +5,6 @@ Mongoose is a [MongoDB](https://www.mongodb.org/) object modeling tool designed
 [![Slack Status](http://slack.mongoosejs.io/badge.svg)](http://slack.mongoosejs.io)
 [![Build Status](https://api.travis-ci.org/Automattic/mongoose.svg?branch=master)](https://travis-ci.org/Automattic/mongoose)
 [![NPM version](https://badge.fury.io/js/mongoose.svg)](http://badge.fury.io/js/mongoose)
-[![Dependency Status](https://gemnasium.com/Automattic/mongoose.svg)](https://gemnasium.com/Automattic/mongoose)
-[![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/vkarpov?utm_source=github&utm_medium=button&utm_term=vkarpov&utm_campaign=github)
 
 ## Documentation
 

package/lib/aggregate.js

@@ -554,7 +554,10 @@ Aggregate.prototype.allowDiskUse = function(value) {
  *     var agg = Model.aggregate(..).option({ allowDiskUse: true }); // Set the `allowDiskUse` option
  *     agg.options; // `{ allowDiskUse: true }`
  *
- * @param {Object} value keys to merge into current options
+ * @param {Object} options keys to merge into current options
+ * @param [options.maxTimeMS] number limits the time this aggregation will run, see [MongoDB docs on `maxTimeMS`](https://docs.mongodb.com/manual/reference/operator/meta/maxTimeMS/)
+ * @param [options.allowDiskUse] boolean if true, the MongoDB server will use the hard drive to store data during this aggregation
+ * @param [options.collation] object see [`Aggregate.prototype.collation()`](./docs/api.html#aggregate_Aggregate-collation)
  * @see mongodb http://docs.mongodb.org/manual/reference/command/aggregate/
  * @return {Aggregate} this
  * @api public
@@ -574,7 +577,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
  *     });
@@ -621,7 +624,6 @@ Aggregate.prototype.addCursorFlag = function(flag, value) {
  *     Model.aggregate(..).collation({ locale: 'en_US', strength: 1 }).exec();
  *
  * @param {Object} collation options
- * @param {Boolean} value
  * @see mongodb http://mongodb.github.io/node-mongodb-native/2.2/api/Collection.html#aggregate
  */
 

package/lib/connection.js

@@ -340,7 +340,7 @@ Connection.prototype.open = util.deprecate(function() {
   };
 
   return promise;
-}, '`open()` is deprecated in mongoose >= 4.11.0, use `openUri()` instead, or set the `useMongoClient` option if using `connect()` or `createConnection()`. See http://mongoosejs.com/docs/connections.html#use-mongo-client');
+}, '`open()` is deprecated in mongoose >= 4.11.0, use `openUri()` instead, or set the `useMongoClient` option if using `connect()` or `createConnection()`. See http://mongoosejs.com/docs/4.x/docs/connections.html#use-mongo-client');
 
 /*!
  * ignore
@@ -653,7 +653,7 @@ Connection.prototype.openSet = util.deprecate(function(uris, database, options,
   };
 
   return promise;
-}, '`openSet()` is deprecated in mongoose >= 4.11.0, use `openUri()` instead, or set the `useMongoClient` option if using `connect()` or `createConnection()`. See http://mongoosejs.com/docs/connections.html#use-mongo-client');
+}, '`openSet()` is deprecated in mongoose >= 4.11.0, use `openUri()` instead, or set the `useMongoClient` option if using `connect()` or `createConnection()`. See http://mongoosejs.com/docs/4.x/docs/connections.html#use-mongo-client');
 
 /**
  * error

package/lib/document.js

@@ -487,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;
@@ -987,6 +988,9 @@ Document.prototype.get = function(path, type) {
   var obj = this._doc;
 
   if (schema instanceof VirtualType) {
+    if (schema.getters.length === 0) {
+      return void 0;
+    }
     return schema.applyGetters(null, this);
   }
 
@@ -1178,6 +1182,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
  */
 

package/lib/index.js

@@ -188,14 +188,14 @@ var checkReplicaSetInUri = function(uri) {
  * @api public
  */
 
-Mongoose.prototype.createConnection = function(uri, options) {
+Mongoose.prototype.createConnection = function(uri, options, callback) {
   var conn = new Connection(this);
   this.connections.push(conn);
 
   var rsOption = options && (options.replset || options.replSet);
 
   if (options && options.useMongoClient) {
-    return conn.openUri(uri, options);
+    return conn.openUri(uri, options, callback);
   }
 
   if (arguments.length) {

package/lib/model.js

@@ -21,6 +21,7 @@ var castUpdate = require('./services/query/castUpdate');
 var discriminator = require('./services/model/discriminator');
 var isPathSelectedInclusive = require('./services/projection/isPathSelectedInclusive');
 var get = require('lodash.get');
+var getSchemaTypes = require('./services/populate/getSchemaTypes');
 var mpath = require('mpath');
 var parallel = require('async/parallel');
 var parallelLimit = require('async/parallelLimit');
@@ -1686,6 +1687,7 @@ Model.$where = function $where() {
  * @param {Object} [conditions]
  * @param {Object} [update]
  * @param {Object} [options] optional see [`Query.prototype.setOptions()`](http://mongoosejs.com/docs/api.html#query_Query-setOptions)
+ * @param {Object} [options.lean] if truthy, mongoose will return the document as a plain JavaScript object rather than a mongoose document. See [`Query.lean()`](http://mongoosejs.com/docs/api.html#query_Query-lean).
  * @param {Function} [callback]
  * @return {Query}
  * @see mongodb http://www.mongodb.org/display/DOCS/findAndModify+Command
@@ -1805,6 +1807,7 @@ Model.findOneAndUpdate = function(conditions, update, options, callback) {
  * @param {Object|Number|String} id value of `_id` to query by
  * @param {Object} [update]
  * @param {Object} [options] optional see [`Query.prototype.setOptions()`](http://mongoosejs.com/docs/api.html#query_Query-setOptions)
+ * @param {Object} [options.lean] if truthy, mongoose will return the document as a plain JavaScript object rather than a mongoose document. See [`Query.lean()`](http://mongoosejs.com/docs/api.html#query_Query-lean).
  * @param {Function} [callback]
  * @return {Query}
  * @see Model.findOneAndUpdate #model_Model.findOneAndUpdate
@@ -2968,7 +2971,8 @@ Model.aggregate = function aggregate() {
  * - `lean` {Boolean} return the raw object instead of the Mongoose Model
  *
  * @param {Object} conditions an object that specifies the match condition (required)
- * @param {Object} options for the geoSearch, some (near, maxDistance) are required
+ * @param {Object} [options] for the geoSearch, some (near, maxDistance) are required
+ * @param {Object} [options.lean] if truthy, mongoose will return the document as a plain JavaScript object rather than a mongoose document. See [`Query.lean()`](http://mongoosejs.com/docs/api.html#query_Query-lean).
  * @param {Function} [callback] optional callback
  * @return {Promise}
  * @see http://docs.mongodb.org/manual/reference/command/geoSearch/
@@ -3548,95 +3552,42 @@ function getModelsMapForPopulate(model, docs, options) {
   var originalModel = options.model;
   var isVirtual = false;
   var isRefPathArray = false;
-
-  schema = model._getSchema(options.path);
-  var isUnderneathDocArray = schema && schema.$isUnderneathDocArray;
-  if (isUnderneathDocArray &&
-      options &&
-      options.options &&
-      options.options.sort) {
-    return new Error('Cannot populate with `sort` on path ' + options.path +
-      ' because it is a subproperty of a document array');
-  }
-
-  if (schema && schema.caster) {
-    schema = schema.caster;
-  }
-
-  if (!schema && model.discriminators) {
-    discriminatorKey = model.schema.discriminatorMapping.key;
-  }
-
-  refPath = schema && schema.options && schema.options.refPath;
+  var modelSchema = model.schema;
 
   for (i = 0; i < len; i++) {
     doc = docs[i];
 
-    if (refPath) {
-      modelNames = utils.getValue(refPath, doc);
-      isRefPathArray = Array.isArray(modelNames);
-    } else {
-      if (!modelNameFromQuery) {
-        var modelForCurrentDoc = model;
-        var schemaForCurrentDoc;
-
-        if (!schema && discriminatorKey) {
-          modelForFindSchema = utils.getValue(discriminatorKey, doc);
-
-          if (modelForFindSchema) {
-            try {
-              modelForCurrentDoc = model.db.model(modelForFindSchema);
-            } catch (error) {
-              return error;
-            }
-
-            schemaForCurrentDoc = modelForCurrentDoc._getSchema(options.path);
+    schema = getSchemaTypes(modelSchema, doc, options.path);
+    var isUnderneathDocArray = schema && schema.$isUnderneathDocArray;
+    if (isUnderneathDocArray &&
+        options &&
+        options.options &&
+        options.options.sort) {
+      return new Error('Cannot populate with `sort` on path ' + options.path +
+        ' because it is a subproperty of a document array');
+    }
 
-            if (schemaForCurrentDoc && schemaForCurrentDoc.caster) {
-              schemaForCurrentDoc = schemaForCurrentDoc.caster;
-            }
-          }
-        } else {
-          schemaForCurrentDoc = schema;
+    if (Array.isArray(schema)) {
+      for (var j = 0; j < schema.length; ++j) {
+        var _modelNames = _getModelNames(doc, schema[j]);
+        if (!_modelNames) {
+          continue;
         }
-        var virtual = modelForCurrentDoc.schema._getVirtual(options.path);
-
-        var ref;
-        if ((ref = get(schemaForCurrentDoc, 'options.ref')) != null) {
-          modelNames = [ref];
-        } else if ((ref = get(virtual, 'options.ref')) != null) {
-          if (typeof ref === 'function') {
-            ref = ref.call(doc, doc);
-          }
-
-          // When referencing nested arrays, the ref should be an Array
-          // of modelNames.
-          if (Array.isArray(ref)) {
-            modelNames = ref;
-          } else {
-            modelNames = [ref];
+        modelNames = (modelNames || []);
+        for (var x = 0; x < _modelNames.length; ++x) {
+          if (modelNames.indexOf(_modelNames[x]) === -1) {
+            modelNames.push(_modelNames[x]);
           }
-
-          isVirtual = true;
-        } else {
-          // We may have a discriminator, in which case we don't want to
-          // populate using the base model by default
-          modelNames = discriminatorKey ? null : [model.modelName];
         }
-      } else {
-        modelNames = [modelNameFromQuery];  // query options
+      }
+    } else {
+      modelNames = _getModelNames(doc, schema);
+      if (!modelNames) {
+        continue;
       }
     }
 
-    if (!modelNames) {
-      continue;
-    }
-
-    if (!Array.isArray(modelNames)) {
-      modelNames = [modelNames];
-    }
-
-    virtual = model.schema._getVirtual(options.path);
+    var virtual = model.schema._getVirtual(options.path);
     var localField;
     if (virtual && virtual.options) {
       var virtualPrefix = virtual.$nestedSchemaPath ?
@@ -3726,6 +3677,87 @@ function getModelsMapForPopulate(model, docs, options) {
     }
   }
 
+  function _getModelNames(doc, schema) {
+    var modelNames;
+    var discriminatorKey;
+
+    if (schema && schema.caster) {
+      schema = schema.caster;
+    }
+
+    if (!schema && model.discriminators) {
+      discriminatorKey = model.schema.discriminatorMapping.key;
+    }
+
+    refPath = schema && schema.options && schema.options.refPath;
+
+    if (refPath) {
+      modelNames = utils.getValue(refPath, doc);
+      isRefPathArray = Array.isArray(modelNames);
+    } else {
+      if (!modelNameFromQuery) {
+        var modelForCurrentDoc = model;
+        var schemaForCurrentDoc;
+
+        if (!schema && discriminatorKey) {
+          modelForFindSchema = utils.getValue(discriminatorKey, doc);
+
+          if (modelForFindSchema) {
+            try {
+              modelForCurrentDoc = model.db.model(modelForFindSchema);
+            } catch (error) {
+              return error;
+            }
+
+            schemaForCurrentDoc = modelForCurrentDoc.schema._getSchema(options.path);
+
+            if (schemaForCurrentDoc && schemaForCurrentDoc.caster) {
+              schemaForCurrentDoc = schemaForCurrentDoc.caster;
+            }
+          }
+        } else {
+          schemaForCurrentDoc = schema;
+        }
+        var virtual = modelForCurrentDoc.schema._getVirtual(options.path);
+
+        var ref;
+        if ((ref = get(schemaForCurrentDoc, 'options.ref')) != null) {
+          modelNames = [ref];
+        } else if ((ref = get(virtual, 'options.ref')) != null) {
+          if (typeof ref === 'function') {
+            ref = ref.call(doc, doc);
+          }
+
+          // When referencing nested arrays, the ref should be an Array
+          // of modelNames.
+          if (Array.isArray(ref)) {
+            modelNames = ref;
+          } else {
+            modelNames = [ref];
+          }
+
+          isVirtual = true;
+        } else {
+          // We may have a discriminator, in which case we don't want to
+          // populate using the base model by default
+          modelNames = discriminatorKey ? null : [model.modelName];
+        }
+      } else {
+        modelNames = [modelNameFromQuery]; // query options
+      }
+    }
+
+    if (!modelNames) {
+      return;
+    }
+
+    if (!Array.isArray(modelNames)) {
+      modelNames = [modelNames];
+    }
+
+    return modelNames;
+  }
+
   return map;
 }
 
@@ -3854,20 +3886,6 @@ function isDoc(doc) {
   return true;
 }
 
-/**
- * Finds the schema for `path`. This is different than
- * calling `schema.path` as it also resolves paths with
- * positional selectors (something.$.another.$.path).
- *
- * @param {String} path
- * @return {Schema}
- * @api private
- */
-
-Model._getSchema = function _getSchema(path) {
-  return this.schema._getSchema(path);
-};
-
 /*!
  * Compiler utility.
  *

package/lib/query.js

@@ -1002,13 +1002,16 @@ Query.prototype.read = function read(pref, tags) {
  * - [readPreference](http://docs.mongodb.org/manual/applications/replication/#read-preference)
  * - [hint](http://www.mongodb.org/display/DOCS/Advanced+Queries#AdvancedQueries-%24hint)
  *
- * The following options are only for `update()`, `updateOne()`, `updateMany()`, `replaceOne()`, and `findOneAndUpdate()`:
+ * The following options are only for `update()`, `updateOne()`, `updateMany()`, `replaceOne()`, `findOneAndUpdate()`, and `findByIdAndUpdate()`:
  * - [upsert](https://docs.mongodb.com/manual/reference/method/db.collection.update/)
  * - [writeConcern](https://docs.mongodb.com/manual/reference/method/db.collection.update/)
  *
- * The following options are only for `find()`, `findOne()`, `findById()`, and `findOneAndUpdate()`:
+ * The following options are only for `find()`, `findOne()`, `findById()`, `findOneAndUpdate()`, and `findByIdAndUpdate()`:
  * - [lean](./api.html#query_Query-lean)
  *
+ * The following options are only for all operations **except** `update()`, `updateOne()`, `updateMany()`, `remove()`, `deleteOne()`, and `deleteMany()`:
+ * - [maxTimeMS](https://docs.mongodb.com/manual/reference/operator/meta/maxTimeMS/)
+ *
  * The following options are for all operations:
  * - [collation](https://docs.mongodb.com/manual/reference/collation/)
  *

package/lib/schema/array.js

@@ -15,8 +15,6 @@ var Types = {
   ObjectId: require('./objectid'),
   Buffer: require('./buffer')
 };
-var MongooseArray = require('../types').Array;
-var EmbeddedDoc = require('../types').Embedded;
 var Mixed = require('./mixed');
 var cast = require('../cast');
 var util = require('util');
@@ -24,6 +22,9 @@ var utils = require('../utils');
 var castToNumber = require('./operators/helpers').castToNumber;
 var geospatial = require('./operators/geospatial');
 
+var MongooseArray;
+var EmbeddedDoc;
+
 /**
  * Array SchemaType constructor
  *
@@ -35,6 +36,9 @@ var geospatial = require('./operators/geospatial');
  */
 
 function SchemaArray(key, cast, options, schemaOptions) {
+  // lazy load
+  EmbeddedDoc || (EmbeddedDoc = require('../types').Embedded);
+
   var typeKey = 'type';
   if (schemaOptions && schemaOptions.typeKey) {
     typeKey = schemaOptions.typeKey;
@@ -155,6 +159,9 @@ SchemaArray.prototype.applyGetters = function(value, scope) {
  */
 
 SchemaArray.prototype.cast = function(value, doc, init) {
+  // lazy load
+  MongooseArray || (MongooseArray = require('../types').Array);
+
   if (Array.isArray(value)) {
     if (!value.length && doc) {
       var indexes = doc.schema.indexedPaths();

package/lib/schema/buffer.js

@@ -5,7 +5,7 @@
 var handleBitwiseOperator = require('./operators/bitwise');
 var utils = require('../utils');
 
-var MongooseBuffer = require('../types').Buffer;
+var MongooseBuffer = require('../types/buffer');
 var SchemaType = require('../schematype');
 
 var Binary = MongooseBuffer.Binary;

package/lib/schema/documentarray.js

@@ -8,13 +8,14 @@ var ArrayType = require('./array');
 var CastError = require('../error/cast');
 var Document = require('../document');
 var EventEmitter = require('events').EventEmitter;
-var MongooseDocumentArray = require('../types/documentarray');
 var SchemaType = require('../schematype');
-var Subdocument = require('../types/embedded');
 var discriminator = require('../services/model/discriminator');
 var util = require('util');
 var utils = require('../utils');
 
+var MongooseDocumentArray;
+var Subdocument;
+
 /**
  * SubdocsArray SchemaType constructor
  *
@@ -66,6 +67,8 @@ DocumentArray.prototype.constructor = DocumentArray;
  */
 
 function _createConstructor(schema, options) {
+  Subdocument || (Subdocument = require('../types/embedded'));
+
   // compile an embedded document for this schema
   function EmbeddedDocument() {
     Subdocument.apply(this, arguments);
@@ -130,6 +133,9 @@ DocumentArray.prototype.discriminator = function(name, schema) {
  */
 
 DocumentArray.prototype.doValidate = function(array, fn, scope, options) {
+  // lazy load
+  MongooseDocumentArray || (MongooseDocumentArray = require('../types/documentarray'));
+
   var _this = this;
   SchemaType.prototype.doValidate.call(this, array, function(err) {
     if (err) {
@@ -251,6 +257,9 @@ DocumentArray.prototype.doValidateSync = function(array, scope) {
  */
 
 DocumentArray.prototype.cast = function(value, doc, init, prev, options) {
+  // lazy load
+  MongooseDocumentArray || (MongooseDocumentArray = require('../types/documentarray'));
+
   var selected;
   var subdoc;
   var i;

package/lib/schema/embedded.js

@@ -7,11 +7,12 @@
 var $exists = require('./operators/exists');
 var EventEmitter = require('events').EventEmitter;
 var SchemaType = require('../schematype');
-var Subdocument = require('../types/subdocument');
 var castToNumber = require('./operators/helpers').castToNumber;
 var discriminator = require('../services/model/discriminator');
 var geospatial = require('./operators/geospatial');
 
+var Subdocument;
+
 module.exports = Embedded;
 
 /**
@@ -43,6 +44,9 @@ Embedded.prototype = Object.create(SchemaType.prototype);
  */
 
 function _createConstructor(schema) {
+  // lazy load
+  Subdocument || (Subdocument = require('../types/subdocument'));
+
   var _embedded = function SingleNested(value, path, parent) {
     var _this = this;
 

package/lib/schema.js

@@ -804,22 +804,17 @@ Schema.prototype.hasMixedParent = function(path) {
  */
 Schema.prototype.setupTimestamp = function(timestamps) {
   if (timestamps) {
-    var paths = ['createdAt', 'updatedAt'].map(handleTimestampOption.bind(null, timestamps));
-    var createdAt = paths[0];
-    var updatedAt = paths[1];
-    var schemaAdditions = paths.reduce(function(cur, path) {
-      if (path != null) {
-        var parts = path.split('.');
-        if (this.pathType(path) === 'adhocOrUndefined') {
-          for (var i = 0; i < parts.length; ++i) {
-            cur[parts[i]] = (i < parts.length - 1 ?
-            cur[parts[i]] || {} :
-              Date);
-          }
-        }
-      }
-      return cur;
-    }.bind(this), {});
+    var createdAt = handleTimestampOption(timestamps, 'createdAt');
+    var updatedAt = handleTimestampOption(timestamps, 'updatedAt');
+    var schemaAdditions = {};
+
+    if (updatedAt && !this.paths[updatedAt]) {
+      schemaAdditions[updatedAt] = Date;
+    }
+
+    if (createdAt && !this.paths[createdAt]) {
+      schemaAdditions[createdAt] = Date;
+    }
 
     this.add(schemaAdditions);
 
@@ -1403,7 +1398,8 @@ Object.defineProperty(Schema, 'indexTypes', {
 });
 
 /**
- * Compiles indexes from fields and schema-level indexes
+ * Returns a list of indexes that this schema declares, via `schema.index()`
+ * or by `index: true` in a path's options.
  *
  * @api public
  */

package/lib/services/model/discriminator.js

@@ -62,7 +62,10 @@ module.exports = function discriminator(model, name, schema) {
       delete schema.paths._id;
       delete schema.tree._id;
     }
-    utils.merge(schema, baseSchema, { retainKeyOrder: true });
+    utils.merge(schema, baseSchema, {
+      retainKeyOrder: true,
+      omit: { discriminators: true }
+    });
 
     var obj = {};
     obj[key] = {
@@ -128,8 +131,11 @@ module.exports = function discriminator(model, name, schema) {
 
   if (!model.schema.discriminatorMapping) {
     model.schema.discriminatorMapping = {key: key, value: null, isRoot: true};
+    model.schema.discriminators = {};
   }
 
+  model.schema.discriminators[name] = schema;
+
   if (model.discriminators[name]) {
     throw new Error('Discriminator with name "' + name + '" already exists');
   }