mongoose 8.20.0 → 9.0.0-rc1

package/lib/query.js

@@ -116,7 +116,7 @@ function Query(conditions, options, model, collection) {
 
   this._transforms = [];
   this._hooks = new Kareem();
-  this._executionStack = null;
+  this._execCount = 0;
 
   // this is the case where we have a CustomQuery, we need to check if we got
   // options passed in, and if we did, merge them in
@@ -300,7 +300,6 @@ Query.prototype.toConstructor = function toConstructor() {
   p.setOptions(options);
 
   p.op = this.op;
-  p._validateOp();
   p._conditions = clone(this._conditions);
   p._fields = clone(this._fields);
   p._update = clone(this._update, {
@@ -349,7 +348,6 @@ Query.prototype.clone = function() {
   q.setOptions(options);
 
   q.op = this.op;
-  q._validateOp();
   q._conditions = clone(this._conditions);
   q._fields = clone(this._fields);
   q._update = clone(this._update, {
@@ -513,6 +511,10 @@ Query.prototype._validateOp = function() {
   if (this.op != null && !validOpsSet.has(this.op)) {
     this.error(new Error('Query has invalid `op`: "' + this.op + '"'));
   }
+
+  if (this.op !== 'estimatedDocumentCount' && this._conditions == null) {
+    throw new ObjectParameterError(this._conditions, 'filter', this.op);
+  }
 };
 
 /**
@@ -918,7 +920,7 @@ Query.prototype.limit = function limit(v) {
   if (typeof v === 'string') {
     try {
       v = castNumber(v);
-    } catch (err) {
+    } catch {
       throw new CastError('Number', v, 'limit');
     }
   }
@@ -952,7 +954,7 @@ Query.prototype.skip = function skip(v) {
   if (typeof v === 'string') {
     try {
       v = castNumber(v);
-    } catch (err) {
+    } catch {
       throw new CastError('Number', v, 'skip');
     }
   }
@@ -1746,6 +1748,10 @@ Query.prototype.setOptions = function(options, overwrite) {
     this._mongooseOptions.overwriteImmutable = options.overwriteImmutable;
     delete options.overwriteImmutable;
   }
+  if ('updatePipeline' in options) {
+    this._mongooseOptions.updatePipeline = options.updatePipeline;
+    delete options.updatePipeline;
+  }
   if ('sanitizeProjection' in options) {
     if (options.sanitizeProjection && !this._mongooseOptions.sanitizeProjection) {
       sanitizeProjection(this._fields);
@@ -1782,14 +1788,14 @@ Query.prototype.setOptions = function(options, overwrite) {
   if (typeof options.limit === 'string') {
     try {
       options.limit = castNumber(options.limit);
-    } catch (err) {
+    } catch {
       throw new CastError('Number', options.limit, 'limit');
     }
   }
   if (typeof options.skip === 'string') {
     try {
       options.skip = castNumber(options.skip);
-    } catch (err) {
+    } catch {
       throw new CastError('Number', options.skip, 'skip');
     }
   }
@@ -2481,7 +2487,7 @@ Query.prototype.find = function(conditions) {
 
   this.op = 'find';
 
-  if (mquery.canMerge(conditions)) {
+  if (canMerge(conditions)) {
     this.merge(conditions);
 
     prepareDiscriminatorCriteria(this);
@@ -2503,9 +2509,14 @@ Query.prototype.find = function(conditions) {
 
 Query.prototype.merge = function(source) {
   if (!source) {
+    if (source === null) {
+      this._conditions = null;
+    }
     return this;
   }
 
+  this._conditions = this._conditions ?? {};
+
   const opts = { overwrite: true };
 
   if (source instanceof Query) {
@@ -2756,7 +2767,6 @@ Query.prototype.findOne = function(conditions, projection, options) {
   }
 
   this.op = 'findOne';
-  this._validateOp();
 
   if (options) {
     this.setOptions(options);
@@ -2766,7 +2776,7 @@ Query.prototype.findOne = function(conditions, projection, options) {
     this.select(projection);
   }
 
-  if (mquery.canMerge(conditions)) {
+  if (canMerge(conditions)) {
     this.merge(conditions);
 
     prepareDiscriminatorCriteria(this);
@@ -2883,7 +2893,6 @@ Query.prototype.estimatedDocumentCount = function(options) {
   }
 
   this.op = 'estimatedDocumentCount';
-  this._validateOp();
 
   if (options != null) {
     this.setOptions(options);
@@ -2938,9 +2947,8 @@ Query.prototype.countDocuments = function(conditions, options) {
   }
 
   this.op = 'countDocuments';
-  this._validateOp();
 
-  if (mquery.canMerge(conditions)) {
+  if (canMerge(conditions)) {
     this.merge(conditions);
   }
 
@@ -3004,9 +3012,8 @@ Query.prototype.distinct = function(field, conditions, options) {
   }
 
   this.op = 'distinct';
-  this._validateOp();
 
-  if (mquery.canMerge(conditions)) {
+  if (canMerge(conditions)) {
     this.merge(conditions);
 
     prepareDiscriminatorCriteria(this);
@@ -3174,7 +3181,7 @@ Query.prototype.deleteOne = function deleteOne(filter, options) {
   this.op = 'deleteOne';
   this.setOptions(options);
 
-  if (mquery.canMerge(filter)) {
+  if (canMerge(filter)) {
     this.merge(filter);
 
     prepareDiscriminatorCriteria(this);
@@ -3250,7 +3257,7 @@ Query.prototype.deleteMany = function(filter, options) {
   this.setOptions(options);
   this.op = 'deleteMany';
 
-  if (mquery.canMerge(filter)) {
+  if (canMerge(filter)) {
     this.merge(filter);
 
     prepareDiscriminatorCriteria(this);
@@ -3382,7 +3389,7 @@ function prepareDiscriminatorCriteria(query) {
  * @memberOf Query
  * @instance
  * @param {Object|Query} [filter]
- * @param {Object} [doc]
+ * @param {Object} [update]
  * @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|String} [options.strict] overwrites the schema's [strict mode option](https://mongoosejs.com/docs/guide.html#strict)
@@ -3404,16 +3411,15 @@ function prepareDiscriminatorCriteria(query) {
  * @api public
  */
 
-Query.prototype.findOneAndUpdate = function(filter, doc, options) {
+Query.prototype.findOneAndUpdate = function(filter, update, options) {
   if (typeof filter === 'function' ||
-      typeof doc === 'function' ||
+      typeof update === 'function' ||
       typeof options === 'function' ||
       typeof arguments[3] === 'function') {
     throw new MongooseError('Query.prototype.findOneAndUpdate() no longer accepts a callback');
   }
 
   this.op = 'findOneAndUpdate';
-  this._validateOp();
   this._validate();
 
   switch (arguments.length) {
@@ -3421,12 +3427,12 @@ Query.prototype.findOneAndUpdate = function(filter, doc, options) {
       options = undefined;
       break;
     case 1:
-      doc = filter;
+      update = filter;
       filter = options = undefined;
       break;
   }
 
-  if (mquery.canMerge(filter)) {
+  if (canMerge(filter)) {
     this.merge(filter);
   } else if (filter != null) {
     this.error(
@@ -3434,11 +3440,6 @@ Query.prototype.findOneAndUpdate = function(filter, doc, options) {
     );
   }
 
-  // apply doc
-  if (doc) {
-    this._mergeUpdate(doc);
-  }
-
   options = options ? clone(options) : {};
 
   if (options.projection) {
@@ -3450,17 +3451,23 @@ Query.prototype.findOneAndUpdate = function(filter, doc, options) {
     delete options.fields;
   }
 
-  const returnOriginal = this &&
-    this.model &&
-    this.model.base &&
-    this.model.base.options &&
-    this.model.base.options.returnOriginal;
+  const returnOriginal = this?.model?.base?.options?.returnOriginal;
   if (options.new == null && options.returnDocument == null && options.returnOriginal == null && returnOriginal != null) {
     options.returnOriginal = returnOriginal;
   }
 
+  const updatePipeline = this?.model?.base?.options?.updatePipeline;
+  if (options.updatePipeline == null && updatePipeline != null) {
+    options.updatePipeline = updatePipeline;
+  }
+
   this.setOptions(options);
 
+  // apply doc
+  if (update) {
+    this._mergeUpdate(update);
+  }
+
   return this;
 };
 
@@ -3509,7 +3516,7 @@ Query.prototype._findOneAndUpdate = async function _findOneAndUpdate() {
       delete $set._id;
       this._update = { $set };
     } else {
-      this._executionStack = null;
+      this._execCount = 0;
       const res = await this._findOne();
       return res;
     }
@@ -3591,10 +3598,9 @@ Query.prototype.findOneAndDelete = function(filter, options) {
   }
 
   this.op = 'findOneAndDelete';
-  this._validateOp();
   this._validate();
 
-  if (mquery.canMerge(filter)) {
+  if (canMerge(filter)) {
     this.merge(filter);
   }
 
@@ -3694,10 +3700,9 @@ Query.prototype.findOneAndReplace = function(filter, replacement, options) {
   }
 
   this.op = 'findOneAndReplace';
-  this._validateOp();
   this._validate();
 
-  if (mquery.canMerge(filter)) {
+  if (canMerge(filter)) {
     this.merge(filter);
   } else if (filter != null) {
     this.error(
@@ -3711,14 +3716,11 @@ Query.prototype.findOneAndReplace = function(filter, replacement, options) {
 
   options = options || {};
 
-  const returnOriginal = this &&
-  this.model &&
-  this.model.base &&
-  this.model.base.options &&
-  this.model.base.options.returnOriginal;
+  const returnOriginal = this?.model?.base?.options?.returnOriginal;
   if (options.new == null && options.returnDocument == null && options.returnOriginal == null && returnOriginal != null) {
     options.returnOriginal = returnOriginal;
   }
+
   this.setOptions(options);
 
   return this;
@@ -3997,39 +3999,43 @@ function _completeManyLean(schema, docs, path, opts) {
  * Override mquery.prototype._mergeUpdate to handle mongoose objects in
  * updates.
  *
- * @param {Object} doc
+ * @param {Object} update
  * @method _mergeUpdate
  * @memberOf Query
  * @instance
  * @api private
  */
 
-Query.prototype._mergeUpdate = function(doc) {
+Query.prototype._mergeUpdate = function(update) {
+  const updatePipeline = this._mongooseOptions.updatePipeline;
+  if (!updatePipeline && Array.isArray(update)) {
+    throw new MongooseError('Cannot pass an array to query updates unless the `updatePipeline` option is set.');
+  }
   if (!this._update) {
-    this._update = Array.isArray(doc) ? [] : {};
+    this._update = Array.isArray(update) ? [] : {};
   }
 
-  if (doc == null || (typeof doc === 'object' && Object.keys(doc).length === 0)) {
+  if (update == null || (typeof update === 'object' && Object.keys(update).length === 0)) {
     return;
   }
 
-  if (doc instanceof Query) {
+  if (update instanceof Query) {
     if (Array.isArray(this._update)) {
-      throw new Error('Cannot mix array and object updates');
+      throw new MongooseError('Cannot mix array and object updates');
     }
-    if (doc._update) {
-      utils.mergeClone(this._update, doc._update);
+    if (update._update) {
+      utils.mergeClone(this._update, update._update);
     }
-  } else if (Array.isArray(doc)) {
+  } else if (Array.isArray(update)) {
     if (!Array.isArray(this._update)) {
-      throw new Error('Cannot mix array and object updates');
+      throw new MongooseError('Cannot mix array and object updates');
     }
-    this._update = this._update.concat(doc);
+    this._update = this._update.concat(update);
   } else {
     if (Array.isArray(this._update)) {
-      throw new Error('Cannot mix array and object updates');
+      throw new MongooseError('Cannot mix array and object updates');
     }
-    utils.mergeClone(this._update, doc);
+    utils.mergeClone(this._update, update);
   }
 };
 
@@ -4057,7 +4063,7 @@ async function _updateThunk(op) {
   this._update = clone(this._update, options);
   const isOverwriting = op === 'replaceOne';
   if (isOverwriting) {
-    this._update = new this.model(this._update, null, true);
+    this._update = new this.model(this._update, null, { skipId: true });
   } else {
     this._update = this._castUpdate(this._update);
 
@@ -4111,14 +4117,7 @@ Query.prototype.validate = async function validate(castedDoc, options, isOverwri
   if (isOverwriting) {
     await castedDoc.$validate();
   } else {
-    await new Promise((resolve, reject) => {
-      updateValidators(this, this.model.schema, castedDoc, options, (err) => {
-        if (err != null) {
-          return reject(err);
-        }
-        resolve();
-      });
-    });
+    await updateValidators(this, this.model.schema, castedDoc, options);
   }
 
   await _executePostHooks(this, null, null, 'validate');
@@ -4209,13 +4208,13 @@ Query.prototype.updateMany = function(conditions, doc, options, callback) {
   if (typeof options === 'function') {
     // .update(conditions, doc, callback)
     callback = options;
-    options = null;
+    options = undefined;
   } else if (typeof doc === 'function') {
     // .update(doc, callback);
     callback = doc;
     doc = conditions;
     conditions = {};
-    options = null;
+    options = undefined;
   } else if (typeof conditions === 'function') {
     // .update(callback)
     callback = conditions;
@@ -4284,13 +4283,13 @@ Query.prototype.updateOne = function(conditions, doc, options, callback) {
   if (typeof options === 'function') {
     // .update(conditions, doc, callback)
     callback = options;
-    options = null;
+    options = undefined;
   } else if (typeof doc === 'function') {
     // .update(doc, callback);
     callback = doc;
     doc = conditions;
     conditions = {};
-    options = null;
+    options = undefined;
   } else if (typeof conditions === 'function') {
     // .update(callback)
     callback = conditions;
@@ -4351,13 +4350,13 @@ Query.prototype.replaceOne = function(conditions, doc, options, callback) {
   if (typeof options === 'function') {
     // .update(conditions, doc, callback)
     callback = options;
-    options = null;
+    options = undefined;
   } else if (typeof doc === 'function') {
     // .update(doc, callback);
     callback = doc;
     doc = conditions;
     conditions = {};
-    options = null;
+    options = undefined;
   } else if (typeof conditions === 'function') {
     // .update(callback)
     callback = conditions;
@@ -4389,7 +4388,6 @@ Query.prototype.replaceOne = function(conditions, doc, options, callback) {
 function _update(query, op, filter, doc, options, callback) {
   // make sure we don't send in the whole Document to merge()
   query.op = op;
-  query._validateOp();
   doc = doc || {};
 
   // strict is an option used in the update checking, make sure it gets set
@@ -4407,6 +4405,12 @@ function _update(query, op, filter, doc, options, callback) {
     query.merge(filter);
   }
 
+  const updatePipeline = query?.model?.base?.options?.updatePipeline;
+  if (updatePipeline != null && (options == null || options.updatePipeline == null)) {
+    options = options || {};
+    options.updatePipeline = updatePipeline;
+  }
+
   if (utils.isObject(options)) {
     query.setOptions(options);
   }
@@ -4574,6 +4578,7 @@ Query.prototype.exec = async function exec(op) {
     throw new MongooseError('Query.prototype.exec() no longer accepts a callback');
   }
 
+  this._validateOp();
   if (typeof op === 'string') {
     this.op = op;
   }
@@ -4594,23 +4599,18 @@ Query.prototype.exec = async function exec(op) {
     throw new Error('Invalid field "" passed to sort()');
   }
 
-  if (this._executionStack != null) {
+  if (this._execCount > 0) {
     let str = this.toString();
     if (str.length > 60) {
       str = str.slice(0, 60) + '...';
     }
-    const err = new MongooseError('Query was already executed: ' + str);
-    if (!this.model.base.options.skipOriginalStackTraces) {
-      err.originalStack = this._executionStack;
-    }
-    throw err;
-  } else {
-    this._executionStack = this.model.base.options.skipOriginalStackTraces ? true : new Error().stack;
+    throw new MongooseError('Query was already executed: ' + str);
   }
+  this._execCount++;
 
   let skipWrappedFunction = null;
   try {
-    await _executePreExecHooks(this);
+    await this._hooks.execPre('exec', this, []);
   } catch (err) {
     if (err instanceof Kareem.skipWrappedFunction) {
       skipWrappedFunction = err;
@@ -4641,27 +4641,11 @@ Query.prototype.exec = async function exec(op) {
 
   res = await _executePostHooks(this, res, error);
 
-  await _executePostExecHooks(this);
+  await this._hooks.execPost('exec', this, []);
 
   return res;
 };
 
-/*!
- * ignore
- */
-
-function _executePostExecHooks(query) {
-  return new Promise((resolve, reject) => {
-    query._hooks.execPost('exec', query, [], {}, (error) => {
-      if (error) {
-        return reject(error);
-      }
-
-      resolve();
-    });
-  });
-}
-
 /*!
  * ignore
  */
@@ -4674,31 +4658,10 @@ function _executePostHooks(query, res, error, op) {
     return res;
   }
 
-  return new Promise((resolve, reject) => {
-    const opts = error ? { error } : {};
-
-    query._queryMiddleware.execPost(op || query.op, query, [res], opts, (error, res) => {
-      if (error) {
-        return reject(error);
-      }
-
-      resolve(res);
-    });
-  });
-}
-
-/*!
- * ignore
- */
-
-function _executePreExecHooks(query) {
-  return new Promise((resolve, reject) => {
-    query._hooks.execPre('exec', query, [], (error) => {
-      if (error != null) {
-        return reject(error);
-      }
-      resolve();
-    });
+  const opts = error ? { error } : {};
+  return query._queryMiddleware.execPost(op || query.op, query, [res], opts).then((res) => {
+    // `res` is array of return args, but queries only return one result.
+    return res[0];
   });
 }
 
@@ -4711,14 +4674,7 @@ function _executePreHooks(query, op) {
     return;
   }
 
-  return new Promise((resolve, reject) => {
-    query._queryMiddleware.execPre(op || query.op, query, [], (error) => {
-      if (error != null) {
-        return reject(error);
-      }
-      resolve();
-    });
-  });
+  return query._queryMiddleware.execPre(op || query.op, query, []);
 }
 
 /**
@@ -5467,26 +5423,17 @@ Query.prototype.nearSphere = function() {
  *       console.log(doc.name);
  *     }
  *
- * Node.js 10.x supports async iterators natively without any flags. You can
- * enable async iterators in Node.js 8.x using the [`--harmony_async_iteration` flag](https://github.com/tc39/proposal-async-iteration/issues/117#issuecomment-346695187).
- *
- * **Note:** This function is not if `Symbol.asyncIterator` is undefined. If
- * `Symbol.asyncIterator` is undefined, that means your Node.js version does not
- * support async iterators.
- *
  * @method [Symbol.asyncIterator]
  * @memberOf Query
  * @instance
  * @api public
  */
 
-if (Symbol.asyncIterator != null) {
-  Query.prototype[Symbol.asyncIterator] = function queryAsyncIterator() {
-    // Set so QueryCursor knows it should transform results for async iterators into `{ value, done }` syntax
-    this._mongooseOptions._asyncIterator = true;
-    return this.cursor();
-  };
-}
+Query.prototype[Symbol.asyncIterator] = function queryAsyncIterator() {
+  // Set so QueryCursor knows it should transform results for async iterators into `{ value, done }` syntax
+  this._mongooseOptions._asyncIterator = true;
+  return this.cursor();
+};
 
 /**
  * Specifies a `$polygon` condition
@@ -5686,6 +5633,15 @@ Query.prototype.selectedExclusively = function selectedExclusively() {
 
 Query.prototype.model;
 
+/**
+ * Determine if we can merge the given value as a query filter. Override for mquery.canMerge() to allow null
+ */
+
+function canMerge(value) {
+  return value instanceof Query || utils.isObject(value) || value === null;
+
+}
+
 /*!
  * Export
  */

package/lib/queryHelpers.js

@@ -90,7 +90,7 @@ exports.createModel = function createModel(model, doc, fields, userProvidedField
     if (discriminator) {
       const _fields = clone(userProvidedFields);
       exports.applyPaths(_fields, discriminator.schema);
-      return new discriminator(undefined, _fields, true);
+      return new discriminator(undefined, _fields, { skipId: true });
     }
   }
 
@@ -268,7 +268,7 @@ exports.applyPaths = function applyPaths(fields, schema, sanitizeProjection) {
       let addedPath = analyzePath(path, type);
       // arrays
       if (addedPath == null && !Array.isArray(type) && type.$isMongooseArray && !type.$isMongooseDocumentArray) {
-        addedPath = analyzePath(path, type.caster);
+        addedPath = analyzePath(path, type.embeddedSchemaType);
       }
       if (addedPath != null) {
         addedPaths.push(addedPath);