BREAKING CHANGE: make 1-arg syntax for updateOne, updateMany, findOneAndX set conditions not update, add findOneAndReplace

Fix #104
Re: Automattic/mongoose#15363

Author: vkarpov15

lib/collection/collection.js

@@ -14,6 +14,7 @@ const methods = [
   'estimatedDocumentCount',
   'distinct',
   'findOneAndDelete',
+  'findOneAndReplace',
   'findOneAndUpdate',
   'aggregate',
   'findCursor',

lib/collection/node.js

@@ -100,6 +100,13 @@ class NodeCollection extends Collection {
     return this.collection.findOneAndUpdate(match, update, options);
   }
 
+  /**
+   * findOneAndReplace(match, update, options)
+   */
+  async findOneAndReplace(match, update, options) {
+    return this.collection.findOneAndReplace(match, update, options);
+  }
+
   /**
    * var cursor = findCursor(match, options)
    */

lib/mquery.js

@@ -2058,11 +2058,6 @@ Query.prototype._distinct = async function _distinct() {
  */
 
 Query.prototype.updateMany = function updateMany(criteria, doc, options) {
-  if (arguments.length === 1) {
-    doc = criteria;
-    criteria = options = undefined;
-  }
-
   return _update(this, 'updateMany', criteria, doc, options);
 };
 
@@ -2093,11 +2088,6 @@ Query.prototype._updateMany = async function() {
  */
 
 Query.prototype.updateOne = function updateOne(criteria, doc, options) {
-  if (arguments.length === 1) {
-    doc = criteria;
-    criteria = options = undefined;
-  }
-
   return _update(this, 'updateOne', criteria, doc, options);
 };
 
@@ -2128,11 +2118,6 @@ Query.prototype._updateOne = async function() {
  */
 
 Query.prototype.replaceOne = function replaceOne(criteria, doc, options) {
-  if (arguments.length === 1) {
-    doc = criteria;
-    criteria = options = undefined;
-  }
-
   this.setOptions({ overwrite: true });
   return _update(this, 'replaceOne', criteria, doc, options);
 };
@@ -2255,7 +2240,7 @@ Query.prototype._deleteMany = async function() {
 };
 
 /**
- * Issues a mongodb [findAndModify](http://www.mongodb.org/display/DOCS/findAndModify+Command) update command.
+ * Issues a mongodb findOneAndUpdate command.
  *
  * Finds a matching document, updates it according to the `update` arg, passing any `options`, and returns the found document (if any).
  *
@@ -2288,11 +2273,6 @@ Query.prototype.findOneAndUpdate = function(criteria, doc, options) {
   this.op = 'findOneAndUpdate';
   this._validate();
 
-  if (arguments.length === 1) {
-    doc = criteria;
-    criteria = options = undefined;
-  }
-
   if (Query.canMerge(criteria)) {
     this.merge(criteria);
   }
@@ -2319,6 +2299,68 @@ Query.prototype._findOneAndUpdate = async function() {
   return this._collection.findOneAndUpdate(conds, update, options);
 };
 
+/**
+ * Issues a mongodb findOneAndReplace command.
+ *
+ * Finds a matching document, replaces it according to the `replacement` arg, passing any `options`, and returns the found document (if any).
+ *
+ * #### Available options
+ *
+ * - `new`: bool - true to return the modified document rather than the original. defaults to true
+ * - `upsert`: bool - creates the object if it doesn't exist. defaults to false.
+ * - `sort`: if multiple docs are found by the conditions, sets the sort order to choose which doc to update
+ *
+ * #### Examples:
+ *
+ *     await query.findOneAndReplace(conditions, replacement, options) // executes
+ *     query.findOneAndReplace(conditions, replacement, options)  // returns Query
+ *     await query.findOneAndReplace(conditions, replacement) // executes
+ *     query.findOneAndReplace(conditions, replacement)           // returns Query
+ *     await query.findOneAndReplace(replacement)             // returns Query
+ *     query.findOneAndReplace(replacement)                       // returns Query
+ *     await query.findOneAndReplace()                     // executes
+ *     query.findOneAndReplace()                             // returns Query
+ *
+ * @param {Object|Query} [query]
+ * @param {Object} [replacement]
+ * @param {Object} [options]
+ * @see mongodb http://www.mongodb.org/display/DOCS/findAndModify+Command
+ * @return {Query} this
+ * @api public
+ */
+
+Query.prototype.findOneAndReplace = function(criteria, replacement, options) {
+  this.op = 'findOneAndReplace';
+  this._validate();
+
+  if (Query.canMerge(criteria)) {
+    this.merge(criteria);
+  }
+
+  // apply replacement
+  if (replacement) {
+    this._updateDoc = replacement;
+    this.options = this.options || {};
+    this.options.overwrite = true;
+  }
+
+  options && this.setOptions(options);
+
+  return this;
+};
+
+/**
+ * Executes a `findOneAndReplace` Query
+ * @returns the results
+ */
+Query.prototype._findOneAndReplace = async function() {
+  const conds = this._conditions;
+  const replacement = this._updateForExec();
+  const options = this._optionsForExec();
+
+  return this._collection.findOneAndReplace(conds, replacement, options);
+};
+
 /**
  * Issues a mongodb findOneAndDelete.
  *
@@ -2573,7 +2615,7 @@ Query.prototype._fieldsForExec = function() {
  */
 
 Query.prototype._updateForExec = function() {
-  const update = utils.clone(this._updateDoc);
+  const update = this._updateDoc == null ? {} : utils.clone(this._updateDoc);
   const ops = utils.keys(update);
   const ret = {};
 

lib/permissions.js

@@ -53,6 +53,21 @@ denied.findOneAndUpdate.skip =
 denied.findOneAndUpdate.batchSize =
 denied.findOneAndUpdate.tailable = true;
 
+denied.findOneAndReplace = function(self) {
+  const keys = Object.keys(denied.findOneAndUpdate);
+  let err;
+
+  keys.every(function(option) {
+    if (self.options[option]) {
+      err = option;
+      return false;
+    }
+    return true;
+  });
+
+  return err;
+};
+
 
 denied.countDocuments = function(self) {
   if (self._fields && Object.keys(self._fields).length > 0) {