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
|
/**
* Tests that $lookup respects the user-specified collation or the inherited local collation
* when performing comparisons on a foreign collection with a different default collation. Exercises
* the fix for SERVER-43350.
*
* Collation can be set at three different levels for $lookup stage
* 1. on the local collection (collation on the foreign collection is always ignored)
* 2. on the $lookup stage via '_internalCollation' property
* 3. on the aggregation command via 'collation' property in options
*
* The three settings have the following precedence:
* 1. '_internalCollation' overrides all others
* 2. 'collation' option overrides local collection's collation
*/
load("jstests/aggregation/extras/utils.js"); // For anyEq.
load("jstests/libs/analyze_plan.js"); // For getAggPlanStages, getWinningPlan.
(function() {
"use strict";
load("jstests/libs/fixture_helpers.js"); // For isSharded.
const testDB = db.getSiblingDB(jsTestName());
assert.commandWorked(testDB.dropDatabase());
const caseInsensitive = {
locale: "en_US",
strength: 1
};
const caseSensitive = {
locale: "simple"
};
// When no collation is specified for a collection, it uses the default, case-sensitive collation.
assert.commandWorked(testDB.createCollection("case_sensitive"));
const collAa = testDB.case_sensitive;
assert.commandWorked(testDB.createCollection("case_sensitive_indexed"));
const collAa_indexed = testDB.case_sensitive_indexed;
assert.commandWorked(testDB.createCollection("case_insensitive", {collation: caseInsensitive}));
const collAA = testDB.case_insensitive;
// Do not run the rest of the tests if the foreign collection is implicitly sharded but the flag to
// allow $lookup/$graphLookup into a sharded collection is disabled.
const getShardedLookupParam = db.adminCommand({getParameter: 1, featureFlagShardedLookup: 1});
const isShardedLookupEnabled = getShardedLookupParam.hasOwnProperty("featureFlagShardedLookup") &&
getShardedLookupParam.featureFlagShardedLookup.value;
if (FixtureHelpers.isSharded(collAA) && !isShardedLookupEnabled) {
return;
}
const records = [{_id: 0, key: "a"}, {_id: 1, key: "A"}];
assert.commandWorked(collAa.insert(records));
assert.commandWorked(collAA.insert(records));
assert.commandWorked(collAa_indexed.insert(records));
// Create two indexes to check the one with a matching collation will be chosen even if it has a
// longer key pattern.
assert.commandWorked(collAa_indexed.createIndex({key: 1}));
assert.commandWorked(collAa_indexed.createIndex({key: 1, x: 1}, {collation: caseInsensitive}));
const lookupWithPipeline = (foreignColl) => {
return {
$lookup: {
from: foreignColl.getName(),
as: "matched",
let: {l_key: "$key"},
pipeline: [{$match: {$expr: {$eq: ["$key", "$$l_key"]}}}]
}
};
};
const lookupNoPipeline = (foreignColl) => {
return {
$lookup:
{from: foreignColl.getName(), localField: "key", foreignField: "key", as: "matched"}
};
};
const resultCaseSensistive = [
{_id: 0, key: "a", matched: [{_id: 0, key: "a"}]},
{_id: 1, key: "A", matched: [{_id: 1, key: "A"}]},
];
const resultCaseInsensitive = [
{_id: 0, key: "a", matched: [{_id: 0, key: "a"}, {_id: 1, key: "A"}]},
{_id: 1, key: "A", matched: [{_id: 0, key: "a"}, {_id: 1, key: "A"}]},
];
let results = [];
let explain;
// Collation on the foreign collection should be ignored.
(function testLocalCollationPrecedence() {
for (let lookupInto of [lookupWithPipeline, lookupNoPipeline]) {
results = collAa.aggregate([lookupInto(collAA)]).toArray();
assertArrayEq({
actual: results,
expected: resultCaseSensistive,
extraErrorMsg: " Default collation on local, running: " + tojson(lookupInto)
});
results = collAA.aggregate([lookupInto(collAa)], {allowDiskUse: false}).toArray();
assertArrayEq({
actual: results,
expected: resultCaseInsensitive,
extraErrorMsg: " Case-insensitive collation on local, running: " + tojson(lookupInto)
});
// When lowering to SBE a different join algorithm (HashJoin) is used if 'allowDiskUse' is
// set to true. We only need to verify the collation of HJ once, because it works the same
// independent of how the collation is chosen.
results = collAA.aggregate([lookupInto(collAa)], {allowDiskUse: true}).toArray();
assertArrayEq({
actual: results,
expected: resultCaseInsensitive,
extraErrorMsg: " Case-insensitive collation on local, disk use allowed, running: " +
tojson(lookupInto)
});
}
})();
// Collation at the command level should override collation of the local collection.
(function testCommandCollationPrecedence() {
for (let lookupInto of [lookupWithPipeline, lookupNoPipeline]) {
results = collAa.aggregate([lookupInto(collAa)], {collation: caseInsensitive}).toArray();
assertArrayEq({
actual: results,
expected: resultCaseInsensitive,
extraErrorMsg: " Case-insensitive collation on command, running: " + tojson(lookupInto)
});
results = collAA.aggregate([lookupInto(collAa)], {collation: caseSensitive}).toArray();
assertArrayEq({
actual: results,
expected: resultCaseSensistive,
extraErrorMsg: " Case-sensitive collation on command, running: " + tojson(lookupInto)
});
}
})();
// Collation set on $lookup stage with '_internalCollation' should override collation of the local
// collection and on the command.
(function testStageCollationPrecedence() {
for (let lookupInto of [lookupWithPipeline, lookupNoPipeline]) {
let lookupStage = lookupInto(collAa);
lookupStage.$lookup._internalCollation = caseInsensitive;
results = collAa.aggregate([lookupStage], {collation: caseSensitive}).toArray();
assertArrayEq({
actual: results,
expected: resultCaseInsensitive,
extraErrorMsg: " Case-insensitive collation on stage, running: " + tojson(lookupInto)
});
lookupStage.$lookup._internalCollation = caseSensitive;
results = collAA.aggregate([lookupStage], {collation: caseInsensitive}).toArray();
assertArrayEq({
actual: results,
expected: resultCaseSensistive,
extraErrorMsg: " Case-sensitive collation on stage, running: " + tojson(lookupInto)
});
}
})();
// In presense of indexes lookup might choose a different strategy for the join, that relies on the
// index (INLJ). It should respect the effective collation of $lookup.
(function testCollationWithIndexes() {
function assertIndexJoinStrategy(explain) {
// Check join strategy when $lookup is pushed down.
if (getAggPlanStages(explain, "$cursor").length === 0) {
const winningPlan = getWinningPlan(explain.queryPlanner);
assert.eq("EQ_LOOKUP", winningPlan.stage, explain);
assert.eq("IndexedLoopJoin", winningPlan.strategy, explain);
// Will choose the index with the matching collation.
assert.eq("key_1_x_1", winningPlan.indexName, explain);
}
}
function assertNestedLoopJoinStrategy(explain) {
// Check join strategy when $lookup is pushed down.
if (getAggPlanStages(explain, "$cursor").length === 0) {
const winningPlan = getWinningPlan(explain.queryPlanner);
assert.eq("EQ_LOOKUP", winningPlan.stage, explain);
assert.eq("NestedLoopJoin", winningPlan.strategy, explain);
}
}
for (let lookupInto of [lookupWithPipeline, lookupNoPipeline]) {
// Local and foreign have different collations.
results = collAA.aggregate([lookupInto(collAa_indexed)]).toArray();
assertArrayEq({
actual: results,
expected: resultCaseInsensitive,
extraErrorMsg: " Case-insensitive collation on local, foreign is indexed, running: " +
tojson(lookupInto)
});
explain = collAA.explain().aggregate([lookupInto(collAa_indexed)]);
assertIndexJoinStrategy(explain);
// Command-level collation overrides collection-level collation.
results =
collAa.aggregate([lookupInto(collAa_indexed)], {collation: caseInsensitive}).toArray();
assertArrayEq({
actual: results,
expected: resultCaseInsensitive,
extraErrorMsg: " Case-insensitive collation on command, foreign is indexed, running: " +
tojson(lookupInto)
});
explain =
collAa.explain().aggregate([lookupInto(collAa_indexed)], {collation: caseInsensitive});
assertIndexJoinStrategy(explain);
// If no index is compatible with the requested collation and disk use is not allowed,
// nested loop join will be chosen instead.
explain = collAa.explain().aggregate([lookupInto(collAa_indexed)],
{collation: {locale: "fr"}, allowDiskUse: false});
assertNestedLoopJoinStrategy(explain);
// Stage-level collation overrides collection-level and command-level collations.
let lookupStage = lookupInto(collAa_indexed);
lookupStage.$lookup._internalCollation = caseInsensitive;
results = collAa.aggregate([lookupStage], {collation: caseSensitive}).toArray();
assertArrayEq({
actual: results,
expected: resultCaseInsensitive,
extraErrorMsg: " Case-insensitive collation on stage, foreign is indexed, running: " +
tojson(lookupInto)
});
explain = collAa.explain().aggregate([lookupStage], {collation: caseSensitive});
assertIndexJoinStrategy(explain);
}
})();
})();
|
