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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
|
/**
* Copyright (C) 2019-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.
*/
#include "mongo/platform/basic.h"
#include "mongo/db/curop.h"
#include "mongo/db/error_labels.h"
#include "mongo/db/logical_session_id.h"
#include "mongo/db/pipeline/lite_parsed_pipeline.h"
#include "mongo/db/service_context_test_fixture.h"
#include "mongo/unittest/unittest.h"
namespace mongo {
namespace {
TEST(IsTransientTransactionErrorTest, NetworkErrorsAreTransientBeforeCommit) {
ASSERT_TRUE(isTransientTransactionError(ErrorCodes::HostUnreachable,
false /* hasWriteConcernError */,
false /* isCommitOrAbort */));
}
TEST(IsTransientTransactionErrorTest, NetworkErrorsAreNotTransientOnCommit) {
ASSERT_FALSE(isTransientTransactionError(
ErrorCodes::HostUnreachable, false /* hasWriteConcernError */, true /* isCommitOrAbort */));
}
TEST(IsTransientTransactionErrorTest, RetryableWriteErrorsAreNotTransientOnAbort) {
ASSERT_FALSE(isTransientTransactionError(ErrorCodes::NotWritablePrimary,
false /* hasWriteConcernError */,
true /* isCommitOrAbort */));
}
TEST(IsTransientTransactionErrorTest,
NoSuchTransactionWithWriteConcernErrorsAreNotTransientOnCommit) {
ASSERT_FALSE(isTransientTransactionError(ErrorCodes::NoSuchTransaction,
true /* hasWriteConcernError */,
true /* isCommitOrAbort */));
}
TEST(IsTransientTransactionErrorTest,
NoSuchTransactionWithoutWriteConcernErrorsAreTransientOnCommit) {
ASSERT_TRUE(isTransientTransactionError(ErrorCodes::NoSuchTransaction,
false /* hasWriteConcernError */,
true /* isCommitOrAbort */));
}
class ErrorLabelBuilderTest : public ServiceContextTest {
public:
ErrorLabelBuilderTest() : _opCtx(makeOperationContext()) {}
void setCommand(BSONObj cmdObj) const {
CurOp::get(opCtx())->setGenericOpRequestDetails(
opCtx(), _testNss, nullptr, cmdObj, NetworkOp::dbMsg);
}
void setGetMore(BSONObj originatingCommand) const {
setCommand(BSON("getMore" << 1000000ll << "collection" << _testNss.coll()));
stdx::lock_guard<Client> lk(*opCtx()->getClient());
CurOp::get(opCtx())->setOriginatingCommand_inlock(originatingCommand);
}
const NamespaceString& nss() const {
return _testNss;
}
OperationContext* opCtx() const {
return _opCtx.get();
}
private:
const NamespaceString _testNss{"test", "testing"};
ServiceContext::UniqueOperationContext _opCtx;
};
TEST_F(ErrorLabelBuilderTest, NonErrorCodesHaveNoLabel) {
OperationSessionInfoFromClient sessionInfo;
std::string commandName = "insert";
ErrorLabelBuilder builder(opCtx(), sessionInfo, commandName, boost::none, boost::none, false);
ASSERT_FALSE(builder.isTransientTransactionError());
ASSERT_FALSE(builder.isRetryableWriteError());
ASSERT_FALSE(builder.isResumableChangeStreamError());
}
TEST_F(ErrorLabelBuilderTest, NonTransactionsHaveNoTransientTransactionErrorLabel) {
OperationSessionInfoFromClient sessionInfo;
std::string commandName = "insert";
ErrorLabelBuilder builder(
opCtx(), sessionInfo, commandName, ErrorCodes::WriteConflict, boost::none, false);
ASSERT_FALSE(builder.isTransientTransactionError());
}
TEST_F(ErrorLabelBuilderTest, RetryableWritesHaveNoTransientTransactionErrorLabel) {
OperationSessionInfoFromClient sessionInfo;
sessionInfo.setTxnNumber(1);
std::string commandName = "insert";
ErrorLabelBuilder builder(
opCtx(), sessionInfo, commandName, ErrorCodes::WriteConflict, boost::none, false);
ASSERT_FALSE(builder.isTransientTransactionError());
}
TEST_F(ErrorLabelBuilderTest, NonTransientTransactionErrorsHaveNoTransientTransactionErrorLabel) {
OperationSessionInfoFromClient sessionInfo;
sessionInfo.setTxnNumber(1);
sessionInfo.setAutocommit(false);
std::string commandName = "commitTransaction";
ErrorLabelBuilder builder(
opCtx(), sessionInfo, commandName, ErrorCodes::NotWritablePrimary, boost::none, false);
ASSERT_FALSE(builder.isTransientTransactionError());
}
TEST_F(ErrorLabelBuilderTest, TransientTransactionErrorsHaveTransientTransactionErrorLabel) {
OperationSessionInfoFromClient sessionInfo;
sessionInfo.setTxnNumber(1);
sessionInfo.setAutocommit(false);
std::string commandName = "commitTransaction";
ErrorLabelBuilder builder(
opCtx(), sessionInfo, commandName, ErrorCodes::NoSuchTransaction, boost::none, false);
ASSERT_TRUE(builder.isTransientTransactionError());
}
TEST_F(ErrorLabelBuilderTest, NonRetryableWritesHaveNoRetryableWriteErrorLabel) {
OperationSessionInfoFromClient sessionInfo;
std::string commandName = "insert";
ErrorLabelBuilder builder(
opCtx(), sessionInfo, commandName, ErrorCodes::NotWritablePrimary, boost::none, false);
// Test regular writes.
ASSERT_FALSE(builder.isRetryableWriteError());
// Test transaction writes.
sessionInfo.setTxnNumber(1);
sessionInfo.setAutocommit(false);
ASSERT_FALSE(builder.isRetryableWriteError());
}
TEST_F(ErrorLabelBuilderTest, NonRetryableWriteErrorsHaveNoRetryableWriteErrorLabel) {
OperationSessionInfoFromClient sessionInfo;
sessionInfo.setTxnNumber(1);
std::string commandName = "update";
ErrorLabelBuilder builder(
opCtx(), sessionInfo, commandName, ErrorCodes::WriteConflict, boost::none, false);
ASSERT_FALSE(builder.isRetryableWriteError());
}
TEST_F(ErrorLabelBuilderTest, RetryableWriteErrorsHaveRetryableWriteErrorLabel) {
OperationSessionInfoFromClient sessionInfo;
sessionInfo.setTxnNumber(1);
std::string commandName = "update";
ErrorLabelBuilder builder(
opCtx(), sessionInfo, commandName, ErrorCodes::NotWritablePrimary, boost::none, false);
ASSERT_TRUE(builder.isRetryableWriteError());
}
TEST_F(ErrorLabelBuilderTest,
RetryableWriteErrorsHaveNoRetryableWriteErrorLabelForInternalClients) {
OperationSessionInfoFromClient sessionInfo;
sessionInfo.setTxnNumber(1);
std::string commandName = "update";
ErrorLabelBuilder builder(
opCtx(), sessionInfo, commandName, ErrorCodes::NotWritablePrimary, boost::none, true);
ASSERT_FALSE(builder.isRetryableWriteError());
}
TEST_F(ErrorLabelBuilderTest,
NonRetryableWriteErrorsInWriteConcernErrorsHaveNoRetryableWriteErrorLabel) {
OperationSessionInfoFromClient sessionInfo;
sessionInfo.setTxnNumber(1);
std::string commandName = "update";
ErrorLabelBuilder builder(opCtx(),
sessionInfo,
commandName,
ErrorCodes::WriteConcernFailed,
ErrorCodes::WriteConcernFailed,
false);
ASSERT_FALSE(builder.isRetryableWriteError());
}
TEST_F(ErrorLabelBuilderTest,
RetryableWriteErrorsInWriteConcernErrorsHaveRetryableWriteErrorLabel) {
OperationSessionInfoFromClient sessionInfo;
sessionInfo.setTxnNumber(1);
std::string commandName = "update";
ErrorLabelBuilder builder(opCtx(),
sessionInfo,
commandName,
ErrorCodes::WriteConcernFailed,
ErrorCodes::PrimarySteppedDown,
false);
ASSERT_TRUE(builder.isRetryableWriteError());
}
TEST_F(ErrorLabelBuilderTest, RetryableWriteErrorsOnCommitAbortHaveRetryableWriteErrorLabel) {
OperationSessionInfoFromClient sessionInfo;
sessionInfo.setTxnNumber(1);
sessionInfo.setAutocommit(false);
std::string commandName;
commandName = "commitTransaction";
ErrorLabelBuilder commitBuilder(
opCtx(), sessionInfo, commandName, ErrorCodes::NotWritablePrimary, boost::none, false);
ASSERT_TRUE(commitBuilder.isRetryableWriteError());
commandName = "coordinateCommitTransaction";
ErrorLabelBuilder coordinateCommitBuilder(
opCtx(), sessionInfo, commandName, ErrorCodes::NotWritablePrimary, boost::none, false);
ASSERT_TRUE(coordinateCommitBuilder.isRetryableWriteError());
commandName = "abortTransaction";
ErrorLabelBuilder abortBuilder(
opCtx(), sessionInfo, commandName, ErrorCodes::NotWritablePrimary, boost::none, false);
ASSERT_TRUE(abortBuilder.isRetryableWriteError());
}
TEST_F(ErrorLabelBuilderTest, NonResumableChangeStreamError) {
OperationSessionInfoFromClient sessionInfo;
std::string commandName;
ErrorLabelBuilder builder(
opCtx(), sessionInfo, commandName, ErrorCodes::ChangeStreamHistoryLost, boost::none, false);
ASSERT_TRUE(builder.isNonResumableChangeStreamError());
}
TEST_F(ErrorLabelBuilderTest, ResumableChangeStreamErrorAppliesToChangeStreamAggregations) {
OperationSessionInfoFromClient sessionInfo;
// Build the aggregation command and confirm that it parses correctly, so we know that the error
// is the only factor that determines the success or failure of isResumableChangeStreamError().
auto cmdObj = BSON("aggregate" << nss().coll() << "pipeline"
<< BSON_ARRAY(BSON("$changeStream" << BSONObj())) << "cursor"
<< BSONObj());
auto aggRequest = uassertStatusOK(AggregationRequest::parseFromBSON(nss(), cmdObj));
ASSERT_TRUE(LiteParsedPipeline(aggRequest).hasChangeStream());
// The label applies to a $changeStream "aggregate" command.
std::string commandName = "aggregate";
setCommand(cmdObj);
ErrorLabelBuilder resumableAggBuilder(
opCtx(), sessionInfo, commandName, ErrorCodes::NetworkTimeout, boost::none, false);
ASSERT_TRUE(resumableAggBuilder.isResumableChangeStreamError());
// The label applies to a "getMore" command on a $changeStream cursor.
commandName = "getMore";
setGetMore(cmdObj);
ErrorLabelBuilder resumableGetMoreBuilder(
opCtx(), sessionInfo, commandName, ErrorCodes::NetworkTimeout, boost::none, false);
ASSERT_TRUE(resumableGetMoreBuilder.isResumableChangeStreamError());
}
TEST_F(ErrorLabelBuilderTest, ResumableChangeStreamErrorDoesNotApplyToNonResumableErrors) {
OperationSessionInfoFromClient sessionInfo;
// Build the aggregation command and confirm that it parses correctly, so we know that the error
// is the only factor that determines the success or failure of isResumableChangeStreamError().
auto cmdObj = BSON("aggregate" << nss().coll() << "pipeline"
<< BSON_ARRAY(BSON("$changeStream" << BSONObj())) << "cursor"
<< BSONObj());
auto aggRequest = uassertStatusOK(AggregationRequest::parseFromBSON(nss(), cmdObj));
ASSERT_TRUE(LiteParsedPipeline(aggRequest).hasChangeStream());
// The label does not apply to a ChangeStreamFatalError error on a $changeStream aggregation.
std::string commandName = "aggregate";
setCommand(cmdObj);
ErrorLabelBuilder resumableAggBuilder(
opCtx(), sessionInfo, commandName, ErrorCodes::ChangeStreamFatalError, boost::none, false);
ASSERT_FALSE(resumableAggBuilder.isResumableChangeStreamError());
// The label does not apply to a ChangeStreamFatalError error on a $changeStream getMore.
commandName = "getMore";
setGetMore(cmdObj);
ErrorLabelBuilder resumableGetMoreBuilder(
opCtx(), sessionInfo, commandName, ErrorCodes::ChangeStreamFatalError, boost::none, false);
ASSERT_FALSE(resumableGetMoreBuilder.isResumableChangeStreamError());
}
TEST_F(ErrorLabelBuilderTest, ResumableChangeStreamErrorDoesNotApplyToNonChangeStreamAggregations) {
OperationSessionInfoFromClient sessionInfo;
// Build the aggregation command and confirm that it parses correctly, so we know that the error
// is the only factor that determines the success or failure of isResumableChangeStreamError().
auto cmdObj =
BSON("aggregate" << nss().coll() << "pipeline" << BSON_ARRAY(BSON("$match" << BSONObj()))
<< "cursor" << BSONObj());
auto aggRequest = uassertStatusOK(AggregationRequest::parseFromBSON(nss(), cmdObj));
ASSERT_FALSE(LiteParsedPipeline(aggRequest).hasChangeStream());
// The label does not apply to a non-$changeStream "aggregate" command.
std::string commandName = "aggregate";
setCommand(cmdObj);
ErrorLabelBuilder nonResumableAggBuilder(
opCtx(), sessionInfo, commandName, ErrorCodes::NetworkTimeout, boost::none, false);
ASSERT_FALSE(nonResumableAggBuilder.isResumableChangeStreamError());
// The label does not apply to a "getMore" command on a non-$changeStream cursor.
commandName = "getMore";
setGetMore(cmdObj);
ErrorLabelBuilder nonResumableGetMoreBuilder(
opCtx(), sessionInfo, commandName, ErrorCodes::NetworkTimeout, boost::none, false);
ASSERT_FALSE(nonResumableGetMoreBuilder.isResumableChangeStreamError());
}
TEST_F(ErrorLabelBuilderTest, ResumableChangeStreamErrorDoesNotApplyToNonAggregations) {
OperationSessionInfoFromClient sessionInfo;
auto cmdObj = BSON("find" << nss().coll() << "filter" << BSONObj());
// The label does not apply to a "find" command.
std::string commandName = "find";
setCommand(cmdObj);
ErrorLabelBuilder nonResumableFindBuilder(
opCtx(), sessionInfo, commandName, ErrorCodes::NetworkTimeout, boost::none, false);
ASSERT_FALSE(nonResumableFindBuilder.isResumableChangeStreamError());
// The label does not apply to a "getMore" command on a "find" cursor.
commandName = "getMore";
setGetMore(cmdObj);
ErrorLabelBuilder nonResumableGetMoreBuilder(
opCtx(), sessionInfo, commandName, ErrorCodes::NetworkTimeout, boost::none, false);
ASSERT_FALSE(nonResumableGetMoreBuilder.isResumableChangeStreamError());
}
} // namespace
} // namespace mongo
|
