2021-04-17 20:07:23 +05:30
|
|
|
# frozen_string_literal: true
|
|
|
|
|
|
|
|
# == CheckRateLimit
|
|
|
|
#
|
|
|
|
# Controller concern that checks if the rate limit for a given action is throttled by calling the
|
|
|
|
# Gitlab::ApplicationRateLimiter class. 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.
|
2022-01-26 12:08:38 +05:30
|
|
|
# See lib/api/helpers/rate_limiter.rb for API version
|
2021-04-17 20:07:23 +05:30
|
|
|
module CheckRateLimit
|
2022-01-26 12:08:38 +05:30
|
|
|
def check_rate_limit!(key, scope:, redirect_back: false, **options)
|
|
|
|
return unless rate_limiter.throttled?(key, scope: scope, **options)
|
2021-04-17 20:07:23 +05:30
|
|
|
|
|
|
|
rate_limiter.log_request(request, "#{key}_request_limit".to_sym, current_user)
|
2022-01-26 12:08:38 +05:30
|
|
|
|
|
|
|
return yield if block_given?
|
|
|
|
|
|
|
|
message = _('This endpoint has been requested too many times. Try again later.')
|
|
|
|
|
|
|
|
if redirect_back
|
|
|
|
redirect_back_or_default(options: { alert: message })
|
|
|
|
else
|
|
|
|
render plain: message, status: :too_many_requests
|
|
|
|
end
|
2021-04-17 20:07:23 +05:30
|
|
|
end
|
|
|
|
|
2022-01-26 12:08:38 +05:30
|
|
|
private
|
|
|
|
|
2021-04-17 20:07:23 +05:30
|
|
|
def rate_limiter
|
|
|
|
::Gitlab::ApplicationRateLimiter
|
|
|
|
end
|
|
|
|
end
|