mongoose 8.6.0 → 8.6.2

package/lib/connection.js

@@ -71,6 +71,9 @@ function Connection(base) {
   } else {
     this.id = base.nextConnectionId;
   }
+
+  // Internal queue of objects `{ fn, ctx, args }` that Mongoose calls when this connection is successfully
+  // opened. In `onOpen()`, Mongoose calls every entry in `_queue` and empties the queue.
   this._queue = [];
 }
 

package/lib/cursor/changeStream.js

@@ -5,6 +5,7 @@
  */
 
 const EventEmitter = require('events').EventEmitter;
+const MongooseError = require('../error/mongooseError');
 
 /*!
  * ignore
@@ -25,6 +26,7 @@ class ChangeStream extends EventEmitter {
     this.bindedEvents = false;
     this.pipeline = pipeline;
     this.options = options;
+    this.errored = false;
 
     if (options && options.hydrate && !options.model) {
       throw new Error(
@@ -33,19 +35,36 @@ class ChangeStream extends EventEmitter {
       );
     }
 
+    let syncError = null;
     this.$driverChangeStreamPromise = new Promise((resolve, reject) => {
       // This wrapper is necessary because of buffering.
-      changeStreamThunk((err, driverChangeStream) => {
-        if (err != null) {
-          this.emit('error', err);
-          return reject(err);
-        }
+      try {
+        changeStreamThunk((err, driverChangeStream) => {
+          if (err != null) {
+            this.errored = true;
+            this.emit('error', err);
+            return reject(err);
+          }
 
-        this.driverChangeStream = driverChangeStream;
-        this.emit('ready');
-        resolve();
-      });
+          this.driverChangeStream = driverChangeStream;
+          this.emit('ready');
+          resolve();
+        });
+      } catch (err) {
+        syncError = err;
+        this.errored = true;
+        this.emit('error', err);
+        reject(err);
+      }
     });
+
+    // Because a ChangeStream is an event emitter, there's no way to register an 'error' handler
+    // that catches errors which occur in the constructor, unless we force sync errors into async
+    // errors with setImmediate(). For cleaner stack trace, we just immediately throw any synchronous
+    // errors that occurred with changeStreamThunk().
+    if (syncError != null) {
+      throw syncError;
+    }
   }
 
   _bindEvents() {
@@ -92,10 +111,16 @@ class ChangeStream extends EventEmitter {
   }
 
   hasNext(cb) {
+    if (this.errored) {
+      throw new MongooseError('Cannot call hasNext() on errored ChangeStream');
+    }
     return this.driverChangeStream.hasNext(cb);
   }
 
   next(cb) {
+    if (this.errored) {
+      throw new MongooseError('Cannot call next() on errored ChangeStream');
+    }
     if (this.options && this.options.hydrate) {
       if (cb != null) {
         const originalCb = cb;
@@ -126,16 +151,25 @@ class ChangeStream extends EventEmitter {
   }
 
   addListener(event, handler) {
+    if (this.errored) {
+      throw new MongooseError('Cannot call addListener() on errored ChangeStream');
+    }
     this._bindEvents();
     return super.addListener(event, handler);
   }
 
   on(event, handler) {
+    if (this.errored) {
+      throw new MongooseError('Cannot call on() on errored ChangeStream');
+    }
     this._bindEvents();
     return super.on(event, handler);
   }
 
   once(event, handler) {
+    if (this.errored) {
+      throw new MongooseError('Cannot call once() on errored ChangeStream');
+    }
     this._bindEvents();
     return super.once(event, handler);
   }

package/lib/cursor/queryCursor.js

@@ -10,7 +10,7 @@ const eachAsync = require('../helpers/cursor/eachAsync');
 const helpers = require('../queryHelpers');
 const kareem = require('kareem');
 const immediate = require('../helpers/immediate');
-const { once } = require('node:events');
+const { once } = require('events');
 const util = require('util');
 
 /**

package/lib/document.js

@@ -1213,7 +1213,7 @@ Document.prototype.$set = function $set(path, val, type, options) {
         this.$__setValue(path, null);
         cleanModifiedSubpaths(this, path);
       } else {
-        return this.$set(val, path, constructing);
+        return this.$set(val, path, constructing, options);
       }
 
       const keys = getKeysInSchemaOrder(this.$__schema, val, path);
@@ -3856,7 +3856,6 @@ Document.prototype.$toObject = function(options, json) {
   // Parent options should only bubble down for subdocuments, not populated docs
   options._parentOptions = this.$isSubdocument ? options : null;
 
-  options._skipSingleNestedGetters = false;
   // remember the root transform function
   // to save it from being overwritten by sub-transform functions
   // const originalTransform = options.transform;
@@ -3870,13 +3869,13 @@ Document.prototype.$toObject = function(options, json) {
     ret = clone(this._doc, options) || {};
   }
 
-  options._skipSingleNestedGetters = true;
   const getters = options._calledWithOptions.getters
     ?? options.getters
     ?? defaultOptions.getters
     ?? false;
+
   if (getters) {
-    applyGetters(this, ret, options);
+    applyGetters(this, ret);
 
     if (options.minimize) {
       ret = minimize(ret) || {};
@@ -4187,12 +4186,11 @@ function applyVirtuals(self, json, options, toObjectOptions) {
  *
  * @param {Document} self
  * @param {Object} json
- * @param {Object} [options]
  * @return {Object} `json`
  * @api private
  */
 
-function applyGetters(self, json, options) {
+function applyGetters(self, json) {
   const schema = self.$__schema;
   const paths = Object.keys(schema.paths);
   let i = paths.length;
@@ -4228,8 +4226,10 @@ function applyGetters(self, json, options) {
       if (branch != null && typeof branch !== 'object') {
         break;
       } else if (ii === last) {
-        const val = self.$get(path);
-        branch[part] = clone(val, options);
+        branch[part] = schema.paths[path].applyGetters(
+          branch[part],
+          self
+        );
         if (Array.isArray(branch[part]) && schema.paths[path].$embeddedSchemaType) {
           for (let i = 0; i < branch[part].length; ++i) {
             branch[part][i] = schema.paths[path].$embeddedSchemaType.applyGetters(

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

@@ -96,7 +96,7 @@ NativeConnection.prototype.useDb = function(name, options) {
   if (this.db && this._readyState === STATES.connected) {
     wireup();
   } else {
-    this.once('connected', wireup);
+    this._queue.push({ fn: wireup });
   }
 
   function wireup() {

package/lib/helpers/clone.js

@@ -40,11 +40,6 @@ function clone(obj, options, isArrayChild) {
 
   if (isMongooseObject(obj)) {
     if (options) {
-      // Single nested subdocs should apply getters later in `applyGetters()`
-      // when calling `toObject()`. See gh-7442, gh-8295
-      if (options._skipSingleNestedGetters && obj.$isSingleNested) {
-        options._calledWithOptions = Object.assign({}, options._calledWithOptions || {}, { getters: false });
-      }
       if (options.retainDocuments && obj.$__ != null) {
         const clonedDoc = obj.$clone();
         if (obj.__index != null) {

package/lib/model.js

@@ -3368,11 +3368,19 @@ Model.bulkWrite = async function bulkWrite(ops, options) {
 };
 
 /**
- *  takes an array of documents, gets the changes and inserts/updates documents in the database
- *  according to whether or not the document is new, or whether it has changes or not.
+ * Takes an array of documents, gets the changes and inserts/updates documents in the database
+ * according to whether or not the document is new, or whether it has changes or not.
  *
  * `bulkSave` uses `bulkWrite` under the hood, so it's mostly useful when dealing with many documents (10K+)
  *
+ * `bulkSave()` throws errors under the following conditions:
+ *
+ * - one of the provided documents fails validation. In this case, `bulkSave()` does not send a `bulkWrite()`, and throws the first validation error.
+ * - `bulkWrite()` fails (for example, due to being unable to connect to MongoDB or due to duplicate key error)
+ * - `bulkWrite()` did not insert or update **any** documents. In this case, `bulkSave()` will throw a DocumentNotFound error.
+ *
+ * Note that `bulkSave()` will **not** throw an error if only some of the `save()` calls succeeded.
+ *
  * @param {Array<Document>} documents
  * @param {Object} [options] options passed to the underlying `bulkWrite()`
  * @param {Boolean} [options.timestamps] defaults to `null`, when set to false, mongoose will not add/update timestamps to the documents.
@@ -3380,7 +3388,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)
- *
+ * @return {BulkWriteResult} the return value from `bulkWrite()`
  */
 Model.bulkSave = async function bulkSave(documents, options) {
   options = options || {};
@@ -3408,18 +3416,31 @@ Model.bulkSave = async function bulkSave(documents, options) {
     (err) => ({ bulkWriteResult: null, bulkWriteError: err })
   );
 
-  await Promise.all(
-    documents.map(async(document) => {
-      const documentError = bulkWriteError && bulkWriteError.writeErrors.find(writeError => {
-        const writeErrorDocumentId = writeError.err.op._id || writeError.err.op.q._id;
-        return writeErrorDocumentId.toString() === document._doc._id.toString();
-      });
+  const matchedCount = bulkWriteResult?.matchedCount ?? 0;
+  const insertedCount = bulkWriteResult?.insertedCount ?? 0;
+  if (writeOperations.length > 0 && matchedCount + insertedCount === 0 && !bulkWriteError) {
+    throw new DocumentNotFoundError(
+      writeOperations.filter(op => op.updateOne).map(op => op.updateOne.filter),
+      this.modelName,
+      writeOperations.length,
+      bulkWriteResult
+    );
+  }
 
-      if (documentError == null) {
-        await handleSuccessfulWrite(document);
-      }
-    })
-  );
+  const successfulDocuments = [];
+  for (let i = 0; i < documents.length; i++) {
+    const document = documents[i];
+    const documentError = bulkWriteError && bulkWriteError.writeErrors.find(writeError => {
+      const writeErrorDocumentId = writeError.err.op._id || writeError.err.op.q._id;
+      return writeErrorDocumentId.toString() === document._doc._id.toString();
+    });
+
+    if (documentError == null) {
+      successfulDocuments.push(document);
+    }
+  }
+
+  await Promise.all(successfulDocuments.map(document => handleSuccessfulWrite(document)));
 
   if (bulkWriteError && bulkWriteError.writeErrors && bulkWriteError.writeErrors.length) {
     throw bulkWriteError;

package/lib/plugins/trackTransaction.js

@@ -27,13 +27,6 @@ module.exports = function trackTransaction(schema) {
       initialState.atomics = _getAtomics(this);
 
       session[sessionNewDocuments].set(this, initialState);
-    } else {
-      const state = session[sessionNewDocuments].get(this);
-
-      for (const path of Object.keys(this.$__.activePaths.getStatePaths('modify'))) {
-        state.modifiedPaths.add(path);
-      }
-      state.atomics = _getAtomics(this, state.atomics);
     }
   });
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mongoose",
   "description": "Mongoose MongoDB ODM",
-  "version": "8.6.0",
+  "version": "8.6.2",
   "author": "Guillermo Rauch <guillermo@learnboost.com>",
   "keywords": [
     "mongodb",
@@ -29,9 +29,9 @@
   },
   "devDependencies": {
     "@babel/core": "7.24.7",
-    "@babel/preset-env": "7.25.3",
-    "@typescript-eslint/eslint-plugin": "^6.21.0",
-    "@typescript-eslint/parser": "^6.21.0",
+    "@babel/preset-env": "7.25.4",
+    "@typescript-eslint/eslint-plugin": "^8.4.0",
+    "@typescript-eslint/parser": "^8.4.0",
     "acquit": "1.3.0",
     "acquit-ignore": "0.2.1",
     "acquit-require": "0.1.1",
@@ -40,7 +40,7 @@
     "babel-loader": "8.2.5",
     "broken-link-checker": "^0.7.8",
     "buffer": "^5.6.0",
-    "cheerio": "1.0.0-rc.12",
+    "cheerio": "1.0.0",
     "crypto-browserify": "3.12.0",
     "dotenv": "16.4.5",
     "dox": "1.0.0",
@@ -53,9 +53,9 @@
     "lodash.isequal": "4.5.0",
     "lodash.isequalwith": "4.4.0",
     "markdownlint-cli2": "^0.13.0",
-    "marked": "14.0.0",
+    "marked": "14.1.0",
     "mkdirp": "^3.0.1",
-    "mocha": "10.7.0",
+    "mocha": "10.7.3",
     "moment": "2.30.1",
     "mongodb-memory-server": "10.0.0",
     "ncp": "^2.0.0",

package/types/cursor.d.ts

@@ -8,6 +8,7 @@ declare module 'mongoose' {
     parallel?: number;
     batchSize?: number;
     continueOnError?: boolean;
+    signal?: AbortSignal;
   }
 
   class Cursor<DocType = any, Options = never> extends stream.Readable {

package/types/inferrawdoctype.d.ts

@@ -91,8 +91,8 @@ declare module 'mongoose' {
             IfEquals<PathValueType, String> extends true ? PathEnumOrString<Options['enum']> :
               PathValueType extends NumberSchemaDefinition ? Options['enum'] extends ReadonlyArray<any> ? Options['enum'][number] : number :
                 IfEquals<PathValueType, Schema.Types.Number> extends true ? number :
-                  PathValueType extends DateSchemaDefinition ? Date :
-                    IfEquals<PathValueType, Schema.Types.Date> extends true ? Date :
+                  PathValueType extends DateSchemaDefinition ? NativeDate :
+                    IfEquals<PathValueType, Schema.Types.Date> extends true ? NativeDate :
                       PathValueType extends typeof Buffer | 'buffer' | 'Buffer' | typeof Schema.Types.Buffer ? Buffer :
                         PathValueType extends BooleanSchemaDefinition ? boolean :
                           IfEquals<PathValueType, Schema.Types.Boolean> extends true ? boolean :

package/types/inferschematype.d.ts

@@ -281,8 +281,8 @@ type ResolvePathType<PathValueType, Options extends SchemaTypeOptions<PathValueT
               IfEquals<PathValueType, String> extends true ? PathEnumOrString<Options['enum']> :
                 PathValueType extends NumberSchemaDefinition ? Options['enum'] extends ReadonlyArray<any> ? Options['enum'][number] : number :
                   IfEquals<PathValueType, Schema.Types.Number> extends true ? number :
-                    PathValueType extends DateSchemaDefinition ? Date :
-                      IfEquals<PathValueType, Schema.Types.Date> extends true ? Date :
+                    PathValueType extends DateSchemaDefinition ? NativeDate :
+                      IfEquals<PathValueType, Schema.Types.Date> extends true ? NativeDate :
                         PathValueType extends typeof Buffer | 'buffer' | 'Buffer' | typeof Schema.Types.Buffer ? Buffer :
                           PathValueType extends BooleanSchemaDefinition ? boolean :
                             IfEquals<PathValueType, Schema.Types.Boolean> extends true ? boolean :

package/types/query.d.ts

@@ -12,7 +12,7 @@ declare module 'mongoose' {
    */
   type RootFilterQuery<T> = FilterQuery<T> | Query<any, any> | Types.ObjectId;
 
-  type FilterQuery<T> ={
+  type FilterQuery<T> = {
     [P in keyof T]?: Condition<T[P]>;
   } & RootQuerySelector<T> & { _id?: Condition<string>; };
 
@@ -116,10 +116,9 @@ declare module 'mongoose' {
     $where?: string | Function;
     /** @see https://www.mongodb.com/docs/manual/reference/operator/query/comment/#op._S_comment */
     $comment?: string;
-    // we could not find a proper TypeScript generic to support nested queries e.g. 'user.friends.name'
-    // this will mark all unrecognized properties as any (including nested queries) only if
-    // they include a "." (to avoid generically allowing any unexpected keys)
-    [nestedSelector: `${string}.${string}`]: any;
+    $expr?: Record<string, any>;
+    // this will mark all unrecognized properties as any (including nested queries)
+    [key: string]: any;
   };
 
   interface QueryTimestampsConfig {

package/types/schematypes.d.ts

@@ -216,6 +216,9 @@ declare module 'mongoose' {
     /** Attaches a getter for all instances of this schema type. */
     static get(getter: (value: any) => any): void;
 
+    /** Array containing default setters for all instances of this SchemaType */
+    static setters: ((val?: unknown, priorVal?: unknown, doc?: Document<unknown>, options?: Record<string, any> | null) => unknown)[];
+
     /** The class that Mongoose uses internally to instantiate this SchemaType's `options` property. */
     OptionsConstructor: SchemaTypeOptions<T>;