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
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
|
/**
* 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.
*/
/**
* This file contains tests for mongo/db/query/plan_cache.h
*/
#include "mongo/db/query/plan_cache.h"
#include <algorithm>
#include <memory>
#include <ostream>
#include "mongo/db/index/wildcard_key_generator.h"
#include "mongo/db/jsobj.h"
#include "mongo/db/json.h"
#include "mongo/db/matcher/extensions_callback_noop.h"
#include "mongo/db/pipeline/expression_context_for_test.h"
#include "mongo/db/query/canonical_query_encoder.h"
#include "mongo/db/query/collation/collator_interface_mock.h"
#include "mongo/db/query/plan_ranker.h"
#include "mongo/db/query/query_knobs_gen.h"
#include "mongo/db/query/query_planner.h"
#include "mongo/db/query/query_planner_test_lib.h"
#include "mongo/db/query/query_solution.h"
#include "mongo/db/query/query_test_service_context.h"
#include "mongo/unittest/unittest.h"
#include "mongo/util/assert_util.h"
#include "mongo/util/scopeguard.h"
#include "mongo/util/transitional_tools_do_not_use/vector_spooling.h"
using namespace mongo;
using unittest::assertGet;
namespace {
using std::string;
using std::unique_ptr;
using std::vector;
static const NamespaceString nss("test.collection");
/**
* Utility functions to create a CanonicalQuery
*/
unique_ptr<CanonicalQuery> canonicalize(const BSONObj& queryObj) {
QueryTestServiceContext serviceContext;
auto opCtx = serviceContext.makeOperationContext();
auto qr = std::make_unique<QueryRequest>(nss);
qr->setFilter(queryObj);
const boost::intrusive_ptr<ExpressionContext> expCtx;
auto statusWithCQ =
CanonicalQuery::canonicalize(opCtx.get(),
std::move(qr),
expCtx,
ExtensionsCallbackNoop(),
MatchExpressionParser::kAllowAllSpecialFeatures);
ASSERT_OK(statusWithCQ.getStatus());
return std::move(statusWithCQ.getValue());
}
unique_ptr<CanonicalQuery> canonicalize(StringData queryStr) {
BSONObj queryObj = fromjson(queryStr.toString());
return canonicalize(queryObj);
}
unique_ptr<CanonicalQuery> canonicalize(BSONObj query,
BSONObj sort,
BSONObj proj,
BSONObj collation) {
QueryTestServiceContext serviceContext;
auto opCtx = serviceContext.makeOperationContext();
auto qr = std::make_unique<QueryRequest>(nss);
qr->setFilter(query);
qr->setSort(sort);
qr->setProj(proj);
qr->setCollation(collation);
const boost::intrusive_ptr<ExpressionContext> expCtx;
auto statusWithCQ =
CanonicalQuery::canonicalize(opCtx.get(),
std::move(qr),
expCtx,
ExtensionsCallbackNoop(),
MatchExpressionParser::kAllowAllSpecialFeatures);
ASSERT_OK(statusWithCQ.getStatus());
return std::move(statusWithCQ.getValue());
}
unique_ptr<CanonicalQuery> canonicalize(const char* queryStr,
const char* sortStr,
const char* projStr,
const char* collationStr) {
return canonicalize(
fromjson(queryStr), fromjson(sortStr), fromjson(projStr), fromjson(collationStr));
}
unique_ptr<CanonicalQuery> canonicalize(const char* queryStr,
const char* sortStr,
const char* projStr,
long long skip,
long long limit,
const char* hintStr,
const char* minStr,
const char* maxStr) {
QueryTestServiceContext serviceContext;
auto opCtx = serviceContext.makeOperationContext();
auto qr = std::make_unique<QueryRequest>(nss);
qr->setFilter(fromjson(queryStr));
qr->setSort(fromjson(sortStr));
qr->setProj(fromjson(projStr));
if (skip) {
qr->setSkip(skip);
}
if (limit) {
qr->setLimit(limit);
}
qr->setHint(fromjson(hintStr));
qr->setMin(fromjson(minStr));
qr->setMax(fromjson(maxStr));
const boost::intrusive_ptr<ExpressionContext> expCtx;
auto statusWithCQ =
CanonicalQuery::canonicalize(opCtx.get(),
std::move(qr),
expCtx,
ExtensionsCallbackNoop(),
MatchExpressionParser::kAllowAllSpecialFeatures);
ASSERT_OK(statusWithCQ.getStatus());
return std::move(statusWithCQ.getValue());
}
unique_ptr<CanonicalQuery> canonicalize(const char* queryStr,
const char* sortStr,
const char* projStr,
long long skip,
long long limit,
const char* hintStr,
const char* minStr,
const char* maxStr,
bool explain) {
QueryTestServiceContext serviceContext;
auto opCtx = serviceContext.makeOperationContext();
auto qr = std::make_unique<QueryRequest>(nss);
qr->setFilter(fromjson(queryStr));
qr->setSort(fromjson(sortStr));
qr->setProj(fromjson(projStr));
if (skip) {
qr->setSkip(skip);
}
if (limit) {
qr->setLimit(limit);
}
qr->setHint(fromjson(hintStr));
qr->setMin(fromjson(minStr));
qr->setMax(fromjson(maxStr));
qr->setExplain(explain);
const boost::intrusive_ptr<ExpressionContext> expCtx;
auto statusWithCQ =
CanonicalQuery::canonicalize(opCtx.get(),
std::move(qr),
expCtx,
ExtensionsCallbackNoop(),
MatchExpressionParser::kAllowAllSpecialFeatures);
ASSERT_OK(statusWithCQ.getStatus());
return std::move(statusWithCQ.getValue());
}
/**
* Check that the stable keys of 'a' and 'b' are equal, but the unstable parts are not.
*/
void assertPlanCacheKeysUnequalDueToDiscriminators(const PlanCacheKey& a, const PlanCacheKey& b) {
ASSERT_EQ(a.getStableKeyStringData(), b.getStableKeyStringData());
ASSERT_EQ(a.getUnstablePart().size(), b.getUnstablePart().size());
// Should always have the begin and end delimiters.
ASSERT_NE(a.getUnstablePart(), b.getUnstablePart());
ASSERT_GTE(a.getUnstablePart().size(), 2u);
}
/**
* Utility function to create MatchExpression
*/
unique_ptr<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 std::move(status.getValue());
}
void assertEquivalent(const char* queryStr,
const MatchExpression* expected,
const MatchExpression* actual) {
if (actual->equivalent(expected)) {
return;
}
str::stream ss;
ss << "Match expressions are not equivalent."
<< "\nOriginal query: " << queryStr << "\nExpected: " << expected->debugString()
<< "\nActual: " << actual->debugString();
FAIL(ss);
}
// Helper which constructs a $** IndexEntry and returns it along with an owned ProjectionExecutor.
// The latter simulates the ProjectionExecutor which, during normal operation, is owned and
// maintained by the $** index's IndexAccessMethod, and is required because the plan cache will
// obtain unowned pointers to it.
std::pair<IndexEntry, std::unique_ptr<WildcardProjection>> makeWildcardEntry(BSONObj keyPattern) {
auto wcProj = std::make_unique<WildcardProjection>(
WildcardKeyGenerator::createProjectionExecutor(keyPattern, {}));
return {IndexEntry(keyPattern,
IndexNames::nameToType(IndexNames::findPluginName(keyPattern)),
IndexDescriptor::kLatestIndexVersion,
false, // multikey
{},
{},
false, // sparse
false, // unique
IndexEntry::Identifier{"indexName"},
nullptr,
BSONObj(),
nullptr,
wcProj.get()),
std::move(wcProj)};
}
// A version of the above for CoreIndexInfo, used for plan cache update tests.
std::pair<CoreIndexInfo, std::unique_ptr<WildcardProjection>> makeWildcardUpdate(
BSONObj keyPattern) {
auto wcProj = std::make_unique<WildcardProjection>(
WildcardKeyGenerator::createProjectionExecutor(keyPattern, {}));
return {CoreIndexInfo(keyPattern,
IndexNames::nameToType(IndexNames::findPluginName(keyPattern)),
false, // sparse
IndexEntry::Identifier{"indexName"}, // name
nullptr, // filterExpr
nullptr, // collation
wcProj.get()), // wildcard
std::move(wcProj)};
}
//
// Tests for CachedSolution
//
/**
* Generator for vector of QuerySolution shared pointers.
*/
struct GenerateQuerySolution {
QuerySolution* operator()() const {
unique_ptr<QuerySolution> qs(new QuerySolution());
qs->cacheData.reset(new SolutionCacheData());
qs->cacheData->solnType = SolutionCacheData::COLLSCAN_SOLN;
qs->cacheData->tree.reset(new PlanCacheIndexTree());
return qs.release();
}
};
/**
* Utility function to create a PlanRankingDecision
*/
std::unique_ptr<plan_ranker::PlanRankingDecision> createDecision(size_t numPlans,
size_t works = 0) {
auto why = std::make_unique<plan_ranker::PlanRankingDecision>();
std::vector<std::unique_ptr<PlanStageStats>> stats;
for (size_t i = 0; i < numPlans; ++i) {
CommonStats common("COLLSCAN");
auto stat = std::make_unique<PlanStageStats>(common, STAGE_COLLSCAN);
stat->specific.reset(new CollectionScanStats());
stat->common.works = works;
stats.push_back(std::move(stat));
why->scores.push_back(0U);
why->candidateOrder.push_back(i);
}
why->getStats<PlanStageStats>() = std::move(stats);
return why;
}
/**
* Test functions for shouldCacheQuery
* Use these functions to assert which categories
* of canonicalized queries are suitable for inclusion
* in the planner cache.
*/
void assertShouldCacheQuery(const CanonicalQuery& query) {
if (PlanCache::shouldCacheQuery(query)) {
return;
}
str::stream ss;
ss << "Canonical query should be cacheable: " << query.toString();
FAIL(ss);
}
void assertShouldNotCacheQuery(const CanonicalQuery& query) {
if (!PlanCache::shouldCacheQuery(query)) {
return;
}
str::stream ss;
ss << "Canonical query should not be cacheable: " << query.toString();
FAIL(ss);
}
void assertShouldNotCacheQuery(const BSONObj& query) {
unique_ptr<CanonicalQuery> cq(canonicalize(query));
assertShouldNotCacheQuery(*cq);
}
void assertShouldNotCacheQuery(const char* queryStr) {
unique_ptr<CanonicalQuery> cq(canonicalize(queryStr));
assertShouldNotCacheQuery(*cq);
}
std::unique_ptr<QuerySolution> getQuerySolutionForCaching() {
std::unique_ptr<QuerySolution> qs = std::make_unique<QuerySolution>();
qs->cacheData = std::make_unique<SolutionCacheData>();
qs->cacheData->tree = std::make_unique<PlanCacheIndexTree>();
return qs;
}
/**
* Cacheable queries
* These queries will be added to the cache with run-time statistics
* and can be managed with the cache DB commands.
*/
TEST(PlanCacheTest, ShouldCacheQueryBasic) {
unique_ptr<CanonicalQuery> cq(canonicalize("{a: 1}"));
assertShouldCacheQuery(*cq);
}
TEST(PlanCacheTest, ShouldCacheQuerySort) {
unique_ptr<CanonicalQuery> cq(canonicalize("{}", "{a: -1}", "{_id: 0, a: 1}", "{}"));
assertShouldCacheQuery(*cq);
}
/*
* Non-cacheable queries.
* These queries will be sent through the planning process everytime.
*/
/**
* Collection scan
* This should normally be handled by the IDHack runner.
*/
TEST(PlanCacheTest, ShouldNotCacheQueryCollectionScan) {
unique_ptr<CanonicalQuery> cq(canonicalize("{}"));
assertShouldNotCacheQuery(*cq);
}
/**
* Hint
* A hinted query implies strong user preference for a particular index.
* Therefore, not much point in caching.
*/
TEST(PlanCacheTest, ShouldNotCacheQueryWithHint) {
unique_ptr<CanonicalQuery> cq(
canonicalize("{a: 1}", "{}", "{}", 0, 0, "{a: 1, b: 1}", "{}", "{}"));
assertShouldNotCacheQuery(*cq);
}
/**
* Min queries are a specialized case of hinted queries
*/
TEST(PlanCacheTest, ShouldNotCacheQueryWithMin) {
unique_ptr<CanonicalQuery> cq(
canonicalize("{a: 1}", "{}", "{}", 0, 0, "{a: 1}", "{a: 100}", "{}"));
assertShouldNotCacheQuery(*cq);
}
/**
* Max queries are non-cacheable for the same reasons as min queries.
*/
TEST(PlanCacheTest, ShouldNotCacheQueryWithMax) {
unique_ptr<CanonicalQuery> cq(
canonicalize("{a: 1}", "{}", "{}", 0, 0, "{a: 1}", "{}", "{a: 100}"));
assertShouldNotCacheQuery(*cq);
}
/**
* $geoWithin queries with legacy coordinates are cacheable as long as
* the planner is able to come up with a cacheable solution.
*/
TEST(PlanCacheTest, ShouldCacheQueryWithGeoWithinLegacyCoordinates) {
unique_ptr<CanonicalQuery> cq(
canonicalize("{a: {$geoWithin: "
"{$box: [[-180, -90], [180, 90]]}}}"));
assertShouldCacheQuery(*cq);
}
/**
* $geoWithin queries with GeoJSON coordinates are supported by the index bounds builder.
*/
TEST(PlanCacheTest, ShouldCacheQueryWithGeoWithinJSONCoordinates) {
unique_ptr<CanonicalQuery> cq(
canonicalize("{a: {$geoWithin: "
"{$geometry: {type: 'Polygon', coordinates: "
"[[[0, 0], [0, 90], [90, 0], [0, 0]]]}}}}"));
assertShouldCacheQuery(*cq);
}
/**
* $geoWithin queries with both legacy and GeoJSON coordinates are cacheable.
*/
TEST(PlanCacheTest, ShouldCacheQueryWithGeoWithinLegacyAndJSONCoordinates) {
unique_ptr<CanonicalQuery> cq(
canonicalize("{$or: [{a: {$geoWithin: {$geometry: {type: 'Polygon', "
"coordinates: [[[0, 0], [0, 90], "
"[90, 0], [0, 0]]]}}}},"
"{a: {$geoWithin: {$box: [[-180, -90], [180, 90]]}}}]}"));
assertShouldCacheQuery(*cq);
}
/**
* $geoIntersects queries are always cacheable because they support GeoJSON coordinates only.
*/
TEST(PlanCacheTest, ShouldCacheQueryWithGeoIntersects) {
unique_ptr<CanonicalQuery> cq(
canonicalize("{a: {$geoIntersects: "
"{$geometry: {type: 'Point', coordinates: "
"[10.0, 10.0]}}}}"));
assertShouldCacheQuery(*cq);
}
/**
* $geoNear queries are cacheable because we are able to distinguish
* between flat and spherical queries.
*/
TEST(PlanCacheTest, ShouldNotCacheQueryWithGeoNear) {
unique_ptr<CanonicalQuery> cq(
canonicalize("{a: {$geoNear: {$geometry: {type: 'Point',"
"coordinates: [0,0]}, $maxDistance:100}}}"));
assertShouldCacheQuery(*cq);
}
/**
* Explain queries are not-cacheable because of allPlans cannot
* be accurately generated from stale cached stats in the plan cache for
* non-winning plans.
*/
TEST(PlanCacheTest, ShouldNotCacheQueryExplain) {
unique_ptr<CanonicalQuery> cq(canonicalize("{a: 1}",
"{}",
"{}",
0,
0,
"{}",
"{}",
"{}", // min, max
true // explain
));
const QueryRequest& qr = cq->getQueryRequest();
ASSERT_TRUE(qr.isExplain());
assertShouldNotCacheQuery(*cq);
}
// Adding an empty vector of query solutions should fail.
TEST(PlanCacheTest, AddEmptySolutions) {
PlanCache planCache;
unique_ptr<CanonicalQuery> cq(canonicalize("{a: 1}"));
std::vector<QuerySolution*> solns;
unique_ptr<plan_ranker::PlanRankingDecision> decision(createDecision(1U));
QueryTestServiceContext serviceContext;
ASSERT_NOT_OK(planCache.set(*cq, solns, std::move(decision), Date_t{}));
}
void addCacheEntryForShape(const CanonicalQuery& cq, PlanCache* planCache) {
invariant(planCache);
auto qs = getQuerySolutionForCaching();
std::vector<QuerySolution*> solns = {qs.get()};
ASSERT_OK(planCache->set(cq, solns, createDecision(1U), Date_t{}));
}
TEST(PlanCacheTest, InactiveEntriesDisabled) {
// Set the global flag for disabling active entries.
internalQueryCacheDisableInactiveEntries.store(true);
ON_BLOCK_EXIT([] { internalQueryCacheDisableInactiveEntries.store(false); });
PlanCache planCache;
unique_ptr<CanonicalQuery> cq(canonicalize("{a: 1}"));
auto qs = getQuerySolutionForCaching();
std::vector<QuerySolution*> solns = {qs.get()};
ASSERT_EQ(planCache.get(*cq).state, PlanCache::CacheEntryState::kNotPresent);
QueryTestServiceContext serviceContext;
ASSERT_OK(planCache.set(*cq, solns, createDecision(1U), Date_t{}));
// After add, the planCache should have an _active_ entry.
ASSERT_EQ(planCache.get(*cq).state, PlanCache::CacheEntryState::kPresentActive);
// Call deactivate(). It should be a noop.
planCache.deactivate(*cq);
// The entry should still be active.
ASSERT_EQ(planCache.get(*cq).state, PlanCache::CacheEntryState::kPresentActive);
// remove() the entry.
ASSERT_OK(planCache.remove(*cq));
ASSERT_EQ(planCache.size(), 0U);
ASSERT_EQ(planCache.get(*cq).state, PlanCache::CacheEntryState::kNotPresent);
}
TEST(PlanCacheTest, PlanCacheLRUPolicyRemovesInactiveEntries) {
// Use a tiny cache size.
const size_t kCacheSize = 2;
PlanCache planCache(kCacheSize);
QueryTestServiceContext serviceContext;
unique_ptr<CanonicalQuery> cqA(canonicalize("{a: 1}"));
ASSERT_EQ(planCache.get(*cqA).state, PlanCache::CacheEntryState::kNotPresent);
addCacheEntryForShape(*cqA.get(), &planCache);
// After add, the planCache should have an inactive entry.
ASSERT_EQ(planCache.get(*cqA).state, PlanCache::CacheEntryState::kPresentInactive);
// Add a cache entry for another shape.
unique_ptr<CanonicalQuery> cqB(canonicalize("{b: 1}"));
ASSERT_EQ(planCache.get(*cqB).state, PlanCache::CacheEntryState::kNotPresent);
addCacheEntryForShape(*cqB.get(), &planCache);
ASSERT_EQ(planCache.get(*cqB).state, PlanCache::CacheEntryState::kPresentInactive);
// Access the cached solution for the {a: 1} shape. Now the entry for {b: 1} will be the least
// recently used.
ASSERT_EQ(planCache.get(*cqA).state, PlanCache::CacheEntryState::kPresentInactive);
// Insert another entry. Since the cache size is 2, we expect the {b: 1} entry to be ejected.
unique_ptr<CanonicalQuery> cqC(canonicalize("{c: 1}"));
ASSERT_EQ(planCache.get(*cqC).state, PlanCache::CacheEntryState::kNotPresent);
addCacheEntryForShape(*cqC.get(), &planCache);
// Check that {b: 1} is gone, but {a: 1} and {c: 1} both still have entries.
ASSERT_EQ(planCache.get(*cqB).state, PlanCache::CacheEntryState::kNotPresent);
ASSERT_EQ(planCache.get(*cqA).state, PlanCache::CacheEntryState::kPresentInactive);
ASSERT_EQ(planCache.get(*cqC).state, PlanCache::CacheEntryState::kPresentInactive);
}
TEST(PlanCacheTest, PlanCacheRemoveDeletesInactiveEntries) {
PlanCache planCache;
unique_ptr<CanonicalQuery> cq(canonicalize("{a: 1}"));
auto qs = getQuerySolutionForCaching();
std::vector<QuerySolution*> solns = {qs.get()};
ASSERT_EQ(planCache.get(*cq).state, PlanCache::CacheEntryState::kNotPresent);
QueryTestServiceContext serviceContext;
ASSERT_OK(planCache.set(*cq, solns, createDecision(1U), Date_t{}));
// After add, the planCache should have an inactive entry.
ASSERT_EQ(planCache.get(*cq).state, PlanCache::CacheEntryState::kPresentInactive);
// remove() the entry.
ASSERT_OK(planCache.remove(*cq));
ASSERT_EQ(planCache.size(), 0U);
ASSERT_EQ(planCache.get(*cq).state, PlanCache::CacheEntryState::kNotPresent);
}
TEST(PlanCacheTest, PlanCacheFlushDeletesInactiveEntries) {
PlanCache planCache;
unique_ptr<CanonicalQuery> cq(canonicalize("{a: 1}"));
auto qs = getQuerySolutionForCaching();
std::vector<QuerySolution*> solns = {qs.get()};
ASSERT_EQ(planCache.get(*cq).state, PlanCache::CacheEntryState::kNotPresent);
QueryTestServiceContext serviceContext;
ASSERT_OK(planCache.set(*cq, solns, createDecision(1U), Date_t{}));
// After add, the planCache should have an inactive entry.
ASSERT_EQ(planCache.get(*cq).state, PlanCache::CacheEntryState::kPresentInactive);
// Clear the plan cache. The inactive entry should now be removed.
planCache.clear();
ASSERT_EQ(planCache.size(), 0U);
ASSERT_EQ(planCache.get(*cq).state, PlanCache::CacheEntryState::kNotPresent);
}
TEST(PlanCacheTest, AddActiveCacheEntry) {
PlanCache planCache;
unique_ptr<CanonicalQuery> cq(canonicalize("{a: 1}"));
auto qs = getQuerySolutionForCaching();
std::vector<QuerySolution*> solns = {qs.get()};
// Check if key is in cache before and after set().
ASSERT_EQ(planCache.get(*cq).state, PlanCache::CacheEntryState::kNotPresent);
QueryTestServiceContext serviceContext;
ASSERT_OK(planCache.set(*cq, solns, createDecision(1U, 20), Date_t{}));
// After add, the planCache should have an inactive entry.
ASSERT_EQ(planCache.get(*cq).state, PlanCache::CacheEntryState::kPresentInactive);
// Calling set() again, with a solution that had a lower works value should create an active
// entry.
ASSERT_OK(planCache.set(*cq, solns, createDecision(1U, 10), Date_t{}));
ASSERT_EQ(planCache.get(*cq).state, PlanCache::CacheEntryState::kPresentActive);
ASSERT_EQUALS(planCache.size(), 1U);
// Clear the plan cache. The active entry should now be removed.
planCache.clear();
ASSERT_EQ(planCache.size(), 0U);
ASSERT_EQ(planCache.get(*cq).state, PlanCache::CacheEntryState::kNotPresent);
}
TEST(PlanCacheTest, WorksValueIncreases) {
PlanCache planCache;
unique_ptr<CanonicalQuery> cq(canonicalize("{a: 1}"));
auto qs = getQuerySolutionForCaching();
std::vector<QuerySolution*> solns = {qs.get()};
ASSERT_EQ(planCache.get(*cq).state, PlanCache::CacheEntryState::kNotPresent);
QueryTestServiceContext serviceContext;
ASSERT_OK(planCache.set(*cq, solns, createDecision(1U, 10), Date_t{}));
// After add, the planCache should have an inactive entry.
ASSERT_EQ(planCache.get(*cq).state, PlanCache::CacheEntryState::kPresentInactive);
auto entry = assertGet(planCache.getEntry(*cq));
ASSERT_EQ(entry->works, 10U);
ASSERT_FALSE(entry->isActive);
// Calling set() again, with a solution that had a higher works value. This should cause the
// works on the original entry to be increased.
ASSERT_OK(planCache.set(*cq, solns, createDecision(1U, 50), Date_t{}));
// The entry should still be inactive. Its works should double though.
ASSERT_EQ(planCache.get(*cq).state, PlanCache::CacheEntryState::kPresentInactive);
entry = assertGet(planCache.getEntry(*cq));
ASSERT_FALSE(entry->isActive);
ASSERT_EQ(entry->works, 20U);
// Calling set() again, with a solution that had a higher works value. This should cause the
// works on the original entry to be increased.
ASSERT_OK(planCache.set(*cq, solns, createDecision(1U, 30), Date_t{}));
// The entry should still be inactive. Its works should have doubled again.
ASSERT_EQ(planCache.get(*cq).state, PlanCache::CacheEntryState::kPresentInactive);
entry = assertGet(planCache.getEntry(*cq));
ASSERT_FALSE(entry->isActive);
ASSERT_EQ(entry->works, 40U);
// Calling set() again, with a solution that has a lower works value than what's currently in
// the cache.
ASSERT_OK(planCache.set(*cq, solns, createDecision(1U, 25), Date_t{}));
// The solution just run should now be in an active cache entry, with a works
// equal to the number of works the solution took.
ASSERT_EQ(planCache.get(*cq).state, PlanCache::CacheEntryState::kPresentActive);
entry = assertGet(planCache.getEntry(*cq));
ASSERT_TRUE(entry->isActive);
ASSERT(entry->debugInfo);
ASSERT(entry->debugInfo->decision);
auto&& decision = entry->debugInfo->decision;
ASSERT_EQ(decision->getStats<PlanStageStats>()[0]->common.works, 25U);
ASSERT_EQ(entry->works, 25U);
ASSERT_EQUALS(planCache.size(), 1U);
// Clear the plan cache. The active entry should now be removed.
planCache.clear();
ASSERT_EQ(planCache.size(), 0U);
ASSERT_EQ(planCache.get(*cq).state, PlanCache::CacheEntryState::kNotPresent);
}
TEST(PlanCacheTest, WorksValueIncreasesByAtLeastOne) {
// Will use a very small growth coefficient.
const double kWorksCoeff = 1.10;
PlanCache planCache;
unique_ptr<CanonicalQuery> cq(canonicalize("{a: 1}"));
auto qs = getQuerySolutionForCaching();
std::vector<QuerySolution*> solns = {qs.get()};
ASSERT_EQ(planCache.get(*cq).state, PlanCache::CacheEntryState::kNotPresent);
QueryTestServiceContext serviceContext;
ASSERT_OK(planCache.set(*cq, solns, createDecision(1U, 3), Date_t{}));
// After add, the planCache should have an inactive entry.
ASSERT_EQ(planCache.get(*cq).state, PlanCache::CacheEntryState::kPresentInactive);
auto entry = assertGet(planCache.getEntry(*cq));
ASSERT_EQ(entry->works, 3U);
ASSERT_FALSE(entry->isActive);
// Calling set() again, with a solution that had a higher works value. This should cause the
// works on the original entry to be increased. In this case, since nWorks is 3,
// multiplying by the value 1.10 will give a value of 3 (static_cast<size_t>(1.1 * 3) == 3).
// We check that the works value is increased 1 instead.
ASSERT_OK(planCache.set(*cq, solns, createDecision(1U, 50), Date_t{}, kWorksCoeff));
// The entry should still be inactive. Its works should increase by 1.
ASSERT_EQ(planCache.get(*cq).state, PlanCache::CacheEntryState::kPresentInactive);
entry = assertGet(planCache.getEntry(*cq));
ASSERT_FALSE(entry->isActive);
ASSERT_EQ(entry->works, 4U);
// Clear the plan cache. The inactive entry should now be removed.
planCache.clear();
ASSERT_EQ(planCache.size(), 0U);
ASSERT_EQ(planCache.get(*cq).state, PlanCache::CacheEntryState::kNotPresent);
}
TEST(PlanCacheTest, SetIsNoopWhenNewEntryIsWorse) {
PlanCache planCache;
unique_ptr<CanonicalQuery> cq(canonicalize("{a: 1}"));
auto qs = getQuerySolutionForCaching();
std::vector<QuerySolution*> solns = {qs.get()};
ASSERT_EQ(planCache.get(*cq).state, PlanCache::CacheEntryState::kNotPresent);
QueryTestServiceContext serviceContext;
ASSERT_OK(planCache.set(*cq, solns, createDecision(1U, 50), Date_t{}));
// After add, the planCache should have an inactive entry.
ASSERT_EQ(planCache.get(*cq).state, PlanCache::CacheEntryState::kPresentInactive);
auto entry = assertGet(planCache.getEntry(*cq));
ASSERT_EQ(entry->works, 50U);
ASSERT_FALSE(entry->isActive);
// Call set() again, with a solution that has a lower works value. This will result in an
// active entry being created.
ASSERT_OK(planCache.set(*cq, solns, createDecision(1U, 20), Date_t{}));
ASSERT_EQ(planCache.get(*cq).state, PlanCache::CacheEntryState::kPresentActive);
entry = assertGet(planCache.getEntry(*cq));
ASSERT_TRUE(entry->isActive);
ASSERT_EQ(entry->works, 20U);
// Now call set() again, but with a solution that has a higher works value. This should be
// a noop.
ASSERT_OK(planCache.set(*cq, solns, createDecision(1U, 100), Date_t{}));
ASSERT_EQ(planCache.get(*cq).state, PlanCache::CacheEntryState::kPresentActive);
entry = assertGet(planCache.getEntry(*cq));
ASSERT_TRUE(entry->isActive);
ASSERT_EQ(entry->works, 20U);
}
TEST(PlanCacheTest, SetOverwritesWhenNewEntryIsBetter) {
PlanCache planCache;
unique_ptr<CanonicalQuery> cq(canonicalize("{a: 1}"));
auto qs = getQuerySolutionForCaching();
std::vector<QuerySolution*> solns = {qs.get()};
ASSERT_EQ(planCache.get(*cq).state, PlanCache::CacheEntryState::kNotPresent);
QueryTestServiceContext serviceContext;
ASSERT_OK(planCache.set(*cq, solns, createDecision(1U, 50), Date_t{}));
// After add, the planCache should have an inactive entry.
auto entry = assertGet(planCache.getEntry(*cq));
ASSERT_EQ(entry->works, 50U);
ASSERT_FALSE(entry->isActive);
// Call set() again, with a solution that has a lower works value. This will result in an
// active entry being created.
ASSERT_OK(planCache.set(*cq, solns, createDecision(1U, 20), Date_t{}));
ASSERT_EQ(planCache.get(*cq).state, PlanCache::CacheEntryState::kPresentActive);
entry = assertGet(planCache.getEntry(*cq));
ASSERT_TRUE(entry->isActive);
ASSERT_EQ(entry->works, 20U);
// Now call set() again, with a solution that has a lower works value. The current active entry
// should be overwritten.
ASSERT_OK(planCache.set(*cq, solns, createDecision(1U, 10), Date_t{}));
ASSERT_EQ(planCache.get(*cq).state, PlanCache::CacheEntryState::kPresentActive);
entry = assertGet(planCache.getEntry(*cq));
ASSERT_TRUE(entry->isActive);
ASSERT_EQ(entry->works, 10U);
}
TEST(PlanCacheTest, DeactivateCacheEntry) {
PlanCache planCache;
unique_ptr<CanonicalQuery> cq(canonicalize("{a: 1}"));
auto qs = getQuerySolutionForCaching();
std::vector<QuerySolution*> solns = {qs.get()};
ASSERT_EQ(planCache.get(*cq).state, PlanCache::CacheEntryState::kNotPresent);
QueryTestServiceContext serviceContext;
ASSERT_OK(planCache.set(*cq, solns, createDecision(1U, 50), Date_t{}));
// After add, the planCache should have an inactive entry.
auto entry = assertGet(planCache.getEntry(*cq));
ASSERT_EQ(entry->works, 50U);
ASSERT_FALSE(entry->isActive);
// Call set() again, with a solution that has a lower works value. This will result in an
// active entry being created.
ASSERT_OK(planCache.set(*cq, solns, createDecision(1U, 20), Date_t{}));
ASSERT_EQ(planCache.get(*cq).state, PlanCache::CacheEntryState::kPresentActive);
entry = assertGet(planCache.getEntry(*cq));
ASSERT_TRUE(entry->isActive);
ASSERT_EQ(entry->works, 20U);
planCache.deactivate(*cq);
ASSERT_EQ(planCache.get(*cq).state, PlanCache::CacheEntryState::kPresentInactive);
// Be sure the entry has the same works value.
entry = assertGet(planCache.getEntry(*cq));
ASSERT_FALSE(entry->isActive);
ASSERT_EQ(entry->works, 20U);
}
TEST(PlanCacheTest, GetMatchingStatsMatchesAndSerializesCorrectly) {
PlanCache planCache;
// Create a cache entry with 5 works.
{
unique_ptr<CanonicalQuery> cq(canonicalize("{a: 1}"));
auto qs = getQuerySolutionForCaching();
std::vector<QuerySolution*> solns = {qs.get()};
ASSERT_OK(planCache.set(*cq, solns, createDecision(1U, 5), Date_t{}));
}
// Create a second cache entry with 3 works.
{
unique_ptr<CanonicalQuery> cq(canonicalize("{b: 1}"));
auto qs = getQuerySolutionForCaching();
std::vector<QuerySolution*> solns = {qs.get()};
ASSERT_OK(planCache.set(*cq, solns, createDecision(1U, 3), Date_t{}));
}
// Verify that the cache entries have been created.
ASSERT_EQ(2U, planCache.size());
// Define a serialization function which just serializes the number of works.
const auto serializer = [](const PlanCacheEntry& entry) {
return BSON("works" << static_cast<int>(entry.works));
};
// Define a matcher which matches if the number of works exceeds 4.
const auto matcher = [](const BSONObj& serializedEntry) {
BSONElement worksElt = serializedEntry["works"];
return worksElt && worksElt.number() > 4;
};
// Verify the output of getMatchingStats().
auto getStatsResult = planCache.getMatchingStats(serializer, matcher);
ASSERT_EQ(1U, getStatsResult.size());
ASSERT_BSONOBJ_EQ(BSON("works" << 5), getStatsResult[0]);
}
/**
* Each test in the CachePlanSelectionTest suite goes through
* the following flow:
*
* 1) Run QueryPlanner::plan on the query, with specified indices
* available. This simulates the case in which we failed to plan from
* the plan cache, and fell back on selecting a plan ourselves. The
* enumerator will run, and cache data will be stashed into each solution
* that it generates.
*
* 2) Use firstMatchingSolution to select one of the solutions generated
* by QueryPlanner::plan. This simulates the multi plan runner picking
* the "best solution".
*
* 3) The cache data stashed inside the "best solution" is used to
* make a CachedSolution which looks exactly like the data structure that
* would be returned from the cache. This simulates a plan cache hit.
*
* 4) Call QueryPlanner::planFromCache, passing it the CachedSolution.
* This exercises the code which is able to map from a CachedSolution to
* a full-blown QuerySolution. Finally, assert that the query solution
* recovered from the cache is identical to the original "best solution".
*/
class CachePlanSelectionTest : public mongo::unittest::Test {
protected:
void setUp() {
params.options = QueryPlannerParams::INCLUDE_COLLSCAN;
addIndex(BSON("_id" << 1), "_id_");
}
void addIndex(BSONObj keyPattern, const std::string& indexName, bool multikey = false) {
params.indices.push_back(
IndexEntry(keyPattern,
IndexNames::nameToType(IndexNames::findPluginName(keyPattern)),
IndexDescriptor::kLatestIndexVersion,
multikey,
{},
{},
false,
false,
IndexEntry::Identifier{indexName},
nullptr,
BSONObj(),
nullptr,
nullptr));
}
void addIndex(BSONObj keyPattern, const std::string& indexName, bool multikey, bool sparse) {
params.indices.push_back(
IndexEntry(keyPattern,
IndexNames::nameToType(IndexNames::findPluginName(keyPattern)),
IndexDescriptor::kLatestIndexVersion,
multikey,
{},
{},
sparse,
false,
IndexEntry::Identifier{indexName},
nullptr,
BSONObj(),
nullptr,
nullptr));
}
void addIndex(BSONObj keyPattern, const std::string& indexName, CollatorInterface* collator) {
IndexEntry entry(keyPattern,
IndexNames::nameToType(IndexNames::findPluginName(keyPattern)),
IndexDescriptor::kLatestIndexVersion,
false,
{},
{},
false,
false,
IndexEntry::Identifier{indexName},
nullptr,
BSONObj(),
nullptr,
nullptr);
entry.collator = collator;
params.indices.push_back(entry);
}
//
// Execute planner.
//
void runQuery(BSONObj query) {
runQuerySortProjSkipLimit(query, BSONObj(), BSONObj(), 0, 0);
}
void runQuerySortProj(const BSONObj& query, const BSONObj& sort, const BSONObj& proj) {
runQuerySortProjSkipLimit(query, sort, proj, 0, 0);
}
void runQuerySkipLimit(const BSONObj& query, long long skip, long long limit) {
runQuerySortProjSkipLimit(query, BSONObj(), BSONObj(), skip, limit);
}
void runQueryHint(const BSONObj& query, const BSONObj& hint) {
runQuerySortProjSkipLimitHint(query, BSONObj(), BSONObj(), 0, 0, hint);
}
void runQuerySortProjSkipLimit(const BSONObj& query,
const BSONObj& sort,
const BSONObj& proj,
long long skip,
long long limit) {
runQuerySortProjSkipLimitHint(query, sort, proj, skip, limit, BSONObj());
}
void runQuerySortHint(const BSONObj& query, const BSONObj& sort, const BSONObj& hint) {
runQuerySortProjSkipLimitHint(query, sort, BSONObj(), 0, 0, hint);
}
void runQueryHintMinMax(const BSONObj& query,
const BSONObj& hint,
const BSONObj& minObj,
const BSONObj& maxObj) {
runQueryFull(query, BSONObj(), BSONObj(), 0, 0, hint, minObj, maxObj);
}
void runQuerySortProjSkipLimitHint(const BSONObj& query,
const BSONObj& sort,
const BSONObj& proj,
long long skip,
long long limit,
const BSONObj& hint) {
runQueryFull(query, sort, proj, skip, limit, hint, BSONObj(), BSONObj());
}
void runQueryFull(const BSONObj& query,
const BSONObj& sort,
const BSONObj& proj,
long long skip,
long long limit,
const BSONObj& hint,
const BSONObj& minObj,
const BSONObj& maxObj) {
QueryTestServiceContext serviceContext;
auto opCtx = serviceContext.makeOperationContext();
// Clean up any previous state from a call to runQueryFull or runQueryAsCommand.
solns.clear();
auto qr = std::make_unique<QueryRequest>(nss);
qr->setFilter(query);
qr->setSort(sort);
qr->setProj(proj);
if (skip) {
qr->setSkip(skip);
}
if (limit) {
qr->setLimit(limit);
}
qr->setHint(hint);
qr->setMin(minObj);
qr->setMax(maxObj);
const boost::intrusive_ptr<ExpressionContext> expCtx;
auto statusWithCQ =
CanonicalQuery::canonicalize(opCtx.get(),
std::move(qr),
expCtx,
ExtensionsCallbackNoop(),
MatchExpressionParser::kAllowAllSpecialFeatures);
ASSERT_OK(statusWithCQ.getStatus());
auto statusWithSolutions = QueryPlanner::plan(*statusWithCQ.getValue(), params);
ASSERT_OK(statusWithSolutions.getStatus());
solns = std::move(statusWithSolutions.getValue());
}
void runQueryAsCommand(const BSONObj& cmdObj) {
QueryTestServiceContext serviceContext;
auto opCtx = serviceContext.makeOperationContext();
// Clean up any previous state from a call to runQueryFull or runQueryAsCommand.
solns.clear();
const bool isExplain = false;
std::unique_ptr<QueryRequest> qr(
assertGet(QueryRequest::makeFromFindCommand(nss, cmdObj, isExplain)));
const boost::intrusive_ptr<ExpressionContext> expCtx;
auto statusWithCQ =
CanonicalQuery::canonicalize(opCtx.get(),
std::move(qr),
expCtx,
ExtensionsCallbackNoop(),
MatchExpressionParser::kAllowAllSpecialFeatures);
ASSERT_OK(statusWithCQ.getStatus());
auto statusWithSolutions = QueryPlanner::plan(*statusWithCQ.getValue(), params);
ASSERT_OK(statusWithSolutions.getStatus());
solns = std::move(statusWithSolutions.getValue());
}
//
// Solution introspection.
//
void dumpSolutions(str::stream& ost) const {
for (auto&& soln : solns) {
ost << soln->toString() << '\n';
}
}
/**
* Returns number of generated solutions matching JSON.
*/
size_t numSolutionMatches(const string& solnJson) const {
BSONObj testSoln = fromjson(solnJson);
size_t matches = 0;
for (auto&& soln : solns) {
if (QueryPlannerTestLib::solutionMatches(testSoln, soln->root())) {
++matches;
}
}
return matches;
}
/**
* Verifies that the solution tree represented in json by 'solnJson' is
* one of the solutions generated by QueryPlanner.
*
* The number of expected matches, 'numMatches', could be greater than
* 1 if solutions differ only by the pattern of index tags on a filter.
*/
void assertSolutionExists(const string& solnJson, size_t numMatches = 1) const {
size_t matches = numSolutionMatches(solnJson);
if (numMatches == matches) {
return;
}
str::stream ss;
ss << "expected " << numMatches << " matches for solution " << solnJson << " but got "
<< matches << " instead. all solutions generated: " << '\n';
dumpSolutions(ss);
FAIL(ss);
}
/**
* Plan 'query' from the cache with sort order 'sort', projection 'proj', and collation
* 'collation'. A mock cache entry is created using the cacheData stored inside the
* QuerySolution 'soln'.
*/
std::unique_ptr<QuerySolution> planQueryFromCache(const BSONObj& query,
const BSONObj& sort,
const BSONObj& proj,
const BSONObj& collation,
const QuerySolution& soln) const {
QueryTestServiceContext serviceContext;
auto opCtx = serviceContext.makeOperationContext();
auto qr = std::make_unique<QueryRequest>(nss);
qr->setFilter(query);
qr->setSort(sort);
qr->setProj(proj);
qr->setCollation(collation);
const boost::intrusive_ptr<ExpressionContext> expCtx;
auto statusWithCQ =
CanonicalQuery::canonicalize(opCtx.get(),
std::move(qr),
expCtx,
ExtensionsCallbackNoop(),
MatchExpressionParser::kAllowAllSpecialFeatures);
ASSERT_OK(statusWithCQ.getStatus());
unique_ptr<CanonicalQuery> scopedCq = std::move(statusWithCQ.getValue());
// Create a CachedSolution the long way..
// QuerySolution -> PlanCacheEntry -> CachedSolution
QuerySolution qs;
qs.cacheData = soln.cacheData->clone();
std::vector<QuerySolution*> solutions;
solutions.push_back(&qs);
uint32_t queryHash = canonical_query_encoder::computeHash(ck.stringData());
uint32_t planCacheKey = queryHash;
auto entry = PlanCacheEntry::create(
solutions, createDecision(1U), *scopedCq, queryHash, planCacheKey, Date_t(), false, 0);
CachedSolution cachedSoln(*entry);
auto statusWithQs = QueryPlanner::planFromCache(*scopedCq, params, cachedSoln);
ASSERT_OK(statusWithQs.getStatus());
return std::move(statusWithQs.getValue());
}
/**
* @param solnJson -- a json representation of a query solution.
*
* Returns the first solution matching 'solnJson', or fails if
* no match is found.
*/
QuerySolution* firstMatchingSolution(const string& solnJson) const {
BSONObj testSoln = fromjson(solnJson);
for (auto&& soln : solns) {
if (QueryPlannerTestLib::solutionMatches(testSoln, soln->root())) {
return soln.get();
}
}
str::stream ss;
ss << "Could not find a match for solution " << solnJson
<< " All solutions generated: " << '\n';
dumpSolutions(ss);
FAIL(ss);
return nullptr;
}
/**
* Assert that the QuerySolution 'trueSoln' matches the JSON-based representation
* of the solution in 'solnJson'.
*
* Relies on solutionMatches() -- see query_planner_test_lib.h
*/
void assertSolutionMatches(QuerySolution* trueSoln, const string& solnJson) const {
BSONObj testSoln = fromjson(solnJson);
if (!QueryPlannerTestLib::solutionMatches(testSoln, trueSoln->root())) {
str::stream ss;
ss << "Expected solution " << solnJson
<< " did not match true solution: " << trueSoln->toString() << '\n';
FAIL(ss);
}
}
/**
* Overloaded so that it is not necessary to specificy sort and project.
*/
void assertPlanCacheRecoversSolution(const BSONObj& query, const string& solnJson) {
assertPlanCacheRecoversSolution(query, BSONObj(), BSONObj(), BSONObj(), solnJson);
}
/**
* First, the solution matching 'solnJson' is retrieved from the vector
* of solutions generated by QueryPlanner::plan. This solution is
* then passed into planQueryFromCache(). Asserts that the solution
* generated by QueryPlanner::planFromCache matches 'solnJson'.
*
* Must be called after calling one of the runQuery* methods.
*
* Together, 'query', 'sort', 'proj', and 'collation' should specify the query which was
* previously run using one of the runQuery* methods.
*/
void assertPlanCacheRecoversSolution(const BSONObj& query,
const BSONObj& sort,
const BSONObj& proj,
const BSONObj& collation,
const string& solnJson) {
auto bestSoln = firstMatchingSolution(solnJson);
auto planSoln = planQueryFromCache(query, sort, proj, collation, *bestSoln);
assertSolutionMatches(planSoln.get(), solnJson);
}
/**
* Check that the solution will not be cached. The planner will store
* cache data inside non-cachable solutions, but will not do so for
* non-cachable solutions. Therefore, we just have to check that
* cache data is NULL.
*/
void assertNotCached(const string& solnJson) {
QuerySolution* bestSoln = firstMatchingSolution(solnJson);
ASSERT(nullptr != bestSoln);
ASSERT(nullptr == bestSoln->cacheData.get());
}
static const PlanCacheKey ck;
BSONObj queryObj;
QueryPlannerParams params;
std::vector<std::unique_ptr<QuerySolution>> solns;
};
const std::string mockKey("mock_cache_key");
const PlanCacheKey CachePlanSelectionTest::ck(mockKey, "");
//
// Equality
//
TEST_F(CachePlanSelectionTest, EqualityIndexScan) {
addIndex(BSON("x" << 1), "x_1");
runQuery(BSON("x" << 5));
assertPlanCacheRecoversSolution(BSON("x" << 5),
"{fetch: {filter: null, node: {ixscan: {pattern: {x: 1}}}}}");
}
TEST_F(CachePlanSelectionTest, EqualityIndexScanWithTrailingFields) {
addIndex(BSON("x" << 1 << "y" << 1), "x_1_y_1");
runQuery(BSON("x" << 5));
assertPlanCacheRecoversSolution(
BSON("x" << 5), "{fetch: {filter: null, node: {ixscan: {pattern: {x: 1, y: 1}}}}}");
}
//
// Geo
//
TEST_F(CachePlanSelectionTest, Basic2DSphereNonNear) {
addIndex(BSON("a"
<< "2dsphere"),
"a_2dsphere");
BSONObj query;
query = fromjson(
"{a: {$geoIntersects: {$geometry: {type: 'Point',"
"coordinates: [10.0, 10.0]}}}}");
runQuery(query);
assertPlanCacheRecoversSolution(query, "{fetch: {node: {ixscan: {pattern: {a: '2dsphere'}}}}}");
query = fromjson("{a : { $geoWithin : { $centerSphere : [[ 10, 20 ], 0.01 ] } }}");
runQuery(query);
assertPlanCacheRecoversSolution(query, "{fetch: {node: {ixscan: {pattern: {a: '2dsphere'}}}}}");
}
TEST_F(CachePlanSelectionTest, Basic2DSphereGeoNear) {
addIndex(BSON("a"
<< "2dsphere"),
"a_2dsphere");
BSONObj query;
query = fromjson("{a: {$nearSphere: [0,0], $maxDistance: 0.31 }}");
runQuery(query);
assertPlanCacheRecoversSolution(query,
"{geoNear2dsphere: {pattern: {a: '2dsphere'}, "
"bounds: {a: [['MinKey', 'MaxKey', true, true]]}}}");
query = fromjson(
"{a: {$geoNear: {$geometry: {type: 'Point', coordinates: [0,0]},"
"$maxDistance:100}}}");
runQuery(query);
assertPlanCacheRecoversSolution(query,
"{geoNear2dsphere: {pattern: {a: '2dsphere'}, "
"bounds: {a: [['MinKey', 'MaxKey', true, true]]}}}");
}
TEST_F(CachePlanSelectionTest, Basic2DSphereGeoNearReverseCompound) {
addIndex(BSON("x" << 1), "x_1");
addIndex(BSON("x" << 1 << "a"
<< "2dsphere"),
"x_1_a_2dsphere");
BSONObj query = fromjson("{x:1, a: {$nearSphere: [0,0], $maxDistance: 0.31 }}");
runQuery(query);
assertPlanCacheRecoversSolution(
query,
"{geoNear2dsphere: {pattern: {x: 1, a: '2dsphere'}, "
"bounds: {x: [[1, 1, true, true]], a: [['MinKey', 'MaxKey', true, true]]}}}");
}
TEST_F(CachePlanSelectionTest, TwoDSphereNoGeoPred) {
addIndex(BSON("x" << 1 << "a"
<< "2dsphere"),
"x_1_a_2dsphere");
runQuery(BSON("x" << 1));
assertPlanCacheRecoversSolution(BSON("x" << 1),
"{fetch: {node: {ixscan: {pattern: {x: 1, a: '2dsphere'}}}}}");
}
TEST_F(CachePlanSelectionTest, Or2DSphereNonNear) {
addIndex(BSON("a"
<< "2dsphere"),
"a_2dsphere");
addIndex(BSON("b"
<< "2dsphere"),
"b_2dsphere");
BSONObj query = fromjson(
"{$or: [ {a: {$geoIntersects: {$geometry: {type: 'Point', coordinates: [10.0, 10.0]}}}},"
" {b: {$geoWithin: { $centerSphere: [[ 10, 20 ], 0.01 ] } }} ]}");
runQuery(query);
assertPlanCacheRecoversSolution(
query,
"{or: {nodes: [{fetch: {node: {ixscan: {pattern: {a: '2dsphere'}}}}},"
"{fetch: {node: {ixscan: {pattern: {b: '2dsphere'}}}}}]}}");
}
// Regression test for SERVER-24320. Tests that the PlanCacheIndexTree has the same sort order as
// the MatchExpression used to generate the plan cache key.
TEST_F(CachePlanSelectionTest, AndWithinPolygonWithinCenterSphere) {
addIndex(BSON("a"
<< "2dsphere"
<< "b" << 1),
"a_2dsphere_b_2dsphere");
BSONObj query = fromjson(
"{$and: [{b: 1}, {a: {$within: {$polygon: [[0, 0], [0, 0], [0, 0], [0, 0]]}}}, {a: "
"{$within: {$centerSphere: [[0, 0], 0]}}}]}");
runQuery(query);
assertPlanCacheRecoversSolution(query,
"{fetch: {node: {ixscan: {pattern: {a: '2dsphere', b: 1}}}}}");
}
// $** index
TEST_F(CachePlanSelectionTest, WildcardIxScan) {
auto entryProjExecPair = makeWildcardEntry(BSON("$**" << 1));
params.indices.push_back(entryProjExecPair.first);
BSONObj query = fromjson("{a: 1, b: 1}");
runQuery(query);
const auto kPlanA =
"{fetch: {node: {ixscan: "
"{bounds: {$_path: [['a', 'a', true, true]], a: [[1, 1, true, true]]},"
"pattern: {$_path: 1, a:1}}}}}";
const auto kPlanB =
"{fetch: {node: {ixscan: "
"{bounds: {$_path: [['b', 'b', true, true]], b: [[1, 1, true, true]]},"
"pattern: {$_path: 1, b:1}}}}}";
assertPlanCacheRecoversSolution(query, kPlanA);
assertPlanCacheRecoversSolution(query, kPlanB);
// Query with fields in a different order, so that index entry expansion results in the list of
// indexes being in a different order. Should still yield the same plans.
BSONObj queryOtherDir = fromjson("{b: 1, a: 1}");
assertPlanCacheRecoversSolution(query, kPlanA);
assertPlanCacheRecoversSolution(query, kPlanB);
}
//
// tree operations
//
TEST_F(CachePlanSelectionTest, TwoPredicatesAnding) {
addIndex(BSON("x" << 1), "x_1");
BSONObj query = fromjson("{$and: [ {x: {$gt: 1}}, {x: {$lt: 3}} ] }");
runQuery(query);
assertPlanCacheRecoversSolution(
query, "{fetch: {filter: null, node: {ixscan: {filter: null, pattern: {x: 1}}}}}");
}
TEST_F(CachePlanSelectionTest, SimpleOr) {
addIndex(BSON("a" << 1), "a_1");
BSONObj query = fromjson("{$or: [{a: 20}, {a: 21}]}");
runQuery(query);
assertPlanCacheRecoversSolution(
query, "{fetch: {filter: null, node: {ixscan: {filter: null, pattern: {a:1}}}}}");
}
TEST_F(CachePlanSelectionTest, OrWithAndChild) {
addIndex(BSON("a" << 1), "a_1");
BSONObj query = fromjson("{$or: [{a: 20}, {$and: [{a:1}, {b:7}]}]}");
runQuery(query);
assertPlanCacheRecoversSolution(query,
"{fetch: {filter: null, node: {or: {nodes: ["
"{ixscan: {filter: null, pattern: {a: 1}}}, "
"{fetch: {filter: {b: 7}, node: {ixscan: "
"{filter: null, pattern: {a: 1}}}}}]}}}}");
}
TEST_F(CachePlanSelectionTest, AndWithUnindexedOrChild) {
addIndex(BSON("a" << 1), "a_1");
BSONObj query = fromjson("{a:20, $or: [{b:1}, {c:7}]}");
runQuery(query);
assertPlanCacheRecoversSolution(query,
"{fetch: {filter: {$or: [{b: 1}, {c: 7}]}, node: "
"{ixscan: {filter: null, pattern: {a: 1}}}}}");
}
TEST_F(CachePlanSelectionTest, AndWithOrWithOneIndex) {
addIndex(BSON("b" << 1), "b_1");
addIndex(BSON("a" << 1), "a_1");
BSONObj query = fromjson("{$or: [{b:1}, {c:7}], a:20}");
runQuery(query);
assertPlanCacheRecoversSolution(query,
"{fetch: {filter: {$or: [{b: 1}, {c: 7}]}, "
"node: {ixscan: {filter: null, pattern: {a: 1}}}}}");
}
//
// Sort orders
//
// SERVER-1205.
TEST_F(CachePlanSelectionTest, MergeSort) {
addIndex(BSON("a" << 1 << "c" << 1), "a_1_c_1");
addIndex(BSON("b" << 1 << "c" << 1), "b_1_c_1");
BSONObj query = fromjson("{$or: [{a:1}, {b:1}]}");
BSONObj sort = BSON("c" << 1);
runQuerySortProj(query, sort, BSONObj());
assertPlanCacheRecoversSolution(
query,
sort,
BSONObj(),
BSONObj(),
"{fetch: {node: {mergeSort: {nodes: "
"[{ixscan: {pattern: {a: 1, c: 1}}}, {ixscan: {pattern: {b: 1, c: 1}}}]}}}}");
}
// SERVER-1205 as well.
TEST_F(CachePlanSelectionTest, NoMergeSortIfNoSortWanted) {
addIndex(BSON("a" << 1 << "c" << 1), "a_1_c_1");
addIndex(BSON("b" << 1 << "c" << 1), "b_1_c_1");
BSONObj query = fromjson("{$or: [{a:1}, {b:1}]}");
runQuerySortProj(query, BSONObj(), BSONObj());
assertPlanCacheRecoversSolution(query,
BSONObj(),
BSONObj(),
BSONObj(),
"{fetch: {filter: null, node: {or: {nodes: ["
"{ixscan: {filter: null, pattern: {a: 1, c: 1}}}, "
"{ixscan: {filter: null, pattern: {b: 1, c: 1}}}]}}}}");
}
// Disabled: SERVER-10801.
/*
TEST_F(CachePlanSelectionTest, SortOnGeoQuery) {
addIndex(BSON("timestamp" << -1 << "position" << "2dsphere"), "timestamp_-1_position_2dsphere");
BSONObj query = fromjson("{position: {$geoWithin: {$geometry: {type: \"Polygon\", "
"coordinates: [[[1, 1], [1, 90], [180, 90], "
"[180, 1], [1, 1]]]}}}}");
BSONObj sort = fromjson("{timestamp: -1}");
runQuerySortProj(query, sort, BSONObj());
assertPlanCacheRecoversSolution(query, sort, BSONObj(),
"{fetch: {node: {ixscan: {pattern: {timestamp: -1, position: '2dsphere'}}}}}");
}
*/
// SERVER-9257
TEST_F(CachePlanSelectionTest, CompoundGeoNoGeoPredicate) {
addIndex(BSON("creationDate" << 1 << "foo.bar"
<< "2dsphere"),
"creationDate_1_foo.bar_2dsphere");
BSONObj query = fromjson("{creationDate: {$gt: 7}}");
BSONObj sort = fromjson("{creationDate: 1}");
runQuerySortProj(query, sort, BSONObj());
assertPlanCacheRecoversSolution(
query,
sort,
BSONObj(),
BSONObj(),
"{fetch: {node: {ixscan: {pattern: {creationDate: 1, 'foo.bar': '2dsphere'}}}}}");
}
TEST_F(CachePlanSelectionTest, ReverseScanForSort) {
addIndex(BSON("_id" << 1), "_id_1");
runQuerySortProj(BSONObj(), fromjson("{_id: -1}"), BSONObj());
assertPlanCacheRecoversSolution(
BSONObj(),
fromjson("{_id: -1}"),
BSONObj(),
BSONObj(),
"{fetch: {filter: null, node: {ixscan: {filter: null, pattern: {_id: 1}}}}}");
}
//
// Caching collection scans.
//
TEST_F(CachePlanSelectionTest, CollscanNoUsefulIndices) {
addIndex(BSON("a" << 1 << "b" << 1), "a_1_b_1");
addIndex(BSON("c" << 1), "c_1");
runQuery(BSON("b" << 4));
assertPlanCacheRecoversSolution(BSON("b" << 4), "{cscan: {filter: {b: 4}, dir: 1}}");
}
TEST_F(CachePlanSelectionTest, CollscanOrWithoutEnoughIndices) {
addIndex(BSON("a" << 1), "a_1");
BSONObj query = fromjson("{$or: [{a: 20}, {b: 21}]}");
runQuery(query);
assertPlanCacheRecoversSolution(query, "{cscan: {filter: {$or:[{a:20},{b:21}]}, dir: 1}}");
}
TEST_F(CachePlanSelectionTest, CollscanMergeSort) {
addIndex(BSON("a" << 1 << "c" << 1), "a_1_c_1");
addIndex(BSON("b" << 1 << "c" << 1), "b_1_c_1");
BSONObj query = fromjson("{$or: [{a:1}, {b:1}]}");
BSONObj sort = BSON("c" << 1);
runQuerySortProj(query, sort, BSONObj());
assertPlanCacheRecoversSolution(query,
sort,
BSONObj(),
BSONObj(),
"{sort: {pattern: {c: 1}, limit: 0, type: 'simple', node: "
"{cscan: {dir: 1}}}}");
}
//
// Caching plans that use multikey indexes.
//
TEST_F(CachePlanSelectionTest, CachedPlanForCompoundMultikeyIndexCanCompoundBounds) {
params.options = QueryPlannerParams::NO_TABLE_SCAN | QueryPlannerParams::INDEX_INTERSECTION;
const bool multikey = true;
addIndex(BSON("a" << 1 << "b" << 1), "a_1_b_1", multikey);
BSONObj query = fromjson("{a: 2, b: 3}");
runQuery(query);
assertPlanCacheRecoversSolution(
query,
"{fetch: {filter: null, node: {ixscan: {pattern: {a: 1, b: 1}, "
"bounds: {a: [[2, 2, true, true]], b: [[3, 3, true, true]]}}}}}");
}
TEST_F(CachePlanSelectionTest,
CachedPlanForSelfIntersectionOfMultikeyIndexPointRangesCannotIntersectBounds) {
params.options = QueryPlannerParams::NO_TABLE_SCAN | QueryPlannerParams::INDEX_INTERSECTION;
const bool multikey = true;
addIndex(BSON("a" << 1), "a_1", multikey);
BSONObj query = fromjson("{$and: [{a: 2}, {a: 3}]}");
runQuery(query);
assertPlanCacheRecoversSolution(
query,
"{fetch: {filter: {$and: [{a: 2}, {a: 3}]}, node: {andSorted: {nodes: ["
"{ixscan: {pattern: {a: 1}, bounds: {a: [[2, 2, true, true]]}}}, "
"{ixscan: {pattern: {a: 1}, bounds: {a: [[3, 3, true, true]]}}}]}}}}");
}
TEST_F(CachePlanSelectionTest,
CachedPlanForSelfIntersectionOfMultikeyIndexNonPointRangesCannotIntersectBounds) {
// Enable a hash-based index intersection plan to be generated because we are scanning a
// non-point range on the "a" field.
bool oldEnableHashIntersection = internalQueryPlannerEnableHashIntersection.load();
ON_BLOCK_EXIT([oldEnableHashIntersection] {
internalQueryPlannerEnableHashIntersection.store(oldEnableHashIntersection);
});
internalQueryPlannerEnableHashIntersection.store(true);
params.options = QueryPlannerParams::NO_TABLE_SCAN | QueryPlannerParams::INDEX_INTERSECTION;
const bool multikey = true;
addIndex(BSON("a" << 1), "a_1", multikey);
BSONObj query = fromjson("{$and: [{a: {$gte: 2}}, {a: {$lt: 3}}]}");
runQuery(query);
assertPlanCacheRecoversSolution(
query,
"{fetch: {filter: {$and:[{a:{$gte:2}},{a:{$lt:3}}]}, node: {andHash: {nodes: ["
"{ixscan: {pattern: {a: 1}, bounds: {a: [[2, Infinity, true, true]]}}}, "
"{ixscan: {pattern: {a: 1}, bounds: {a: [[-Infinity, 3, true, false]]}}}]}}}}");
}
TEST_F(CachePlanSelectionTest, CachedPlanForIntersectionOfMultikeyIndexesWhenUsingElemMatch) {
params.options = QueryPlannerParams::NO_TABLE_SCAN | QueryPlannerParams::INDEX_INTERSECTION;
const bool multikey = true;
addIndex(BSON("a.b" << 1), "a.b_1", multikey);
addIndex(BSON("a.c" << 1), "a.c_1", multikey);
BSONObj query = fromjson("{a: {$elemMatch: {b: 2, c: 3}}}");
runQuery(query);
assertPlanCacheRecoversSolution(
query,
"{fetch: {filter: {a: {$elemMatch: {b: 2, c: 3}}}, node: {andSorted: {nodes: ["
"{ixscan: {pattern: {'a.b': 1}, bounds: {'a.b': [[2, 2, true, true]]}}},"
"{ixscan: {pattern: {'a.c': 1}, bounds: {'a.c': [[3, 3, true, true]]}}}]}}}}");
}
TEST_F(CachePlanSelectionTest, CachedPlanForIntersectionWithNonMultikeyIndexCanIntersectBounds) {
// Enable a hash-based index intersection plan to be generated because we are scanning a
// non-point range on the "a.c" field.
bool oldEnableHashIntersection = internalQueryPlannerEnableHashIntersection.load();
ON_BLOCK_EXIT([oldEnableHashIntersection] {
internalQueryPlannerEnableHashIntersection.store(oldEnableHashIntersection);
});
internalQueryPlannerEnableHashIntersection.store(true);
params.options = QueryPlannerParams::NO_TABLE_SCAN | QueryPlannerParams::INDEX_INTERSECTION;
const bool multikey = true;
addIndex(BSON("a.b" << 1), "a.b_1", multikey);
addIndex(BSON("a.c" << 1), "a.c_1", !multikey);
BSONObj query = fromjson("{'a.b': 2, 'a.c': {$gte: 0, $lt: 10}}}}");
runQuery(query);
assertPlanCacheRecoversSolution(
query,
"{fetch: {node: {andHash: {nodes: ["
"{ixscan: {pattern: {'a.b': 1}, bounds: {'a.b': [[2, 2, true, true]]}}},"
"{ixscan: {pattern: {'a.c': 1}, bounds: {'a.c': [[0, 10, true, false]]}}}]}}}}");
}
//
// Check queries that, at least for now, are not cached.
//
TEST_F(CachePlanSelectionTest, GeoNear2DNotCached) {
addIndex(BSON("a"
<< "2d"),
"a_2d");
runQuery(fromjson("{a: {$near: [0,0], $maxDistance:0.3 }}"));
assertNotCached("{geoNear2d: {a: '2d'}}");
}
TEST_F(CachePlanSelectionTest, MinNotCached) {
addIndex(BSON("a" << 1), "a_1");
runQueryHintMinMax(BSONObj(), fromjson("{a: 1}"), fromjson("{a: 1}"), BSONObj());
assertNotCached(
"{fetch: {filter: null, "
"node: {ixscan: {filter: null, pattern: {a: 1}}}}}");
}
TEST_F(CachePlanSelectionTest, MaxNotCached) {
addIndex(BSON("a" << 1), "a_1");
runQueryHintMinMax(BSONObj(), fromjson("{a: 1}"), BSONObj(), fromjson("{a: 1}"));
assertNotCached(
"{fetch: {filter: null, "
"node: {ixscan: {filter: null, pattern: {a: 1}}}}}");
}
TEST_F(CachePlanSelectionTest, NaturalHintNotCached) {
addIndex(BSON("a" << 1), "a_1");
addIndex(BSON("b" << 1), "b_1");
runQuerySortHint(BSON("a" << 1), BSON("b" << 1), BSON("$natural" << 1));
assertNotCached(
"{sort: {pattern: {b: 1}, limit: 0, type: 'simple', node: "
"{cscan: {filter: {a: 1}, dir: 1}}}}");
}
TEST_F(CachePlanSelectionTest, HintValidNotCached) {
addIndex(BSON("a" << 1), "a_1");
runQueryHint(BSONObj(), fromjson("{a: 1}"));
assertNotCached(
"{fetch: {filter: null, "
"node: {ixscan: {filter: null, pattern: {a: 1}}}}}");
}
//
// Queries using '2d' indices are not cached.
//
TEST_F(CachePlanSelectionTest, Basic2DNonNearNotCached) {
addIndex(BSON("a"
<< "2d"),
"a_2d");
BSONObj query;
// Polygon
query = fromjson("{a : { $within: { $polygon : [[0,0], [2,0], [4,0]] } }}");
runQuery(query);
assertNotCached("{fetch: {node: {ixscan: {pattern: {a: '2d'}}}}}");
// Center
query = fromjson("{a : { $within : { $center : [[ 5, 5 ], 7 ] } }}");
runQuery(query);
assertNotCached("{fetch: {node: {ixscan: {pattern: {a: '2d'}}}}}");
// Centersphere
query = fromjson("{a : { $within : { $centerSphere : [[ 10, 20 ], 0.01 ] } }}");
runQuery(query);
assertNotCached("{fetch: {node: {ixscan: {pattern: {a: '2d'}}}}}");
// Within box.
query = fromjson("{a : {$within: {$box : [[0,0],[9,9]]}}}");
runQuery(query);
assertNotCached("{fetch: {node: {ixscan: {pattern: {a: '2d'}}}}}");
}
TEST_F(CachePlanSelectionTest, Or2DNonNearNotCached) {
addIndex(BSON("a"
<< "2d"),
"a_2d");
addIndex(BSON("b"
<< "2d"),
"b_2d");
BSONObj query = fromjson(
"{$or: [ {a : { $within : { $polygon : [[0,0], [2,0], [4,0]] } }},"
" {b : { $within : { $center : [[ 5, 5 ], 7 ] } }} ]}");
runQuery(query);
assertNotCached(
"{or: {nodes: [{fetch: {node: {ixscan: {pattern: {a: '2d'}}}}},"
"{fetch: {node: {ixscan: {pattern: {b: '2d'}}}}}]}}");
}
//
// Collation.
//
TEST_F(CachePlanSelectionTest, MatchingCollation) {
CollatorInterfaceMock collator(CollatorInterfaceMock::MockType::kReverseString);
addIndex(BSON("x" << 1), "x_1", &collator);
runQueryAsCommand(fromjson(
"{find: 'testns', filter: {x: 'foo'}, collation: {locale: 'mock_reverse_string'}}"));
assertPlanCacheRecoversSolution(BSON("x"
<< "bar"),
BSONObj(),
BSONObj(),
BSON("locale"
<< "mock_reverse_string"),
"{fetch: {node: {ixscan: {pattern: {x: 1}}}}}");
}
TEST_F(CachePlanSelectionTest, ContainedOr) {
addIndex(BSON("b" << 1 << "a" << 1), "b_1_a_1");
addIndex(BSON("c" << 1 << "a" << 1), "c_1_a_1");
BSONObj query = fromjson("{$and: [{a: 5}, {$or: [{b: 6}, {c: 7}]}]}");
runQuery(query);
assertPlanCacheRecoversSolution(
query,
"{fetch: {filter: null, node: {or: {nodes: ["
"{ixscan: {pattern: {b: 1, a: 1}, bounds: {b: [[6, 6, true, true]], a: [[5, 5, true, "
"true]]}}},"
"{ixscan: {pattern: {c: 1, a: 1}, bounds: {c: [[7, 7, true, true]], a: [[5, 5, true, "
"true]]}}}"
"]}}}}");
}
TEST_F(CachePlanSelectionTest, ContainedOrAndIntersection) {
bool oldEnableHashIntersection = internalQueryPlannerEnableHashIntersection.load();
ON_BLOCK_EXIT([oldEnableHashIntersection] {
internalQueryPlannerEnableHashIntersection.store(oldEnableHashIntersection);
});
internalQueryPlannerEnableHashIntersection.store(true);
params.options = QueryPlannerParams::INCLUDE_COLLSCAN | QueryPlannerParams::INDEX_INTERSECTION;
addIndex(BSON("a" << 1 << "b" << 1), "a_1_b_1");
addIndex(BSON("c" << 1), "c_1");
BSONObj query = fromjson("{$and: [{a: 5}, {$or: [{b: 6}, {c: 7}]}]}");
runQuery(query);
assertPlanCacheRecoversSolution(
query,
"{fetch: {filter: {$and:[{a:5},{$or:[{a:5,b:6},{c:7}]}]}, node: {andHash: {nodes: ["
"{or: {nodes: ["
"{ixscan: {pattern: {a: 1, b: 1}, bounds: {a: [[5, 5, true, true]], b: [[6, 6, true, "
"true]]}}},"
"{ixscan: {pattern: {c: 1}, bounds: {c: [[7, 7, true, true]]}}}]}},"
"{ixscan: {pattern: {a: 1, b: 1}, bounds: {a: [[5, 5, true, true]], b: [['MinKey', "
"'MaxKey', true, true]]}}}"
"]}}}}");
}
// When a sparse index is present, computeKey() should generate different keys depending on
// whether or not the predicates in the given query can use the index.
TEST(PlanCacheTest, ComputeKeySparseIndex) {
PlanCache planCache;
const auto keyPattern = BSON("a" << 1);
planCache.notifyOfIndexUpdates(
{CoreIndexInfo(keyPattern,
IndexNames::nameToType(IndexNames::findPluginName(keyPattern)),
true, // sparse
IndexEntry::Identifier{""})}); // name
unique_ptr<CanonicalQuery> cqEqNumber(canonicalize("{a: 0}}"));
unique_ptr<CanonicalQuery> cqEqString(canonicalize("{a: 'x'}}"));
unique_ptr<CanonicalQuery> cqEqNull(canonicalize("{a: null}}"));
// 'cqEqNumber' and 'cqEqString' get the same key, since both are compatible with this
// index.
const auto eqNumberKey = planCache.computeKey(*cqEqNumber);
const auto eqStringKey = planCache.computeKey(*cqEqString);
ASSERT_EQ(eqNumberKey, eqStringKey);
// 'cqEqNull' gets a different key, since it is not compatible with this index.
const auto eqNullKey = planCache.computeKey(*cqEqNull);
ASSERT_NOT_EQUALS(eqNullKey, eqNumberKey);
assertPlanCacheKeysUnequalDueToDiscriminators(eqNullKey, eqNumberKey);
assertPlanCacheKeysUnequalDueToDiscriminators(eqNullKey, eqStringKey);
}
// When a partial index is present, computeKey() should generate different keys depending on
// whether or not the predicates in the given query "match" the predicates in the partial index
// filter.
TEST(PlanCacheTest, ComputeKeyPartialIndex) {
BSONObj filterObj = BSON("f" << BSON("$gt" << 0));
unique_ptr<MatchExpression> filterExpr(parseMatchExpression(filterObj));
PlanCache planCache;
const auto keyPattern = BSON("a" << 1);
planCache.notifyOfIndexUpdates(
{CoreIndexInfo(keyPattern,
IndexNames::nameToType(IndexNames::findPluginName(keyPattern)),
false, // sparse
IndexEntry::Identifier{""}, // name
filterExpr.get())}); // filterExpr
unique_ptr<CanonicalQuery> cqGtNegativeFive(canonicalize("{f: {$gt: -5}}"));
unique_ptr<CanonicalQuery> cqGtZero(canonicalize("{f: {$gt: 0}}"));
unique_ptr<CanonicalQuery> cqGtFive(canonicalize("{f: {$gt: 5}}"));
// 'cqGtZero' and 'cqGtFive' get the same key, since both are compatible with this index.
ASSERT_EQ(planCache.computeKey(*cqGtZero), planCache.computeKey(*cqGtFive));
// 'cqGtNegativeFive' gets a different key, since it is not compatible with this index.
assertPlanCacheKeysUnequalDueToDiscriminators(planCache.computeKey(*cqGtNegativeFive),
planCache.computeKey(*cqGtZero));
}
// Query shapes should get the same plan cache key if they have the same collation indexability.
TEST(PlanCacheTest, ComputeKeyCollationIndex) {
CollatorInterfaceMock collator(CollatorInterfaceMock::MockType::kReverseString);
PlanCache planCache;
const auto keyPattern = BSON("a" << 1);
planCache.notifyOfIndexUpdates(
{CoreIndexInfo(keyPattern,
IndexNames::nameToType(IndexNames::findPluginName(keyPattern)),
false, // sparse
IndexEntry::Identifier{""}, // name
nullptr, // filterExpr
&collator)}); // collation
unique_ptr<CanonicalQuery> containsString(canonicalize("{a: 'abc'}"));
unique_ptr<CanonicalQuery> containsObject(canonicalize("{a: {b: 'abc'}}"));
unique_ptr<CanonicalQuery> containsArray(canonicalize("{a: ['abc', 'xyz']}"));
unique_ptr<CanonicalQuery> noStrings(canonicalize("{a: 5}"));
unique_ptr<CanonicalQuery> containsStringHasCollation(
canonicalize("{a: 'abc'}", "{}", "{}", "{locale: 'mock_reverse_string'}"));
// 'containsString', 'containsObject', and 'containsArray' have the same key, since none are
// compatible with the index.
ASSERT_EQ(planCache.computeKey(*containsString), planCache.computeKey(*containsObject));
ASSERT_EQ(planCache.computeKey(*containsString), planCache.computeKey(*containsArray));
// 'noStrings' gets a different key since it is compatible with the index.
assertPlanCacheKeysUnequalDueToDiscriminators(planCache.computeKey(*containsString),
planCache.computeKey(*noStrings));
ASSERT_EQ(planCache.computeKey(*containsString).getUnstablePart(), "<0>");
ASSERT_EQ(planCache.computeKey(*noStrings).getUnstablePart(), "<1>");
// 'noStrings' and 'containsStringHasCollation' get different keys, since the collation
// specified in the query is considered part of its shape. However, they have the same index
// compatibility, so the unstable part of their PlanCacheKeys should be the same.
PlanCacheKey noStringKey = planCache.computeKey(*noStrings);
PlanCacheKey withStringAndCollationKey = planCache.computeKey(*containsStringHasCollation);
ASSERT_NE(noStringKey, withStringAndCollationKey);
ASSERT_EQ(noStringKey.getUnstablePart(), withStringAndCollationKey.getUnstablePart());
ASSERT_NE(noStringKey.getStableKeyStringData(),
withStringAndCollationKey.getStableKeyStringData());
unique_ptr<CanonicalQuery> inContainsString(canonicalize("{a: {$in: [1, 'abc', 2]}}"));
unique_ptr<CanonicalQuery> inContainsObject(canonicalize("{a: {$in: [1, {b: 'abc'}, 2]}}"));
unique_ptr<CanonicalQuery> inContainsArray(canonicalize("{a: {$in: [1, ['abc', 'xyz'], 2]}}"));
unique_ptr<CanonicalQuery> inNoStrings(canonicalize("{a: {$in: [1, 2]}}"));
unique_ptr<CanonicalQuery> inContainsStringHasCollation(
canonicalize("{a: {$in: [1, 'abc', 2]}}", "{}", "{}", "{locale: 'mock_reverse_string'}"));
// 'inContainsString', 'inContainsObject', and 'inContainsArray' have the same key, since none
// are compatible with the index.
ASSERT_EQ(planCache.computeKey(*inContainsString), planCache.computeKey(*inContainsObject));
ASSERT_EQ(planCache.computeKey(*inContainsString), planCache.computeKey(*inContainsArray));
// 'inNoStrings' gets a different key since it is compatible with the index.
assertPlanCacheKeysUnequalDueToDiscriminators(planCache.computeKey(*inContainsString),
planCache.computeKey(*inNoStrings));
ASSERT_EQ(planCache.computeKey(*inContainsString).getUnstablePart(), "<0>");
ASSERT_EQ(planCache.computeKey(*inNoStrings).getUnstablePart(), "<1>");
// 'inNoStrings' and 'inContainsStringHasCollation' get the same key since they compatible with
// the index.
ASSERT_NE(planCache.computeKey(*inNoStrings),
planCache.computeKey(*inContainsStringHasCollation));
ASSERT_EQ(planCache.computeKey(*inNoStrings).getUnstablePart(),
planCache.computeKey(*inContainsStringHasCollation).getUnstablePart());
}
TEST(PlanCacheTest, ComputeKeyWildcardIndex) {
auto entryProjUpdatePair = makeWildcardUpdate(BSON("a.$**" << 1));
PlanCache planCache;
planCache.notifyOfIndexUpdates({entryProjUpdatePair.first});
// Used to check that two queries have the same shape when no indexes are present.
PlanCache planCacheWithNoIndexes;
// Compatible with index.
unique_ptr<CanonicalQuery> usesPathWithScalar(canonicalize("{a: 'abcdef'}"));
unique_ptr<CanonicalQuery> usesPathWithEmptyArray(canonicalize("{a: []}"));
// Not compatible with index.
unique_ptr<CanonicalQuery> usesPathWithObject(canonicalize("{a: {b: 'abc'}}"));
unique_ptr<CanonicalQuery> usesPathWithArray(canonicalize("{a: [1, 2]}"));
unique_ptr<CanonicalQuery> usesPathWithArrayContainingObject(canonicalize("{a: [1, {b: 1}]}"));
unique_ptr<CanonicalQuery> usesPathWithEmptyObject(canonicalize("{a: {}}"));
unique_ptr<CanonicalQuery> doesNotUsePath(canonicalize("{b: 1234}"));
// Check that the queries which are compatible with the index have the same key.
ASSERT_EQ(planCache.computeKey(*usesPathWithScalar),
planCache.computeKey(*usesPathWithEmptyArray));
// Check that the queries which have the same path as the index, but aren't supported, have
// different keys.
ASSERT_EQ(planCacheWithNoIndexes.computeKey(*usesPathWithScalar),
planCacheWithNoIndexes.computeKey(*usesPathWithObject));
assertPlanCacheKeysUnequalDueToDiscriminators(planCache.computeKey(*usesPathWithScalar),
planCache.computeKey(*usesPathWithObject));
ASSERT_EQ(planCache.computeKey(*usesPathWithScalar).getUnstablePart(), "<1>");
ASSERT_EQ(planCache.computeKey(*usesPathWithObject).getUnstablePart(), "<0>");
ASSERT_EQ(planCache.computeKey(*usesPathWithObject), planCache.computeKey(*usesPathWithArray));
ASSERT_EQ(planCache.computeKey(*usesPathWithObject),
planCache.computeKey(*usesPathWithArrayContainingObject));
// The query on 'b' should have a completely different plan cache key (both with and without a
// wildcard index).
ASSERT_NE(planCacheWithNoIndexes.computeKey(*usesPathWithScalar),
planCacheWithNoIndexes.computeKey(*doesNotUsePath));
ASSERT_NE(planCache.computeKey(*usesPathWithScalar), planCache.computeKey(*doesNotUsePath));
ASSERT_NE(planCacheWithNoIndexes.computeKey(*usesPathWithObject),
planCacheWithNoIndexes.computeKey(*doesNotUsePath));
ASSERT_NE(planCache.computeKey(*usesPathWithObject), planCache.computeKey(*doesNotUsePath));
// More complex queries with similar shapes. This is to ensure that plan cache key encoding
// correctly traverses the expression tree.
auto orQueryWithOneBranchAllowed = canonicalize("{$or: [{a: 3}, {a: {$gt: [1,2]}}]}");
// Same shape except 'a' is compared to an object.
auto orQueryWithNoBranchesAllowed =
canonicalize("{$or: [{a: {someobject: 1}}, {a: {$gt: [1,2]}}]}");
// The two queries should have the same shape when no indexes are present, but different shapes
// when a $** index is present.
ASSERT_EQ(planCacheWithNoIndexes.computeKey(*orQueryWithOneBranchAllowed),
planCacheWithNoIndexes.computeKey(*orQueryWithNoBranchesAllowed));
assertPlanCacheKeysUnequalDueToDiscriminators(
planCache.computeKey(*orQueryWithOneBranchAllowed),
planCache.computeKey(*orQueryWithNoBranchesAllowed));
ASSERT_EQ(planCache.computeKey(*orQueryWithOneBranchAllowed).getUnstablePart(), "<1><0>");
ASSERT_EQ(planCache.computeKey(*orQueryWithNoBranchesAllowed).getUnstablePart(), "<0><0>");
}
TEST(PlanCacheTest, ComputeKeyWildcardIndexDiscriminatesEqualityToEmptyObj) {
auto entryProjUpdatePair = makeWildcardUpdate(BSON("a.$**" << 1));
PlanCache planCache;
planCache.notifyOfIndexUpdates({entryProjUpdatePair.first});
// Equality to empty obj and equality to non-empty obj have different plan cache keys.
std::unique_ptr<CanonicalQuery> equalsEmptyObj(canonicalize("{a: {}}"));
std::unique_ptr<CanonicalQuery> equalsNonEmptyObj(canonicalize("{a: {b: 1}}"));
assertPlanCacheKeysUnequalDueToDiscriminators(planCache.computeKey(*equalsEmptyObj),
planCache.computeKey(*equalsNonEmptyObj));
ASSERT_EQ(planCache.computeKey(*equalsNonEmptyObj).getUnstablePart(), "<0>");
ASSERT_EQ(planCache.computeKey(*equalsEmptyObj).getUnstablePart(), "<1>");
// $in with empty obj and $in with non-empty obj have different plan cache keys.
std::unique_ptr<CanonicalQuery> inWithEmptyObj(canonicalize("{a: {$in: [{}]}}"));
std::unique_ptr<CanonicalQuery> inWithNonEmptyObj(canonicalize("{a: {$in: [{b: 1}]}}"));
assertPlanCacheKeysUnequalDueToDiscriminators(planCache.computeKey(*inWithEmptyObj),
planCache.computeKey(*inWithNonEmptyObj));
ASSERT_EQ(planCache.computeKey(*inWithNonEmptyObj).getUnstablePart(), "<0>");
ASSERT_EQ(planCache.computeKey(*inWithEmptyObj).getUnstablePart(), "<1>");
}
TEST(PlanCacheTest, ComputeKeyWildcardDiscriminatesCorrectlyBasedOnPartialFilterExpression) {
BSONObj filterObj = BSON("x" << BSON("$gt" << 0));
std::unique_ptr<MatchExpression> filterExpr(parseMatchExpression(filterObj));
auto entryProjUpdatePair = makeWildcardUpdate(BSON("$**" << 1));
auto indexInfo = std::move(entryProjUpdatePair.first);
indexInfo.filterExpr = filterExpr.get();
PlanCache planCache;
planCache.notifyOfIndexUpdates({indexInfo});
// Test that queries on field 'x' are discriminated based on their relationship with the partial
// filter expression.
{
auto compatibleWithFilter = canonicalize("{x: {$eq: 5}}");
auto incompatibleWithFilter = canonicalize("{x: {$eq: -5}}");
auto compatibleKey = planCache.computeKey(*compatibleWithFilter);
auto incompatibleKey = planCache.computeKey(*incompatibleWithFilter);
assertPlanCacheKeysUnequalDueToDiscriminators(compatibleKey, incompatibleKey);
// The discriminator strings have the format "<xx>". That is, there are two discriminator
// bits for the "x" predicate, the first pertaining to the partialFilterExpression and the
// second around applicability to the wildcard index.
ASSERT_EQ(compatibleKey.getUnstablePart(), "<11>");
ASSERT_EQ(incompatibleKey.getUnstablePart(), "<01>");
}
// The partialFilterExpression should lead to a discriminator over field 'x', but not over 'y'.
// (Separately, there are wildcard-related discriminator bits for both 'x' and 'y'.)
{
auto compatibleWithFilter = canonicalize("{x: {$eq: 5}, y: 1}");
auto incompatibleWithFilter = canonicalize("{x: {$eq: -5}, y: 1}");
auto compatibleKey = planCache.computeKey(*compatibleWithFilter);
auto incompatibleKey = planCache.computeKey(*incompatibleWithFilter);
assertPlanCacheKeysUnequalDueToDiscriminators(compatibleKey, incompatibleKey);
// The discriminator strings have the format "<xx><y>". That is, there are two discriminator
// bits for the "x" predicate (the first pertaining to the partialFilterExpression, the
// second around applicability to the wildcard index) and one discriminator bit for "y".
ASSERT_EQ(compatibleKey.getUnstablePart(), "<11><1>");
ASSERT_EQ(incompatibleKey.getUnstablePart(), "<01><1>");
}
// $eq:null predicates cannot be assigned to a wildcard index. Make sure that this is
// discrimated correctly. This test is designed to reproduce SERVER-48614.
{
auto compatibleQuery = canonicalize("{x: {$eq: 5}, y: 1}");
auto incompatibleQuery = canonicalize("{x: {$eq: 5}, y: null}");
auto compatibleKey = planCache.computeKey(*compatibleQuery);
auto incompatibleKey = planCache.computeKey(*incompatibleQuery);
assertPlanCacheKeysUnequalDueToDiscriminators(compatibleKey, incompatibleKey);
// The discriminator strings have the format "<xx><y>". That is, there are two discriminator
// bits for the "x" predicate (the first pertaining to the partialFilterExpression, the
// second around applicability to the wildcard index) and one discriminator bit for "y".
ASSERT_EQ(compatibleKey.getUnstablePart(), "<11><1>");
ASSERT_EQ(incompatibleKey.getUnstablePart(), "<11><0>");
}
// Test that the discriminators are correct for an $eq:null predicate on 'x'. This predicate is
// imcompatible for two reasons: null equality predicates cannot be answered by wildcard
// indexes, and the predicate is not compatible with the partial filter expression. This should
// result in two "0" bits inside the discriminator string.
{
auto key = planCache.computeKey(*canonicalize("{x: {$eq: null}}"));
ASSERT_EQ(key.getUnstablePart(), "<00>");
}
}
TEST(PlanCacheTest, ComputeKeyWildcardDiscriminatesCorrectlyWithPartialFilterAndExpression) {
// Partial filter is an AND of multiple conditions.
BSONObj filterObj = BSON("x" << BSON("$gt" << 0) << "y" << BSON("$gt" << 0));
std::unique_ptr<MatchExpression> filterExpr(parseMatchExpression(filterObj));
auto entryProjUpdatePair = makeWildcardUpdate(BSON("$**" << 1));
auto indexInfo = std::move(entryProjUpdatePair.first);
indexInfo.filterExpr = filterExpr.get();
PlanCache planCache;
planCache.notifyOfIndexUpdates({indexInfo});
{
// The discriminators should have the format <xx><yy><z>. The 'z' predicate has just one
// discriminator because it is not referenced in the partial filter expression. All
// predicates are compatible.
auto key = planCache.computeKey(*canonicalize("{x: {$eq: 1}, y: {$eq: 2}, z: {$eq: 3}}"));
ASSERT_EQ(key.getUnstablePart(), "<11><11><1>");
}
{
// The discriminators should have the format <xx><yy><z>. The 'y' predicate is not
// compatible with the partial filter expression, leading to one of the 'y' bits being set
// to zero.
auto key = planCache.computeKey(*canonicalize("{x: {$eq: 1}, y: {$eq: -2}, z: {$eq: 3}}"));
ASSERT_EQ(key.getUnstablePart(), "<11><01><1>");
}
}
TEST(PlanCacheTest, ComputeKeyWildcardDiscriminatesCorrectlyWithPartialFilterOnNestedField) {
BSONObj filterObj = BSON("x.y" << BSON("$gt" << 0));
std::unique_ptr<MatchExpression> filterExpr(parseMatchExpression(filterObj));
auto entryProjUpdatePair = makeWildcardUpdate(BSON("$**" << 1));
auto indexInfo = std::move(entryProjUpdatePair.first);
indexInfo.filterExpr = filterExpr.get();
PlanCache planCache;
planCache.notifyOfIndexUpdates({indexInfo});
{
// The discriminators have the format <x><(x.y)(x.y)<y>. All predicates are compatible
auto key =
planCache.computeKey(*canonicalize("{x: {$eq: 1}, y: {$eq: 2}, 'x.y': {$eq: 3}}"));
ASSERT_EQ(key.getUnstablePart(), "<1><11><1>");
}
{
// Here, the predicate on "x.y" is not compatible with the partial filter expression.
auto key =
planCache.computeKey(*canonicalize("{x: {$eq: 1}, y: {$eq: 2}, 'x.y': {$eq: -3}}"));
ASSERT_EQ(key.getUnstablePart(), "<1><01><1>");
}
}
TEST(PlanCacheTest, ComputeKeyDiscriminatesCorrectlyWithPartialFilterAndWildcardProjection) {
BSONObj filterObj = BSON("x" << BSON("$gt" << 0));
std::unique_ptr<MatchExpression> filterExpr(parseMatchExpression(filterObj));
auto entryProjUpdatePair = makeWildcardUpdate(BSON("y.$**" << 1));
auto indexInfo = std::move(entryProjUpdatePair.first);
indexInfo.filterExpr = filterExpr.get();
PlanCache planCache;
planCache.notifyOfIndexUpdates({indexInfo});
{
// The discriminators have the format <x><y>. The discriminator for 'x' indicates whether
// the predicate is compatible with the partial filter expression, whereas the disciminator
// for 'y' is about compatibility with the wildcard index.
auto key = planCache.computeKey(*canonicalize("{x: {$eq: 1}, y: {$eq: 2}, z: {$eq: 3}}"));
ASSERT_EQ(key.getUnstablePart(), "<1><1>");
}
{
// Similar to the previous case, except with an 'x' predicate that is incompatible with the
// partial filter expression.
auto key = planCache.computeKey(*canonicalize("{x: {$eq: -1}, y: {$eq: 2}, z: {$eq: 3}}"));
ASSERT_EQ(key.getUnstablePart(), "<0><1>");
}
{
// Case where the 'y' predicate is not compatible with the wildcard index.
auto key =
planCache.computeKey(*canonicalize("{x: {$eq: 1}, y: {$eq: null}, z: {$eq: 3}}"));
ASSERT_EQ(key.getUnstablePart(), "<1><0>");
}
}
TEST(PlanCacheTest, StableKeyDoesNotChangeAcrossIndexCreation) {
PlanCache planCache;
unique_ptr<CanonicalQuery> cq(canonicalize("{a: 0}}"));
const PlanCacheKey preIndexKey = planCache.computeKey(*cq);
const auto preIndexStableKey = preIndexKey.getStableKey();
ASSERT_EQ(preIndexKey.getUnstablePart(), "");
const auto keyPattern = BSON("a" << 1);
// Create a sparse index (which requires a discriminator).
planCache.notifyOfIndexUpdates(
{CoreIndexInfo(keyPattern,
IndexNames::nameToType(IndexNames::findPluginName(keyPattern)),
true, // sparse
IndexEntry::Identifier{""})}); // name
const PlanCacheKey postIndexKey = planCache.computeKey(*cq);
const auto postIndexStableKey = postIndexKey.getStableKey();
ASSERT_NE(preIndexKey, postIndexKey);
ASSERT_EQ(preIndexStableKey, postIndexStableKey);
ASSERT_EQ(postIndexKey.getUnstablePart(), "<1>");
}
TEST(PlanCacheTest, ComputeKeyNotEqualsArray) {
PlanCache planCache;
unique_ptr<CanonicalQuery> cqNeArray(canonicalize("{a: {$ne: [1]}}"));
unique_ptr<CanonicalQuery> cqNeScalar(canonicalize("{a: {$ne: 123}}"));
const PlanCacheKey noIndexNeArrayKey = planCache.computeKey(*cqNeArray);
const PlanCacheKey noIndexNeScalarKey = planCache.computeKey(*cqNeScalar);
ASSERT_EQ(noIndexNeArrayKey.getUnstablePart(), "<0>");
ASSERT_EQ(noIndexNeScalarKey.getUnstablePart(), "<1>");
ASSERT_EQ(noIndexNeScalarKey.getStableKey(), noIndexNeArrayKey.getStableKey());
const auto keyPattern = BSON("a" << 1);
// Create a normal btree index. It will have a discriminator.
planCache.notifyOfIndexUpdates(
{CoreIndexInfo(keyPattern,
IndexNames::nameToType(IndexNames::findPluginName(keyPattern)),
false, // sparse
IndexEntry::Identifier{""})}); // name
const PlanCacheKey withIndexNeArrayKey = planCache.computeKey(*cqNeArray);
const PlanCacheKey withIndexNeScalarKey = planCache.computeKey(*cqNeScalar);
ASSERT_NE(noIndexNeArrayKey, withIndexNeArrayKey);
ASSERT_EQ(noIndexNeArrayKey.getStableKey(), withIndexNeArrayKey.getStableKey());
ASSERT_EQ(noIndexNeScalarKey.getStableKey(), withIndexNeScalarKey.getStableKey());
// There will be one discriminator for the $not and another for the leaf node ({$eq: 123}).
ASSERT_EQ(withIndexNeScalarKey.getUnstablePart(), "<1><1>");
// There will be one discriminator for the $not and another for the leaf node ({$eq: [1]}).
// Since the index can support equality to an array, the second discriminator will have a value
// of '1'.
ASSERT_EQ(withIndexNeArrayKey.getUnstablePart(), "<0><1>");
}
TEST(PlanCacheTest, ComputeKeyNinArray) {
PlanCache planCache;
unique_ptr<CanonicalQuery> cqNinArray(canonicalize("{a: {$nin: [123, [1]]}}"));
unique_ptr<CanonicalQuery> cqNinScalar(canonicalize("{a: {$nin: [123, 456]}}"));
const PlanCacheKey noIndexNinArrayKey = planCache.computeKey(*cqNinArray);
const PlanCacheKey noIndexNinScalarKey = planCache.computeKey(*cqNinScalar);
ASSERT_EQ(noIndexNinArrayKey.getUnstablePart(), "<0>");
ASSERT_EQ(noIndexNinScalarKey.getUnstablePart(), "<1>");
ASSERT_EQ(noIndexNinScalarKey.getStableKey(), noIndexNinArrayKey.getStableKey());
const auto keyPattern = BSON("a" << 1);
// Create a normal btree index. It will have a discriminator.
planCache.notifyOfIndexUpdates(
{CoreIndexInfo(keyPattern,
IndexNames::nameToType(IndexNames::findPluginName(keyPattern)),
false, // sparse
IndexEntry::Identifier{""})}); // name
const PlanCacheKey withIndexNinArrayKey = planCache.computeKey(*cqNinArray);
const PlanCacheKey withIndexNinScalarKey = planCache.computeKey(*cqNinScalar);
// The unstable part of the key for $nin: [<array>] should have changed. The stable part,
// however, should not.
ASSERT_EQ(noIndexNinArrayKey.getStableKey(), withIndexNinArrayKey.getStableKey());
ASSERT_NE(noIndexNinArrayKey.getUnstablePart(), withIndexNinArrayKey.getUnstablePart());
ASSERT_EQ(noIndexNinScalarKey.getStableKey(), withIndexNinScalarKey.getStableKey());
ASSERT_EQ(withIndexNinArrayKey.getUnstablePart(), "<0><1>");
ASSERT_EQ(withIndexNinScalarKey.getUnstablePart(), "<1><1>");
}
// Test for a bug which would be easy to introduce. If we only inserted discriminators for some
// nodes, we would have a problem. For example if our "stable" key was:
// (or[nt[eqa],nt[eqa]])
// And there was just one discriminator:
// <0>
// Whether the discriminator referred to the first not-eq node or the second would be
// ambiguous. This would make it possible for two queries with different shapes (and different
// plans) to get the same plan cache key. We test that this does not happen for a simple example.
TEST(PlanCacheTest, PlanCacheKeyCollision) {
PlanCache planCache;
unique_ptr<CanonicalQuery> cqNeA(canonicalize("{$or: [{a: {$ne: 5}}, {a: {$ne: [12]}}]}"));
unique_ptr<CanonicalQuery> cqNeB(canonicalize("{$or: [{a: {$ne: [12]}}, {a: {$ne: 5}}]}"));
const PlanCacheKey keyA = planCache.computeKey(*cqNeA);
const PlanCacheKey keyB = planCache.computeKey(*cqNeB);
ASSERT_EQ(keyA.getStableKey(), keyB.getStableKey());
ASSERT_NE(keyA.getUnstablePart(), keyB.getUnstablePart());
const auto keyPattern = BSON("a" << 1);
// Create a normal btree index. It will have a discriminator.
planCache.notifyOfIndexUpdates(
{CoreIndexInfo(keyPattern,
IndexNames::nameToType(IndexNames::findPluginName(keyPattern)),
false, // sparse
IndexEntry::Identifier{""})}); // name
const PlanCacheKey keyAWithIndex = planCache.computeKey(*cqNeA);
const PlanCacheKey keyBWithIndex = planCache.computeKey(*cqNeB);
ASSERT_EQ(keyAWithIndex.getStableKey(), keyBWithIndex.getStableKey());
ASSERT_NE(keyAWithIndex.getUnstablePart(), keyBWithIndex.getUnstablePart());
}
TEST(PlanCacheTest, PlanCacheSizeWithCRUDOperations) {
PlanCache planCache;
unique_ptr<CanonicalQuery> cq(canonicalize("{a: 1, b: 1}"));
auto qs = getQuerySolutionForCaching();
std::vector<QuerySolution*> solns = {qs.get()};
long long previousSize, originalSize = PlanCacheEntry::planCacheTotalSizeEstimateBytes.get();
// Verify that the plan cache size increases after adding new entry to cache.
previousSize = PlanCacheEntry::planCacheTotalSizeEstimateBytes.get();
ASSERT_OK(planCache.set(*cq, solns, createDecision(1U), Date_t{}));
ASSERT_GT(PlanCacheEntry::planCacheTotalSizeEstimateBytes.get(), previousSize);
// Verify that trying to set the same entry won't change the plan cache size.
previousSize = PlanCacheEntry::planCacheTotalSizeEstimateBytes.get();
ASSERT_OK(planCache.set(*cq, solns, createDecision(1U), Date_t{}));
ASSERT_EQ(PlanCacheEntry::planCacheTotalSizeEstimateBytes.get(), previousSize);
// Verify that the plan cache size increases after updating the same entry with more solutions.
solns.push_back(qs.get());
ASSERT_OK(planCache.set(*cq, solns, createDecision(2U), Date_t{}));
ASSERT_GT(PlanCacheEntry::planCacheTotalSizeEstimateBytes.get(), previousSize);
// Verify that the plan cache size decreases after updating the same entry with fewer solutions.
solns.erase(solns.end() - 1);
previousSize = PlanCacheEntry::planCacheTotalSizeEstimateBytes.get();
ASSERT_OK(planCache.set(*cq, solns, createDecision(1U), Date_t{}));
ASSERT_LT(PlanCacheEntry::planCacheTotalSizeEstimateBytes.get(), previousSize);
ASSERT_GT(PlanCacheEntry::planCacheTotalSizeEstimateBytes.get(), originalSize);
// Verify that adding multiple entries will increasing the cache size.
long long sizeWithOneEntry = PlanCacheEntry::planCacheTotalSizeEstimateBytes.get();
std::string queryString = "{a: 1, c: 1}";
for (int i = 0; i < 5; ++i) {
// Update the field name in the query string so that plan cache creates a new entry.
queryString[1] = 'b' + i;
unique_ptr<CanonicalQuery> query(canonicalize(queryString));
previousSize = PlanCacheEntry::planCacheTotalSizeEstimateBytes.get();
ASSERT_OK(planCache.set(*query, solns, createDecision(1U), Date_t{}));
ASSERT_GT(PlanCacheEntry::planCacheTotalSizeEstimateBytes.get(), previousSize);
}
// Verify that removing multiple entries will decreasing the cache size.
for (int i = 0; i < 5; ++i) {
// Update the field name in the query to match the previously created plan cache entry key.
queryString[1] = 'b' + i;
unique_ptr<CanonicalQuery> query(canonicalize(queryString));
previousSize = PlanCacheEntry::planCacheTotalSizeEstimateBytes.get();
ASSERT_OK(planCache.remove(*query));
ASSERT_LT(PlanCacheEntry::planCacheTotalSizeEstimateBytes.get(), previousSize);
}
// Verify that size is reset to the size when there is only entry.
ASSERT_EQ(PlanCacheEntry::planCacheTotalSizeEstimateBytes.get(), sizeWithOneEntry);
// Verify that trying to remove a non-existing key won't change the plan cache size.
previousSize = PlanCacheEntry::planCacheTotalSizeEstimateBytes.get();
unique_ptr<CanonicalQuery> newQuery(canonicalize("{a: 1}"));
ASSERT_NOT_OK(planCache.remove(*newQuery));
ASSERT_EQ(PlanCacheEntry::planCacheTotalSizeEstimateBytes.get(), previousSize);
// Verify that the plan cache size goes back to original size when the entry is removed.
ASSERT_OK(planCache.remove(*cq));
ASSERT_EQ(planCache.size(), 0U);
ASSERT_EQ(PlanCacheEntry::planCacheTotalSizeEstimateBytes.get(), originalSize);
}
TEST(PlanCacheTest, PlanCacheSizeWithEviction) {
const size_t kCacheSize = 5;
PlanCache planCache(kCacheSize);
unique_ptr<CanonicalQuery> cq(canonicalize("{a: 1, b: 1}"));
auto qs = getQuerySolutionForCaching();
std::vector<QuerySolution*> solns = {qs.get(), qs.get()};
long long originalSize = PlanCacheEntry::planCacheTotalSizeEstimateBytes.get();
long long previousSize = PlanCacheEntry::planCacheTotalSizeEstimateBytes.get();
// Add entries until plan cache is full and verify that the size keeps increasing.
std::string queryString = "{a: 1, c: 1}";
for (size_t i = 0; i < kCacheSize; ++i) {
// Update the field name in the query string so that plan cache creates a new entry.
queryString[1]++;
unique_ptr<CanonicalQuery> query(canonicalize(queryString));
previousSize = PlanCacheEntry::planCacheTotalSizeEstimateBytes.get();
ASSERT_OK(planCache.set(*query, solns, createDecision(2U), Date_t{}));
ASSERT_GT(PlanCacheEntry::planCacheTotalSizeEstimateBytes.get(), previousSize);
}
// Verify that adding entry of same size as evicted entry wouldn't change the plan cache size.
queryString = "{k: 1, c: 1}";
cq = unique_ptr<CanonicalQuery>(canonicalize(queryString));
previousSize = PlanCacheEntry::planCacheTotalSizeEstimateBytes.get();
ASSERT_EQ(planCache.size(), kCacheSize);
ASSERT_OK(planCache.set(*cq, solns, createDecision(2U), Date_t{}));
ASSERT_EQ(planCache.size(), kCacheSize);
ASSERT_EQ(PlanCacheEntry::planCacheTotalSizeEstimateBytes.get(), previousSize);
// Verify that adding entry with query bigger than the evicted entry's key should change the
// plan cache size.
queryString = "{k: 1, c: 1, extraField: 1}";
unique_ptr<CanonicalQuery> queryBiggerKey(canonicalize(queryString));
previousSize = PlanCacheEntry::planCacheTotalSizeEstimateBytes.get();
ASSERT_OK(planCache.set(*queryBiggerKey, solns, createDecision(2U), Date_t{}));
ASSERT_GT(PlanCacheEntry::planCacheTotalSizeEstimateBytes.get(), previousSize);
// Verify that adding entry with query solutions larger than the evicted entry's query solutions
// should increase the plan cache size.
queryString = "{l: 1, c: 1}";
cq = unique_ptr<CanonicalQuery>(canonicalize(queryString));
previousSize = PlanCacheEntry::planCacheTotalSizeEstimateBytes.get();
solns.push_back(qs.get());
ASSERT_OK(planCache.set(*cq, solns, createDecision(3U), Date_t{}));
ASSERT_GT(PlanCacheEntry::planCacheTotalSizeEstimateBytes.get(), previousSize);
// Verify that adding entry with query solutions smaller than the evicted entry's query
// solutions should decrease the plan cache size.
queryString = "{m: 1, c: 1}";
cq = unique_ptr<CanonicalQuery>(canonicalize(queryString));
previousSize = PlanCacheEntry::planCacheTotalSizeEstimateBytes.get();
solns = {qs.get()};
ASSERT_OK(planCache.set(*cq, solns, createDecision(1U), Date_t{}));
ASSERT_LT(PlanCacheEntry::planCacheTotalSizeEstimateBytes.get(), previousSize);
// clear() should reset the size.
planCache.clear();
ASSERT_EQ(PlanCacheEntry::planCacheTotalSizeEstimateBytes.get(), originalSize);
}
TEST(PlanCacheTest, PlanCacheSizeWithMultiplePlanCaches) {
PlanCache planCache1;
PlanCache planCache2;
unique_ptr<CanonicalQuery> cq(canonicalize("{a: 1, b: 1}"));
auto qs = getQuerySolutionForCaching();
std::vector<QuerySolution*> solns = {qs.get()};
long long previousSize, originalSize = PlanCacheEntry::planCacheTotalSizeEstimateBytes.get();
// Verify that adding entries to both plan caches will keep increasing the cache size.
std::string queryString = "{a: 1, c: 1}";
for (int i = 0; i < 5; ++i) {
// Update the field name in the query string so that plan cache creates a new entry.
queryString[1] = 'b' + i;
unique_ptr<CanonicalQuery> query(canonicalize(queryString));
previousSize = PlanCacheEntry::planCacheTotalSizeEstimateBytes.get();
ASSERT_OK(planCache1.set(*query, solns, createDecision(1U), Date_t{}));
ASSERT_GT(PlanCacheEntry::planCacheTotalSizeEstimateBytes.get(), previousSize);
previousSize = PlanCacheEntry::planCacheTotalSizeEstimateBytes.get();
ASSERT_OK(planCache2.set(*query, solns, createDecision(1U), Date_t{}));
ASSERT_GT(PlanCacheEntry::planCacheTotalSizeEstimateBytes.get(), previousSize);
}
// Verify that removing entries from one plan caches will keep decreasing the cache size.
for (int i = 0; i < 5; ++i) {
// Update the field name in the query to match the previously created plan cache entry key.
queryString[1] = 'b' + i;
unique_ptr<CanonicalQuery> query(canonicalize(queryString));
previousSize = PlanCacheEntry::planCacheTotalSizeEstimateBytes.get();
ASSERT_OK(planCache1.remove(*query));
ASSERT_LT(PlanCacheEntry::planCacheTotalSizeEstimateBytes.get(), previousSize);
}
// Verify for scoped PlanCache object.
long long sizeBeforeScopedPlanCache = PlanCacheEntry::planCacheTotalSizeEstimateBytes.get();
{
PlanCache planCache;
previousSize = PlanCacheEntry::planCacheTotalSizeEstimateBytes.get();
ASSERT_OK(planCache.set(*cq, solns, createDecision(1U), Date_t{}));
ASSERT_GT(PlanCacheEntry::planCacheTotalSizeEstimateBytes.get(), previousSize);
}
// Verify that size is reset to 'sizeBeforeScopedPlanCache' after the destructor of 'planCache'
// is called.
ASSERT_EQ(PlanCacheEntry::planCacheTotalSizeEstimateBytes.get(), sizeBeforeScopedPlanCache);
// Clear 'planCache2' to remove all entries.
previousSize = PlanCacheEntry::planCacheTotalSizeEstimateBytes.get();
planCache2.clear();
ASSERT_LT(PlanCacheEntry::planCacheTotalSizeEstimateBytes.get(), previousSize);
// Verify that size is reset to the original size after removing all entries.
ASSERT_EQ(PlanCacheEntry::planCacheTotalSizeEstimateBytes.get(), originalSize);
}
} // namespace
|