21d99c5e89
- We should tell people to not report issues if they are running in an unsupported configuration. - We should tell people to run `brew update` before reporting issues if they have `HOMEBREW_NO_AUTO_UPDATE` set. - We should tell people to not report issues in more types of exceptions. - Warn people in `HOMEBREW_NO_AUTO_UPDATE` documentation. - DRY up `brew.rb` exception handling. Co-authored-by: Colin Dean <colindean@users.noreply.github.com>
53 lines
1.6 KiB
Ruby
53 lines
1.6 KiB
Ruby
# typed: true
|
|
# frozen_string_literal: true
|
|
|
|
module Utils
|
|
module Backtrace
|
|
# Cleans `sorbet-runtime` gem paths from the backtrace unless...
|
|
# 1. `verbose` is set
|
|
# 2. first backtrace line starts with `sorbet-runtime`
|
|
# - This implies that the error is related to Sorbet.
|
|
sig { params(error: Exception).returns(T.nilable(T::Array[String])) }
|
|
def self.clean(error)
|
|
backtrace = error.backtrace
|
|
|
|
return backtrace if Context.current.verbose?
|
|
return backtrace if backtrace.blank?
|
|
return backtrace if backtrace.fetch(0).start_with?(sorbet_runtime_path)
|
|
|
|
old_backtrace_length = backtrace.length
|
|
backtrace.reject { |line| line.start_with?(sorbet_runtime_path) }
|
|
.tap { |new_backtrace| print_backtrace_message if old_backtrace_length > new_backtrace.length }
|
|
end
|
|
|
|
sig { returns(String) }
|
|
def self.sorbet_runtime_path
|
|
@sorbet_runtime_path ||= "#{Gem.paths.home}/gems/sorbet-runtime"
|
|
end
|
|
|
|
sig { void }
|
|
def self.print_backtrace_message
|
|
return if @print_backtrace_message
|
|
|
|
opoo "Removed Sorbet lines from backtrace!"
|
|
puts "Rerun with `--verbose` to see the original backtrace" unless Homebrew::EnvConfig.no_env_hints?
|
|
|
|
@print_backtrace_message = true
|
|
end
|
|
|
|
sig { params(error: Exception).returns(T.nilable(String)) }
|
|
def self.tap_error_url(error)
|
|
backtrace = error.backtrace
|
|
return if backtrace.blank?
|
|
|
|
backtrace.each do |line|
|
|
if (tap = line.match(%r{/Library/Taps/([^/]+/[^/]+)/}))
|
|
return "https://github.com/#{tap[1]}/issues/new"
|
|
end
|
|
end
|
|
|
|
nil
|
|
end
|
|
end
|
|
end
|