Module: API::Helpers::RateLimiter

Defined in:
lib/api/helpers/rate_limiter.rb

Overview

RateLimiter

Helper that checks if the rate limit for a given endpoint is throttled by calling the Gitlab::ApplicationRateLimiter module. If the action is throttled for the current user, the request will be logged and an error message will be rendered with a Too Many Requests response status. See app/controllers/concerns/check_rate_limit.rb for Rails controllers version

Instance Method Summary collapse

Instance Method Details

#check_rate_limit!(key, scope:, **options) ⇒ Object


12
13
14
15
16
17
18
19
20
21
# File 'lib/api/helpers/rate_limiter.rb', line 12

def check_rate_limit!(key, scope:, **options)
  return if bypass_header_set?
  return unless rate_limiter.throttled?(key, scope: scope, **options)

  rate_limiter.log_request(request, "#{key}_request_limit".to_sym, current_user)

  return yield if block_given?

  render_api_error!({ error: _('This endpoint has been requested too many times. Try again later.') }, 429)
end