Merge branch '6.x'

Author: vkarpov15

.github/workflows/test.yml

@@ -106,7 +106,7 @@ jobs:
       - name: Setup Deno
         uses: denoland/setup-deno@v1
         with:
-          deno-version: v1.30.x
+          deno-version: v1.33.x
       - run: deno --version
       - run: npm install
       - name: Run Deno tests

CHANGELOG.md

@@ -1,3 +1,18 @@
+6.11.1 / 2023-05-08
+===================
+ * fix(query): apply schema-level paths before calculating projection for findOneAndUpdate() #13348 #13340
+ * fix: add SUPPRESS_JEST_WARNINGS environment variable to hide jest warnings #13384 #13373
+ * types(model): allow overwriting expected param type for bulkWrite() #13292 [hasezoey](https://github.com/hasezoey)
+
+6.11.0 / 2023-05-01
+===================
+ * feat: upgrade to mongodb 4.16.0 for Deno+Atlas connection fix #13337 #13075
+ * perf: speed up creating maps of subdocuments #13280 #13191 #13271
+ * fix(query): set ObjectParameterError if calling findOneAndX() with filter as non-object #13338
+ * fix(document): merge Document $inc calls instead of overwriting #13322
+ * fix(update): handle casting doubly nested arrays with $pullAll #13285
+ * docs: backport documentation versioning changes to 6.x #13253 #13190 [hasezoey](https://github.com/hasezoey)
+
 7.1.0 / 2023-04-27
 ==================
  * feat: upgrade mongodb -> 5.3.0

benchmarks/mapOfSubdocs.js

@@ -0,0 +1,55 @@
+'use strict';
+
+const mongoose = require('../');
+
+run().catch(err => {
+  console.error(err);
+  process.exit(-1);
+});
+
+async function run() {
+  await mongoose.connect('mongodb://127.0.0.1:27017/mongoose_test', {
+    serverSelectionTimeoutMS: 5000
+  });
+
+  const minisMap = new mongoose.Schema(
+    {
+      //? Mini reference
+      mini: {
+        type: Map,
+        of: new mongoose.Schema({
+          //? Mini ID
+          miniID: { type: mongoose.Schema.Types.ObjectId, ref: 'Mini', required: true },
+          //? Timestamp as number
+          timestamp: { type: Number, required: true },
+        }),
+      },
+    },
+    //? Automatic creation of timestamps for creation and updating.
+    //? This will be created on the background by the package
+    { timestamps: true }
+  );
+  const MinisMap = mongoose.model('MinisMap', minisMap);
+  await MinisMap.init();
+  
+  const mini = new Map();
+  for (let i = 0; i < 2000; ++i) {
+    const miniID = new mongoose.Types.ObjectId();
+    mini.set(miniID, {
+      miniID,
+      timestamp: Math.floor(Math.random() * 1000000)
+    });
+  }
+
+  let loopStart = Date.now();
+
+  for (let k = 0; k < 10; k++) {
+    await MinisMap.create({ mini });
+  }
+
+  const results = {
+    'Average save time ms': (Date.now() - loopStart) / 10
+  };
+
+  console.log(JSON.stringify(results, null, '  '));
+}

docs/jest.md

@@ -4,6 +4,12 @@ Jest is a JavaScript runtime developed by Facebook that is usually used for test
 Because Jest is designed primarily for testing React applications, using it to test Node.js server-side applications comes with a lot of caveats.
 We strongly recommend using a different testing framework, like [Mocha](https://mochajs.org/).
 
+To suppress any Jest warnings from Mongoose, set the `SUPPRESS_JEST_WARNINGS` environment variable:
+
+```
+env SUPPRESS_JEST_WARNINGS=1 npm test
+```
+
 If you choose to delve into dangerous waters and test Mongoose apps with Jest, here's what you need to know:
 
 <h2 id="recommended-testenvironment"><a href="#recommended-testenvironment">Recommended <code>testEnvironment</code></a></h2>

lib/document.js

@@ -1778,7 +1778,11 @@ Document.prototype.$inc = function $inc(path, val) {
 
   if (shouldSet) {
     this.$__.primitiveAtomics = this.$__.primitiveAtomics || {};
-    this.$__.primitiveAtomics[path] = { $inc: valToInc };
+    if (this.$__.primitiveAtomics[path] == null) {
+      this.$__.primitiveAtomics[path] = { $inc: valToInc };
+    } else {
+      this.$__.primitiveAtomics[path].$inc += valToInc;
+    }
     this.markModified(path);
     this.$__setValue(path, valToSet);
   }
@@ -2195,19 +2199,26 @@ Document.prototype[documentModifiedPaths] = Document.prototype.modifiedPaths;
 
 Document.prototype.isModified = function(paths, modifiedPaths) {
   if (paths) {
-    const directModifiedPaths = Object.keys(this.$__.activePaths.getStatePaths('modify'));
-    if (directModifiedPaths.length === 0) {
-      return false;
-    }
-
     if (!Array.isArray(paths)) {
       paths = paths.indexOf(' ') === -1 ? [paths] : paths.split(' ');
     }
+
+    const directModifiedPathsObj = this.$__.activePaths.states.modify;
+    if (directModifiedPathsObj == null) {
+      return false;
+    }
+    for (const path of paths) {
+      if (Object.prototype.hasOwnProperty.call(directModifiedPathsObj, path)) {
+        return true;
+      }
+    }
+
     const modified = modifiedPaths || this[documentModifiedPaths]();
     const isModifiedChild = paths.some(function(path) {
       return !!~modified.indexOf(path);
     });
 
+    const directModifiedPaths = Object.keys(directModifiedPathsObj);
     return isModifiedChild || paths.some(function(path) {
       return directModifiedPaths.some(function(mod) {
         return mod === path || path.startsWith(mod + '.');

lib/error/objectParameter.js

@@ -18,7 +18,7 @@ class ObjectParameterError extends MongooseError {
    */
   constructor(value, paramName, fnName) {
     super('Parameter "' + paramName + '" to ' + fnName +
-      '() must be an object, got ' + value.toString());
+      '() must be an object, got "' + value.toString() + '" (type ' + typeof value + ')');
   }
 }
 

lib/helpers/discriminator/mergeDiscriminatorSchema.js

@@ -55,7 +55,8 @@ module.exports = function mergeDiscriminatorSchema(to, from, path, seen) {
         // base schema has a given path as a single nested but discriminator schema
         // has the path as a document array, or vice versa (gh-9534)
         if ((from[key].$isSingleNested && to[key].$isMongooseDocumentArray) ||
-              (from[key].$isMongooseDocumentArray && to[key].$isSingleNested)) {
+              (from[key].$isMongooseDocumentArray && to[key].$isSingleNested) ||
+              (from[key].$isMongooseDocumentArrayElement && to[key].$isMongooseDocumentArrayElement)) {
           continue;
         } else if (from[key].instanceOfSchema) {
           if (to[key].instanceOfSchema) {

lib/helpers/printJestWarning.js

@@ -2,16 +2,20 @@
 
 const utils = require('../utils');
 
-if (typeof jest !== 'undefined' && typeof window !== 'undefined') {
-  utils.warn('Mongoose: looks like you\'re trying to test a Mongoose app ' +
-    'with Jest\'s default jsdom test environment. Please make sure you read ' +
-    'Mongoose\'s docs on configuring Jest to test Node.js apps: ' +
-    'https://mongoosejs.com/docs/jest.html');
-}
+if (typeof jest !== 'undefined' && !process.env.SUPPRESS_JEST_WARNINGS) {
+  if (typeof window !== 'undefined') {
+    utils.warn('Mongoose: looks like you\'re trying to test a Mongoose app ' +
+      'with Jest\'s default jsdom test environment. Please make sure you read ' +
+      'Mongoose\'s docs on configuring Jest to test Node.js apps: ' +
+      'https://mongoosejs.com/docs/jest.html. Set the SUPPRESS_JEST_WARNINGS to true ' +
+      'to hide this warning.');
+  }
 
-if (typeof jest !== 'undefined' && setTimeout.clock != null && typeof setTimeout.clock.Date === 'function') {
-  utils.warn('Mongoose: looks like you\'re trying to test a Mongoose app ' +
-    'with Jest\'s mock timers enabled. Please make sure you read ' +
-    'Mongoose\'s docs on configuring Jest to test Node.js apps: ' +
-    'https://mongoosejs.com/docs/jest.html');
+  if (setTimeout.clock != null && typeof setTimeout.clock.Date === 'function') {
+    utils.warn('Mongoose: looks like you\'re trying to test a Mongoose app ' +
+      'with Jest\'s mock timers enabled. Please make sure you read ' +
+      'Mongoose\'s docs on configuring Jest to test Node.js apps: ' +
+      'https://mongoosejs.com/docs/jest.html. Set the SUPPRESS_JEST_WARNINGS to true ' +
+      'to hide this warning.');
+  }
 }

lib/query.js

@@ -1967,9 +1967,13 @@ Query.prototype._optionsForExec = function(model) {
     }
   }
 
-  const projection = this._fieldsForExec();
-  if (projection != null) {
-    options.projection = projection;
+  this._applyPaths();
+  if (this._fields != null) {
+    this._fields = this._castFields(this._fields);
+    const projection = this._fieldsForExec();
+    if (projection != null) {
+      options.projection = projection;
+    }
   }
 
   return options;
@@ -2218,10 +2222,6 @@ Query.prototype._find = async function _find() {
     throw this.error();
   }
 
-  this._applyPaths();
-  this._fields = this._castFields(this._fields);
-
-  const fields = this._fieldsForExec();
   const mongooseOptions = this._mongooseOptions;
   const _this = this;
   const userProvidedFields = _this._userProvidedFields || {};
@@ -2237,8 +2237,8 @@ Query.prototype._find = async function _find() {
   });
 
   const options = this._optionsForExec();
-  options.projection = this._fieldsForExec();
   const filter = this._conditions;
+  const fields = options.projection;
 
   const cursor = await this._collection.collection.find(filter, options);
   if (options.explain) {
@@ -2481,8 +2481,6 @@ Query.prototype._findOne = async function _findOne() {
     throw err;
   }
 
-  this._applyPaths();
-  this._fields = this._castFields(this._fields);
   applyGlobalMaxTimeMS(this.options, this.model);
   applyGlobalDiskUse(this.options, this.model);
 
@@ -3153,8 +3151,8 @@ function prepareDiscriminatorCriteria(query) {
  * @api public
  */
 
-Query.prototype.findOneAndUpdate = function(criteria, doc, options) {
-  if (typeof conditions === 'function' ||
+Query.prototype.findOneAndUpdate = function(filter, doc, options) {
+  if (typeof filter === 'function' ||
       typeof doc === 'function' ||
       typeof options === 'function' ||
       typeof arguments[3] === 'function') {
@@ -3170,13 +3168,17 @@ Query.prototype.findOneAndUpdate = function(criteria, doc, options) {
       options = undefined;
       break;
     case 1:
-      doc = criteria;
-      criteria = options = undefined;
+      doc = filter;
+      filter = options = undefined;
       break;
   }
 
-  if (mquery.canMerge(criteria)) {
-    this.merge(criteria);
+  if (mquery.canMerge(filter)) {
+    this.merge(filter);
+  } else if (filter != null) {
+    this.error(
+      new ObjectParameterError(filter, 'filter', 'findOneAndUpdate')
+    );
   }
 
   // apply doc
@@ -3378,7 +3380,7 @@ Query.prototype.findOneAndRemove = function(conditions, options) {
  *
  * @method findOneAndDelete
  * @memberOf Query
- * @param {Object} [conditions]
+ * @param {Object} [filter]
  * @param {Object} [options]
  * @param {Boolean} [options.rawResult] if true, returns the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/4.9/interfaces/ModifyResult.html)
  * @param {ClientSession} [options.session=null] The session associated with this query. See [transactions docs](https://mongoosejs.com/docs/transactions.html).
@@ -3388,8 +3390,8 @@ Query.prototype.findOneAndRemove = function(conditions, options) {
  * @api public
  */
 
-Query.prototype.findOneAndDelete = function(conditions, options) {
-  if (typeof conditions === 'function' ||
+Query.prototype.findOneAndDelete = function(filter, options) {
+  if (typeof filter === 'function' ||
       typeof options === 'function' ||
       typeof arguments[2] === 'function') {
     throw new MongooseError('Query.prototype.findOneAndDelete() no longer accepts a callback');
@@ -3399,8 +3401,8 @@ Query.prototype.findOneAndDelete = function(conditions, options) {
   this._validateOp();
   this._validate();
 
-  if (mquery.canMerge(conditions)) {
-    this.merge(conditions);
+  if (mquery.canMerge(filter)) {
+    this.merge(filter);
   }
 
   options && this.setOptions(options);
@@ -3512,6 +3514,10 @@ Query.prototype.findOneAndReplace = function(filter, replacement, options) {
 
   if (mquery.canMerge(filter)) {
     this.merge(filter);
+  } else if (filter != null) {
+    this.error(
+      new ObjectParameterError(filter, 'filter', 'findOneAndReplace')
+    );
   }
 
   if (replacement != null) {
@@ -3555,16 +3561,6 @@ Query.prototype._findOneAndReplace = async function _findOneAndReplace() {
   const filter = this._conditions;
   const options = this._optionsForExec();
   convertNewToReturnDocument(options);
-  let fields = null;
-
-  this._applyPaths();
-  if (this._fields != null) {
-    options.projection = this._castFields(clone(this._fields));
-    fields = options.projection;
-    if (fields instanceof Error) {
-      throw fields;
-    }
-  }
 
   const runValidators = _getOption(this, 'runValidators', false);
   if (runValidators === false) {
@@ -4890,6 +4886,9 @@ Query.prototype._castFields = function _castFields(fields) {
  */
 
 Query.prototype._applyPaths = function applyPaths() {
+  if (!this.model) {
+    return;
+  }
   this._fields = this._fields || {};
   helpers.applyPaths(this._fields, this.model.schema);
 
@@ -4948,9 +4947,6 @@ Query.prototype._applyPaths = function applyPaths() {
  */
 
 Query.prototype.cursor = function cursor(opts) {
-  this._applyPaths();
-  this._fields = this._castFields(this._fields);
-
   if (opts) {
     this.setOptions(opts);
   }