Merge branch 'master' into 6.6

Author: vkarpov15

.github/dependabot.yml

@@ -7,7 +7,6 @@ updates:
   open-pull-requests-limit: 100
   target-branch: master
   ignore:
-    - dependency-name: "dox"
 - package-ecosystem: github-actions
   directory: "/"
   schedule:

CHANGELOG.md

@@ -1,3 +1,13 @@
+6.5.5 / 2022-09-07
+==================
+ * fix(setDefaultsOnInsert): avoid applying defaults on insert if nested property set #12279
+ * fix(model): make applyHooks() and applyMethods() handle case where custom method is set to Mongoose implementation #12254
+ * fix(types): add string "ascending" and "descending" index-directions #10269
+ * docs: upgrade dox to 1.0.0 #12403 [hasezoey](https://github.com/hasezoey)
+ * docs: update old mongodb nodejs driver documentation urls #12387 [hasezoey](https://github.com/hasezoey)
+ * docs: update JSDOC ... (spread) definition #12388 [hasezoey](https://github.com/hasezoey)
+ * refactor(model): allow optionally passing indexes to createIndexes and cleanIndexes #12280 [AbdelrahmanHafez](https://github.com/AbdelrahmanHafez)
+
 6.5.4 / 2022-08-30
 ==================
  * fix(document): allow calling $assertPopulated() with values to better support manual population #12233

docs/api_split.pug

@@ -68,7 +68,7 @@ block content
       if prop.inherits != null
         h5 Inherits:
         ul
-          li <span class="method-type">&laquo;#{prop.inherits}&raquo;</span>
+          li <span class="method-type"><a href="#{prop.inherits.url}">&laquo;#{prop.inherits.text}&raquo;</a></span>
       if prop.see != null && prop.see.length > 0
         h5 See:
         ul

docs/source/api.js

@@ -99,7 +99,7 @@ parse();
  * @property {string} [deprecated] Defines wheter the current Property is signaled as deprecated
  * @property {SeeObject[]} [see] Defines all "@see" references
  * @property {TagObject[]} [param] Defines all "@param" references
- * @property {String} [inherits] Defines the string for "@inherits"
+ * @property {SeeObject} [inherits] Defines the string for "@inherits"
  */
 
 function parse() {
@@ -167,35 +167,7 @@ function parse() {
             // for this type, it needs to be parsed from the string itself to support more than 1 word
             // this is required because "@see" is kinda badly defined and mongoose uses a slightly customized way (longer text and different kinds of links)
 
-            // the following regex matches cases of:
-            // "External Links http://someurl.com/" -> "External Links"
-            // "External https://someurl.com/" -> "External"
-            // "Id href #some_Some-method" -> "Id href"
-            // "Local Absolute /docs/somewhere" -> "Local Absolute"
-            // "No Href" -> "No Href"
-            // "https://someurl.com" -> "" (fallback added)
-            // "Some#Method #something" -> "Some#Method"
-            // The remainder is simply taken by a call to "slice" (also the text is trimmed later)
-            const textMatches = /^(.*? (?=#|\/|(?:https?:)|$))/i.exec(tag.string);
-
-            let text = undefined;
-            let url = undefined;
-            if (textMatches === null || textMatches === undefined) {
-              // warn because this most likely is a badly defined "@see"
-              console.warn(`No Text Matches found in @see for "${ctx.constructor}.${ctx.name}"`)
-
-              // if no text is found, add text as url and use the url itself as the text
-              url = tag.string;
-              text = tag.string;
-            } else {
-              text = textMatches[1].trim();
-              url = tag.string.slice(text.length).trim();
-            }
-
-            ctx.see.push({
-              text: text || 'No Description', // fallback text, so that the final text does not end up as a empty element that cannot be seen
-              url: url || undefined, // change to be "undefined" if text is empty or non-valid
-            });
+            ctx.see.push(extractTextUrlFromTag(tag, ctx, true));
             break;
           case 'receiver':
             console.warn(`Found "@receiver" tag in ${ctx.constructor} ${ctx.name}`);
@@ -241,7 +213,7 @@ function parse() {
             ctx.return = tag;
             break;
           case 'inherits':
-            ctx[tag.type] = tag.string;
+            ctx.inherits = extractTextUrlFromTag(tag, ctx);
             break;
           case 'event':
           case 'param':
@@ -344,3 +316,44 @@ function parse() {
     out.push(data);
   }
 }
+
+/**
+ * Extract the Text and Url from a description if any
+ * @param {Tag} tag The tag to process the resulting object from
+ * @param {PropContext} ctx The current ctx for warnings
+ * @param {Boolean} warnOnMissingUrl Warn if the url is missing, false by default
+ * @returns {{ text: string, url: string }}
+ */
+function extractTextUrlFromTag(tag, ctx, warnOnMissingUrl = false) {
+  // the following regex matches cases of:
+  // "External Links http://someurl.com/" -> "External Links"
+  // "External https://someurl.com/" -> "External"
+  // "Id href #some_Some-method" -> "Id href"
+  // "Local Absolute /docs/somewhere" -> "Local Absolute"
+  // "No Href" -> "No Href"
+  // "https://someurl.com" -> "" (fallback added)
+  // "Some#Method #something" -> "Some#Method"
+  // The remainder is simply taken by a call to "slice" (also the text is trimmed later)
+  const textMatches = /^(.*? (?=#|\/|(?:https?:)|$))/i.exec(tag.string);
+
+  let text = undefined;
+  let url = undefined;
+  if (textMatches === null || textMatches === undefined) {
+    if (warnOnMissingUrl) {
+      // warn for the cases where URL should be defined (like in "@see")
+      console.warn(`No Text Matches found in tag for "${ctx.constructor}.${ctx.name}"`)
+    }
+
+    // if no text is found, add text as url and use the url itself as the text
+    url = tag.string;
+    text = tag.string;
+  } else {
+    text = textMatches[1].trim();
+    url = tag.string.slice(text.length).trim();
+  }
+
+  return {
+    text: text || 'No Description', // fallback text, so that the final text does not end up as a empty element that cannot be seen
+    url: url || undefined, // change to be "undefined" if text is empty or non-valid
+  };
+}

lib/aggregate.js

@@ -789,7 +789,7 @@ Aggregate.prototype.explain = function(verbosity, callback) {
 };
 
 /**
- * Sets the allowDiskUse option for the aggregation query (ignored for < 2.6.0)
+ * Sets the allowDiskUse option for the aggregation query
  *
  * #### Example:
  *
@@ -806,7 +806,7 @@ Aggregate.prototype.allowDiskUse = function(value) {
 };
 
 /**
- * Sets the hint option for the aggregation query (ignored for < 3.6.0)
+ * Sets the hint option for the aggregation query
  *
  * #### Example:
  *
@@ -1073,7 +1073,7 @@ Aggregate.prototype.catch = function(reject) {
 };
 
 /**
- * Returns an asyncIterator for use with [`for/await/of` loops](https://thecodebarbarian.com/getting-started-with-async-iterators-in-node-js
+ * Returns an asyncIterator for use with [`for/await/of` loops](https://thecodebarbarian.com/getting-started-with-async-iterators-in-node-js)
  * You do not need to call this function explicitly, the JavaScript runtime
  * will call it for you.
  *

lib/cursor/AggregationCursor.js

@@ -231,7 +231,7 @@ AggregationCursor.prototype.eachAsync = function(fn, opts, callback) {
 };
 
 /**
- * Returns an asyncIterator for use with [`for/await/of` loops](https://thecodebarbarian.com/getting-started-with-async-iterators-in-node-js
+ * Returns an asyncIterator for use with [`for/await/of` loops](https://thecodebarbarian.com/getting-started-with-async-iterators-in-node-js)
  * You do not need to call this function explicitly, the JavaScript runtime
  * will call it for you.
  *

lib/helpers/indexes/isIndexEqual.js

@@ -6,13 +6,13 @@ const utils = require('../../utils');
  * Given a Mongoose index definition (key + options objects) and a MongoDB server
  * index definition, determine if the two indexes are equal.
  *
- * @param {Object} key the Mongoose index spec
+ * @param {Object} schemaIndexKeysObject the Mongoose index spec
  * @param {Object} options the Mongoose index definition's options
  * @param {Object} dbIndex the index in MongoDB as returned by `listIndexes()`
  * @api private
  */
 
-module.exports = function isIndexEqual(key, options, dbIndex) {
+module.exports = function isIndexEqual(schemaIndexKeysObject, options, dbIndex) {
   // Special case: text indexes have a special format in the db. For example,
   // `{ name: 'text' }` becomes:
   // {
@@ -30,11 +30,11 @@ module.exports = function isIndexEqual(key, options, dbIndex) {
     delete dbIndex.key._fts;
     delete dbIndex.key._ftsx;
     const weights = { ...dbIndex.weights, ...dbIndex.key };
-    if (Object.keys(weights).length !== Object.keys(key).length) {
+    if (Object.keys(weights).length !== Object.keys(schemaIndexKeysObject).length) {
       return false;
     }
     for (const prop of Object.keys(weights)) {
-      if (!(prop in key)) {
+      if (!(prop in schemaIndexKeysObject)) {
         return false;
       }
       const weight = weights[prop];
@@ -78,7 +78,7 @@ module.exports = function isIndexEqual(key, options, dbIndex) {
     }
   }
 
-  const schemaIndexKeys = Object.keys(key);
+  const schemaIndexKeys = Object.keys(schemaIndexKeysObject);
   const dbIndexKeys = Object.keys(dbIndex.key);
   if (schemaIndexKeys.length !== dbIndexKeys.length) {
     return false;
@@ -87,7 +87,7 @@ module.exports = function isIndexEqual(key, options, dbIndex) {
     if (schemaIndexKeys[i] !== dbIndexKeys[i]) {
       return false;
     }
-    if (!utils.deepEqual(key[schemaIndexKeys[i]], dbIndex.key[dbIndexKeys[i]])) {
+    if (!utils.deepEqual(schemaIndexKeysObject[schemaIndexKeys[i]], dbIndex.key[dbIndexKeys[i]])) {
       return false;
     }
   }

lib/helpers/model/applyHooks.js

@@ -22,6 +22,12 @@ applyHooks.middlewareFunctions = [
   'init'
 ];
 
+/*!
+ * ignore
+ */
+
+const alreadyHookedFunctions = new Set(applyHooks.middlewareFunctions.flatMap(fn => ([fn, `$__${fn}`])));
+
 /**
  * Register hooks for this model
  *
@@ -117,6 +123,9 @@ function applyHooks(model, schema, options) {
     checkForPromise: true
   });
   for (const method of customMethods) {
+    if (alreadyHookedFunctions.has(method)) {
+      continue;
+    }
     if (!middleware.hasHooks(method)) {
       // Don't wrap if there are no hooks for the custom method to avoid
       // surprises. Also, `createWrapper()` enforces consistent async,

lib/helpers/model/applyMethods.js

@@ -30,6 +30,15 @@ module.exports = function applyMethods(model, schema) {
       throw new Error('You have a method and a property in your schema both ' +
         'named "' + method + '"');
     }
+
+    // Avoid making custom methods if user sets a method to itself, e.g.
+    // `schema.method(save, Document.prototype.save)`. Can happen when
+    // calling `loadClass()` with a class that `extends Document`. See gh-12254
+    if (typeof fn === 'function' && model.prototype[method] === fn) {
+      delete schema.methods[method];
+      continue;
+    }
+
     if (schema.reserved[method] &&
         !get(schema, `methodOptions.${method}.suppressWarning`, false)) {
       utils.warn(`mongoose: the method name "${method}" is used by mongoose ` +

lib/helpers/setDefaultsOnInsert.js

@@ -105,6 +105,8 @@ function isModified(modified, path) {
   if (modified[path]) {
     return true;
   }
+
+  // Is any parent path of `path` modified?
   const sp = path.split('.');
   let cur = sp[0];
   for (let i = 1; i < sp.length; ++i) {
@@ -113,5 +115,18 @@ function isModified(modified, path) {
     }
     cur += '.' + sp[i];
   }
+
+  // Is any child of `path` modified?
+  const modifiedKeys = Object.keys(modified);
+  if (modifiedKeys.length) {
+    const parentPath = path + '.';
+
+    for (const modifiedPath of modifiedKeys) {
+      if (modifiedPath.slice(0, path.length + 1) === parentPath) {
+        return true;
+      }
+    }
+  }
+
   return false;
 }