File: query_cache_spec.rb

package info (click to toggle)
ruby-mongo 2.21.3-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 14,764 kB
  • sloc: ruby: 108,806; makefile: 5; sh: 2
file content (471 lines) | stat: -rw-r--r-- 13,568 bytes parent folder | download
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
# frozen_string_literal: true
# rubocop:todo all

require 'spec_helper'

describe Mongo::QueryCache do

  around do |spec|
    Mongo::QueryCache.clear
    Mongo::QueryCache.cache { spec.run }
  end

  before do
    authorized_collection.delete_many
  end

  let(:subscriber) { Mrss::EventSubscriber.new }

  let(:client) do
    authorized_client.tap do |client|
      client.subscribe(Mongo::Monitoring::COMMAND, subscriber)
    end
  end

  let(:authorized_collection) { client['collection_spec'] }

  let(:events) do
    subscriber.command_started_events('find')
  end

  describe '#enabled' do

    context 'when query cache is disabled' do

      before do
        Mongo::QueryCache.enabled = false
      end

      it 'disables the query cache' do
        expect(Mongo::QueryCache.enabled?).to be(false)
      end
    end

    context 'when query cache is enabled' do

      before do
        Mongo::QueryCache.enabled = true
      end

      it 'enables the query cache' do
        expect(Mongo::QueryCache.enabled?).to be(true)
      end
    end
  end

  describe '#cache' do

    before do
      Mongo::QueryCache.enabled = false
    end

    it 'enables the query cache inside the block' do
      Mongo::QueryCache.cache do
        expect(Mongo::QueryCache.enabled?).to be(true)
      end
      expect(Mongo::QueryCache.enabled?).to be(false)
    end
  end

  describe '#uncached' do

    it 'disables the query cache inside the block' do
      Mongo::QueryCache.uncached do
        expect(Mongo::QueryCache.enabled?).to be(false)
      end
      expect(Mongo::QueryCache.enabled?).to be(true)
    end
  end

  describe '#cache_table' do

    before do
      authorized_collection.insert_one({ name: 'testing' })
      authorized_collection.find(name: 'testing').to_a
    end

    it 'gets the cached query' do
      expect(Mongo::QueryCache.send(:cache_table).length).to eq(1)
      authorized_collection.find(name: 'testing').to_a
      expect(events.length).to eq(1)
    end
  end

  describe '#clear' do

    before do
      authorized_collection.insert_one({ name: 'testing' })
      authorized_collection.find(name: 'testing').to_a
    end

    it 'clears the cache' do
      expect(Mongo::QueryCache.send(:cache_table).length).to eq(1)
      Mongo::QueryCache.clear
      expect(Mongo::QueryCache.send(:cache_table).length).to eq(0)
    end
  end

  describe '#set' do
    let(:caching_cursor) { double("Mongo::CachingCursor") }
    let(:namespace) { 'db.coll' }
    let(:selector) { { field: 'value' } }
    let(:skip) { 5 }
    let(:sort) { { field: 'asc' } }
    let(:limit) { 5 }
    let(:projection) { { field: 1 } }
    let(:collation) { { locale: 'fr_CA' } }
    let(:read_concern) { { level: :majority } }
    let(:read_preference) { { mode: :secondary } }

    let(:options) do
      {
        namespace: namespace,
        selector: selector,
        skip: skip,
        sort: sort,
        limit: limit,
        projection: projection,
        collation: collation,
        read_concern: read_concern,
        read_preference: read_preference,
      }
    end

    it 'stores the cursor at the correct key' do
      Mongo::QueryCache.set(caching_cursor, **options)
      expect(Mongo::QueryCache.send(:cache_table)[namespace][[namespace, selector, skip, sort, projection, collation, read_concern, read_preference]]).to eq(caching_cursor)
    end
  end

  describe '#get' do
    let(:view) do
      double("Mongo::Collection::View").tap do |view|
        allow(view).to receive(:client).and_return(client)
        allow(view).to receive(:operation_timeouts).and_return({})
      end
    end

    let(:result) do
      double("Mongo::Operation::Result").tap do |result|
        allow(result).to receive(:is_a?).with(Mongo::Operation::Result).and_return(true)
      end
    end

    let(:server) { double("Mongo::Server") }
    let(:caching_cursor) { Mongo::CachingCursor.new(view, result, server) }

    let(:options) do
      {
        namespace: 'db.coll',
        selector: { field: 'value' },
      }
    end

    before do
      allow(result).to receive(:cursor_id) { 0 }
      allow(result).to receive(:namespace) { 'db.coll' }
      allow(result).to receive(:connection_global_id) { 1 }
      allow(view).to receive(:limit) { nil }
    end

    [true, false].each do |load_balancer|
      context "when load_balancer is #{load_balancer}" do
        before do
          allow(server).to receive(:load_balancer?) { load_balancer }
          if load_balancer
            allow(result).to receive(:connection) { nil }
          end
        end

        context 'when there is no entry in the cache' do
          it 'returns nil' do
            expect(Mongo::QueryCache.get(**options)).to be_nil
          end
        end

        context 'when there is an entry in the cache' do
          before do
            Mongo::QueryCache.set(caching_cursor, **caching_cursor_options)
          end

          context 'when that entry has no limit' do
            let(:caching_cursor_options) do
              {
                namespace: 'db.coll',
                selector: { field: 'value' },
              }
            end

            let(:query_options) do
              caching_cursor_options.merge(limit: limit)
            end

            context 'when the query has a limit' do
              let(:limit) { 5 }

              it 'returns the caching cursor' do
                expect(Mongo::QueryCache.get(**query_options)).to eq(caching_cursor)
              end
            end

            context 'when the query has a limit but negative' do
              let(:limit) { -5 }

              it 'returns the caching cursor' do
                expect(Mongo::QueryCache.get(**query_options)).to eq(caching_cursor)
              end
            end

            context 'when the query has no limit' do
              let(:limit) { nil }

              it 'returns the caching cursor' do
                expect(Mongo::QueryCache.get(**query_options)).to eq(caching_cursor)
              end
            end

            context 'when the query has a 0 limit' do
              let(:limit) { 0 }

              it 'returns the caching cursor' do
                expect(Mongo::QueryCache.get(**query_options)).to eq(caching_cursor)
              end
            end
          end

          context 'when that entry has a 0 limit' do
            let(:caching_cursor_options) do
              {
                namespace: 'db.coll',
                selector: { field: 'value' },
                limit: 0,
              }
            end

            let(:query_options) do
              caching_cursor_options.merge(limit: limit)
            end

            before do
              allow(view).to receive(:limit) { 0 }
            end

            context 'when the query has a limit' do
              let(:limit) { 5 }

              it 'returns the caching cursor' do
                expect(Mongo::QueryCache.get(**query_options)).to eq(caching_cursor)
              end
            end

            context 'when the query has a limit but negative' do
              let(:limit) { -5 }

              it 'returns the caching cursor' do
                expect(Mongo::QueryCache.get(**query_options)).to eq(caching_cursor)
              end
            end


            context 'when the query has no limit' do
              let(:limit) { nil }

              it 'returns the caching cursor' do
                expect(Mongo::QueryCache.get(**query_options)).to eq(caching_cursor)
              end
            end

            context 'when the query has a 0 limit' do
              let(:limit) { 0 }

              it 'returns the caching cursor' do
                expect(Mongo::QueryCache.get(**query_options)).to eq(caching_cursor)
              end
            end
          end

          context 'when that entry has a limit' do
            let(:caching_cursor_options) do
              {
                namespace: 'db.coll',
                selector: { field: 'value' },
                limit: 5,
              }
            end

            let(:query_options) do
              caching_cursor_options.merge(limit: limit)
            end

            before do
              allow(view).to receive(:limit) { 5 }
            end

            context 'and the new query has a smaller limit' do
              let(:limit) { 4 }

              it 'returns the caching cursor' do
                expect(Mongo::QueryCache.get(**query_options)).to eq(caching_cursor)
              end
            end

            context 'and the new query has a smaller limit but negative' do
              let(:limit) { -4 }

              it 'returns the caching cursor' do
                expect(Mongo::QueryCache.get(**query_options)).to eq(caching_cursor)
              end
            end

            context 'and the new query has a larger limit' do
              let(:limit) { 6 }

              it 'returns nil' do
                expect(Mongo::QueryCache.get(**query_options)).to be_nil
              end
            end

            context 'and the new query has a larger limit but negative' do
              let(:limit) { -6 }

              it 'returns nil' do
                expect(Mongo::QueryCache.get(**query_options)).to be_nil
              end
            end

            context 'and the new query has the same limit' do
              let(:limit) { 5 }

              it 'returns the caching cursor' do
                expect(Mongo::QueryCache.get(**query_options)).to eq(caching_cursor)
              end
            end

            context 'and the new query has the same limit but negative' do
              let(:limit) { -5 }

              it 'returns the caching cursor' do
                expect(Mongo::QueryCache.get(**query_options)).to eq(caching_cursor)
              end
            end

            context 'and the new query has no limit' do
              let(:limit) { nil }

              it 'returns nil' do
                expect(Mongo::QueryCache.get(**query_options)).to be_nil
              end
            end

            context 'and the new query has a 0 limit' do
              let(:limit) { 0 }

              it 'returns nil' do
                expect(Mongo::QueryCache.get(**query_options)).to be_nil
              end
            end
          end

          context 'when that entry has a negative limit' do
            let(:caching_cursor_options) do
              {
                namespace: 'db.coll',
                selector: { field: 'value' },
                limit: -5,
              }
            end

            let(:query_options) do
              caching_cursor_options.merge(limit: limit)
            end

            before do
              allow(view).to receive(:limit) { -5 }
            end

            context 'and the new query has a smaller limit' do
              let(:limit) { 4 }

              it 'returns the caching cursor' do
                expect(Mongo::QueryCache.get(**query_options)).to eq(caching_cursor)
              end
            end

            context 'and the new query has a larger limit' do
              let(:limit) { 6 }

              it 'returns nil' do
                expect(Mongo::QueryCache.get(**query_options)).to be_nil
              end
            end

            context 'and the new query has the same negative limit' do
              let(:limit) { -5 }

              it 'returns the caching cursor' do
                expect(Mongo::QueryCache.get(**query_options)).to eq(caching_cursor)
              end
            end

            context 'and the new query has the same positive limit' do
              let(:limit) { 5 }

              it 'returns the caching cursor' do
                expect(Mongo::QueryCache.get(**query_options)).to eq(caching_cursor)
              end
            end

            context 'and the new query has no limit' do
              let(:limit) { nil }

              it 'returns nil' do
                expect(Mongo::QueryCache.get(**query_options)).to be_nil
              end
            end

            context 'and the new query has a 0 limit' do
              let(:limit) { 0 }

              it 'returns nil' do
                expect(Mongo::QueryCache.get(**query_options)).to be_nil
              end
            end
          end
        end
      end
    end
  end

  describe '#clear_namespace' do
    let(:caching_cursor) { double("Mongo::CachingCursor") }
    let(:namespace1) { 'db.coll' }
    let(:namespace2) { 'db.coll2' }
    let(:namespace3) { 'db.coll3' }
    let(:selector) { { field: 'value' } }

    before do
      Mongo::QueryCache.set(caching_cursor, namespace: namespace1, selector: selector)
      Mongo::QueryCache.set(caching_cursor, namespace: namespace2, selector: selector)
      Mongo::QueryCache.set(caching_cursor, namespace: namespace3, selector: selector, multi_collection: true)
    end

    it 'returns nil' do
      expect(Mongo::QueryCache.clear_namespace(namespace1)).to be_nil
    end

    it 'clears the specified namespace in the query cache' do
      Mongo::QueryCache.clear_namespace(namespace1)
      expect(Mongo::QueryCache.send(:cache_table)[namespace1]).to be_nil
    end

    it 'does not clear other namespaces in the query cache' do
      Mongo::QueryCache.clear_namespace(namespace1)
      expect(Mongo::QueryCache.send(:cache_table)[namespace2]).not_to be_nil
    end

    it 'clears the nil namespace' do
      Mongo::QueryCache.clear_namespace(namespace1)
      expect(Mongo::QueryCache.send(:cache_table)[nil]).to be_nil
    end
  end
end