mongoose 5.0.9 → 5.0.10

package/History.md

@@ -1,3 +1,15 @@
+5.0.10 / 2018-03-12
+===================
+ * docs(schematype): add notes re: running setters on queries #6209
+ * docs: fix typo #6208 [kamagatos](https://github.com/kamagatos)
+ * fix(query): only call setters once on query filter props for findOneAndUpdate and findOneAndRemove #6203
+ * docs: elaborate on connection string changes in migration guide #6193
+ * fix(document): skip applyDefaults if subdoc is null #6187
+ * docs: fix schematypes docs and link to them #6176
+ * docs(faq): add FAQs re: array defaults and casting aggregation pipelines #6184 #6176 #6170 [lineus](https://github.com/lineus)
+ * fix(document): ensure primitive defaults are set and built-in default functions run before setters #6155
+ * fix(query): handle single embedded embedded discriminators in castForQuery #6027
+
 5.0.9 / 2018-03-05
 ==================
  * perf: bump mongodb -> 3.0.4 to fix SSL perf issue #6065

package/lib/cast.js

@@ -1,13 +1,16 @@
+'use strict';
+
 /*!
  * Module dependencies.
  */
 
-var StrictModeError = require('./error/strict');
-var Types = require('./schema/index');
-var util = require('util');
-var utils = require('./utils');
+const StrictModeError = require('./error/strict');
+const Types = require('./schema/index');
+const get = require('lodash.get');
+const util = require('util');
+const utils = require('./utils');
 
-var ALLOWED_GEOWITHIN_GEOJSON_TYPES = ['Polygon', 'MultiPolygon'];
+const ALLOWED_GEOWITHIN_GEOJSON_TYPES = ['Polygon', 'MultiPolygon'];
 
 /**
  * Handles internal casting for query filters.
@@ -67,6 +70,31 @@ module.exports = function cast(schema, obj, options, context) {
 
       schematype = schema.path(path);
 
+      // Check for embedded discriminator paths
+      if (!schematype) {
+        let split = path.split('.');
+        let j = split.length;
+        while (j--) {
+          let pathFirstHalf = split.slice(0, j).join('.');
+          let pathLastHalf = split.slice(j).join('.');
+          let _schematype = schema.path(pathFirstHalf);
+          let discriminatorKey = get(_schematype, 'schema.options.discriminatorKey');
+          // gh-6027: if we haven't found the schematype but this path is
+          // underneath an embedded discriminator and the embedded discriminator
+          // key is in the query, use the embedded discriminator schema
+          if (_schematype != null &&
+              get(_schematype, 'schema.discriminators') != null &&
+              discriminatorKey != null &&
+              pathLastHalf !== discriminatorKey) {
+            const discriminatorVal = get(obj, pathFirstHalf + '.' + discriminatorKey);
+            if (discriminatorVal) {
+              schematype = _schematype.schema.discriminators[discriminatorVal].
+                path(pathLastHalf);
+            }
+          }
+        }
+      }
+
       if (!schematype) {
         // Handle potential embedded array queries
         var split = path.split('.'),
@@ -206,7 +234,7 @@ module.exports = function cast(schema, obj, options, context) {
         } else if (options.strictQuery) {
           delete obj[path];
         }
-      } else if (val === null || val === undefined) {
+      } else if (val == null) {
         obj[path] = null;
         continue;
       } else if (val.constructor.name === 'Object') {

package/lib/document.js

@@ -87,6 +87,10 @@ function Document(obj, fields, skipId, options) {
 
   this.$__buildDoc(obj, fields, skipId, exclude, hasIncludedChildren);
 
+  // By default, defaults get applied **before** setting initial values
+  // Re: gh-6155
+  $__applyDefaults(this, fields, skipId, exclude, hasIncludedChildren, true);
+
   if (obj) {
     if (obj instanceof Document) {
       this.isNew = obj.isNew;
@@ -99,7 +103,10 @@ function Document(obj, fields, skipId, options) {
     }
   }
 
-  $__applyDefaults(this, fields, skipId, exclude, hasIncludedChildren);
+  // Function defaults get applied **after** setting initial values so they
+  // see the full doc rather than an empty one, unless they opt out.
+  // Re: gh-3781, gh-6155
+  $__applyDefaults(this, fields, skipId, exclude, hasIncludedChildren, false);
 
   this.$__._id = this._id;
 
@@ -202,7 +209,7 @@ function $__hasIncludedChildren(fields) {
  * ignore
  */
 
-function $__applyDefaults(doc, fields, skipId, exclude, hasIncludedChildren) {
+function $__applyDefaults(doc, fields, skipId, exclude, hasIncludedChildren, isBeforeSetters) {
   const paths = Object.keys(doc.schema.paths);
   const plen = paths.length;
 
@@ -222,6 +229,10 @@ function $__applyDefaults(doc, fields, skipId, exclude, hasIncludedChildren) {
     let doc_ = doc._doc;
 
     for (let j = 0; j < len; ++j) {
+      if (doc_ == null) {
+        break;
+      }
+
       let piece = path[j];
       curPath += (!curPath.length ? '' : '.') + piece;
 
@@ -242,6 +253,18 @@ function $__applyDefaults(doc, fields, skipId, exclude, hasIncludedChildren) {
           break;
         }
 
+        if (typeof type.defaultValue === 'function') {
+          if (!type.defaultValue.$runBeforeSetters && isBeforeSetters) {
+            break;
+          }
+          if (type.defaultValue.$runBeforeSetters && !isBeforeSetters) {
+            break;
+          }
+        } else if (!isBeforeSetters) {
+          // Non-function defaults should always run **before** setters
+          continue;
+        }
+
         if (fields && exclude !== null) {
           if (exclude === true) {
             // apply defaults to all non-excluded fields

package/lib/index.js

@@ -477,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/query.js

@@ -2145,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());
   }
@@ -2240,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());
   }

package/lib/schema/array.js

@@ -94,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();
@@ -103,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);
   }
 }
 

package/lib/schema/embedded.js

@@ -152,7 +152,6 @@ Embedded.prototype.cast = function(val, doc, init, priorVal) {
     }
   }
 
-
   var subdoc;
   if (init) {
     subdoc = new Constructor(void 0, doc ? doc.$__.selected : void 0, doc);
@@ -196,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);
 };
 
 /**

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/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/migrating_to_5.md

@@ -33,6 +33,21 @@ mongoose.connect('mongodb://localhost:27017/test');
 mongoose.model('Test', new Schema({}));
 ```
 
+### Connection Logic and `useMongoClient`
+
+The [`useMongoClient` option](http://mongoosejs.com/docs/4.x/docs/connections.html#use-mongo-client) was
+removed in Mongoose 5, it is now always `true`. As a consequence, Mongoose 5
+no longer supports several function signatures for `mongoose.connect()` that
+worked in Mongoose 4.x if the `useMongoClient` option was off. Below are some
+examples of `mongoose.connect()` calls that do **not** work in Mongoose 5.x.
+
+* `mongoose.connect('localhost', 27017);`
+* `mongoose.connect('localhost', 'mydb', 27017);`
+* `mongoose.connect('mongodb://host1:27017,mongodb://host2:27017');`
+
+In Mongoose 5.x, the first parameter to `mongoose.connect()` and `mongoose.createConnection()`, if specified, **must** be a [MongoDB connection string](https://docs.mongodb.com/manual/reference/connection-string/). The
+connection string and options are then passed down to [the MongoDB Node.js driver's `MongoClient.connect()` function](http://mongodb.github.io/node-mongodb-native/3.0/api/MongoClient.html#.connect). Mongoose does not modify the connection string, although `mongoose.connect()` and `mongoose.createConnection()` support a [few additional options in addition to the ones the MongoDB driver supports](http://mongoosejs.com/docs/connections.html#options).
+
 ### Setter Order
 
 Setters run in reverse order in 4.x:

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mongoose",
   "description": "Mongoose MongoDB ODM",
-  "version": "5.0.9",
+  "version": "5.0.10",
   "author": "Guillermo Rauch <guillermo@learnboost.com>",
   "keywords": [
     "mongodb",