refactor: remove remaining usage of overwrite option

Re: #13578
Automattic · Oct 17, 2023 · f6ed0eb · f6ed0eb
1 parent 7722af4
commit f6ed0eb
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 96 deletions.
diff --git a/lib/helpers/model/castBulkWrite.js b/lib/helpers/model/castBulkWrite.js
@@ -88,7 +88,6 @@ module.exports = function castBulkWrite(originalModel, op, options) {
 
         op['updateOne']['update'] = castUpdate(model.schema, op['updateOne']['update'], {
           strict: strict,
-          overwrite: false,
           upsert: op['updateOne'].upsert
         }, model, op['updateOne']['filter']);
       } catch (error) {
@@ -140,7 +139,6 @@ module.exports = function castBulkWrite(originalModel, op, options) {
 
         op['updateMany']['update'] = castUpdate(model.schema, op['updateMany']['update'], {
           strict: strict,
-          overwrite: false,
           upsert: op['updateMany'].upsert
         }, model, op['updateMany']['filter']);
       } catch (error) {

diff --git a/lib/helpers/query/castUpdate.js b/lib/helpers/query/castUpdate.js
@@ -233,7 +233,6 @@ function walkUpdatePath(schema, obj, op, options, context, filter, pref) {
       }
 
       if (op !== '$setOnInsert' &&
-          !options.overwrite &&
           handleImmutable(schematype, strict, obj, key, prefix + key, context)) {
         continue;
       }
@@ -328,7 +327,6 @@ function walkUpdatePath(schema, obj, op, options, context, filter, pref) {
 
       // You can use `$setOnInsert` with immutable keys
       if (op !== '$setOnInsert' &&
-          !options.overwrite &&
           handleImmutable(schematype, strict, obj, key, prefix + key, context)) {
         continue;
       }

diff --git a/lib/model.js b/lib/model.js
@@ -2394,7 +2394,6 @@ Model.$where = function $where() {
  * @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)
  * @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.overwrite=false] If set to `true`, Mongoose will convert this `findOneAndUpdate()` to a `findOneAndReplace()`. This option is deprecated and only supported for backwards compatiblity.
  * @param {Boolean} [options.upsert=false] if true, and no documents found, insert a new document
  * @param {Object|String|String[]} [options.projection=null] optional fields to return, see [`Query.prototype.select()`](https://mongoosejs.com/docs/api/query.html#Query.prototype.select())
  * @param {Boolean} [options.new=false] if true, return the modified document rather than the original
@@ -2453,14 +2452,10 @@ function _decorateUpdateWithVersionKey(update, options, versionKey) {
 
   const updatedPaths = modifiedPaths(update);
   if (!updatedPaths[versionKey]) {
-    if (options.overwrite) {
-      update[versionKey] = 0;
-    } else {
-      if (!update.$setOnInsert) {
-        update.$setOnInsert = {};
-      }
-      update.$setOnInsert[versionKey] = 0;
+    if (!update.$setOnInsert) {
+      update.$setOnInsert = {};
     }
+    update.$setOnInsert[versionKey] = 0;
   }
 }
 
@@ -2492,9 +2487,6 @@ function _decorateUpdateWithVersionKey(update, options, versionKey) {
  *     // is sent as
  *     Model.findByIdAndUpdate(id, { $set: { name: 'jason bourne' }}, options)
  *
- * This helps prevent accidentally overwriting your document with `{ name: 'jason bourne' }`.
- * To prevent this behaviour, see the `overwrite` option
- *
  * #### Note:
  *
  * `findOneAndX` and `findByIdAndX` functions support limited validation. You can
@@ -2515,7 +2507,6 @@ function _decorateUpdateWithVersionKey(update, options, versionKey) {
  * @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)
  * @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.overwrite=false] If set to `true`, Mongoose will convert this `findByIdAndUpdate()` to a `findByIdAndReplace()`. This option is deprecated and only supported for backwards compatiblity.
  * @param {Object|String} [options.sort] if multiple docs are found by the conditions, sets the sort order to choose which doc to update.
  * @param {Boolean} [options.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
  * @param {Boolean} [options.setDefaultsOnInsert=true] 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

diff --git a/lib/query.js b/lib/query.js
@@ -1618,10 +1618,6 @@ Query.prototype.setOptions = function(options, overwrite) {
     this._mongooseOptions.sanitizeFilter = options.sanitizeFilter;
     delete options.sanitizeFilter;
   }
-  if ('overwrite' in options) {
-    this._mongooseOptions.overwrite = options.overwrite;
-    delete options.overwrite;
-  }
   if ('timestamps' in options) {
     this._mongooseOptions.timestamps = options.timestamps;
     delete options.timestamps;
@@ -1888,11 +1884,6 @@ Query.prototype._updateForExec = function() {
   while (i--) {
     const op = ops[i];
 
-    if (this._mongooseOptions.overwrite) {
-      ret[op] = update[op];
-      continue;
-    }
-
     if ('$' !== op[0]) {
       // fix up $set sugar
       if (!ret.$set) {
@@ -3267,7 +3258,7 @@ Query.prototype._findOneAndUpdate = async function _findOneAndUpdate() {
   convertNewToReturnDocument(options);
   this._applyTranslateAliases(options);
 
-  this._update = this._castUpdate(this._update, false);
+  this._update = this._castUpdate(this._update);
 
   const _opts = Object.assign({}, options, {
     setDefaultsOnInsert: this._mongooseOptions.setDefaultsOnInsert
@@ -3738,7 +3729,7 @@ async function _updateThunk(op) {
   if (isOverwriting) {
     this._update = new this.model(this._update, null, true);
   } else {
-    this._update = this._castUpdate(this._update, this._mongooseOptions.overwrite);
+    this._update = this._castUpdate(this._update);
 
     if (this._update == null || Object.keys(this._update).length === 0) {
       return { acknowledged: false };
@@ -4536,7 +4527,6 @@ Query.prototype.post = function(fn) {
  * Casts obj for an update command.
  *
  * @param {Object} obj
- * @param {Boolean} overwrite
  * @return {Object} obj after casting its values
  * @method _castUpdate
  * @memberOf Query

diff --git a/test/model.updateOne.test.js b/test/model.updateOne.test.js
@@ -874,22 +874,6 @@ describe('model: updateOne:', function() {
     });
   });
 
-  it('works with $set and overwrite (gh-2515)', async function() {
-    const schema = new Schema({ breakfast: String });
-    const M = db.model('Test', schema);
-
-    let doc = await M.create({ breakfast: 'bacon' });
-    await M.updateOne(
-      { _id: doc._id },
-      { $set: { breakfast: 'eggs' } },
-      { overwrite: true }
-    );
-
-    doc = await M.findOne({ _id: doc._id });
-    assert.equal(doc.breakfast, 'eggs');
-
-  });
-
   it('successfully casts set with nested mixed objects (gh-2796)', async function() {
     const schema = new Schema({ breakfast: {} });
     const M = db.model('Test', schema);
@@ -1246,33 +1230,6 @@ describe('model: updateOne:', function() {
       assert.equal(doc.name, 'Val');
     });
 
-    it('casting $push with overwrite (gh-3564)', async function() {
-      const schema = mongoose.Schema({
-        topicId: Number,
-        name: String,
-        followers: [Number]
-      });
-
-      let doc = {
-        topicId: 100,
-        name: 'name',
-        followers: [500]
-      };
-
-      const M = db.model('Test', schema);
-
-      await M.create(doc);
-
-      const update = { $push: { followers: 200 } };
-      const opts = { overwrite: true, new: true, upsert: false, multi: false };
-
-      await M.updateOne({ topicId: doc.topicId }, update, opts);
-      doc = await M.findOne({ topicId: doc.topicId });
-      assert.equal(doc.name, 'name');
-      assert.deepEqual(doc.followers.toObject(), [500, 200]);
-
-    });
-
     it('$push with buffer doesnt throw error (gh-3890)', async function() {
       const InfoSchema = new Schema({
         prop: { type: Buffer }
@@ -1747,31 +1704,6 @@ describe('model: updateOne:', function() {
       assert.deepEqual(doc.profiles[0], { rules: {} });
     });
 
-    it('with overwrite and upsert (gh-4749) (gh-5631)', function() {
-      const schema = new Schema({
-        name: String,
-        meta: { age: { type: Number } }
-      });
-      const User = db.model('User', schema);
-
-      const filter = { name: 'Bar' };
-      const update = { name: 'Bar', meta: { age: 33 } };
-      const options = { overwrite: true, upsert: true };
-      const q2 = User.updateOne(filter, update, options);
-      assert.deepEqual(q2.getUpdate(), {
-        __v: 0,
-        meta: { age: 33 },
-        name: 'Bar'
-      });
-
-      const q3 = User.findOneAndUpdate(filter, update, options);
-      assert.deepEqual(q3.getUpdate(), {
-        __v: 0,
-        meta: { age: 33 },
-        name: 'Bar'
-      });
-    });
-
     it('findOneAndUpdate with nested arrays (gh-5032)', async function() {
       const schema = Schema({
         name: String,