Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Respect HTTP 429 and Retry-After header #628

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
NARKOZ merged 1 commit into from
Oct 11, 2021
Merged

Respect HTTP 429 and Retry-After header #628

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion lib/gitlab/request.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,18 @@ def self.decode(response)
params[:headers].merge!(authorization_header)
end

validate self.class.send(method, endpoint + path, params)
retries_left = params[:ratelimit_retries] || 3
begin
response = self.class.send(method, endpoint + path, params)
validate response
rescue Gitlab::Error::TooManyRequests => e
retries_left -= 1
raise e if retries_left.zero?

wait_time = response.headers['Retry-After'] || 2
sleep(wait_time.to_i)
retry
end
end
end

Expand Down
73 changes: 73 additions & 0 deletions spec/gitlab/request_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,4 +114,77 @@
expect(@request.send(:authorization_header)).to eq('Authorization' => 'Bearer 3225e2804d31fea13fc41fc83bffef00cfaedc463118646b154acc6f94747603')
end
end

describe 'ratelimiting' do
before do
@request.private_token = 'token'
@request.endpoint = 'https://example.com/api/v4'
@rpath = "#{@request.endpoint}/version"

allow(@request).to receive(:httparty)
end

it 'tries 3 times when ratelimited by default' do
stub_request(:get, @rpath)
.to_return(
status: 429,
headers: { 'Retry-After' => 1 }
)

expect do
@request.get('/version')
end.to raise_error(Gitlab::Error::TooManyRequests)

expect(a_request(:get, @rpath).with(headers: {
'PRIVATE_TOKEN' => 'token'
}.merge(described_class.headers))).to have_been_made.times(3)
end

it 'tries 4 times when ratelimited with option' do
stub_request(:get, @rpath)
.to_return(
status: 429,
headers: { 'Retry-After' => 1 }
)
expect do
@request.get('/version', { ratelimit_retries: 4 })
end.to raise_error(Gitlab::Error::TooManyRequests)

expect(a_request(:get, @rpath).with(headers: {
'PRIVATE_TOKEN' => 'token'
}.merge(described_class.headers))).to have_been_made.times(4)
end

it 'handles one retry then success' do
stub_request(:get, @rpath)
.to_return(
status: 429,
headers: { 'Retry-After' => 1 }
).times(1).then
.to_return(
status: 200
).times(1)

@request.get('/version')

expect(a_request(:get, @rpath).with(headers: {
'PRIVATE_TOKEN' => 'token'
}.merge(described_class.headers))).to have_been_made.times(2)
end

it 'survives a 429 with no Retry-After header' do
stub_request(:get, @rpath)
.to_return(
status: 429
)

expect do
@request.get('/version')
end.to raise_error(Gitlab::Error::TooManyRequests)

expect(a_request(:get, @rpath).with(headers: {
'PRIVATE_TOKEN' => 'token'
}.merge(described_class.headers))).to have_been_made.times(3)
end
end
end