honeybadger 5.0.0 → 5.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2a2ce33f6ebc41718667b59e4c9aafa07ff171b7ebaa01ec6f0dda61ee5f35b
-  data.tar.gz: 3c84dc54194ffaaf5c5623048de44d6a9c22e64684c877b16c725836a63f5017
+  metadata.gz: 5a2c2c0edaf0bade862e18a686e2f58270e0b11e93a6db396a77a8d7f1e301bd
+  data.tar.gz: 16b138e134ad212fa887473ff9d97a11467bd6d08f20cff001e71d926c562cd3
 SHA512:
-  metadata.gz: 4733b0ed3b93686aa2441d0e24e07535de45130da9145bf53efae6b0e3a6ccb86b322f72fcaea1cc307a6714f3a1d9c3ac106492b6d95ddabda861df940cbae6
-  data.tar.gz: b7aed73d5785b846faa2186a8d6f6549a43c8fdc33a42f3b52db93c4e3ba7cc6b2c4768e31ad5904fd94add2659d73361bf17de1278c025c67a82ffc1143f0b1
+  metadata.gz: fc0893711e71d35abd15d4ac3c2f40eb6ec21ac46702235287b82c229294c6375e4a8c767cf20dcaa1db4c6f86016385741387d8e7cc6eece65f73655889c5c4
+  data.tar.gz: 184d5df4dc67c18d03aa5bcbd5aaaca53b528dc33e9337675c18035c0600e1cfbcdb4b93c484a81ba8b98cda3b6458c2e6b831f1239dc19bb0b35e5c35ebc26c

data/CHANGELOG.md

@@ -5,6 +5,39 @@ adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [5.2.1] - 2023-03-14
+### Fixed
+- Remove ANSI escape codes from detailed error message in Ruby 3.2 (#473)
+
+## [5.2.0] - 2023-02-28
+### Added
+- First-class support for Hanami (#470)
+- Auto-add Sinatra optional middleware (#471). This is fine, as they don't do anything without the magic strings (and they can be disabled via config, anyway).
+
+## [5.1.0] - 2023-01-31
+### Added
+- Support for `Exception#detailed_message` on Ruby 3.2 (#459)
+- Added `notice.parsed_backtrace` method, meant to make custom fingerprints easier (#454)
+- Support for Sidekiq 7 (#458)
+
+### Changed
+- On Rails 7, The Honeybadger gem now prioritises the more detailed integrations' native error handlers instead of `Rails.error`, to avoid loss of context (#460)
+
+### Fixed
+- Stopped the Rails middleware from crashing due to changes on Rails 7.1 (#464)
+
+## [5.0.2] - 2022-11-04
+### Fixed
+- `Honeybadger.check_in` would raise an exception when used with the test backend (#449)
+
+## [5.0.1] - 2022-10-27
+### Fixed
+- Ignore `Sidekiq::JobRetry` skip exception. Since support was added for Rails 7
+  error reporting interface these exceptions are being reported in addition to
+  the exception that caused the job to be retried. Mike Perham says these
+  exceptions can safely be ignored.
+  See https://github.com/rails/rails/pull/43625#issuecomment-1071574110
+
 ## [5.0.0] - 2022-10-18
 ### Changed
 - `Honeybadger.notify` is now idempotent; it will skip reporting exception

data/README.md

@@ -10,7 +10,7 @@ When an uncaught exception occurs, Honeybadger will POST the relevant data to th
 
 ## Documentation and Support
 
-For comprehensive documentation and support, [check out our documentation site](https://docs.honeybadger.io/ruby/index.html).
+For comprehensive documentation and support, [check out our documentation site](https://docs.honeybadger.io/lib/ruby/).
 
 ## Changelog
 

data/lib/honeybadger/backend/test.rb

@@ -39,6 +39,7 @@ module Honeybadger
 
       def check_in(id)
         check_ins << id
+        super
       end
     end
   end

data/lib/honeybadger/breadcrumbs/logging.rb

@@ -5,7 +5,11 @@ module Honeybadger
     module LogWrapper
       def add(severity, message = nil, progname = nil)
         org_severity, org_message, org_progname = severity, message, progname
-        message, progname = [progname, nil] if message.nil?
+        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?
+        end
         message = message && message.to_s.strip
         unless should_ignore_log?(message, progname)
           Honeybadger.add_breadcrumb(message, category: :log, metadata: {

data/lib/honeybadger/config/defaults.rb

@@ -28,7 +28,8 @@ module Honeybadger
                       'Rack::QueryParser::InvalidParameterError',
                       'CGI::Session::CookieStore::TamperedWithCookie',
                       'Mongoid::Errors::DocumentNotFound',
-                      'Sinatra::NotFound'].map(&:freeze).freeze
+                      'Sinatra::NotFound',
+                      'Sidekiq::JobRetry::Skip'].map(&:freeze).freeze
 
     DEVELOPMENT_ENVIRONMENTS = ['development', 'test', 'cucumber'].map(&:freeze).freeze
 
@@ -301,8 +302,11 @@ module Honeybadger
         type: Boolean
       },
       :'rails.subscriber_ignore_sources' => {
-        description: "Sources (strings or regexes) that should be ignored when using the Rails' (7+) native error reporter.",
-        default: [],
+        description: "Sources (strings or regexes) that should be ignored when using the Rails' (7+) native error reporter (handled exceptions only).",
+        # External libraries (eg Sidekiq, Resque) may wrap their execution in Rails' executor.
+        # But this means errors will first be reported by Rails.error, before the library's native error handler
+        # We ignore these reports, since the native error handler provides more context (such as job details)
+        default: ['application.active_support'],
         type: Array
       },
       :'resque.resque_retry.send_exceptions_when_retrying' => {

data/lib/honeybadger/config.rb

@@ -271,6 +271,8 @@ module Honeybadger
         :rails
       elsif defined?(::Sinatra::VERSION)
         :sinatra
+      elsif defined?(::Hanami::VERSION) && ::Hanami::VERSION >= '2.0'
+        :hanami
       elsif defined?(::Rack.release)
         :rack
       else
@@ -282,6 +284,7 @@ module Honeybadger
       case detected_framework
       when :rails then "Rails #{::Rails::VERSION::STRING}"
       when :sinatra then "Sinatra #{::Sinatra::VERSION}"
+      when :hanami then "Hanami #{::Hanami::VERSION}"
       when :rack then "Rack #{::Rack.release}"
       else
         "Ruby #{RUBY_VERSION}"

data/lib/honeybadger/init/hanami.rb

@@ -0,0 +1,19 @@
+require 'honeybadger/ruby'
+
+Honeybadger.init!({
+  :framework => :hanami,
+  :env => ENV['HANAMI_ENV'] || ENV['RACK_ENV'],
+  :'logging.path' => 'STDOUT'
+})
+
+Honeybadger.load_plugins!
+
+if Hanami::VERSION >= '2.0'
+  Hanami.app.instance_eval do
+    config.middleware.use Honeybadger::Rack::UserFeedback
+    config.middleware.use Honeybadger::Rack::UserInformer
+    config.middleware.use Honeybadger::Rack::ErrorNotifier
+  end
+end
+
+Honeybadger.install_at_exit_callback

data/lib/honeybadger/init/sinatra.rb

@@ -28,7 +28,13 @@ module Honeybadger
           def install_honeybadger
             config = Honeybadger.config
             return unless config[:'sinatra.enabled']
-            install_honeybadger_middleware(Honeybadger::Rack::ErrorNotifier) if config[:'exceptions.enabled']
+            if config[:'exceptions.enabled']
+              # These two must come before the ErrorNotifier, since an error/response
+              # passes through middleware from inner to outer (bottom to top)
+              install_honeybadger_middleware(Honeybadger::Rack::UserFeedback)
+              install_honeybadger_middleware(Honeybadger::Rack::UserInformer)
+              install_honeybadger_middleware(Honeybadger::Rack::ErrorNotifier)
+            end
           end
 
           def install_honeybadger_middleware(klass)

data/lib/honeybadger/notice.rb

@@ -144,6 +144,14 @@ module Honeybadger
     # Custom details data
     attr_accessor :details
 
+    # The parsed exception backtrace. Lines in this backtrace that are from installed gems
+    # have the base path for gem installs replaced by "[GEM_ROOT]", while those in the project
+    # have "[PROJECT_ROOT]".
+    # @return [Array<{:number, :file, :method => String}>]
+    def parsed_backtrace
+      @parsed_backtrace ||= parse_backtrace(backtrace)
+    end
+
     # @api private
     # Cache project path substitutions for backtrace lines.
     PROJECT_ROOT_CACHE = {}
@@ -192,7 +200,10 @@ module Honeybadger
 
       self.error_class = exception_attribute(:error_class, 'Notice') {|exception| exception.class.name }
       self.error_message = exception_attribute(:error_message, 'No message provided') do |exception|
-        "#{exception.class.name}: #{exception.message}"
+        message = exception.respond_to?(:detailed_message) ?
+          exception.detailed_message(highlight: false).sub(" (#{exception.class.name})", '') # Gems like error_highlight append the exception class name
+          : exception.message
+        "#{exception.class.name}: #{message}"
       end
       self.backtrace = exception_attribute(:backtrace, caller)
       self.cause = opts.key?(:cause) ? opts[:cause] : (exception_cause(@exception) || $!)
@@ -235,7 +246,7 @@ module Honeybadger
           token: id,
           class: s(error_class),
           message: s(error_message),
-          backtrace: s(parse_backtrace(backtrace)),
+          backtrace: s(parsed_backtrace),
           fingerprint: fingerprint_hash,
           tags: s(tags),
           causes: s(prepare_causes(causes))
@@ -297,7 +308,7 @@ module Honeybadger
     end
 
     # Gets a property named "attribute" of an exception, either from
-    # the #args hash or actual exception (in order of precidence).
+    # the #args hash or actual exception (in order of precedence).
     #
     # attribute - A Symbol existing as a key in #args and/or attribute on
     #             Exception.

data/lib/honeybadger/plugins/rails.rb

@@ -13,7 +13,7 @@ module Honeybadger
         #
         # @return The super value of the middleware's +#render_exception()+
         #   method.
-        def render_exception(arg, exception)
+        def render_exception(arg, exception, *args)
           if arg.kind_of?(::ActionDispatch::Request)
             request = arg
             env = request.env
@@ -25,18 +25,28 @@ module Honeybadger
           env['honeybadger.exception'] = exception
           env['honeybadger.request.url'] = request.url rescue nil
 
-          super(arg, exception)
+          super(arg, exception, *args)
         end
       end
 
       class ErrorSubscriber
         def self.report(exception, handled:, severity:, context: {}, source: nil)
-          return if source && ::Honeybadger.config[:'rails.subscriber_ignore_sources'].any? { |regex| regex.match?(source) }
+          # We only report unhandled errors (`Rails.error.handle`)
+          # Unhandled errors will be caught by our integrations (eg middleware), which have richer context
+          return unless handled
+
+          return if source_ignored?(source)
 
           tags = ["severity:#{severity}", "handled:#{handled}"]
           tags << "source:#{source}" if source
           Honeybadger.notify(exception, context: context, tags: tags)
         end
+
+        def self.source_ignored?(source)
+          source && ::Honeybadger.config[:'rails.subscriber_ignore_sources'].any? do |ignored_source|
+            ignored_source.is_a?(Regexp) ? ignored_source.match?(source) : (ignored_source == source)
+          end
+        end
       end
 
       Plugin.register :rails_exceptions_catcher do
@@ -52,8 +62,7 @@ module Honeybadger
             ::ActionDispatch::ShowExceptions.prepend(ExceptionsCatcher)
           end
 
-          if defined?(::ActiveSupport::ErrorReporter)
-            # Rails 7
+          if defined?(::ActiveSupport::ErrorReporter) # Rails 7
             ::Rails.error.subscribe(ErrorSubscriber)
           end
         end

data/lib/honeybadger/plugins/sidekiq.rb

@@ -23,8 +23,15 @@ module Honeybadger
 
           if defined?(::Sidekiq::VERSION) && ::Sidekiq::VERSION > '3'
             ::Sidekiq.configure_server do |sidekiq|
-              sidekiq.error_handlers << lambda { |ex, params|
+
+              sidekiq.error_handlers << lambda { |ex, sidekiq_params|
+                params = sidekiq_params.dup
+                if defined?(::Sidekiq::Config) && params[:_config].is_a?(::Sidekiq::Config)
+                  params[:_config] = params[:_config].instance_variable_get(:@options)
+                end
+
                 job = params[:job] || params
+
                 job_retry = job['retry'.freeze]
 
                 if (threshold = config[:'sidekiq.attempt_threshold'].to_i) > 0 && job_retry
@@ -36,9 +43,11 @@ module Honeybadger
                   retry_count = job['retry_count'.freeze]
                   attempt = retry_count ? retry_count + 1 : 0
 
+                  max_retries = (::Sidekiq::VERSION > '7') ?
+                    ::Sidekiq.default_configuration[:max_retries] : sidekiq.options[:max_retries]
                   # Ensure we account for modified max_retries setting
                   default_max_retry_attempts = defined?(::Sidekiq::JobRetry::DEFAULT_MAX_RETRY_ATTEMPTS) ? ::Sidekiq::JobRetry::DEFAULT_MAX_RETRY_ATTEMPTS : 25
-                  retry_limit = job_retry == true ? (sidekiq.options[:max_retries] || default_max_retry_attempts) : job_retry.to_i
+                  retry_limit = job_retry == true ? (max_retries || default_max_retry_attempts) : job_retry.to_i
 
                   limit = [retry_limit, threshold].min
 

data/lib/honeybadger/version.rb

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

data/lib/honeybadger.rb

@@ -2,6 +2,8 @@ if defined?(::Rails::Railtie)
   require 'honeybadger/init/rails'
 elsif defined?(Sinatra::Base)
   require 'honeybadger/init/sinatra'
+elsif defined?(::Hanami)
+  require 'honeybadger/init/hanami'
 else
   require 'honeybadger/init/ruby'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: honeybadger
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.2.1
 platform: ruby
 authors:
 - Honeybadger Industries LLC
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-18 00:00:00.000000000 Z
+date: 2023-03-14 00:00:00.000000000 Z
 dependencies: []
 description: Make managing application errors a more pleasant experience.
 email:
@@ -55,6 +55,7 @@ files:
 - lib/honeybadger/const.rb
 - lib/honeybadger/context_manager.rb
 - lib/honeybadger/conversions.rb
+- lib/honeybadger/init/hanami.rb
 - lib/honeybadger/init/rails.rb
 - lib/honeybadger/init/rake.rb
 - lib/honeybadger/init/ruby.rb
@@ -131,10 +132,15 @@ files:
 - vendor/cli/thor/shell/html.rb
 - vendor/cli/thor/util.rb
 - vendor/cli/thor/version.rb
-homepage: https://github.com/honeybadger-io/honeybadger-ruby
+homepage: https://www.honeybadger.io/for/ruby/
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/honeybadger-io/honeybadger-ruby/issues
+  changelog_uri: https://github.com/honeybadger-io/honeybadger-ruby/blob/master/CHANGELOG.md
+  documentation_uri: https://docs.honeybadger.io/lib/ruby/
+  homepage_uri: https://www.honeybadger.io/for/ruby/
+  source_code_uri: https://github.com/honeybadger-io/honeybadger-ruby
 post_install_message:
 rdoc_options:
 - "--markup=tomdoc"