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
|
/**
* 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 <memory>
// This file is included by many low-level headers including status.h, so it isn't able to include
// much without creating a cycle.
#include "mongo/base/error_codes.h"
#include "mongo/base/static_assert.h"
namespace mongo {
class BSONObj;
class BSONObjBuilder;
/**
* Base class for the extra info that can be attached to commands.
*
* Actual implementations must have a 'constexpr ErrorCode::Error code' to indicate which
* error code they bind to, and a static method with the following signature:
* static std::shared_ptr<const ErrorExtraInfo> parse(const BSONObj&);
* You must call the MONGO_INIT_REGISTER_ERROR_EXTRA_INFO(type) macro in the cpp file that contains
* the implementation for your subtype.
*/
class ErrorExtraInfo {
public:
using Parser = std::shared_ptr<const ErrorExtraInfo>(const BSONObj&);
ErrorExtraInfo() = default;
virtual ~ErrorExtraInfo() = default;
/**
* Puts the extra info (and just the extra info) into builder.
*/
virtual void serialize(BSONObjBuilder* builder) const = 0;
/**
* Returns the registered parser for a given code or nullptr if none is registered.
*/
static Parser* parserFor(ErrorCodes::Error);
/**
* Use the MONGO_INIT_REGISTER_ERROR_EXTRA_INFO(type) macro below rather than calling this
* directly.
*/
template <typename T>
static void registerType() {
MONGO_STATIC_ASSERT(std::is_base_of<ErrorExtraInfo, T>());
MONGO_STATIC_ASSERT(std::is_same<error_details::ErrorExtraInfoFor<T::code>, T>());
MONGO_STATIC_ASSERT(std::is_final<T>());
MONGO_STATIC_ASSERT(std::is_move_constructible<T>());
registerParser(T::code, T::parse);
}
/**
* Fails fatally if any error codes that should have parsers registered don't. An invariant in
* this function indicates that there isn't a MONGO_INIT_REGISTER_ERROR_EXTRA_INFO declaration
* for some error code, which requires an extra info.
*
* Call this during startup of any shipping executable to prevent failures at runtime.
*/
static void invariantHaveAllParsers();
private:
static void registerParser(ErrorCodes::Error code, Parser* parser);
};
/**
* Registers the parser for an ErrorExtraInfo subclass. This must be called at namespace scope in
* the same cpp file as the virtual methods for that type.
*
* You must separately #include "mongo/base/init.h" since including it here would create an include
* cycle.
*/
#define MONGO_INIT_REGISTER_ERROR_EXTRA_INFO(type) \
MONGO_INITIALIZER_GENERAL(RegisterErrorExtraInfoFor##type, (), ("default")) \
(InitializerContext*) { \
ErrorExtraInfo::registerType<type>(); \
}
/**
* This is an example ErrorExtraInfo subclass. It is used for testing the ErrorExtraInfoHandling.
*
* The default parser just throws a numeric code since this class should never be encountered in
* production. A normal parser is activated while an EnableParserForTesting object is in scope.
*/
class ErrorExtraInfoExample final : public ErrorExtraInfo {
public:
static constexpr auto code = ErrorCodes::ForTestingErrorExtraInfo;
void serialize(BSONObjBuilder*) const override;
static std::shared_ptr<const ErrorExtraInfo> parse(const BSONObj&);
// Everything else in this class is just for testing and shouldn't by copied by users.
struct EnableParserForTest {
EnableParserForTest() {
isParserEnabledForTest = true;
}
~EnableParserForTest() {
isParserEnabledForTest = false;
}
};
ErrorExtraInfoExample(int data) : data(data) {}
int data; // This uses the fieldname "data".
private:
static bool isParserEnabledForTest;
};
/**
* This is an example ErrorExtraInfo subclass. It is used for testing the ErrorExtraInfoHandling.
*
* It is meant to be a duplicate of ErrorExtraInfoExample, except that it is optional. This will
* make sure we don't crash the server when an ErrorExtraInfo class is meant to be optional.
*/
class OptionalErrorExtraInfoExample final : public ErrorExtraInfo {
public:
static constexpr auto code = ErrorCodes::ForTestingOptionalErrorExtraInfo;
void serialize(BSONObjBuilder*) const override;
static std::shared_ptr<const ErrorExtraInfo> parse(const BSONObj&);
// Everything else in this class is just for testing and shouldn't by copied by users.
struct EnableParserForTest {
EnableParserForTest() {
isParserEnabledForTest = true;
}
~EnableParserForTest() {
isParserEnabledForTest = false;
}
};
OptionalErrorExtraInfoExample(int data) : data(data) {}
int data; // This uses the fieldname "data".
private:
static bool isParserEnabledForTest;
};
namespace nested::twice {
/**
* This is an example ErrorExtraInfo subclass. It is used for testing the ErrorExtraInfoHandling.
*
* It is meant to be a duplicate of ErrorExtraInfoExample, except that it is within a namespace
* (and so exercises a different codepath in the parser).
*/
class NestedErrorExtraInfoExample final : public ErrorExtraInfo {
public:
static constexpr auto code = ErrorCodes::ForTestingErrorExtraInfoWithExtraInfoInNamespace;
void serialize(BSONObjBuilder*) const override;
static std::shared_ptr<const ErrorExtraInfo> parse(const BSONObj&);
// Everything else in this class is just for testing and shouldn't by copied by users.
struct EnableParserForTest {
EnableParserForTest() {
isParserEnabledForTest = true;
}
~EnableParserForTest() {
isParserEnabledForTest = false;
}
};
NestedErrorExtraInfoExample(int data) : data(data) {}
int data; // This uses the fieldname "data".
private:
static bool isParserEnabledForTest;
};
} // namespace nested::twice
} // namespace mongo
|
