mongoose 8.20.0 → 9.0.0-rc0

package/lib/mongoose.js

@@ -39,7 +39,7 @@ require('./helpers/printJestWarning');
 
 const objectIdHexRegexp = /^[0-9A-Fa-f]{24}$/;
 
-const { AsyncLocalStorage } = require('node:async_hooks');
+const { AsyncLocalStorage } = require('async_hooks');
 
 /**
  * Mongoose constructor.
@@ -230,7 +230,6 @@ Mongoose.prototype.setDriver = function setDriver(driver) {
  * - `cloneSchemas`: `false` by default. Set to `true` to `clone()` all schemas before compiling into a model.
  * - `debug`: If `true`, prints the operations mongoose sends to MongoDB to the console. If a writable stream is passed, it will log to that stream, without colorization. If a callback function is passed, it will receive the collection name, the method name, then all arguments passed to the method. For example, if you wanted to replicate the default logging, you could output from the callback `Mongoose: ${collectionName}.${methodName}(${methodArgs.join(', ')})`.
  * - `id`: If `true`, adds a `id` virtual to all schemas unless overwritten on a per-schema basis.
- * - `timestamps.createdAt.immutable`: `true` by default. If `false`, it will change the `createdAt` field to be [`immutable: false`](https://mongoosejs.com/docs/api/schematype.html#SchemaType.prototype.immutable) which means you can update the `createdAt`
  * - `maxTimeMS`: If set, attaches [maxTimeMS](https://www.mongodb.com/docs/manual/reference/operator/meta/maxTimeMS/) to every query
  * - `objectIdGetter`: `true` by default. Mongoose adds a getter to MongoDB ObjectId's called `_id` that returns `this` for convenience with populate. Set this to false to remove the getter.
  * - `overwriteModels`: Set to `true` to default to overwriting models with the same name when calling `mongoose.model()`, as opposed to throwing an `OverwriteModelError`.
@@ -238,10 +237,12 @@ Mongoose.prototype.setDriver = function setDriver(driver) {
  * - `runValidators`: `false` by default. Set to true to enable [update validators](https://mongoosejs.com/docs/validation.html#update-validators) for all validators by default.
  * - `sanitizeFilter`: `false` by default. Set to true to enable the [sanitization of the query filters](https://mongoosejs.com/docs/api/mongoose.html#Mongoose.prototype.sanitizeFilter()) against query selector injection attacks by wrapping any nested objects that have a property whose name starts with `$` in a `$eq`.
  * - `selectPopulatedPaths`: `true` by default. Set to false to opt out of Mongoose adding all fields that you `populate()` to your `select()`. The schema-level option `selectPopulatedPaths` overwrites this one.
- * - `strict`: `true` by default, may be `false`, `true`, or `'throw'`. Sets the default strict mode for schemas.
  * - `strictQuery`: `false` by default. May be `false`, `true`, or `'throw'`. Sets the default [strictQuery](https://mongoosejs.com/docs/guide.html#strictQuery) mode for schemas.
+ * - `strict`: `true` by default, may be `false`, `true`, or `'throw'`. Sets the default strict mode for schemas.
+ * - `timestamps.createdAt.immutable`: `true` by default. If `false`, it will change the `createdAt` field to be [`immutable: false`](https://mongoosejs.com/docs/api/schematype.html#SchemaType.prototype.immutable) which means you can update the `createdAt`
  * - `toJSON`: `{ transform: true, flattenDecimals: true }` by default. Overwrites default objects to [`toJSON()`](https://mongoosejs.com/docs/api/document.html#Document.prototype.toJSON()), for determining how Mongoose documents get serialized by `JSON.stringify()`
  * - `toObject`: `{ transform: true, flattenDecimals: true }` by default. Overwrites default objects to [`toObject()`](https://mongoosejs.com/docs/api/document.html#Document.prototype.toObject())
+ * - `updatePipeline`: `false` by default. If `true`, allows passing update pipelines (arrays) to update operations by default without explicitly setting `updatePipeline: true` in each query.
  *
  * @param {String|Object} key The name of the option or a object of multiple key-value pairs
  * @param {String|Function|Boolean} value The value of the option, unused if "key" is a object
@@ -1051,16 +1052,6 @@ Mongoose.prototype.Model = Model;
 
 Mongoose.prototype.Document = Document;
 
-/**
- * The Mongoose DocumentProvider constructor. Mongoose users should not have to
- * use this directly
- *
- * @method DocumentProvider
- * @api public
- */
-
-Mongoose.prototype.DocumentProvider = require('./documentProvider');
-
 /**
  * The Mongoose ObjectId [SchemaType](https://mongoosejs.com/docs/schematypes.html). Used for
  * declaring paths in your schema that should be
@@ -1337,6 +1328,43 @@ Mongoose.prototype.skipMiddlewareFunction = Kareem.skipWrappedFunction;
 
 Mongoose.prototype.overwriteMiddlewareResult = Kareem.overwriteResult;
 
+/**
+ * Use this function in `pre()` middleware to replace the arguments passed to the next middleware or hook.
+ *
+ * #### Example:
+ *
+ *     // Suppose you have a schema for time in "HH:MM" string format, but you want to store it as an object { hours, minutes }
+ *     const timeStringToObject = (time) => {
+ *       if (typeof time !== 'string') return time;
+ *       const [hours, minutes] = time.split(':');
+ *       return { hours: parseInt(hours), minutes: parseInt(minutes) };
+ *     };
+ *
+ *     const timeSchema = new Schema({
+ *       hours: { type: Number, required: true },
+ *       minutes: { type: Number, required: true },
+ *     });
+ *
+ *     // In a pre('init') hook, replace raw string doc with custom object form
+ *     timeSchema.pre('init', function(doc) {
+ *       if (typeof doc === 'string') {
+ *         return mongoose.overwriteMiddlewareArguments(timeStringToObject(doc));
+ *       }
+ *     });
+ *
+ *     // Now, initializing with a time string gets auto-converted by the hook
+ *     const userSchema = new Schema({ time: timeSchema });
+ *     const User = mongoose.model('User', userSchema);
+ *     const doc = new User({});
+ *     doc.$init({ time: '12:30' });
+ *
+ * @method overwriteMiddlewareArguments
+ * @param {...any} args The new arguments to be passed to the next middleware. Pass multiple arguments as a spread, **not** as an array.
+ * @api public
+ */
+
+Mongoose.prototype.overwriteMiddlewareArguments = Kareem.overwriteArguments;
+
 /**
  * Takes in an object and deletes any keys from the object whose values
  * are strictly equal to `undefined`.

package/lib/plugins/saveSubdocs.js

@@ -1,45 +1,44 @@
 'use strict';
 
-const each = require('../helpers/each');
-
 /*!
  * ignore
  */
 
 module.exports = function saveSubdocs(schema) {
   const unshift = true;
-  schema.s.hooks.pre('save', false, function saveSubdocsPreSave(next) {
+  schema.s.hooks.pre('save', false, async function saveSubdocsPreSave() {
     if (this.$isSubdocument) {
-      next();
       return;
     }
 
-    const _this = this;
     const subdocs = this.$getAllSubdocs({ useCache: true });
 
     if (!subdocs.length) {
-      next();
       return;
     }
 
-    each(subdocs, function(subdoc, cb) {
-      subdoc.$__schema.s.hooks.execPre('save', subdoc, function(err) {
-        cb(err);
-      });
-    }, function(error) {
-      // Invalidate subdocs cache because subdoc pre hooks can add new subdocuments
-      if (_this.$__.saveOptions) {
-        _this.$__.saveOptions.__subdocs = null;
-      }
-      if (error) {
-        return _this.$__schema.s.hooks.execPost('save:error', _this, [_this], { error: error }, function(error) {
-          next(error);
-        });
-      }
-      next();
-    });
+    await Promise.all(subdocs.map(subdoc => subdoc._execDocumentPreHooks('save')));
+
+    // Invalidate subdocs cache because subdoc pre hooks can add new subdocuments
+    if (this.$__.saveOptions) {
+      this.$__.saveOptions.__subdocs = null;
+    }
   }, null, unshift);
 
+  schema.s.hooks.pre('save', async function saveSubdocsPreDeleteOne() {
+    const removedSubdocs = this.$__.removedSubdocs;
+    if (!removedSubdocs || !removedSubdocs.length) {
+      return;
+    }
+
+    const promises = [];
+    for (const subdoc of removedSubdocs) {
+      promises.push(subdoc._execDocumentPreHooks('deleteOne'));
+    }
+
+    await Promise.all(promises);
+  });
+
   schema.s.hooks.post('save', async function saveSubdocsPostDeleteOne() {
     const removedSubdocs = this.$__.removedSubdocs;
     if (!removedSubdocs || !removedSubdocs.length) {
@@ -48,14 +47,7 @@ module.exports = function saveSubdocs(schema) {
 
     const promises = [];
     for (const subdoc of removedSubdocs) {
-      promises.push(new Promise((resolve, reject) => {
-        subdoc.$__schema.s.hooks.execPost('deleteOne', subdoc, [subdoc], function(err) {
-          if (err) {
-            return reject(err);
-          }
-          resolve();
-        });
-      }));
+      promises.push(subdoc._execDocumentPostHooks('deleteOne'));
     }
 
     this.$__.removedSubdocs = null;
@@ -67,7 +59,6 @@ module.exports = function saveSubdocs(schema) {
       return;
     }
 
-    const _this = this;
     const subdocs = this.$getAllSubdocs({ useCache: true });
 
     if (!subdocs.length) {
@@ -76,27 +67,9 @@ module.exports = function saveSubdocs(schema) {
 
     const promises = [];
     for (const subdoc of subdocs) {
-      promises.push(new Promise((resolve, reject) => {
-        subdoc.$__schema.s.hooks.execPost('save', subdoc, [subdoc], function(err) {
-          if (err) {
-            return reject(err);
-          }
-          resolve();
-        });
-      }));
+      promises.push(subdoc._execDocumentPostHooks('save'));
     }
 
-    try {
-      await Promise.all(promises);
-    } catch (error) {
-      await new Promise((resolve, reject) => {
-        this.$__schema.s.hooks.execPost('save:error', _this, [_this], { error: error }, function(error) {
-          if (error) {
-            return reject(error);
-          }
-          resolve();
-        });
-      });
-    }
+    await Promise.all(promises);
   }, null, unshift);
 };

package/lib/plugins/sharding.js

@@ -12,13 +12,14 @@ module.exports = function shardingPlugin(schema) {
     storeShard.call(this);
     return this;
   });
-  schema.pre('save', function shardingPluginPreSave(next) {
+  schema.pre('save', function shardingPluginPreSave() {
     applyWhere.call(this);
-    next();
   });
-  schema.pre('deleteOne', { document: true, query: false }, function shardingPluginPreRemove(next) {
+  schema.pre('deleteOne', { document: true, query: false }, function shardingPluginPreDeleteOne() {
+    applyWhere.call(this);
+  });
+  schema.pre('updateOne', { document: true, query: false }, function shardingPluginPreUpdateOne() {
     applyWhere.call(this);
-    next();
   });
   schema.post('save', function shardingPluginPostSave() {
     storeShard.call(this);

package/lib/plugins/validateBeforeSave.js

@@ -6,11 +6,10 @@
 
 module.exports = function validateBeforeSave(schema) {
   const unshift = true;
-  schema.pre('save', false, function validateBeforeSave(next, options) {
-    const _this = this;
+  schema.pre('save', false, async function validateBeforeSave(options) {
     // Nested docs have their own presave
     if (this.$isSubdocument) {
-      return next();
+      return;
     }
 
     const hasValidateBeforeSaveOption = options &&
@@ -32,20 +31,11 @@ module.exports = function validateBeforeSave(schema) {
       const validateOptions = hasValidateModifiedOnlyOption ?
         { validateModifiedOnly: options.validateModifiedOnly } :
         null;
-      this.$validate(validateOptions).then(
+      await this.$validate(validateOptions).then(
         () => {
           this.$op = 'save';
-          next();
-        },
-        error => {
-          _this.$__schema.s.hooks.execPost('save:error', _this, [_this], { error: error }, function(error) {
-            _this.$op = 'save';
-            next(error);
-          });
         }
       );
-    } else {
-      next();
     }
   }, null, unshift);
 };