mongoose 8.5.5 → 8.6.1

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,16 +35,36 @@ class ChangeStream extends EventEmitter {
       );
     }
 
-    // This wrapper is necessary because of buffering.
-    changeStreamThunk((err, driverChangeStream) => {
-      if (err != null) {
+    let syncError = null;
+    this.$driverChangeStreamPromise = new Promise((resolve, reject) => {
+      // This wrapper is necessary because of buffering.
+      try {
+        changeStreamThunk((err, driverChangeStream) => {
+          if (err != null) {
+            this.errored = true;
+            this.emit('error', err);
+            return reject(err);
+          }
+
+          this.driverChangeStream = driverChangeStream;
+          this.emit('ready');
+          resolve();
+        });
+      } catch (err) {
+        syncError = err;
+        this.errored = true;
         this.emit('error', err);
-        return;
+        reject(err);
       }
-
-      this.driverChangeStream = driverChangeStream;
-      this.emit('ready');
     });
+
+    // 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() {
@@ -53,20 +75,23 @@ class ChangeStream extends EventEmitter {
     this.bindedEvents = true;
 
     if (this.driverChangeStream == null) {
-      this.once('ready', () => {
-        this.driverChangeStream.on('close', () => {
-          this.closed = true;
-        });
+      this.$driverChangeStreamPromise.then(
+        () => {
+          this.driverChangeStream.on('close', () => {
+            this.closed = true;
+          });
 
-        driverChangeStreamEvents.forEach(ev => {
-          this.driverChangeStream.on(ev, data => {
-            if (data != null && data.fullDocument != null && this.options && this.options.hydrate) {
-              data.fullDocument = this.options.model.hydrate(data.fullDocument);
-            }
-            this.emit(ev, data);
+          driverChangeStreamEvents.forEach(ev => {
+            this.driverChangeStream.on(ev, data => {
+              if (data != null && data.fullDocument != null && this.options && this.options.hydrate) {
+                data.fullDocument = this.options.model.hydrate(data.fullDocument);
+              }
+              this.emit(ev, data);
+            });
           });
-        });
-      });
+        },
+        () => {} // No need to register events if opening change stream failed
+      );
 
       return;
     }
@@ -86,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;
@@ -120,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);
   }
@@ -142,8 +182,12 @@ class ChangeStream extends EventEmitter {
     this.closed = true;
     if (this.driverChangeStream) {
       return this.driverChangeStream.close();
+    } else {
+      return this.$driverChangeStreamPromise.then(
+        () => this.driverChangeStream.close(),
+        () => {} // No need to close if opening the change stream failed
+      );
     }
-    return Promise.resolve();
   }
 }
 

package/lib/cursor/queryCursor.js

@@ -10,6 +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 util = require('util');
 
 /**
@@ -42,6 +43,7 @@ function QueryCursor(query) {
   this.cursor = null;
   this.skipped = false;
   this.query = query;
+  this._closed = false;
   const model = query.model;
   this._mongooseOptions = {};
   this._transforms = [];
@@ -135,6 +137,25 @@ QueryCursor.prototype._read = function() {
   });
 };
 
+/**
+ * Returns the underlying cursor from the MongoDB Node driver that this cursor uses.
+ *
+ * @method getDriverCursor
+ * @memberOf QueryCursor
+ * @returns {Cursor} MongoDB Node driver cursor instance
+ * @instance
+ * @api public
+ */
+
+QueryCursor.prototype.getDriverCursor = async function getDriverCursor() {
+  if (this.cursor) {
+    return this.cursor;
+  }
+
+  await once(this, 'cursor');
+  return this.cursor;
+};
+
 /**
  * Registers a transform function which subsequently maps documents retrieved
  * via the streams interface or `.next()`
@@ -209,6 +230,7 @@ QueryCursor.prototype.close = async function close() {
   }
   try {
     await this.cursor.close();
+    this._closed = true;
     this.emit('close');
   } catch (error) {
     this.listeners('error').length > 0 && this.emit('error', error);
@@ -246,6 +268,9 @@ QueryCursor.prototype.next = async function next() {
   if (typeof arguments[0] === 'function') {
     throw new MongooseError('QueryCursor.prototype.next() no longer accepts a callback');
   }
+  if (this._closed) {
+    throw new MongooseError('Cannot call `next()` on a closed cursor');
+  }
   return new Promise((resolve, reject) => {
     _next(this, function(error, doc) {
       if (error) {

package/lib/document.js

@@ -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/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

@@ -2115,17 +2115,21 @@ Model.countDocuments = function countDocuments(conditions, options) {
  *
  * @param {String} field
  * @param {Object} [conditions] optional
+ * @param {Object} [options] optional
  * @return {Query}
  * @api public
  */
 
-Model.distinct = function distinct(field, conditions) {
+Model.distinct = function distinct(field, conditions, options) {
   _checkContext(this, 'distinct');
-  if (typeof arguments[0] === 'function' || typeof arguments[1] === 'function') {
+  if (typeof arguments[0] === 'function' || typeof arguments[1] === 'function' || typeof arguments[2] === 'function') {
     throw new MongooseError('Model.distinct() no longer accepts a callback');
   }
 
   const mq = new this.Query({}, {}, this, this.$__collection);
+  if (options != null) {
+    mq.setOptions(options);
+  }
 
   return mq.distinct(field, conditions);
 };
@@ -3364,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.
@@ -3376,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 || {};
@@ -3404,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/query.js

@@ -2777,7 +2777,7 @@ Query.prototype.estimatedDocumentCount = function(options) {
   this.op = 'estimatedDocumentCount';
   this._validateOp();
 
-  if (typeof options === 'object' && options != null) {
+  if (options != null) {
     this.setOptions(options);
   }
 
@@ -2836,7 +2836,7 @@ Query.prototype.countDocuments = function(conditions, options) {
     this.merge(conditions);
   }
 
-  if (typeof options === 'object' && options != null) {
+  if (options != null) {
     this.setOptions(options);
   }
 
@@ -2874,21 +2874,24 @@ Query.prototype.__distinct = async function __distinct() {
  *
  * #### Example:
  *
+ *     distinct(field, conditions, options)
  *     distinct(field, conditions)
  *     distinct(field)
  *     distinct()
  *
  * @param {String} [field]
  * @param {Object|Query} [filter]
+ * @param {Object} [options]
  * @return {Query} this
  * @see distinct https://www.mongodb.com/docs/manual/reference/method/db.collection.distinct/
  * @api public
  */
 
-Query.prototype.distinct = function(field, conditions) {
+Query.prototype.distinct = function(field, conditions, options) {
   if (typeof field === 'function' ||
       typeof conditions === 'function' ||
-      typeof arguments[2] === 'function') {
+      typeof options === 'function' ||
+      typeof arguments[3] === 'function') {
     throw new MongooseError('Query.prototype.distinct() no longer accepts a callback');
   }
 
@@ -2907,6 +2910,10 @@ Query.prototype.distinct = function(field, conditions) {
     this._distinct = field;
   }
 
+  if (options != null) {
+    this.setOptions(options);
+  }
+
   return this;
 };
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mongoose",
   "description": "Mongoose MongoDB ODM",
-  "version": "8.5.5",
+  "version": "8.6.1",
   "author": "Guillermo Rauch <guillermo@learnboost.com>",
   "keywords": [
     "mongodb",
@@ -21,7 +21,7 @@
   "dependencies": {
     "bson": "^6.7.0",
     "kareem": "2.6.3",
-    "mongodb": "6.7.0",
+    "mongodb": "6.8.0",
     "mpath": "0.9.0",
     "mquery": "5.0.0",
     "ms": "2.1.3",
@@ -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",
@@ -67,7 +67,7 @@
     "tsd": "0.31.1",
     "typescript": "5.5.4",
     "uuid": "10.0.0",
-    "webpack": "5.93.0"
+    "webpack": "5.94.0"
   },
   "directories": {
     "lib": "./lib/mongoose"

package/types/document.d.ts

@@ -22,7 +22,7 @@ declare module 'mongoose' {
     constructor(doc?: any);
 
     /** This documents _id. */
-    _id?: T;
+    _id: T;
 
     /** This documents __v. */
     __v?: any;
@@ -259,11 +259,14 @@ declare module 'mongoose' {
     set(value: string | Record<string, any>): this;
 
     /** The return value of this method is used in calls to JSON.stringify(doc). */
+    toJSON(options?: ToObjectOptions & { flattenMaps?: true }): FlattenMaps<Require_id<DocType>>;
+    toJSON(options: ToObjectOptions & { flattenMaps: false }): Require_id<DocType>;
     toJSON<T = Require_id<DocType>>(options?: ToObjectOptions & { flattenMaps?: true }): FlattenMaps<T>;
     toJSON<T = Require_id<DocType>>(options: ToObjectOptions & { flattenMaps: false }): T;
 
     /** Converts this document into a plain-old JavaScript object ([POJO](https://masteringjs.io/tutorials/fundamentals/pojo)). */
-    toObject<T = Require_id<DocType>>(options?: ToObjectOptions): Require_id<T>;
+    toObject(options?: ToObjectOptions): Require_id<DocType>;
+    toObject<T>(options?: ToObjectOptions): Require_id<T>;
 
     /** Clears the modified state on the specified path. */
     unmarkModified<T extends keyof DocType>(path: T): void;

package/types/inferrawdoctype.d.ts

@@ -1,4 +1,5 @@
 import {
+  IsPathRequired,
   IsSchemaTypeFromBuiltinClass,
   RequiredPaths,
   OptionalPaths,
@@ -14,7 +15,9 @@ declare module 'mongoose' {
     [
     K in keyof (RequiredPaths<DocDefinition, TSchemaOptions['typeKey']> &
     OptionalPaths<DocDefinition, TSchemaOptions['typeKey']>)
-    ]: ObtainRawDocumentPathType<DocDefinition[K], TSchemaOptions['typeKey']>;
+    ]: IsPathRequired<DocDefinition[K], TSchemaOptions['typeKey']> extends true
+      ? ObtainRawDocumentPathType<DocDefinition[K], TSchemaOptions['typeKey']>
+      : ObtainRawDocumentPathType<DocDefinition[K], TSchemaOptions['typeKey']> | null;
   }, TSchemaOptions>;
 
   /**