mongoose 9.10.1 → 9.10.3

package/lib/collection.js

@@ -5,7 +5,6 @@
  */
 
 const EventEmitter = require('events').EventEmitter;
-const STATES = require('./connectionState');
 const immediate = require('./helpers/immediate');
 
 /**
@@ -32,7 +31,7 @@ function Collection(name, conn, opts) {
   this.buffer = !conn?._hasOpened;
   this.emitter = new EventEmitter();
 
-  if (STATES.connected === this.conn.readyState) {
+  if (conn?._hasOpened) {
     this.onOpen();
   }
 }

package/lib/drivers/node-mongodb-native/connection.js

@@ -495,6 +495,11 @@ function _setClient(conn, client, options, dbName) {
         otherDb._flushQueue();
       }
     }
+    for (const collection of Object.values(conn.collections)) {
+      if (collection.buffer) {
+        collection.onOpen();
+      }
+    }
   });
 
   if (options.monitorCommands) {

package/lib/helpers/clone.js

@@ -197,6 +197,11 @@ function cloneObject(obj, options, isArrayChild) {
 }
 
 function cloneArray(arr, options) {
+  const seen = options?._seen;
+  if (seen && seen.has(arr)) {
+    return seen.get(arr);
+  }
+
   let i = 0;
   const len = arr.length;
 
@@ -218,6 +223,10 @@ function cloneArray(arr, options) {
     ret = new Array(len);
   }
 
+  if (seen) {
+    seen.set(arr, ret);
+  }
+
   arr = isMongooseArray(arr) ? arr.__array : arr;
   if (ret.isMongooseDocumentArray) {
     // Create new options object to avoid mutating the shared options.

package/lib/helpers/model/castBulkWrite.js

@@ -149,7 +149,7 @@ module.exports.castUpdateOne = function castUpdateOne(originalModel, updateOne,
     model.schema.options.versionKey
   );
 
-  updateOne['filter'] = cast(model.schema, updateOne['filter'], {
+  updateOne['filter'] = _castFilter(model, updateOne['filter'], {
     strict: strict,
     upsert: updateOne.upsert
   });
@@ -176,11 +176,13 @@ module.exports.castUpdateMany = function castUpdateMany(originalModel, updateMan
   const schema = model.schema;
   const strict = options.strict ?? model.schema.options.strict;
 
+  const update = clone(updateMany['update']);
+
   const globalSetDefaultsOnInsert = originalModel.base.options.setDefaultsOnInsert;
   const shouldSetDefaultsOnInsert = updateMany.setDefaultsOnInsert ?? globalSetDefaultsOnInsert;
 
   if (shouldSetDefaultsOnInsert !== false) {
-    setDefaultsOnInsert(updateMany['filter'], model.schema, updateMany['update'], {
+    setDefaultsOnInsert(updateMany['filter'], model.schema, update, {
       setDefaultsOnInsert: true,
       upsert: updateMany.upsert
     });
@@ -191,29 +193,29 @@ module.exports.castUpdateMany = function castUpdateMany(originalModel, updateMan
   if (model.schema.$timestamps != null && doInitTimestamps) {
     const createdAt = model.schema.$timestamps.createdAt;
     const updatedAt = model.schema.$timestamps.updatedAt;
-    applyTimestampsToUpdate(now, createdAt, updatedAt, updateMany['update'], {
+    applyTimestampsToUpdate(now, createdAt, updatedAt, update, {
       timestamps: updateMany.timestamps,
       overwriteImmutable: updateMany.overwriteImmutable
     }, updateMany.upsert);
   }
   if (doInitTimestamps) {
-    applyTimestampsToChildren(now, updateMany['update'], model.schema);
+    applyTimestampsToChildren(now, update, model.schema);
   }
 
   _addDiscriminatorToObject(schema, updateMany['filter']);
 
   decorateUpdateWithVersionKey(
-    updateMany['update'],
+    update,
     updateMany,
     model.schema.options.versionKey
   );
 
-  updateMany['filter'] = cast(model.schema, updateMany['filter'], {
+  updateMany['filter'] = _castFilter(model, updateMany['filter'], {
     strict: strict,
     upsert: updateMany.upsert
   });
 
-  updateMany['update'] = castUpdate(model.schema, updateMany['update'], {
+  updateMany['update'] = castUpdate(model.schema, update, {
     strict: strict,
     upsert: updateMany.upsert,
     arrayFilters: updateMany.arrayFilters,
@@ -228,7 +230,7 @@ module.exports.castReplaceOne = async function castReplaceOne(originalModel, rep
   const strict = options.strict ?? model.schema.options.strict;
 
   _addDiscriminatorToObject(schema, replaceOne['filter']);
-  replaceOne['filter'] = cast(model.schema, replaceOne['filter'], {
+  replaceOne['filter'] = _castFilter(model, replaceOne['filter'], {
     strict: strict,
     upsert: replaceOne.upsert
   });
@@ -262,7 +264,7 @@ module.exports.castDeleteOne = function castDeleteOne(originalModel, deleteOne)
 
   _addDiscriminatorToObject(schema, deleteOne['filter']);
 
-  deleteOne['filter'] = cast(model.schema, deleteOne['filter']);
+  deleteOne['filter'] = _castFilter(model, deleteOne['filter']);
 };
 
 module.exports.castDeleteMany = function castDeleteMany(originalModel, deleteMany) {
@@ -271,7 +273,7 @@ module.exports.castDeleteMany = function castDeleteMany(originalModel, deleteMan
 
   _addDiscriminatorToObject(schema, deleteMany['filter']);
 
-  deleteMany['filter'] = cast(model.schema, deleteMany['filter']);
+  deleteMany['filter'] = _castFilter(model, deleteMany['filter']);
 };
 
 module.exports.cast = {
@@ -283,6 +285,19 @@ module.exports.cast = {
   deleteMany: module.exports.castDeleteMany
 };
 
+function _castFilter(model, filter, options) {
+  try {
+    return cast(model.schema, filter, options);
+  } catch (err) {
+    // Set the model on cast errors so `{MODEL}` gets replaced, like it is for
+    // query filter casting (gh-8300)
+    if (typeof err.setModel === 'function') {
+      err.setModel(model);
+    }
+    throw err;
+  }
+}
+
 function _addDiscriminatorToObject(schema, obj) {
   if (schema == null) {
     return;

package/lib/helpers/query/castUpdate.js

@@ -262,7 +262,16 @@ function walkUpdatePath(schema, obj, op, options, context, filter, prefix) {
         }
       }
       if (schematype?.schema != null) {
-        obj[key] = cast(schematype.schema, obj[key], options, context);
+        try {
+          obj[key] = cast(schematype.schema, obj[key], options, context);
+        } catch (error) {
+          if (error instanceof CastError) {
+            aggregatedError = _appendError(error, context, key, aggregatedError);
+            continue;
+          } else {
+            throw error;
+          }
+        }
         hasKeys = true;
         continue;
       }
@@ -446,11 +455,15 @@ function walkUpdatePath(schema, obj, op, options, context, filter, prefix) {
         }
       } else {
         if (op === '$rename') {
-          if (obj[key] == null) {
-            throw new CastError('String', obj[key], `${prefix}${key}.$rename`);
+          try {
+            if (obj[key] == null) {
+              throw new CastError('String', obj[key], `${prefix}${key}.$rename`);
+            }
+            const schematype = new SchemaString(`${prefix}${key}.$rename`, null, null, schema);
+            obj[key] = schematype.castForQuery(null, obj[key], context);
+          } catch (error) {
+            aggregatedError = _appendError(error, context, key, aggregatedError);
           }
-          const schematype = new SchemaString(`${prefix}${key}.$rename`, null, null, schema);
-          obj[key] = schematype.castForQuery(null, obj[key], context);
           continue;
         }
 
@@ -499,6 +512,14 @@ function walkUpdatePath(schema, obj, op, options, context, filter, prefix) {
  */
 
 function _appendError(error, query, key, aggregatedError) {
+  // Set the model on cast errors so `{MODEL}` gets replaced, like it is for
+  // query filter casting and document validation (gh-8300). `query` is a
+  // Query, or the model itself when casting a `bulkWrite()` operation.
+  const model = query?.modelName != null ? query : query?.model;
+  if (model != null && typeof error.setModel === 'function') {
+    error.setModel(model);
+  }
+
   if (typeof query !== 'object' || !query.options.multipleCastError) {
     throw error;
   }

package/lib/model.js

@@ -3676,7 +3676,8 @@ Model.bulkSave = async function bulkSave(documents, options) {
 
   await Promise.all(documents.map(doc => buildPreSavePromise(doc, options)));
 
-  const writeOperations = this.buildBulkWriteOperations(documents, options);
+  const documentIndexes = [];
+  const writeOperations = this.buildBulkWriteOperations(documents, options, documentIndexes);
   const opts = { skipValidation: true, _skipCastBulkWrite: true, ...options };
   const { bulkWriteResult, bulkWriteError } = await this.bulkWrite(writeOperations, opts).then(
     (res) => ({ bulkWriteResult: res, bulkWriteError: null }),
@@ -3697,20 +3698,22 @@ Model.bulkSave = async function bulkSave(documents, options) {
     );
   }
 
-  const failedDocumentIds = documents.length >= 25 ? new Set(bulkWriteError?.writeErrors?.map(writeError => {
-    const writeErrorDocumentId = writeError.err.op._id || writeError.err.op.q._id;
-    return writeErrorDocumentId.toString();
-  })) : null;
-  const successfulDocuments = [];
-  for (let i = 0; i < documents.length; i++) {
-    const document = documents[i];
-    const documentId = document._doc._id.toString();
-    const failed = failedDocumentIds == null ? bulkWriteError?.writeErrors.find(writeError => {
-      const writeErrorDocumentId = writeError.err.op._id || writeError.err.op.q._id;
-      return writeErrorDocumentId.toString() === documentId;
-    }) != null : failedDocumentIds.has(documentId);
-    if (!failed) {
-      successfulDocuments.push(document);
+  const writeErrors = bulkWriteError?.writeErrors || [];
+  let successfulDocuments = documents;
+  if (writeErrors.length > 0) {
+    if (options.ordered !== false) {
+      // Unchanged documents don't generate operations, so map back to the input before slicing.
+      successfulDocuments = documents.slice(0, documentIndexes[writeErrors[0].index]);
+    } else {
+      const failedDocumentIndexes = documents.length >= 25 ? {} : null;
+      if (failedDocumentIndexes != null) {
+        for (const writeError of writeErrors) {
+          failedDocumentIndexes[documentIndexes[writeError.index]] = true;
+        }
+      }
+      successfulDocuments = documents.filter((document, i) => failedDocumentIndexes == null ?
+        !writeErrors.some(writeError => documentIndexes[writeError.index] === i) :
+        !failedDocumentIndexes[i]);
     }
   }
   await Promise.all(successfulDocuments.map(document => handleSuccessfulWrite(document, options)));
@@ -3951,6 +3954,18 @@ Model.castObject = function castObject(obj, options) {
   }
 
   if (error != null) {
+    // `{MODEL}` is replaced for query casting and document validation, so do it
+    // here too. Only the top-level call knows the model: the recursive calls for
+    // subdocuments are invoked on the subdocument constructor, which has no
+    // `modelName`, so this runs once over every collected error. (gh-8300)
+    if (this.modelName != null) {
+      for (const key of Object.keys(error.errors)) {
+        const err = error.errors[key];
+        if (typeof err.setModel === 'function') {
+          err.setModel(this);
+        }
+      }
+    }
     throw error;
   }
 
@@ -3964,11 +3979,12 @@ Model.castObject = function castObject(obj, options) {
  * @param {object} options
  * @param {boolean} options.skipValidation defaults to `false`, when set to true, building the write operations will bypass validating the documents.
  * @param {boolean} options.timestamps defaults to `null`, when set to false, mongoose will not add/update timestamps to the documents.
+ * @param {number[]} [documentIndexes] If provided, receives the input document index for each generated operation in order.
  * @return {Promise[]} Returns a array of all Promises the function executes to be awaited.
  * @api private
  */
 
-Model.buildBulkWriteOperations = function buildBulkWriteOperations(documents, options) {
+Model.buildBulkWriteOperations = function buildBulkWriteOperations(documents, options, documentIndexes) {
   if (!Array.isArray(documents)) {
     throw new MongooseError(`bulkSave expects an array of documents to be passed, received \`${documents}\` instead`);
   }
@@ -3998,6 +4014,7 @@ Model.buildBulkWriteOperations = function buildBulkWriteOperations(documents, op
       }
       const writeOperation = { insertOne: { document } };
       utils.injectTimestampsOption(writeOperation.insertOne, options.timestamps);
+      documentIndexes?.push(i);
       return writeOperation;
     }
 
@@ -4024,6 +4041,7 @@ Model.buildBulkWriteOperations = function buildBulkWriteOperations(documents, op
       document.$__version(where, delta);
       const writeOperation = { updateOne: { filter: where, update: changes } };
       utils.injectTimestampsOption(writeOperation.updateOne, options.timestamps);
+      documentIndexes?.push(i);
       return writeOperation;
     }
 

package/lib/schema/map.js

@@ -30,20 +30,6 @@ class SchemaMap extends SchemaType {
     this._createNestedSchemaType(parentSchema, key, options, schemaOptions);
   }
 
-  /**
-   * Sets a default option for all Map instances.
-   *
-   * @param {string} option The option you'd like to set the value for
-   * @param {any} value value for option
-   * @return {undefined}
-   * @function set
-   * @api public
-   */
-
-  set(option, value) {
-    return SchemaType.set(option, value);
-  }
-
   /**
    * Casts to Map
    *
@@ -143,6 +129,19 @@ class SchemaMap extends SchemaType {
   }
 }
 
+/**
+ * Sets a default option for all Map instances.
+ *
+ * @param {string} option The option you'd like to set the value for
+ * @param {any} value value for option
+ * @return {undefined}
+ * @function set
+ * @static
+ * @api public
+ */
+
+SchemaMap.set = SchemaType.set;
+
 /**
  * This schema type's name, to defend against minifiers that mangle
  * function names.

package/lib/schema/union.js

@@ -60,6 +60,10 @@ class Union extends SchemaType {
 
   // Setters also need to be aware of casting - we need to apply the setters of the entry in the union we choose.
   applySetters(val, doc, init, prev, options) {
+    // Setters on the union path itself run first, so they can change which entry
+    // in the union the value resolves to.
+    val = this._applySetters(val, doc, init, prev, options);
+
     let firstValue = firstValueSymbol;
     let lastError;
     // Loop through each schema type in the union. If one of the schematypes returns a value that is `=== val`, then

package/lib/schema.js

@@ -595,12 +595,6 @@ Schema.prototype.omit = function(paths, options) {
 
   newSchema.remove(paths);
 
-  for (const nested in newSchema.singleNestedPaths) {
-    if (paths.includes(nested)) {
-      delete newSchema.singleNestedPaths[nested];
-    }
-  }
-
   return newSchema;
 };
 
@@ -2831,6 +2825,7 @@ Schema.prototype.remove = function(path) {
         this.mapPaths = this.mapPaths.filter(
           schemaType => !schemaType.path.startsWith(name + '.')
         );
+        _deleteSubpaths(this, name);
 
         delete this.nested[name];
         _deletePath(this, name);
@@ -2849,6 +2844,11 @@ Schema.prototype.remove = function(path) {
       this.mapPaths = this.mapPaths.filter(
         schemaType => !schemaType.path.startsWith(name + '.')
       );
+      // A document array registers its element paths under `subpaths` and a
+      // single nested subdocument registers its paths under `singleNestedPaths`.
+      // Left behind, they keep answering `path()` and `pathType()`, and queries
+      // on the removed path keep being cast.
+      _deleteSubpaths(this, name);
       _deletePath(this, name);
 
       this._removeEncryptedField(name);
@@ -2861,6 +2861,20 @@ Schema.prototype.remove = function(path) {
  * ignore
  */
 
+function _deleteSubpaths(schema, name) {
+  const prefix = name + '.';
+  for (const subpath of Object.keys(schema.subpaths)) {
+    if (subpath === name || subpath.startsWith(prefix)) {
+      delete schema.subpaths[subpath];
+    }
+  }
+  for (const subpath of Object.keys(schema.singleNestedPaths)) {
+    if (subpath === name || subpath.startsWith(prefix)) {
+      delete schema.singleNestedPaths[subpath];
+    }
+  }
+}
+
 function _deletePath(schema, name) {
   const pieces = name.split('.');
   const last = pieces.pop();

package/lib/types/documentArray/methods/index.js

@@ -211,6 +211,26 @@ const methods = {
     return this.constructor.prototype.toObject.apply(this, arguments);
   },
 
+  /**
+   * Wraps [`MongooseArray#addToSet`](https://mongoosejs.com/docs/api/array.html#MongooseArray.prototype.addToSet())
+   * with proper change tracking.
+   *
+   * @param {...object} [args]
+   * @api public
+   * @method addToSet
+   * @memberOf MongooseDocumentArray
+   */
+
+  addToSet() {
+    // Arguments are cast before duplicates are skipped, so any value added
+    // after a skipped duplicate is cast with an index that is too high.
+    const ret = ArrayMethods.addToSet.apply(this, arguments);
+
+    _updateSubdocIndexes(this);
+
+    return ret;
+  },
+
   /**
    * Wraps [`Array#push`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/push) with proper change tracking.
    *

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mongoose",
   "description": "Mongoose MongoDB ODM",
-  "version": "9.10.1",
+  "version": "9.10.3",
   "author": "Guillermo Rauch <guillermo@learnboost.com>",
   "keywords": [
     "mongodb",