Merge branch 'master' into 9.0

vkarpov15 · vkarpov15 · commit 9eeabedb0c41 · 2025-06-12T19:41:40.000-04:00
diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml
@@ -26,7 +26,7 @@ jobs:
         with:
           fetch-depth: 0
       - name: Setup node
-        uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4.3.0
+        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
         with:
           node-version: 22
 
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -31,7 +31,7 @@ jobs:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
 
       - name: Setup node
-        uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4.3.0
+        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
         with:
           node-version: 22
 
@@ -52,7 +52,7 @@ jobs:
       - run: git fetch --depth=1 --tags # download all tags for documentation
 
       - name: Setup node
-        uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4.3.0
+        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
         with:
           node-version: 22
 
diff --git a/.github/workflows/encryption-tests.yml b/.github/workflows/encryption-tests.yml
@@ -26,7 +26,7 @@ jobs:
     steps:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       - name: Setup node
-        uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4.3.0
+        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
         with:
           node-version: 22
       - name: Install Dependencies
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -25,7 +25,7 @@ jobs:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
 
       - name: Setup node
-        uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4.3.0
+        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
         with:
           node-version: 22
 
@@ -56,7 +56,7 @@ jobs:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
 
       - name: Setup node
-        uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4.3.0
+        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
         with:
           node-version: ${{ matrix.node }}
 
@@ -68,6 +68,8 @@ jobs:
           key: ${{ matrix.os }}-${{ matrix.mongodb }}
 
       - run: npm install
+      # Create ./node_modules/mongoose-separate-require-instance for testing multiple require instances
+      - run: npm run create-separate-require-instance
       - name: NPM Test without Coverage
         run: npm test
         if: matrix.coverage != true
@@ -85,7 +87,7 @@ jobs:
     steps:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       - name: Setup node
-        uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4.3.0
+        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
         with:
           node-version: 22
       - name: Load MongoDB binary cache
@@ -113,7 +115,7 @@ jobs:
     steps:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       - name: Setup node
-        uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4.3.0
+        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
         with:
           node-version: 22
       - run: npm install
diff --git a/.github/workflows/tidelift-alignment.yml b/.github/workflows/tidelift-alignment.yml
@@ -17,7 +17,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       - name: Setup node
-        uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4.3.0
+        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
         with:
           node-version: 22
       - name: Alignment
diff --git a/.github/workflows/tsd.yml b/.github/workflows/tsd.yml
@@ -23,7 +23,7 @@ jobs:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
 
       - name: Setup node
-        uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4.3.0
+        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
         with:
           node-version: 22
 
@@ -41,7 +41,7 @@ jobs:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
 
       - name: Setup node
-        uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4.3.0
+        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
         with:
           node-version: 22
 
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,9 @@
+8.15.1 / 2025-05-26
+===================
+ * types: correct handling of _id in ProjectionType #15432 #15418
+ * types: fix definition of VectorSearch.$vectorSearch #15429 [chriskrycho](https://github.com/chriskrycho)
+ * docs: add Document#save to list of function with callbacks removed #15433 [SethFalco](https://github.com/SethFalco)
+
 8.15.0 / 2025-05-16
 ===================
  * feat: CSFLE support #15390 [baileympearson](https://github.com/baileympearson)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -19,7 +19,7 @@ If you have a question about Mongoose (not a bug report) please post it to eithe
 
 ## Fixing bugs / Adding features
 
-* Before starting to write code, look for existing [issues](https://github.com/learnboost/mongoose/issues). That way you avoid working on something that might not be of interest or that has been addressed already in a different branch. You can create a new issue [here](https://github.com/learnboost/mongoose/issues/new).
+* Before starting to write code, look for existing [issues](https://github.com/learnboost/mongoose/issues). That way you avoid working on something that might not be of interest or that has been addressed already in a different branch. [You can create a new issue on GitHub](https://github.com/learnboost/mongoose/issues/new).
   * *The source of this project is written in JavaScript, not CoffeeScript or TypeScript. Please write your bug reports in JavaScript that can run in vanilla Node.js*.
 * Fork the [repo](https://github.com/Automattic/mongoose) *or* for small documentation changes, navigate to the source on github and click the [Edit](https://github.com/blog/844-forking-with-the-edit-button) button.
 * Follow the general coding style of the rest of the project:
diff --git a/README.md b/README.md
@@ -325,7 +325,7 @@ return a cursor.
 
 ## API Docs
 
-Find the API docs [here](http://mongoosejs.com/docs/api/mongoose.html), generated using [dox](https://github.com/tj/dox)
+[Mongoose API documentation](http://mongoosejs.com/docs/api/mongoose.html), generated using [dox](https://github.com/tj/dox)
 and [acquit](https://github.com/vkarpov15/acquit).
 
 ## Related Projects
diff --git a/docs/guide.md b/docs/guide.md
@@ -205,7 +205,7 @@ dog.findSimilarTypes((err, dogs) => {
 ```
 
 * Overwriting a default mongoose document method may lead to unpredictable results. See [this](api/schema.html#schema_Schema-reserved) for more details.
-* The example above uses the `Schema.methods` object directly to save an instance method. You can also use the `Schema.method()` helper as described [here](api/schema.html#schema_Schema-method).
+* The example above uses the `Schema.methods` object directly to save an instance method. You can also use the [`Schema.method()` helper](api/schema.html#schema_Schema-method).
 * Do **not** declare methods using ES6 arrow functions (`=>`). Arrow functions [explicitly prevent binding `this`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Functions/Arrow_functions#No_binding_of_this), so your method will **not** have access to the document and the above examples will not work.
 
 ## Statics {#statics}
@@ -827,8 +827,8 @@ The alias of each pref is also permitted so instead of having to type out
 The read option also allows us to specify *tag sets*. These tell the
 [driver](https://github.com/mongodb/node-mongodb-native/) from which members
 of the replica-set it should attempt to read. Read more about tag sets
-[here](http://www.mongodb.com/docs/manual/applications/replication/#tag-sets) and
-[here](https://www.mongodb.com/docs/manual/core/read-preference).
+in the [MongoDB documentation on replica set tag sets](http://www.mongodb.com/docs/manual/applications/replication/#tag-sets) and
+in the [MongoDB core documentation on read preference](https://www.mongodb.com/docs/manual/core/read-preference).
 
 *NOTE: you may also specify the driver read preference [strategy](https://www.mongodb.com/docs/manual/core/read-preference/#read-preference-modes)
 option when connecting:*
diff --git a/docs/queries.md b/docs/queries.md
@@ -113,10 +113,9 @@ await q.then(() => console.log('Update 3'));
 
 ## References to other documents {#refs}
 
-There are no joins in MongoDB but sometimes we still want references to
-documents in other collections. This is where [population](populate.html)
-comes in. Read more about how to include documents from other collections in
-your query results [here](api/query.html#query_Query-populate).
+There are no joins in MongoDB but sometimes we still want references to documents in other collections.
+This is where [population](populate.html) comes in.
+Read more about how to include documents from other collections in your query results in the [population documentation](api/query.html#query_Query-populate).
 
 ## Streaming {#streaming}
 
diff --git a/docs/schematypes.md b/docs/schematypes.md
@@ -814,7 +814,7 @@ site for compatible types like
 and
 [mongoose-function](https://github.com/aheckmann/mongoose-function).
 
-Read more about creating custom SchemaTypes [here](customschematypes.html).
+Read more about creating custom SchemaTypes in our [Custom SchemaTypes guide](customschematypes.html).
 
 ## The `schema.path()` Function {#path}
 
diff --git a/lib/document.js b/lib/document.js
@@ -2706,7 +2706,13 @@ function _getPathsToValidate(doc, pathsToValidate, pathsToSkip, isNestedValidate
   Object.keys(doc.$__.activePaths.getStatePaths('init')).forEach(addToPaths);
   Object.keys(doc.$__.activePaths.getStatePaths('modify')).forEach(addToPaths);
   Object.keys(doc.$__.activePaths.getStatePaths('default')).forEach(addToPaths);
-  function addToPaths(p) { paths.add(p); }
+  function addToPaths(p) {
+    if (p.endsWith('.$*')) {
+      // Skip $* paths - they represent map schemas, not actual document paths
+      return;
+    }
+    paths.add(p);
+  }
 
   if (!isNestedValidate) {
     // If we're validating a subdocument, all this logic will run anyway on the top-level document, so skip for subdocuments.
@@ -2746,6 +2752,9 @@ function _getPathsToValidate(doc, pathsToValidate, pathsToSkip, isNestedValidate
         }
 
         const subdocParent = subdoc.$parent();
+        if (subdocParent == null) {
+          throw new Error('Cannot validate subdocument that does not have a parent');
+        }
         if (doc.$isModified(fullPathToSubdoc, null, modifiedPaths) &&
               // Avoid using isDirectModified() here because that does additional checks on whether the parent path
               // is direct modified, which can cause performance issues re: gh-14897
diff --git a/lib/helpers/populate/assignVals.js b/lib/helpers/populate/assignVals.js
@@ -144,7 +144,24 @@ module.exports = function assignVals(o) {
       if (Array.isArray(valueToSet)) {
         valueToSet = valueToSet.map(v => v == null ? void 0 : v);
       }
-      mpath.set(_path, valueToSet, docs[i], void 0, setValue, false);
+      mpath.set(
+        _path,
+        valueToSet,
+        docs[i],
+        // Handle setting paths underneath maps using $* by converting arrays into maps of values
+        function lookup(obj, part, val) {
+          if (arguments.length >= 3) {
+            obj[part] = val;
+            return obj[part];
+          }
+          if (obj instanceof Map && part === '$*') {
+            return [...obj.values()];
+          }
+          return obj[part];
+        },
+        setValue,
+        false
+      );
       continue;
     }
 
diff --git a/lib/helpers/populate/getVirtual.js b/lib/helpers/populate/getVirtual.js
@@ -58,6 +58,37 @@ function getVirtual(schema, name) {
       nestedSchemaPath += (nestedSchemaPath.length > 0 ? '.' : '') + cur;
       cur = '';
       continue;
+    } else if (schema.paths[cur]?.$isSchemaMap && schema.paths[cur].$__schemaType?.schema) {
+      schema = schema.paths[cur].$__schemaType.schema;
+      ++i;
+      const rest = parts.slice(i + 1).join('.');
+
+      if (schema.virtuals[rest]) {
+        if (i === parts.length - 2) {
+          return {
+            virtual: schema.virtuals[rest],
+            nestedSchemaPath: [nestedSchemaPath, cur, '$*'].filter(v => !!v).join('.')
+          };
+        }
+        continue;
+      }
+
+      if (i + 1 < parts.length && schema.discriminators) {
+        for (const key of Object.keys(schema.discriminators)) {
+          const res = getVirtual(schema.discriminators[key], rest);
+          if (res != null) {
+            const _path = [nestedSchemaPath, cur, res.nestedSchemaPath, '$*'].
+              filter(v => !!v).join('.');
+            return {
+              virtual: res.virtual,
+              nestedSchemaPath: _path
+            };
+          }
+        }
+      }
+
+      nestedSchemaPath += (nestedSchemaPath.length > 0 ? '.' : '') + '$*' + cur;
+      cur = '';
     }
 
     if (schema.discriminators) {
diff --git a/lib/helpers/updateValidators.js b/lib/helpers/updateValidators.js
@@ -130,10 +130,12 @@ module.exports = async function updateValidators(query, schema, castedDoc, optio
           })
         );
       } else {
-        for (const path of alreadyValidated) {
-          if (updates[i].startsWith(path + '.')) {
-            continue;
-          }
+        const isAlreadyValidated = alreadyValidated.find(path => updates[i].startsWith(path + '.'));
+        if (isAlreadyValidated) {
+          continue;
+        }
+        if (schemaPath.$isSingleNested) {
+          alreadyValidated.push(updates[i]);
         }
         validatorsToExecute.push(
           schemaPath.doValidate(v, context, { updateValidator: true }).catch(err => {
diff --git a/lib/model.js b/lib/model.js
@@ -526,13 +526,13 @@ Model.prototype.$__save = async function $__save(options) {
  * ignore
  */
 
-function generateVersionError(doc, modifiedPaths) {
+function generateVersionError(doc, modifiedPaths, defaultPaths) {
   const key = doc.$__schema.options.versionKey;
   if (!key) {
     return null;
   }
   const version = doc.$__getValue(key) || 0;
-  return new VersionError(doc, version, modifiedPaths);
+  return new VersionError(doc, version, modifiedPaths.concat(defaultPaths));
 }
 
 /**
@@ -590,7 +590,11 @@ Model.prototype.save = async function save(options) {
   if (this.$__.timestamps != null) {
     options.timestamps = this.$__.timestamps;
   }
-  this.$__.$versionError = generateVersionError(this, this.modifiedPaths());
+  this.$__.$versionError = generateVersionError(
+    this,
+    this.modifiedPaths(),
+    Object.keys(this.$__.activePaths.getStatePaths('default'))
+  );
 
   if (parallelSave) {
     this.$__handleReject(parallelSave);
diff --git a/lib/schema.js b/lib/schema.js
@@ -2636,6 +2636,10 @@ Schema.prototype.virtual = function(name, options) {
         const remnant = parts.slice(i + 1).join('.');
         this.paths[cur].schema.virtual(remnant, options);
         break;
+      } else if (this.paths[cur].$isSchemaMap) {
+        const remnant = parts.slice(i + 2).join('.');
+        this.paths[cur].$__schemaType.schema.virtual(remnant, options);
+        break;
       }
 
       cur += '.' + parts[i + 1];
diff --git a/lib/types/array/index.js b/lib/types/array/index.js
@@ -4,7 +4,6 @@
 
 'use strict';
 
-const Document = require('../../document');
 const mongooseArrayMethods = require('./methods');
 
 const arrayAtomicsSymbol = require('../../helpers/symbols').arrayAtomicsSymbol;
@@ -73,11 +72,7 @@ function MongooseArray(values, path, doc, schematype) {
     internals[arrayAtomicsSymbol] = values[arrayAtomicsSymbol];
   }
 
-  // Because doc comes from the context of another function, doc === global
-  // can happen if there was a null somewhere up the chain (see #3020)
-  // RB Jun 17, 2015 updated to check for presence of expected paths instead
-  // to make more proof against unusual node environments
-  if (doc != null && doc instanceof Document) {
+  if (doc != null && doc.$__) {
     internals[arrayParentSymbol] = doc;
     internals[arraySchemaSymbol] = schematype || doc.schema.path(path);
   }
diff --git a/lib/types/documentArray/index.js b/lib/types/documentArray/index.js
@@ -6,7 +6,6 @@
 
 const ArrayMethods = require('../array/methods');
 const DocumentArrayMethods = require('./methods');
-const Document = require('../../document');
 
 const arrayAtomicsSymbol = require('../../helpers/symbols').arrayAtomicsSymbol;
 const arrayAtomicsBackupSymbol = require('../../helpers/symbols').arrayAtomicsBackupSymbol;
@@ -51,11 +50,7 @@ function MongooseDocumentArray(values, path, doc, schematype) {
   internals[arrayPathSymbol] = path;
   internals.__array = __array;
 
-  // Because doc comes from the context of another function, doc === global
-  // can happen if there was a null somewhere up the chain (see #3020 && #3034)
-  // RB Jun 17, 2015 updated to check for presence of expected paths instead
-  // to make more proof against unusual node environments
-  if (doc && doc instanceof Document) {
+  if (doc && doc.$__) {
     internals[arrayParentSymbol] = doc;
     internals[arraySchemaSymbol] = doc.$__schema.path(path);
 
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "mongoose",
   "description": "Mongoose MongoDB ODM",
-  "version": "8.15.0",
+  "version": "8.15.1",
   "author": "Guillermo Rauch <guillermo@learnboost.com>",
   "keywords": [
     "mongodb",
@@ -45,10 +45,10 @@
     "highlight.js": "11.11.1",
     "lodash.isequal": "4.5.0",
     "lodash.isequalwith": "4.4.0",
-    "markdownlint-cli2": "^0.17.1",
-    "marked": "15.0.11",
+    "markdownlint-cli2": "^0.18.1",
+    "marked": "15.0.12",
     "mkdirp": "^3.0.1",
-    "mocha": "11.2.2",
+    "mocha": "11.5.0",
     "moment": "2.30.1",
     "mongodb-memory-server": "10.1.4",
     "mongodb-runner": "^5.8.2",
@@ -90,6 +90,7 @@
     "release-6x": "git pull origin 6.x && git push origin 6.x && git push origin 6.x --tags && npm publish --tag 6x",
     "mongo": "node ./tools/repl.js",
     "publish-7x": "npm publish --tag 7x",
+    "create-separate-require-instance": "rm -rf ./node_modules/mongoose-separate-require-instance && node ./scripts/create-tarball && tar -xzf mongoose.tgz -C ./node_modules && mv ./node_modules/package ./node_modules/mongoose-separate-require-instance",
     "test": "mocha --exit ./test/*.test.js",
     "test-deno": "deno run --allow-env --allow-read --allow-net --allow-run --allow-sys --allow-write ./test/deno.mjs",
     "test-rs": "START_REPLICA_SET=1 mocha --timeout 30000 --exit ./test/*.test.js",
diff --git a/test/document.test.js b/test/document.test.js
diff --git a/test/helpers/populate.getVirtual.test.js b/test/helpers/populate.getVirtual.test.js
diff --git a/test/model.populate.test.js b/test/model.populate.test.js
diff --git a/test/model.updateOne.test.js b/test/model.updateOne.test.js
diff --git a/test/multiple-require-instance.test.js b/test/multiple-require-instance.test.js
diff --git a/test/types.map.test.js b/test/types.map.test.js
diff --git a/test/types/models.test.ts b/test/types/models.test.ts
diff --git a/types/models.d.ts b/types/models.d.ts
