mongoose 8.9.2 → 8.9.4

package/lib/cursor/queryCursor.js

@@ -557,17 +557,11 @@ function _onNext(error, doc) {
 
   if (this.ctx._batchDocs.length < this.ctx.options._populateBatchSize) {
     // If both `batchSize` and `_populateBatchSize` are huge, calling `next()` repeatedly may
-    // cause a stack overflow. So make sure we clear the stack regularly.
-    if (this.ctx._batchDocs.length > 0 && this.ctx._batchDocs.length % 1000 === 0) {
-      return immediate(() => this.ctx.cursor.next().then(
-        res => { _onNext.call(this, null, res); },
-        err => { _onNext.call(this, err); }
-      ));
-    }
-    this.ctx.cursor.next().then(
+    // cause a stack overflow. So make sure we clear the stack.
+    immediate(() => this.ctx.cursor.next().then(
       res => { _onNext.call(this, null, res); },
       err => { _onNext.call(this, err); }
-    );
+    ));
   } else {
     _populateBatch.call(this);
   }

package/lib/document.js

@@ -55,6 +55,7 @@ const documentIsModified = require('./helpers/symbols').documentIsModified;
 const documentModifiedPaths = require('./helpers/symbols').documentModifiedPaths;
 const documentSchemaSymbol = require('./helpers/symbols').documentSchemaSymbol;
 const getSymbol = require('./helpers/symbols').getSymbol;
+const modelSymbol = require('./helpers/symbols').modelSymbol;
 const populateModelSymbol = require('./helpers/symbols').populateModelSymbol;
 const scopeSymbol = require('./helpers/symbols').scopeSymbol;
 const schemaMixedSymbol = require('./schema/symbols').schemaMixedSymbol;
@@ -1386,7 +1387,9 @@ Document.prototype.$set = function $set(path, val, type, options) {
       const model = val.constructor;
 
       // Check ref
-      const ref = schema.options.ref;
+      const refOpt = typeof schema.options.ref === 'function' && !schema.options.ref[modelSymbol] ? schema.options.ref.call(this, this) : schema.options.ref;
+
+      const ref = refOpt?.modelName || refOpt;
       if (ref != null && (ref === model.modelName || ref === model.baseModelName)) {
         return true;
       }
@@ -3703,8 +3706,10 @@ Document.prototype.$getAllSubdocs = function(options) {
   const subDocs = [];
   function getSubdocs(doc) {
     const newSubdocs = [];
-    for (const { path } of doc.$__schema.childSchemas) {
-      const val = doc.$__getValue(path);
+
+    for (const { model } of doc.$__schema.childSchemas) {
+      // Avoid using `childSchemas.path` to avoid compatibility versions with pre-8.8 versions of Mongoose
+      const val = doc.$__getValue(model.path);
       if (val == null) {
         continue;
       }
@@ -3726,6 +3731,7 @@ Document.prototype.$getAllSubdocs = function(options) {
         }
       }
     }
+
     for (const subdoc of newSubdocs) {
       getSubdocs(subdoc);
     }

package/lib/model.js

@@ -69,6 +69,7 @@ const util = require('util');
 const utils = require('./utils');
 const minimize = require('./helpers/minimize');
 const MongooseBulkSaveIncompleteError = require('./error/bulkSaveIncompleteError');
+const ObjectExpectedError = require('./error/objectExpected');
 
 const modelCollectionSymbol = Symbol('mongoose#Model#collection');
 const modelDbSymbol = Symbol('mongoose#Model#db');
@@ -387,7 +388,11 @@ Model.prototype.$__handleSave = function(options, callback) {
 
     this[modelCollectionSymbol].updateOne(where, update, saveOptions).then(
       ret => {
-        ret.$where = where;
+        if (ret == null) {
+          ret = { $where: where };
+        } else {
+          ret.$where = where;
+        }
         callback(null, ret);
       },
       err => {
@@ -3431,6 +3436,7 @@ Model.bulkWrite = async function bulkWrite(ops, options) {
  * @param {String|number} [options.w=1] The [write concern](https://www.mongodb.com/docs/manual/reference/write-concern/). See [`Query#w()`](https://mongoosejs.com/docs/api/query.html#Query.prototype.w()) for more information.
  * @param {number} [options.wtimeout=null] The [write concern timeout](https://www.mongodb.com/docs/manual/reference/write-concern/#wtimeout).
  * @param {Boolean} [options.j=true] If false, disable [journal acknowledgement](https://www.mongodb.com/docs/manual/reference/write-concern/#j-option)
+ * @param {Boolean} [options.validateBeforeSave=true] set to `false` to skip Mongoose validation on all documents
  * @return {BulkWriteResult} the return value from `bulkWrite()`
  */
 Model.bulkSave = async function bulkSave(documents, options) {
@@ -3450,15 +3456,13 @@ Model.bulkSave = async function bulkSave(documents, options) {
     }
   }
 
-  await Promise.all(documents.map(buildPreSavePromise));
+  await Promise.all(documents.map(doc => buildPreSavePromise(doc, options)));
 
   const writeOperations = this.buildBulkWriteOperations(documents, { skipValidation: true, timestamps: options.timestamps });
-
-  const { bulkWriteResult, bulkWriteError } = await this.bulkWrite(writeOperations, options).then(
+  const { bulkWriteResult, bulkWriteError } = await this.bulkWrite(writeOperations, { skipValidation: true, ...options }).then(
     (res) => ({ bulkWriteResult: res, bulkWriteError: null }),
     (err) => ({ bulkWriteResult: null, bulkWriteError: err })
   );
-
   // If not a MongoBulkWriteError, treat this as all documents failed to save.
   if (bulkWriteError != null && !(bulkWriteError instanceof MongoBulkWriteError)) {
     throw bulkWriteError;
@@ -3486,7 +3490,6 @@ Model.bulkSave = async function bulkSave(documents, options) {
       successfulDocuments.push(document);
     }
   }
-
   await Promise.all(successfulDocuments.map(document => handleSuccessfulWrite(document)));
 
   if (bulkWriteError && bulkWriteError.writeErrors && bulkWriteError.writeErrors.length) {
@@ -3496,9 +3499,9 @@ Model.bulkSave = async function bulkSave(documents, options) {
   return bulkWriteResult;
 };
 
-function buildPreSavePromise(document) {
+function buildPreSavePromise(document, options) {
   return new Promise((resolve, reject) => {
-    document.schema.s.hooks.execPre('save', document, (err) => {
+    document.schema.s.hooks.execPre('save', document, [options], (err) => {
       if (err) {
         reject(err);
         return;
@@ -3687,7 +3690,21 @@ Model.castObject = function castObject(obj, options) {
     }
 
     if (schemaType.$isMongooseDocumentArray) {
-      continue;
+      const castNonArraysOption = schemaType.options?.castNonArrays ?? schemaType.constructor.options.castNonArrays;
+      if (!Array.isArray(val)) {
+        if (!castNonArraysOption) {
+          if (!options.ignoreCastErrors) {
+            error = error || new ValidationError();
+            error.addError(path, new ObjectExpectedError(path, val));
+          }
+        } else {
+          cur[pieces[pieces.length - 1]] = [
+            Model.castObject.call(schemaType.caster, val)
+          ];
+        }
+
+        continue;
+      }
     }
     if (schemaType.$isSingleNested || schemaType.$isMongooseDocumentArrayElement) {
       try {

package/lib/schema/documentArray.js

@@ -522,6 +522,7 @@ SchemaDocumentArray.prototype.clone = function() {
   }
   schematype.Constructor.discriminators = Object.assign({},
     this.Constructor.discriminators);
+  schematype._appliedDiscriminators = this._appliedDiscriminators;
   return schematype;
 };
 

package/lib/schema/subdocument.js

@@ -393,5 +393,6 @@ SchemaSubdocument.prototype.clone = function() {
     schematype.requiredValidator = this.requiredValidator;
   }
   schematype.caster.discriminators = Object.assign({}, this.caster.discriminators);
+  schematype._appliedDiscriminators = this._appliedDiscriminators;
   return schematype;
 };

package/lib/schema.js

@@ -2148,7 +2148,7 @@ Schema.prototype.index = function(fields, options) {
 
   for (const existingIndex of this.indexes()) {
     if (options.name == null && existingIndex[1].name == null && isIndexSpecEqual(existingIndex[0], fields)) {
-      throw new MongooseError(`Schema already has an index on ${JSON.stringify(fields)}`);
+      utils.warn(`Duplicate schema index on ${JSON.stringify(fields)} found. This is often due to declaring an index using both "index: true" and "schema.index()". Please remove the duplicate index definition.`);
     }
   }
 

package/lib/utils.js

@@ -631,6 +631,9 @@ exports.getValue = function(path, obj, map) {
 const mapGetterOptions = Object.freeze({ getters: false });
 
 function getValueLookup(obj, part) {
+  if (part === '$*' && obj instanceof Map) {
+    return obj;
+  }
   let _from = obj?._doc || obj;
   if (_from != null && _from.isMongooseArrayProxy) {
     _from = _from.__array;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mongoose",
   "description": "Mongoose MongoDB ODM",
-  "version": "8.9.2",
+  "version": "8.9.4",
   "author": "Guillermo Rauch <guillermo@learnboost.com>",
   "keywords": [
     "mongodb",
@@ -30,34 +30,32 @@
   "devDependencies": {
     "@babel/core": "7.26.0",
     "@babel/preset-env": "7.26.0",
-    "@typescript-eslint/eslint-plugin": "^8.18.0",
-    "@typescript-eslint/parser": "^8.18.0",
+    "@typescript-eslint/eslint-plugin": "^8.19.1",
+    "@typescript-eslint/parser": "^8.19.1",
     "acquit": "1.3.0",
     "acquit-ignore": "0.2.1",
     "acquit-require": "0.1.1",
     "assert-browserify": "2.0.0",
-    "axios": "1.1.3",
     "babel-loader": "8.2.5",
     "broken-link-checker": "^0.7.8",
     "buffer": "^5.6.0",
     "cheerio": "1.0.0",
     "crypto-browserify": "3.12.1",
-    "dotenv": "16.4.5",
     "dox": "1.0.0",
-    "eslint": "8.57.0",
-    "eslint-plugin-markdown": "^5.0.0",
+    "eslint": "8.57.1",
+    "eslint-plugin-markdown": "^5.1.0",
     "eslint-plugin-mocha-no-only": "1.2.0",
     "express": "^4.19.2",
     "fs-extra": "~11.2.0",
-    "highlight.js": "11.10.0",
+    "highlight.js": "11.11.1",
     "lodash.isequal": "4.5.0",
     "lodash.isequalwith": "4.4.0",
-    "markdownlint-cli2": "^0.15.0",
-    "marked": "15.0.3",
+    "markdownlint-cli2": "^0.17.1",
+    "marked": "15.0.4",
     "mkdirp": "^3.0.1",
-    "mocha": "10.8.2",
+    "mocha": "11.0.1",
     "moment": "2.30.1",
-    "mongodb-memory-server": "10.1.2",
+    "mongodb-memory-server": "10.1.3",
     "ncp": "^2.0.0",
     "nyc": "15.1.0",
     "pug": "3.0.3",
@@ -67,7 +65,7 @@
     "tsd": "0.31.2",
     "typescript": "5.7.2",
     "uuid": "11.0.3",
-    "webpack": "5.96.1"
+    "webpack": "5.97.1"
   },
   "directories": {
     "lib": "./lib/mongoose"

package/types/index.d.ts

@@ -491,7 +491,7 @@ declare module 'mongoose' {
     remove(paths: string | Array<string>): this;
 
     /** Removes index by name or index spec */
-    remove(index: string | AnyObject): this;
+    removeIndex(index: string | AnyObject): this;
 
     /** Returns an Array of path strings that are required by this schema. */
     requiredPaths(invalidate?: boolean): string[];
@@ -710,86 +710,102 @@ declare module 'mongoose' {
     [K in keyof T]: FlattenProperty<T[K]>;
   };
 
+  export type BufferToBinaryProperty<T> = T extends Buffer
+    ? mongodb.Binary
+    : T extends Types.DocumentArray<infer ItemType>
+      ? Types.DocumentArray<BufferToBinary<ItemType>>
+      : T extends Types.Subdocument<unknown, unknown, infer SubdocType>
+        ? HydratedSingleSubdocument<BufferToBinary<SubdocType>>
+        : BufferToBinary<T>;
+
   /**
    * Converts any Buffer properties into mongodb.Binary instances, which is what `lean()` returns
    */
   export type BufferToBinary<T> = T extends Buffer
     ? mongodb.Binary
-    : T extends TreatAsPrimitives
+    : T extends Document
       ? T
-      : T extends Record<string, any> ? {
-        [K in keyof T]: T[K] extends Buffer
-          ? mongodb.Binary
-          : T[K] extends Types.DocumentArray<infer ItemType>
-            ? Types.DocumentArray<BufferToBinary<ItemType>>
-            : T[K] extends Types.Subdocument<unknown, unknown, infer SubdocType>
-              ? HydratedSingleSubdocument<SubdocType>
-              : BufferToBinary<T[K]>;
-      } : T;
+      : T extends TreatAsPrimitives
+        ? T
+        : T extends Record<string, any>
+          ? {
+              [K in keyof T]: BufferToBinaryProperty<T[K]>
+            }
+          : T;
 
   /**
    * Converts any Buffer properties into { type: 'buffer', data: [1, 2, 3] } format for JSON serialization
    */
   export type BufferToJSON<T> = T extends Buffer
     ? { type: 'buffer', data: number[] }
-    : T extends TreatAsPrimitives
+    : T extends Document
       ? T
-      : T extends Record<string, any> ? {
-        [K in keyof T]: T[K] extends Buffer
-          ? { type: 'buffer', data: number[] }
-          : T[K] extends Types.DocumentArray<infer ItemType>
-              ? Types.DocumentArray<BufferToBinary<ItemType>>
-              : T[K] extends Types.Subdocument<unknown, unknown, infer SubdocType>
-                ? HydratedSingleSubdocument<SubdocType>
-                : BufferToBinary<T[K]>;
-      } : T;
+      : T extends TreatAsPrimitives
+        ? T
+        : T extends Record<string, any> ? {
+          [K in keyof T]: T[K] extends Buffer
+            ? { type: 'buffer', data: number[] }
+            : T[K] extends Types.DocumentArray<infer ItemType>
+                ? Types.DocumentArray<BufferToBinary<ItemType>>
+                : T[K] extends Types.Subdocument<unknown, unknown, infer SubdocType>
+                  ? HydratedSingleSubdocument<SubdocType>
+                  : BufferToBinary<T[K]>;
+        } : T;
 
   /**
    * Converts any ObjectId properties into strings for JSON serialization
    */
   export type ObjectIdToString<T> = T extends mongodb.ObjectId
     ? string
-    : T extends TreatAsPrimitives
+    : T extends Document
       ? T
-      : T extends Record<string, any> ? {
-        [K in keyof T]: T[K] extends mongodb.ObjectId
-          ? string
-          : T[K] extends Types.DocumentArray<infer ItemType>
-              ? Types.DocumentArray<ObjectIdToString<ItemType>>
-              : T[K] extends Types.Subdocument<unknown, unknown, infer SubdocType>
-                ? HydratedSingleSubdocument<ObjectIdToString<SubdocType>>
-                : ObjectIdToString<T[K]>;
-      } : T;
+      : T extends TreatAsPrimitives
+        ? T
+        : T extends Record<string, any> ? {
+          [K in keyof T]: T[K] extends mongodb.ObjectId
+            ? string
+            : T[K] extends Types.DocumentArray<infer ItemType>
+                ? Types.DocumentArray<ObjectIdToString<ItemType>>
+                : T[K] extends Types.Subdocument<unknown, unknown, infer SubdocType>
+                  ? HydratedSingleSubdocument<ObjectIdToString<SubdocType>>
+                  : ObjectIdToString<T[K]>;
+        } : T;
 
   /**
    * Converts any Date properties into strings for JSON serialization
    */
   export type DateToString<T> = T extends NativeDate
     ? string
-    : T extends TreatAsPrimitives
+    : T extends Document
       ? T
-      : T extends Record<string, any> ? {
-        [K in keyof T]: T[K] extends NativeDate
-          ? string
-          : T[K] extends (NativeDate | null | undefined)
-            ? string | null | undefined
-            : T[K] extends Types.DocumentArray<infer ItemType>
-                ? Types.DocumentArray<DateToString<ItemType>>
-                : T[K] extends Types.Subdocument<unknown, unknown, infer SubdocType>
-                  ? HydratedSingleSubdocument<DateToString<SubdocType>>
-                  : DateToString<T[K]>;
-      } : T;
+        : T extends TreatAsPrimitives
+        ? T
+        : T extends Record<string, any> ? {
+          [K in keyof T]: T[K] extends NativeDate
+            ? string
+            : T[K] extends (NativeDate | null | undefined)
+              ? string | null | undefined
+              : T[K] extends Types.DocumentArray<infer ItemType>
+                  ? Types.DocumentArray<DateToString<ItemType>>
+                  : T[K] extends Types.Subdocument<unknown, unknown, infer SubdocType>
+                    ? HydratedSingleSubdocument<DateToString<SubdocType>>
+                    : DateToString<T[K]>;
+        } : T;
 
   /**
    * Converts any Mongoose subdocuments (single nested or doc arrays) into POJO equivalents
    */
-  export type SubdocsToPOJOs<T> = T extends TreatAsPrimitives ? T : T extends Record<string, any> ? {
-    [K in keyof T]: T[K] extends Types.DocumentArray<infer ItemType>
-      ? ItemType[]
-      : T[K] extends Types.Subdocument<unknown, unknown, infer SubdocType>
-        ? SubdocType
-        : SubdocsToPOJOs<T[K]>;
-  } : T;
+  export type SubdocsToPOJOs<T> = T extends Document
+    ? T
+    : T extends TreatAsPrimitives
+      ? T
+      : T extends Record<string, any> ? {
+        [K in keyof T]: T[K] extends Types.DocumentArray<infer ItemType>
+          ? ItemType[]
+          : T[K] extends Types.Subdocument<unknown, unknown, infer SubdocType>
+            ? SubdocType
+            : SubdocsToPOJOs<T[K]>;
+      } : T;
 
   export type JSONSerialized<T> = SubdocsToPOJOs<
     FlattenMaps<

package/types/indexes.d.ts

@@ -10,6 +10,9 @@ declare module 'mongoose' {
   function syncIndexes(options?: SyncIndexesOptions): Promise<ConnectionSyncIndexesResult>;
 
   interface IndexManager {
+    /* Deletes all indexes that aren't defined in this model's schema. Used by `syncIndexes()`. Returns list of dropped index names. */
+    cleanIndexes(options?: { toDrop?: string[], hideIndexes?: boolean }): Promise<string[]>;
+
     /**
      * Similar to `ensureIndexes()`, except for it uses the [`createIndex`](https://mongodb.github.io/node-mongodb-native/4.9/classes/Collection.html#createIndex)
      * function.