summaryrefslogtreecommitdiff
path: root/jstests/sharding/txn_two_phase_commit_basic.js
blob: 09f4f1bf0cffef92df62dfacb8b91a83f8270f29 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
/**
 * Exercises the coordinator commands logic by simulating a basic two phase commit and basic two
 * phase abort.
 *
 * @tags: [uses_transactions, uses_prepare_transaction, uses_multi_shard_transaction]
 */

(function() {
    'use strict';

    load('jstests/sharding/libs/sharded_transactions_helpers.js');

    const dbName = "test";
    const collName = "foo";
    const ns = dbName + "." + collName;

    let st = new ShardingTest({shards: 3, causallyConsistent: true});

    let coordinator = st.shard0;
    let participant1 = st.shard1;
    let participant2 = st.shard2;

    let expectedParticipantList =
        [participant1.shardName, participant2.shardName, coordinator.shardName];

    let lsid = {id: UUID()};
    let txnNumber = 0;

    const checkParticipantListMatches = function(
        coordinatorConn, lsid, txnNumber, expectedParticipantList) {
        let coordDoc = coordinatorConn.getDB("config")
                           .getCollection("transaction_coordinators")
                           .findOne({"_id.lsid.id": lsid.id, "_id.txnNumber": txnNumber});
        assert.neq(null, coordDoc);
        assert.sameMembers(coordDoc.participants, expectedParticipantList);
    };

    const checkDecisionIs = function(coordinatorConn, lsid, txnNumber, expectedDecision) {
        let coordDoc = coordinatorConn.getDB("config")
                           .getCollection("transaction_coordinators")
                           .findOne({"_id.lsid.id": lsid.id, "_id.txnNumber": txnNumber});
        assert.neq(null, coordDoc);
        assert.eq(expectedDecision, coordDoc.decision.decision);
        if (expectedDecision === "commit") {
            assert.neq(null, coordDoc.decision.commitTimestamp);
        } else {
            assert.eq(null, coordDoc.decision.commitTimestamp);
        }
    };

    const checkDocumentDeleted = function(coordinatorConn, lsid, txnNumber) {
        let coordDoc = coordinatorConn.getDB("config")
                           .getCollection("transaction_coordinators")
                           .findOne({"_id.lsid.id": lsid.id, "_id.txnNumber": txnNumber});
        return null === coordDoc;
    };

    const runCommitThroughMongosInParallelShellExpectSuccess = function() {
        const runCommitExpectSuccessCode = "assert.commandWorked(db.adminCommand({" +
            "commitTransaction: 1," + "lsid: " + tojson(lsid) + "," + "txnNumber: NumberLong(" +
            txnNumber + ")," + "stmtId: NumberInt(0)," + "autocommit: false," + "}));";
        return startParallelShell(runCommitExpectSuccessCode, st.s.port);
    };

    const runCommitThroughMongosInParallelShellExpectAbort = function() {
        const runCommitExpectSuccessCode = "assert.commandFailedWithCode(db.adminCommand({" +
            "commitTransaction: 1," + "lsid: " + tojson(lsid) + "," + "txnNumber: NumberLong(" +
            txnNumber + ")," + "stmtId: NumberInt(0)," + "autocommit: false," + "})," +
            "ErrorCodes.NoSuchTransaction);";
        return startParallelShell(runCommitExpectSuccessCode, st.s.port);
    };

    const startSimulatingNetworkFailures = function(connArray) {
        connArray.forEach(function(conn) {
            assert.commandWorked(conn.adminCommand({
                configureFailPoint: "failCommand",
                mode: {times: 10},
                data: {
                    errorCode: ErrorCodes.NotMaster,
                    failCommands:
                        ["prepareTransaction", "abortTransaction", "commitTransaction"]
                }
            }));
            assert.commandWorked(conn.adminCommand({
                configureFailPoint:
                    "participantReturnNetworkErrorForPrepareAfterExecutingPrepareLogic",
                mode: {times: 5}
            }));
            assert.commandWorked(conn.adminCommand({
                configureFailPoint: "participantReturnNetworkErrorForAbortAfterExecutingAbortLogic",
                mode: {times: 5}
            }));
            assert.commandWorked(conn.adminCommand({
                configureFailPoint:
                    "participantReturnNetworkErrorForCommitAfterExecutingCommitLogic",
                mode: {times: 5}
            }));
        });
    };

    const stopSimulatingNetworkFailures = function(connArray) {
        connArray.forEach(function(conn) {
            assert.commandWorked(conn.adminCommand({
                configureFailPoint: "failCommand",
                mode: "off",
            }));
            assert.commandWorked(conn.adminCommand({
                configureFailPoint:
                    "participantReturnNetworkErrorForPrepareAfterExecutingPrepareLogic",
                mode: "off"
            }));
            assert.commandWorked(conn.adminCommand({
                configureFailPoint: "participantReturnNetworkErrorForAbortAfterExecutingAbortLogic",
                mode: "off"
            }));
            assert.commandWorked(conn.adminCommand({
                configureFailPoint:
                    "participantReturnNetworkErrorForCommitAfterExecutingCommitLogic",
                mode: "off"
            }));
        });
    };

    const setUp = function() {
        // Create a sharded collection with a chunk on each shard:
        // shard0: [-inf, 0)
        // shard1: [0, 10)
        // shard2: [10, +inf)
        assert.commandWorked(st.s.adminCommand({enableSharding: dbName}));
        assert.commandWorked(st.s.adminCommand({movePrimary: dbName, to: coordinator.shardName}));
        assert.commandWorked(st.s.adminCommand({shardCollection: ns, key: {_id: 1}}));
        assert.commandWorked(st.s.adminCommand({split: ns, middle: {_id: 0}}));
        assert.commandWorked(st.s.adminCommand({split: ns, middle: {_id: 10}}));
        assert.commandWorked(
            st.s.adminCommand({moveChunk: ns, find: {_id: 0}, to: participant1.shardName}));
        assert.commandWorked(
            st.s.adminCommand({moveChunk: ns, find: {_id: 10}, to: participant2.shardName}));

        // These forced refreshes are not strictly necessary; they just prevent extra TXN log lines
        // from the shards starting, aborting, and restarting the transaction due to needing to
        // refresh after the transaction has started.
        assert.commandWorked(coordinator.adminCommand({_flushRoutingTableCacheUpdates: ns}));
        assert.commandWorked(participant1.adminCommand({_flushRoutingTableCacheUpdates: ns}));
        assert.commandWorked(participant2.adminCommand({_flushRoutingTableCacheUpdates: ns}));

        // Start a new transaction by inserting a document onto each shard.
        assert.commandWorked(st.s.getDB(dbName).runCommand({
            insert: collName,
            documents: [{_id: -5}, {_id: 5}, {_id: 15}],
            lsid: lsid,
            txnNumber: NumberLong(txnNumber),
            stmtId: NumberInt(0),
            startTransaction: true,
            autocommit: false,
        }));
    };

    const testCommitProtocol = function(shouldCommit, simulateNetworkFailures) {
        jsTest.log("Testing two-phase " + (shouldCommit ? "commit" : "abort") +
                   " protocol with simulateNetworkFailures: " + simulateNetworkFailures);

        txnNumber++;
        setUp();

        if (!shouldCommit) {
            // Manually abort the transaction on one of the participants, so that the participant
            // fails to prepare.
            assert.commandWorked(participant2.adminCommand({
                abortTransaction: 1,
                lsid: lsid,
                txnNumber: NumberLong(txnNumber),
                stmtId: NumberInt(0),
                autocommit: false,
            }));
        }

        if (simulateNetworkFailures) {
            startSimulatingNetworkFailures([participant1, participant2]);
        }

        // Turn on failpoints so that the coordinator hangs after each write it does, so that the
        // test can check that the write happened correctly.
        assert.commandWorked(coordinator.adminCommand({
            configureFailPoint: "hangBeforeWaitingForParticipantListWriteConcern",
            mode: "alwaysOn",
        }));
        assert.commandWorked(coordinator.adminCommand({
            configureFailPoint: "hangBeforeWaitingForDecisionWriteConcern",
            mode: "alwaysOn",
        }));

        // Run commitTransaction through a parallel shell.
        let awaitResult;
        if (shouldCommit) {
            awaitResult = runCommitThroughMongosInParallelShellExpectSuccess();
        } else {
            awaitResult = runCommitThroughMongosInParallelShellExpectAbort();
        }

        // Check that the coordinator wrote the participant list.
        waitForFailpoint("Hit hangBeforeWaitingForParticipantListWriteConcern failpoint",
                         txnNumber);
        checkParticipantListMatches(coordinator, lsid, txnNumber, expectedParticipantList);
        assert.commandWorked(coordinator.adminCommand({
            configureFailPoint: "hangBeforeWaitingForParticipantListWriteConcern",
            mode: "off",
        }));

        // Check that the coordinator wrote the decision.
        waitForFailpoint("Hit hangBeforeWaitingForDecisionWriteConcern failpoint", txnNumber);
        checkParticipantListMatches(coordinator, lsid, txnNumber, expectedParticipantList);
        checkDecisionIs(coordinator, lsid, txnNumber, (shouldCommit ? "commit" : "abort"));
        assert.commandWorked(coordinator.adminCommand({
            configureFailPoint: "hangBeforeWaitingForDecisionWriteConcern",
            mode: "off",
        }));

        // Check that the coordinator deleted its persisted state.
        awaitResult();
        assert.soon(function() {
            return checkDocumentDeleted(coordinator, lsid, txnNumber);
        });

        if (simulateNetworkFailures) {
            stopSimulatingNetworkFailures([participant1, participant2]);
        }

        // Check that the transaction committed or aborted as expected.
        if (!shouldCommit) {
            jsTest.log("Verify that the transaction was aborted on all shards.");
            assert.eq(0, st.s.getDB(dbName).getCollection(collName).find().itcount());
        } else {
            jsTest.log("Verify that the transaction was committed on all shards.");
            // Use assert.soon(), because although coordinateCommitTransaction currently blocks
            // until the commit process is fully complete, it will eventually be changed to only
            // block until the decision is *written*, at which point the test can pass the
            // operationTime returned by coordinateCommitTransaction as 'afterClusterTime' in the
            // read to ensure the read sees the transaction's writes (TODO SERVER-37165).
            assert.soon(function() {
                return 3 === st.s.getDB(dbName).getCollection(collName).find().itcount();
            });
        }

        st.s.getDB(dbName).getCollection(collName).drop();
    };

    testCommitProtocol(false /* test abort */, false /* no network failures */);
    testCommitProtocol(true /* test commit */, false /* no network failures */);
    testCommitProtocol(false /* test abort */, true /* with network failures */);
    testCommitProtocol(true /* test commit */, true /* with network failures */);

    st.stop();

})();