summaryrefslogtreecommitdiff
path: root/jstests/core/timeseries/timeseries_predicates.js
blob: 5499c060eea9828f5edcda3dd099b782e0eb934e (plain)
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
/**
 * Test the input/output behavior of some predicates on time-series collections.
 *
 * @tags: [
 *   # This test depends on certain writes ending up in the same bucket. Stepdowns may result in
 *   # writes splitting between two primaries, and thus different buckets.
 *   does_not_support_stepdowns,
 *   # We need a timeseries collection.
 *   requires_timeseries,
 * ]
 */
(function() {
"use strict";

load("jstests/core/timeseries/libs/timeseries.js");

const coll = db.timeseries_predicates_normal;
const tsColl = db.timeseries_predicates_timeseries;
coll.drop();
tsColl.drop();
assert.commandWorked(
    db.createCollection(tsColl.getName(), {timeseries: {timeField: 'time', metaField: 'meta'}}));
const bucketsColl = db.getCollection('system.buckets.' + tsColl.getName());

// Test that 'predicate' behaves correctly on the example documents,
// by comparing the result on a time-series collection against a normal collection.
function checkPredicateResult(predicate, documents) {
    assert.commandWorked(coll.deleteMany({}));
    assert.commandWorked(bucketsColl.deleteMany({}));
    assert.commandWorked(coll.insert(documents));
    assert.commandWorked(tsColl.insert(documents));

    const normalResult = coll.aggregate({$match: predicate}).toArray();
    const tsResult = tsColl.aggregate({$match: predicate}).toArray();
    assert.sameMembers(normalResult, tsResult);
}

// Test that 'predicate' behaves correctly, no matter how the documents are bucketed:
// insert the documents with different combinations of metadata to change how they are bucketed.
// 'documents' should be small, since this runs 2^N tests.
function checkAllBucketings(predicate, documents) {
    for (const doc of documents) {
        doc._id = ObjectId();
        doc.time = doc.time || ISODate();
    }

    // For N documents, there are 2^N ways to assign them to buckets A and B.
    const numDocs = documents.length;
    const numBucketings = 1 << numDocs;
    for (let bucketing = 0; bucketing < numBucketings; ++bucketing) {
        // The ith bit tells you how to assign documents[i].
        const labeledDocs = documents.map(
            (doc, i) => Object.merge(doc, {meta: {bucket: bucketing & (1 << i)}}, true /*deep*/));
        checkPredicateResult(predicate, labeledDocs);
    }
}

// Test $in...
{
    // ... with a simple list of equalities.
    checkAllBucketings({x: {$in: [2, 3, 4]}}, [
        {x: 1},
        {x: 2},
        {x: 3},
        {x: 42},
    ]);

    // ... with equalities which contain an array.
    checkAllBucketings({x: {$in: [1, [2, 3, 4], 5]}}, [
        {},
        {x: 1},
        {x: 2},
        {x: [2, 3]},
        {x: [2, 3, 4]},
        {x: 5},
        {x: 42},
    ]);
}

// $exists: true
checkAllBucketings({x: {$exists: true}}, [
    {},
    {x: 2},
    {x: ISODate()},
    {x: null},
    {x: undefined},
]);

// Test $or...
{
    // ... on metric + meta.
    checkAllBucketings({
        $or: [
            {x: {$lt: 0}},
            {'meta.y': {$gt: 0}},
        ]
    },
                       [
                           {x: +1, meta: {y: -1}},
                           {x: +1, meta: {y: +1}},
                           {x: -1, meta: {y: -1}},
                           {x: -1, meta: {y: +1}},
                       ]);

    // ... when one argument can't be pushed down.
    checkAllBucketings({
        $or: [
            {x: {$lt: 0}},
            {y: {$exists: false}},
        ]
    },
                       [
                           {x: -1},
                           {x: +1},
                           {x: -1, y: 'asdf'},
                           {x: +1, y: 'asdf'},
                       ]);

    // ... when neither argument can be pushed down.
    checkAllBucketings({
        $or: [
            {x: {$exists: false}},
            {y: {$exists: false}},
        ]
    },
                       [
                           {},
                           {x: 'qwer'},
                           {y: 'asdf'},
                           {x: 'qwer', y: 'asdf'},
                       ]);
}

// Test $and...
{
    // ... on metric + meta.
    checkAllBucketings({
        $and: [
            {x: {$lt: 0}},
            {'meta.y': {$gt: 0}},
        ]
    },
                       [
                           {x: +1, meta: {y: -1}},
                           {x: +1, meta: {y: +1}},
                           {x: -1, meta: {y: -1}},
                           {x: -1, meta: {y: +1}},
                       ]);

    // ... when one argument can't be pushed down.
    checkAllBucketings({
        $and: [
            {x: {$lt: 0}},
            {y: {$exists: false}},
        ]
    },
                       [
                           {x: -1},
                           {x: +1},
                           {x: -1, y: 'asdf'},
                           {x: +1, y: 'asdf'},
                       ]);

    // ... when neither argument can be pushed down.
    checkAllBucketings({
        $and: [
            {x: {$exists: false}},
            {y: {$exists: false}},
        ]
    },
                       [
                           {},
                           {x: 'qwer'},
                           {y: 'asdf'},
                           {x: 'qwer', y: 'asdf'},
                       ]);
}

// Test nested $and / $or.
checkAllBucketings({
    // The top-level $or prevents us from splitting into 2 top-level $match stages.
    $or: [
        {
            $and: [
                {'meta.a': {$gt: 0}},
                {'x': {$lt: 0}},
            ]
        },
        {
            $and: [
                {'meta.b': {$gte: 0}},
                {time: {$gt: ISODate('2020-01-01')}},
            ]
        },
    ]
},
                   [
                       {meta: {a: -1, b: -1}, x: -1, time: ISODate('2020-02-01')},
                       {meta: {a: -1, b: -1}, x: -1, time: ISODate('2019-12-31')},
                       {meta: {a: -1, b: -1}, x: +1, time: ISODate('2020-02-01')},
                       {meta: {a: -1, b: -1}, x: +1, time: ISODate('2019-12-31')},

                       {meta: {a: +1, b: -1}, x: -1, time: ISODate('2020-02-01')},
                       {meta: {a: +1, b: -1}, x: -1, time: ISODate('2019-12-31')},
                       {meta: {a: +1, b: -1}, x: +1, time: ISODate('2020-02-01')},
                       {meta: {a: +1, b: -1}, x: +1, time: ISODate('2019-12-31')},
                   ]);

// Test nested $and / $or where some leaf predicates cannot be pushed down.
checkAllBucketings({
    $or: [
        {
            $and: [
                {'meta.a': {$gt: 0}},
                {'x': {$exists: false}},
            ]
        },
        {
            $and: [
                {'meta.b': {$gte: 0}},
                {time: {$gt: ISODate('2020-01-01')}},
            ]
        },
    ]
},
                   [
                       {meta: {a: -1, b: -1}, time: ISODate('2020-02-01')},
                       {meta: {a: -1, b: -1}, time: ISODate('2019-12-31')},
                       {meta: {a: -1, b: -1}, x: 'asdf', time: ISODate('2020-02-01')},
                       {meta: {a: -1, b: -1}, x: 'asdf', time: ISODate('2019-12-31')},

                       {meta: {a: +1, b: -1}, time: ISODate('2020-02-01')},
                       {meta: {a: +1, b: -1}, time: ISODate('2019-12-31')},
                       {meta: {a: +1, b: -1}, x: 'asdf', time: ISODate('2020-02-01')},
                       {meta: {a: +1, b: -1}, x: 'asdf', time: ISODate('2019-12-31')},
                   ]);

// Test $exists on meta, inside $or.
checkAllBucketings({
    $or: [
        {"meta.a": {$exists: true}},
        {"x": {$gt: 2}},
    ]
},
                   [
                       {meta: {a: 1}, x: 1},
                       {meta: {a: 2}, x: 2},
                       {meta: {a: 3}, x: 3},
                       {meta: {a: 4}, x: 4},
                       {meta: {}, x: 1},
                       {meta: {}, x: 2},
                       {meta: {}, x: 3},
                       {meta: {}, x: 4},
                   ]);

// Test $in on meta, inside $or.
checkAllBucketings({
    $or: [
        {"meta.a": {$in: [1, 3]}},
        {"x": {$gt: 2}},
    ]
},
                   [
                       {meta: {a: 1}, x: 1},
                       {meta: {a: 2}, x: 2},
                       {meta: {a: 3}, x: 3},
                       {meta: {a: 4}, x: 4},
                       {meta: {}, x: 1},
                       {meta: {}, x: 2},
                       {meta: {}, x: 3},
                       {meta: {}, x: 4},
                   ]);

// Test geo predicates on meta, inside $or.
for (const pred of ['$geoWithin', '$geoIntersects']) {
    checkAllBucketings({
        $or: [
            {
                "meta.location": {
                    [pred]: {
                        $geometry: {
                            type: "Polygon",
                            coordinates: [[
                                [0, 0],
                                [0, 3],
                                [3, 3],
                                [3, 0],
                                [0, 0],
                            ]]
                        }
                    }
                }
            },
            {x: {$gt: 2}},
        ]
    },
                       [
                           {meta: {location: [1, 1]}, x: 1},
                           {meta: {location: [1, 1]}, x: 2},
                           {meta: {location: [1, 1]}, x: 3},
                           {meta: {location: [1, 1]}, x: 4},
                           {meta: {location: [5, 5]}, x: 1},
                           {meta: {location: [5, 5]}, x: 2},
                           {meta: {location: [5, 5]}, x: 3},
                           {meta: {location: [5, 5]}, x: 4},
                       ]);
}

// Test $mod on meta, inside $or.
// $mod is an example of a predicate that we don't handle specially in time-series optimizations:
// it can be pushed down if and only if it's on a metadata field.
checkAllBucketings({
    $or: [
        {"meta.a": {$mod: [2, 0]}},
        {"x": {$gt: 4}},
    ]
},
                   [
                       {meta: {a: 1}, x: 1},
                       {meta: {a: 2}, x: 2},
                       {meta: {a: 3}, x: 3},
                       {meta: {a: 4}, x: 4},
                       {meta: {a: 5}, x: 5},
                       {meta: {a: 6}, x: 6},
                       {meta: {a: 7}, x: 7},
                       {meta: {a: 8}, x: 8},
                   ]);

// Test $elemMatch on meta, inside $or.
checkAllBucketings({
    $or: [
        {"meta.a": {$elemMatch: {b: 3}}},
        {"x": {$gt: 4}},
    ]
},
                   [
                       {x: 1, meta: {a: []}},
                       {x: 2, meta: {a: [{b: 2}]}},
                       {x: 3, meta: {a: [{b: 3}]}},
                       {x: 4, meta: {a: [{b: 2}, {b: 3}]}},
                       {x: 5, meta: {a: []}},
                       {x: 6, meta: {a: [{b: 2}]}},
                       {x: 7, meta: {a: [{b: 3}]}},
                       {x: 8, meta: {a: [{b: 2}, {b: 3}]}},
                   ]);
checkAllBucketings({
    $or: [
        {"meta.a": {$elemMatch: {b: 2, c: 3}}},
        {"x": {$gt: 3}},
    ]
},
                   [
                       {x: 1, meta: {a: []}},
                       {x: 2, meta: {a: [{b: 2, c: 3}]}},
                       {x: 3, meta: {a: [{b: 2}, {c: 3}]}},
                       {x: 4, meta: {a: []}},
                       {x: 5, meta: {a: [{b: 2, c: 3}]}},
                       {x: 6, meta: {a: [{b: 2}, {c: 3}]}},
                   ]);
})();