SERVER-64741 Create mongos appendOplogNote command

(cherry picked from commit 55f3bca3212d994bf00f1165021db34b3ce1d0bb)

5 files changed, 187 insertions, 0 deletions

diff --git a/etc/backports_required_for_multiversion_tests.yml b/etc/backports_required_for_multiversion_tests.yml
index ff2e8ab2990..4b7ec4699e4 100644
--- a/etc/backports_required_for_multiversion_tests.yml
+++ b/etc/backports_required_for_multiversion_tests.yml
@@ -223,6 +223,8 @@ all:
     test_file: jstests/sharding/move_chunk_interrupt_postimage.js
   - ticket: SERVER-58176
     test_file: jstests/sharding/write_commands_read_concern_validation.js
+  - ticket: SERVER-64741
+    test_file: jstests/sharding/append_oplog_note_mongos.js
 
 suites:
 
diff --git a/jstests/sharding/append_oplog_note_mongos.js b/jstests/sharding/append_oplog_note_mongos.js
new file mode 100644
index 00000000000..1369ecb06be
--- /dev/null
+++ b/jstests/sharding/append_oplog_note_mongos.js
@@ -0,0 +1,76 @@
+/**
+ * Tests that the 'appendOplogNote' command on mongos correctly performs a no-op write on each
+ * shard and advances the $clusterTime.
+ */
+
+(function() {
+"use strict";
+
+load("jstests/libs/fail_point_util.js");
+
+function checkOplogEntry(actualOplogEntry) {
+    const {op, o} = actualOplogEntry;
+    assert.eq({op, o}, {op: "n", o: {a: 2}}, actualOplogEntry);
+}
+
+// We need to disable the periodic no-op writer so we can verify that the 'appendOplogNote'
+// no-op is the latest operation on the oplog.
+const st = new ShardingTest(
+    {mongos: 1, shards: 2, rs: {nodes: 2, setParameter: {writePeriodicNoops: false}}});
+const admin = st.getDB('admin');
+const shardOnePrimary = st.rs0.getPrimary();
+const shardTwoPrimary = st.rs1.getPrimary();
+
+// Test that issuing the command without the 'data' field results in an error.
+let res = assert.commandFailed(admin.runCommand({appendOplogNote: 1}));
+assert.eq(res.code, ErrorCodes.NoSuchKey);
+assert(res.hasOwnProperty("raw"), res);
+
+// Test that the error response contains the correct fields.
+const appendOplogNoteFailpoint = configureFailPoint(shardOnePrimary, "failCommand", {
+    errorCode: ErrorCodes.HostUnreachable,
+    failCommands: ["appendOplogNote"],
+    failInternalCommands: true
+});
+
+res = assert.commandFailed(admin.runCommand({appendOplogNote: 1, data: {a: 1}}));
+assert(res.hasOwnProperty("errmsg"), res);
+assert.eq(res.code, ErrorCodes.HostUnreachable);
+assert(res.hasOwnProperty("raw"), res);
+
+appendOplogNoteFailpoint.wait();
+appendOplogNoteFailpoint.off();
+
+// Test that a successful 'appendOplogNote' command performs a no-op write and advances the
+// $clusterTime.
+const shardOneBefore =
+    assert.commandWorked(shardOnePrimary.getDB("admin").runCommand({replSetGetStatus: 1}));
+const shardTwoBefore =
+    assert.commandWorked(shardTwoPrimary.getDB("admin").runCommand({replSetGetStatus: 1}));
+
+res = assert.commandWorked(admin.runCommand({appendOplogNote: 1, data: {a: 2}}));
+assert(res.hasOwnProperty("raw"), res);
+
+const shardOneAfter =
+    assert.commandWorked(shardOnePrimary.getDB("admin").runCommand({replSetGetStatus: 1}));
+const shardTwoAfter =
+    assert.commandWorked(shardTwoPrimary.getDB("admin").runCommand({replSetGetStatus: 1}));
+
+assert.lt(shardOneBefore.members[0].optime.ts, shardOneAfter.members[0].optime.ts);
+assert.lt(shardTwoBefore.members[0].optime.ts, shardTwoAfter.members[0].optime.ts);
+
+let lastEntryShardOne =
+    shardOnePrimary.getDB("local").oplog.rs.find().sort({$natural: -1}).limit(1).toArray()[0];
+let lastEntryShardTwo =
+    shardTwoPrimary.getDB("local").oplog.rs.find().sort({$natural: -1}).limit(1).toArray()[0];
+
+// The $clusterTime in the 'replSetGetStatus' response should be equal to the timestamp of
+// 'appendOplogNote' command no-op write, which is the last operation on the shard oplogs.
+checkOplogEntry(lastEntryShardOne);
+checkOplogEntry(lastEntryShardTwo);
+
+assert.eq(shardOneAfter.members[0].optime.ts, lastEntryShardOne.ts);
+assert.eq(shardTwoAfter.members[0].optime.ts, lastEntryShardTwo.ts);
+
+st.stop();
+}());
diff --git a/jstests/sharding/database_versioning_all_commands.js b/jstests/sharding/database_versioning_all_commands.js
index 517b7ac231e..c6c4360028e 100644
--- a/jstests/sharding/database_versioning_all_commands.js
+++ b/jstests/sharding/database_versioning_all_commands.js
@@ -263,6 +263,7 @@ let testCases = {
             }
         }
     },
+    appendOplogNote: {skip: "unversioned and executes on all shards"},
     authenticate: {skip: "does not forward command to primary shard"},
     availableQueryOptions: {skip: "executes locally on mongos (not sent to any remote node)"},
     balancerCollectionStatus: {skip: "does not forward command to primary shard"},
diff --git a/src/mongo/s/commands/SConscript b/src/mongo/s/commands/SConscript
index 69caec4a08a..2e8c32aa44b 100644
--- a/src/mongo/s/commands/SConscript
+++ b/src/mongo/s/commands/SConscript
@@ -25,6 +25,7 @@ env.Library(
         'cluster_abort_transaction_cmd.cpp',
         'cluster_add_shard_cmd.cpp',
         'cluster_add_shard_to_zone_cmd.cpp',
+        'cluster_oplog_note_cmd.cpp',
         'cluster_available_query_options_cmd.cpp',
         'cluster_balancer_collection_status_cmd.cpp',
         'cluster_build_info.cpp',
diff --git a/src/mongo/s/commands/cluster_oplog_note_cmd.cpp b/src/mongo/s/commands/cluster_oplog_note_cmd.cpp
new file mode 100644
index 00000000000..9dbb19518a0
--- /dev/null
+++ b/src/mongo/s/commands/cluster_oplog_note_cmd.cpp
@@ -0,0 +1,107 @@
+/**
+ *    Copyright (C) 2022-present MongoDB, Inc.
+ *
+ *    This program is free software: you can redistribute it and/or modify
+ *    it under the terms of the Server Side Public License, version 1,
+ *    as published by MongoDB, Inc.
+ *
+ *    This program is distributed in the hope that it will be useful,
+ *    but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *    Server Side Public License for more details.
+ *
+ *    You should have received a copy of the Server Side Public License
+ *    along with this program. If not, see
+ *    <http://www.mongodb.com/licensing/server-side-public-license>.
+ *
+ *    As a special exception, the copyright holders give permission to link the
+ *    code of portions of this program with the OpenSSL library under certain
+ *    conditions as described in each individual source file and distribute
+ *    linked combinations including the program with the OpenSSL library. You
+ *    must comply with the Server Side Public License in all respects for
+ *    all of the code used other than as permitted herein. If you modify file(s)
+ *    with this exception, you may extend this exception to your version of the
+ *    file(s), but you are not obligated to do so. If you do not wish to do so,
+ *    delete this exception statement from your version. If you delete this
+ *    exception statement from all source files in the program, then also delete
+ *    it in the license file.
+ */
+
+#define MONGO_LOGV2_DEFAULT_COMPONENT ::mongo::logv2::LogComponent::kCommand
+
+#include "mongo/platform/basic.h"
+
+#include "mongo/db/commands.h"
+
+#include "mongo/bson/util/bson_extract.h"
+#include "mongo/db/auth/action_type.h"
+#include "mongo/db/auth/authorization_session.h"
+#include "mongo/db/auth/resource_pattern.h"
+#include "mongo/db/concurrency/d_concurrency.h"
+#include "mongo/db/curop.h"
+#include "mongo/db/namespace_string.h"
+#include "mongo/db/operation_context.h"
+#include "mongo/db/service_context.h"
+#include "mongo/s/cluster_commands_helpers.h"
+
+
+namespace mongo {
+
+
+using std::string;
+using std::stringstream;
+
+class AppendOplogNoteCmd : public BasicCommand {
+public:
+    AppendOplogNoteCmd() : BasicCommand("appendOplogNote") {}
+
+    AllowedOnSecondary secondaryAllowed(ServiceContext*) const override {
+        return AllowedOnSecondary::kNever;
+    }
+
+    virtual bool adminOnly() const {
+        return true;
+    }
+
+    virtual bool supportsWriteConcern(const BSONObj& cmd) const override {
+        return true;
+    }
+
+    std::string help() const override {
+        return "Performs a no-op entry on the oplog on each shard";
+    }
+
+    virtual Status checkAuthForCommand(Client* client,
+                                       const std::string& dbname,
+                                       const BSONObj& cmdObj) const {
+        if (!AuthorizationSession::get(client)->isAuthorizedForActionsOnResource(
+                ResourcePattern::forClusterResource(), ActionType::appendOplogNote)) {
+            return Status(ErrorCodes::Unauthorized, "Unauthorized");
+        }
+        return Status::OK();
+    }
+
+    virtual bool run(OperationContext* opCtx,
+                     const string& dbname,
+                     const BSONObj& cmdObj,
+                     BSONObjBuilder& result) {
+
+        auto shardResponses = scatterGatherUnversionedTargetAllShards(
+            opCtx,
+            dbname,
+            applyReadWriteConcern(
+                opCtx, this, CommandHelpers::filterCommandRequestForPassthrough(cmdObj)),
+            ReadPreferenceSetting::get(opCtx),
+            Shard::RetryPolicy::kIdempotent);
+
+        std::string errmsg;
+        return appendRawResponses(opCtx, &errmsg, &result, shardResponses).responseOK;
+    }
+};
+
+MONGO_INITIALIZER(RegisterAppendOpLogNoteCmd)(InitializerContext* context) {
+    new AppendOplogNoteCmd();
+    return Status::OK();
+}
+
+}  // namespace mongo