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
|
/**
* Copyright (C) 2018-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.
*/
#pragma once
#include "mongo/db/logical_session_id.h"
namespace mongo {
static constexpr StringData kErrorLabelsFieldName = "errorLabels"_sd;
namespace ErrorLabel {
// PLEASE CONSULT DRIVERS BEFORE ADDING NEW ERROR LABELS.
static constexpr StringData kTransientTransaction = "TransientTransactionError"_sd;
static constexpr StringData kRetryableWrite = "RetryableWriteError"_sd;
static constexpr StringData kNonResumableChangeStream = "NonResumableChangeStreamError"_sd;
static constexpr StringData kResumableChangeStream = "ResumableChangeStreamError"_sd;
} // namespace ErrorLabel
class ErrorLabelBuilder {
public:
ErrorLabelBuilder(OperationContext* opCtx,
const OperationSessionInfoFromClient& sessionOptions,
const std::string& commandName,
boost::optional<ErrorCodes::Error> code,
boost::optional<ErrorCodes::Error> wcCode,
bool isInternalClient)
: _opCtx(opCtx),
_sessionOptions(sessionOptions),
_commandName(commandName),
_code(code),
_wcCode(wcCode),
_isInternalClient(isInternalClient) {}
void build(BSONArrayBuilder& labels) const;
bool isTransientTransactionError() const;
bool isRetryableWriteError() const;
bool isResumableChangeStreamError() const;
bool isNonResumableChangeStreamError() const;
private:
bool _isCommitOrAbort() const;
OperationContext* _opCtx;
const OperationSessionInfoFromClient& _sessionOptions;
const std::string& _commandName;
boost::optional<ErrorCodes::Error> _code;
boost::optional<ErrorCodes::Error> _wcCode;
bool _isInternalClient;
};
/**
* Returns the error labels for the given error.
*/
BSONObj getErrorLabels(OperationContext* opCtx,
const OperationSessionInfoFromClient& sessionOptions,
const std::string& commandName,
boost::optional<ErrorCodes::Error> code,
boost::optional<ErrorCodes::Error> wcCode,
bool isInternalClient);
/**
* Whether a write error in a transaction should be labelled with "TransientTransactionError".
*/
bool isTransientTransactionError(ErrorCodes::Error code,
bool hasWriteConcernError,
bool isCommitOrAbort);
} // namespace mongo
|
