Add requireFilter for all methods with comprehensive tests, fix beforeEach timeout (#14913)

Author: muazahmed-dev

lib/query.js

@@ -165,6 +165,15 @@ function Query(conditions, options, model, collection) {
   }
 }
 
+// Helper function to check empty/invalid filter
+function checkRequireFilter(filter, options) {
+  if (options && options.requireFilter &&
+      (filter == null ||
+       (typeof filter === 'object' && filter !== null && !Array.isArray(filter) && Object.keys(filter).length === 0))) {
+    throw new Error('Empty or invalid filter not allowed with requireFilter enabled');
+  }
+}
+
 /*!
  * inherit mquery
  */
@@ -3111,6 +3120,7 @@ function _handleSortValue(val, key) {
  *
  * @param {Object|Query} [filter] mongodb selector
  * @param {Object} [options] optional see [`Query.prototype.setOptions()`](https://mongoosejs.com/docs/api/query.html#Query.prototype.setOptions())
+ * @param {Boolean} [options.requireFilter=false] If true, throws an error if the filter is empty (`{}`)
  * @return {Query} this
  * @see DeleteResult https://mongodb.github.io/node-mongodb-native/6.15/interfaces/DeleteResult.html
  * @see deleteOne https://mongodb.github.io/node-mongodb-native/6.15/classes/Collection.html#deleteOne
@@ -3148,6 +3158,9 @@ Query.prototype._deleteOne = async function _deleteOne() {
   this._applyTranslateAliases();
   this._castConditions();
 
+  // Check for empty/invalid filter with requireFilter option
+  checkRequireFilter(this._conditions, this.options);
+
   if (this.error() != null) {
     throw this.error();
   }
@@ -3183,6 +3196,7 @@ Query.prototype._deleteOne = async function _deleteOne() {
  *
  * @param {Object|Query} [filter] mongodb selector
  * @param {Object} [options] optional see [`Query.prototype.setOptions()`](https://mongoosejs.com/docs/api/query.html#Query.prototype.setOptions())
+ * @param {Boolean} [options.requireFilter=false] If true, throws an error if the filter is empty (`{}`)
  * @return {Query} this
  * @see DeleteResult https://mongodb.github.io/node-mongodb-native/6.15/interfaces/DeleteResult.html
  * @see deleteMany https://mongodb.github.io/node-mongodb-native/6.15/classes/Collection.html#deleteMany
@@ -3220,6 +3234,9 @@ Query.prototype._deleteMany = async function _deleteMany() {
   this._applyTranslateAliases();
   this._castConditions();
 
+  // Check for empty/invalid filter with requireFilter option
+  checkRequireFilter(this._conditions, this.options);
+  
   if (this.error() != null) {
     throw this.error();
   }
@@ -3311,7 +3328,7 @@ function prepareDiscriminatorCriteria(query) {
  * - `maxTimeMS`: puts a time limit on the query - requires mongodb >= 2.6.0
  * - `runValidators`: if true, runs [update validators](https://mongoosejs.com/docs/validation.html#update-validators) on this command. Update validators validate the update operation against the model's schema.
  * - `setDefaultsOnInsert`: `true` by default. If `setDefaultsOnInsert` and `upsert` are true, mongoose will apply the [defaults](https://mongoosejs.com/docs/defaults.html) specified in the model's schema if a new document is created.
- * - `strictFilter`: bool - if true, throws an error if the filter is empty (`{}`). Defaults to false.
+ * - `requireFilter`: bool - if true, throws an error if the filter is empty (`{}`). Defaults to false.
  *
  * #### Example:
  *
@@ -3338,7 +3355,7 @@ function prepareDiscriminatorCriteria(query) {
  * @param {Boolean} [options.translateAliases=null] If set to `true`, translates any schema-defined aliases in `filter`, `projection`, `update`, and `distinct`. Throws an error if there are any conflicts where both alias and raw property are defined on the same object.
  * @param {Boolean} [options.overwriteDiscriminatorKey=false] Mongoose removes discriminator key updates from `update` by default, set `overwriteDiscriminatorKey` to `true` to allow updating the discriminator key
  * @param {Boolean} [options.overwriteImmutable=false] Mongoose removes updated immutable properties from `update` by default (excluding $setOnInsert). Set `overwriteImmutable` to `true` to allow updating immutable properties using other update operators.
- * @param {Boolean} [options.strictFilter=false] If true, throws an error if the filter is empty (`{}`)
+ * @param {Boolean} [options.requireFilter=false] If true, throws an error if the filter is empty (`{}`)
  * @see Tutorial https://mongoosejs.com/docs/tutorials/findoneandupdate.html
  * @see findAndModify command https://www.mongodb.com/docs/manual/reference/command/findAndModify/
  * @see ModifyResult https://mongodb.github.io/node-mongodb-native/4.9/interfaces/ModifyResult.html
@@ -3355,11 +3372,6 @@ Query.prototype.findOneAndUpdate = function(filter, doc, options) {
     throw new MongooseError('Query.prototype.findOneAndUpdate() no longer accepts a callback');
   }
 
-  // Check for empty filter with strictFilter option
-  if (options && options.strictFilter && filter && Object.keys(filter).length === 0) {
-    return Promise.reject(new Error('Empty filter not allowed in findOneAndUpdate with strictFilter enabled'));
-  }
-
   this.op = 'findOneAndUpdate';
   this._validateOp();
   this._validate();
@@ -3424,6 +3436,9 @@ Query.prototype._findOneAndUpdate = async function _findOneAndUpdate() {
   this._applyTranslateAliases();
   this._castConditions();
 
+  // Check for empty/invalid filter with requireFilter option
+  checkRequireFilter(this._conditions, this.options);
+
   _castArrayFilters(this);
 
   if (this.error()) {
@@ -3507,6 +3522,7 @@ Query.prototype._findOneAndUpdate = async function _findOneAndUpdate() {
  *
  * - `sort`: if multiple docs are found by the conditions, sets the sort order to choose which doc to update
  * - `maxTimeMS`: puts a time limit on the query - requires mongodb >= 2.6.0
+ * - `requireFilter`: bool - if true, throws an error if the filter is empty (`{}`). Defaults to false.
  *
  * #### Example:
  *
@@ -3519,6 +3535,7 @@ Query.prototype._findOneAndUpdate = async function _findOneAndUpdate() {
  * @param {Object} [filter]
  * @param {Object} [options]
  * @param {Boolean} [options.includeResultMetadata] if true, returns the full [ModifyResult from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/4.9/interfaces/ModifyResult.html) rather than just the document
+ * @param {Boolean} [options.requireFilter=false] If true, throws an error if the filter is empty (`{}`)
  * @param {ClientSession} [options.session=null] The session associated with this query. See [transactions docs](https://mongoosejs.com/docs/transactions.html).
  * @param {Boolean|String} [options.strict] overwrites the schema's [strict mode option](https://mongoosejs.com/docs/guide.html#strict)
  * @return {Query} this
@@ -3558,6 +3575,9 @@ Query.prototype._findOneAndDelete = async function _findOneAndDelete() {
   this._applyTranslateAliases();
   this._castConditions();
 
+  // Check for empty/invalid filter with requireFilter option
+  checkRequireFilter(this._conditions, this.options);
+
   if (this.error() != null) {
     throw this.error();
   }
@@ -3597,6 +3617,7 @@ Query.prototype._findOneAndDelete = async function _findOneAndDelete() {
  * - `sort`: if multiple docs are found by the conditions, sets the sort order to choose which doc to update
  * - `maxTimeMS`: puts a time limit on the query - requires mongodb >= 2.6.0
  * - `includeResultMetadata`: if true, returns the full [ModifyResult from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/4.9/interfaces/ModifyResult.html) rather than just the document
+ * - `requireFilter`: bool - if true, throws an error if the filter is empty (`{}`). Defaults to false.
  *
  * #### Example:
  *
@@ -3619,6 +3640,7 @@ Query.prototype._findOneAndDelete = async function _findOneAndDelete() {
  * @param {Boolean} [options.timestamps=null] If set to `false` and [schema-level timestamps](https://mongoosejs.com/docs/guide.html#timestamps) are enabled, skip timestamps for this update. Note that this allows you to overwrite timestamps. Does nothing if schema-level timestamps are not set.
  * @param {Boolean} [options.returnOriginal=null] An alias for the `new` option. `returnOriginal: false` is equivalent to `new: true`.
  * @param {Boolean} [options.translateAliases=null] If set to `true`, translates any schema-defined aliases in `filter`, `projection`, `update`, and `distinct`. Throws an error if there are any conflicts where both alias and raw property are defined on the same object.
+ * @param {Boolean} [options.requireFilter=false] If true, throws an error if the filter is empty (`{}`)
  * @return {Query} this
  * @api public
  */
@@ -3674,6 +3696,10 @@ Query.prototype.findOneAndReplace = function(filter, replacement, options) {
 Query.prototype._findOneAndReplace = async function _findOneAndReplace() {
   this._applyTranslateAliases();
   this._castConditions();
+
+  // Check for empty/invalid filter with requireFilter option
+  checkRequireFilter(this._conditions, this.options);
+
   if (this.error() != null) {
     throw this.error();
   }
@@ -3976,6 +4002,9 @@ async function _updateThunk(op) {
 
   this._castConditions();
 
+  // Check for empty/invalid filter with requireFilter option
+  checkRequireFilter(this._conditions, this.options);
+
   _castArrayFilters(this);
 
   if (this.error() != null) {
@@ -4126,6 +4155,7 @@ Query.prototype._replaceOne = async function _replaceOne() {
  * @param {Boolean} [options.translateAliases=null] If set to `true`, translates any schema-defined aliases in `filter`, `projection`, `update`, and `distinct`. Throws an error if there are any conflicts where both alias and raw property are defined on the same object.
  * @param {Boolean} [options.overwriteDiscriminatorKey=false] Mongoose removes discriminator key updates from `update` by default, set `overwriteDiscriminatorKey` to `true` to allow updating the discriminator key
  * @param {Boolean} [options.overwriteImmutable=false] Mongoose removes updated immutable properties from `update` by default (excluding $setOnInsert). Set `overwriteImmutable` to `true` to allow updating immutable properties using other update operators.
+ * @param {Boolean} [options.requireFilter=false] If true, throws an error if the filter is empty (`{}`)
  * @return {Query} this
  * @see Model.update https://mongoosejs.com/docs/api/model.html#Model.update()
  * @see Query docs https://mongoosejs.com/docs/queries.html
@@ -4200,6 +4230,7 @@ Query.prototype.updateMany = function(conditions, doc, options, callback) {
  * @param {Boolean} [options.translateAliases=null] If set to `true`, translates any schema-defined aliases in `filter`, `projection`, `update`, and `distinct`. Throws an error if there are any conflicts where both alias and raw property are defined on the same object.
  * @param {Boolean} [options.overwriteDiscriminatorKey=false] Mongoose removes discriminator key updates from `update` by default, set `overwriteDiscriminatorKey` to `true` to allow updating the discriminator key
  * @param {Boolean} [options.overwriteImmutable=false] Mongoose removes updated immutable properties from `update` by default (excluding $setOnInsert). Set `overwriteImmutable` to `true` to allow updating immutable properties using other update operators.
+ * @param {Boolean} [options.requireFilter=false] If true, throws an error if the filter is empty (`{}`)
  * @return {Query} this
  * @see Model.update https://mongoosejs.com/docs/api/model.html#Model.update()
  * @see Query docs https://mongoosejs.com/docs/queries.html
@@ -4266,6 +4297,7 @@ Query.prototype.updateOne = function(conditions, doc, options, callback) {
  * @param {Object} [options.writeConcern=null] sets the [write concern](https://www.mongodb.com/docs/manual/reference/write-concern/) for replica sets. Overrides the [schema-level write concern](https://mongoosejs.com/docs/guide.html#writeConcern)
  * @param {Boolean} [options.timestamps=null] If set to `false` and [schema-level timestamps](https://mongoosejs.com/docs/guide.html#timestamps) are enabled, skip timestamps for this update. Does nothing if schema-level timestamps are not set.
  * @param {Boolean} [options.translateAliases=null] If set to `true`, translates any schema-defined aliases in `filter`, `projection`, `update`, and `distinct`. Throws an error if there are any conflicts where both alias and raw property are defined on the same object.
+ * @param {Boolean} [options.requireFilter=false] If true, throws an error if the filter is empty (`{}`)
  * @return {Query} this
  * @see Model.update https://mongoosejs.com/docs/api/model.html#Model.update()
  * @see Query docs https://mongoosejs.com/docs/queries.html