mongoose 5.0.6 → 5.0.10

package/lib/index.js

@@ -79,6 +79,7 @@ Mongoose.prototype.STATES = STATES;
  * Currently supported options are:
  * - '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()`.
  *
  * @param {String} key
  * @param {String|Function|Boolean} value
@@ -476,7 +477,7 @@ Mongoose.prototype.__defineSetter__('connection', function(v) {
 });
 
 /*!
- * Driver depentend APIs
+ * Driver dependent APIs
  */
 
 var driver = global.MONGOOSE_DRIVER_PATH || './drivers/node-mongodb-native';

package/lib/model.js

@@ -22,6 +22,7 @@ var applyStatics = require('./services/model/applyStatics');
 var cast = require('./cast');
 var castUpdate = require('./services/query/castUpdate');
 var discriminator = require('./services/model/discriminator');
+var getDiscriminatorByValue = require('./queryhelpers').getDiscriminatorByValue;
 var internalToObjectOptions = require('./options').internalToObjectOptions;
 var isPathSelectedInclusive = require('./services/projection/isPathSelectedInclusive');
 var get = require('lodash.get');
@@ -829,10 +830,11 @@ Model.prototype.model = function model(name) {
  *
  * @param {String} name   discriminator model name
  * @param {Schema} schema discriminator model schema
+ * @param {String} value  discriminator model typeKey value
  * @api public
  */
 
-Model.discriminator = function(name, schema) {
+Model.discriminator = function(name, schema, value) {
   var model;
   if (typeof name === 'function') {
     model = name;
@@ -842,7 +844,7 @@ Model.discriminator = function(name, schema) {
     }
   }
 
-  schema = discriminator(this, name, schema);
+  schema = discriminator(this, name, schema, value);
   if (this.db.models[name]) {
     throw new OverwriteModelError(name);
   }
@@ -2034,7 +2036,7 @@ Model.create = function create(doc, callback) {
     args.forEach(doc => {
       toExecute.push(callback => {
         var Model = this.discriminators && doc[discriminatorKey] ?
-          this.discriminators[doc[discriminatorKey]] :
+          this.discriminators[doc[discriminatorKey]] || getDiscriminatorByValue(this, doc[discriminatorKey]) :
           this;
         var toSave = doc;
         var callbackWrapper = (error, doc) => {

package/lib/query.js

@@ -1021,6 +1021,15 @@ Query.prototype.setOptions = function(options, overwrite) {
     }
   }
 
+  if ('useFindAndModify' in options) {
+    this._mongooseOptions.useFindAndModify = options.useFindAndModify;
+    delete options.useFindAndModify;
+  }
+  if ('omitUndefined' in options) {
+    this._mongooseOptions.omitUndefined = options.omitUndefined;
+    delete options.omitUndefined;
+  }
+
   return Query.base.setOptions.call(this, options);
 };
 
@@ -1437,14 +1446,14 @@ function completeMany(model, docs, fields, userProvidedFields, pop, callback) {
   var opts = pop ? { populated: pop } : undefined;
   var error = null;
   function init(_error) {
+    if (_error != null) {
+      error = error || _error;
+    }
     if (error != null) {
+      --count || callback(error);
       return;
     }
-    if (_error != null) {
-      error = _error;
-      return callback(error);
-    }
-    --count || callback(null, arr);
+    --count || callback(error, arr);
   }
   for (var i = 0; i < len; ++i) {
     arr[i] = helpers.createModel(model, docs[i], fields, userProvidedFields);
@@ -1590,13 +1599,6 @@ Query.prototype.findOne = function(conditions, projection, options, callback) {
     this.merge(conditions);
 
     prepareDiscriminatorCriteria(this);
-
-    try {
-      this.cast(this.model);
-      this.error(null);
-    } catch (err) {
-      this.error(err);
-    }
   } else if (conditions != null) {
     this.error(new ObjectParameterError(conditions, 'filter', 'findOne'));
   }
@@ -2143,8 +2145,6 @@ Query.prototype.findOneAndUpdate = function(criteria, doc, options, callback) {
  */
 
 Query.prototype._findOneAndUpdate = function(callback) {
-  this._castConditions();
-
   if (this.error() != null) {
     return callback(this.error());
   }
@@ -2238,8 +2238,6 @@ Query.prototype.findOneAndRemove = function(conditions, options, callback) {
  * @api private
  */
 Query.prototype._findOneAndRemove = function(callback) {
-  this._castConditions();
-
   if (this.error() != null) {
     return callback(this.error());
   }
@@ -2377,8 +2375,68 @@ Query.prototype._findAndModify = function(type, callback) {
     });
   };
 
+  var _callback;
+
+  var useFindAndModify = true;
+  var base = _this.model && _this.model.base;
+  if ('useFindAndModify' in base.options) {
+    useFindAndModify = base.get('useFindAndModify');
+  }
+  if ('useFindAndModify' in options) {
+    useFindAndModify = options.useFindAndModify;
+  }
+  if (useFindAndModify === false) {
+    // Bypass mquery
+    var collection = _this._collection.collection;
+    if ('new' in opts) {
+      opts.returnOriginal = !opts['new'];
+      delete opts['new'];
+    }
+    if ('fields' in opts) {
+      opts.projection = opts.fields;
+      delete opts.fields;
+    }
+
+    if (type === 'remove') {
+      collection.findOneAndDelete(castedQuery, opts, utils.tick(function(error, res) {
+        return cb(error, res ? res.value : res, res);
+      }));
+
+      return this;
+    }
+
+    if (opts.runValidators && doValidate) {
+      _callback = function(error) {
+        if (error) {
+          return callback(error);
+        }
+        if (castedDoc && castedDoc.toBSON) {
+          castedDoc = castedDoc.toBSON();
+        }
+        collection.findOneAndUpdate(castedQuery, castedDoc, opts, utils.tick(function(error, res) {
+          return cb(error, res ? res.value : res, res);
+        }));
+      };
+
+      try {
+        doValidate(_callback);
+      } catch (error) {
+        callback(error);
+      }
+    } else {
+      if (castedDoc && castedDoc.toBSON) {
+        castedDoc = castedDoc.toBSON();
+      }
+      collection.findOneAndUpdate(castedQuery, castedDoc, opts, utils.tick(function(error, res) {
+        return cb(error, res ? res.value : res, res);
+      }));
+    }
+
+    return this;
+  }
+
   if (opts.runValidators && doValidate) {
-    var _callback = function(error) {
+    _callback = function(error) {
       if (error) {
         return callback(error);
       }
@@ -3006,9 +3064,16 @@ Query.prototype._castUpdate = function _castUpdate(obj, overwrite) {
   } else {
     strict = true;
   }
+
+  var omitUndefined = false;
+  if ('omitUndefined' in this._mongooseOptions) {
+    omitUndefined = this._mongooseOptions.omitUndefined;
+  }
+
   return castUpdate(this.schema, obj, {
     overwrite: overwrite,
-    strict: strict
+    strict: strict,
+    omitUndefined
   }, this);
 };
 
@@ -3214,8 +3279,7 @@ Query.prototype._applyPaths = function applyPaths() {
 
 /**
  * Returns a wrapper around a [mongodb driver cursor](http://mongodb.github.io/node-mongodb-native/2.1/api/Cursor.html).
- * A QueryCursor exposes a [Streams3](https://strongloop.com/strongblog/whats-new-io-js-beta-streams3/)-compatible
- * interface, as well as a `.next()` function.
+ * A QueryCursor exposes a Streams3 interface, as well as a `.next()` function.
  *
  * The `.cursor()` function triggers pre find hooks, but **not** post find hooks.
  *

package/lib/queryhelpers.js

@@ -46,6 +46,34 @@ exports.preparePopulationOptionsMQ = function preparePopulationOptionsMQ(query,
   return pop;
 };
 
+
+/*!
+ * returns discriminator by discriminatorMapping.value
+ *
+ * @param {Model} model
+ * @param {string} value
+ */
+function getDiscriminatorByValue(model, value) {
+  var discriminator = null;
+  if (!model.discriminators) {
+    return discriminator;
+  }
+  for (var name in model.discriminators) {
+    var it = model.discriminators[name];
+    if (
+      it.schema &&
+      it.schema.discriminatorMapping &&
+      it.schema.discriminatorMapping.value == value
+    ) {
+      discriminator = it;
+      break;
+    }
+  }
+  return discriminator;
+}
+
+exports.getDiscriminatorByValue = getDiscriminatorByValue;
+
 /*!
  * If the document is a mapped discriminator type, it returns a model instance for that type, otherwise,
  * it returns an instance of the given model.
@@ -65,11 +93,14 @@ exports.createModel = function createModel(model, doc, fields, userProvidedField
     ? discriminatorMapping.key
     : null;
 
-  if (key && doc[key] && model.discriminators && model.discriminators[doc[key]]) {
-    var discriminator = model.discriminators[doc[key]];
-    var _fields = utils.clone(userProvidedFields);
-    exports.applyPaths(_fields, discriminator.schema);
-    return new model.discriminators[doc[key]](undefined, _fields, true);
+  var value = doc[key];
+  if (key && value && model.discriminators) {
+    var discriminator = model.discriminators[value] || getDiscriminatorByValue(model, value);
+    if (discriminator) {
+      var _fields = utils.clone(userProvidedFields);
+      exports.applyPaths(_fields, discriminator.schema);
+      return new discriminator(undefined, _fields, true);
+    }
   }
 
   return new model(undefined, fields, true);

package/lib/schema/array.js

@@ -22,6 +22,7 @@ var util = require('util');
 var utils = require('../utils');
 var castToNumber = require('./operators/helpers').castToNumber;
 var geospatial = require('./operators/geospatial');
+var getDiscriminatorByValue = require('../queryhelpers').getDiscriminatorByValue;
 
 var MongooseArray;
 var EmbeddedDoc;
@@ -93,7 +94,7 @@ function SchemaArray(key, cast, options, schemaOptions) {
   }
 
   if (!('defaultValue' in this) || this.defaultValue !== void 0) {
-    this.default(function() {
+    var defaultFn = function() {
       var arr = [];
       if (fn) {
         arr = defaultArr();
@@ -102,7 +103,9 @@ function SchemaArray(key, cast, options, schemaOptions) {
       }
       // Leave it up to `cast()` to convert the array
       return arr;
-    });
+    };
+    defaultFn.$runBeforeSetters = true;
+    this.default(defaultFn);
   }
 }
 
@@ -247,10 +250,18 @@ SchemaArray.prototype.castForQuery = function($conditional, value) {
 
     if (val &&
         Constructor.discriminators &&
-        Constructor.schema.options.discriminatorKey &&
-        typeof val[Constructor.schema.options.discriminatorKey] === 'string' &&
-        Constructor.discriminators[val[Constructor.schema.options.discriminatorKey]]) {
-      Constructor = Constructor.discriminators[val[Constructor.schema.options.discriminatorKey]];
+        Constructor.schema &&
+        Constructor.schema.options &&
+        Constructor.schema.options.discriminatorKey) {
+      if (typeof val[Constructor.schema.options.discriminatorKey] === 'string' &&
+          Constructor.discriminators[val[Constructor.schema.options.discriminatorKey]]) {
+        Constructor = Constructor.discriminators[val[Constructor.schema.options.discriminatorKey]];
+      } else {
+        var constructorByValue = getDiscriminatorByValue(Constructor, val[Constructor.schema.options.discriminatorKey]);
+        if (constructorByValue) {
+          Constructor = constructorByValue;
+        }
+      }
     }
 
     var proto = this.casterConstructor.prototype;

package/lib/schema/documentarray.js

@@ -12,6 +12,7 @@ var SchemaType = require('../schematype');
 var discriminator = require('../services/model/discriminator');
 var util = require('util');
 var utils = require('../utils');
+var getDiscriminatorByValue = require('../queryhelpers').getDiscriminatorByValue;
 
 var MongooseDocumentArray;
 var Subdocument;
@@ -181,13 +182,7 @@ DocumentArray.prototype.doValidate = function(array, fn, scope, options) {
           undefined, i);
       }
 
-      // HACK: use $__original_validate to avoid promises so bluebird doesn't
-      // complain
-      if (doc.$__original_validate) {
-        doc.$__original_validate({__noPromise: true}, callback);
-      } else {
-        doc.validate({__noPromise: true}, callback);
-      }
+      doc.$__validate(callback);
     }
   }, scope);
 };
@@ -297,9 +292,17 @@ DocumentArray.prototype.cast = function(value, doc, init, prev, options) {
 
     var Constructor = this.casterConstructor;
     if (Constructor.discriminators &&
-        typeof value[i][Constructor.schema.options.discriminatorKey] === 'string' &&
-        Constructor.discriminators[value[i][Constructor.schema.options.discriminatorKey]]) {
-      Constructor = Constructor.discriminators[value[i][Constructor.schema.options.discriminatorKey]];
+        Constructor.schema &&
+        Constructor.schema.options &&
+        typeof value[i][Constructor.schema.options.discriminatorKey] === 'string') {
+      if (Constructor.discriminators[value[i][Constructor.schema.options.discriminatorKey]]) {
+        Constructor = Constructor.discriminators[value[i][Constructor.schema.options.discriminatorKey]];
+      } else {
+        var constructorByValue = getDiscriminatorByValue(Constructor, value[i][Constructor.schema.options.discriminatorKey]);
+        if (constructorByValue) {
+          Constructor = constructorByValue;
+        }
+      }
     }
 
     // Check if the document has a different schema (re gh-3701)

package/lib/schema/embedded.js

@@ -11,6 +11,7 @@ const castToNumber = require('./operators/helpers').castToNumber;
 const discriminator = require('../services/model/discriminator');
 const geospatial = require('./operators/geospatial');
 const internalToObjectOptions = require('../options').internalToObjectOptions;
+var getDiscriminatorByValue = require('../queryhelpers').getDiscriminatorByValue;
 
 let Subdocument;
 
@@ -140,9 +141,15 @@ Embedded.prototype.cast = function(val, doc, init, priorVal) {
   var discriminatorKey = Constructor.schema.options.discriminatorKey;
   if (val != null &&
       Constructor.discriminators &&
-      typeof val[discriminatorKey] === 'string' &&
-      Constructor.discriminators[val[discriminatorKey]]) {
-    Constructor = Constructor.discriminators[val[discriminatorKey]];
+      typeof val[discriminatorKey] === 'string') {
+    if (Constructor.discriminators[val[discriminatorKey]]) {
+      Constructor = Constructor.discriminators[val[discriminatorKey]];
+    } else {
+      var constructorByValue = getDiscriminatorByValue(Constructor, val[discriminatorKey]);
+      if (constructorByValue) {
+        Constructor = constructorByValue;
+      }
+    }
   }
 
   var subdoc;
@@ -188,7 +195,22 @@ Embedded.prototype.castForQuery = function($conditional, val) {
     val = this._applySetters(val);
   }
 
-  return new this.caster(val);
+  var Constructor = this.caster;
+  var discriminatorKey = Constructor.schema.options.discriminatorKey;
+  if (val != null &&
+      Constructor.discriminators &&
+      typeof val[discriminatorKey] === 'string') {
+    if (Constructor.discriminators[val[discriminatorKey]]) {
+      Constructor = Constructor.discriminators[val[discriminatorKey]];
+    } else {
+      var constructorByValue = getDiscriminatorByValue(Constructor, val[discriminatorKey]);
+      if (constructorByValue) {
+        Constructor = constructorByValue;
+      }
+    }
+  }
+
+  return new Constructor(val);
 };
 
 /**
@@ -202,11 +224,18 @@ Embedded.prototype.doValidate = function(value, fn, scope) {
   var discriminatorKey = Constructor.schema.options.discriminatorKey;
   if (value != null &&
       Constructor.discriminators &&
-      typeof value[discriminatorKey] === 'string' &&
-      Constructor.discriminators[value[discriminatorKey]]) {
-    Constructor = Constructor.discriminators[value[discriminatorKey]];
+      typeof value[discriminatorKey] === 'string') {
+    if (Constructor.discriminators[value[discriminatorKey]]) {
+      Constructor = Constructor.discriminators[value[discriminatorKey]];
+    } else {
+      var constructorByValue = getDiscriminatorByValue(Constructor, value[discriminatorKey]);
+      if (constructorByValue) {
+        Constructor = constructorByValue;
+      }
+    }
   }
 
+
   SchemaType.prototype.doValidate.call(this, value, function(error) {
     if (error) {
       return fn(error);

package/lib/schema/objectid.js

@@ -206,6 +206,8 @@ function defaultId() {
   return new oid();
 }
 
+defaultId.$runBeforeSetters = true;
+
 function resetId(v) {
   Document || (Document = require('./../document'));
 

package/lib/schema.js

@@ -29,7 +29,6 @@ var mpath = require('mpath');
  * - [bufferCommands](/docs/guide.html#bufferCommands): bool - defaults to true
  * - [capped](/docs/guide.html#capped): bool - defaults to false
  * - [collection](/docs/guide.html#collection): string - no default
- * - [emitIndexErrors](/docs/guide.html#emitIndexErrors): bool - defaults to false.
  * - [id](/docs/guide.html#id): bool - defaults to true
  * - [_id](/docs/guide.html#_id): bool - defaults to true
  * - `minimize`: bool - controls [document#toObject](#document_Document-toObject) behavior when called manually - defaults to true
@@ -1333,33 +1332,39 @@ Schema.prototype.indexes = function() {
         if (path.options.excludeIndexes !== true) {
           collectIndexes(path.schema, prefix + key + '.');
         }
-      } else {
-        index = path._index || (path.caster && path.caster._index);
-
-        if (index !== false && index !== null && index !== undefined) {
-          field = {};
-          isObject = utils.isObject(index);
-          options = isObject ? index : {};
-          type = typeof index === 'string' ? index :
-            isObject ? index.type :
-              false;
-
-          if (type && ~Schema.indexTypes.indexOf(type)) {
-            field[prefix + key] = type;
-          } else if (options.text) {
-            field[prefix + key] = 'text';
-            delete options.text;
-          } else {
-            field[prefix + key] = 1;
-          }
 
-          delete options.type;
-          if (!('background' in options)) {
-            options.background = true;
-          }
+        // Retained to minimize risk of backwards breaking changes due to
+        // gh-6113
+        if ((path instanceof MongooseTypes.DocumentArray)) {
+          continue;
+        }
+      }
 
-          indexes.push([field, options]);
+      index = path._index || (path.caster && path.caster._index);
+
+      if (index !== false && index !== null && index !== undefined) {
+        field = {};
+        isObject = utils.isObject(index);
+        options = isObject ? index : {};
+        type = typeof index === 'string' ? index :
+          isObject ? index.type :
+            false;
+
+        if (type && ~Schema.indexTypes.indexOf(type)) {
+          field[prefix + key] = type;
+        } else if (options.text) {
+          field[prefix + key] = 'text';
+          delete options.text;
+        } else {
+          field[prefix + key] = 1;
         }
+
+        delete options.type;
+        if (!('background' in options)) {
+          options.background = true;
+        }
+
+        indexes.push([field, options]);
       }
     }
 

package/lib/schematype.js

@@ -245,15 +245,19 @@ SchemaType.prototype.sparse = function(bool) {
  *     }
  *
  *     // defining within the schema
- *     var s = new Schema({ name: { type: String, set: capitalize }})
+ *     var s = new Schema({ name: { type: String, set: capitalize }});
  *
- *     // or by retreiving its SchemaType
+ *     // or with the SchemaType
  *     var s = new Schema({ name: String })
- *     s.path('name').set(capitalize)
+ *     s.path('name').set(capitalize);
  *
- * Setters allow you to transform the data before it gets to the raw mongodb document and is set as a value on an actual key.
+ * Setters allow you to transform the data before it gets to the raw mongodb
+ * document or query.
  *
- * Suppose you are implementing user registration for a website. Users provide an email and password, which gets saved to mongodb. The email is a string that you will want to normalize to lower case, in order to avoid one email having more than one account -- e.g., otherwise, avenue@q.com can be registered for 2 accounts via avenue@q.com and AvEnUe@Q.CoM.
+ * Suppose you are implementing user registration for a website. Users provide
+ * an email and password, which gets saved to mongodb. The email is a string
+ * that you will want to normalize to lower case, in order to avoid one email
+ * having more than one account -- e.g., otherwise, avenue@q.com can be registered for 2 accounts via avenue@q.com and AvEnUe@Q.CoM.
  *
  * You can set up email lower case normalization easily via a Mongoose setter.
  *
@@ -276,7 +280,8 @@ SchemaType.prototype.sparse = function(bool) {
  *     console.log(user.email); // 'avenue@q.com'
  *     User.updateOne({ _id: _id }, { $set: { email: 'AVENUE@Q.COM' } }); // update to 'avenue@q.com'
  *
- * As you can see above, setters allow you to transform the data before it stored in MongoDB.
+ * As you can see above, setters allow you to transform the data before it
+ * stored in MongoDB, or before executing a query.
  *
  * _NOTE: we could have also just used the built-in `lowercase: true` SchemaType option instead of defining our own function._
  *
@@ -303,6 +308,24 @@ SchemaType.prototype.sparse = function(bool) {
  *     console.log(v.name);     // name is required
  *     console.log(v.taxonomy); // Parvovirinae
  *
+ * You can also use setters to modify other properties on the document. If
+ * you're setting a property `name` on a document, the setter will run with
+ * `this` as the document. Be careful, in mongoose 5 setters will also run
+ * when querying by `name` with `this` as the query.
+ *
+ * ```javascript
+ * const nameSchema = new Schema({ name: String, keywords: [String] });
+ * nameSchema.path('name').set(function(v) {
+ *   // Need to check if `this` is a document, because in mongoose 5
+ *   // setters will also run on queries, in which case `this` will be a
+ *   // mongoose query object.
+ *   if (this instanceof Document && v != null) {
+ *     this.keywords = v.split(' ');
+ *   }
+ *   return v;
+ * });
+ * ```
+ *
  * @param {Function} fn
  * @return {SchemaType} this
  * @api public

package/lib/services/model/discriminator.js

@@ -14,7 +14,7 @@ var CUSTOMIZABLE_DISCRIMINATOR_OPTIONS = {
  * ignore
  */
 
-module.exports = function discriminator(model, name, schema) {
+module.exports = function discriminator(model, name, schema, tiedValue) {
   if (!(schema && schema.instanceOfSchema)) {
     throw new Error('You must pass a valid discriminator Schema');
   }
@@ -46,6 +46,11 @@ module.exports = function discriminator(model, name, schema) {
         '" cannot have field with name "' + key + '"');
   }
 
+  var value = name;
+  if (typeof tiedValue == 'string' && tiedValue.length) {
+    value = tiedValue;
+  }
+
   function merge(schema, baseSchema) {
     if (baseSchema.paths._id &&
         baseSchema.paths._id.options &&
@@ -59,11 +64,11 @@ module.exports = function discriminator(model, name, schema) {
 
     var obj = {};
     obj[key] = {
-      default: name,
+      default: value,
       select: true,
       set: function(newName) {
-        if (newName === name) {
-          return name;
+        if (newName === value) {
+          return value;
         }
         throw new Error('Can\'t set discriminator key "' + key + '"');
       },
@@ -71,7 +76,7 @@ module.exports = function discriminator(model, name, schema) {
     };
     obj[key][schema.options.typeKey] = String;
     schema.add(obj);
-    schema.discriminatorMapping = {key: key, value: name, isRoot: false};
+    schema.discriminatorMapping = {key: key, value: value, isRoot: false};
 
     if (baseSchema.options.collection) {
       schema.options.collection = baseSchema.options.collection;