mongoose 6.1.10 → 6.2.3

package/lib/document.js

@@ -16,6 +16,7 @@ const StrictModeError = require('./error/strict');
 const ValidationError = require('./error/validation');
 const ValidatorError = require('./error/validator');
 const VirtualType = require('./virtualtype');
+const $__hasIncludedChildren = require('./helpers/projection/hasIncludedChildren');
 const promiseOrCallback = require('./helpers/promiseOrCallback');
 const cleanModifiedSubpaths = require('./helpers/document/cleanModifiedSubpaths');
 const compile = require('./helpers/document/compile').compile;
@@ -66,7 +67,7 @@ const specialProperties = utils.specialProperties;
  * @param {Object} [fields] optional object containing the fields which were selected in the query returning this document and any populated paths data
  * @param {Object} [options] various configuration options for the document
  * @param {Boolean} [options.defaults=true] if `false`, skip applying default values to this document.
- * @inherits NodeJS EventEmitter http://nodejs.org/api/events.html#events_class_events_eventemitter
+ * @inherits NodeJS EventEmitter https://nodejs.org/api/events.html#events_class_events_eventemitter
  * @event `init`: Emitted on a document after it has been retrieved from the db and fully hydrated by Mongoose.
  * @event `save`: Emitted when the document is successfully saved
  * @api private
@@ -90,7 +91,7 @@ function Document(obj, fields, skipId, options) {
     options = arguments[4] || {};
   }
 
-  this.$__ = new InternalCache;
+  this.$__ = new InternalCache();
   this.$isNew = 'isNew' in options ? options.isNew : true;
 
   if ('priorDoc' in options) {
@@ -417,33 +418,6 @@ Object.defineProperty(Document.prototype, '$op', {
   }
 });
 
-/*!
- * ignore
- */
-
-function $__hasIncludedChildren(fields) {
-  const hasIncludedChildren = {};
-  const keys = Object.keys(fields);
-
-  for (const key of keys) {
-    if (key.indexOf('.') === -1) {
-      hasIncludedChildren[key] = 1;
-      continue;
-    }
-    const parts = key.split('.');
-    let c = parts[0];
-
-    for (let i = 0; i < parts.length; ++i) {
-      hasIncludedChildren[c] = 1;
-      if (i + 1 < parts.length) {
-        c = c + '.' + parts[i + 1];
-      }
-    }
-  }
-
-  return hasIncludedChildren;
-}
-
 /*!
  * ignore
  */
@@ -479,7 +453,8 @@ function $__applyDefaults(doc, fields, exclude, hasIncludedChildren, isBeforeSet
           break;
         }
       } else if (exclude === false && fields && !included) {
-        if (curPath in fields) {
+        const hasSubpaths = type.$isSingleNested || type.$isMongooseDocumentArray;
+        if (curPath in fields || (hasSubpaths && hasIncludedChildren[curPath])) {
           included = true;
         } else if (!hasIncludedChildren[curPath]) {
           break;
@@ -795,11 +770,12 @@ function init(self, obj, doc, opts, prefix) {
 
   const keys = Object.keys(obj);
   const len = keys.length;
-  let schema;
+  let schemaType;
   let path;
   let i;
   let index = 0;
   const strict = self.$__.strictMode;
+  const docSchema = self.$__schema;
 
   while (index < len) {
     _init(index++);
@@ -808,25 +784,27 @@ function init(self, obj, doc, opts, prefix) {
   function _init(index) {
     i = keys[index];
     path = prefix + i;
-    schema = self.$__schema.path(path);
+    schemaType = docSchema.path(path);
 
     // Should still work if not a model-level discriminator, but should not be
     // necessary. This is *only* to catch the case where we queried using the
     // base model and the discriminated model has a projection
-    if (self.$__schema.$isRootDiscriminator && !self.$__isSelected(path)) {
+    if (docSchema.$isRootDiscriminator && !self.$__isSelected(path)) {
       return;
     }
 
-    if (!schema && utils.isPOJO(obj[i])) {
+    if (!schemaType && utils.isPOJO(obj[i])) {
       // assume nested object
       if (!doc[i]) {
         doc[i] = {};
+        if (!strict && !(i in docSchema.tree) && !(i in docSchema.methods) && !(i in docSchema.virtuals)) {
+          self[i] = doc[i];
+        }
       }
       init(self, obj[i], doc[i], opts, path + '.');
-    } else if (!schema) {
+    } else if (!schemaType) {
       doc[i] = obj[i];
-      if (!strict && !prefix) {
-        // Set top-level properties that aren't in the schema if strict is false
+      if (!strict) {
         self[i] = obj[i];
       }
     } else {
@@ -835,13 +813,13 @@ function init(self, obj, doc, opts, prefix) {
         delete doc[i];
       }
       if (obj[i] === null) {
-        doc[i] = schema._castNullish(null);
+        doc[i] = schemaType._castNullish(null);
       } else if (obj[i] !== undefined) {
         const wasPopulated = obj[i].$__ == null ? null : obj[i].$__.wasPopulated;
 
-        if (schema && !wasPopulated) {
+        if (schemaType && !wasPopulated) {
           try {
-            doc[i] = schema.cast(obj[i], self, true);
+            doc[i] = schemaType.cast(obj[i], self, true);
           } catch (e) {
             self.invalidate(e.path, new ValidatorError({
               path: e.path,
@@ -911,9 +889,9 @@ Document.prototype.update = function update() {
  *
  * @see Model.updateOne #model_Model.updateOne
  * @param {Object} doc
- * @param {Object} [options] optional see [`Query.prototype.setOptions()`](http://mongoosejs.com/docs/api.html#query_Query-setOptions)
+ * @param {Object} [options] optional see [`Query.prototype.setOptions()`](https://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()`](/docs/api.html#query_Query-lean) and the [Mongoose lean tutorial](/docs/tutorials/lean.html).
- * @param {Boolean|String} [options.strict] overwrites the schema's [strict mode option](http://mongoosejs.com/docs/guide.html#strict)
+ * @param {Boolean|String} [options.strict] overwrites the schema's [strict mode option](https://mongoosejs.com/docs/guide.html#strict)
  * @param {Boolean} [options.timestamps=null] If set to `false` and [schema-level timestamps](/docs/guide.html#timestamps) are enabled, skip timestamps for this update. Note that this allows you to overwrite timestamps. Does nothing if schema-level timestamps are not set.
  * @param {Function} callback
  * @return {Query}
@@ -1116,7 +1094,7 @@ Document.prototype.$set = function $set(path, val, type, options) {
 
     // `_skipMinimizeTopLevel` is because we may have deleted the top-level
     // nested key to ensure key order.
-    const _skipMinimizeTopLevel = get(options, '_skipMinimizeTopLevel', false);
+    const _skipMinimizeTopLevel = options._skipMinimizeTopLevel || false;
     if (len === 0 && _skipMinimizeTopLevel) {
       delete options._skipMinimizeTopLevel;
       if (val) {
@@ -1135,7 +1113,7 @@ Document.prototype.$set = function $set(path, val, type, options) {
       // them to ensure we keep the user's key order.
       if (type === true &&
           !prefix &&
-          path[key] != null &&
+          valForKey != null &&
           pathtype === 'nested' &&
           this._doc[key] != null) {
         delete this._doc[key];
@@ -1260,7 +1238,7 @@ Document.prototype.$set = function $set(path, val, type, options) {
   const parts = path.indexOf('.') === -1 ? [path] : path.split('.');
 
   // Might need to change path for top-level alias
-  if (typeof this.$__schema.aliases[parts[0]] == 'string') {
+  if (typeof this.$__schema.aliases[parts[0]] === 'string') {
     parts[0] = this.$__schema.aliases[parts[0]];
   }
 
@@ -1313,7 +1291,7 @@ Document.prototype.$set = function $set(path, val, type, options) {
   let curPath = '';
   for (i = 0; i < parts.length - 1; ++i) {
     cur = cur[parts[i]];
-    curPath += (curPath.length > 0 ? '.' : '') + parts[i];
+    curPath += (curPath.length !== 0 ? '.' : '') + parts[i];
     if (!cur) {
       this.$set(curPath, {});
       // Hack re: gh-5800. If nested field is not selected, it probably exists
@@ -1336,7 +1314,8 @@ Document.prototype.$set = function $set(path, val, type, options) {
   if (parts.length <= 1) {
     pathToMark = path;
   } else {
-    for (i = 0; i < parts.length; ++i) {
+    const len = parts.length;
+    for (i = 0; i < len; ++i) {
       const subpath = parts.slice(0, i + 1).join('.');
       if (this.$get(subpath, null, { getters: false }) === null) {
         pathToMark = subpath;
@@ -1361,7 +1340,7 @@ Document.prototype.$set = function $set(path, val, type, options) {
     _markValidSubpaths(this, path);
   }
 
-  if (schema.$isSingleNested && val != null && merge) {
+  if (val != null && merge && schema.$isSingleNested) {
     if (val instanceof Document) {
       val = val.toObject({ virtuals: false, transform: false });
     }
@@ -1403,8 +1382,9 @@ Document.prototype.$set = function $set(path, val, type, options) {
 
     let didPopulate = false;
     if (refMatches && val instanceof Document) {
-      this.$populated(path, val._id, { [populateModelSymbol]: val.constructor });
-      val.$__.wasPopulated = true;
+      const unpopulatedValue = (schema && schema.$isSingleNested) ? schema.cast(val, this) : val._id;
+      this.$populated(path, unpopulatedValue, { [populateModelSymbol]: val.constructor });
+      val.$__.wasPopulated = { value: unpopulatedValue };
       didPopulate = true;
     }
 
@@ -1418,7 +1398,7 @@ Document.prototype.$set = function $set(path, val, type, options) {
       this.$populated(path, val.map(function(v) { return v._id; }), popOpts);
 
       for (const doc of val) {
-        doc.$__.wasPopulated = true;
+        doc.$__.wasPopulated = { value: doc._id };
       }
       didPopulate = true;
     }
@@ -1431,9 +1411,10 @@ Document.prototype.$set = function $set(path, val, type, options) {
       val = schema.applySetters(val, this, false, priorVal);
     }
 
-    if (schema.$isMongooseDocumentArray &&
-        Array.isArray(val) &&
-        val.length > 0 &&
+    if (Array.isArray(val) &&
+        !Array.isArray(schema) &&
+        schema.$isMongooseDocumentArray &&
+        val.length !== 0 &&
         val[0] != null &&
         val[0].$__ != null &&
         val[0].$__.populated != null) {
@@ -1459,7 +1440,7 @@ Document.prototype.$set = function $set(path, val, type, options) {
       delete this.$__.populated[path];
     }
 
-    if (schema.$isSingleNested && val != null) {
+    if (val != null && schema.$isSingleNested) {
       _checkImmutableSubpaths(val, schema, priorVal);
     }
 
@@ -1652,11 +1633,11 @@ Document.prototype.$__set = function(pathToMark, path, options, constructing, pa
 
     // handle directly setting arrays (gh-1126)
     MongooseArray || (MongooseArray = require('./types/array'));
-    if (val && val.isMongooseArray) {
+    if (val && utils.isMongooseArray(val)) {
       val._registerAtomic('$set', val);
 
       // Update embedded document parent references (gh-5189)
-      if (val.isMongooseDocumentArray) {
+      if (utils.isMongooseDocumentArray(val)) {
         val.forEach(function(item) {
           item && item.__parentArray && (item.__parentArray = val);
         });
@@ -1670,10 +1651,10 @@ Document.prototype.$__set = function(pathToMark, path, options, constructing, pa
         }
       });
     }
-  } else if (Array.isArray(val) && val.isMongooseArray && Array.isArray(priorVal) && priorVal.isMongooseArray) {
+  } else if (Array.isArray(val) && Array.isArray(priorVal) && utils.isMongooseArray(val) && utils.isMongooseArray(priorVal)) {
     val[arrayAtomicsSymbol] = priorVal[arrayAtomicsSymbol];
     val[arrayAtomicsBackupSymbol] = priorVal[arrayAtomicsBackupSymbol];
-    if (val.isMongooseDocumentArray) {
+    if (utils.isMongooseDocumentArray(val)) {
       val.forEach(doc => { doc.isNew = false; });
     }
   }
@@ -1702,7 +1683,7 @@ Document.prototype.$__set = function(pathToMark, path, options, constructing, pa
         obj = obj[parts[i]];
       } else if (obj[parts[i]] && obj[parts[i]] instanceof Embedded) {
         obj = obj[parts[i]];
-      } else if (obj[parts[i]] && obj[parts[i]].$isSingleNested) {
+      } else if (obj[parts[i]] && !Array.isArray(obj[parts[i]]) && obj[parts[i]].$isSingleNested) {
         obj = obj[parts[i]];
       } else if (obj[parts[i]] && Array.isArray(obj[parts[i]])) {
         obj = obj[parts[i]];
@@ -1782,7 +1763,7 @@ Document.prototype.get = function(path, type, options) {
   }
 
   // Might need to change path for top-level alias
-  if (typeof this.$__schema.aliases[pieces[0]] == 'string') {
+  if (typeof this.$__schema.aliases[pieces[0]] === 'string') {
     pieces[0] = this.$__schema.aliases[pieces[0]];
   }
 
@@ -1963,7 +1944,7 @@ Document.prototype.$isEmpty = function(path) {
     transform: false
   };
 
-  if (arguments.length > 0) {
+  if (arguments.length !== 0) {
     const v = this.$get(path);
     if (v == null) {
       return true;
@@ -2006,51 +1987,60 @@ function _isEmpty(v) {
 
 Document.prototype.modifiedPaths = function(options) {
   options = options || {};
+
   const directModifiedPaths = Object.keys(this.$__.activePaths.states.modify);
-  const _this = this;
-  return directModifiedPaths.reduce(function(list, path) {
-    const parts = path.split('.');
-    list = list.concat(parts.reduce(function(chains, part, i) {
-      return chains.concat(parts.slice(0, i).concat(part).join('.'));
-    }, []).filter(function(chain) {
-      return (list.indexOf(chain) === -1);
-    }));
+  const result = new Set();
+
+  let i = 0;
+  let j = 0;
+  const len = directModifiedPaths.length;
+
+  for (i = 0; i < len; ++i) {
+    const path = directModifiedPaths[i];
+    const parts = parentPaths(path);
+    const pLen = parts.length;
+
+    for (j = 0; j < pLen; ++j) {
+      result.add(parts[j]);
+    }
 
     if (!options.includeChildren) {
-      return list;
+      continue;
     }
 
-    let cur = _this.$get(path);
-    if (cur != null && typeof cur === 'object') {
+    let ii = 0;
+    let cur = this.$get(path);
+    if (typeof cur === 'object' && cur !== null) {
       if (cur._doc) {
         cur = cur._doc;
       }
+      const len = cur.length;
       if (Array.isArray(cur)) {
-        const len = cur.length;
-        for (let i = 0; i < len; ++i) {
-          if (list.indexOf(path + '.' + i) === -1) {
-            list.push(path + '.' + i);
-            if (cur[i] != null && cur[i].$__) {
-              const modified = cur[i].modifiedPaths();
-              for (const childPath of modified) {
-                list.push(path + '.' + i + '.' + childPath);
+        for (ii = 0; ii < len; ++ii) {
+          const subPath = path + '.' + ii;
+          if (!result.has(subPath)) {
+            result.add(subPath);
+            if (cur[ii] != null && cur[ii].$__) {
+              const modified = cur[ii].modifiedPaths();
+              let iii = 0;
+              const iiiLen = modified.length;
+              for (iii = 0; iii < iiiLen; ++iii) {
+                result.add(subPath + '.' + modified[iii]);
               }
             }
           }
         }
       } else {
-        Object.keys(cur).
-          filter(function(key) {
-            return list.indexOf(path + '.' + key) === -1;
-          }).
-          forEach(function(key) {
-            list.push(path + '.' + key);
-          });
+        const keys = Object.keys(cur);
+        let ii = 0;
+        const len = keys.length;
+        for (ii = 0; ii < len; ++ii) {
+          result.add(path + '.' + keys[ii]);
+        }
       }
     }
-
-    return list;
-  }, []);
+  }
+  return Array.from(result);
 };
 
 Document.prototype[documentModifiedPaths] = Document.prototype.modifiedPaths;
@@ -2448,7 +2438,12 @@ Document.prototype.$validate = Document.prototype.validate;
  */
 
 function _evaluateRequiredFunctions(doc) {
-  Object.keys(doc.$__.activePaths.states.require).forEach(path => {
+  const requiredFields = Object.keys(doc.$__.activePaths.states.require);
+  let i = 0;
+  const len = requiredFields.length;
+  for (i = 0; i < len; ++i) {
+    const path = requiredFields[i];
+
     const p = doc.$__schema.path(path);
 
     if (p != null && typeof p.originalRequiredValue === 'function') {
@@ -2459,7 +2454,7 @@ function _evaluateRequiredFunctions(doc) {
         doc.invalidate(path, err);
       }
     }
-  });
+  }
 }
 
 /*!
@@ -2520,7 +2515,9 @@ function _getPathsToValidate(doc) {
         // To avoid potential performance issues, skip doc arrays whose children
         // are not required. `getPositionalPathType()` may be slow, so avoid
         // it unless we have a case of #6364
-        (_pathType.$isMongooseDocumentArray && !get(_pathType, 'schemaOptions.required'))) {
+        (!Array.isArray(_pathType) &&
+          _pathType.$isMongooseDocumentArray &&
+          !(_pathType && _pathType.schemaOptions && _pathType.schemaOptions.required))) {
       continue;
     }
 
@@ -2597,7 +2594,7 @@ Document.prototype.$__validate = function(pathsToValidate, options, callback) {
       (typeof options === 'object') &&
       ('validateModifiedOnly' in options);
 
-  const pathsToSkip = get(options, 'pathsToSkip', null);
+  const pathsToSkip = (options && options.pathsToSkip) || null;
 
   let shouldValidateModifiedOnly;
   if (hasValidateModifiedOnlyOption) {
@@ -2858,19 +2855,21 @@ Document.prototype.validateSync = function(pathsToValidate, options) {
   }
   const validating = {};
 
-  paths.forEach(function(path) {
+  for (let i = 0, len = paths.length; i < len; ++i) {
+    const path = paths[i];
+
     if (validating[path]) {
-      return;
+      continue;
     }
 
     validating[path] = true;
 
     const p = _this.$__schema.path(path);
     if (!p) {
-      return;
+      continue;
     }
     if (!_this.$isValid(path)) {
-      return;
+      continue;
     }
 
     const val = _this.$__getValue(path);
@@ -2884,11 +2883,11 @@ Document.prototype.validateSync = function(pathsToValidate, options) {
         p.$isArraySubdocument ||
         p.$isMongooseDocumentArray;
       if (isSubdoc && err instanceof ValidationError) {
-        return;
+        continue;
       }
       _this.invalidate(path, err, undefined, true);
     }
-  });
+  }
 
   const err = _this.$__.validationError;
   _this.$__.validationError = undefined;
@@ -3047,7 +3046,7 @@ function _checkImmutableSubpaths(subdoc, schematype, priorVal) {
  *
  * @param {Object} [options] options optional options
  * @param {Session} [options.session=null] the [session](https://docs.mongodb.com/manual/reference/server-sessions/) associated with this save operation. If not specified, defaults to the [document's associated session](api.html#document_Document-$session).
- * @param {Object} [options.safe] (DEPRECATED) overrides [schema's safe option](http://mongoosejs.com//docs/guide.html#safe). Use the `w` option instead.
+ * @param {Object} [options.safe] (DEPRECATED) overrides [schema's safe option](https://mongoosejs.com//docs/guide.html#safe). Use the `w` option instead.
  * @param {Boolean} [options.validateBeforeSave] set to false to save without validating.
  * @param {Boolean} [options.validateModifiedOnly=false] If `true`, Mongoose will only validate modified paths, as opposed to modified paths and `required` paths.
  * @param {Number|String} [options.w] set the [write concern](https://docs.mongodb.com/manual/reference/write-concern/#w-option). Overrides the [schema-level `writeConcern` option](/docs/guide.html#writeConcern)
@@ -3062,7 +3061,7 @@ function _checkImmutableSubpaths(subdoc, schematype, priorVal) {
  * @throws {DocumentNotFoundError} if this [save updates an existing document](api.html#document_Document-isNew) but the document doesn't exist in the database. For example, you will get this error if the document is [deleted between when you retrieved the document and when you saved it](documents.html#updating).
  * @return {Promise|undefined} Returns undefined if used with callback or a Promise otherwise.
  * @api public
- * @see middleware http://mongoosejs.com/docs/middleware.html
+ * @see middleware https://mongoosejs.com/docs/middleware.html
  */
 
 /**
@@ -3112,7 +3111,7 @@ Document.prototype.$__reset = function reset() {
       return _this.$__getValue(i);
     })
     .filter(function(val) {
-      return val && val instanceof Array && val.isMongooseDocumentArray && val.length;
+      return val && Array.isArray(val) && utils.isMongooseDocumentArray(val) && val.length;
     })
     .forEach(function(array) {
       let i = array.length;
@@ -3135,7 +3134,7 @@ Document.prototype.$__reset = function reset() {
       return _this.$__getValue(i);
     }).
     filter(function(val) {
-      return val && val.$isSingleNested;
+      return val && !Array.isArray(val) && val.$isSingleNested;
     }).
     forEach(function(doc) {
       doc.$__reset();
@@ -3315,7 +3314,7 @@ Document.prototype.$__getArrayPathsToValidate = function() {
       return this.$__getValue(i);
     }.bind(this))
     .filter(function(val) {
-      return val && val instanceof Array && val.isMongooseDocumentArray && val.length;
+      return val && Array.isArray(val) && utils.isMongooseDocumentArray(val) && val.length;
     }).reduce(function(seed, array) {
       return seed.concat(array);
     }, [])
@@ -3357,12 +3356,12 @@ Document.prototype.$getAllSubdocs = function() {
       seed = Array.from(val.keys()).reduce(function(seed, path) {
         return docReducer(val.get(path), seed, null);
       }, seed);
-    } else if (val && val.$isSingleNested) {
+    } else if (val && !Array.isArray(val) && val.$isSingleNested) {
       seed = Object.keys(val._doc).reduce(function(seed, path) {
         return docReducer(val._doc, seed, path);
       }, seed);
       seed.push(val);
-    } else if (val && val.isMongooseDocumentArray) {
+    } else if (val && utils.isMongooseDocumentArray(val)) {
       val.forEach(function _docReduce(doc) {
         if (!doc || !doc._doc) {
           return;
@@ -3436,8 +3435,11 @@ Document.prototype.$toObject = function(options, json) {
   };
 
   const path = json ? 'toJSON' : 'toObject';
-  const baseOptions = get(this, 'constructor.base.options.' + path, {});
-  const schemaOptions = get(this, '$__schema.options', {});
+  const baseOptions = this.constructor &&
+  this.constructor.base &&
+  this.constructor.base.options &&
+  get(this.constructor.base.options, path) || {};
+  const schemaOptions = this.$__schema && this.$__schema.options || {};
   // merge base default options with Schema's set default options if available.
   // `clone` is necessary here because `utils.options` directly modifies the second input.
   defaultOptions = utils.options(defaultOptions, clone(baseOptions));
@@ -3484,12 +3486,11 @@ Document.prototype.$toObject = function(options, json) {
   }
 
   const depopulate = options.depopulate ||
-    get(options, '_parentOptions.depopulate', false);
+    (options._parentOptions && options._parentOptions.depopulate || false);
   // _isNested will only be true if this is not the top level document, we
-  // should never depopulate
+  // should never depopulate the top-level document
   if (depopulate && options._isNested && this.$__.wasPopulated) {
-    // populated paths that we set to a document
-    return clone(this._id, cloneOptions);
+    return clone(this.$__.wasPopulated.value || this._id, cloneOptions);
   }
 
   // merge default options with input options.
@@ -3564,7 +3565,7 @@ Document.prototype.$toObject = function(options, json) {
 /**
  * Converts this document into a plain-old JavaScript object ([POJO](https://masteringjs.io/tutorials/fundamentals/pojo)).
  *
- * Buffers are converted to instances of [mongodb.Binary](http://mongodb.github.com/node-mongodb-native/api-bson-generated/binary.html) for proper storage.
+ * Buffers are converted to instances of [mongodb.Binary](https://mongodb.github.com/node-mongodb-native/api-bson-generated/binary.html) for proper storage.
  *
  * ####Options:
  *
@@ -3703,7 +3704,7 @@ Document.prototype.$toObject = function(options, json) {
  * @param {Boolean} [options.flattenMaps=false] if true, convert Maps to POJOs. Useful if you want to `JSON.stringify()` the result of `toObject()`.
  * @param {Boolean} [options.useProjection=false] - If true, omits fields that are excluded in this document's projection. Unless you specified a projection, this will omit any field that has `select: false` in the schema.
  * @return {Object} js object
- * @see mongodb.Binary http://mongodb.github.com/node-mongodb-native/api-bson-generated/binary.html
+ * @see mongodb.Binary https://mongodb.github.com/node-mongodb-native/api-bson-generated/binary.html
  * @api public
  * @memberOf Document
  * @instance
@@ -3761,7 +3762,9 @@ function applyVirtuals(self, json, options, toObjectOptions) {
   let assignPath;
   let cur = self._doc;
   let v;
-  const aliases = get(toObjectOptions, 'aliases', true);
+  const aliases = typeof (toObjectOptions && toObjectOptions.aliases) === 'boolean'
+    ? toObjectOptions.aliases
+    : true;
 
   let virtualsToApply = null;
   if (Array.isArray(options.virtuals)) {
@@ -3955,15 +3958,20 @@ function omitDeselectedFields(self, json) {
 }
 
 /**
- * The return value of this method is used in calls to JSON.stringify(doc).
+ * The return value of this method is used in calls to [`JSON.stringify(doc)`](https://thecodebarbarian.com/the-80-20-guide-to-json-stringify-in-javascript#the-tojson-function).
  *
  * This method accepts the same options as [Document#toObject](#document_Document-toObject). To apply the options to every document of your schema by default, set your [schemas](#schema_Schema) `toJSON` option to the same argument.
  *
- *     schema.set('toJSON', { virtuals: true })
+ *     schema.set('toJSON', { virtuals: true });
+ *
+ * There is one difference between `toJSON()` and `toObject()` options.
+ * When you call `toJSON()`, the [`flattenMaps` option](./document.html#document_Document-toObject) defaults to `true`, because `JSON.stringify()` doesn't convert maps to objects by default.
+ * When you call `toObject()`, the `flattenMaps` option is `false` by default.
  *
- * See [schema options](/docs/guide.html#toJSON) for details.
+ * See [schema options](/docs/guide.html#toJSON) for more information on setting `toJSON` option defaults.
  *
  * @param {Object} options
+ * @param {Boolean} [options.flattenMaps=true] if true, convert Maps to [POJOs](https://masteringjs.io/tutorials/fundamentals/pojo). Useful if you want to `JSON.stringify()` the result.
  * @return {Object}
  * @see Document#toObject #document_Document-toObject
  * @see JSON.stringify() in JavaScript https://thecodebarbarian.com/the-80-20-guide-to-json-stringify-in-javascript.html
@@ -4118,6 +4126,7 @@ Document.prototype.equals = function(doc) {
  * @param {Object} [match] Conditions for the population query
  * @param {Object} [options] Options for the population query (sort, etc)
  * @param {String} [options.path=null] The path to populate.
+ * @param {string|PopulateOptions} [options.populate=null] Recursively populate paths in the populated documents. See [deep populate docs](/docs/populate.html#deep-populate).
  * @param {boolean} [options.retainNullValues=false] by default, Mongoose removes null and undefined values from populated arrays. Use this option to make `populate()` retain `null` and `undefined` array entries.
  * @param {boolean} [options.getters=false] if true, Mongoose will call any getters defined on the `localField`. By default, Mongoose gets the raw value of `localField`. For example, you would need to set this option to `true` if you wanted to [add a `lowercase` getter to your `localField`](/docs/schematypes.html#schematype-options).
  * @param {boolean} [options.clone=false] When you do `BlogPost.find().populate('author')`, blog posts with the same author will share 1 copy of an `author` doc. Enable this option to make Mongoose clone populated docs before assigning them.
@@ -4139,7 +4148,7 @@ Document.prototype.populate = function populate() {
   const args = [...arguments];
   let fn;
 
-  if (args.length > 0) {
+  if (args.length !== 0) {
     if (typeof args[args.length - 1] === 'function') {
       fn = args.pop();
     }
@@ -4298,7 +4307,7 @@ Document.prototype.depopulate = function(path) {
 
   let populatedIds;
   const virtualKeys = this.$$populatedVirtuals ? Object.keys(this.$$populatedVirtuals) : [];
-  const populated = get(this, '$__.populated', {});
+  const populated = this.$__ && this.$__.populated || {};
 
   if (arguments.length === 0) {
     // Depopulate all