honeybadger 4.5.5 → 4.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d10b44dcc496d25ac018e8b636886a72bf143ab354a63e65f72a01ac93012c48
-  data.tar.gz: 823b72ff2411d1432eef6a7350b1f0eea6b0419a75e76c978ac4c4fa517b0444
+  metadata.gz: ae86ea681a8b1e58775976adc5fe1300cfa043865c9a72344b5ae2dfcde2565a
+  data.tar.gz: 98a92af83ec77fff0fba12fd551ca81417ed04d0cfdba225a262f1db2786ad82
 SHA512:
-  metadata.gz: fac043a475c0bec627d4596e9668a05abdb32da750cfa77d5c2bd1e2d9abce479f7d3a1126c7ac8ff09edec7bec3a03c4ad70b728d643617ad7712647cd2f424
-  data.tar.gz: 302b5d830b45cb93b0592aee5d8d75ad33af920b3e020746ba881dfa8392ac324ebe60b681b970c9e05eb36b5c2dbe3de3f67701a9a7c12f3c9a4c9424b8a7cd
+  metadata.gz: bad75cfca393708ec07292b6e34257afdaad23753e7fe26b96e8c9d1ca5d46099f9da13b93b53d49d5a77569913e0048a883cc6bf73b04686d85060805e8d681
+  data.tar.gz: 79e8f88c82d3e8da1eb968b4f9df0ba88da145a034cd6c82cd7e3bf84649d9d5d3c7e3586ce12e391b3f097c9a955231654a825726ac9a697050ffdbca2df64d

data/CHANGELOG.md

@@ -5,6 +5,43 @@ adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [4.7.2] - 2020-08-17
+### Fixed
+- Remove usage of `ActiveRecord::Base.connection` (thanks @jcoyne for testing)
+- Check for UTF-8 in ActiveRecord breadcrumb exclusion filter
+
+## [4.7.1] - 2020-08-11
+### Fixed
+- ActiveRecord SQL Breadcrumb event pulls adapter from supplied connection,
+  allowing for multiple databases.
+- Fix Rails deprecation of `ActionDispatch::ParamsParser::ParseError`
+- Deal with invalid UTF-8 byte sequences during SQL obfuscation
+- Fix Ruby 2.7 deprecation notice in sql.rb
+
+## [4.7.0] - 2020-06-02
+### Fixed
+- Alias `Notice#controller=` as `Notice#component=`
+- Fix Rails 6.1 deprecation warning with `ActiveRecord::Base.connection_config`
+- Fix agent where breadcrumbs.enabled = true and local_context = true
+
+### Added
+- Add `honeybadger_skip_rails_load` Capistrano option to skip rails load on
+  deployment notification (#355) -@NielsKSchjoedt
+
+## [4.6.0] - 2020-03-12
+### Fixed
+- Fixed issue where Sidekiq.attempt_threshold was triggering 2 attempts ahead
+  of the setting
+- Dup notify opts before mutating (#345)
+
+### Changed
+- Breadcrumbs on by default
+- Added Faktory plugin -@scottrobertson
+
+## [4.5.6] - 2020-01-08
+### Fixed
+- Fix remaining Ruby 2.7 deprecation warnings
+
 ## [4.5.5] - 2020-01-06
 ### Fixed
 - Replace empty `Proc.new` with explicit block param to suppress warnings

data/README.md

@@ -1,6 +1,7 @@
 # Honeybadger for Ruby
 
-[![CircleCI](https://circleci.com/gh/honeybadger-io/honeybadger-ruby.svg?style=svg)](https://circleci.com/gh/honeybadger-io/honeybadger-ruby)
+![Ruby](https://github.com/honeybadger-io/honeybadger-ruby/workflows/Ruby/badge.svg)
+![JRuby](https://github.com/honeybadger-io/honeybadger-ruby/workflows/JRuby/badge.svg)
 [![Gem Version](https://badge.fury.io/rb/honeybadger.svg)](http://badge.fury.io/rb/honeybadger)
 [![SemVer](https://api.dependabot.com/badges/compatibility_score?dependency-name=honeybadger&package-manager=bundler&version-scheme=semver)](https://dependabot.com/compatibility-score.html?dependency-name=honeybadger&package-manager=bundler&version-scheme=semver)
 

data/lib/honeybadger/agent.rb

@@ -63,13 +63,17 @@ module Honeybadger
       end
 
       @context = opts.delete(:context)
-      if opts.delete(:local_context)
+      local_context = opts.delete(:local_context)
+
+      @config ||= Config.new(opts)
+
+      if local_context
         @context ||= ContextManager.new
         @breadcrumbs = Breadcrumbs::Collector.new(config)
+      else
+        @breadcrumbs = nil
       end
 
-      @config ||= Config.new(opts)
-
       init_worker
     end
 
@@ -115,6 +119,8 @@ module Honeybadger
     # @return [String] UUID reference to the notice within Honeybadger.
     # @return [false] when ignored.
     def notify(exception_or_opts, opts = {})
+      opts = opts.dup
+
       if exception_or_opts.is_a?(Exception)
         opts[:exception] = exception_or_opts
       elsif exception_or_opts.respond_to?(:to_hash)
@@ -278,7 +284,7 @@ module Honeybadger
         metadata: metadata
       })
 
-      breadcrumbs.add!(Breadcrumbs::Breadcrumb.new(params))
+      breadcrumbs.add!(Breadcrumbs::Breadcrumb.new(**params))
 
       self
     end

data/lib/honeybadger/breadcrumbs/active_support.rb

@@ -15,17 +15,19 @@ module Honeybadger
               ["Active Record", name].compact.join(" - ")
             end,
             category: "query",
-            select_keys: [:sql, :name, :connection_id, :cached],
+            select_keys: [:sql, :name, :connection, :connection_id, :cached],
             transform: lambda do |data|
               if data[:sql]
-                adapter = ::ActiveRecord::Base.connection_config[:adapter]
+                connection = data.delete(:connection)
+                adapter = (connection && connection.adapter_name.downcase) || active_record_connection_db_config[:adapter]
                 data[:sql] = Util::SQL.obfuscate(data[:sql], adapter)
               end
               data
             end,
             exclude_when: lambda do |data|
               # Ignore schema, begin, and commit transaction queries
-              data[:name] == "SCHEMA" || (data[:sql] && (data[:sql] =~ /^(begin|commit)( transaction)?$/i))
+              data[:name] == "SCHEMA" ||
+                (data[:sql] && (Util::SQL.force_utf_8(data[:sql].dup) =~ /^(begin|commit)( transaction)?$/i))
             end
           },
 
@@ -103,6 +105,15 @@ module Honeybadger
         }
       end
 
+      private_class_method def self.active_record_connection_db_config
+        if ::ActiveRecord::Base.respond_to?(:connection_db_config)
+          # >= Rails 6.1
+          ::ActiveRecord::Base.connection_db_config.configuration_hash
+        else
+          # < Rails 6.1
+          ::ActiveRecord::Base.connection_config
+        end
+      end
     end
   end
 end

data/lib/honeybadger/cli/helpers.rb

@@ -15,7 +15,7 @@ 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} (`ping #{host}`).
+  - 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!
 

data/lib/honeybadger/cli/main.rb

@@ -196,7 +196,7 @@ WELCOME
 # What can I do?
 
   - Retry the command.
-  - Make sure you can connect to api.honeybadger.io (`ping api.honeybadger.io`).
+  - Make sure you can connect to api.honeybadger.io (`curl https://api.honeybadger.io/v1/notices`).
   - If you continue to see this message, email us at support@honeybadger.io
     (don't forget to attach this output!)
 

data/lib/honeybadger/cli/test.rb

@@ -175,7 +175,7 @@ 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} (`ping #{host}`).
+  - 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!
 

data/lib/honeybadger/config/defaults.rb

@@ -13,7 +13,12 @@ module Honeybadger
                       'ActionController::UnknownFormat',
                       'ActionController::InvalidAuthenticityToken',
                       'ActionController::InvalidCrossOriginRequest',
+                      # ActionDispatch::ParamsParser::ParseError was removed in Rails 6.0
+                      # and may be removed here once support for Rails 5.2 is dropped.
+                      # https://github.com/rails/rails/commit/e16c765ac6dcff068ff2e5554d69ff345c003de1
+                      # https://github.com/honeybadger-io/honeybadger-ruby/pull/358
                       'ActionDispatch::ParamsParser::ParseError',
+                      'ActionDispatch::Http::Parameters::ParseError',
                       'ActionController::BadRequest',
                       'ActionController::ParameterMissing',
                       'ActiveRecord::RecordNotFound',
@@ -279,6 +284,11 @@ module Honeybadger
         default: 0,
         type: Integer
       },
+      :'faktory.attempt_threshold' => {
+        description: 'The number of attempts before notifications will be sent.',
+        default: 0,
+        type: Integer
+      },
       :'sidekiq.use_component' => {
         description: 'Automatically set the component to the class of the job. Helps with grouping.',
         default: true,
@@ -295,8 +305,8 @@ module Honeybadger
         type: Boolean
       },
       :'breadcrumbs.enabled' => {
-        description: 'Enable/Disable breadcrumb functionality.',
-        default: false,
+        description: 'Disable breadcrumb functionality.',
+        default: true,
         type: Boolean
       },
       :'breadcrumbs.active_support_notifications' => {

data/lib/honeybadger/notice.rb

@@ -42,6 +42,10 @@ module Honeybadger
   # @api private
   MAX_EXCEPTION_CAUSES = 5
 
+  # @api private
+  # Binding#source_location was added in Ruby 2.6.
+  BINDING_HAS_SOURCE_LOCATION = Binding.method_defined?(:source_location)
+
   class Notice
     extend Forwardable
 
@@ -114,6 +118,7 @@ module Honeybadger
     # The component (if any) which was used in this request (usually the controller).
     attr_accessor :component
     alias_method :controller, :component
+    alias_method :controller=, :component=
 
     # The action (if any) that was called in this request.
     attr_accessor :action
@@ -444,7 +449,13 @@ module Honeybadger
       return {} if exception.__honeybadger_bindings_stack.empty?
 
       if config[:root]
-        binding = exception.__honeybadger_bindings_stack.find { |b| b.eval('__FILE__') =~ /^#{Regexp.escape(config[:root].to_s)}/ }
+        binding = exception.__honeybadger_bindings_stack.find { |b|
+          if BINDING_HAS_SOURCE_LOCATION
+            b.source_location[0]
+          else
+            b.eval('__FILE__')
+          end =~ /^#{Regexp.escape(config[:root].to_s)}/
+        }
       end
 
       binding ||= exception.__honeybadger_bindings_stack[0]

data/lib/honeybadger/plugins/faktory.rb

@@ -0,0 +1,52 @@
+require 'honeybadger/plugin'
+require 'honeybadger/ruby'
+
+module Honeybadger
+  module Plugins
+    module Faktory
+      class Middleware
+        def call(worker, job)
+          Honeybadger.clear!
+          yield
+        end
+      end
+
+      Plugin.register do
+        requirement { defined?(::Faktory) }
+
+        execution do
+          ::Faktory.configure_worker do |faktory|
+            faktory.worker_middleware do |chain|
+              chain.prepend Middleware
+            end
+          end
+
+          ::Faktory.configure_worker do |faktory|
+            faktory.error_handlers << lambda do |ex, params|
+              opts = {parameters: params}
+
+              if job = params[:job]
+                if (threshold = config[:'faktory.attempt_threshold'].to_i) > 0
+                  # If job.failure is nil, it is the first attempt. The first
+                  # retry has a job.failure.retry_count of 0, which would be
+                  # the second attempt in our case.
+                  retry_count = job.dig('failure', 'retry_count')
+                  attempt = retry_count ? retry_count + 1 : 0
+
+                  limit = [job['retry'].to_i, threshold].min
+
+                  return if attempt < limit
+                end
+
+                opts[:component] = job['jobtype']
+                opts[:action] = 'perform'
+              end
+
+              Honeybadger.notify(ex, opts)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/honeybadger/plugins/sidekiq.rb

@@ -25,20 +25,30 @@ module Honeybadger
             ::Sidekiq.configure_server do |sidekiq|
               sidekiq.error_handlers << lambda {|ex, params|
                 job = params[:job] || params
-                retry_count = job['retry_count'.freeze].to_i
-                retry_opt = job['retry'.freeze]
-                max_retries = if retry_opt.is_a?(Integer)
-                  [retry_opt - 1, config[:'sidekiq.attempt_threshold'].to_i].min
-                else
-                  config[:'sidekiq.attempt_threshold'].to_i
+                job_retry = job['retry'.freeze]
+
+                if (threshold = config[:'sidekiq.attempt_threshold'].to_i) > 0 && job_retry
+                  # We calculate the job attempts to determine the need to
+                  # skip. Sidekiq's first job execution will have nil for the
+                  # 'retry_count' job key. The first retry will have 0 set for
+                  # the 'retry_count' key, incrementing on each execution
+                  # afterwards.
+                  retry_count = job['retry_count'.freeze]
+                  attempt = retry_count ? retry_count + 1 : 0
+
+                  # Ensure we account for modified max_retries setting
+                  retry_limit = job_retry == true ? (sidekiq.options[:max_retries] || 25) : job_retry.to_i
+                  limit = [retry_limit, threshold].min
+
+                  return if attempt < limit
                 end
 
-                return if retry_opt && retry_count < max_retries
                 opts = {parameters: params}
                 if config[:'sidekiq.use_component']
                   opts[:component] = job['wrapped'.freeze] || job['class'.freeze]
                   opts[:action] = 'perform' if opts[:component]
                 end
+
                 Honeybadger.notify(ex, opts)
               }
             end

data/lib/honeybadger/util/sanitizer.rb

@@ -187,7 +187,7 @@ module Honeybadger
 
       def valid_encoding(string)
         return string if valid_encoding?(string)
-        string.encode(Encoding::UTF_8, ENCODE_OPTS)
+        string.encode(Encoding::UTF_8, **ENCODE_OPTS)
       end
 
       def recursive?(data)

data/lib/honeybadger/util/sql.rb

@@ -11,7 +11,7 @@ module Honeybadger
       DoubleQuoters = /(postgres|sqlite|postgis)/.freeze
 
       def self.obfuscate(sql, adapter)
-        sql.dup.tap do |s|
+        force_utf_8(sql.dup).tap do |s|
           s.gsub!(EscapedQuotes, EmptyReplacement)
           s.gsub!(SQuotedData, Replacement)
           s.gsub!(DQuotedData, Replacement) if adapter =~ DoubleQuoters
@@ -20,6 +20,15 @@ module Honeybadger
           s.squeeze!(' ')
         end
       end
+
+      def self.force_utf_8(string)
+        string.encode(
+          Encoding.find('UTF-8'),
+          invalid: :replace, 
+          undef: :replace, 
+          replace: ''
+        )
+      end
     end
   end
 end

data/lib/honeybadger/version.rb

@@ -1,4 +1,4 @@
 module Honeybadger
   # The current String Honeybadger version.
-  VERSION = '4.5.5'.freeze
+  VERSION = '4.7.2'.freeze
 end

data/vendor/capistrano-honeybadger/lib/capistrano/tasks/deploy.cap

@@ -24,6 +24,7 @@ namespace :honeybadger do
 
         api_key = fetch(:honeybadger_api_key, ENV['HONEYBADGER_API_KEY'])
         options += ['--api-key', api_key] if api_key
+        options << '--skip-rails-load' if fetch(:honeybadger_skip_rails_load, false)
 
         if fetch(:honeybadger_async_notify, false)
           ::SSHKit.config.command_map.prefix[:honeybadger].push(:nohup)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: honeybadger
 version: !ruby/object:Gem::Version
-  version: 4.5.5
+  version: 4.7.2
 platform: ruby
 authors:
 - Honeybadger Industries LLC
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-07 00:00:00.000000000 Z
+date: 2020-08-17 00:00:00.000000000 Z
 dependencies: []
 description: Make managing application errors a more pleasant experience.
 email:
@@ -65,6 +65,7 @@ files:
 - lib/honeybadger/plugins/breadcrumbs.rb
 - lib/honeybadger/plugins/delayed_job.rb
 - lib/honeybadger/plugins/delayed_job/plugin.rb
+- lib/honeybadger/plugins/faktory.rb
 - lib/honeybadger/plugins/lambda.rb
 - lib/honeybadger/plugins/local_variables.rb
 - lib/honeybadger/plugins/passenger.rb
@@ -134,7 +135,7 @@ homepage: https://github.com/honeybadger-io/honeybadger-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--markup=tomdoc"
 - "--main=README.md"
@@ -152,8 +153,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Error reports you can be happy about.
 test_files: []