Merge pull request #15705 from Automattic/vkarpov15/gh-15701

fix(model+plugins): correctly apply shard key on deleteOne()

Author: vkarpov15

lib/model.js

@@ -802,8 +802,18 @@ Model.prototype.deleteOne = function deleteOne(options) {
     }
   }
 
-  query.pre(function queryPreDeleteOne(cb) {
-    self.constructor._middleware.execPre('deleteOne', self, [self], cb);
+  query.pre(async function queryPreDeleteOne() {
+    await new Promise((resolve, reject) => {
+      self.constructor._middleware.execPre('deleteOne', self, [self], err => {
+        if (err) reject(err);
+        else resolve();
+      });
+    });
+    // Apply custom where conditions _after_ document deleteOne middleware for
+    // consistency with save() - sharding plugin needs to set $where
+    if (self.$where != null) {
+      this.where(self.$where);
+    }
   });
   query.pre(function callSubdocPreHooks(cb) {
     each(self.$getAllSubdocs(), (subdoc, cb) => {

lib/plugins/sharding.js

@@ -16,7 +16,7 @@ module.exports = function shardingPlugin(schema) {
     applyWhere.call(this);
     next();
   });
-  schema.pre('remove', function shardingPluginPreRemove(next) {
+  schema.pre('deleteOne', { document: true, query: false }, function shardingPluginPreRemove(next) {
     applyWhere.call(this);
     next();
   });

test/sharding.test.js

@@ -0,0 +1,37 @@
+'use strict';
+
+const assert = require('assert');
+const start = require('./common');
+
+const mongoose = start.mongoose;
+
+describe('plugins.sharding', function() {
+  let db;
+
+  before(function() {
+    db = start();
+  });
+
+  after(async function() {
+    await db.close();
+  });
+
+  beforeEach(() => db.deleteModel(/.*/));
+  afterEach(() => require('./util').clearTestData(db));
+  afterEach(() => require('./util').stopRemainingOps(db));
+
+  it('applies shard key to deleteOne (gh-15701)', async function() {
+    const TestModel = db.model('Test', new mongoose.Schema({ name: String, shardKey: String }));
+    const doc = await TestModel.create({ name: 'test', shardKey: 'test1' });
+    doc.$__.shardval = { shardKey: 'test2' };
+    let res = await doc.deleteOne();
+    assert.strictEqual(res.deletedCount, 0);
+    doc.$__.shardval = { shardKey: 'test1' };
+    res = await doc.deleteOne();
+    assert.strictEqual(res.deletedCount, 1);
+
+    await TestModel.create({ name: 'test2', shardKey: 'test2' });
+    res = await TestModel.deleteOne({ name: 'test2' });
+    assert.strictEqual(res.deletedCount, 1);
+  });
+});