Module: GitHub::API

Extended by:
SystemCommand::Mixin
Defined in:
utils/github/api.rb

Overview

This module is part of an internal API. This module may only be used internally in repositories owned by Homebrew, except in casks or formulae. Third parties should avoid using this module if possible, as it may be removed or changed without warning.

Helper functions for accessing the GitHub API.

Defined Under Namespace

Classes: AuthenticationFailedError, Error, HTTPNotFoundError, MissingAuthenticationError, RateLimitExceededError, ValidationFailedError

Constant Summary collapse

GITHUB_IP_ALLOWLIST_ERROR =

This constant is part of an internal API. This constant may only be used internally in repositories owned by Homebrew, except in casks or formulae. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 

T.let(
  Regexp.new(
    "Although you appear to have the correct authorization credentials, " \
    "the `(.+)` organization has an IP allow list enabled, " \
    "and your IP address is not permitted to access this resource",
  ).freeze,
  Regexp,
)
NO_CREDENTIALS_MESSAGE =

This constant is part of an internal API. This constant may only be used internally in repositories owned by Homebrew, except in casks or formulae. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 

T.let <<~MESSAGE.freeze, String
  No GitHub credentials found in macOS Keychain, GitHub CLI or the environment.
  #{GitHub.pat_blurb}
MESSAGE
ERRORS =

This constant is part of an internal API. This constant may only be used internally in repositories owned by Homebrew, except in casks or formulae. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 

T.let([
  AuthenticationFailedError,
  HTTPNotFoundError,
  RateLimitExceededError,
  Error,
  JSON::ParserError,
].freeze, T::Array[T.any(T.class_of(Error), T.class_of(JSON::ParserError))])
CREDENTIAL_NAMES =

This constant is part of an internal API. This constant may only be used internally in repositories owned by Homebrew, except in casks or formulae. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 

T.let({
  env_token:                  "HOMEBREW_GITHUB_API_TOKEN",
  github_cli_token:           "GitHub CLI login",
  keychain_username_password: "macOS Keychain GitHub",
}.freeze, T::Hash[Symbol, String])

Class Method Summary collapse

Methods included from SystemCommand::Mixin

system_command, system_command!

Class Method Details

.credentials ⇒ String?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



200
201
202
203
204
205
 
# File 'utils/github/api.rb', line 200

def self.credentials
  @credentials ||= T.let(nil, T.nilable(String))
  @credentials ||= Homebrew::EnvConfig.github_api_token.presence
  @credentials ||= github_cli_token
  @credentials ||= keychain_username_password
end

.credentials_error_message(response_headers, needed_scopes) ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

Given an API response from GitHub, warn the user if their credentials have insufficient permissions.

Parameters:



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'utils/github/api.rb', line 229

def self.credentials_error_message(response_headers, needed_scopes)
  return if response_headers.empty?

  scopes = response_headers["x-accepted-oauth-scopes"].to_s.split(", ").presence
  needed_scopes = Set.new(scopes || needed_scopes)
  credentials_scopes = response_headers["x-oauth-scopes"]
  return if needed_scopes.subset?(Set.new(credentials_scopes.to_s.split(", ")))

  github_permission_link = GitHub.pat_blurb(needed_scopes.to_a)
  needed_scopes = needed_scopes.to_a.join(", ").presence || "none"
  credentials_scopes = "none" if credentials_scopes.blank?

  what = CREDENTIAL_NAMES.fetch(credentials_type)
  @credentials_error_message ||= T.let(begin
    error_message = <<~EOS
      Your #{what} credentials do not have sufficient scope!
      Scopes required: #{needed_scopes}
      Scopes present:  #{credentials_scopes}
      #{github_permission_link}
    EOS
    onoe error_message
    error_message
  end, T.nilable(String))
end

.credentials_type ⇒ Symbol

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



208
209
210
211
212
213
214
215
216
217
218
 
# File 'utils/github/api.rb', line 208

def self.credentials_type
  if Homebrew::EnvConfig.github_api_token.present?
    :env_token
  elsif github_cli_token.present?
    :github_cli_token
  elsif keychain_username_password.present?
    :keychain_username_password
  else
    :none
  end
end

.github_cli_token ⇒ String?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Gets the token from the GitHub CLI for github.com.

Returns:



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'utils/github/api.rb', line 154

def self.github_cli_token
  require "utils/uid"
  Utils::UID.drop_euid do
    # Avoid `Formula["gh"].opt_bin` so this method works even with `HOMEBREW_DISABLE_LOAD_FORMULA`.
    env = {
      "PATH" => PATH.new(HOMEBREW_PREFIX/"opt/gh/bin", ENV.fetch("PATH")),
      "HOME" => Utils::UID.uid_home,
    }.compact
    gh_out, _, result = system_command "gh",
                                       args:         ["auth", "token", "--hostname", "github.com"],
                                       env:,
                                       print_stderr: false
    return unless result.success?

    gh_out.chomp.presence
  end
end

.keychain_username_password ⇒ String?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Gets the password field from git-credential-osxkeychain for github.com, but only if that password looks like a GitHub Personal Access Token.

Returns:



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'utils/github/api.rb', line 175

def self.keychain_username_password
  require "utils/uid"
  Utils::UID.drop_euid do
    git_credential_out, _, result = system_command "git",
                                                   args:         ["credential-osxkeychain", "get"],
                                                   input:        ["protocol=https\n", "host=github.com\n"],
                                                   env:          { "HOME" => Utils::UID.uid_home }.compact,
                                                   print_stderr: false
    return unless result.success?

    git_credential_out.force_encoding("ASCII-8BIT")
    github_username = git_credential_out[/^username=(.+)/, 1]
    github_password = git_credential_out[/^password=(.+)/, 1]
    return unless github_username

    # Don't use passwords from the keychain unless they look like
    # GitHub Personal Access Tokens:
    #   https://github.com/Homebrew/brew/issues/6862#issuecomment-572610344
    return unless GITHUB_PERSONAL_ACCESS_TOKEN_REGEX.match?(github_password)

    github_password.presence
  end
end

.open_graphql(query, variables: {}, scopes: [].freeze, raise_errors: true) ⇒ T.untyped

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

  • query (String)
  • variables (Hash{Symbol => T.untyped}) (defaults to: {})
  • scopes (Array<String>) (defaults to: [].freeze)
  • raise_errors (Boolean) (defaults to: true)

Returns:

  • (T.untyped) 


381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'utils/github/api.rb', line 381

def self.open_graphql(query, variables: {}, scopes: [].freeze, raise_errors: true)
  data = { query:, variables: }
  result = open_rest("#{API_URL}/graphql", scopes:, data:, request_method: :POST)

  if raise_errors
    raise Error, result["errors"].map { |e| e["message"] }.join("\n") if result["errors"].present?

    result["data"]
  else
    result
  end
end

.open_rest(url, data: T.unsafe(nil), data_binary_path: T.unsafe(nil), request_method: T.unsafe(nil), scopes: [].freeze, parse_json: true, &_block) ⇒ T.untyped

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

  • url (String, URI::Generic)
  • data (Hash{Symbol => T.untyped}) (defaults to: T.unsafe(nil))
  • data_binary_path (String) (defaults to: T.unsafe(nil))
  • request_method (Symbol) (defaults to: T.unsafe(nil))
  • scopes (Array<String>) (defaults to: [].freeze)
  • parse_json (Boolean) (defaults to: true)
  • _block (T.proc .params(data: T::Hash[String, T.untyped]) .returns(T.untyped), nil)

Returns:

  • (T.untyped) 


269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'utils/github/api.rb', line 269

def self.open_rest(url, data: T.unsafe(nil), data_binary_path: T.unsafe(nil), request_method: T.unsafe(nil),
                   scopes: [].freeze, parse_json: true, &_block)
  # This is a no-op if the user is opting out of using the GitHub API.
  return block_given? ? yield({}) : {} if Homebrew::EnvConfig.no_github_api?

  # This is a Curl format token, not a Ruby one.
  # rubocop:disable Style/FormatStringToken
  args = ["--header", "Accept: application/vnd.github+json", "--write-out", "\n%{http_code}"]
  # rubocop:enable Style/FormatStringToken

  token = credentials
  args += ["--header", "Authorization: token #{token}"] if credentials_type != :none
  args += ["--header", "X-GitHub-Api-Version:2022-11-28"]

  require "tempfile"
  data_tmpfile = nil
  if data
    begin
      data = JSON.pretty_generate data
      data_tmpfile = Tempfile.new("github_api_post", HOMEBREW_TEMP)
    rescue JSON::ParserError => e
      raise Error, "Failed to parse JSON request:\n#{e.message}\n#{data}", e.backtrace
    end
  end

  if data_binary_path.present?
    args += ["--data-binary", "@#{data_binary_path}"]
    args += ["--header", "Content-Type: application/gzip"]
  end

  headers_tmpfile = Tempfile.new("github_api_headers", HOMEBREW_TEMP)
  begin
    if data_tmpfile
      data_tmpfile.write data
      data_tmpfile.close
      args += ["--data", "@#{data_tmpfile.path}"]

      args += ["--request", request_method.to_s] if request_method
    end

    args += ["--dump-header", T.must(headers_tmpfile.path)]

    require "utils/curl"
    result = Utils::Curl.curl_output("--location", url.to_s, *args, secrets: [token])
    output, _, http_code = result.stdout.rpartition("\n")
    output, _, http_code = output.rpartition("\n") if http_code == "000"
    headers = headers_tmpfile.read
  ensure
    if data_tmpfile
      data_tmpfile.close
      data_tmpfile.unlink
    end
    headers_tmpfile.close
    headers_tmpfile.unlink
  end

  begin
    if !http_code.start_with?("2") || !result.status.success?
      raise_error(output, result.stderr, http_code, headers || "", scopes)
    end

    return if http_code == "204" # No Content

    output = JSON.parse output if parse_json
    if block_given?
      yield output
    else
      output
    end
  rescue JSON::ParserError => e
    raise Error, "Failed to parse JSON response\n#{e.message}", e.backtrace
  end
end

.paginate_graphql(query, variables: {}, scopes: [].freeze, raise_errors: true, &_block) ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

Parameters:

  • query (String)
  • variables (Hash{Symbol => T.untyped}) (defaults to: {})
  • scopes (Array<String>) (defaults to: [].freeze)
  • raise_errors (Boolean) (defaults to: true)
  • _block (T.proc.params(data: T::Hash[String, T.untyped]).returns(T.untyped)) 


403
404
405
406
407
408
409
410
411
412
413
414
415
 
# File 'utils/github/api.rb', line 403

def self.paginate_graphql(query, variables: {}, scopes: [].freeze, raise_errors: true, &_block)
  result = API.open_graphql(query, variables:, scopes:, raise_errors:)

  has_next_page = T.let(true, T::Boolean)
  while has_next_page
    page_info = yield result
    has_next_page = page_info["hasNextPage"]
    if has_next_page
      variables[:after] = page_info["endCursor"]
      result = API.open_graphql(query, variables:, scopes:, raise_errors:)
    end
  end
end

.paginate_rest(url, additional_query_params: T.unsafe(nil), per_page: 100, scopes: [].freeze, &_block) ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

Parameters:

  • url (String, URI::Generic)
  • additional_query_params (String) (defaults to: T.unsafe(nil))
  • per_page (Integer) (defaults to: 100)
  • scopes (Array<String>) (defaults to: [].freeze)
  • _block (T.proc .params(result: T.untyped, page: Integer) .returns(T.untyped)) 


354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'utils/github/api.rb', line 354

def self.paginate_rest(url, additional_query_params: T.unsafe(nil), per_page: 100, scopes: [].freeze, &_block)
  (1..API_MAX_PAGES).each do |page|
    retry_count = 1
    result = begin
      API.open_rest("#{url}?per_page=#{per_page}&page=#{page}&#{additional_query_params}", scopes:)
    rescue Error
      if retry_count < PAGINATE_RETRY_COUNT
        retry_count += 1
        retry
      end

      raise
    end
    break if result.blank?

    yield(result, page)
  end
end

.raise_error(output, errors, http_code, headers, scopes) ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

Parameters:



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'utils/github/api.rb', line 426

def self.raise_error(output, errors, http_code, headers, scopes)
  json = begin
    JSON.parse(output)
  rescue
    nil
  end
  message = json&.[]("message") || "curl failed! #{errors}"

  meta = {}
  headers.lines.each do |l|
    key, _, value = l.delete(":").partition(" ")
    key = key.downcase.strip
    next if key.empty?

    meta[key] = value.strip
  end

  credentials_error_message(meta, scopes)

  case http_code
  when "401"
    raise AuthenticationFailedError.new(credentials_type, message)
  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)
    end

    raise AuthenticationFailedError.new(credentials_type, message)
  when "404"
    raise MissingAuthenticationError if credentials_type == :none && scopes.present?

    raise HTTPNotFoundError, message
  when "422"
    errors = json&.[]("errors") || []
    raise ValidationFailedError.new(message, errors)
  else
    raise Error, message
  end
end