mongoose 5.1.1 → 5.1.2

package/History.md

@@ -1,3 +1,24 @@
+5.1.2 / 2018-05-21
+==================
+ * docs(guide): add missing SchemaTypes #6490 [distancesprinter](https://github.com/distancesprinter)
+ * fix(map): make MongooseMap.toJSON return a serialized object #6486 #6478 [lineus](https://github.com/lineus)
+ * fix(query): make CustomQuery inherit from model.Query for hooks #6483 #6455 [lineus](https://github.com/lineus)
+ * fix(document): prevent default falses from being skipped by $__dirty #6481 #6477 [lineus](https://github.com/lineus)
+ * docs(connection): document `useDb()` #6480
+ * fix(model): skip redundant clone in insertMany #6479 [d1manson](https://github.com/d1manson)
+ * fix(aggregate): let replaceRoot accept objects as well as strings #6475 #6474 [lineus](https://github.com/lineus)
+ * docs(model): clarify `emit()` in mapReduce and how map/reduce are run #6465
+ * fix(populate): flatten array to handle multi-level nested `refPath` #6457
+ * fix(date): cast small numeric strings as years #6444 [AbdelrahmanHafez](https://github.com/AbdelrahmanHafez)
+ * fix(populate): remove unmatched ids when using virtual populate on already hydrated document #6435
+ * fix(array): use custom array class to avoid clobbered property names #6431
+ * fix(model): handle hooks for custom methods that return promises #6385
+
+4.13.13 / 2018-05-17
+====================
+ * fix(update): stop clobbering $in when casting update #6441 #6339
+ * fix: upgrade async -> 2.6.0 re: security warning
+
 5.1.1 / 2018-05-14
 ==================
  * docs(schema): add notes in api and guide about schema.methods object #6470 #6440 [lineus](https://github.com/lineus)

package/lib/aggregate.js

@@ -342,23 +342,34 @@ Aggregate.prototype.unwind = function() {
 /**
  * Appends a new $replaceRoot operator to this aggregate pipeline.
  *
- * Note that the `$replaceRoot` operator requires the new root to start with '$'.
- * Mongoose will prepend '$' if the specified field doesn't start '$'.
+ * Note that the `$replaceRoot` operator requires field strings to start with '$'.
+ * If you are passing in a string Mongoose will prepend '$' if the specified field doesn't start '$'.
+ * If you are passing in an object the strings in your expression will not be altered.
  *
  * ####Examples:
  *
  *     aggregate.replaceRoot("user");
  *
+ *     aggregate.replaceRoot({ x: { $concat: ['$this', '$that'] } });
+ *
  * @see $replaceRoot https://docs.mongodb.org/manual/reference/operator/aggregation/replaceRoot
- * @param {String} the field which will become the new root document
+ * @param {String|Object} the field or document which will become the new root document
  * @return {Aggregate}
  * @api public
  */
 
 Aggregate.prototype.replaceRoot = function(newRoot) {
+  var ret;
+
+  if (typeof newRoot === 'string') {
+    ret = newRoot.startsWith('$') ? newRoot : '$' + newRoot;
+  } else {
+    ret = newRoot;
+  }
+
   return this.append({
     $replaceRoot: {
-      newRoot: (newRoot && newRoot.charAt(0) === '$') ? newRoot : '$' + newRoot
+      newRoot: ret
     }
   });
 };

package/lib/connection.js

@@ -770,6 +770,18 @@ Connection.prototype.optionsProvideAuthenticationData = function(options) {
       ((options.pass) || this.authMechanismDoesNotRequirePassword());
 };
 
+/**
+ * Switches to a different database using the same connection pool.
+ *
+ * Returns a new connection object, with the new db.
+ *
+ * @method useDb
+ * @memberOf Connection
+ * @param {String} name The database name
+ * @return {Connection} New Connection Object
+ * @api public
+ */
+
 /*!
  * Module exports.
  */

package/lib/document.js

@@ -2003,7 +2003,7 @@ Document.prototype.$__dirty = function() {
   // gh-2558: if we had to set a default and the value is not undefined,
   // we have to save as well
   all = all.concat(this.$__.activePaths.map('default', function(path) {
-    if (path === '_id' || !_this.getValue(path)) {
+    if (path === '_id' || _this.getValue(path) == null) {
       return;
     }
     return {
@@ -2680,7 +2680,6 @@ Document.prototype.populate = function populate() {
   if (fn) {
     var paths = utils.object.vals(pop);
     this.$__.populate = undefined;
-    paths.__noPromise = true;
     var topLevelModel = this.constructor;
     if (this.$__isNested) {
       topLevelModel = this.$__.scope.constructor;

package/lib/model.js

@@ -2365,7 +2365,9 @@ Model.$__insertMany = function(arr, options, callback) {
   var validationErrors = [];
   arr.forEach(function(doc) {
     toExecute.push(function(callback) {
-      doc = new _this(doc);
+      if (!(doc instanceof _this)) {
+        doc = new _this(doc);
+      }
       doc.validate({ __noPromise: true }, function(error) {
         if (error) {
           // Option `ordered` signals that insert should be continued after reaching
@@ -2822,8 +2824,10 @@ function _update(model, op, conditions, doc, options, callback) {
  * ####Example:
  *
  *     var o = {};
- *     o.map = function () { emit(this.name, 1) }
- *     o.reduce = function (k, vals) { return vals.length }
+ *     // `map()` and `reduce()` are run on the MongoDB server, not Node.js,
+ *     // these functions are converted to strings
+ *     o.map = function () { emit(this.name, 1) };
+ *     o.reduce = function (k, vals) { return vals.length };
  *     User.mapReduce(o, function (err, results) {
  *       console.log(results)
  *     })
@@ -2853,8 +2857,10 @@ function _update(model, op, conditions, doc, options, callback) {
  * ####Example:
  *
  *     var o = {};
- *     o.map = function () { emit(this.name, 1) }
- *     o.reduce = function (k, vals) { return vals.length }
+ *     // You can also define `map()` and `reduce()` as strings if your
+ *     // linter complains about `emit()` not being defined
+ *     o.map = 'function () { emit(this.name, 1) }';
+ *     o.reduce = 'function (k, vals) { return vals.length }';
  *     o.out = { replace: 'createdCollectionNameForResults' }
  *     o.verbose = true;
  *
@@ -3485,7 +3491,7 @@ function assignVals(o) {
     if (o.isVirtual && docs[i].constructor.name === 'model') {
       // If virtual populate and doc is already init-ed, need to walk through
       // the actual doc to set rather than setting `_doc` directly
-      mpath.set(o.path, rawIds[i], docs[i]);
+      mpath.set(o.path, rawIds[i], docs[i], setValue);
     } else {
       var parts = o.path.split('.');
       var cur = docs[i];
@@ -3754,7 +3760,11 @@ function getModelsMapForPopulate(model, docs, options) {
 
     if (refPath) {
       modelNames = utils.getValue(refPath, doc);
-      isRefPathArray = Array.isArray(modelNames);
+      isRefPathArray = false;
+      if (Array.isArray(modelNames)) {
+        isRefPathArray = true;
+        modelNames = utils.array.flatten(modelNames);
+      }
     } else {
       if (!modelNameFromQuery) {
         var modelForCurrentDoc = model;
@@ -3838,7 +3848,7 @@ function convertTo_id(val) {
         val[i] = val[i]._id;
       }
     }
-    if (val.isMongooseArray) {
+    if (val.isMongooseArray && val._schema) {
       return val._schema.cast(val, val._parent);
     }
 

package/lib/query.js

@@ -167,7 +167,7 @@ Query.prototype.toConstructor = function toConstructor() {
     Query.call(this, criteria, options || null, model, coll);
   };
 
-  util.inherits(CustomQuery, Query);
+  util.inherits(CustomQuery, model.Query);
 
   // set inherited defaults
   var p = CustomQuery.prototype;
@@ -1309,7 +1309,7 @@ Query.prototype._find = function(callback) {
 
   if (this.error() != null) {
     callback(this.error());
-    return this;
+    return null;
   }
 
   this._applyPaths();
@@ -1355,7 +1355,8 @@ Query.prototype._find = function(callback) {
   var options = this._optionsForExec();
   options.fields = this._fieldsForExec();
   var filter = this._conditions;
-  return this._collection.find(filter, options, cb);
+  this._collection.find(filter, options, cb);
+  return null;
 };
 
 /**
@@ -1517,7 +1518,8 @@ Query.prototype._findOne = function(callback) {
   this._castConditions();
 
   if (this.error()) {
-    return callback(this.error());
+    callback(this.error());
+    return null;
   }
 
   this._applyPaths();
@@ -1526,7 +1528,8 @@ Query.prototype._findOne = function(callback) {
   // don't pass in the conditions because we already merged them in
   Query.base.findOne.call(this, {}, (err, doc) => {
     if (err) {
-      return callback(err);
+      callback(err);
+      return null;
     }
 
     this._completeOne(doc, null, callback);
@@ -2161,7 +2164,6 @@ Query.prototype._findOneAndUpdate = function(callback) {
   }
 
   this._findAndModify('update', callback);
-  return this;
 };
 
 /**
@@ -2336,7 +2338,7 @@ Query.prototype._findOneAndDelete = function(callback) {
 
   if (this.error() != null) {
     callback(this.error());
-    return this;
+    return null;
   }
 
   const filter = this._conditions;
@@ -2348,7 +2350,7 @@ Query.prototype._findOneAndDelete = function(callback) {
     fields = options.projection;
     if (fields instanceof Error) {
       callback(fields);
-      return this;
+      return null;
     }
   }
 
@@ -2361,8 +2363,6 @@ Query.prototype._findOneAndDelete = function(callback) {
 
     return this._completeOne(doc, res, callback);
   });
-
-  return this;
 };
 
 /*!
@@ -2374,12 +2374,11 @@ Query.prototype._findOneAndDelete = function(callback) {
  */
 Query.prototype._findOneAndRemove = function(callback) {
   if (this.error() != null) {
-    return callback(this.error());
+    callback(this.error());
+    return;
   }
 
   this._findAndModify('remove', callback);
-
-  return this;
 };
 
 /*!
@@ -2644,7 +2643,7 @@ function _updateThunk(op, callback) {
 
   if (this.error() != null) {
     callback(this.error());
-    return this;
+    return null;
   }
 
   var castedQuery = this._conditions;
@@ -2660,12 +2659,12 @@ function _updateThunk(op, callback) {
 
     if (castedDoc instanceof Error) {
       callback(castedDoc);
-      return this;
+      return null;
     }
 
     if (castedDoc == null || Object.keys(castedDoc).length === 0) {
       callback(null, 0);
-      return this;
+      return null;
     }
 
     castedDoc = setDefaultsOnInsert(this._conditions, this.model.schema,
@@ -2697,7 +2696,7 @@ function _updateThunk(op, callback) {
         callback(err);
       });
     }
-    return this;
+    return null;
   }
 
   if (castedDoc.toBSON) {
@@ -2705,7 +2704,7 @@ function _updateThunk(op, callback) {
   }
 
   this._collection[op](castedQuery, castedDoc, options, callback);
-  return this;
+  return null;
 }
 
 /*!

package/lib/schema/date.js

@@ -232,9 +232,12 @@ SchemaDate.prototype.cast = function(value) {
 
   if (value instanceof Number || typeof value === 'number') {
     date = new Date(value);
+  } else if (typeof value === 'string' && !isNaN(Number(value)) && (Number(value) >= 275761 || Number(value) < -271820)) {
+    // string representation of milliseconds take this path
+    date = new Date(Number(value));
   } else if (typeof value.valueOf === 'function') {
-    // support for moment.js. This is also the path strings will take because strings
-    // have a `valueOf()`
+    // support for moment.js. This is also the path strings will take because
+    // strings have a `valueOf()`
     date = new Date(value.valueOf());
   } else {
     // fallback

package/lib/services/model/applyHooks.js

@@ -1,5 +1,7 @@
 'use strict';
 
+const utils = require('../../utils');
+
 /*!
  * ignore
  */
@@ -54,6 +56,13 @@ function applyHooks(model, schema, options) {
 
   // Support hooks for custom methods
   const customMethods = Object.keys(schema.methods);
+  const customMethodOptions = Object.assign({}, kareemOptions, {
+    // Only use `checkForPromise` for custom methods, because mongoose
+    // query thunks are not as consistent as I would like about returning
+    // a nullish value rather than the query. If a query thunk returns
+    // a query, `checkForPromise` causes infinite recursion
+    checkForPromise: true
+  });
   for (const method of customMethods) {
     if (!schema.s.hooks.hasHooks(method)) {
       // Don't wrap if there are no hooks for the custom method to avoid
@@ -61,7 +70,18 @@ function applyHooks(model, schema, options) {
       // so wrapping a sync method would break it.
       continue;
     }
-    objToDecorate[method] = schema.s.hooks.
-      createWrapper(method, objToDecorate[method], null, kareemOptions);
+    const originalMethod = objToDecorate[method];
+    objToDecorate[method] = function() {
+      const args = Array.prototype.slice.call(arguments);
+      const cb = utils.last(args);
+      const argsWithoutCallback = cb == null ? args :
+        args.slice(0, args.length - 1);
+      return utils.promiseOrCallback(cb, callback => {
+        this[`$__${method}`].apply(this,
+          argsWithoutCallback.concat([callback]));
+      });
+    };
+    objToDecorate[`$__${method}`] = schema.s.hooks.
+      createWrapper(method, originalMethod, null, customMethodOptions);
   }
 }

package/lib/types/documentarray.js

@@ -12,6 +12,18 @@ const utils = require('../utils');
 const Document = require('../document');
 const getDiscriminatorByValue = require('../queryhelpers').getDiscriminatorByValue;
 
+/*!
+ * ignore
+ */
+
+class CoreMongooseArray extends Array {
+  get isMongooseArray() {
+    return true;
+  }
+
+  remove() {}
+}
+
 /**
  * DocumentArray constructor
  *
@@ -25,11 +37,13 @@ const getDiscriminatorByValue = require('../queryhelpers').getDiscriminatorByVal
  */
 
 function MongooseDocumentArray(values, path, doc) {
-  var arr = [].concat(values);
+  // TODO: replace this with `new CoreMongooseArray().concat()` when we remove
+  // support for node 4.x and 5.x, see https://i.imgur.com/UAAHk4S.png
+  var arr = new CoreMongooseArray();
+  if (Array.isArray(values)) values.forEach(v => arr.push(v));
   arr._path = path;
 
   var props = {
-    isMongooseArray: true,
     isMongooseDocumentArray: true,
     validators: [],
     _atomics: {},

package/lib/types/map.js

@@ -91,7 +91,12 @@ class MongooseMap extends Map {
   }
 
   toJSON() {
-    return new Map(this);
+    let ret = {};
+    const keys = this.keys();
+    for (let key of keys) {
+      ret[key] = this.get(key);
+    }
+    return ret;
   }
 
   inspect() {

package/lib/utils.js

@@ -137,6 +137,17 @@ exports.deepEqual = function deepEqual(a, b) {
   return true;
 };
 
+/*!
+ * Get the last element of an array
+ */
+
+exports.last = function(arr) {
+  if (arr.length > 0) {
+    return arr[arr.length - 1];
+  }
+  return void 0;
+};
+
 /*!
  * Object clone with Mongoose natives support.
  *

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mongoose",
   "description": "Mongoose MongoDB ODM",
-  "version": "5.1.1",
+  "version": "5.1.2",
   "author": "Guillermo Rauch <guillermo@learnboost.com>",
   "keywords": [
     "mongodb",
@@ -21,7 +21,7 @@
   "dependencies": {
     "async": "2.1.4",
     "bson": "~1.0.5",
-    "kareem": "2.0.7",
+    "kareem": "2.1.0",
     "lodash.get": "4.4.2",
     "mongodb": "3.0.8",
     "mongoose-legacy-pluralize": "1.0.2",
@@ -32,7 +32,7 @@
     "sliced": "1.0.1"
   },
   "devDependencies": {
-    "acquit": "0.5.1",
+    "acquit": "0.6.3",
     "acquit-ignore": "0.0.3",
     "benchmark": "2.1.2",
     "bluebird": "3.5.0",