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
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
|
/**
* 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.
*/
#include "mongo/db/pipeline/expression.h"
#include "mongo/db/matcher/expression_always_boolean.h"
#include "mongo/db/pipeline/expression_context_for_test.h"
#include "mongo/db/query/canonical_query.h"
#include "mongo/db/query/collation/collator_interface_mock.h"
#include "mongo/db/query/index_tag.h"
#include "mongo/unittest/unittest.h"
namespace mongo {
namespace {
static const NamespaceString nss("testdb.testcoll");
using unittest::assertGet;
/**
* Helper function to parse the given BSON object as a MatchExpression, checks the status,
* and return the MatchExpression*.
*/
MatchExpression* parseMatchExpression(const BSONObj& obj) {
boost::intrusive_ptr<ExpressionContextForTest> expCtx(new ExpressionContextForTest());
StatusWithMatchExpression status =
MatchExpressionParser::parse(obj,
std::move(expCtx),
ExtensionsCallbackNoop(),
MatchExpressionParser::kAllowAllSpecialFeatures);
if (!status.isOK()) {
str::stream ss;
ss << "failed to parse query: " << obj.toString()
<< ". Reason: " << status.getStatus().toString();
FAIL(ss);
}
return status.getValue().release();
}
/**
* Helper function which parses and normalizes 'queryStr', and returns whether the given
* (expression tree, query request) tuple passes CanonicalQuery::isValid().
* Returns Status::OK() if the tuple is valid, else returns an error Status.
*/
Status isValid(const std::string& queryStr, const QueryRequest& qrRaw) {
BSONObj queryObj = fromjson(queryStr);
std::unique_ptr<MatchExpression> me(parseMatchExpression(queryObj));
me = MatchExpression::optimize(std::move(me));
return CanonicalQuery::isValid(me.get(), qrRaw).getStatus();
}
TEST(ExpressionOptimizeTest, IsValidText) {
// Filter inside QueryRequest is not used.
auto qr = std::make_unique<QueryRequest>(nss);
ASSERT_OK(qr->validate());
// Valid: regular TEXT.
ASSERT_OK(isValid("{$text: {$search: 's'}}", *qr));
// Valid: TEXT inside OR.
ASSERT_OK(
isValid("{$or: ["
" {$text: {$search: 's'}},"
" {a: 1}"
"]}",
*qr));
// Valid: TEXT outside NOR.
ASSERT_OK(isValid("{$text: {$search: 's'}, $nor: [{a: 1}, {b: 1}]}", *qr));
// Invalid: TEXT inside NOR.
ASSERT_NOT_OK(isValid("{$nor: [{$text: {$search: 's'}}, {a: 1}]}", *qr));
// Invalid: TEXT inside NOR.
ASSERT_NOT_OK(
isValid("{$nor: ["
" {$or: ["
" {$text: {$search: 's'}},"
" {a: 1}"
" ]},"
" {a: 2}"
"]}",
*qr));
// Invalid: >1 TEXT.
ASSERT_NOT_OK(
isValid("{$and: ["
" {$text: {$search: 's'}},"
" {$text: {$search: 't'}}"
"]}",
*qr));
// Invalid: >1 TEXT.
ASSERT_NOT_OK(
isValid("{$and: ["
" {$or: ["
" {$text: {$search: 's'}},"
" {a: 1}"
" ]},"
" {$or: ["
" {$text: {$search: 't'}},"
" {b: 1}"
" ]}"
"]}",
*qr));
}
TEST(ExpressionOptimizeTest, IsValidTextTailable) {
// Filter inside QueryRequest is not used.
auto qr = std::make_unique<QueryRequest>(nss);
qr->setTailableMode(TailableModeEnum::kTailable);
ASSERT_OK(qr->validate());
// Invalid: TEXT and tailable.
ASSERT_NOT_OK(isValid("{$text: {$search: 's'}}", *qr));
}
TEST(ExpressionOptimizeTest, IsValidGeo) {
// Filter inside QueryRequest is not used.
auto qr = std::make_unique<QueryRequest>(nss);
ASSERT_OK(qr->validate());
// Valid: regular GEO_NEAR.
ASSERT_OK(isValid("{a: {$near: [0, 0]}}", *qr));
// Valid: GEO_NEAR inside nested AND.
ASSERT_OK(
isValid("{$and: ["
" {$and: ["
" {a: {$near: [0, 0]}},"
" {b: 1}"
" ]},"
" {c: 1}"
"]}",
*qr));
// Invalid: >1 GEO_NEAR.
ASSERT_NOT_OK(
isValid("{$and: ["
" {a: {$near: [0, 0]}},"
" {b: {$near: [0, 0]}}"
"]}",
*qr));
// Invalid: >1 GEO_NEAR.
ASSERT_NOT_OK(
isValid("{$and: ["
" {a: {$geoNear: [0, 0]}},"
" {b: {$near: [0, 0]}}"
"]}",
*qr));
// Invalid: >1 GEO_NEAR.
ASSERT_NOT_OK(
isValid("{$and: ["
" {$and: ["
" {a: {$near: [0, 0]}},"
" {b: 1}"
" ]},"
" {$and: ["
" {c: {$near: [0, 0]}},"
" {d: 1}"
" ]}"
"]}",
*qr));
// Invalid: GEO_NEAR inside NOR.
ASSERT_NOT_OK(
isValid("{$nor: ["
" {a: {$near: [0, 0]}},"
" {b: 1}"
"]}",
*qr));
// Invalid: GEO_NEAR inside OR.
ASSERT_NOT_OK(
isValid("{$or: ["
" {a: {$near: [0, 0]}},"
" {b: 1}"
"]}",
*qr));
}
TEST(ExpressionOptimizeTest, IsValidTextAndGeo) {
// Filter inside QueryRequest is not used.
auto qr = std::make_unique<QueryRequest>(nss);
ASSERT_OK(qr->validate());
// Invalid: TEXT and GEO_NEAR.
ASSERT_NOT_OK(isValid("{$text: {$search: 's'}, a: {$near: [0, 0]}}", *qr));
// Invalid: TEXT and GEO_NEAR.
ASSERT_NOT_OK(isValid("{$text: {$search: 's'}, a: {$geoNear: [0, 0]}}", *qr));
// Invalid: TEXT and GEO_NEAR.
ASSERT_NOT_OK(
isValid("{$or: ["
" {$text: {$search: 's'}},"
" {a: 1}"
" ],"
" b: {$near: [0, 0]}}",
*qr));
}
TEST(ExpressionOptimizeTest, IsValidTextAndNaturalAscending) {
// Filter inside QueryRequest is not used.
auto qr = std::make_unique<QueryRequest>(nss);
qr->setSort(fromjson("{$natural: 1}"));
ASSERT_OK(qr->validate());
// Invalid: TEXT and {$natural: 1} sort order.
ASSERT_NOT_OK(isValid("{$text: {$search: 's'}}", *qr));
}
TEST(ExpressionOptimizeTest, IsValidTextAndNaturalDescending) {
// Filter inside QueryRequest is not used.
auto qr = std::make_unique<QueryRequest>(nss);
qr->setSort(fromjson("{$natural: -1}"));
ASSERT_OK(qr->validate());
// Invalid: TEXT and {$natural: -1} sort order.
ASSERT_NOT_OK(isValid("{$text: {$search: 's'}}", *qr));
}
TEST(ExpressionOptimizeTest, IsValidTextAndHint) {
// Filter inside QueryRequest is not used.
auto qr = std::make_unique<QueryRequest>(nss);
qr->setHint(fromjson("{a: 1}"));
ASSERT_OK(qr->validate());
// Invalid: TEXT and {$natural: -1} sort order.
ASSERT_NOT_OK(isValid("{$text: {$search: 's'}}", *qr));
}
// SERVER-14366
TEST(ExpressionOptimizeTest, IsValidGeoNearNaturalSort) {
// Filter inside QueryRequest is not used.
auto qr = std::make_unique<QueryRequest>(nss);
qr->setSort(fromjson("{$natural: 1}"));
ASSERT_OK(qr->validate());
// Invalid: GEO_NEAR and {$natural: 1} sort order.
ASSERT_NOT_OK(isValid("{a: {$near: {$geometry: {type: 'Point', coordinates: [0, 0]}}}}", *qr));
}
// SERVER-14366
TEST(ExpressionOptimizeTest, IsValidGeoNearNaturalHint) {
// Filter inside QueryRequest is not used.
auto qr = std::make_unique<QueryRequest>(nss);
qr->setHint(fromjson("{$natural: 1}"));
ASSERT_OK(qr->validate());
// Invalid: GEO_NEAR and {$natural: 1} hint.
ASSERT_NOT_OK(isValid("{a: {$near: {$geometry: {type: 'Point', coordinates: [0, 0]}}}}", *qr));
}
TEST(ExpressionOptimizeTest, IsValidNaturalSortIndexHint) {
const bool isExplain = false;
auto qr = assertGet(QueryRequest::makeFromFindCommand(
nss, fromjson("{find: 'testcoll', sort: {$natural: 1}, hint: {a: 1}}"), isExplain));
// Invalid: {$natural: 1} sort order and index hint.
ASSERT_NOT_OK(isValid("{}", *qr));
}
TEST(ExpressionOptimizeTest, IsValidNaturalSortNaturalHint) {
const bool isExplain = false;
auto qr = assertGet(QueryRequest::makeFromFindCommand(
nss, fromjson("{find: 'testcoll', sort: {$natural: 1}, hint: {$natural: 1}}"), isExplain));
// Valid: {$natural: 1} sort order and {$natural: 1} hint.
ASSERT_OK(isValid("{}", *qr));
}
TEST(ExpressionOptimizeTest, IsValidNaturalSortNaturalHintDifferentDirections) {
const bool isExplain = false;
auto qr = assertGet(QueryRequest::makeFromFindCommand(
nss, fromjson("{find: 'testcoll', sort: {$natural: 1}, hint: {$natural: -1}}"), isExplain));
// Invalid: {$natural: 1} sort order and {$natural: -1} hint.
ASSERT_NOT_OK(isValid("{}", *qr));
}
TEST(ExpressionOptimizeTest, NormalizeWithInPreservesTags) {
BSONObj obj = fromjson("{x: {$in: [1]}}");
std::unique_ptr<MatchExpression> matchExpression(parseMatchExpression(obj));
matchExpression->setTag(new IndexTag(2U, 1U, false));
matchExpression = MatchExpression::optimize(std::move(matchExpression));
IndexTag* tag = dynamic_cast<IndexTag*>(matchExpression->getTag());
ASSERT(tag);
ASSERT_EQ(2U, tag->index);
}
TEST(ExpressionOptimizeTest, NormalizeWithInAndRegexPreservesTags) {
BSONObj obj = fromjson("{x: {$in: [/a.b/]}}");
std::unique_ptr<MatchExpression> matchExpression(parseMatchExpression(obj));
matchExpression->setTag(new IndexTag(2U, 1U, false));
matchExpression = MatchExpression::optimize(std::move(matchExpression));
IndexTag* tag = dynamic_cast<IndexTag*>(matchExpression->getTag());
ASSERT(tag);
ASSERT_EQ(2U, tag->index);
}
TEST(ExpressionOptimizeTest, NormalizeWithInPreservesCollator) {
CollatorInterfaceMock collator(CollatorInterfaceMock::MockType::kReverseString);
BSONObj obj = fromjson("{'': 'string'}");
auto inMatchExpression = std::make_unique<InMatchExpression>("");
inMatchExpression->setCollator(&collator);
std::vector<BSONElement> equalities{obj.firstElement()};
ASSERT_OK(inMatchExpression->setEqualities(std::move(equalities)));
auto matchExpression = MatchExpression::optimize(std::move(inMatchExpression));
ASSERT(matchExpression->matchType() == MatchExpression::MatchType::EQ);
EqualityMatchExpression* eqMatchExpression =
static_cast<EqualityMatchExpression*>(matchExpression.get());
ASSERT_EQ(eqMatchExpression->getCollator(), &collator);
}
TEST(ExpressionOptimizeTest, AndWithAlwaysFalseChildOptimizesToAlwaysFalse) {
BSONObj obj = fromjson("{$and: [{a: 1}, {$alwaysFalse: 1}]}");
std::unique_ptr<MatchExpression> matchExpression(parseMatchExpression(obj));
auto optimizedMatchExpression = MatchExpression::optimize(std::move(matchExpression));
BSONObjBuilder bob;
optimizedMatchExpression->serialize(&bob, true);
ASSERT_BSONOBJ_EQ(bob.obj(), fromjson("{$alwaysFalse: 1}"));
}
TEST(ExpressionOptimizeTest, AndRemovesAlwaysTrueChildren) {
BSONObj obj = fromjson("{$and: [{a: 1}, {$alwaysTrue: 1}]}");
std::unique_ptr<MatchExpression> matchExpression(parseMatchExpression(obj));
auto optimizedMatchExpression = MatchExpression::optimize(std::move(matchExpression));
BSONObjBuilder bob;
optimizedMatchExpression->serialize(&bob, true);
ASSERT_BSONOBJ_EQ(bob.obj(), fromjson("{a: {$eq: 1}}"));
}
TEST(ExpressionOptimizeTest, AndWithSingleChildAlwaysTrueOptimizesToEmptyAnd) {
BSONObj obj = fromjson("{$and: [{$alwaysTrue: 1}]}");
std::unique_ptr<MatchExpression> matchExpression(parseMatchExpression(obj));
auto optimizedMatchExpression = MatchExpression::optimize(std::move(matchExpression));
// TODO SERVER-34759 We want this to optimize to an AlwaysTrueMatchExpression.
ASSERT_TRUE(dynamic_cast<AndMatchExpression*>(optimizedMatchExpression.get()));
BSONObjBuilder bob;
optimizedMatchExpression->serialize(&bob, true);
ASSERT_BSONOBJ_EQ(bob.obj(), fromjson("{}"));
}
TEST(ExpressionOptimizeTest, AndWithEachChildAlwaysTrueOptimizesToEmptyAnd) {
BSONObj obj = fromjson("{$and: [{$alwaysTrue: 1}, {$alwaysTrue: 1}]}");
std::unique_ptr<MatchExpression> matchExpression(parseMatchExpression(obj));
auto optimizedMatchExpression = MatchExpression::optimize(std::move(matchExpression));
// TODO SERVER-34759 We want this to optimize to an AlwaysTrueMatchExpression.
ASSERT_TRUE(dynamic_cast<AndMatchExpression*>(optimizedMatchExpression.get()));
BSONObjBuilder bob;
optimizedMatchExpression->serialize(&bob, true);
ASSERT_BSONOBJ_EQ(bob.obj(), fromjson("{}"));
}
TEST(ExpressionOptimizeTest, NestedAndWithAlwaysFalseOptimizesToAlwaysFalse) {
BSONObj obj = fromjson("{$and: [{$and: [{$alwaysFalse: 1}, {a: 1}]}, {b: 1}]}");
std::unique_ptr<MatchExpression> matchExpression(parseMatchExpression(obj));
auto optimizedMatchExpression = MatchExpression::optimize(std::move(matchExpression));
BSONObjBuilder bob;
optimizedMatchExpression->serialize(&bob, true);
ASSERT_BSONOBJ_EQ(bob.obj(), fromjson("{$alwaysFalse: 1}"));
}
TEST(ExpressionOptimizeTest, OrWithAlwaysTrueOptimizesToAlwaysTrue) {
BSONObj obj = fromjson("{$or: [{a: 1}, {$alwaysTrue: 1}]}");
std::unique_ptr<MatchExpression> matchExpression(parseMatchExpression(obj));
auto optimizedMatchExpression = MatchExpression::optimize(std::move(matchExpression));
BSONObjBuilder bob;
optimizedMatchExpression->serialize(&bob, true);
ASSERT_BSONOBJ_EQ(bob.obj(), fromjson("{$alwaysTrue: 1}"));
}
TEST(ExpressionOptimizeTest, OrRemovesAlwaysFalseChildren) {
BSONObj obj = fromjson("{$or: [{a: 1}, {$alwaysFalse: 1}]}");
std::unique_ptr<MatchExpression> matchExpression(parseMatchExpression(obj));
auto optimizedMatchExpression = MatchExpression::optimize(std::move(matchExpression));
BSONObjBuilder bob;
optimizedMatchExpression->serialize(&bob, true);
ASSERT_BSONOBJ_EQ(bob.obj(), fromjson("{a: {$eq: 1}}"));
}
TEST(ExpressionOptimizeTest, OrPromotesSingleAlwaysFalseAfterOptimize) {
// The nested predicate is always false. This test is designed to reproduce SERVER-34714.
BSONObj obj = fromjson("{$or: [{a: {$all: []}}]}");
std::unique_ptr<MatchExpression> matchExpression(parseMatchExpression(obj));
auto optimizedMatchExpression = MatchExpression::optimize(std::move(matchExpression));
ASSERT_TRUE(dynamic_cast<AlwaysFalseMatchExpression*>(optimizedMatchExpression.get()));
BSONObjBuilder bob;
optimizedMatchExpression->serialize(&bob, true);
ASSERT_BSONOBJ_EQ(bob.obj(), fromjson("{$alwaysFalse: 1}"));
}
TEST(ExpressionOptimizeTest, OrPromotesSingleAlwaysFalse) {
BSONObj obj = fromjson("{$or: [{$alwaysFalse: 1}]}");
std::unique_ptr<MatchExpression> matchExpression(parseMatchExpression(obj));
auto optimizedMatchExpression = MatchExpression::optimize(std::move(matchExpression));
ASSERT_TRUE(dynamic_cast<AlwaysFalseMatchExpression*>(optimizedMatchExpression.get()));
BSONObjBuilder bob;
optimizedMatchExpression->serialize(&bob, true);
ASSERT_BSONOBJ_EQ(bob.obj(), fromjson("{$alwaysFalse: 1}"));
}
TEST(ExpressionOptimizeTest, OrPromotesMultipleAlwaysFalse) {
BSONObj obj = fromjson("{$or: [{$alwaysFalse: 1}, {a: {$all: []}}]}");
std::unique_ptr<MatchExpression> matchExpression(parseMatchExpression(obj));
auto optimizedMatchExpression = MatchExpression::optimize(std::move(matchExpression));
ASSERT_TRUE(dynamic_cast<AlwaysFalseMatchExpression*>(optimizedMatchExpression.get()));
BSONObjBuilder bob;
optimizedMatchExpression->serialize(&bob, true);
ASSERT_BSONOBJ_EQ(bob.obj(), fromjson("{$alwaysFalse: 1}"));
}
TEST(ExpressionOptimizeTest, NestedOrWithAlwaysTrueOptimizesToAlwaysTrue) {
BSONObj obj = fromjson("{$or: [{$or: [{$alwaysTrue: 1}, {a: 1}]}, {b: 1}]}");
std::unique_ptr<MatchExpression> matchExpression(parseMatchExpression(obj));
auto optimizedMatchExpression = MatchExpression::optimize(std::move(matchExpression));
BSONObjBuilder bob;
optimizedMatchExpression->serialize(&bob, true);
ASSERT_BSONOBJ_EQ(bob.obj(), fromjson("{$alwaysTrue: 1}"));
}
} // namespace
} // namespace mongo
|