Merge branch 'master' into gh-pages

Author: vkarpov15

.github/workflows/benchmark.yml

@@ -28,7 +28,7 @@ jobs:
       - name: Setup node
         uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
         with:
-          node-version: 16
+          node-version: 22
 
       - run: npm install
 

.github/workflows/documentation.yml

@@ -33,7 +33,7 @@ jobs:
       - name: Setup node
         uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
         with:
-          node-version: 20
+          node-version: 22
 
       - run: npm install
 
@@ -54,7 +54,7 @@ jobs:
       - name: Setup node
         uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
         with:
-          node-version: 20
+          node-version: 22
 
       - run: npm install
       - name: Setup MongoDB

.github/workflows/test.yml

@@ -27,7 +27,7 @@ jobs:
       - name: Setup node
         uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
         with:
-          node-version: 18
+          node-version: 22
 
       - run: npm install
 
@@ -39,7 +39,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node: [16, 18, 20]
+        node: [16, 18, 20, 22]
         os: [ubuntu-20.04, ubuntu-22.04]
         mongodb: [4.4.29, 5.0.26, 6.0.15, 7.0.12, 8.0.0]
         include:
@@ -98,7 +98,7 @@ jobs:
       - name: Setup node
         uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
         with:
-          node-version: 16
+          node-version: 22
       - name: Load MongoDB binary cache
         id: cache-mongodb-binaries
         uses: actions/cache@v4
@@ -126,7 +126,7 @@ jobs:
       - name: Setup node
         uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
         with:
-          node-version: 16
+          node-version: 22
       - run: npm install
       - name: Test
         run: npm run test-rs

.github/workflows/tidelift-alignment.yml

@@ -19,7 +19,7 @@ jobs:
       - name: Setup node
         uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
         with:
-          node-version: 16
+          node-version: 22
       - name: Alignment
         uses: tidelift/alignment-action@8d7700fe795fc01179c1f9fa05b72a089873027d # main
         env:

.github/workflows/tsd.yml

@@ -25,7 +25,7 @@ jobs:
       - name: Setup node
         uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
         with:
-          node-version: 18
+          node-version: 22
 
       - run: npm install
 
@@ -43,7 +43,7 @@ jobs:
       - name: Setup node
         uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
         with:
-          node-version: 16
+          node-version: 22
 
       - run: npm install
 

CHANGELOG.md

@@ -1,3 +1,17 @@
+8.8.2 / 2024-11-18
+==================
+ * fix(model): handle array filters when casting bulkWrite #15036 #14978
+ * fix(model): make diffIndexes() avoid trying to drop default timeseries collection index #15035 #14984
+ * fix: save execution stack in query as string #15039 [durran](https://github.com/durran)
+ * types(cursor): correct asyncIterator and asyncDispose for TypeScript with lib: 'esnext' #15038
+ * docs(migrating_to_8): add note about removing findByIdAndRemove #15024 [dragontaek-lee](https://github.com/dragontaek-lee)
+
+8.8.1 / 2024-11-08
+==================
+ * perf: make a few micro-optimizations to help speed up findOne() #15022 #14906
+ * fix: apply embedded discriminators to subdoc schemas before compiling top level model so middleware applies correctly #15001 #14961
+ * fix(query): add overwriteImmutable option to allow updating immutable properties without disabling strict mode #15000 #8619
+
 8.8.0 / 2024-10-31
 ==================
  * feat: upgrade mongodb -> ~6.10 #14991 #14877

docs/migrating_to_8.md

@@ -87,6 +87,9 @@ In Mongoose 7, `findOneAndRemove()` was an alias for `findOneAndDelete()` that M
 Mongoose 8 no longer supports `findOneAndRemove()`.
 Use `findOneAndDelete()` instead.
 
+Similarly, Mongoose 8 no longer supports `findByIdAndRemove()`, which was an alias for `findByIdAndDelete()`.
+Please use `findByIdAndDelete()` instead.
+
 ## Removed `count()` {#removed-count}
 
 `Model.count()` and `Query.prototype.count()` were removed in Mongoose 8. Use `Model.countDocuments()` and `Query.prototype.countDocuments()` instead.

lib/helpers/indexes/isTimeseriesIndex.js

@@ -0,0 +1,16 @@
+'use strict';
+
+/**
+ * Returns `true` if the given index matches the schema's `timestamps` options
+ */
+
+module.exports = function isTimeseriesIndex(dbIndex, schemaOptions) {
+  if (schemaOptions.timeseries == null) {
+    return false;
+  }
+  const { timeField, metaField } = schemaOptions.timeseries;
+  if (typeof timeField !== 'string' || typeof metaField !== 'string') {
+    return false;
+  }
+  return Object.keys(dbIndex.key).length === 2 && dbIndex.key[timeField] === 1 && dbIndex.key[metaField] === 1;
+};

lib/helpers/model/castBulkWrite.js

@@ -103,7 +103,8 @@ module.exports = function castBulkWrite(originalModel, op, options) {
         });
         op['updateOne']['update'] = castUpdate(model.schema, update, {
           strict: strict,
-          upsert: op['updateOne'].upsert
+          upsert: op['updateOne'].upsert,
+          arrayFilters: op['updateOne'].arrayFilters
         }, model, op['updateOne']['filter']);
       } catch (error) {
         return callback(error, null);
@@ -162,7 +163,8 @@ module.exports = function castBulkWrite(originalModel, op, options) {
 
         op['updateMany']['update'] = castUpdate(model.schema, op['updateMany']['update'], {
           strict: strict,
-          upsert: op['updateMany'].upsert
+          upsert: op['updateMany'].upsert,
+          arrayFilters: op['updateMany'].arrayFilters
         }, model, op['updateMany']['filter']);
       } catch (error) {
         return callback(error, null);

lib/model.js

@@ -51,6 +51,7 @@ const immediate = require('./helpers/immediate');
 const internalToObjectOptions = require('./options').internalToObjectOptions;
 const isDefaultIdIndex = require('./helpers/indexes/isDefaultIdIndex');
 const isIndexEqual = require('./helpers/indexes/isIndexEqual');
+const isTimeseriesIndex = require('./helpers/indexes/isTimeseriesIndex');
 const {
   getRelatedDBIndexes,
   getRelatedSchemaIndexes
@@ -1418,6 +1419,10 @@ function getIndexesToDrop(schema, schemaIndexes, dbIndexes) {
     if (isDefaultIdIndex(dbIndex)) {
       continue;
     }
+    // Timeseries collections have a default index on { timeField: 1, metaField: 1 }.
+    if (isTimeseriesIndex(dbIndex, schema.options)) {
+      continue;
+    }
 
     for (const [schemaIndexKeysObject, schemaIndexOptions] of schemaIndexes) {
       const options = decorateDiscriminatorIndexOptions(schema, clone(schemaIndexOptions));
@@ -1429,9 +1434,11 @@ function getIndexesToDrop(schema, schemaIndexes, dbIndexes) {
       }
     }
 
-    if (!found) {
-      toDrop.push(dbIndex.name);
+    if (found) {
+      continue;
     }
+
+    toDrop.push(dbIndex.name);
   }
 
   return toDrop;

lib/query.js

@@ -4433,10 +4433,10 @@ Query.prototype.exec = async function exec(op) {
       str = str.slice(0, 60) + '...';
     }
     const err = new MongooseError('Query was already executed: ' + str);
-    err.originalStack = this._executionStack.stack;
+    err.originalStack = this._executionStack;
     throw err;
   } else {
-    this._executionStack = new Error();
+    this._executionStack = new Error().stack;
   }
 
   let skipWrappedFunction = null;

package.json

@@ -1,7 +1,7 @@
 {
   "name": "mongoose",
   "description": "Mongoose MongoDB ODM",
-  "version": "8.8.0",
+  "version": "8.8.2",
   "author": "Guillermo Rauch <[email protected]>",
   "keywords": [
     "mongodb",

test/model.test.js

@@ -4125,6 +4125,55 @@ describe('Model', function() {
         assert.equal(err.validationErrors[0].errors['num'].name, 'CastError');
       });
 
+      it('handles array filters (gh-14978)', async function() {
+        const embedDiscriminatorSchema = new mongoose.Schema({
+          field1: String
+        });
+
+        const embedSchema = new mongoose.Schema({
+          field: String,
+          key: String
+        }, { discriminatorKey: 'key' });
+        embedSchema.discriminator('Type1', embedDiscriminatorSchema);
+
+        const testSchema = new mongoose.Schema({
+          testArray: [embedSchema]
+        });
+        const TestModel = db.model('Test', testSchema);
+
+        const test = new TestModel({
+          testArray: [{
+            key: 'Type1',
+            field: 'field',
+            field1: 'field1'
+          }]
+        });
+        const r1 = await test.save();
+        assert.equal(r1.testArray[0].field1, 'field1');
+
+        const field1update = 'field1 update';
+        await TestModel.bulkWrite([{
+          updateOne: {
+            filter: { _id: r1._id },
+            update: {
+              $set: {
+                'testArray.$[element].field1': field1update,
+                'testArray.$[element].nonexistentProp': field1update
+              }
+            },
+            arrayFilters: [
+              {
+                'element._id': r1.testArray[0]._id,
+                'element.key': 'Type1'
+              }
+            ]
+          }
+        }]);
+        const r2 = await TestModel.findById(r1._id).lean();
+        assert.equal(r2.testArray[0].field1, field1update);
+        assert.strictEqual(r2.testArray[0].nonexistentProp, undefined);
+      });
+
       it('with child timestamps and array filters (gh-7032)', async function() {
         const childSchema = new Schema({ name: String }, { timestamps: true });
 
@@ -8147,6 +8196,52 @@ describe('Model', function() {
       assert.ok(obj.post.updatedAt.valueOf(), new Date('2023-06-01T18:00:00.000Z').valueOf());
     });
   });
+
+  describe('diffIndexes()', function() {
+    it('avoids trying to drop timeseries collections (gh-14984)', async function() {
+      const version = await start.mongodVersion();
+      if (version[0] < 5) {
+        this.skip();
+        return;
+      }
+
+      const schema = new mongoose.Schema(
+        {
+          time: {
+            type: Date
+          },
+          deviceId: {
+            type: String
+          }
+        },
+        {
+          timeseries: {
+            timeField: 'time',
+            metaField: 'deviceId',
+            granularity: 'seconds'
+          },
+          autoCreate: false
+        }
+      );
+
+      const TestModel = db.model(
+        'TimeSeriesTest',
+        schema,
+        'gh14984'
+      );
+
+      await db.dropCollection('gh14984').catch(err => {
+        if (err.codeName === 'NamespaceNotFound') {
+          return;
+        }
+        throw err;
+      });
+      await TestModel.createCollection();
+
+      const { toDrop } = await TestModel.diffIndexes();
+      assert.deepStrictEqual(toDrop, []);
+    });
+  });
 });
 
 

types/cursor.d.ts

@@ -11,8 +11,10 @@ declare module 'mongoose' {
     signal?: AbortSignal;
   }
 
-  class Cursor<DocType = any, Options = never> extends stream.Readable {
-    [Symbol.asyncIterator](): AsyncIterableIterator<DocType>;
+  class Cursor<DocType = any, Options = never, NextResultType = DocType | null> extends stream.Readable {
+    [Symbol.asyncIterator](): Cursor<IteratorResult<DocType>, Options, IteratorResult<DocType>>;
+
+    [Symbol.asyncDispose](): Promise<void>;
 
     /**
      * Adds a [cursor flag](https://mongodb.github.io/node-mongodb-native/4.9/classes/FindCursor.html#addCursorFlag).
@@ -58,7 +60,7 @@ declare module 'mongoose' {
      * Get the next document from this cursor. Will return `null` when there are
      * no documents left.
      */
-    next(): Promise<DocType | null>;
+    next(): Promise<NextResultType>;
 
     options: Options;
   }