mongoose 7.3.0 → 7.3.2

package/lib/connection.js

@@ -703,8 +703,7 @@ Connection.prototype.onOpen = function() {
  * @param {Number} [options.heartbeatFrequencyMS] If `useUnifiedTopology = true`, the MongoDB driver sends a heartbeat every `heartbeatFrequencyMS` to check on the status of the connection. A heartbeat is subject to `serverSelectionTimeoutMS`, so the MongoDB driver will retry failed heartbeats for up to 30 seconds by default. Mongoose only emits a `'disconnected'` event after a heartbeat has failed, so you may want to decrease this setting to reduce the time between when your server goes down and when Mongoose emits `'disconnected'`. We recommend you do **not** set this setting below 1000, too many heartbeats can lead to performance degradation.
  * @param {Boolean} [options.autoIndex=true] Mongoose-specific option. Set to false to disable automatic index creation for all models associated with this connection.
  * @param {Class} [options.promiseLibrary] Sets the [underlying driver's promise library](https://mongodb.github.io/node-mongodb-native/4.9/interfaces/MongoClientOptions.html#promiseLibrary).
- * @param {Number} [options.connectTimeoutMS=30000] How long the MongoDB driver will wait before killing a socket due to inactivity _during initial connection_. Defaults to 30000. This option is passed transparently to [Node.js' `socket#setTimeout()` function](https://nodejs.org/api/net.html#net_socket_settimeout_timeout_callback).
- * @param {Number} [options.socketTimeoutMS=30000] How long the MongoDB driver will wait before killing a socket due to inactivity _after initial connection_. A socket may be inactive because of either no activity or a long-running operation. This is set to `30000` by default, you should set this to 2-3x your longest running operation if you expect some of your database operations to run longer than 20 seconds. This option is passed to [Node.js `socket#setTimeout()` function](https://nodejs.org/api/net.html#net_socket_settimeout_timeout_callback) after the MongoDB driver successfully completes.
+ * @param {Number} [options.socketTimeoutMS=0] How long the MongoDB driver will wait before killing a socket due to inactivity _after initial connection_. A socket may be inactive because of either no activity or a long-running operation. `socketTimeoutMS` defaults to 0, which means Node.js will not time out the socket due to inactivity. This option is passed to [Node.js `socket#setTimeout()` function](https://nodejs.org/api/net.html#net_socket_settimeout_timeout_callback) after the MongoDB driver successfully completes.
  * @param {Number} [options.family=0] Passed transparently to [Node.js' `dns.lookup()`](https://nodejs.org/api/dns.html#dns_dns_lookup_hostname_options_callback) function. May be either `0, `4`, or `6`. `4` means use IPv4 only, `6` means use IPv6 only, `0` means try both.
  * @param {Boolean} [options.autoCreate=false] Set to `true` to make Mongoose automatically call `createCollection()` on every model created on this connection.
  * @returns {Promise<Connection>}

package/lib/cursor/QueryCursor.js

@@ -84,25 +84,33 @@ function QueryCursor(query, options) {
       this.options._populateBatchSize = Math.min(this.options.batchSize, 5000);
     }
     Object.assign(this.options, query._optionsForExec());
-    model.collection.find(query._conditions, this.options, (err, cursor) => {
-      if (err != null) {
-        this._markError(err);
-        this.listeners('error').length > 0 && this.emit('error', this._error);
-        return;
-      }
-
-      if (this._error) {
-        cursor.close(function() {});
-        this.listeners('error').length > 0 && this.emit('error', this._error);
-      }
-      this.cursor = cursor;
-      this.emit('cursor', cursor);
-    });
+    if (model.collection._shouldBufferCommands() && model.collection.buffer) {
+      model.collection.queue.push([
+        () => _getRawCursor(query, this)
+      ]);
+    } else {
+      _getRawCursor(query, this);
+    }
   });
 }
 
 util.inherits(QueryCursor, Readable);
 
+/*!
+ * ignore
+ */
+
+function _getRawCursor(query, queryCursor) {
+  try {
+    const cursor = query.model.collection.find(query._conditions, queryCursor.options);
+    queryCursor.cursor = cursor;
+    queryCursor.emit('cursor', cursor);
+  } catch (err) {
+    queryCursor._markError(err);
+    queryCursor.listeners('error').length > 0 && queryCursor.emit('error', queryCursor._error);
+  }
+}
+
 /**
  * Necessary to satisfy the Readable API
  * @method _read

package/lib/index.js

@@ -329,8 +329,7 @@ Mongoose.prototype.get = Mongoose.prototype.set;
  * @param {Class} [options.promiseLibrary] Sets the [underlying driver's promise library](https://mongodb.github.io/node-mongodb-native/4.9/interfaces/MongoClientOptions.html#promiseLibrary).
  * @param {Number} [options.maxPoolSize=5] The maximum number of sockets the MongoDB driver will keep open for this connection. Keep in mind that MongoDB only allows one operation per socket at a time, so you may want to increase this if you find you have a few slow queries that are blocking faster queries from proceeding. See [Slow Trains in MongoDB and Node.js](https://thecodebarbarian.com/slow-trains-in-mongodb-and-nodejs).
  * @param {Number} [options.minPoolSize=1] The minimum number of sockets the MongoDB driver will keep open for this connection. Keep in mind that MongoDB only allows one operation per socket at a time, so you may want to increase this if you find you have a few slow queries that are blocking faster queries from proceeding. See [Slow Trains in MongoDB and Node.js](https://thecodebarbarian.com/slow-trains-in-mongodb-and-nodejs).
- * @param {Number} [options.connectTimeoutMS=30000] How long the MongoDB driver will wait before killing a socket due to inactivity _during initial connection_. Defaults to 30000. This option is passed transparently to [Node.js' `socket#setTimeout()` function](https://nodejs.org/api/net.html#net_socket_settimeout_timeout_callback).
- * @param {Number} [options.socketTimeoutMS=30000] How long the MongoDB driver will wait before killing a socket due to inactivity _after initial connection_. A socket may be inactive because of either no activity or a long-running operation. This is set to `30000` by default, you should set this to 2-3x your longest running operation if you expect some of your database operations to run longer than 20 seconds. This option is passed to [Node.js `socket#setTimeout()` function](https://nodejs.org/api/net.html#net_socket_settimeout_timeout_callback) after the MongoDB driver successfully completes.
+ * @param {Number} [options.socketTimeoutMS=0] How long the MongoDB driver will wait before killing a socket due to inactivity _after initial connection_. Defaults to 0, which means Node.js will not time out the socket due to inactivity. A socket may be inactive because of either no activity or a long-running operation. This option is passed to [Node.js `socket#setTimeout()` function](https://nodejs.org/api/net.html#net_socket_settimeout_timeout_callback) after the MongoDB driver successfully completes.
  * @param {Number} [options.family=0] Passed transparently to [Node.js' `dns.lookup()`](https://nodejs.org/api/dns.html#dns_dns_lookup_hostname_options_callback) function. May be either `0`, `4`, or `6`. `4` means use IPv4 only, `6` means use IPv6 only, `0` means try both.
  * @return {Connection} the created Connection object. Connections are not thenable, so you can't do `await mongoose.createConnection()`. To await use `mongoose.createConnection(uri).asPromise()` instead.
  * @api public
@@ -385,8 +384,7 @@ Mongoose.prototype.createConnection = function(uri, options) {
  * @param {Number} [options.heartbeatFrequencyMS] If `useUnifiedTopology = true`, the MongoDB driver sends a heartbeat every `heartbeatFrequencyMS` to check on the status of the connection. A heartbeat is subject to `serverSelectionTimeoutMS`, so the MongoDB driver will retry failed heartbeats for up to 30 seconds by default. Mongoose only emits a `'disconnected'` event after a heartbeat has failed, so you may want to decrease this setting to reduce the time between when your server goes down and when Mongoose emits `'disconnected'`. We recommend you do **not** set this setting below 1000, too many heartbeats can lead to performance degradation.
  * @param {Boolean} [options.autoIndex=true] Mongoose-specific option. Set to false to disable automatic index creation for all models associated with this connection.
  * @param {Class} [options.promiseLibrary] Sets the [underlying driver's promise library](https://mongodb.github.io/node-mongodb-native/4.9/interfaces/MongoClientOptions.html#promiseLibrary).
- * @param {Number} [options.connectTimeoutMS=30000] How long the MongoDB driver will wait before killing a socket due to inactivity _during initial connection_. Defaults to 30000. This option is passed transparently to [Node.js' `socket#setTimeout()` function](https://nodejs.org/api/net.html#net_socket_settimeout_timeout_callback).
- * @param {Number} [options.socketTimeoutMS=30000] How long the MongoDB driver will wait before killing a socket due to inactivity _after initial connection_. A socket may be inactive because of either no activity or a long-running operation. This is set to `30000` by default, you should set this to 2-3x your longest running operation if you expect some of your database operations to run longer than 20 seconds. This option is passed to [Node.js `socket#setTimeout()` function](https://nodejs.org/api/net.html#net_socket_settimeout_timeout_callback) after the MongoDB driver successfully completes.
+ * @param {Number} [options.socketTimeoutMS=0] How long the MongoDB driver will wait before killing a socket due to inactivity _after initial connection_. A socket may be inactive because of either no activity or a long-running operation. `socketTimeoutMS` defaults to 0, which means Node.js will not time out the socket due to inactivity. This option is passed to [Node.js `socket#setTimeout()` function](https://nodejs.org/api/net.html#net_socket_settimeout_timeout_callback) after the MongoDB driver successfully completes.
  * @param {Number} [options.family=0] Passed transparently to [Node.js' `dns.lookup()`](https://nodejs.org/api/dns.html#dns_dns_lookup_hostname_options_callback) function. May be either `0`, `4`, or `6`. `4` means use IPv4 only, `6` means use IPv6 only, `0` means try both.
  * @param {Boolean} [options.autoCreate=false] Set to `true` to make Mongoose automatically call `createCollection()` on every model created on this connection.
  * @param {Function} [callback]

package/lib/model.js

@@ -1046,16 +1046,18 @@ Model.prototype.$__deleteOne = function $__deleteOne(options, cb) {
     options.session = session;
   }
 
-  this[modelCollectionSymbol].deleteOne(where, options, err => {
-    if (!err) {
+  this[modelCollectionSymbol].deleteOne(where, options).then(
+    () => {
       this.$__.isDeleted = true;
       this.$emit('deleteOne', this);
       this.constructor.emit('deleteOne', this);
       return cb(null, this);
+    },
+    err => {
+      this.$__.isDeleted = false;
+      cb(err);
     }
-    this.$__.isDeleted = false;
-    cb(err);
-  });
+  );
 };
 
 /**
@@ -3232,16 +3234,19 @@ Model.$__insertMany = function(arr, options, callback) {
         }
 
         // `insertedDocs` is a Mongoose-specific property
+        const hasWriteErrors = error && error.writeErrors;
         const erroredIndexes = new Set((error && error.writeErrors || []).map(err => err.index));
 
-        for (let i = 0; i < error.writeErrors.length; ++i) {
-          const originalIndex = validDocIndexToOriginalIndex.get(error.writeErrors[i].index);
-          error.writeErrors[i] = {
-            ...error.writeErrors[i],
-            index: originalIndex
-          };
-          if (!ordered) {
-            results[originalIndex] = error.writeErrors[i];
+        if (error.writeErrors != null) {
+          for (let i = 0; i < error.writeErrors.length; ++i) {
+            const originalIndex = validDocIndexToOriginalIndex.get(error.writeErrors[i].index);
+            error.writeErrors[i] = {
+              ...error.writeErrors[i],
+              index: originalIndex
+            };
+            if (!ordered) {
+              results[originalIndex] = error.writeErrors[i];
+            }
           }
         }
 
@@ -3258,7 +3263,7 @@ Model.$__insertMany = function(arr, options, callback) {
         let firstErroredIndex = -1;
         error.insertedDocs = docAttributes.
           filter((doc, i) => {
-            const isErrored = erroredIndexes.has(i);
+            const isErrored = !hasWriteErrors || erroredIndexes.has(i);
 
             if (ordered) {
               if (firstErroredIndex > -1) {

package/lib/query.js

@@ -3281,6 +3281,12 @@ Query.prototype.findOneAndUpdate = function(filter, doc, options) {
  */
 
 Query.prototype._findOneAndUpdate = async function _findOneAndUpdate() {
+  // For backwards compability with Mongoose 6 re: #13550
+  if (this._mongooseOptions.overwrite) {
+    this.op = 'findOneAndReplace';
+    return this._findOneAndReplace();
+  }
+
   this._castConditions();
 
   _castArrayFilters(this);
@@ -3608,55 +3614,47 @@ Query.prototype._findOneAndReplace = async function _findOneAndReplace() {
     throw this.error();
   }
 
+  if ('strict' in this.options) {
+    this._mongooseOptions.strict = this.options.strict;
+    delete this.options.strict;
+  }
+
   const filter = this._conditions;
   const options = this._optionsForExec();
   this._applyTranslateAliases(options);
   convertNewToReturnDocument(options);
 
-  const runValidators = _getOption(this, 'runValidators', false);
-  if (runValidators === false) {
-    try {
-      this._update = this._castUpdate(this._update, true);
-    } catch (err) {
-      const validationError = new ValidationError();
-      validationError.errors[err.path] = err;
-      throw validationError;
-    }
-
-    let res = await this._collection.collection.findOneAndReplace(filter, this._update || {}, options);
-
-    for (const fn of this._transforms) {
-      res = fn(res);
-    }
-
-    const doc = res.value;
-    return new Promise((resolve, reject) => {
-      this._completeOne(doc, res, _wrapThunkCallback(this, (err, res) => {
-        if (err) {
-          return reject(err);
-        }
-        resolve(res);
-      }));
-    });
+  const modelOpts = { skipId: true };
+  if ('strict' in this._mongooseOptions) {
+    modelOpts.strict = this._mongooseOptions.strict;
   }
 
+  const runValidators = _getOption(this, 'runValidators', false);
 
-  let castedDoc = new this.model(this._update, null, true);
-  this._update = castedDoc;
-  await castedDoc.validate();
-
-  if (castedDoc.toBSON) {
-    castedDoc = castedDoc.toBSON();
+  try {
+    const update = new this.model(this._update, null, modelOpts);
+    if (runValidators) {
+      await update.validate();
+    } else if (update.$__.validationError) {
+      throw update.$__.validationError;
+    }
+    this._update = update.toBSON();
+  } catch (err) {
+    if (err instanceof ValidationError) {
+      throw err;
+    }
+    const validationError = new ValidationError();
+    validationError.errors[err.path] = err;
+    throw validationError;
   }
 
-  let res = await this._collection.collection.findOneAndReplace(filter, castedDoc, options);
+  let res = await this._collection.collection.findOneAndReplace(filter, this._update, options);
 
   for (const fn of this._transforms) {
     res = fn(res);
   }
 
   const doc = res.value;
-
   return new Promise((resolve, reject) => {
     this._completeOne(doc, res, _wrapThunkCallback(this, (err, res) => {
       if (err) {
@@ -4362,7 +4360,10 @@ Query.prototype.exec = async function exec(op) {
   }
 
   if (this.op == null) {
-    throw new Error('Query must have `op` before executing');
+    throw new MongooseError('Query must have `op` before executing');
+  }
+  if (this.model == null) {
+    throw new MongooseError('Query must have an associated model before executing');
   }
   this._validateOp();
 
@@ -4442,6 +4443,13 @@ function _executePostExecHooks(query) {
  */
 
 function _executePostHooks(query, res, error, op) {
+  if (query._queryMiddleware == null) {
+    if (error != null) {
+      throw error;
+    }
+    return res;
+  }
+
   return new Promise((resolve, reject) => {
     const opts = error ? { error } : {};
 
@@ -4475,6 +4483,10 @@ function _executePreExecHooks(query) {
  */
 
 function _executePreHooks(query, op) {
+  if (query._queryMiddleware == null) {
+    return;
+  }
+
   return new Promise((resolve, reject) => {
     query._queryMiddleware.execPre(op || query.op, query, [], (error) => {
       if (error != null) {

package/lib/schematype.js

@@ -810,8 +810,8 @@ SchemaType.prototype.get = function(fn) {
  *     // adding many validators at a time
  *
  *     const many = [
- *         { validator: validator, msg: 'uh oh' }
- *       , { validator: anotherValidator, msg: 'failed' }
+ *         { validator: validator, message: 'uh oh' }
+ *       , { validator: anotherValidator, message: 'failed' }
  *     ]
  *     new Schema({ name: { type: String, validate: many }});
  *

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mongoose",
   "description": "Mongoose MongoDB ODM",
-  "version": "7.3.0",
+  "version": "7.3.2",
   "author": "Guillermo Rauch <guillermo@learnboost.com>",
   "keywords": [
     "mongodb",
@@ -28,10 +28,10 @@
     "sift": "16.0.1"
   },
   "devDependencies": {
-    "@babel/core": "7.22.1",
-    "@babel/preset-env": "7.22.4",
-    "@typescript-eslint/eslint-plugin": "5.59.8",
-    "@typescript-eslint/parser": "5.59.8",
+    "@babel/core": "7.22.5",
+    "@babel/preset-env": "7.22.5",
+    "@typescript-eslint/eslint-plugin": "5.61.0",
+    "@typescript-eslint/parser": "5.61.0",
     "acquit": "1.3.0",
     "acquit-ignore": "0.2.1",
     "acquit-require": "0.1.1",
@@ -44,31 +44,32 @@
     "buffer": "^5.6.0",
     "cheerio": "1.0.0-rc.12",
     "crypto-browserify": "3.12.0",
-    "dotenv": "16.1.3",
+    "dotenv": "16.3.1",
     "dox": "1.0.0",
-    "eslint": "8.41.0",
+    "eslint": "8.44.0",
     "eslint-plugin-markdown": "^3.0.0",
     "eslint-plugin-mocha-no-only": "1.1.1",
     "express": "^4.18.1",
+    "fs-extra": "~11.1.1",
     "highlight.js": "11.8.0",
     "lodash.isequal": "4.5.0",
     "lodash.isequalwith": "4.4.0",
+    "markdownlint-cli2": "^0.8.1",
     "marked": "4.3.0",
-    "mkdirp": "^2.1.3",
+    "mkdirp": "^3.0.1",
     "mocha": "10.2.0",
     "moment": "2.x",
-    "mongodb-memory-server": "8.12.2",
+    "mongodb-memory-server": "8.13.0",
     "ncp": "^2.0.0",
     "nyc": "15.1.0",
     "pug": "3.0.2",
     "q": "1.5.1",
-    "sinon": "15.1.0",
+    "sinon": "15.2.0",
     "stream-browserify": "3.0.0",
     "tsd": "0.28.1",
-    "typescript": "5.1.3",
+    "typescript": "5.1.6",
     "uuid": "9.0.0",
-    "webpack": "5.85.0",
-    "fs-extra": "~11.1.1"
+    "webpack": "5.88.1"
   },
   "directories": {
     "lib": "./lib/mongoose"
@@ -98,9 +99,9 @@
     "docs:prepare:publish:6x": "npm run docs:checkout:6x && npm run docs:merge:6x && npm run docs:clean:stable && env DOCS_DEPLOY=true npm run docs:generate && npm run docs:move:6x:tmp && npm run docs:checkout:gh-pages && npm run docs:copy:tmp:6x",
     "docs:check-links": "blc http://127.0.0.1:8089 -ro",
     "lint": "eslint .",
-    "lint-js": "eslint . --ext .js",
+    "lint-js": "eslint . --ext .js --ext .cjs",
     "lint-ts": "eslint . --ext .ts",
-    "lint-md": "eslint . --ext .md",
+    "lint-md": "markdownlint-cli2 \"**/*.md\"",
     "build-browser": "(rm ./dist/* || true) && node ./scripts/build-browser.js",
     "prepublishOnly": "npm run build-browser",
     "release": "git pull && git push origin master --tags && npm publish",

package/types/index.d.ts

@@ -197,7 +197,7 @@ declare module 'mongoose' {
 
   export type DiscriminatorSchema<DocType, M, TInstanceMethods, TQueryHelpers, TVirtuals, TStaticMethods, DisSchema> =
     DisSchema extends Schema<infer DisSchemaEDocType, infer DisSchemaM, infer DisSchemaInstanceMethods, infer DisSchemaQueryhelpers, infer DisSchemaVirtuals, infer DisSchemaStatics>
-      ? Schema<Omit<DocType, keyof DisSchemaEDocType> & DisSchemaEDocType, DiscriminatorModel<DisSchemaM, M>, DisSchemaInstanceMethods | TInstanceMethods, DisSchemaQueryhelpers | TQueryHelpers, DisSchemaVirtuals | TVirtuals, DisSchemaStatics & TStaticMethods>
+      ? Schema<MergeType<DocType, DisSchemaEDocType>, DiscriminatorModel<DisSchemaM, M>, DisSchemaInstanceMethods | TInstanceMethods, DisSchemaQueryhelpers | TQueryHelpers, DisSchemaVirtuals | TVirtuals, DisSchemaStatics & TStaticMethods>
       : Schema<DocType, M, TInstanceMethods, TQueryHelpers, TVirtuals, TStaticMethods>;
 
   type QueryResultType<T> = T extends Query<infer ResultType, any> ? ResultType : never;
@@ -430,6 +430,8 @@ declare module 'mongoose' {
 
     /** Returns the virtual type with the given `name`. */
     virtualpath<T = THydratedDocumentType>(name: string): VirtualType<T> | null;
+
+    static ObjectId: typeof Schema.Types.ObjectId;
   }
 
   export type NumberSchemaDefinition = typeof Number | 'number' | 'Number' | typeof Schema.Types.Number;