docbrown/app/services/rate_limit_checker.rb
Michael Kohl 28dd50e718
Create settings model for rate limits (#13381)
Co-authored-by: rhymes <rhymes@hey.com>
2021-04-20 11:29:22 +07:00

122 lines
3.8 KiB
Ruby

class RateLimitChecker
attr_reader :user, :action
# retry_after values are the seconds until a user can retry an action
ACTION_LIMITERS = {
article_update: { retry_after: 30 },
feedback_message_creation: { retry_after: 300 },
image_upload: { retry_after: 30 },
listing_creation: { retry_after: 60 },
organization_creation: { retry_after: 300 },
published_article_creation: { retry_after: 30 },
published_article_antispam_creation: { retry_after: 300 },
reaction_creation: { retry_after: 30 },
send_email_confirmation: { retry_after: 120 },
user_subscription_creation: { retry_after: 30 },
user_update: { retry_after: 30 },
comment_antispam_creation: { retry_after: 300 }
}.with_indifferent_access.freeze
def initialize(user = nil)
@user = user
end
class LimitReached < StandardError
attr_reader :retry_after
def initialize(retry_after) # rubocop:disable Lint/MissingSuper
@retry_after = retry_after
end
def message
"Rate limit reached, try again in #{retry_after} seconds"
end
end
def check_limit!(action)
return unless limit_by_action(action)
retry_after = ACTION_LIMITERS.dig(action, :retry_after)
raise LimitReached, retry_after
end
def limit_by_action(action)
check_method = "check_#{action}_limit"
result = respond_to?(check_method, true) ? __send__(check_method) : false
if result
@action = action
log_to_datadog
end
result
end
def track_limit_by_action(action)
expires_in = ACTION_LIMITERS.dig(action, :retry_after).seconds
Rails.cache.increment(limit_cache_key(action), 1, expires_in: expires_in, raw: true)
end
def limit_by_email_recipient_address(address)
# This is related to the recipient, not the "user" initiator, like in action.
EmailMessage.where(to: address).where("sent_at > ?", 2.minutes.ago).size >
Settings::RateLimit.email_recipient
end
private
ACTION_LIMITERS.each_key do |action|
define_method("check_#{action}_limit") do
Rails.cache.read(limit_cache_key(action), raw: true).to_i > action_rate_limit(action)
end
end
def limit_cache_key(action)
unique_key_component = @user&.id || @user&.ip_address
raise "Invalid Cache Key: no unique component present" if unique_key_component.blank?
"#{unique_key_component}_#{action}"
end
def action_rate_limit(action)
Settings::RateLimit.public_send(action)
end
def check_comment_creation_limit
user.comments.where("created_at > ?", 30.seconds.ago).size >
Settings::RateLimit.comment_creation
end
def check_published_article_creation_limit
# TODO: Vaidehi Joshi - We should make this time frame configurable.
user.articles.published.where("created_at > ?", 30.seconds.ago).size >
Settings::RateLimit.published_article_creation
end
def check_published_article_antispam_creation_limit
# TODO: Vaidehi Joshi - We should make this time frame configurable.
user.articles.published.where("created_at > ?", 5.minutes.ago).size >
Settings::RateLimit.published_article_antispam_creation
end
def check_comment_antispam_creation_limit
# TODO: We should make this time frame configurable.
user.comments.where(created_at: 5.minutes.ago...).size >
Settings::RateLimit.comment_antispam_creation
end
def check_follow_account_limit
user_today_follow_count > Settings::RateLimit.follow_count_daily
end
def user_today_follow_count
following_users_count = user.following_users_count
return following_users_count if following_users_count < Settings::RateLimit.follow_count_daily
now = Time.zone.now
user.follows.where(created_at: (now.beginning_of_day..now)).size
end
def log_to_datadog
ForemStatsClient.increment("rate_limit.limit_reached", tags: ["user:#{user.id}", "action:#{action}"])
end
end