summaryrefslogtreecommitdiff
path: root/spec/support/shared_examples/models/update_project_statistics_shared_examples.rb
blob: 7b591ad84d18f8b50657ff1b2c9b87432d945f41 (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
# frozen_string_literal: true

RSpec.shared_examples 'UpdateProjectStatistics' do |with_counter_attribute|
  let(:project) { subject.project }
  let(:project_statistics_name) { described_class.project_statistics_name }
  let(:statistic_attribute) { described_class.statistic_attribute }

  def reload_stat
    project.statistics.reload.send(project_statistics_name).to_i
  end

  def read_attribute
    subject.read_attribute(statistic_attribute).to_i
  end

  def read_pending_increment
    Gitlab::Redis::SharedState.with do |redis|
      key = project.statistics.counter_key(project_statistics_name)
      redis.get(key).to_i
    end
  end

  it { is_expected.to be_new_record }

  context 'when feature flag efficient_counter_attribute is disabled' do
    before do
      stub_feature_flags(efficient_counter_attribute: false)
    end

    context 'when creating' do
      it 'updates the project statistics' do
        delta0 = reload_stat

        subject.save!

        delta1 = reload_stat

        expect(delta1).to eq(delta0 + read_attribute)
        expect(delta1).to be > delta0
      end

      it 'schedules a namespace statistics worker' do
        expect(Namespaces::ScheduleAggregationWorker)
          .to receive(:perform_async).once

        subject.save!
      end
    end

    context 'when updating' do
      let(:delta) { 42 }

      before do
        subject.save!
      end

      it 'updates project statistics' do
        expect(ProjectStatistics)
          .to receive(:increment_statistic)
          .and_call_original

        subject.write_attribute(statistic_attribute, read_attribute + delta)

        expect { subject.save! }
          .to change { reload_stat }
          .by(delta)
      end

      it 'schedules a namespace statistics worker' do
        expect(Namespaces::ScheduleAggregationWorker)
          .to receive(:perform_async).once

        subject.write_attribute(statistic_attribute, read_attribute + delta)
        subject.save!
      end

      it 'avoids N + 1 queries' do
        subject.write_attribute(statistic_attribute, read_attribute + delta)

        control_count = ActiveRecord::QueryRecorder.new do
          subject.save!
        end

        subject.write_attribute(statistic_attribute, read_attribute + delta)

        expect do
          subject.save!
        end.not_to exceed_query_limit(control_count)
      end
    end

    context 'when destroying' do
      before do
        subject.save!
      end

      it 'updates the project statistics' do
        delta0 = reload_stat

        subject.destroy!

        delta1 = reload_stat

        expect(delta1).to eq(delta0 - read_attribute)
        expect(delta1).to be < delta0
      end

      it 'schedules a namespace statistics worker' do
        expect(Namespaces::ScheduleAggregationWorker)
          .to receive(:perform_async).once

        subject.destroy!
      end

      context 'when it is destroyed from the project level' do
        it 'does not update the project statistics' do
          expect(ProjectStatistics)
            .not_to receive(:increment_statistic)

          project.update!(pending_delete: true)
          project.destroy!
        end

        it 'does not schedule a namespace statistics worker' do
          expect(Namespaces::ScheduleAggregationWorker)
            .not_to receive(:perform_async)

          project.update!(pending_delete: true)
          project.destroy!
        end
      end
    end
  end

  def expect_flush_counter_increments_worker_performed
    expect(FlushCounterIncrementsWorker)
      .to receive(:perform_in)
      .with(CounterAttribute::WORKER_DELAY, project.statistics.class.name, project.statistics.id, project_statistics_name)
    expect(FlushCounterIncrementsWorker)
      .to receive(:perform_in)
      .with(CounterAttribute::WORKER_DELAY, project.statistics.class.name, project.statistics.id, :storage_size)

    yield

    # simulate worker running now
    expect(Namespaces::ScheduleAggregationWorker).to receive(:perform_async)
    FlushCounterIncrementsWorker.new.perform(project.statistics.class.name, project.statistics.id, project_statistics_name)
  end

  if with_counter_attribute
    context 'when statistic is a counter attribute', :clean_gitlab_redis_shared_state do
      context 'when creating' do
        it 'stores pending increments for async update' do
          initial_stat = reload_stat
          expected_increment = read_attribute

          expect_flush_counter_increments_worker_performed do
            subject.save!

            expect(read_pending_increment).to eq(expected_increment)
            expect(expected_increment).to be > initial_stat
            expect(expected_increment).to be_positive
          end
        end
      end

      context 'when updating' do
        let(:delta) { 42 }

        before do
          subject.save!
          redis_shared_state_cleanup!
        end

        it 'stores pending increments for async update' do
          expect(ProjectStatistics)
            .to receive(:increment_statistic)
            .and_call_original

          subject.write_attribute(statistic_attribute, read_attribute + delta)

          expect_flush_counter_increments_worker_performed do
            subject.save!

            expect(read_pending_increment).to eq(delta)
          end
        end

        it 'avoids N + 1 queries' do
          subject.write_attribute(statistic_attribute, read_attribute + delta)

          control_count = ActiveRecord::QueryRecorder.new do
            subject.save!
          end

          subject.write_attribute(statistic_attribute, read_attribute + delta)

          expect do
            subject.save!
          end.not_to exceed_query_limit(control_count)
        end
      end

      context 'when destroying' do
        before do
          subject.save!
          redis_shared_state_cleanup!
        end

        it 'stores pending increment for async update' do
          initial_stat = reload_stat
          expected_increment = -read_attribute

          expect_flush_counter_increments_worker_performed do
            subject.destroy!

            expect(read_pending_increment).to eq(expected_increment)
            expect(expected_increment).to be < initial_stat
            expect(expected_increment).to be_negative
          end
        end

        context 'when it is destroyed from the project level' do
          it 'does not update the project statistics' do
            expect(ProjectStatistics)
              .not_to receive(:increment_statistic)

            project.update!(pending_delete: true)
            project.destroy!
          end

          it 'does not schedule a namespace statistics worker' do
            expect(Namespaces::ScheduleAggregationWorker)
              .not_to receive(:perform_async)

            project.update!(pending_delete: true)
            project.destroy!
          end
        end
      end
    end
  end
end