Welcome to mirror list, hosted at ThFree Co, Russian Federation.

caching_spec.rb « helpers « api « lib « spec - gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: a8cd061e12307f94edd2672a96a9a1b33e209684 (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
# frozen_string_literal: true

require "spec_helper"

RSpec.describe API::Helpers::Caching do
  subject(:instance) { Class.new.include(described_class).new }

  describe "#present_cached" do
    let_it_be(:project) { create(:project) }
    let_it_be(:user) { create(:user) }

    let(:presenter) { API::Entities::Todo }

    let(:kwargs) do
      {
        with: presenter,
        project: project
      }
    end

    subject do
      instance.present_cached(presentable, **kwargs)
    end

    before do
      # We have to stub #body as it's a Grape method
      # unavailable in the module by itself
      expect(instance).to receive(:body) do |data|
        data
      end

      allow(instance).to receive(:current_user) { user }
    end

    context "single object" do
      let_it_be(:presentable) { create(:todo, project: project) }

      it { is_expected.to be_a(Gitlab::Json::PrecompiledJson) }

      it "uses the presenter" do
        expect(presenter).to receive(:represent).with(presentable, project: project)

        subject
      end

      it "is valid JSON" do
        parsed = Gitlab::Json.parse(subject.to_s)

        expect(parsed).to be_a(Hash)
        expect(parsed["id"]).to eq(presentable.id)
      end

      it "fetches from the cache" do
        expect(instance.cache).to receive(:fetch).with("#{presentable.cache_key}:#{user.cache_key}", expires_in: described_class::DEFAULT_EXPIRY).once

        subject
      end

      context "when a cache context is supplied" do
        before do
          kwargs[:cache_context] = -> (todo) { todo.project.cache_key }
        end

        it "uses the context to augment the cache key" do
          expect(instance.cache).to receive(:fetch).with("#{presentable.cache_key}:#{project.cache_key}", expires_in: described_class::DEFAULT_EXPIRY).once

          subject
        end
      end

      context "when expires_in is supplied" do
        it "sets the expiry when accessing the cache" do
          kwargs[:expires_in] = 7.days

          expect(instance.cache).to receive(:fetch).with("#{presentable.cache_key}:#{user.cache_key}", expires_in: 7.days).once

          subject
        end
      end
    end

    context "for a collection of objects" do
      let_it_be(:presentable) { Array.new(5).map { create(:todo, project: project) } }

      it { is_expected.to be_an(Gitlab::Json::PrecompiledJson) }

      it "uses the presenter" do
        presentable.each do |todo|
          expect(presenter).to receive(:represent).with(todo, project: project)
        end

        subject
      end

      it "is valid JSON" do
        parsed = Gitlab::Json.parse(subject.to_s)

        expect(parsed).to be_an(Array)

        presentable.each_with_index do |todo, i|
          expect(parsed[i]["id"]).to eq(todo.id)
        end
      end

      it "fetches from the cache" do
        keys = presentable.map { |todo| "#{todo.cache_key}:#{user.cache_key}" }

        expect(instance.cache).to receive(:fetch_multi).with(*keys, expires_in: described_class::DEFAULT_EXPIRY).once.and_call_original

        subject
      end

      context "when a cache context is supplied" do
        before do
          kwargs[:cache_context] = -> (todo) { todo.project.cache_key }
        end

        it "uses the context to augment the cache key" do
          keys = presentable.map { |todo| "#{todo.cache_key}:#{project.cache_key}" }

          expect(instance.cache).to receive(:fetch_multi).with(*keys, expires_in: described_class::DEFAULT_EXPIRY).once.and_call_original

          subject
        end
      end

      context "expires_in is supplied" do
        it "sets the expiry when accessing the cache" do
          keys = presentable.map { |todo| "#{todo.cache_key}:#{user.cache_key}" }
          kwargs[:expires_in] = 7.days

          expect(instance.cache).to receive(:fetch_multi).with(*keys, expires_in: 7.days).once.and_call_original

          subject
        end
      end
    end
  end
end