honeybadger 5.27.0 → 6.2.0

data/lib/honeybadger/backtrace.rb

@@ -1,4 +1,4 @@
-require 'json'
+require "json"
 
 module Honeybadger
   # @api private
@@ -8,7 +8,7 @@ module Honeybadger
     class Line
       # Backtrace line regexp (optionally allowing leading X: for windows support).
       # Capture quoted strings either with leading backtick (pre Ruby 3.4) or single quote.
-      INPUT_FORMAT = %r{^((?:[a-zA-Z]:)?[^:]+):(\d+)(?::in (?:`|')([^']+)')?$}.freeze
+      INPUT_FORMAT = %r{^((?:[a-zA-Z]:)?[^:]+):(\d+)(?::in (?:`|')([^']+)')?$}
 
       # The file portion of the line (such as app/models/user.rb).
       attr_reader :file
@@ -45,21 +45,19 @@ module Honeybadger
           file, number, method = match[1], match[2], match[3]
           filtered_args = [fmatch[1], fmatch[2], fmatch[3]]
           new(file, number, method, *filtered_args, opts.fetch(:source_radius, 2))
-        else
-          nil
         end
       end
 
       def initialize(file, number, method, filtered_file = file,
-                     filtered_number = number, filtered_method = method,
-                     source_radius = 2)
-        self.filtered_file   = filtered_file
+        filtered_number = number, filtered_method = method,
+        source_radius = 2)
+        self.filtered_file = filtered_file
         self.filtered_number = filtered_number
         self.filtered_method = filtered_method
-        self.file            = file
-        self.number          = number
-        self.method          = method
-        self.source_radius   = source_radius
+        self.file = file
+        self.number = number
+        self.method = method
+        self.source_radius = source_radius
       end
 
       # Reconstructs the line in a readable fashion.
@@ -72,7 +70,7 @@ module Honeybadger
       end
 
       def inspect
-        "<Line:#{to_s}>"
+        "<Line:#{self}>"
       end
 
       # Determines if this line is part of the application trace or not.
@@ -102,8 +100,11 @@ module Honeybadger
 
           l = 0
           File.open(file) do |f|
-            start.times { f.gets ; l += 1 }
-            return Hash[duration.times.map { (line = f.gets) ? [(l += 1), line] : nil }.compact]
+            start.times {
+              f.gets
+              l += 1
+            }
+            return duration.times.map { (line = f.gets) ? [(l += 1), line] : nil }.compact.to_h
           end
         else
           {}
@@ -121,7 +122,7 @@ module Honeybadger
         Line.parse(unparsed_line.to_s, opts)
       end.compact
 
-      instance = new(lines)
+      new(lines)
     end
 
     def initialize(lines)
@@ -133,9 +134,9 @@ module Honeybadger
     #
     # Returns array containing backtrace lines.
     def to_ary
-      lines.take(1000).map { |l| { :number => l.filtered_number, :file => l.filtered_file, :method => l.filtered_method, :source => l.source } }
+      lines.take(1000).map { |l| {number: l.filtered_number, file: l.filtered_file, method: l.filtered_method, source: l.source} }
     end
-    alias :to_a :to_ary
+    alias_method :to_a, :to_ary
 
     # JSON support.
     #
@@ -171,11 +172,15 @@ module Honeybadger
 
     attr_writer :lines, :application_lines
 
-    def self.split_multiline_backtrace(backtrace)
-      if backtrace.size == 1
-        backtrace.first.to_s.split(/\n\s*/)
-      else
-        backtrace
+    class << self
+      private
+
+      def split_multiline_backtrace(backtrace)
+        if backtrace.size == 1
+          backtrace.first.to_s.split(/\n\s*/)
+        else
+          backtrace
+        end
       end
     end
   end

data/lib/honeybadger/breadcrumbs/active_support.rb

@@ -1,4 +1,4 @@
-require 'honeybadger/util/sql'
+require "honeybadger/util/sql"
 
 module Honeybadger
   module Breadcrumbs
@@ -10,7 +10,7 @@ module Honeybadger
           "sql.active_record" => {
             message: lambda do |data|
               # Disregard empty string names
-              name = data[:name] if data[:name] && !data[:name].strip.empty?
+              name = data[:name] if data[:name] && !data[:name].to_s.strip.empty?
 
               ["Active Record", name].compact.join(" - ")
             end,
@@ -19,7 +19,7 @@ module Honeybadger
             transform: lambda do |data|
               if data[:sql]
                 connection = data.delete(:connection)
-                adapter = (connection && connection.adapter_name.downcase) || active_record_connection_db_config[:adapter]
+                adapter = connection&.adapter_name&.downcase || active_record_connection_db_config[:adapter]
                 data[:sql] = Util::SQL.obfuscate(data[:sql], adapter)
               end
               data
@@ -49,7 +49,7 @@ module Honeybadger
           "perform_start.active_job" => {
             message: "Active Job Perform Start",
             select_keys: [],
-            category: "job",
+            category: "job"
           },
 
           # ActiveSupport Actions
@@ -67,32 +67,32 @@ module Honeybadger
           #
           "halted_callback.action_controller" => {
             message: "Action Controller Callback Halted",
-            category: "request",
+            category: "request"
           },
           "process_action.action_controller" => {
             message: "Action Controller Action Process",
             select_keys: [:controller, :action, :format, :method, :path, :status, :view_runtime, :db_runtime],
-            category: "request",
+            category: "request"
           },
           "start_processing.action_controller" => {
             message: "Action Controller Start Process",
             select_keys: [:controller, :action, :format, :method, :path],
-            category: "request",
+            category: "request"
           },
           "redirect_to.action_controller" => {
             message: "Action Controller Redirect",
-            category: "request",
+            category: "request"
           },
 
           # View Actions
           #
           "render_template.action_view" => {
             message: "Action View Template Render",
-            category: "render",
+            category: "render"
           },
           "render_partial.action_view" => {
             message: "Action View Partial Render",
-            category: "render",
+            category: "render"
           },
 
           # Mailer actions

data/lib/honeybadger/breadcrumbs/breadcrumb.rb

@@ -1,4 +1,4 @@
-require 'time'
+require "time"
 
 module Honeybadger
   module Breadcrumbs
@@ -32,7 +32,6 @@ module Honeybadger
         to_h <=> other.to_h
       end
 
-
       # Is the Breadcrumb active or not. Inactive Breadcrumbs not be included
       # with any outgoing payloads.
       #

data/lib/honeybadger/breadcrumbs/collector.rb

@@ -1,4 +1,4 @@
-require 'forwardable'
+require "forwardable"
 
 module Honeybadger
   module Breadcrumbs
@@ -35,7 +35,7 @@ module Honeybadger
       #
       # @return [self] Filtered breadcrumbs
       def add!(breadcrumb)
-        return unless @config[:'breadcrumbs.enabled']
+        return unless @config[:"breadcrumbs.enabled"]
         @buffer.add!(breadcrumb)
 
         self
@@ -48,7 +48,7 @@ module Honeybadger
       # block returns a falsy value
       #
       def drop_previous_breadcrumb_if
-        @buffer.drop if (previous && block_given? && yield(previous))
+        @buffer.drop if previous && block_given? && yield(previous)
       end
 
       # All active breadcrumbs you want to remove a breadcrumb from the trail,
@@ -61,7 +61,7 @@ module Honeybadger
 
       def to_h
         {
-          enabled: @config[:'breadcrumbs.enabled'],
+          enabled: @config[:"breadcrumbs.enabled"],
           trail: trail.map(&:to_h)
         }
       end

data/lib/honeybadger/breadcrumbs/logging.rb

@@ -1,3 +1,5 @@
+require "honeybadger/util/sanitizer"
+
 module Honeybadger
   module Breadcrumbs
     # @api private
@@ -7,10 +9,10 @@ module Honeybadger
         org_severity, org_message, org_progname = severity, message, progname
         if defined?(Dry::Logger::Entry) && progname.is_a?(Dry::Logger::Entry) # Hanami uses dry-logger
           message, progname = progname.message || progname.exception, progname.progname
-        else
-          message, progname = [progname, nil] if message.nil?
+        elsif message.nil?
+          message, progname = [progname, nil]
         end
-        message = message && message.to_s.strip
+        message &&= Util::Sanitizer.sanitize(message.to_s)&.strip
         unless should_ignore_log?(message, progname)
           Honeybadger.add_breadcrumb(message, category: :log, metadata: {
             severity: format_severity(severity),
@@ -25,9 +27,9 @@ module Honeybadger
 
       def should_ignore_log?(message, progname)
         message.nil? ||
-        message == "" ||
-        Thread.current[:__hb_within_log_subscriber] ||
-        progname == "honeybadger"
+          message == "" ||
+          Thread.current[:__hb_within_log_subscriber] ||
+          progname == "honeybadger"
       end
     end
 
@@ -39,17 +41,14 @@ module Honeybadger
     # class that provides LogSubscriber events, we want to filter out those
     # logs as they just become noise.
     module LogSubscriberInjector
-      %w(info debug warn error fatal unknown).each do |level|
+      %w[info debug warn error fatal unknown].each do |level|
         define_method(level) do |*args, &block|
-          begin
-            Thread.current[:__hb_within_log_subscriber] = true
-            super(*args, &block)
-          ensure
-            Thread.current[:__hb_within_log_subscriber] = false
-          end
+          Thread.current[:__hb_within_log_subscriber] = true
+          super(*args, &block)
+        ensure
+          Thread.current[:__hb_within_log_subscriber] = false
         end
       end
     end
   end
 end
-

data/lib/honeybadger/breadcrumbs.rb

@@ -1,6 +1,6 @@
-require 'honeybadger/breadcrumbs/ring_buffer'
-require 'honeybadger/breadcrumbs/breadcrumb'
-require 'honeybadger/breadcrumbs/collector'
+require "honeybadger/breadcrumbs/ring_buffer"
+require "honeybadger/breadcrumbs/breadcrumb"
+require "honeybadger/breadcrumbs/collector"
 
 module Honeybadger
   module Breadcrumbs

data/lib/honeybadger/cli/deploy.rb

@@ -1,7 +1,7 @@
-require 'forwardable'
-require 'honeybadger/cli/main'
-require 'honeybadger/cli/helpers'
-require 'honeybadger/util/http'
+require "forwardable"
+require "honeybadger/cli/main"
+require "honeybadger/cli/helpers"
+require "honeybadger/util/http"
 
 module Honeybadger
   module CLI
@@ -19,9 +19,9 @@ module Honeybadger
       def run
         payload = {
           environment: config.get(:env),
-          revision: options['revision'],
-          repository: options['repository'],
-          local_username: options['user']
+          revision: options["revision"],
+          repository: options["repository"],
+          local_username: options["user"]
         }
 
         response = config.backend.notify(:deploys, payload)

data/lib/honeybadger/cli/exec.rb

@@ -1,12 +1,12 @@
-require 'erb'
-require 'forwardable'
-require 'honeybadger/cli/main'
-require 'honeybadger/cli/helpers'
-require 'honeybadger/util/http'
-require 'honeybadger/util/stats'
-require 'open3'
-require 'ostruct'
-require 'thor/shell'
+require "erb"
+require "forwardable"
+require "honeybadger/cli/main"
+require "honeybadger/cli/helpers"
+require "honeybadger/util/http"
+require "honeybadger/util/stats"
+require "open3"
+require "ostruct"
+require "thor/shell"
 
 module Honeybadger
   module CLI
@@ -14,34 +14,34 @@ module Honeybadger
       extend Forwardable
       include Helpers::BackendCmd
 
-      FAILED_TEMPLATE = <<-MSG
-Honeybadger detected failure or error output for the command:
-`<%= args.join(' ') %>`
-
-PROCESS ID: <%= pid %>
-
-RESULT CODE: <%= code %>
-
-ERROR OUTPUT:
-<%= stderr %>
-
-STANDARD OUTPUT:
-<%= stdout %>
-MSG
-
-      NO_EXEC_TEMPLATE = <<-MSG
-Honeybadger failed to execute the following command:
-`<%= args.join(' ') %>`
-
-The command was not executable. Try adjusting permissions on the file.
-MSG
-
-      NOT_FOUND_TEMPLATE = <<-MSG
-Honeybadger failed to execute the following command:
-`<%= args.join(' ') %>`
-
-The command was not found. Make sure it exists in your PATH.
-MSG
+      FAILED_TEMPLATE = <<~MSG
+        Honeybadger detected failure or error output for the command:
+        `<%= args.join(' ') %>`
+        
+        PROCESS ID: <%= pid %>
+        
+        RESULT CODE: <%= code %>
+        
+        ERROR OUTPUT:
+        <%= stderr %>
+        
+        STANDARD OUTPUT:
+        <%= stdout %>
+      MSG
+
+      NO_EXEC_TEMPLATE = <<~MSG
+        Honeybadger failed to execute the following command:
+        `<%= args.join(' ') %>`
+        
+        The command was not executable. Try adjusting permissions on the file.
+      MSG
+
+      NOT_FOUND_TEMPLATE = <<~MSG
+        Honeybadger failed to execute the following command:
+        `<%= args.join(' ') %>`
+        
+        The command was not found. Make sure it exists in your PATH.
+      MSG
 
       def initialize(options, args, config)
         @options = options
@@ -59,17 +59,17 @@ MSG
           api_key: config.get(:api_key),
           notifier: NOTIFIER,
           error: {
-            class: 'honeybadger exec error',
+            class: "honeybadger exec error",
             message: result.msg
           },
           request: {
             component: executable,
             context: {
-              command: args.join(' '),
+              command: args.join(" "),
               code: result.code,
               pid: result.pid,
               pwd: Dir.pwd,
-              path: ENV['PATH']
+              path: ENV["PATH"]
             }
           },
           server: {
@@ -112,7 +112,7 @@ MSG
       end
 
       def exec_cmd
-        stdout, stderr, status = Open3.capture3(args.join(' '))
+        stdout, stderr, status = Open3.capture3(args.join(" "))
 
         success = status.success? && stderr =~ BLANK
         pid = status.pid

data/lib/honeybadger/cli/helpers.rb

@@ -3,24 +3,24 @@ module Honeybadger
     module Helpers
       module BackendCmd
         def error_message(response)
-          host = config.get(:'connection.host')
-          <<-MSG
-!! --- Honeybadger request failed --------------------------------------------- !!
-
-We encountered an error when contacting the server:
-
-  #{response.error_message}
-
-To fix this issue, please try the following:
-
-  - Make sure the gem is configured properly.
-  - Retry executing this command a few times.
-  - Make sure you can connect to #{host} (`curl https://#{host}/v1/notices`).
-  - Email support@honeybadger.io for help. Include as much debug info as you
-    can for a faster resolution!
-
-!! --- End -------------------------------------------------------------------- !!
-MSG
+          host = config.get(:"connection.host")
+          <<~MSG
+            !! --- Honeybadger request failed --------------------------------------------- !!
+            
+            We encountered an error when contacting the server:
+            
+              #{response.error_message}
+            
+            To fix this issue, please try the following:
+            
+              - Make sure the gem is configured properly.
+              - Retry executing this command a few times.
+              - Make sure you can connect to #{host} (`curl https://#{host}/v1/notices`).
+              - Email support@honeybadger.io for help. Include as much debug info as you
+                can for a faster resolution!
+            
+            !! --- End -------------------------------------------------------------------- !!
+          MSG
         end
       end
     end

data/lib/honeybadger/cli/heroku.rb

@@ -1,50 +1,50 @@
 module Honeybadger
   module CLI
     class Heroku < Thor
-      class_option :app, aliases: :'-a', type: :string, default: nil, desc: 'Specify optional Heroku APP'
+      class_option :app, aliases: :"-a", type: :string, default: nil, desc: "Specify optional Heroku APP"
 
-      desc 'install_deploy_notification', 'Install Heroku deploy notifications addon'
-      option :api_key, aliases: :'-k', type: :string, desc: 'Api key of your Honeybadger application'
-      option :environment, aliases: :'-e', type: :string, desc: 'Environment of your Heroku application (i.e. "production", "staging")'
+      desc "install_deploy_notification", "Install Heroku deploy notifications addon"
+      option :api_key, aliases: :"-k", type: :string, desc: "Api key of your Honeybadger application"
+      option :environment, aliases: :"-e", type: :string, desc: 'Environment of your Heroku application (i.e. "production", "staging")'
       def install_deploy_notification
-        app       = options.has_key?('app') ? options['app'] : detect_heroku_app(false)
-        rails_env = options['environment'] || heroku_var('RAILS_ENV', app)
-        api_key   = options['api_key'] || heroku_var('HONEYBADGER_API_KEY', app)
+        app = options.has_key?("app") ? options["app"] : detect_heroku_app(false)
+        rails_env = options["environment"] || heroku_var("RAILS_ENV", app)
+        api_key = options["api_key"] || heroku_var("HONEYBADGER_API_KEY", app)
 
-        unless api_key =~ /\S/
+        unless /\S/.match?(api_key)
           say("Unable to detect your API key from Heroku.", :red)
-          say('Have you configured multiple Heroku apps? Try using --app APP', :red) unless app
+          say("Have you configured multiple Heroku apps? Try using --app APP", :red) unless app
           exit(1)
         end
 
-        unless rails_env =~ /\S/
+        unless /\S/.match?(rails_env)
           say("Unable to detect your environment from Heroku. Use --environment ENVIRONMENT.", :red)
-          say('Have you configured multiple Heroku apps? Try using --app APP', :red) unless app
+          say("Have you configured multiple Heroku apps? Try using --app APP", :red) unless app
           exit(1)
         end
 
-        cmd = %Q(heroku webhooks:add -i api:release -l notify -u "https://api.honeybadger.io/v1/deploys/heroku?environment=#{rails_env}&api_key=#{api_key}"#{app ? " --app #{app}" : ''})
+        cmd = %(heroku webhooks:add -i api:release -l notify -u "https://api.honeybadger.io/v1/deploys/heroku?environment=#{rails_env}&api_key=#{api_key}"#{app ? " --app #{app}" : ""})
 
         say("Running: `#{cmd}`")
         say(run(cmd))
       end
 
-      desc 'install API_KEY', 'Install Honeybadger on Heroku using API_KEY'
+      desc "install API_KEY", "Install Honeybadger on Heroku using API_KEY"
       def install(api_key)
         say("Installing Honeybadger #{VERSION} for Heroku")
 
         app = options[:app] || detect_heroku_app(false)
         say("Adding config HONEYBADGER_API_KEY=#{api_key} to Heroku.", :magenta)
-        unless write_heroku_env({'HONEYBADGER_API_KEY' => api_key}, app)
-          say('Unable to update heroku config. You may need to specify an app name with --app APP', :red)
+        unless write_heroku_env({"HONEYBADGER_API_KEY" => api_key}, app)
+          say("Unable to update heroku config. You may need to specify an app name with --app APP", :red)
           exit(1)
         end
 
-        if env = heroku_var('RAILS_ENV', app, heroku_var('RACK_ENV', app))
-          say('Installing deploy notification addon', :magenta)
-          invoke :install_deploy_notification, [], { app: app, api_key: api_key, environment: env }
+        if (env = heroku_var("RAILS_ENV", app, heroku_var("RACK_ENV", app)))
+          say("Installing deploy notification addon", :magenta)
+          invoke :install_deploy_notification, [], {app: app, api_key: api_key, environment: env}
         else
-          say('Skipping deploy notification installation: we were unable to determine the environment name from your Heroku app.', :yellow)
+          say("Skipping deploy notification installation: we were unable to determine the environment name from your Heroku app.", :yellow)
           say("To install manually, try `honeybadger heroku install_deploy_notification#{app ? " -a #{app}" : ""} -k #{api_key} --environment ENVIRONMENT`", :yellow)
         end
 
@@ -60,14 +60,14 @@ module Honeybadger
       #
       # Returns the String app name if detected, otherwise nil.
       def detect_heroku_app(prompt_on_default = true)
-        apps, git_config = {}, File.join(Dir.pwd, '.git', 'config')
+        apps, git_config = {}, File.join(Dir.pwd, ".git", "config")
         if File.exist?(git_config)
-          require 'inifile'
+          require "inifile"
           ini = IniFile.load(git_config)
           ini.each_section do |section|
-            if match = section.match(/remote \"(?<remote>.+)\"/)
-              url = ini[section]['url']
-              if url_match = url.match(/heroku\.com:(?<app>.+)\.git$/)
+            if (match = section.match(/remote "(?<remote>.+)"/))
+              url = ini[section]["url"]
+              if (url_match = url.match(/heroku\.com:(?<app>.+)\.git$/))
                 apps[match[:remote]] = url_match[:app]
               end
             end
@@ -78,16 +78,16 @@ module Honeybadger
               apps.values.first
             else
               say "We detected a Heroku app named #{apps.values.first}. Do you want to load the config? (y/yes or n/no)"
-              if STDIN.gets.chomp =~ /(y|yes)/i
+              if /(y|yes)/i.match?($stdin.gets.chomp)
                 apps.values.first
               end
             end
           elsif apps.size > 1
             say "We detected the following Heroku apps:"
-            apps.each_with_index {|a,i| say "\s\s#{i+1}. #{a[1]}" }
-            say "\s\s#{apps.size+1}. Use default"
-            say "Please select an option (1-#{apps.size+1}):"
-            apps.values[STDIN.gets.chomp.to_i-1]
+            apps.each_with_index { |a, i| say "\s\s#{i + 1}. #{a[1]}" }
+            say "\s\s#{apps.size + 1}. Use default"
+            say "Please select an option (1-#{apps.size + 1}):"
+            apps.values[$stdin.gets.chomp.to_i - 1]
           end
         end
       end
@@ -97,29 +97,29 @@ module Honeybadger
       end
 
       def heroku_var(var, app_name, default = nil)
-        app = app_name ? "--app #{app_name}" : ''
+        app = app_name ? "--app #{app_name}" : ""
         result = run("heroku config:get #{var} #{app} 2> /dev/null").strip
-        result.split.find(lambda { default }) {|x| x =~ /\S/ }
+        result.split.find(lambda { default }) { |x| x =~ /\S/ }
       end
 
       def read_heroku_env(app = nil)
-        cmd = ['heroku config']
+        cmd = ["heroku config"]
         cmd << "--app #{app}" if app
         output = run(cmd.join("\s"))
         return false unless $?.to_i == 0
-        Hash[output.scan(/(HONEYBADGER_[^:]+):\s*(\S.*)\s*$/)]
+        output.scan(/(HONEYBADGER_[^:]+):\s*(\S.*)\s*$/).to_h
       end
 
       def set_env_from_heroku(app = nil)
-        return false unless env = read_heroku_env(app)
-        env.each_pair do |k,v|
+        return false unless (env = read_heroku_env(app))
+        env.each_pair do |k, v|
           ENV[k] ||= v
         end
       end
 
       def write_heroku_env(env, app = nil)
         cmd = ["heroku config:set"]
-        Hash(env).each_pair {|k,v| cmd << "#{k}=#{v}" }
+        Hash(env).each_pair { |k, v| cmd << "#{k}=#{v}" }
         cmd << "--app #{app}" if app
         run(cmd.join("\s"))
         $?.to_i == 0