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
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe Gitlab::ApplicationRateLimiter, :clean_gitlab_redis_rate_limiting do
let_it_be(:user) { create(:user) }
let_it_be(:project) { create(:project) }
let(:rate_limits) do
{
test_action: {
threshold: 1,
interval: 2.minutes
},
another_action: {
threshold: -> { 2 },
interval: -> { 3.minutes }
}
}
end
subject { described_class }
before do
allow(described_class).to receive(:rate_limits).and_return(rate_limits)
end
describe '.throttled?' do
context 'when the key is invalid' do
context 'is provided as a Symbol' do
context 'but is not defined in the rate_limits Hash' do
it 'raises an InvalidKeyError exception' do
key = :key_not_in_rate_limits_hash
expect { subject.throttled?(key, scope: [user]) }.to raise_error(Gitlab::ApplicationRateLimiter::InvalidKeyError)
end
end
end
context 'is provided as a String' do
context 'and is a String representation of an existing key in rate_limits Hash' do
it 'raises an InvalidKeyError exception' do
key = rate_limits.keys[0].to_s
expect { subject.throttled?(key, scope: [user]) }.to raise_error(Gitlab::ApplicationRateLimiter::InvalidKeyError)
end
end
context 'but is not defined in any form in the rate_limits Hash' do
it 'raises an InvalidKeyError exception' do
key = 'key_not_in_rate_limits_hash'
expect { subject.throttled?(key, scope: [user]) }.to raise_error(Gitlab::ApplicationRateLimiter::InvalidKeyError)
end
end
end
end
context 'when the key is valid' do
it 'records the checked key in request storage', :request_store do
subject.throttled?(:test_action, scope: [user])
expect(::Gitlab::Instrumentation::RateLimitingGates.payload)
.to eq(::Gitlab::Instrumentation::RateLimitingGates::GATES => [:test_action])
subject.throttled?(:another_action, scope: [user], peek: true)
expect(::Gitlab::Instrumentation::RateLimitingGates.payload)
.to eq(::Gitlab::Instrumentation::RateLimitingGates::GATES => [:test_action, :another_action])
end
end
describe 'counting actions once per unique resource' do
let(:scope) { [user, project] }
let(:start_time) { Time.current.beginning_of_hour }
let(:project1) { instance_double(Project, id: '1') }
let(:project2) { instance_double(Project, id: '2') }
it 'returns true when unique actioned resources count exceeds threshold' do
travel_to(start_time) do
expect(subject.throttled?(:test_action, scope: scope, resource: project1)).to eq(false)
end
travel_to(start_time + 1.minute) do
expect(subject.throttled?(:test_action, scope: scope, resource: project2)).to eq(true)
end
end
it 'returns false when unique actioned resource count does not exceed threshold' do
travel_to(start_time) do
expect(subject.throttled?(:test_action, scope: scope, resource: project1)).to eq(false)
end
travel_to(start_time + 1.minute) do
expect(subject.throttled?(:test_action, scope: scope, resource: project1)).to eq(false)
end
end
it 'returns false when interval has elapsed' do
travel_to(start_time) do
expect(subject.throttled?(:test_action, scope: scope, resource: project1)).to eq(false)
end
travel_to(start_time + 2.minutes) do
expect(subject.throttled?(:test_action, scope: scope, resource: project2)).to eq(false)
end
end
end
shared_examples 'throttles based on key and scope' do
let(:start_time) { Time.current.beginning_of_hour }
let(:threshold) { nil }
let(:interval) { nil }
it 'returns true when threshold is exceeded', :aggregate_failures do
travel_to(start_time) do
expect(subject.throttled?(
:test_action, scope: scope, threshold: threshold, interval: interval)
).to eq(false)
end
travel_to(start_time + 1.minute) do
expect(subject.throttled?(
:test_action, scope: scope, threshold: threshold, interval: interval)
).to eq(true)
# Assert that it does not affect other actions or scope
expect(subject.throttled?(:another_action, scope: scope)).to eq(false)
expect(subject.throttled?(
:test_action, scope: [user], threshold: threshold, interval: interval)
).to eq(false)
end
end
it 'returns false when interval has elapsed', :aggregate_failures do
travel_to(start_time) do
expect(subject.throttled?(
:test_action, scope: scope, threshold: threshold, interval: interval)
).to eq(false)
# another_action has a threshold of 2 so we simulate 2 requests
expect(subject.throttled?(:another_action, scope: scope)).to eq(false)
expect(subject.throttled?(:another_action, scope: scope)).to eq(false)
end
travel_to(start_time + 2.minutes) do
expect(subject.throttled?(
:test_action, scope: scope, threshold: threshold, interval: interval)
).to eq(false)
# Assert that another_action has its own interval that hasn't elapsed
expect(subject.throttled?(:another_action, scope: scope)).to eq(true)
end
end
it 'allows peeking at the current state without changing its value', :aggregate_failures do
travel_to(start_time) do
expect(subject.throttled?(
:test_action, scope: scope, threshold: threshold, interval: interval)
).to eq(false)
2.times do
expect(subject.throttled?(
:test_action, scope: scope, threshold: threshold, interval: interval, peek: true)
).to eq(false)
end
expect(subject.throttled?(
:test_action, scope: scope, threshold: threshold, interval: interval)
).to eq(true)
expect(subject.throttled?(
:test_action, scope: scope, peek: true, threshold: threshold, interval: interval)
).to eq(true)
end
end
end
context 'when using ActiveRecord models as scope' do
let(:scope) { [user, project] }
it_behaves_like 'throttles based on key and scope'
end
context 'when using ActiveRecord models and strings as scope' do
let(:scope) { [project, 'app/controllers/groups_controller.rb'] }
it_behaves_like 'throttles based on key and scope'
end
context 'when threshold and interval get overwritten from rate_limits' do
let(:rate_limits) do
{
test_action: {
threshold: 0,
interval: 0
},
another_action: {
threshold: -> { 2 },
interval: -> { 3.minutes }
}
}
end
let(:scope) { [user, project] }
it_behaves_like 'throttles based on key and scope' do
let(:threshold) { 1 }
let(:interval) { 2.minutes }
end
end
end
describe '.peek' do
it 'peeks at the current state without changing its value' do
freeze_time do
expect(subject.peek(:test_action, scope: [user])).to eq(false)
expect(subject.throttled?(:test_action, scope: [user])).to eq(false)
2.times do
expect(subject.peek(:test_action, scope: [user])).to eq(false)
end
expect(subject.throttled?(:test_action, scope: [user])).to eq(true)
expect(subject.peek(:test_action, scope: [user])).to eq(true)
end
end
end
describe '.log_request' do
let(:file_path) { 'master/README.md' }
let(:type) { :raw_blob_request_limit }
let(:fullpath) { "/#{project.full_path}/raw/#{file_path}" }
let(:request) do
double('request', ip: '127.0.0.1', request_method: 'GET', fullpath: fullpath)
end
let(:base_attributes) do
{
message: 'Application_Rate_Limiter_Request',
env: type,
remote_ip: '127.0.0.1',
request_method: 'GET',
path: fullpath
}
end
context 'without a current user' do
let(:current_user) { nil }
it 'logs information to auth.log' do
expect(Gitlab::AuthLogger).to receive(:error).with(base_attributes).once
subject.log_request(request, type, current_user)
end
end
context 'with a current_user' do
let(:current_user) { user }
let(:attributes) do
base_attributes.merge({
user_id: current_user.id,
username: current_user.username
})
end
it 'logs information to auth.log' do
expect(Gitlab::AuthLogger).to receive(:error).with(attributes).once
subject.log_request(request, type, current_user)
end
end
end
context 'when interval is 0' do
let(:rate_limits) { { test_action: { threshold: 1, interval: 0 } } }
let(:scope) { user }
let(:start_time) { Time.current.beginning_of_hour }
it 'returns false' do
travel_to(start_time) do
expect(subject.throttled?(:test_action, scope: scope)).to eq(false)
end
travel_to(start_time + 1.minute) do
expect(subject.throttled?(:test_action, scope: scope)).to eq(false)
end
end
end
end
|