mongoose 4.11.14 → 4.12.3

package/History.md

@@ -1,3 +1,44 @@
+4.12.3 / 2017-10-16
+===================
+ * fix(connection): emit 'reconnect' event as well as 'reconnected' for consistency with driver #5719
+ * fix: correctly bubble up left/joined events for replica set #5718
+ * fix(connection): allow passing in `autoIndex` as top-level option rather than requiring `config.autoIndex` #5711
+ * docs(connection): improve docs regarding reconnectTries, autoReconnect, and bufferMaxEntries #5711
+ * fix(query): handle null with addToSet/push/pull/pullAll update validators #5710
+ * fix(model): handle setDefaultsOnInsert option for bulkWrite updateOne and updateMany #5708
+ * fix(query): avoid infinite recursion edge case when cloning a buffer #5702
+
+4.12.2 / 2017-10-14
+===================
+ * docs(faq): add FAQ about using arrow functions for getters/setters, virtuals, and methods #5700
+ * docs(schema): document the childSchemas property and add to public API #5695
+ * fix(query): don't project in populated field if parent field is already projected in #5669
+ * fix: bump mongodb -> 2.2.33 for issue with autoReconnect #4513
+
+4.12.1 / 2017-10-08
+===================
+ * fix(document): create new doc when setting single nested, no more set() on copy of priorVal #5693
+ * fix(model): recursively call applyMethods on child schemas for global plugins #5690
+ * docs: fix bad promise lib example on home page #5686
+ * fix(query): handle false when checking for inclusive/exclusive projection #5685
+ * fix(discriminator): allow reusing child schema #5684
+ * fix: make addToSet() on empty array with subdoc trigger manual population #5504
+
+4.12.0 / 2017-10-02
+===================
+ * docs(validation): add docs coverage for ValidatorError.reason #5681
+ * feat(discriminator): always add discriminatorKey to base schema to allow updating #5613
+ * fix(document): make nested docs no longer inherit parent doc's schema props #5586 #5546 #5470
+ * feat(query): run update validators on $pull and $pullAll #5555
+ * feat(query): add .error() helper to query to error out in pre hooks #5520
+ * feat(connection): add dropCollection() helper #5393
+ * feat(schema): add schema-level collation option #5295
+ * feat(types): add `discriminator()` function for single nested subdocs #5244
+ * feat(document): add $isDeleted() getter/setter for better support for soft deletes #4428
+ * feat(connection): bubble up reconnectFailed event when driver gives up reconnecting #4027
+ * fix(query): report error if passing array or other non-object as filter to update query #3677
+ * fix(collection): use createIndex() instead of deprecated ensureIndex() #3280
+
 4.11.14 / 2017-09-30
 ====================
  * chore: add nsp check to the CI build #5679 [hairyhenderson](https://github.com/hairyhenderson)

package/lib/aggregate.js

@@ -63,10 +63,15 @@ function Aggregate() {
 
 Aggregate.prototype.model = function(model) {
   this._model = model;
-  if (this.options.readPreference == null &&
-      model.schema &&
-      model.schema.options.read != null) {
-    this.options.readPreference = model.schema.options.read;
+  if (model.schema != null) {
+    if (this.options.readPreference == null &&
+        model.schema.options.read != null) {
+      this.options.readPreference = model.schema.options.read;
+    }
+    if (this.options.collation == null &&
+        model.schema.options.collation != null) {
+      this.options.collation = model.schema.options.collation;
+    }
   }
   return this;
 };

package/lib/collection.js

@@ -139,6 +139,14 @@ Collection.prototype.ensureIndex = function() {
   throw new Error('Collection#ensureIndex unimplemented by driver');
 };
 
+/**
+ * Abstract method that drivers must implement.
+ */
+
+Collection.prototype.createIndex = function() {
+  throw new Error('Collection#ensureIndex unimplemented by driver');
+};
+
 /**
  * Abstract method that drivers must implement.
  */

package/lib/connection.js

@@ -369,42 +369,70 @@ Connection.prototype._openWithoutPromise = function() {
 };
 
 /**
- * Helper for `dropDatabase()`.
+ * Helper for `dropCollection()`. Will delete the given collection, including
+ * all documents and indexes.
  *
- * @param {Function} callback
+ * @param {string} collection The collection to delete
+ * @param {Function} [callback]
  * @return {Promise}
  * @api public
  */
 
-Connection.prototype.dropDatabase = function(callback) {
-  var Promise = PromiseProvider.get();
-  var _this = this;
-  var promise = new Promise.ES6(function(resolve, reject) {
-    if (_this.readyState !== STATES.connected) {
-      _this.on('open', function() {
-        _this.db.dropDatabase(function(error) {
+Connection.prototype.dropCollection = _wrapConnHelper(function dropCollection(collection, cb) {
+  this.db.dropCollection(collection, cb);
+});
+
+/**
+ * Helper for `dropDatabase()`. Deletes the given database, including all
+ * collections, documents, and indexes.
+ *
+ * @param {Function} [callback]
+ * @return {Promise}
+ * @api public
+ */
+
+Connection.prototype.dropDatabase = _wrapConnHelper(function dropDatabase(cb) {
+  this.db.dropDatabase(cb);
+});
+
+/*!
+ * ignore
+ */
+
+function _wrapConnHelper(fn) {
+  return function() {
+    var _this = this;
+    var Promise = PromiseProvider.get();
+    var argsWithoutCb = Array.prototype.slice.call(arguments, 0, fn.length - 1);
+    var cb = arguments[arguments.length - 1];
+    var promise = new Promise.ES6(function(resolve, reject) {
+      if (_this.readyState !== STATES.connected) {
+        _this.on('open', function() {
+          fn.apply(_this, argsWithoutCb.concat([function(error) {
+            if (error) {
+              reject(error);
+            } else {
+              resolve();
+            }
+          }]));
+        });
+      } else {
+        fn.apply(_this, argsWithoutCb.concat([function(error) {
           if (error) {
             reject(error);
           } else {
             resolve();
           }
-        });
-      });
-    } else {
-      _this.db.dropDatabase(function(error) {
-        if (error) {
-          reject(error);
-        } else {
-          resolve();
-        }
-      });
+        }]));
+      }
+    });
+    if (cb) {
+      promise.
+        then(function() { cb(); }, function(error) { cb(error); });
     }
-  });
-  if (callback) {
-    promise.then(function() { callback(); }, callback);
-  }
-  return promise;
-};
+    return promise;
+  };
+}
 
 /*!
  * ignore
@@ -735,9 +763,13 @@ Connection.prototype.openUri = function(uri, options, callback) {
   if (options) {
     options = utils.clone(options, { retainKeyOrder: true });
     delete options.useMongoClient;
-    if (options.config && options.config.autoIndex != null) {
-      this.config.autoIndex = options.config.autoIndex !== false;
+    var autoIndex = options.config && options.config.autoIndex != null ?
+      options.config.autoIndex :
+      options.autoIndex;
+    if (autoIndex != null) {
+      this.config.autoIndex = autoIndex !== false;
       delete options.config;
+      delete options.autoIndex;
     }
 
     // Backwards compat
@@ -767,8 +799,12 @@ Connection.prototype.openUri = function(uri, options, callback) {
       // Backwards compat for mongoose 4.x
       db.on('reconnect', function() {
         _this.readyState = STATES.connected;
+        _this.emit('reconnect');
         _this.emit('reconnected');
       });
+      db.s.topology.on('reconnectFailed', function() {
+        _this.emit('reconnectFailed');
+      });
       db.s.topology.on('close', function() {
         // Implicitly emits 'disconnected'
         _this.readyState = STATES.disconnected;

package/lib/document.js

@@ -41,11 +41,12 @@ var idGetter = require('./plugins/idGetter');
  * @api private
  */
 
-function Document(obj, fields, skipId) {
+function Document(obj, fields, skipId, options) {
   this.$__ = new InternalCache;
   this.$__.emitter = new EventEmitter();
   this.isNew = true;
   this.errors = undefined;
+  this.$__.$options = options || {};
 
   var schema = this.schema;
 
@@ -757,7 +758,10 @@ Document.prototype.set = function(path, val, type, options) {
       didPopulate = true;
     }
 
-    val = schema.applySetters(val, this, false, priorVal);
+    var setterContext = constructing && this.$__.$options.priorDoc ?
+      this.$__.$options.priorDoc :
+      this;
+    val = schema.applySetters(val, setterContext, false, priorVal);
 
     if (!didPopulate && this.$__.populated) {
       delete this.$__.populated[path];
@@ -1126,6 +1130,33 @@ Document.prototype.$isDefault = function(path) {
   return (path in this.$__.activePaths.states.default);
 };
 
+/**
+ * Getter/setter, determines whether the document was removed or not.
+ *
+ * ####Example:
+ *     product.remove(function (err, product) {
+ *       product.isDeleted(); // true
+ *       product.remove(); // no-op, doesn't send anything to the db
+ *
+ *       product.isDeleted(false);
+ *       product.isDeleted(); // false
+ *       product.remove(); // will execute a remove against the db
+ *     })
+ *
+ * @param {Boolean} [val] optional, overrides whether mongoose thinks the doc is deleted
+ * @return {Boolean} whether mongoose thinks this doc is deleted.
+ * @api public
+ */
+
+Document.prototype.$isDeleted = function(val) {
+  if (arguments.length === 0) {
+    return !!this.$__.isDeleted;
+  }
+
+  this.$__.isDeleted = !!val;
+  return this;
+};
+
 /**
  * Returns true if `path` was directly set and modified, else false.
  *

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

@@ -2,9 +2,10 @@
  * Module dependencies.
  */
 
-var MongooseCollection = require('../../collection'),
-    Collection = require('mongodb').Collection,
-    utils = require('../../utils');
+var MongooseCollection = require('../../collection');
+var Collection = require('mongodb').Collection;
+var util = require('util');
+var utils = require('../../utils');
 
 /**
  * A [node-mongodb-native](https://github.com/mongodb/node-mongodb-native) collection implementation.
@@ -155,6 +156,13 @@ for (var i in Collection.prototype) {
   iter(i);
 }
 
+/*!
+ * ignore
+ */
+
+Collection.prototype.ensureIndex = util.deprecate(Collection.prototype.ensureIndex,
+  '`ensureIndex()` is deprecated in Mongoose >= 4.12.0, use `createIndex()` instead');
+
 /**
  * Debug print helper
  *

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

@@ -162,6 +162,7 @@ function listen(conn) {
   });
   conn.db.on('reconnect', function() {
     conn.readyState = STATES.connected;
+    conn.emit('reconnect');
     conn.emit('reconnected');
     conn.onOpen();
   });
@@ -171,6 +172,7 @@ function listen(conn) {
   conn.db.on('open', function(err, db) {
     if (STATES.disconnected === conn.readyState && db && db.databaseName) {
       conn.readyState = STATES.connected;
+      conn.emit('reconnect');
       conn.emit('reconnected');
     }
   });
@@ -204,6 +206,14 @@ NativeConnection.prototype.doOpenSet = function(fn) {
     : new ReplSetServers(servers, this.options.replset || this.options.replSet);
   this.db = new Db(this.name, server, this.options.db);
 
+  this.db.s.topology.on('left', function(data) {
+    _this.emit('left', data);
+  });
+
+  this.db.s.topology.on('joined', function(data) {
+    _this.emit('joined', data);
+  });
+
   this.db.on('fullsetup', function() {
     _this.emit('fullsetup');
   });

package/lib/error/browserMissingSchema.js

@@ -2,7 +2,7 @@
  * Module dependencies.
  */
 
-var MongooseError = require('../error.js');
+var MongooseError = require('./');
 
 /*!
  * MissingSchema Error constructor.

package/lib/error/cast.js

@@ -2,7 +2,7 @@
  * Module dependencies.
  */
 
-var MongooseError = require('../error.js');
+var MongooseError = require('./');
 var util = require('util');
 
 /**

package/lib/error/disconnected.js

@@ -2,7 +2,7 @@
  * Module dependencies.
  */
 
-var MongooseError = require('../error.js');
+var MongooseError = require('./');
 
 /**
  * Casting Error constructor.

package/lib/error/divergentArray.js

@@ -3,7 +3,7 @@
  * Module dependencies.
  */
 
-var MongooseError = require('../error.js');
+var MongooseError = require('./');
 
 /*!
  * DivergentArrayError constructor.

package/lib/{error.js → error/index.js}

@@ -37,7 +37,7 @@ module.exports = exports = MongooseError;
  * @api public
  */
 
-MongooseError.messages = require('./error/messages');
+MongooseError.messages = require('./messages');
 
 // backward compat
 MongooseError.Messages = MongooseError.messages;
@@ -51,16 +51,16 @@ MongooseError.Messages = MongooseError.messages;
  * @api public
  */
 
-MongooseError.DocumentNotFoundError = require('./error/notFound');
+MongooseError.DocumentNotFoundError = require('./notFound');
 
 /*!
  * Expose subclasses
  */
 
-MongooseError.CastError = require('./error/cast');
-MongooseError.ValidationError = require('./error/validation');
-MongooseError.ValidatorError = require('./error/validator');
-MongooseError.VersionError = require('./error/version');
-MongooseError.OverwriteModelError = require('./error/overwriteModel');
-MongooseError.MissingSchemaError = require('./error/missingSchema');
-MongooseError.DivergentArrayError = require('./error/divergentArray');
+MongooseError.CastError = require('./cast');
+MongooseError.ValidationError = require('./validation');
+MongooseError.ValidatorError = require('./validator');
+MongooseError.VersionError = require('./version');
+MongooseError.OverwriteModelError = require('./overwriteModel');
+MongooseError.MissingSchemaError = require('./missingSchema');
+MongooseError.DivergentArrayError = require('./divergentArray');

package/lib/error/missingSchema.js

@@ -3,7 +3,7 @@
  * Module dependencies.
  */
 
-var MongooseError = require('../error.js');
+var MongooseError = require('./');
 
 /*!
  * MissingSchema Error constructor.

package/lib/error/notFound.js

@@ -4,7 +4,7 @@
  * Module dependencies.
  */
 
-var MongooseError = require('../error.js');
+var MongooseError = require('./');
 var util = require('util');
 
 /*!

package/lib/error/objectExpected.js

@@ -2,7 +2,7 @@
  * Module dependencies.
  */
 
-var MongooseError = require('../error.js');
+var MongooseError = require('./');
 
 /**
  * Strict mode error constructor

package/lib/error/objectParameter.js

@@ -0,0 +1,36 @@
+/*!
+ * Module dependencies.
+ */
+
+var MongooseError = require('./');
+
+/**
+ * Constructor for errors that happen when a parameter that's expected to be
+ * an object isn't an object
+ *
+ * @param {Any} value
+ * @param {String} paramName
+ * @param {String} fnName
+ * @inherits MongooseError
+ * @api private
+ */
+
+function ObjectParameterError(value, paramName, fnName) {
+  MongooseError.call(this, 'Parameter "' + paramName + '" to ' + fnName +
+    '() must be an object, got ' + value.toString());
+  this.name = 'ObjectParameterError';
+  if (Error.captureStackTrace) {
+    Error.captureStackTrace(this);
+  } else {
+    this.stack = new Error().stack;
+  }
+}
+
+/*!
+ * Inherits from MongooseError.
+ */
+
+ObjectParameterError.prototype = Object.create(MongooseError.prototype);
+ObjectParameterError.prototype.constructor = MongooseError;
+
+module.exports = ObjectParameterError;

package/lib/error/overwriteModel.js

@@ -3,7 +3,7 @@
  * Module dependencies.
  */
 
-var MongooseError = require('../error.js');
+var MongooseError = require('./');
 
 /*!
  * OverwriteModel Error constructor.

package/lib/error/strict.js

@@ -2,7 +2,7 @@
  * Module dependencies.
  */
 
-var MongooseError = require('../error.js');
+var MongooseError = require('./');
 
 /**
  * Strict mode error constructor

package/lib/error/validation.js

@@ -2,7 +2,7 @@
  * Module requirements
  */
 
-var MongooseError = require('../error.js');
+var MongooseError = require('./');
 var utils = require('../utils');
 
 /**

package/lib/error/validator.js

@@ -2,7 +2,7 @@
  * Module dependencies.
  */
 
-var MongooseError = require('../error.js');
+var MongooseError = require('./');
 
 /**
  * Schema validator error

package/lib/error/version.js

@@ -4,7 +4,7 @@
  * Module dependencies.
  */
 
-var MongooseError = require('../error.js');
+var MongooseError = require('./');
 
 /**
  * Version Error constructor.