mongoose 6.9.0 → 6.9.2

package/lib/aggregate.js

@@ -42,7 +42,7 @@ const validRedactStringValues = new Set(['$$DESCEND', '$$PRUNE', '$$KEEP']);
  *     // Do this instead to cast to an ObjectId
  *     new Aggregate([{ $match: { _id: new mongoose.Types.ObjectId('00000000000000000000000a') } }]);
  *
- * @see MongoDB https://docs.mongodb.org/manual/applications/aggregation/
+ * @see MongoDB https://www.mongodb.com/docs/manual/applications/aggregation/
  * @see driver https://mongodb.github.io/node-mongodb-native/4.9/classes/Collection.html#aggregate
  * @param {Array} [pipeline] aggregation pipeline as an array of objects
  * @param {Model} [model] the model to use with this aggregate.
@@ -60,23 +60,23 @@ function Aggregate(pipeline, model) {
 }
 
 /**
- * Contains options passed down to the [aggregate command](https://docs.mongodb.com/manual/reference/command/aggregate/).
+ * Contains options passed down to the [aggregate command](https://www.mongodb.com/docs/manual/reference/command/aggregate/).
  * Supported options are:
  *
- * - [`allowDiskUse`](./api/aggregate.html#aggregate_Aggregate-allowDiskUse)
+ * - [`allowDiskUse`](#aggregate_Aggregate-allowDiskUse)
  * - `bypassDocumentValidation`
- * - [`collation`](./api/aggregate.html#aggregate_Aggregate-collation)
+ * - [`collation`](#aggregate_Aggregate-collation)
  * - `comment`
- * - [`cursor`](./api/aggregate.html#aggregate_Aggregate-cursor)
- * - [`explain`](./api/aggregate.html#aggregate_Aggregate-explain)
+ * - [`cursor`](#aggregate_Aggregate-cursor)
+ * - [`explain`](#aggregate_Aggregate-explain)
  * - `fieldsAsRaw`
- * - `hint`
+ * - [`hint`](#aggregate_Aggregate-hint)
  * - `let`
  * - `maxTimeMS`
  * - `raw`
- * - `readConcern`
+ * - [`readConcern`](#aggregate_Aggregate-readConcern)
  * - `readPreference`
- * - [`session`](./api/aggregate.html#aggregate_Aggregate-session)
+ * - [`session`](#aggregate_Aggregate-session)
  * - `writeConcern`
  *
  * @property options
@@ -172,7 +172,7 @@ Aggregate.prototype.append = function() {
  *     aggregate.addFields({ salary_k: { $divide: [ "$salary", 1000 ] } });
  *
  * @param {Object} arg field specification
- * @see $addFields https://docs.mongodb.com/manual/reference/operator/aggregation/addFields/
+ * @see $addFields https://www.mongodb.com/docs/manual/reference/operator/aggregation/addFields/
  * @return {Aggregate}
  * @api public
  */
@@ -210,7 +210,7 @@ Aggregate.prototype.addFields = function(arg) {
  *     aggregate.project({ salary_k: { $divide: [ "$salary", 1000 ] } });
  *
  * @param {Object|String} arg field specification
- * @see projection https://docs.mongodb.org/manual/reference/aggregation/project/
+ * @see projection https://www.mongodb.com/docs/manual/reference/aggregation/project/
  * @return {Aggregate}
  * @api public
  */
@@ -247,7 +247,7 @@ Aggregate.prototype.project = function(arg) {
  *
  *     aggregate.group({ _id: "$department" });
  *
- * @see $group https://docs.mongodb.org/manual/reference/aggregation/group/
+ * @see $group https://www.mongodb.com/docs/manual/reference/aggregation/group/
  * @method group
  * @memberOf Aggregate
  * @instance
@@ -263,7 +263,7 @@ Aggregate.prototype.project = function(arg) {
  *
  *     aggregate.match({ department: { $in: [ "sales", "engineering" ] } });
  *
- * @see $match https://docs.mongodb.org/manual/reference/aggregation/match/
+ * @see $match https://www.mongodb.com/docs/manual/reference/aggregation/match/
  * @method match
  * @memberOf Aggregate
  * @instance
@@ -279,7 +279,7 @@ Aggregate.prototype.project = function(arg) {
  *
  *     aggregate.skip(10);
  *
- * @see $skip https://docs.mongodb.org/manual/reference/aggregation/skip/
+ * @see $skip https://www.mongodb.com/docs/manual/reference/aggregation/skip/
  * @method skip
  * @memberOf Aggregate
  * @instance
@@ -295,7 +295,7 @@ Aggregate.prototype.project = function(arg) {
  *
  *     aggregate.limit(10);
  *
- * @see $limit https://docs.mongodb.org/manual/reference/aggregation/limit/
+ * @see $limit https://www.mongodb.com/docs/manual/reference/aggregation/limit/
  * @method limit
  * @memberOf Aggregate
  * @instance
@@ -360,16 +360,15 @@ Aggregate.prototype.project = function(arg) {
  * #### Example:
  *
  *     aggregate.near({
- *       near: [40.724, -73.997],
+ *       near: { type: 'Point', coordinates: [40.724, -73.997] },
  *       distanceField: "dist.calculated", // required
  *       maxDistance: 0.008,
  *       query: { type: "public" },
  *       includeLocs: "dist.location",
- *       uniqueDocs: true,
- *       num: 5
+ *       spherical: true,
  *     });
  *
- * @see $geoNear https://docs.mongodb.org/manual/reference/aggregation/geoNear/
+ * @see $geoNear https://www.mongodb.com/docs/manual/reference/aggregation/geoNear/
  * @method near
  * @memberOf Aggregate
  * @instance
@@ -408,8 +407,8 @@ Aggregate.prototype.near = function(arg) {
  *     aggregate.unwind("a", "b", "c");
  *     aggregate.unwind({ path: '$tags', preserveNullAndEmptyArrays: true });
  *
- * @see $unwind https://docs.mongodb.org/manual/reference/aggregation/unwind/
- * @param {String|Object|String[]|Object[]} fields the field(s) to unwind, either as field names or as [objects with options](https://docs.mongodb.com/manual/reference/operator/aggregation/unwind/#document-operand-with-options). If passing a string, prefixing the field name with '$' is optional. If passing an object, `path` must start with '$'.
+ * @see $unwind https://www.mongodb.com/docs/manual/reference/aggregation/unwind/
+ * @param {String|Object|String[]|Object[]} fields the field(s) to unwind, either as field names or as [objects with options](https://www.mongodb.com/docs/manual/reference/operator/aggregation/unwind/#document-operand-with-options). If passing a string, prefixing the field name with '$' is optional. If passing an object, `path` must start with '$'.
  * @return {Aggregate}
  * @api public
  */
@@ -447,7 +446,7 @@ Aggregate.prototype.unwind = function() {
  *
  *     aggregate.replaceRoot({ x: { $concat: ['$this', '$that'] } });
  *
- * @see $replaceRoot https://docs.mongodb.org/manual/reference/operator/aggregation/replaceRoot
+ * @see $replaceRoot https://www.mongodb.com/docs/manual/reference/operator/aggregation/replaceRoot
  * @param {String|Object} newRoot the field or document which will become the new root document
  * @return {Aggregate}
  * @api public
@@ -476,7 +475,7 @@ Aggregate.prototype.replaceRoot = function(newRoot) {
  *
  *     aggregate.count("userCount");
  *
- * @see $count https://docs.mongodb.org/manual/reference/operator/aggregation/count
+ * @see $count https://www.mongodb.com/docs/manual/reference/operator/aggregation/count
  * @param {String} fieldName The name of the output field which has the count as its value. It must be a non-empty string, must not start with $ and must not contain the . character.
  * @return {Aggregate}
  * @api public
@@ -498,7 +497,7 @@ Aggregate.prototype.count = function(fieldName) {
  *     aggregate.sortByCount('users');
  *     aggregate.sortByCount({ $mergeObjects: [ "$employee", "$business" ] })
  *
- * @see $sortByCount https://docs.mongodb.com/manual/reference/operator/aggregation/sortByCount/
+ * @see $sortByCount https://www.mongodb.com/docs/manual/reference/operator/aggregation/sortByCount/
  * @param {Object|String} arg
  * @return {Aggregate} this
  * @api public
@@ -524,7 +523,7 @@ Aggregate.prototype.sortByCount = function(arg) {
  *
  *     aggregate.lookup({ from: 'users', localField: 'userId', foreignField: '_id', as: 'users' });
  *
- * @see $lookup https://docs.mongodb.org/manual/reference/operator/aggregation/lookup/#pipe._S_lookup
+ * @see $lookup https://www.mongodb.com/docs/manual/reference/operator/aggregation/lookup/#pipe._S_lookup
  * @param {Object} options to $lookup as described in the above link
  * @return {Aggregate}
  * @api public
@@ -544,7 +543,7 @@ Aggregate.prototype.lookup = function(options) {
  *      // Suppose we have a collection of courses, where a document might look like `{ _id: 0, name: 'Calculus', prerequisite: 'Trigonometry'}` and `{ _id: 0, name: 'Trigonometry', prerequisite: 'Algebra' }`
  *      aggregate.graphLookup({ from: 'courses', startWith: '$prerequisite', connectFromField: 'prerequisite', connectToField: 'name', as: 'prerequisites', maxDepth: 3 }) // this will recursively search the 'courses' collection up to 3 prerequisites
  *
- * @see $graphLookup https://docs.mongodb.com/manual/reference/operator/aggregation/graphLookup/#pipe._S_graphLookup
+ * @see $graphLookup https://www.mongodb.com/docs/manual/reference/operator/aggregation/graphLookup/#pipe._S_graphLookup
  * @param {Object} options to $graphLookup as described in the above link
  * @return {Aggregate}
  * @api public
@@ -577,7 +576,7 @@ Aggregate.prototype.graphLookup = function(options) {
  *
  *     aggregate.sample(3); // Add a pipeline that picks 3 random documents
  *
- * @see $sample https://docs.mongodb.org/manual/reference/operator/aggregation/sample/#pipe._S_sample
+ * @see $sample https://www.mongodb.com/docs/manual/reference/operator/aggregation/sample/#pipe._S_sample
  * @param {Number} size number of random documents to pick
  * @return {Aggregate}
  * @api public
@@ -600,7 +599,7 @@ Aggregate.prototype.sample = function(size) {
  *     aggregate.sort({ field: 'asc', test: -1 });
  *     aggregate.sort('field -test');
  *
- * @see $sort https://docs.mongodb.org/manual/reference/aggregation/sort/
+ * @see $sort https://www.mongodb.com/docs/manual/reference/aggregation/sort/
  * @param {Object|String} arg
  * @return {Aggregate} this
  * @api public
@@ -646,7 +645,7 @@ Aggregate.prototype.sort = function(arg) {
  *
  *     aggregate.unionWith({ coll: 'users', pipeline: [ { $match: { _id: 1 } } ] });
  *
- * @see $unionWith https://docs.mongodb.com/manual/reference/operator/aggregation/unionWith
+ * @see $unionWith https://www.mongodb.com/docs/manual/reference/operator/aggregation/unionWith
  * @param {Object} options to $unionWith query as described in the above link
  * @return {Aggregate}
  * @api public
@@ -668,7 +667,7 @@ Aggregate.prototype.unionWith = function(options) {
  * @param {Array} [tags] optional tags for this query. DEPRECATED
  * @return {Aggregate} this
  * @api public
- * @see mongodb https://docs.mongodb.org/manual/applications/replication/#read-preference
+ * @see mongodb https://www.mongodb.com/docs/manual/applications/replication/#read-preference
  */
 
 Aggregate.prototype.read = function(pref, tags) {
@@ -684,7 +683,7 @@ Aggregate.prototype.read = function(pref, tags) {
  *     await Model.aggregate(pipeline).readConcern('majority');
  *
  * @param {String} level one of the listed read concern level or their aliases
- * @see mongodb https://docs.mongodb.com/manual/reference/read-concern/
+ * @see mongodb https://www.mongodb.com/docs/manual/reference/read-concern/
  * @return {Aggregate} this
  * @api public
  */
@@ -717,7 +716,7 @@ Aggregate.prototype.readConcern = function(level) {
  * @param {String|Object} [thenExpr] true case for the condition
  * @param {String|Object} [elseExpr] false case for the condition
  * @return {Aggregate} this
- * @see $redact https://docs.mongodb.com/manual/reference/operator/aggregation/redact/
+ * @see $redact https://www.mongodb.com/docs/manual/reference/operator/aggregation/redact/
  * @api public
  */
 
@@ -819,7 +818,7 @@ Aggregate.prototype.explain = function(verbosity, callback) {
  *
  * @param {Boolean} value Should tell server it can use hard drive to store data during aggregation.
  * @return {Aggregate} this
- * @see mongodb https://docs.mongodb.org/manual/reference/command/aggregate/
+ * @see mongodb https://www.mongodb.com/docs/manual/reference/command/aggregate/
  */
 
 Aggregate.prototype.allowDiskUse = function(value) {
@@ -836,7 +835,7 @@ Aggregate.prototype.allowDiskUse = function(value) {
  *
  * @param {Object|String} value a hint object or the index name
  * @return {Aggregate} this
- * @see mongodb https://docs.mongodb.org/manual/reference/command/aggregate/
+ * @see mongodb https://www.mongodb.com/docs/manual/reference/command/aggregate/
  */
 
 Aggregate.prototype.hint = function(value) {
@@ -854,7 +853,7 @@ Aggregate.prototype.hint = function(value) {
  *
  * @param {ClientSession} session
  * @return {Aggregate} this
- * @see mongodb https://docs.mongodb.org/manual/reference/command/aggregate/
+ * @see mongodb https://www.mongodb.com/docs/manual/reference/command/aggregate/
  */
 
 Aggregate.prototype.session = function(session) {
@@ -875,11 +874,11 @@ Aggregate.prototype.session = function(session) {
  *     agg.options; // `{ allowDiskUse: true }`
  *
  * @param {Object} options keys to merge into current options
- * @param {Number} [options.maxTimeMS] number limits the time this aggregation will run, see [MongoDB docs on `maxTimeMS`](https://docs.mongodb.com/manual/reference/operator/meta/maxTimeMS/)
+ * @param {Number} [options.maxTimeMS] number limits the time this aggregation will run, see [MongoDB docs on `maxTimeMS`](https://www.mongodb.com/docs/manual/reference/operator/meta/maxTimeMS/)
  * @param {Boolean} [options.allowDiskUse] boolean if true, the MongoDB server will use the hard drive to store data during this aggregation
- * @param {Object} [options.collation] object see [`Aggregate.prototype.collation()`](./docs/api/aggregate.html#aggregate_Aggregate-collation)
- * @param {ClientSession} [options.session] ClientSession see [`Aggregate.prototype.session()`](./docs/api/aggregate.html#aggregate_Aggregate-session)
- * @see mongodb https://docs.mongodb.org/manual/reference/command/aggregate/
+ * @param {Object} [options.collation] object see [`Aggregate.prototype.collation()`](#aggregate_Aggregate-collation)
+ * @param {ClientSession} [options.session] ClientSession see [`Aggregate.prototype.session()`](#aggregate_Aggregate-session)
+ * @see mongodb https://www.mongodb.com/docs/manual/reference/command/aggregate/
  * @return {Aggregate} this
  * @api public
  */
@@ -948,7 +947,7 @@ Aggregate.prototype.collation = function(collation) {
  *
  * @param {Object} facet options
  * @return {Aggregate} this
- * @see $facet https://docs.mongodb.com/v3.4/reference/operator/aggregation/facet/
+ * @see $facet https://www.mongodb.com/docs/manual/reference/operator/aggregation/facet/
  * @api public
  */
 
@@ -957,7 +956,7 @@ Aggregate.prototype.facet = function(options) {
 };
 
 /**
- * Helper for [Atlas Text Search](https://docs.atlas.mongodb.com/reference/atlas-search/tutorial/)'s
+ * Helper for [Atlas Text Search](https://www.mongodb.com/docs/atlas/atlas-search/tutorial/)'s
  * `$search` stage.
  *
  * #### Example:
@@ -974,7 +973,7 @@ Aggregate.prototype.facet = function(options) {
  *
  * @param {Object} $search options
  * @return {Aggregate} this
- * @see $search https://docs.atlas.mongodb.com/reference/atlas-search/tutorial/
+ * @see $search https://www.mongodb.com/docs/atlas/atlas-search/tutorial/
  * @api public
  */
 

package/lib/connection.js

@@ -72,7 +72,7 @@ function Connection(base) {
   if (typeof base === 'undefined' || !base.connections.length) {
     this.id = 0;
   } else {
-    this.id = base.connections.length;
+    this.id = base.nextConnectionId;
   }
   this._queue = [];
 }
@@ -385,8 +385,8 @@ Connection.prototype.config;
 
 /**
  * Helper for `createCollection()`. Will explicitly create the given collection
- * with specified options. Used to create [capped collections](https://docs.mongodb.com/manual/core/capped-collections/)
- * and [views](https://docs.mongodb.com/manual/core/views/) from mongoose.
+ * with specified options. Used to create [capped collections](https://www.mongodb.com/docs/manual/core/capped-collections/)
+ * and [views](https://www.mongodb.com/docs/manual/core/views/) from mongoose.
  *
  * Options are passed down without modification to the [MongoDB driver's `createCollection()` function](https://mongodb.github.io/node-mongodb-native/4.9/classes/Db.html#createCollection)
  *
@@ -407,8 +407,8 @@ Connection.prototype.createCollection = _wrapConnHelper(function createCollectio
 });
 
 /**
- * _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/),
+ * _Requires MongoDB >= 3.6.0._ Starts a [MongoDB session](https://www.mongodb.com/docs/manual/release-notes/3.6/#client-sessions)
+ * for benefits like causal consistency, [retryable writes](https://www.mongodb.com/docs/manual/core/retryable-writes/),
  * and [transactions](https://thecodebarbarian.com/a-node-js-perspective-on-mongodb-4-transactions.html).
  *
  * #### Example:
@@ -1118,7 +1118,7 @@ Connection.prototype.collection = function(name, options) {
  * @param {Function} fn plugin callback
  * @param {Object} [opts] optional options
  * @return {Connection} this
- * @see plugins /docs/plugins
+ * @see plugins /docs/plugins.html
  * @api public
  */
 

package/lib/cursor/AggregationCursor.js

@@ -26,7 +26,7 @@ const util = require('util');
  * Use [`Aggregate#cursor()`](/docs/api/aggregate.html#aggregate_Aggregate-cursor) instead.
  *
  * @param {Aggregate} agg
- * @inherits Readable
+ * @inherits Readable https://nodejs.org/api/stream.html#class-streamreadable
  * @event `cursor`: Emitted when the cursor is created
  * @event `error`: Emitted when an error occurred
  * @event `data`: Emitted when the stream is flowing and the next doc is ready

package/lib/cursor/QueryCursor.js

@@ -25,7 +25,7 @@ const util = require('util');
  *
  * @param {Query} query
  * @param {Object} options query options passed to `.find()`
- * @inherits Readable
+ * @inherits Readable https://nodejs.org/api/stream.html#class-streamreadable
  * @event `cursor`: Emitted when the cursor is created
  * @event `error`: Emitted when an error occurred
  * @event `data`: Emitted when the stream is flowing and the next doc is ready

package/lib/document.js

@@ -1621,7 +1621,7 @@ Document.prototype.$__shouldModify = function(pathToMark, path, options, constru
     return false;
   }
 
-  if (!deepEqual(val, priorVal || utils.getValue(path, this))) {
+  if (!deepEqual(val, priorVal !== undefined ? priorVal : utils.getValue(path, this))) {
     return true;
   }
 
@@ -3211,8 +3211,8 @@ function _checkImmutableSubpaths(subdoc, schematype, priorVal) {
 }
 
 /**
- * Saves this document by inserting a new document into the database if [document.isNew](/docs/api/document.html#document_Document-isNew) is `true`,
- * or sends an [updateOne](/docs/api/document.html#document_Document-updateOne) operation **only** with the modifications to the database, it does not replace the whole document in the latter case.
+ * Saves this document by inserting a new document into the database if [document.isNew](#document_Document-isNew) is `true`,
+ * or sends an [updateOne](#document_Document-updateOne) operation **only** with the modifications to the database, it does not replace the whole document in the latter case.
  *
  * #### Example:
  *
@@ -3228,20 +3228,20 @@ function _checkImmutableSubpaths(subdoc, schematype, priorVal) {
  *     newProduct === product; // true
  *
  * @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/document.html#document_Document-$session).
+ * @param {Session} [options.session=null] the [session](https://www.mongodb.com/docs/manual/reference/server-sessions/) associated with this save operation. If not specified, defaults to the [document's associated session](#document_Document-$session).
  * @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)
- * @param {Boolean} [options.j] set to true for MongoDB to wait until this `save()` has been [journaled before resolving the returned promise](https://docs.mongodb.com/manual/reference/write-concern/#j-option). Overrides the [schema-level `writeConcern` option](/docs/guide.html#writeConcern)
- * @param {Number} [options.wtimeout] sets a [timeout for the write concern](https://docs.mongodb.com/manual/reference/write-concern/#wtimeout). Overrides the [schema-level `writeConcern` option](/docs/guide.html#writeConcern).
- * @param {Boolean} [options.checkKeys=true] the MongoDB driver prevents you from saving keys that start with '$' or contain '.' by default. Set this option to `false` to skip that check. See [restrictions on field names](https://docs.mongodb.com/manual/reference/limits/#Restrictions-on-Field-Names)
- * @param {Boolean} [options.timestamps=true] if `false` and [timestamps](./guide.html#timestamps) are enabled, skip timestamps for this `save()`.
+ * @param {Number|String} [options.w] set the [write concern](https://www.mongodb.com/docs/manual/reference/write-concern/#w-option). Overrides the [schema-level `writeConcern` option](/docs/guide.html#writeConcern)
+ * @param {Boolean} [options.j] set to true for MongoDB to wait until this `save()` has been [journaled before resolving the returned promise](https://www.mongodb.com/docs/manual/reference/write-concern/#j-option). Overrides the [schema-level `writeConcern` option](/docs/guide.html#writeConcern)
+ * @param {Number} [options.wtimeout] sets a [timeout for the write concern](https://www.mongodb.com/docs/manual/reference/write-concern/#wtimeout). Overrides the [schema-level `writeConcern` option](/docs/guide.html#writeConcern).
+ * @param {Boolean} [options.checkKeys=true] the MongoDB driver prevents you from saving keys that start with '$' or contain '.' by default. Set this option to `false` to skip that check. See [restrictions on field names](https://www.mongodb.com/docs/manual/reference/limits/#Restrictions-on-Field-Names)
+ * @param {Boolean} [options.timestamps=true] if `false` and [timestamps](/docs/guide.html#timestamps) are enabled, skip timestamps for this `save()`.
  * @param {Function} [fn] optional callback
  * @method save
  * @memberOf Document
  * @instance
- * @throws {DocumentNotFoundError} if this [save updates an existing document](api/document.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).
+ * @throws {DocumentNotFoundError} if this [save updates an existing document](#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 https://mongoosejs.com/docs/middleware.html
@@ -4322,11 +4322,11 @@ Document.prototype.equals = function(doc) {
  * @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.
- * @param {Object|Function} [options.match=null] Add an additional filter to the populate query. Can be a filter object containing [MongoDB query syntax](https://docs.mongodb.com/manual/tutorial/query-documents/), or a function that returns a filter object.
+ * @param {Object|Function} [options.match=null] Add an additional filter to the populate query. Can be a filter object containing [MongoDB query syntax](https://www.mongodb.com/docs/manual/tutorial/query-documents/), or a function that returns a filter object.
  * @param {Function} [options.transform=null] Function that Mongoose will call on every populated document that allows you to transform the populated document.
  * @param {Object} [options.options=null] Additional options like `limit` and `lean`.
  * @param {Function} [callback] Callback
- * @see population /docs/populate
+ * @see population /docs/populate.html
  * @see Query#select #query_Query-select
  * @see Model.populate #model_Model-populate
  * @memberOf Document

package/lib/drivers/node-mongodb-native/collection.js

@@ -17,7 +17,7 @@ const util = require('util');
  *
  * All methods methods from the [node-mongodb-native](https://github.com/mongodb/node-mongodb-native) driver are copied and wrapped in queue management.
  *
- * @inherits Collection
+ * @inherits Collection https://mongodb.github.io/node-mongodb-native/4.9/classes/Collection.html
  * @api private
  */
 

package/lib/error/index.js

@@ -25,19 +25,19 @@ const MongooseError = require('./mongooseError');
  *
  * - `MongooseError`: general Mongoose error
  * - `CastError`: Mongoose could not convert a value to the type defined in the schema path. May be in a `ValidationError` class' `errors` property.
- * - `DisconnectedError`: This [connection](connections.html) timed out in trying to reconnect to MongoDB and will not successfully reconnect to MongoDB unless you explicitly reconnect.
+ * - `DisconnectedError`: This [connection](/docs/connections.html) timed out in trying to reconnect to MongoDB and will not successfully reconnect to MongoDB unless you explicitly reconnect.
  * - `DivergentArrayError`: You attempted to `save()` an array that was modified after you loaded it with a `$elemMatch` or similar projection
- * - `MissingSchemaError`: You tried to access a model with [`mongoose.model()`](api/mongoose.html#mongoose_Mongoose-model) that was not defined
- * - `DocumentNotFoundError`: The document you tried to [`save()`](api/document.html#document_Document-save) was not found
+ * - `MissingSchemaError`: You tried to access a model with [`mongoose.model()`](mongoose.html#mongoose_Mongoose-model) that was not defined
+ * - `DocumentNotFoundError`: The document you tried to [`save()`](document.html#document_Document-save) was not found
  * - `ValidatorError`: error from an individual schema path's validator
- * - `ValidationError`: error returned from [`validate()`](api/document.html#document_Document-validate) or [`validateSync()`](api/document.html#document_Document-validateSync). Contains zero or more `ValidatorError` instances in `.errors` property.
+ * - `ValidationError`: error returned from [`validate()`](document.html#document_Document-validate) or [`validateSync()`](document.html#document_Document-validateSync). Contains zero or more `ValidatorError` instances in `.errors` property.
  * - `MissingSchemaError`: You called `mongoose.Document()` without a schema
- * - `ObjectExpectedError`: Thrown when you set a nested path to a non-object value with [strict mode set](guide.html#strict).
+ * - `ObjectExpectedError`: Thrown when you set a nested path to a non-object value with [strict mode set](/docs/guide.html#strict).
  * - `ObjectParameterError`: Thrown when you pass a non-object value to a function which expects an object as a paramter
- * - `OverwriteModelError`: Thrown when you call [`mongoose.model()`](api/mongoose.html#mongoose_Mongoose-model) to re-define a model that was already defined.
- * - `ParallelSaveError`: Thrown when you call [`save()`](api/model.html#model_Model-save) on a document when the same document instance is already saving.
- * - `StrictModeError`: Thrown when you set a path that isn't the schema and [strict mode](guide.html#strict) is set to `throw`.
- * - `VersionError`: Thrown when the [document is out of sync](guide.html#versionKey)
+ * - `OverwriteModelError`: Thrown when you call [`mongoose.model()`](mongoose.html#mongoose_Mongoose-model) to re-define a model that was already defined.
+ * - `ParallelSaveError`: Thrown when you call [`save()`](model.html#model_Model-save) on a document when the same document instance is already saving.
+ * - `StrictModeError`: Thrown when you set a path that isn't the schema and [strict mode](/docs/guide.html#strict) is set to `throw`.
+ * - `VersionError`: Thrown when the [document is out of sync](/docs/guide.html#versionKey)
  *
  * @api public
  * @property {String} name
@@ -205,7 +205,7 @@ MongooseError.MongooseServerSelectionError = require('./serverSelection');
 MongooseError.DivergentArrayError = require('./divergentArray');
 
 /**
- * Thrown when your try to pass values to model contrtuctor that
+ * Thrown when your try to pass values to model constructor that
  * were not specified in schema or change immutable properties when
  * `strict` mode is `"throw"`
  *
@@ -215,3 +215,14 @@ MongooseError.DivergentArrayError = require('./divergentArray');
  */
 
 MongooseError.StrictModeError = require('./strict');
+
+/**
+ * An instance of this error class will be returned when mongoose failed to
+ * populate with a path that is not existing.
+ *
+ * @api public
+ * @memberOf Error
+ * @static
+ */
+
+MongooseError.StrictPopulateError = require('./strictPopulate');

package/lib/error/serverSelection.js

@@ -16,7 +16,7 @@ const isSSLError = require('../helpers/topology/isSSLError');
 const atlasMessage = 'Could not connect to any servers in your MongoDB Atlas cluster. ' +
   'One common reason is that you\'re trying to access the database from ' +
   'an IP that isn\'t whitelisted. Make sure your current IP address is on your Atlas ' +
-  'cluster\'s IP whitelist: https://docs.atlas.mongodb.com/security-whitelist/';
+  'cluster\'s IP whitelist: https://www.mongodb.com/docs/atlas/security-whitelist/';
 
 const sslMessage = 'Mongoose is connecting with SSL enabled, but the server is ' +
   'not accepting SSL connections. Please ensure that the MongoDB server you are ' +

package/lib/helpers/document/applyDefaults.js

@@ -78,7 +78,7 @@ module.exports = function applyDefaults(doc, fields, exclude, hasIncludedChildre
 
             if (typeof def !== 'undefined') {
               doc_[piece] = def;
-              doc.$__.activePaths.default(p);
+              applyChangeTracking(doc, p);
             }
           } else if (included) {
             // selected field
@@ -91,7 +91,7 @@ module.exports = function applyDefaults(doc, fields, exclude, hasIncludedChildre
 
             if (typeof def !== 'undefined') {
               doc_[piece] = def;
-              doc.$__.activePaths.default(p);
+              applyChangeTracking(doc, p);
             }
           }
         } else {
@@ -104,7 +104,7 @@ module.exports = function applyDefaults(doc, fields, exclude, hasIncludedChildre
 
           if (typeof def !== 'undefined') {
             doc_[piece] = def;
-            doc.$__.activePaths.default(p);
+            applyChangeTracking(doc, p);
           }
         }
       } else {
@@ -113,3 +113,14 @@ module.exports = function applyDefaults(doc, fields, exclude, hasIncludedChildre
     }
   }
 };
+
+/*!
+ * ignore
+ */
+
+function applyChangeTracking(doc, fullPath) {
+  doc.$__.activePaths.default(fullPath);
+  if (doc.$isSubdocument && doc.$isSingleNested && doc.$parent() != null) {
+    doc.$parent().$__.activePaths.default(doc.$__pathRelativeToParent(fullPath));
+  }
+}

package/lib/helpers/query/cast$expr.js

@@ -275,7 +275,7 @@ function isLiteral(val) {
   }
   if (typeof val === 'object' && val !== null && Object.keys(val).find(key => key[0] === '$')) {
     // The `$literal` expression can make an object a literal
-    // https://docs.mongodb.com/manual/reference/operator/aggregation/literal/#mongodb-expression-exp.-literal
+    // https://www.mongodb.com/docs/manual/reference/operator/aggregation/literal/#mongodb-expression-exp.-literal
     return val.$literal != null;
   }
   return true;

package/lib/helpers/query/castUpdate.js

@@ -84,14 +84,6 @@ module.exports = function castUpdate(schema, obj, options, context, filter) {
     const op = ops[i];
     val = ret[op];
     hasDollarKey = hasDollarKey || op.startsWith('$');
-    const toUnset = {};
-    if (val != null) {
-      for (const key of Object.keys(val)) {
-        if (val[key] === undefined) {
-          toUnset[key] = 1;
-        }
-      }
-    }
 
     if (val &&
         typeof val === 'object' &&
@@ -108,10 +100,6 @@ module.exports = function castUpdate(schema, obj, options, context, filter) {
 
     if (op.startsWith('$') && utils.isEmptyObject(val)) {
       delete ret[op];
-      if (op === '$set' && !utils.isEmptyObject(toUnset)) {
-        // Unset all undefined values
-        ret['$unset'] = toUnset;
-      }
     }
   }