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
|
/**
* Copyright (C) 2021-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/catalog/collection.h"
#include "mongo/db/catalog/collection_catalog_helper.h"
#include "mongo/db/catalog/database_holder.h"
#include "mongo/db/catalog/index_catalog.h"
#include "mongo/db/catalog/index_key_validate.h"
#include "mongo/db/commands.h"
#include "mongo/db/commands/validate_db_metadata_common.h"
#include "mongo/db/commands/validate_db_metadata_gen.h"
#include "mongo/db/db_raii.h"
#include "mongo/db/views/view_catalog.h"
#include "mongo/logv2/log.h"
namespace mongo {
namespace {
void overrideAPIParams(OperationContext* opCtx, const APIParamsForCmd& params) {
APIParameters apiParameters;
apiParameters.setAPIVersion(params.getVersion());
apiParameters.setAPIStrict(params.getStrict());
apiParameters.setAPIDeprecationErrors(params.getDeprecationErrors());
APIParameters::get(opCtx) = std::move(apiParameters);
}
} // namespace
/**
* Example validate command:
* {
* validateDBMeta: 1,
* db: <string>,
* collection: <string>,
* apiParameters: {version: <string>, strict: <bool>, deprecationErrors: <bool>}
* }
*/
class ValidateDBMetadataCmd : public TypedCommand<ValidateDBMetadataCmd> {
using _TypedCommandInvocationBase =
typename TypedCommand<ValidateDBMetadataCmd>::InvocationBase;
public:
using Request = ValidateDBMetadataCommandRequest;
using Reply = ValidateDBMetadataCommandReply;
AllowedOnSecondary secondaryAllowed(ServiceContext*) const override {
return AllowedOnSecondary::kAlways;
}
bool maintenanceOk() const {
return false;
}
std::string help() const override {
return str::stream()
<< "validateDBMetadata checks that the stored metadata of a database/collection is "
"valid within a particular API version. If 'db' parameter is specified, only runs "
"validation against that database, if not the validation will be run againt all "
"dbs. Similarly if 'collection' parameter is specified, the validation is only "
"run against that collection, if not the validation is run against all collections.";
}
class Invocation : public _TypedCommandInvocationBase {
public:
using _TypedCommandInvocationBase::_TypedCommandInvocationBase;
bool supportsWriteConcern() const final {
return false;
}
NamespaceString ns() const final {
return NamespaceString(request().getDbName());
}
void doCheckAuthorization(OperationContext* opCtx) const final {
assertUserCanRunValidate(opCtx, request());
}
Reply typedRun(OperationContext* opCtx) {
overrideAPIParams(opCtx, request().getApiParameters());
runApiVersionValidation(opCtx);
_reply.setApiVersionErrors(std::move(apiVersionErrors));
// Reset API parameters.
APIParameters::get(opCtx) = APIParameters();
return _reply;
}
private:
void runApiVersionValidation(OperationContext* opCtx) {
auto collectionCatalog = CollectionCatalog::get(opCtx);
auto validateCmdRequest = this->request();
// If there is no database name present in the input, run validation against all the
// databases.
auto dbNames = validateCmdRequest.getDb()
? std::vector<std::string>{validateCmdRequest.getDb()->toString()}
: collectionCatalog->getAllDbNames();
for (const auto& dbName : dbNames) {
AutoGetDb autoDb(opCtx, dbName, LockMode::MODE_IS);
if (!autoDb.getDb()) {
continue;
}
if (validateCmdRequest.getCollection()) {
if (!_validateNamespace(
opCtx, NamespaceString(dbName, *validateCmdRequest.getCollection()))) {
return;
}
continue;
}
// If there is no collection name present in the input, run validation against all
// the collections.
if (auto viewCatalog = DatabaseHolder::get(opCtx)->getViewCatalog(opCtx, dbName)) {
viewCatalog->iterate([this, opCtx](const ViewDefinition& view) {
return _validateView(opCtx, view);
});
}
for (auto collIt = collectionCatalog->begin(opCtx, dbName);
collIt != collectionCatalog->end(opCtx);
++collIt) {
if (!_validateNamespace(
opCtx,
collectionCatalog->lookupNSSByUUID(opCtx, collIt.uuid().get()).get())) {
return;
}
}
}
}
/**
* Returns false, if the evaluation needs to be aborted.
*/
bool _validateView(OperationContext* opCtx, const ViewDefinition& view) {
auto pipelineStatus = ViewCatalog::validatePipeline(opCtx, view);
if (!pipelineStatus.isOK()) {
ErrorReplyElement error(view.name().ns(),
ErrorCodes::APIStrictError,
ErrorCodes::errorString(ErrorCodes::APIStrictError),
pipelineStatus.getStatus().reason());
if (!_sizeTracker.incrementAndCheckOverflow(error)) {
_reply.setHasMoreErrors(true);
return false;
}
apiVersionErrors.push_back(error);
}
return true;
}
/**
* Returns false, if the evaluation needs to be aborted.
*/
bool _validateNamespace(OperationContext* opCtx, const NamespaceStringOrUUID& coll) {
bool apiStrict = APIParameters::get(opCtx).getAPIStrict().value_or(false);
auto apiVersion = APIParameters::get(opCtx).getAPIVersion().value_or("");
// We permit views here so that user requested views can be allowed.
AutoGetCollection collection(
opCtx, coll, LockMode::MODE_IS, AutoGetCollectionViewMode::kViewsPermitted);
// If it view, just do the validations for view.
if (auto viewDef = collection.getView()) {
return _validateView(opCtx, *viewDef);
}
if (!collection.getCollection()) {
return true;
}
const auto status = collection->checkValidatorAPIVersionCompatability(opCtx);
if (!status.isOK()) {
ErrorReplyElement error(coll.nss()->ns(),
ErrorCodes::APIStrictError,
ErrorCodes::errorString(ErrorCodes::APIStrictError),
status.reason());
if (!_sizeTracker.incrementAndCheckOverflow(error)) {
_reply.setHasMoreErrors(true);
return false;
}
apiVersionErrors.push_back(error);
}
// Ensure there are no unstable indexes.
const auto* indexCatalog = collection->getIndexCatalog();
std::unique_ptr<IndexCatalog::IndexIterator> ii =
indexCatalog->getIndexIterator(opCtx, true /* includeUnfinishedIndexes */);
while (ii->more()) {
// Check if the index is allowed in API version 1.
const IndexDescriptor* desc = ii->next()->descriptor();
if (apiStrict && apiVersion == "1" &&
!index_key_validate::isIndexAllowedInAPIVersion1(*desc)) {
ErrorReplyElement error(coll.nss()->ns(),
ErrorCodes::APIStrictError,
ErrorCodes::errorString(ErrorCodes::APIStrictError),
str::stream()
<< "The index with name " << desc->indexName()
<< " is not allowed in API version 1.");
if (!_sizeTracker.incrementAndCheckOverflow(error)) {
_reply.setHasMoreErrors(true);
return false;
}
apiVersionErrors.push_back(error);
}
}
return true;
}
ValidateDBMetadataSizeTracker _sizeTracker;
std::vector<ErrorReplyElement> apiVersionErrors;
ValidateDBMetadataCommandReply _reply;
};
} validateDBMetadataCmd;
} // namespace mongo
|
