mongoose 6.2.1 → 6.2.4

package/lib/model.js

@@ -25,6 +25,7 @@ const ParallelSaveError = require('./error/parallelSave');
 const applyQueryMiddleware = require('./helpers/query/applyQueryMiddleware');
 const applyHooks = require('./helpers/model/applyHooks');
 const applyMethods = require('./helpers/model/applyMethods');
+const applyProjection = require('./helpers/projection/applyProjection');
 const applyStaticHooks = require('./helpers/model/applyStaticHooks');
 const applyStatics = require('./helpers/model/applyStatics');
 const applyWriteConcern = require('./helpers/schema/applyWriteConcern');
@@ -42,6 +43,11 @@ const immediate = require('./helpers/immediate');
 const internalToObjectOptions = require('./options').internalToObjectOptions;
 const isDefaultIdIndex = require('./helpers/indexes/isDefaultIdIndex');
 const isIndexEqual = require('./helpers/indexes/isIndexEqual');
+const {
+  getRelatedDBIndexes,
+  getRelatedSchemaIndexes
+} = require('./helpers/indexes/getRelatedIndexes');
+const decorateDiscriminatorIndexOptions = require('./helpers/indexes/decorateDiscriminatorIndexOptions');
 const isPathSelectedInclusive = require('./helpers/projection/isPathSelectedInclusive');
 const leanPopulateMap = require('./helpers/populate/leanPopulateMap');
 const modifiedPaths = require('./helpers/update/modifiedPaths');
@@ -91,7 +97,7 @@ const saveToObjectOptions = Object.assign({}, internalToObjectOptions, {
  * @param {Object} doc values for initial set
  * @param [fields] optional object containing the fields that were selected in the query which returned this document. You do **not** need to set this parameter to ensure Mongoose handles your [query projection](./api.html#query_Query-select).
  * @param {Boolean} [skipId=false] optional boolean. If true, mongoose doesn't add an `_id` field to the document.
- * @inherits Document http://mongoosejs.com/docs/api/document.html
+ * @inherits Document https://mongoosejs.com/docs/api/document.html
  * @event `error`: If listening to this event, 'error' is emitted when a document was saved without passing a callback and an `error` occurred. If not listening, the event bubbles to the connection used to create this Model.
  * @event `index`: Emitted after `Model#ensureIndexes` completes. If an error occurred it is passed with the event.
  * @event `index-single-start`: Emitted when an individual index starts within `Model#ensureIndexes`. The fields and options being used to build the index are also passed with the event.
@@ -243,7 +249,7 @@ Model.prototype.$__handleSave = function(options, callback) {
   let saveOptions = {};
 
   applyWriteConcern(this.$__schema, options);
-  if (typeof options.writeConcern != 'undefined') {
+  if (typeof options.writeConcern !== 'undefined') {
     saveOptions.writeConcern = {};
     if ('w' in options.writeConcern) {
       saveOptions.writeConcern.w = options.writeConcern.w;
@@ -345,17 +351,12 @@ Model.prototype.$__handleSave = function(options, callback) {
           where[key] = val;
         }
       }
-      this.constructor.exists(where, optionsWithCustomValues).
-        then((documentExists) => {
-          if (!documentExists) {
-            const matchedCount = 0;
-            return callback(null, { $where: where, matchedCount });
-          }
-
-          const matchedCount = 1;
+      this.constructor.exists(where, optionsWithCustomValues)
+        .then(documentExists => {
+          const matchedCount = !documentExists ? 0 : 1;
           callback(null, { $where: where, matchedCount });
-        }).
-        catch(callback);
+        })
+        .catch(callback);
       return;
     }
 
@@ -467,7 +468,7 @@ function generateVersionError(doc, modifiedPaths) {
  *
  * @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)
@@ -479,7 +480,7 @@ function generateVersionError(doc, modifiedPaths) {
  * @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
  */
 
 Model.prototype.save = function(options, fn) {
@@ -710,7 +711,7 @@ Model.prototype.$__delta = function() {
   where._id = this._doc._id;
   // If `_id` is an object, need to depopulate, but also need to be careful
   // because `_id` can technically be null (see gh-6406)
-  if (get(where, '_id.$__', null) != null) {
+  if ((where && where._id && where._id.$__ || null) != null) {
     where._id = where._id.toObject({ transform: false, depopulate: true });
   }
   for (; d < len; ++d) {
@@ -890,7 +891,7 @@ Model.prototype.$__version = function(where, delta) {
  *       doc.save(function (err) { .. })
  *     })
  *
- * @see versionKeys http://mongoosejs.com/docs/guide.html#versionKey
+ * @see versionKeys https://mongoosejs.com/docs/guide.html#versionKey
  * @api public
  */
 
@@ -1086,7 +1087,7 @@ Model.prototype.model = function model(name) {
  * - `findOne()`
  *
  * @param {Object} filter
- * @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 {Function} [callback] callback
  * @return {Query}
  */
@@ -1159,7 +1160,7 @@ Model.discriminator = function(name, schema, options) {
 
   options = options || {};
   const value = utils.isPOJO(options) ? options.value : options;
-  const clone = get(options, 'clone', true);
+  const clone = typeof options.clone === 'boolean' ? options.clone : true;
 
   _checkContext(this, 'discriminator');
 
@@ -1233,7 +1234,7 @@ for (const i in EventEmitter.prototype) {
 
 /**
  * This function is responsible for building [indexes](https://docs.mongodb.com/manual/indexes/),
- * unless [`autoIndex`](http://mongoosejs.com/docs/guide.html#autoIndex) is turned off.
+ * unless [`autoIndex`](https://mongoosejs.com/docs/guide.html#autoIndex) is turned off.
  *
  * Mongoose calls this function automatically when a model is created using
  * [`mongoose.model()`](/docs/api.html#mongoose_Mongoose-model) or
@@ -1338,7 +1339,7 @@ Model.init = function init(callback) {
  *     });
  *
  * @api public
- * @param {Object} [options] see [MongoDB driver docs](http://mongodb.github.io/node-mongodb-native/3.1/api/Db.html#createCollection)
+ * @param {Object} [options] see [MongoDB driver docs](https://mongodb.github.io/node-mongodb-native/3.1/api/Db.html#createCollection)
  * @param {Function} [callback]
  * @returns {Promise}
  */
@@ -1354,15 +1355,24 @@ Model.createCollection = function createCollection(options, callback) {
     options = void 0;
   }
 
-  const schemaCollation = get(this, ['schema', 'options', 'collation'], null);
+  const schemaCollation = this &&
+  this.schema &&
+  this.schema.options &&
+  this.schema.options.collation || null;
   if (schemaCollation != null) {
     options = Object.assign({ collation: schemaCollation }, options);
   }
-  const capped = get(this, ['schema', 'options', 'capped']);
+  const capped = this &&
+  this.schema &&
+  this.schema.options &&
+   this.schema.options.capped;
   if (capped) {
     options = Object.assign({ capped: true }, capped, options);
   }
-  const timeseries = get(this, ['schema', 'options', 'timeseries']);
+  const timeseries = this &&
+  this.schema &&
+  this.schema.options &&
+  this.schema.options.timeseries;
   if (timeseries != null) {
     options = Object.assign({ timeseries }, options);
   }
@@ -1388,7 +1398,7 @@ Model.createCollection = function createCollection(options, callback) {
  * the model's schema except the `_id` index, and build any indexes that
  * are in your schema but not in MongoDB.
  *
- * See the [introductory blog post](http://thecodebarbarian.com/whats-new-in-mongoose-5-2-syncindexes)
+ * See the [introductory blog post](https://thecodebarbarian.com/whats-new-in-mongoose-5-2-syncindexes)
  * for more information.
  *
  * ####Example:
@@ -1466,8 +1476,7 @@ Model.diffIndexes = function diffIndexes(options, callback) {
 
         for (const schemaIndex of schemaIndexes) {
           const key = schemaIndex[0];
-          const options = _decorateDiscriminatorIndexOptions(this,
-            utils.clone(schemaIndex[1]));
+          const options = decorateDiscriminatorIndexOptions(this.schema, utils.clone(schemaIndex[1]));
           if (isIndexEqual(key, options, index)) {
             found = true;
           }
@@ -1480,10 +1489,9 @@ Model.diffIndexes = function diffIndexes(options, callback) {
       // Iterate through the indexes created on the schema and
       // compare against the indexes in mongodb.
       for (const schemaIndex of schemaIndexes) {
-        const key = schemaIndex[0];
         let found = false;
-        const options = _decorateDiscriminatorIndexOptions(this,
-          utils.clone(schemaIndex[1]));
+        const key = schemaIndex[0];
+        const options = decorateDiscriminatorIndexOptions(this.schema, utils.clone(schemaIndex[1]));
         for (const index of indexes) {
           if (isDefaultIdIndex(index)) {
             continue;
@@ -1520,32 +1528,33 @@ Model.cleanIndexes = function cleanIndexes(callback) {
   return this.db.base._promiseOrCallback(callback, cb => {
     const collection = this.$__collection;
 
-    this.listIndexes((err, indexes) => {
+    this.listIndexes((err, dbIndexes) => {
       if (err != null) {
         return cb(err);
       }
 
-      const schemaIndexes = this.schema.indexes();
+      dbIndexes = getRelatedDBIndexes(this, dbIndexes);
+      const schemaIndexes = getRelatedSchemaIndexes(this, this.schema.indexes());
+
       const toDrop = [];
 
-      for (const index of indexes) {
+      for (const dbIndex of dbIndexes) {
         let found = false;
         // Never try to drop `_id` index, MongoDB server doesn't allow it
-        if (isDefaultIdIndex(index)) {
+        if (isDefaultIdIndex(dbIndex)) {
           continue;
         }
 
-        for (const schemaIndex of schemaIndexes) {
-          const key = schemaIndex[0];
-          const options = _decorateDiscriminatorIndexOptions(this,
-            utils.clone(schemaIndex[1]));
-          if (isIndexEqual(key, options, index)) {
+        for (const [schemaIndexKeysObject, schemaIndexOptions] of schemaIndexes) {
+          const options = decorateDiscriminatorIndexOptions(this.schema, utils.clone(schemaIndexOptions));
+
+          if (isIndexEqual(schemaIndexKeysObject, options, dbIndex)) {
             found = true;
           }
         }
 
         if (!found) {
-          toDrop.push(index.name);
+          toDrop.push(dbIndex.name);
         }
       }
 
@@ -1658,7 +1667,7 @@ Model.ensureIndexes = function ensureIndexes(options, callback) {
 };
 
 /**
- * Similar to `ensureIndexes()`, except for it uses the [`createIndex`](http://mongodb.github.io/node-mongodb-native/2.2/api/Collection.html#createIndex)
+ * Similar to `ensureIndexes()`, except for it uses the [`createIndex`](https://mongodb.github.io/node-mongodb-native/2.2/api/Collection.html#createIndex)
  * function.
  *
  * @param {Object} [options] internal options
@@ -1701,7 +1710,7 @@ function _ensureIndexes(model, options, callback) {
       utils.warn('mongoose: Cannot specify a custom index on `_id` for ' +
         'model name "' + model.modelName + '", ' +
         'MongoDB does not allow overwriting the default `_id` index. See ' +
-        'http://bit.ly/mongodb-id-index');
+        'https://bit.ly/mongodb-id-index');
     }
   }
 
@@ -1724,7 +1733,17 @@ function _ensureIndexes(model, options, callback) {
   const baseSchema = model.schema._baseSchema;
   const baseSchemaIndexes = baseSchema ? baseSchema.indexes() : [];
 
-  const create = function() {
+  immediate(function() {
+    // If buffering is off, do this manually.
+    if (options._automatic && !model.collection.collection) {
+      model.collection.addQueue(create, []);
+    } else {
+      create();
+    }
+  });
+
+
+  function create() {
     if (options._automatic) {
       if (model.schema.options.autoIndex === false ||
           (model.schema.options.autoIndex == null && model.db.config.autoIndex === false)) {
@@ -1753,7 +1772,7 @@ function _ensureIndexes(model, options, callback) {
       }
     }
     delete indexOptions._autoIndex;
-    _decorateDiscriminatorIndexOptions(model, indexOptions);
+    decorateDiscriminatorIndexOptions(model.schema, indexOptions);
     applyWriteConcern(model.schema, indexOptions);
 
     indexSingleStart(indexFields, options);
@@ -1779,34 +1798,7 @@ function _ensureIndexes(model, options, callback) {
       }
       create();
     }));
-  };
-
-  immediate(function() {
-    // If buffering is off, do this manually.
-    if (options._automatic && !model.collection.collection) {
-      model.collection.addQueue(create, []);
-    } else {
-      create();
-    }
-  });
-}
-
-function _decorateDiscriminatorIndexOptions(model, indexOptions) {
-  // If the model is a discriminator and it has a unique index, add a
-  // partialFilterExpression by default so the unique index will only apply
-  // to that discriminator.
-  if (model.baseModelName != null &&
-    !('partialFilterExpression' in indexOptions) &&
-    !('sparse' in indexOptions)) {
-    const value = (
-      model.schema.discriminatorMapping &&
-      model.schema.discriminatorMapping.value
-    ) || model.modelName;
-    const discriminatorKey = model.schema.options.discriminatorKey;
-
-    indexOptions.partialFilterExpression = { [discriminatorKey]: value };
-  }
-  return indexOptions;
+  }
 }
 
 /**
@@ -2026,7 +2018,7 @@ Model.remove = function remove(conditions, options, callback) {
  * [middleware docs](/docs/middleware.html#naming) to learn more.
  *
  * @param {Object} conditions
- * @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 {Function} [callback]
  * @return {Query}
  * @api public
@@ -2069,7 +2061,7 @@ Model.deleteOne = function deleteOne(conditions, options, callback) {
  * [middleware docs](/docs/middleware.html#naming) to learn more.
  *
  * @param {Object} conditions
- * @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 {Function} [callback]
  * @return {Query}
  * @api public
@@ -2120,8 +2112,8 @@ Model.deleteMany = function deleteMany(conditions, options, callback) {
  *     await MyModel.find({ name: /john/i }, null, { skip: 10 }).exec();
  *
  * @param {Object|ObjectId} filter
- * @param {Object|String|Array<String>} [projection] optional fields to return, see [`Query.prototype.select()`](http://mongoosejs.com/docs/api.html#query_Query-select)
- * @param {Object} [options] optional see [`Query.prototype.setOptions()`](http://mongoosejs.com/docs/api.html#query_Query-setOptions)
+ * @param {Object|String|Array<String>} [projection] optional fields to return, see [`Query.prototype.select()`](https://mongoosejs.com/docs/api.html#query_Query-select)
+ * @param {Object} [options] optional see [`Query.prototype.setOptions()`](https://mongoosejs.com/docs/api.html#query_Query-setOptions)
  * @param {Function} [callback]
  * @return {Query}
  * @see field selection #query_Query-select
@@ -2191,7 +2183,7 @@ Model.find = function find(conditions, projection, options, callback) {
  *
  * @param {Any} id value of `_id` to query by
  * @param {Object|String|Array<String>} [projection] optional fields to return, see [`Query.prototype.select()`](#query_Query-select)
- * @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 {Function} [callback]
  * @return {Query}
  * @see field selection #query_Query-select
@@ -2234,7 +2226,7 @@ Model.findById = function findById(id, projection, options, callback) {
  *
  * @param {Object} [conditions]
  * @param {Object|String|Array<String>} [projection] optional fields to return, see [`Query.prototype.select()`](#query_Query-select)
- * @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 {Function} [callback]
  * @return {Query}
  * @see field selection #query_Query-select
@@ -2488,9 +2480,9 @@ Model.$where = function $where() {
  * - `maxTimeMS`: puts a time limit on the query - requires mongodb >= 2.6.0
  * - `sort`: if multiple docs are found by the conditions, sets the sort order to choose which doc to update
  * - `runValidators`: if true, runs [update validators](/docs/validation.html#update-validators) on this command. Update validators validate the update operation against the model's schema.
- * - `setDefaultsOnInsert`: `true` by default. If `setDefaultsOnInsert` and `upsert` are true, mongoose will apply the [defaults](http://mongoosejs.com/docs/defaults.html) specified in the model's schema if a new document is created.
- * - `rawResult`: if true, returns the [raw result from the MongoDB driver](http://mongodb.github.io/node-mongodb-native/2.0/api/Collection.html#findAndModify)
- * - `strict`: overwrites the schema's [strict mode option](http://mongoosejs.com/docs/guide.html#strict) for this update
+ * - `setDefaultsOnInsert`: `true` by default. If `setDefaultsOnInsert` and `upsert` are true, mongoose will apply the [defaults](https://mongoosejs.com/docs/defaults.html) specified in the model's schema if a new document is created.
+ * - `rawResult`: if true, returns the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/2.0/api/Collection.html#findAndModify)
+ * - `strict`: overwrites the schema's [strict mode option](https://mongoosejs.com/docs/guide.html#strict) for this update
  *
  * ####Examples:
  *
@@ -2528,11 +2520,11 @@ Model.$where = function $where() {
  *
  * @param {Object} [conditions]
  * @param {Object} [update]
- * @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 {String} [options.returnDocument='before'] Has two possible values, `'before'` and `'after'`. By default, it will return the document before the update was applied.
  * @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 {ClientSession} [options.session=null] The session associated with this query. See [transactions docs](/docs/transactions.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 {Boolean} [options.overwrite=false] By default, if you don't include any [update operators](https://docs.mongodb.com/manual/reference/operator/update/) in `update`, Mongoose will wrap `update` in `$set` for you. This prevents you from accidentally overwriting the document. This option tells Mongoose to skip adding `$set`. An alternative to this would be using [Model.findOneAndReplace(conditions, update, options, callback)](https://mongoosejs.com/docs/api/model.html#model_Model.findOneAndReplace).
  * @param {Boolean} [options.upsert=false] if true, and no documents found, insert a new document
@@ -2540,7 +2532,7 @@ Model.$where = function $where() {
  * @param {Function} [callback]
  * @return {Query}
  * @see Tutorial /docs/tutorials/findoneandupdate.html
- * @see mongodb http://www.mongodb.org/display/DOCS/findAndModify+Command
+ * @see mongodb https://www.mongodb.org/display/DOCS/findAndModify+Command
  * @api public
  */
 
@@ -2588,7 +2580,7 @@ Model.findOneAndUpdate = function(conditions, update, options, callback) {
  */
 
 function _decorateUpdateWithVersionKey(update, options, versionKey) {
-  if (!versionKey || !get(options, 'upsert', false)) {
+  if (!versionKey || !(options && options.upsert || false)) {
     return;
   }
 
@@ -2622,11 +2614,11 @@ function _decorateUpdateWithVersionKey(update, options, versionKey) {
  * - `new`: bool - true to return the modified document rather than the original. defaults to false
  * - `upsert`: bool - creates the object if it doesn't exist. defaults to false.
  * - `runValidators`: if true, runs [update validators](/docs/validation.html#update-validators) on this command. Update validators validate the update operation against the model's schema.
- * - `setDefaultsOnInsert`: `true` by default. If `setDefaultsOnInsert` and `upsert` are true, mongoose will apply the [defaults](http://mongoosejs.com/docs/defaults.html) specified in the model's schema if a new document is created.
+ * - `setDefaultsOnInsert`: `true` by default. If `setDefaultsOnInsert` and `upsert` are true, mongoose will apply the [defaults](https://mongoosejs.com/docs/defaults.html) specified in the model's schema if a new document is created.
  * - `sort`: if multiple docs are found by the conditions, sets the sort order to choose which doc to update
  * - `select`: sets the document fields to return
- * - `rawResult`: if true, returns the [raw result from the MongoDB driver](http://mongodb.github.io/node-mongodb-native/2.0/api/Collection.html#findAndModify)
- * - `strict`: overwrites the schema's [strict mode option](http://mongoosejs.com/docs/guide.html#strict) for this update
+ * - `rawResult`: if true, returns the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/2.0/api/Collection.html#findAndModify)
+ * - `strict`: overwrites the schema's [strict mode option](https://mongoosejs.com/docs/guide.html#strict) for this update
  *
  * ####Examples:
  *
@@ -2665,17 +2657,17 @@ function _decorateUpdateWithVersionKey(update, options, versionKey) {
  *
  * @param {Object|Number|String} id value of `_id` to query by
  * @param {Object} [update]
- * @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 {String} [options.returnDocument='before'] Has two possible values, `'before'` and `'after'`. By default, it will return the document before the update was applied.
  * @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 {ClientSession} [options.session=null] The session associated with this query. See [transactions docs](/docs/transactions.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 {Boolean} [options.overwrite=false] By default, if you don't include any [update operators](https://docs.mongodb.com/manual/reference/operator/update/) in `update`, Mongoose will wrap `update` in `$set` for you. This prevents you from accidentally overwriting the document. This option tells Mongoose to skip adding `$set`. An alternative to this would be using [Model.findOneAndReplace({ _id: id }, update, options, callback)](https://mongoosejs.com/docs/api/model.html#model_Model.findOneAndReplace).
  * @param {Function} [callback]
  * @return {Query}
  * @see Model.findOneAndUpdate #model_Model.findOneAndUpdate
- * @see mongodb http://www.mongodb.org/display/DOCS/findAndModify+Command
+ * @see mongodb https://www.mongodb.org/display/DOCS/findAndModify+Command
  * @api public
  */
 
@@ -2726,8 +2718,8 @@ Model.findByIdAndUpdate = function(id, update, options, callback) {
  * - `maxTimeMS`: puts a time limit on the query - requires mongodb >= 2.6.0
  * - `select`: sets the document fields to return, ex. `{ projection: { _id: 0 } }`
  * - `projection`: equivalent to `select`
- * - `rawResult`: if true, returns the [raw result from the MongoDB driver](http://mongodb.github.io/node-mongodb-native/2.0/api/Collection.html#findAndModify)
- * - `strict`: overwrites the schema's [strict mode option](http://mongoosejs.com/docs/guide.html#strict) for this update
+ * - `rawResult`: if true, returns the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/2.0/api/Collection.html#findAndModify)
+ * - `strict`: overwrites the schema's [strict mode option](https://mongoosejs.com/docs/guide.html#strict) for this update
  *
  * ####Examples:
  *
@@ -2750,8 +2742,8 @@ Model.findByIdAndUpdate = function(id, update, options, callback) {
  *     });
  *
  * @param {Object} conditions
- * @param {Object} [options] optional see [`Query.prototype.setOptions()`](http://mongoosejs.com/docs/api.html#query_Query-setOptions)
- * @param {Boolean|String} [options.strict] overwrites the schema's [strict mode option](http://mongoosejs.com/docs/guide.html#strict)
+ * @param {Object} [options] optional see [`Query.prototype.setOptions()`](https://mongoosejs.com/docs/api.html#query_Query-setOptions)
+ * @param {Boolean|String} [options.strict] overwrites the schema's [strict mode option](https://mongoosejs.com/docs/guide.html#strict)
  * @param {Object|String|Array<String>} [options.projection=null] optional fields to return, see [`Query.prototype.select()`](#query_Query-select)
  * @param {ClientSession} [options.session=null] The session associated with this query. See [transactions docs](/docs/transactions.html).
  * @param {Function} [callback]
@@ -2798,12 +2790,12 @@ Model.findOneAndDelete = function(conditions, options, callback) {
  * - `findOneAndDelete()`
  *
  * @param {Object|Number|String} id value of `_id` to query by
- * @param {Object} [options] optional see [`Query.prototype.setOptions()`](http://mongoosejs.com/docs/api.html#query_Query-setOptions)
- * @param {Boolean|String} [options.strict] overwrites the schema's [strict mode option](http://mongoosejs.com/docs/guide.html#strict)
+ * @param {Object} [options] optional see [`Query.prototype.setOptions()`](https://mongoosejs.com/docs/api.html#query_Query-setOptions)
+ * @param {Boolean|String} [options.strict] overwrites the schema's [strict mode option](https://mongoosejs.com/docs/guide.html#strict)
  * @param {Function} [callback]
  * @return {Query}
  * @see Model.findOneAndRemove #model_Model.findOneAndRemove
- * @see mongodb http://www.mongodb.org/display/DOCS/findAndModify+Command
+ * @see mongodb https://www.mongodb.org/display/DOCS/findAndModify+Command
  */
 
 Model.findByIdAndDelete = function(id, options, callback) {
@@ -2839,8 +2831,8 @@ Model.findByIdAndDelete = function(id, options, callback) {
  * - `maxTimeMS`: puts a time limit on the query - requires mongodb >= 2.6.0
  * - `select`: sets the document fields to return
  * - `projection`: like select, it determines which fields to return, ex. `{ projection: { _id: 0 } }`
- * - `rawResult`: if true, returns the [raw result from the MongoDB driver](http://mongodb.github.io/node-mongodb-native/2.0/api/Collection.html#findAndModify)
- * - `strict`: overwrites the schema's [strict mode option](http://mongoosejs.com/docs/guide.html#strict) for this update
+ * - `rawResult`: if true, returns the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/2.0/api/Collection.html#findAndModify)
+ * - `strict`: overwrites the schema's [strict mode option](https://mongoosejs.com/docs/guide.html#strict) for this update
  *
  * ####Examples:
  *
@@ -2852,11 +2844,11 @@ Model.findByIdAndDelete = function(id, options, callback) {
  *
  * @param {Object} filter Replace the first document that matches this filter
  * @param {Object} [replacement] Replace with this document
- * @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 {String} [options.returnDocument='before'] Has two possible values, `'before'` and `'after'`. By default, it will return the document before the update was applied.
  * @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 {ClientSession} [options.session=null] The session associated with this query. See [transactions docs](/docs/transactions.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 {Object|String|Array<String>} [options.projection=null] optional fields to return, see [`Query.prototype.select()`](#query_Query-select)
  * @param {Function} [callback]
@@ -2916,8 +2908,8 @@ Model.findOneAndReplace = function(filter, replacement, options, callback) {
  * - `maxTimeMS`: puts a time limit on the query - requires mongodb >= 2.6.0
  * - `select`: sets the document fields to return
  * - `projection`: like select, it determines which fields to return, ex. `{ projection: { _id: 0 } }`
- * - `rawResult`: if true, returns the [raw result from the MongoDB driver](http://mongodb.github.io/node-mongodb-native/2.0/api/Collection.html#findAndModify)
- * - `strict`: overwrites the schema's [strict mode option](http://mongoosejs.com/docs/guide.html#strict) for this update
+ * - `rawResult`: if true, returns the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/2.0/api/Collection.html#findAndModify)
+ * - `strict`: overwrites the schema's [strict mode option](https://mongoosejs.com/docs/guide.html#strict) for this update
  *
  * ####Examples:
  *
@@ -2940,13 +2932,13 @@ Model.findOneAndReplace = function(filter, replacement, options, callback) {
  *     });
  *
  * @param {Object} conditions
- * @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 {ClientSession} [options.session=null] The session associated with this query. See [transactions docs](/docs/transactions.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 {Object|String|Array<String>} [options.projection=null] optional fields to return, see [`Query.prototype.select()`](#query_Query-select)
  * @param {Function} [callback]
  * @return {Query}
- * @see mongodb http://www.mongodb.org/display/DOCS/findAndModify+Command
+ * @see mongodb https://www.mongodb.org/display/DOCS/findAndModify+Command
  * @api public
  */
 
@@ -2994,8 +2986,8 @@ Model.findOneAndRemove = function(conditions, options, callback) {
  *
  * - `sort`: if multiple docs are found by the conditions, sets the sort order to choose which doc to update
  * - `select`: sets the document fields to return
- * - `rawResult`: if true, returns the [raw result from the MongoDB driver](http://mongodb.github.io/node-mongodb-native/2.0/api/Collection.html#findAndModify)
- * - `strict`: overwrites the schema's [strict mode option](http://mongoosejs.com/docs/guide.html#strict) for this update
+ * - `rawResult`: if true, returns the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/2.0/api/Collection.html#findAndModify)
+ * - `strict`: overwrites the schema's [strict mode option](https://mongoosejs.com/docs/guide.html#strict) for this update
  *
  * ####Examples:
  *
@@ -3006,14 +2998,14 @@ Model.findOneAndRemove = function(conditions, options, callback) {
  *     A.findByIdAndRemove()           // returns Query
  *
  * @param {Object|Number|String} id value of `_id` to query by
- * @param {Object} [options] optional see [`Query.prototype.setOptions()`](http://mongoosejs.com/docs/api.html#query_Query-setOptions)
- * @param {Boolean|String} [options.strict] overwrites the schema's [strict mode option](http://mongoosejs.com/docs/guide.html#strict)
+ * @param {Object} [options] optional see [`Query.prototype.setOptions()`](https://mongoosejs.com/docs/api.html#query_Query-setOptions)
+ * @param {Boolean|String} [options.strict] overwrites the schema's [strict mode option](https://mongoosejs.com/docs/guide.html#strict)
  * @param {ClientSession} [options.session=null] The session associated with this query. See [transactions docs](/docs/transactions.html).
  * @param {Object|String|Array<String>} [options.projection=null] optional fields to return, see [`Query.prototype.select()`](#query_Query-select)
  * @param {Function} [callback]
  * @return {Query}
  * @see Model.findOneAndRemove #model_Model.findOneAndRemove
- * @see mongodb http://www.mongodb.org/display/DOCS/findAndModify+Command
+ * @see mongodb https://www.mongodb.org/display/DOCS/findAndModify+Command
  */
 
 Model.findByIdAndRemove = function(id, options, callback) {
@@ -3158,7 +3150,7 @@ Model.create = function create(doc, options, callback) {
         return cb(firstError, savedDocs);
       }
 
-      if (doc instanceof Array) {
+      if (Array.isArray(doc)) {
         cb(null, savedDocs);
       } else {
         cb.apply(this, [null].concat(savedDocs));
@@ -3204,7 +3196,7 @@ Model.create = function create(doc, options, callback) {
  *     await doc.remove();
  *
  * @param {Array} [pipeline]
- * @param {Object} [options] see the [mongodb driver options](http://mongodb.github.io/node-mongodb-native/3.0/api/Collection.html#watch)
+ * @param {Object} [options] see the [mongodb driver options](https://mongodb.github.io/node-mongodb-native/3.0/api/Collection.html#watch)
  * @return {ChangeStream} mongoose-specific change stream wrapper, inherits from EventEmitter
  * @api public
  */
@@ -3235,7 +3227,7 @@ Model.watch = function(pipeline, options) {
 /**
  * _Requires MongoDB >= 3.6.0._ Starts a [MongoDB session](https://docs.mongodb.com/manual/release-notes/3.6/#client-sessions)
  * for benefits like causal consistency, [retryable writes](https://docs.mongodb.com/manual/core/retryable-writes/),
- * and [transactions](http://thecodebarbarian.com/a-node-js-perspective-on-mongodb-4-transactions.html).
+ * and [transactions](https://thecodebarbarian.com/a-node-js-perspective-on-mongodb-4-transactions.html).
  *
  * Calling `MyModel.startSession()` is equivalent to calling `MyModel.db.startSession()`.
  *
@@ -3252,7 +3244,7 @@ Model.watch = function(pipeline, options) {
  *     // secondary that is experiencing replication lag.
  *     doc = await Person.findOne({ name: 'Ned Stark' }, null, { session, readPreference: 'secondary' });
  *
- * @param {Object} [options] see the [mongodb driver options](http://mongodb.github.io/node-mongodb-native/3.0/api/MongoClient.html#startSession)
+ * @param {Object} [options] see the [mongodb driver options](https://mongodb.github.io/node-mongodb-native/3.0/api/MongoClient.html#startSession)
  * @param {Boolean} [options.causalConsistency=true] set to false to disable causal consistency
  * @param {Function} [callback]
  * @return {Promise<ClientSession>} promise that resolves to a MongoDB driver `ClientSession`
@@ -3288,9 +3280,9 @@ Model.startSession = function() {
  *     Movies.insertMany(arr, function(error, docs) {});
  *
  * @param {Array|Object|*} doc(s)
- * @param {Object} [options] see the [mongodb driver options](http://mongodb.github.io/node-mongodb-native/2.2/api/Collection.html#insertMany)
+ * @param {Object} [options] see the [mongodb driver options](https://mongodb.github.io/node-mongodb-native/2.2/api/Collection.html#insertMany)
  * @param {Boolean} [options.ordered = true] if true, will fail fast on the first error encountered. If false, will insert all the documents it can and report errors later. An `insertMany()` with `ordered = false` is called an "unordered" `insertMany()`.
- * @param {Boolean} [options.rawResult = false] if false, the returned promise resolves to the documents that passed mongoose document validation. If `true`, will return the [raw result from the MongoDB driver](http://mongodb.github.io/node-mongodb-native/2.2/api/Collection.html#~insertWriteOpCallback) with a `mongoose` property that contains `validationErrors` if this is an unordered `insertMany`.
+ * @param {Boolean} [options.rawResult = false] if false, the returned promise resolves to the documents that passed mongoose document validation. If `true`, will return the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/2.2/api/Collection.html#~insertWriteOpCallback) with a `mongoose` property that contains `validationErrors` if this is an unordered `insertMany`.
  * @param {Boolean} [options.lean = false] if `true`, skips hydrating and validating the documents. This option is useful if you need the extra performance, but Mongoose won't validate the documents before inserting.
  * @param {Number} [options.limit = null] this limits the number of documents being processed (validation/casting) by mongoose in parallel, this does **NOT** send the documents in batches to MongoDB. Use this option if you're processing a large number of documents and your app is running out of memory.
  * @param {String|Object|Array} [options.populate = null] populates the result documents. This option is a no-op if `rawResult` is set.
@@ -3327,10 +3319,10 @@ Model.$__insertMany = function(arr, options, callback) {
   }
   callback = callback || utils.noop;
   options = options || {};
-  const limit = get(options, 'limit', 1000);
-  const rawResult = get(options, 'rawResult', false);
-  const ordered = get(options, 'ordered', true);
-  const lean = get(options, 'lean', false);
+  const limit = options.limit || 1000;
+  const rawResult = !!options.rawResult;
+  const ordered = typeof options.ordered === 'boolean' ? options.ordered : true;
+  const lean = !!options.lean;
 
   if (!Array.isArray(arr)) {
     arr = [arr];
@@ -3408,12 +3400,12 @@ Model.$__insertMany = function(arr, options, callback) {
         // `writeErrors` is a property reported by the MongoDB driver,
         // just not if there's only 1 error.
         if (error.writeErrors == null &&
-            get(error, 'result.result.writeErrors') != null) {
+           (error.result && error.result.result && error.result.result.writeErrors) != null) {
           error.writeErrors = error.result.result.writeErrors;
         }
 
         // `insertedDocs` is a Mongoose-specific property
-        const erroredIndexes = new Set(get(error, 'writeErrors', []).map(err => err.index));
+        const erroredIndexes = new Set((error && error.writeErrors || []).map(err => err.index));
 
         let firstErroredIndex = -1;
         error.insertedDocs = docAttributes.
@@ -3500,7 +3492,7 @@ function _setIsNew(doc, val) {
  *
  * This function does **not** trigger any middleware, neither `save()`, nor `update()`.
  * If you need to trigger
- * `save()` middleware for every document use [`create()`](http://mongoosejs.com/docs/api.html#model_Model.create) instead.
+ * `save()` middleware for every document use [`create()`](https://mongoosejs.com/docs/api.html#model_Model.create) instead.
  *
  * ####Example:
  *
@@ -3524,9 +3516,7 @@ function _setIsNew(doc, val) {
  *       },
  *       {
  *         deleteOne: {
- *           {
- *             filter: { name: 'Eddard Stark' }
- *           }
+ *           filter: { name: 'Eddard Stark' }
  *         }
  *       }
  *     ]).then(res => {
@@ -3571,7 +3561,7 @@ function _setIsNew(doc, val) {
  * @param {Boolean} [options.bypassDocumentValidation=false] If true, disable [MongoDB server-side schema validation](https://docs.mongodb.com/manual/core/schema-validation/) for all writes in this bulk.
  * @param {Boolean} [options.strict=null] Overwrites the [`strict` option](/docs/guide.html#strict) on schema. If false, allows filtering and writing fields not defined in the schema for all writes in this bulk.
  * @param {Function} [callback] callback `function(error, bulkWriteOpResult) {}`
- * @return {Promise} resolves to a [`BulkWriteOpResult`](http://mongodb.github.io/node-mongodb-native/3.1/api/Collection.html#~BulkWriteOpResult) if the operation succeeds
+ * @return {Promise} resolves to a [`BulkWriteOpResult`](https://mongodb.github.io/node-mongodb-native/3.1/api/Collection.html#~BulkWriteOpResult) if the operation succeeds
  * @api public
  */
 
@@ -3634,7 +3624,7 @@ Model.bulkSave = function(documents, options) {
     .then(() => documents.map(buildSuccessfulWriteHandlerPromise))
     .then(() => bulkWriteResultPromise)
     .catch((err) => {
-      if (!get(err, 'writeErrors.length')) {
+      if (!(err && err.writeErrors && err.writeErrors.length)) {
         throw err;
       }
       return Promise.all(
@@ -3774,6 +3764,13 @@ Model.buildBulkWriteOperations = function buildBulkWriteOperations(documents, op
 Model.hydrate = function(obj, projection) {
   _checkContext(this, 'hydrate');
 
+  if (projection != null) {
+    if (obj != null && obj.$__ != null) {
+      obj = obj.toObject(internalToObjectOptions);
+    }
+    obj = applyProjection(obj, projection);
+  }
+
   const document = require('./queryhelpers').createModel(this, obj, projection);
   document.$init(obj);
   return document;
@@ -3805,7 +3802,7 @@ Model.hydrate = function(obj, projection) {
  *  - `writeConcern` (object): sets the [write concern](https://docs.mongodb.com/manual/reference/write-concern/) for replica sets. Overrides the [schema-level write concern](/docs/guide.html#writeConcern)
  *  - `multi` (boolean): whether multiple documents should be updated (false)
  *  - `runValidators`: if true, runs [update validators](/docs/validation.html#update-validators) on this command. Update validators validate the update operation against the model's schema.
- *  - `setDefaultsOnInsert` (boolean): if this and `upsert` are true, mongoose will apply the [defaults](http://mongoosejs.com/docs/defaults.html) specified in the model's schema if a new document is created. This option only works on MongoDB >= 2.4 because it relies on [MongoDB's `$setOnInsert` operator](https://docs.mongodb.org/v2.4/reference/operator/update/setOnInsert/).
+ *  - `setDefaultsOnInsert` (boolean): if this and `upsert` are true, mongoose will apply the [defaults](https://mongoosejs.com/docs/defaults.html) specified in the model's schema if a new document is created. This option only works on MongoDB >= 2.4 because it relies on [MongoDB's `$setOnInsert` operator](https://docs.mongodb.org/v2.4/reference/operator/update/setOnInsert/).
  *  - `timestamps` (boolean): If set to `false` and [schema-level timestamps](/docs/guide.html#timestamps) are enabled, skip timestamps for this update. Does nothing if schema-level timestamps are not set.
  *  - `overwrite` (boolean): disables update-only mode, allowing you to overwrite the doc (false)
  *
@@ -3836,8 +3833,8 @@ Model.hydrate = function(obj, projection) {
  * Be careful to not use an existing model instance for the update clause (this won't work and can cause weird behavior like infinite loops). Also, ensure that the update clause does not have an _id property, which causes Mongo to return a "Mod on _id not allowed" error.
  *
  * @deprecated
- * @see strict http://mongoosejs.com/docs/guide.html#strict
- * @see response http://docs.mongodb.org/v2.6/reference/command/update/#output
+ * @see strict https://mongoosejs.com/docs/guide.html#strict
+ * @see response https://docs.mongodb.org/v2.6/reference/command/update/#output
  * @param {Object} filter
  * @param {Object} doc
  * @param {Object} [options] optional see [`Query.prototype.setOptions()`](/docs/api.html#query_Query-setOptions)
@@ -3846,7 +3843,7 @@ Model.hydrate = function(obj, projection) {
  * @param {Object} [options.writeConcern=null] sets the [write concern](https://docs.mongodb.com/manual/reference/write-concern/) for replica sets. Overrides the [schema-level write concern](/docs/guide.html#writeConcern)
  * @param {Boolean} [options.multi=false] whether multiple documents should be updated or just the first one that matches `filter`.
  * @param {Boolean} [options.runValidators=false] if true, runs [update validators](/docs/validation.html#update-validators) on this command. Update validators validate the update operation against the model's schema.
- * @param {Boolean} [options.setDefaultsOnInsert=false] `true` by default. If `setDefaultsOnInsert` and `upsert` are true, mongoose will apply the [defaults](http://mongoosejs.com/docs/defaults.html) specified in the model's schema if a new document is created.
+ * @param {Boolean} [options.setDefaultsOnInsert=false] `true` by default. If `setDefaultsOnInsert` and `upsert` are true, mongoose will apply the [defaults](https://mongoosejs.com/docs/defaults.html) specified in the model's schema if a new document is created.
  * @param {Boolean} [options.timestamps=null] If set to `false` and [schema-level timestamps](/docs/guide.html#timestamps) are enabled, skip timestamps for this update. Does nothing if schema-level timestamps are not set.
  * @param {Boolean} [options.overwrite=false] By default, if you don't include any [update operators](https://docs.mongodb.com/manual/reference/operator/update/) in `doc`, Mongoose will wrap `doc` in `$set` for you. This prevents you from accidentally overwriting the document. This option tells Mongoose to skip adding `$set`.
  * @param {Function} [callback] params are (error, [updateWriteOpResult](https://mongodb.github.io/node-mongodb-native/3.6/api/Collection.html#~updateWriteOpResult))
@@ -3886,8 +3883,8 @@ Model.update = function update(conditions, doc, options, callback) {
  *
  * @param {Object} filter
  * @param {Object|Array} update
- * @param {Object} [options] optional see [`Query.prototype.setOptions()`](http://mongoosejs.com/docs/api.html#query_Query-setOptions)
- * @param {Boolean|String} [options.strict] overwrites the schema's [strict mode option](http://mongoosejs.com/docs/guide.html#strict)
+ * @param {Object} [options] optional see [`Query.prototype.setOptions()`](https://mongoosejs.com/docs/api.html#query_Query-setOptions)
+ * @param {Boolean|String} [options.strict] overwrites the schema's [strict mode option](https://mongoosejs.com/docs/guide.html#strict)
  * @param {Boolean} [options.upsert=false] if true, and no documents found, insert a new document
  * @param {Object} [options.writeConcern=null] sets the [write concern](https://docs.mongodb.com/manual/reference/write-concern/) for replica sets. Overrides the [schema-level write concern](/docs/guide.html#writeConcern)
  * @param {Boolean} [options.timestamps=null] If set to `false` and [schema-level timestamps](/docs/guide.html#timestamps) are enabled, skip timestamps for this update. Does nothing if schema-level timestamps are not set.
@@ -3895,7 +3892,7 @@ Model.update = function update(conditions, doc, options, callback) {
  * @return {Query}
  * @see Query docs https://mongoosejs.com/docs/queries.html
  * @see MongoDB docs https://docs.mongodb.com/manual/reference/command/update/#update-command-output
- * @see writeOpResult http://mongodb.github.io/node-mongodb-native/2.2/api/Collection.html#~WriteOpResult
+ * @see writeOpResult https://mongodb.github.io/node-mongodb-native/2.2/api/Collection.html#~WriteOpResult
  * @api public
  */
 
@@ -3926,8 +3923,8 @@ Model.updateMany = function updateMany(conditions, doc, options, callback) {
  *
  * @param {Object} filter
  * @param {Object|Array} update
- * @param {Object} [options] optional see [`Query.prototype.setOptions()`](http://mongoosejs.com/docs/api.html#query_Query-setOptions)
- * @param {Boolean|String} [options.strict] overwrites the schema's [strict mode option](http://mongoosejs.com/docs/guide.html#strict)
+ * @param {Object} [options] optional see [`Query.prototype.setOptions()`](https://mongoosejs.com/docs/api.html#query_Query-setOptions)
+ * @param {Boolean|String} [options.strict] overwrites the schema's [strict mode option](https://mongoosejs.com/docs/guide.html#strict)
  * @param {Boolean} [options.upsert=false] if true, and no documents found, insert a new document
  * @param {Object} [options.writeConcern=null] sets the [write concern](https://docs.mongodb.com/manual/reference/write-concern/) for replica sets. Overrides the [schema-level write concern](/docs/guide.html#writeConcern)
  * @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.
@@ -3935,7 +3932,7 @@ Model.updateMany = function updateMany(conditions, doc, options, callback) {
  * @return {Query}
  * @see Query docs https://mongoosejs.com/docs/queries.html
  * @see MongoDB docs https://docs.mongodb.com/manual/reference/command/update/#update-command-output
- * @see writeOpResult http://mongodb.github.io/node-mongodb-native/2.2/api/Collection.html#~WriteOpResult
+ * @see writeOpResult https://mongodb.github.io/node-mongodb-native/2.2/api/Collection.html#~WriteOpResult
  * @api public
  */
 
@@ -3963,15 +3960,15 @@ Model.updateOne = function updateOne(conditions, doc, options, callback) {
  *
  * @param {Object} filter
  * @param {Object} doc
- * @param {Object} [options] optional see [`Query.prototype.setOptions()`](http://mongoosejs.com/docs/api.html#query_Query-setOptions)
- * @param {Boolean|String} [options.strict] overwrites the schema's [strict mode option](http://mongoosejs.com/docs/guide.html#strict)
+ * @param {Object} [options] optional see [`Query.prototype.setOptions()`](https://mongoosejs.com/docs/api.html#query_Query-setOptions)
+ * @param {Boolean|String} [options.strict] overwrites the schema's [strict mode option](https://mongoosejs.com/docs/guide.html#strict)
  * @param {Boolean} [options.upsert=false] if true, and no documents found, insert a new document
  * @param {Object} [options.writeConcern=null] sets the [write concern](https://docs.mongodb.com/manual/reference/write-concern/) for replica sets. Overrides the [schema-level write concern](/docs/guide.html#writeConcern)
  * @param {Boolean} [options.timestamps=null] If set to `false` and [schema-level timestamps](/docs/guide.html#timestamps) are enabled, skip timestamps for this update. Does nothing if schema-level timestamps are not set.
  * @param {Function} [callback] `function(error, res) {}` where `res` has 3 properties: `n`, `nModified`, `ok`.
  * @return {Query}
  * @see Query docs https://mongoosejs.com/docs/queries.html
- * @see writeOpResult http://mongodb.github.io/node-mongodb-native/2.2/api/Collection.html#~WriteOpResult
+ * @see writeOpResult https://mongodb.github.io/node-mongodb-native/2.2/api/Collection.html#~WriteOpResult
  * @return {Query}
  * @api public
  */
@@ -3979,7 +3976,7 @@ Model.updateOne = function updateOne(conditions, doc, options, callback) {
 Model.replaceOne = function replaceOne(conditions, doc, options, callback) {
   _checkContext(this, 'replaceOne');
 
-  const versionKey = get(this, 'schema.options.versionKey', null);
+  const versionKey = this && this.schema && this.schema.options && this.schema.options.versionKey || null;
   if (versionKey && !doc[versionKey]) {
     doc[versionKey] = 0;
   }
@@ -4004,7 +4001,10 @@ function _update(model, op, conditions, doc, options, callback) {
   }
   options = typeof options === 'function' ? options : utils.clone(options);
 
-  const versionKey = get(model, 'schema.options.versionKey', null);
+  const versionKey = model &&
+  model.schema &&
+  model.schema.options &&
+  model.schema.options.versionKey || null;
   _decorateUpdateWithVersionKey(doc, options, versionKey);
 
   return mq[op](conditions, doc, options, callback);
@@ -4013,7 +4013,7 @@ function _update(model, op, conditions, doc, options, callback) {
 /**
  * Executes a mapReduce command.
  *
- * `o` is an object specifying all mapReduce options as well as the map and reduce functions. All options are delegated to the driver implementation. See [node-mongodb-native mapReduce() documentation](http://mongodb.github.io/node-mongodb-native/api-generated/collection.html#mapreduce) for more detail about options.
+ * `o` is an object specifying all mapReduce options as well as the map and reduce functions. All options are delegated to the driver implementation. See [node-mongodb-native mapReduce() documentation](https://mongodb.github.io/node-mongodb-native/api-generated/collection.html#mapreduce) for more detail about options.
  *
  * This function does not trigger any middleware.
  *
@@ -4082,7 +4082,7 @@ function _update(model, op, conditions, doc, options, callback) {
  *
  * @param {Object} o an object specifying map-reduce options
  * @param {Function} [callback] optional callback
- * @see http://www.mongodb.org/display/DOCS/MapReduce
+ * @see https://www.mongodb.org/display/DOCS/MapReduce
  * @return {Promise}
  * @api public
  */
@@ -4135,7 +4135,7 @@ Model.mapReduce = function mapReduce(o, callback) {
 };
 
 /**
- * Performs [aggregations](http://docs.mongodb.org/manual/applications/aggregation/) on the models collection.
+ * Performs [aggregations](https://docs.mongodb.org/manual/applications/aggregation/) on the models collection.
  *
  * If a `callback` is passed, the `aggregate` is executed and a `Promise` is returned. If a callback is not passed, the `aggregate` itself is returned.
  *
@@ -4169,10 +4169,10 @@ Model.mapReduce = function mapReduce(o, callback) {
  *
  * - [Mongoose `Aggregate`](/docs/api/aggregate.html)
  * - [An Introduction to Mongoose Aggregate](https://masteringjs.io/tutorials/mongoose/aggregate)
- * - [MongoDB Aggregation docs](http://docs.mongodb.org/manual/applications/aggregation/)
+ * - [MongoDB Aggregation docs](https://docs.mongodb.org/manual/applications/aggregation/)
  *
  * @see Aggregate #aggregate_Aggregate
- * @see MongoDB http://docs.mongodb.org/manual/applications/aggregation/
+ * @see MongoDB https://docs.mongodb.org/manual/applications/aggregation/
  * @param {Array} [pipeline] aggregation pipeline as an array of objects
  * @param {Object} [options] aggregation options
  * @param {Function} [callback]
@@ -4183,7 +4183,7 @@ Model.mapReduce = function mapReduce(o, callback) {
 Model.aggregate = function aggregate(pipeline, options, callback) {
   _checkContext(this, 'aggregate');
 
-  if (arguments.length > 3 || get(pipeline, 'constructor.name') === 'Object') {
+  if (arguments.length > 3 || (pipeline && pipeline.constructor && pipeline.constructor.name) === 'Object') {
     throw new MongooseError('Mongoose 5.x disallows passing a spread of operators ' +
       'to `Model.aggregate()`. Instead of ' +
       '`Model.aggregate({ $match }, { $skip })`, do ' +
@@ -4391,6 +4391,7 @@ Model.validate = function validate(obj, pathsToValidate, context, callback) {
  * @param {Document|Array} docs Either a single document or array of documents to populate.
  * @param {Object|String} options Either the paths to populate or an object specifying all parameters
  * @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.
@@ -4506,7 +4507,10 @@ function populate(model, docs, options, callback) {
     ids = utils.array.unique(ids);
 
     const assignmentOpts = {};
-    assignmentOpts.sort = get(mod, 'options.options.sort', void 0);
+    assignmentOpts.sort = mod &&
+      mod.options &&
+      mod.options.options &&
+      mod.options.options.sort || void 0;
     assignmentOpts.excludeId = excludeIdReg.test(select) || (select && select._id === 0);
 
     if (ids.length === 0 || ids.every(utils.isNullOrUndefined)) {
@@ -4675,7 +4679,9 @@ function _assign(model, vals, mod, assignmentOpts) {
   const isVirtual = mod.isVirtual;
   const justOne = mod.justOne;
   let _val;
-  const lean = get(options, 'options.lean', false);
+  const lean = options &&
+    options.options &&
+    options.options.lean || false;
   const len = vals.length;
   const rawOrder = {};
   const rawDocs = {};
@@ -4746,7 +4752,7 @@ function _assign(model, vals, mod, assignmentOpts) {
       }
       // flag each as result of population
       if (!lean) {
-        val.$__.wasPopulated = true;
+        val.$__.wasPopulated = val.$__.wasPopulated || true;
       }
     }
   }