Skip to content

utils/github/api: print more info on rate limits #20879

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
Bo98 merged 1 commit into from
Oct 15, 2025
Merged

utils/github/api: print more info on rate limits #20879

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
9 changes: 6 additions & 3 deletions Library/Homebrew/utils/github/api.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,12 +66,13 @@ def initialize(github_message)

# Error when the API rate limit is exceeded.
class RateLimitExceededError < Error
sig { params(reset: Integer, github_message: String).void }
def initialize(reset, github_message)
sig { params(github_message: String, reset: Integer, resource: String, limit: Integer).void }
def initialize(github_message, reset:, resource:, limit:)
@reset = T.let(reset, Integer)
new_pat_message = ", or:\n#{GitHub.pat_blurb}" if API.credentials.blank?
message = <<~EOS
GitHub API Error: #{github_message}
Rate limit exceeded for #{resource} resource (#{limit} limit).
Try again in #{pretty_ratelimit_reset}#{new_pat_message}
EOS
super(message, github_message)
Expand Down Expand Up @@ -456,7 +457,9 @@ def self.raise_error(output, errors, http_code, headers, scopes)
when "403"
if meta.fetch("x-ratelimit-remaining", 1).to_i <= 0
reset = meta.fetch("x-ratelimit-reset").to_i
raise RateLimitExceededError.new(reset, message)
resource = meta.fetch("x-ratelimit-resource")
limit = meta.fetch("x-ratelimit-limit").to_i
raise RateLimitExceededError.new(message, reset:, resource:, limit:)
end

raise AuthenticationFailedError.new(credentials_type, message)
Expand Down
Loading