Merge branch 'master' into 8.0

vkarpov15 · vkarpov15 · commit 9ce415376c10 · 2023-10-04T17:37:34.000-04:00
diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml
@@ -22,7 +22,7 @@ jobs:
     runs-on: ubuntu-20.04
     name: Benchmark TypeScript Types
     steps:
-      - uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0
+      - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
         with:
           fetch-depth: 0
       - name: Setup node
diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml
@@ -21,7 +21,7 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0
+        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
 
       # Initializes the CodeQL tools for scanning.
       - name: Initialize CodeQL
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -28,7 +28,7 @@ jobs:
     runs-on: ubuntu-latest
     name: Lint Markdown files
     steps:
-      - uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0
+      - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
 
       - name: Setup node
         uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d # v3.8.1
@@ -48,7 +48,7 @@ jobs:
     runs-on: ubuntu-20.04
     name: Test Generating Docs
     steps:
-      - uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0
+      - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
       - run: git fetch --depth=1 --tags # download all tags for documentation
 
       - name: Setup node
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -22,7 +22,7 @@ jobs:
     runs-on: ubuntu-latest
     name: Lint JS-Files
     steps:
-      - uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0
+      - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
 
       - name: Setup node
         uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d # v3.8.1
@@ -58,7 +58,7 @@ jobs:
       MONGOMS_PREFER_GLOBAL_PATH: 1
       FORCE_COLOR: true
     steps:
-      - uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0
+      - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
 
       - name: Setup node
         uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d # v3.8.1
@@ -94,7 +94,7 @@ jobs:
       MONGOMS_PREFER_GLOBAL_PATH: 1
       FORCE_COLOR: true
     steps:
-      - uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0
+      - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
       - name: Setup node
         uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d # v3.8.1
         with:
@@ -122,7 +122,7 @@ jobs:
     env:
       FORCE_COLOR: true
     steps:
-      - uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0
+      - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
       - name: Setup node
         uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d # v3.8.1
         with:
@@ -139,6 +139,6 @@ jobs:
       contents: read
     steps:
       - name: Check out repo
-        uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0
+        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
       - name: Dependency review
         uses: actions/dependency-review-action@v3
diff --git a/.github/workflows/tidelift-alignment.yml b/.github/workflows/tidelift-alignment.yml
@@ -15,7 +15,7 @@ jobs:
     if: github.repository == 'Automattic/mongoose'
     steps:
       - name: Checkout
-        uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0
+        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
       - name: Setup node
         uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d # v3.8.1
         with:
diff --git a/.github/workflows/tsd.yml b/.github/workflows/tsd.yml
@@ -22,7 +22,7 @@ jobs:
     runs-on: ubuntu-latest
     name: Lint TS-Files
     steps:
-      - uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0
+      - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
 
       - name: Setup node
         uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d # v3.8.1
@@ -40,7 +40,7 @@ jobs:
     runs-on: ubuntu-latest
     name: Test Typescript Types
     steps:
-      - uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0
+      - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
 
       - name: Setup node
         uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d # v3.8.1
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,15 @@
+7.5.4 / 2023-10-04
+==================
+ * fix: avoid stripping out `id` property when `_id` is set #13933 #13892 #13867
+ * fix(QueryCursor): avoid double-applying schema paths so you can include select: false fields with + projection using cursors #13932 #13773
+ * fix(query): allow deselecting discriminator key using - syntax #13929 #13760
+ * fix(query): handle $round in $expr as array #13928 #13881
+ * fix(document): call pre('validate') hooks when modifying a path underneath triply nested subdoc #13912 #13876
+ * fix(mongoose): correctly handle global applyPluginsToChildSchemas option #13911 #13887
+ * types: add insertMany array overload with options #13931 [t1bb4r](https://github.com/t1bb4r)
+ * docs(compatibility): add Mongoose 7 support to compatibility matrix #13875
+ * docs: amend some awkward FAQ wording #13925 [peteboere](https://github.com/peteboere)
+
 7.5.3 / 2023-09-25
 ==================
  * fix(document): handle MongoDB Long when casting BigInts #13869 #13791
diff --git a/docs/compatibility.md b/docs/compatibility.md
@@ -18,6 +18,7 @@ Below are the [semver](http://semver.org/) ranges representing which versions of
 
 | MongoDB Server |           Mongoose            |
 | :------------: | :---------------------------: |
+|     `7.x`      |           `^7.4.0`            |
 |     `6.x`      |      `^6.5.0 \| ^7.0.0`       |
 |     `5.x`      |      `^6.0.0 \| ^7.0.0`       |
 |    `4.4.x`     | `^5.10.0 \| ^6.0.0 \| ^7.0.0` |
diff --git a/docs/faq.md b/docs/faq.md
@@ -139,7 +139,7 @@ is undefined on the underlying [POJO](guide.html#minimize).
 
 <a class="anchor" href="#arrow-functions">**Q**</a>. I'm using an arrow function for a [virtual](guide.html#virtuals), [middleware](middleware.html), [getter](api/schematype.html#schematype_SchemaType-get)/[setter](api/schematype.html#schematype_SchemaType-set), or [method](guide.html#methods) and the value of `this` is wrong.
 
-**A**. Arrow functions [handle the `this` keyword much differently than conventional functions](https://masteringjs.io/tutorials/fundamentals/arrow#why-not-arrow-functions).
+**A**. Arrow functions [handle the `this` keyword differently than conventional functions](https://masteringjs.io/tutorials/fundamentals/arrow#why-not-arrow-functions).
 Mongoose getters/setters depend on `this` to give you access to the document that you're writing to, but this functionality does not work with arrow functions. Do **not** use arrow functions for mongoose getters/setters unless do not intend to access the document in the getter/setter.
 
 ```javascript
diff --git a/lib/cursor/queryCursor.js b/lib/cursor/queryCursor.js
@@ -34,7 +34,7 @@ const util = require('util');
  * @api public
  */
 
-function QueryCursor(query, options) {
+function QueryCursor(query) {
   // set autoDestroy=true because on node 12 it's by default false
   // gh-10902 need autoDestroy to destroy correctly and emit 'close' event
   Readable.call(this, { autoDestroy: true, objectMode: true });
@@ -46,7 +46,7 @@ function QueryCursor(query, options) {
   this._mongooseOptions = {};
   this._transforms = [];
   this.model = model;
-  this.options = options || {};
+  this.options = {};
   model.hooks.execPre('find', query, (err) => {
     if (err != null) {
       if (err instanceof kareem.skipWrappedFunction) {
@@ -70,20 +70,18 @@ function QueryCursor(query, options) {
       this.listeners('error').length > 0 && this.emit('error', err);
       return;
     }
+    Object.assign(this.options, query._optionsForExec());
     this._transforms = this._transforms.concat(query._transforms.slice());
     if (this.options.transform) {
-      this._transforms.push(options.transform);
+      this._transforms.push(this.options.transform);
     }
     // Re: gh-8039, you need to set the `cursor.batchSize` option, top-level
     // `batchSize` option doesn't work.
     if (this.options.batchSize) {
-      this.options.cursor = options.cursor || {};
-      this.options.cursor.batchSize = options.batchSize;
-
       // Max out the number of documents we'll populate in parallel at 5000.
       this.options._populateBatchSize = Math.min(this.options.batchSize, 5000);
     }
-    Object.assign(this.options, query._optionsForExec());
+
     if (model.collection._shouldBufferCommands() && model.collection.buffer) {
       model.collection.queue.push([
         () => _getRawCursor(query, this)
diff --git a/lib/document.js b/lib/document.js
@@ -1691,6 +1691,13 @@ Document.prototype.$__set = function(pathToMark, path, options, constructing, pa
     if (last) {
       if (obj instanceof Map) {
         obj.set(parts[i], val);
+      } else if (obj.$isSingleNested) {
+        if (!(parts[i] in obj)) {
+          obj[parts[i]] = val;
+          obj._doc[parts[i]] = val;
+        } else {
+          obj._doc[parts[i]] = val;
+        }
       } else {
         obj[parts[i]] = val;
       }
@@ -1702,7 +1709,7 @@ Document.prototype.$__set = function(pathToMark, path, options, constructing, pa
       } else if (value && value instanceof Embedded) {
         obj = value;
       } else if (value && !Array.isArray(value) && value.$isSingleNested) {
-        obj = value._doc;
+        obj = value;
       } else if (value && Array.isArray(value)) {
         obj = value;
       } else if (value == null) {
@@ -2647,7 +2654,7 @@ function _getPathsToValidate(doc, pathsToValidate, pathsToSkip) {
   const modifiedPaths = doc.modifiedPaths();
   for (const subdoc of subdocs) {
     if (subdoc.$basePath) {
-      const fullPathToSubdoc = subdoc.$__fullPathWithIndexes();
+      const fullPathToSubdoc = subdoc.$isSingleNested ? subdoc.$__pathRelativeToParent() : subdoc.$__fullPathWithIndexes();
 
       // Remove child paths for now, because we'll be validating the whole
       // subdoc.
diff --git a/lib/helpers/query/cast$expr.js b/lib/helpers/query/cast$expr.js
@@ -29,7 +29,6 @@ const arithmeticOperatorNumber = new Set([
   '$floor',
   '$ln',
   '$log10',
-  '$round',
   '$sqrt',
   '$sin',
   '$cos',
@@ -118,6 +117,13 @@ function _castExpression(val, schema, strictQuery) {
   if (val.$size) {
     val.$size = castNumberOperator(val.$size, schema, strictQuery);
   }
+  if (val.$round) {
+    const $round = val.$round;
+    if (!Array.isArray($round) || $round.length < 1 || $round.length > 2) {
+      throw new CastError('Array', $round, '$round');
+    }
+    val.$round = $round.map(v => castNumberOperator(v, schema, strictQuery));
+  }
 
   _omitUndefined(val);
 
diff --git a/lib/index.js b/lib/index.js
@@ -694,7 +694,9 @@ Mongoose.prototype._applyPlugins = function(schema, options) {
 
   options = options || {};
   options.applyPluginsToDiscriminators = _mongoose.options && _mongoose.options.applyPluginsToDiscriminators || false;
-  options.applyPluginsToChildSchemas = typeof (_mongoose.options && _mongoose.options.applyPluginsToDiscriminators) === 'boolean' ? _mongoose.options.applyPluginsToDiscriminators : true;
+  options.applyPluginsToChildSchemas = typeof (_mongoose.options && _mongoose.options.applyPluginsToChildSchemas) === 'boolean' ?
+    _mongoose.options.applyPluginsToChildSchemas :
+    true;
   applyPlugins(schema, _mongoose.plugins, options, '$globalPluginsApplied');
 };
 
diff --git a/lib/query.js b/lib/query.js
@@ -4940,15 +4940,13 @@ Query.prototype.cursor = function cursor(opts) {
     this.setOptions(opts);
   }
 
-  const options = this._optionsForExec();
-
   try {
     this.cast(this.model);
   } catch (err) {
-    return (new QueryCursor(this, options))._markError(err);
+    return (new QueryCursor(this))._markError(err);
   }
 
-  return new QueryCursor(this, options);
+  return new QueryCursor(this);
 };
 
 // the rest of these are basically to support older Mongoose syntax with mquery
diff --git a/lib/queryHelpers.js b/lib/queryHelpers.js
@@ -199,6 +199,7 @@ exports.applyPaths = function applyPaths(fields, schema) {
       // projection if `name` has schema-level `select: true`.
       if ((!type || !type.selected) || exclude !== false) {
         fields[path] = 0;
+        exclude = true;
       } else if (type && type.selected && exclude === false) {
         // Make a note of minus paths that are overwriting paths that are
         // included by default.
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "mongoose",
   "description": "Mongoose MongoDB ODM",
-  "version": "7.5.3",
+  "version": "7.5.4",
   "author": "Guillermo Rauch <guillermo@learnboost.com>",
   "keywords": [
     "mongodb",
@@ -28,8 +28,8 @@
     "sift": "16.0.1"
   },
   "devDependencies": {
-    "@babel/core": "7.22.11",
-    "@babel/preset-env": "7.22.14",
+    "@babel/core": "7.23.0",
+    "@babel/preset-env": "7.22.20",
     "@typescript-eslint/eslint-plugin": "^6.2.1",
     "@typescript-eslint/parser": "^6.2.1",
     "acquit": "1.3.0",
@@ -46,15 +46,15 @@
     "crypto-browserify": "3.12.0",
     "dotenv": "16.3.1",
     "dox": "1.0.0",
-    "eslint": "8.48.0",
+    "eslint": "8.50.0",
     "eslint-plugin-markdown": "^3.0.1",
     "eslint-plugin-mocha-no-only": "1.1.1",
     "express": "^4.18.1",
     "fs-extra": "~11.1.1",
     "highlight.js": "11.8.0",
     "lodash.isequal": "4.5.0",
     "lodash.isequalwith": "4.4.0",
-    "markdownlint-cli2": "^0.9.2",
+    "markdownlint-cli2": "^0.10.0",
     "marked": "4.3.0",
     "mkdirp": "^3.0.1",
     "mocha": "10.2.0",
@@ -64,11 +64,11 @@
     "nyc": "15.1.0",
     "pug": "3.0.2",
     "q": "1.5.1",
-    "sinon": "15.2.0",
+    "sinon": "16.0.0",
     "stream-browserify": "3.0.0",
     "tsd": "0.29.0",
     "typescript": "5.2.2",
-    "uuid": "9.0.0",
+    "uuid": "9.0.1",
     "webpack": "5.88.2"
   },
   "directories": {
diff --git a/test/document.test.js b/test/document.test.js
@@ -12206,6 +12206,8 @@ describe('document', function() {
 
     const x = new Test();
     x.set('d.x.y', 1);
+    assert.strictEqual(x.d.x.y, 1);
+    assert.deepStrictEqual(x.get('d.x'), { y: 1 });
     assert.strictEqual(x.get('d.x.y'), 1);
     await x.save();
 
@@ -12389,6 +12391,7 @@ describe('document', function() {
     assert.strictEqual(nestedProjectionDoc.sub.propertyA, 'A');
   });
 
+<<<<<<< HEAD
   it('should ignore `id` if the object contains `id` and `_id` as keys (gh-13762)', async function() {
     const testSchema = new Schema({
       _id: {
@@ -12402,6 +12405,8 @@ describe('document', function() {
     const fromDb = await Test.findById(x._id).lean();
     assert.equal(fromDb._id, 1);
   });
+=======
+>>>>>>> master
   it('handles bigint (gh-13791)', async function() {
     const testSchema = new mongoose.Schema({
       n: Number,
@@ -12516,6 +12521,25 @@ describe('document', function() {
     assert.ok(err.errors['links']);
     assert.equal(err.errors['links'].message, 'Path `links` is required.');
   });
+
+  it('fires pre validate hooks on 4 level single nested subdocs (gh-13876)', async function() {
+    let attachmentSchemaPreValidateCalls = 0;
+    const attachmentSchema = new Schema({ name: String });
+    attachmentSchema.pre('validate', () => { ++attachmentSchemaPreValidateCalls; });
+
+    const richImageSchema = new Schema({ attachment: { type: attachmentSchema, required: false } });
+    const brandingSchema = new Schema({ logo: richImageSchema });
+    const instanceSchema = new Schema({ branding: brandingSchema });
+    const TestModel = db.model('Test', instanceSchema);
+
+    const instance = await TestModel.create({ branding: { logo: {} } });
+    assert.strictEqual(attachmentSchemaPreValidateCalls, 0);
+    const doc = await TestModel.findById(instance._id);
+
+    doc.set('branding.logo.attachment', { name: 'coolLogo' });
+    await doc.save();
+    assert.strictEqual(attachmentSchemaPreValidateCalls, 1);
+  });
 });
 
 describe('Check if instance function that is supplied in schema option is availabe', function() {
diff --git a/test/helpers/query.cast$expr.test.js b/test/helpers/query.cast$expr.test.js
@@ -108,4 +108,14 @@ describe('castexpr', function() {
     const res = cast$expr({ $not: { $in: ['42', '$nums'] } }, testSchema);
     assert.deepStrictEqual(res, { $not: { $in: [42, '$nums'] } });
   });
+
+  it('casts $round (gh-13881)', function() {
+    const testSchema = new Schema({ value: Number });
+
+    let res = cast$expr({ $eq: [{ $round: ['$value', '00'] }, 2] }, testSchema);
+    assert.deepStrictEqual(res, { $eq: [{ $round: ['$value', 0] }, 2] });
+
+    res = cast$expr({ $eq: [{ $round: ['$value'] }, 2] }, testSchema);
+    assert.deepStrictEqual(res, { $eq: [{ $round: ['$value'] }, 2] });
+  });
 });
diff --git a/test/index.test.js b/test/index.test.js
diff --git a/test/query.cursor.test.js b/test/query.cursor.test.js
diff --git a/test/query.middleware.test.js b/test/query.middleware.test.js
diff --git a/test/query.test.js b/test/query.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
