honeybadger 4.1.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d010f2e523efe0185206367bd3d32bfd8984ea0b6e995432772eee392676a5a
-  data.tar.gz: bdef4e603e16d0b256f2288bd2b37ebe52affa9b7803c37ef0ebfbb7bd931f14
+  metadata.gz: 4a6d163c5a87db64d1c5e591757d69dfd7be38854e01150c3ec4a86f041ea020
+  data.tar.gz: b3b56e28bd3f5885d5db6adf4d23d7f7ce7bdce8497ce62f68b3b267921a0eee
 SHA512:
-  metadata.gz: 8c0b7043750663369c7521b5987942b50dc472cd84bc90c5c773ec870b7e37676091bff5ad51a6c3725a608abd012063ccf510a83936ceb3a8b540e00c864739
-  data.tar.gz: 8653f1dd66da018309fd5dbb9f77f851a07be313822b79c830cd41b9f9222f602153dbb4314d174dac133521124ad27f5b44d984a3cf0f4e80b3c05baa78e5a8
+  metadata.gz: f4eeb6527e4de32f97020b8b19af675e17500138aafde1ee1a9541ebf9b6b09fa7f62987f63d3908c03646ff4dd2303d10460d930c2b3075a4df2054e7003371
+  data.tar.gz: 0ad30ae7ddf8a44d592cac241e5faa8b4c55589b2cba15d414e3c6d06df59f745fd2034d0cfa45334f0a81466d2b2904c65df368751af2ee87d6217ac2a5e60d

data/CHANGELOG.md

@@ -5,6 +5,15 @@ adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [4.2.0] - 2019-01-31
+### Changed
+- Issue a Notification from a Sidekiq job when either the `sidekiq.attempt_threshold` is reached OR if the job defined retry threshold is reached, whichever comes first.
+- Updated supported Ruby/Rails versions (MRI >= 2.3.0, JRuby >= 9.2, Rails >= 4.2)
+  https://docs.honeybadger.io/ruby/gem-reference/supported-versions.html
+
+### Added
+- Get the right controller / action name in Rails, when using an exception app for custom error pages.
+
 ## [4.1.0] - 2018-10-16
 ### Added
 - Added flag `--skip-rails-load` to cli commands for optionally skipping Rails initialization when running from a Rails root.

data/lib/honeybadger/plugin.rb

@@ -1,17 +1,71 @@
 require 'forwardable'
 
 module Honeybadger
-  # @api private
+  # +Honeybadger::Plugin+ defines the API for registering plugins with
+  # Honeybadger. Each plugin has requirements which must be satisified before
+  # executing the plugin's execution block(s). This allows us to detect
+  # optional dependencies and load the plugin for each dependency only if it's
+  # present in the application.
+  #
+  # See the plugins/ directory for examples of official plugins. If you're
+  # interested in developing a plugin for Honeybadger, see the Integration
+  # Guide: https://docs.honeybadger.io/ruby/gem-reference/integration.html
+  #
+  # @example
+  #
+  #   require 'honeybadger/plugin'
+  #   require 'honeybadger/ruby'
+  #
+  #   module Honeybadger
+  #     module Plugins
+  #       # Register your plugin with an optional name. If the name (such as
+  #       # "my_framework") is not provided, Honeybadger will try to infer the name
+  #       # from the current file.
+  #       Plugin.register 'my_framework' do
+  #         requirement do
+  #           # Check to see if the thing you're integrating with is loaded. Return true
+  #           # if it is, or false if it isn't. An exception in this block is equivalent
+  #           # to returning false. Multiple requirement blocks are supported.
+  #           defined?(MyFramework)
+  #         end
+  #
+  #         execution do
+  #           # Write your integration. This code will be executed only if all requirement
+  #           # blocks return true. An exception in this block will disable the plugin.
+  #           # Multiple execution blocks are supported.
+  #           MyFramework.on_exception do |exception|
+  #             Honeybadger.notify(exception)
+  #           end
+  #         end
+  #       end
+  #     end
+  #   end
   class Plugin
+    # @api private
     CALLER_FILE = Regexp.new('\A(?:\w:)?([^:]+)(?=(:\d+))').freeze
 
     class << self
+      # @api private
       @@instances = {}
 
+      # @api private
       def instances
         @@instances
       end
 
+      # Register a new plugin with Honeybadger. See {#requirement} and {#execution}.
+      #
+      # @example
+      #
+      #   Honeybadger::Plugin.register 'my_framework' do
+      #     requirement { }
+      #     execution { }
+      #   end
+      #
+      # @param [String] name The optional name of the plugin. Should use
+      #   +snake_case+. The name is inferred from the current file name if omitted.
+      #
+      # @return nil
       def register(name = nil)
         name ||= name_from_caller(caller) or
           raise(ArgumentError, 'Plugin name is required, but was nil.')
@@ -19,6 +73,7 @@ module Honeybadger
         instances[key] = new(name).tap { |d| d.instance_eval(&Proc.new) }
       end
 
+      # @api private
       def load!(config)
         instances.each_pair do |name, plugin|
           if config.load_plugin?(name)
@@ -29,6 +84,7 @@ module Honeybadger
         end
       end
 
+      # @api private
       def name_from_caller(caller)
         caller && caller[0].match(CALLER_FILE) or
           fail("Unable to determine name from caller: #{caller.inspect}")
@@ -36,6 +92,7 @@ module Honeybadger
       end
     end
 
+    # @api private
     class Execution
       extend Forwardable
 
@@ -54,6 +111,7 @@ module Honeybadger
       def_delegator :@config, :logger
     end
 
+    # @api private
     def initialize(name)
       @name         = name
       @loaded       = false
@@ -61,14 +119,53 @@ module Honeybadger
       @executions   = []
     end
 
+    # Define a requirement. All requirement blocks must return +true+ for the
+    # plugin to be executed.
+    #
+    # @example
+    #
+    #   Honeybadger::Plugin.register 'my_framework' do
+    #     requirement { defined?(MyFramework) }
+    #
+    #     # Honeybadger's configuration object is available inside
+    #     # requirement blocks. It should generally not be used outside of
+    #     # internal plugins. See +Config+.
+    #     requirement { config[:'my_framework.enabled'] }
+    #
+    #     execution { }
+    #   end
+    #
+    # @return nil
     def requirement
       @requirements << Proc.new
     end
 
+    # Define an execution block. Execution blocks will be executed if all
+    # requirement blocks return +true+.
+    #
+    # @example
+    #
+    #   Honeybadger::Plugin.register 'my_framework' do
+    #     requirement { defined?(MyFramework) }
+    #
+    #     execution do
+    #       MyFramework.on_exception {|err| Honeybadger.notify(err) }
+    #     end
+    #
+    #     execution do
+    #       # Honeybadger's configuration object is available inside
+    #       # execution blocks. It should generally not be used outside of
+    #       # internal plugins. See +Config+.
+    #       MyFramework.use_middleware(MyMiddleware) if config[:'my_framework.use_middleware']
+    #     end
+    #   end
+    #
+    # @return nil
     def execution
       @executions << Proc.new
     end
 
+    # @api private
     def ok?(config)
       @requirements.all? {|r| Execution.new(config, &r).call }
     rescue => e
@@ -76,6 +173,7 @@ module Honeybadger
       false
     end
 
+    # @api private
     def load!(config)
       if @loaded
         config.logger.debug(sprintf('skip plugin name=%s reason=loaded', name))
@@ -95,16 +193,18 @@ module Honeybadger
       false
     end
 
+    # @api private
+    def loaded?
+      @loaded
+    end
+
     # @private
     # Used for testing only; don't normally call this. :)
     def reset!
       @loaded = false
     end
 
-    def loaded?
-      @loaded
-    end
-
+    # @api private
     attr_reader :name, :requirements, :executions
   end
 end

data/lib/honeybadger/plugins/rails.rb

@@ -33,6 +33,21 @@ module Honeybadger
         requirement { defined?(::Rails.application) && ::Rails.application }
 
         execution do
+          if ::Rails.application.config.exceptions_app.is_a?(::ActionDispatch::Routing::RouteSet)
+            Honeybadger.configure do |config|
+              config.before_notify do |notice|
+                begin
+                  route_resolver = ::Rails.application.routes.recognize_path(notice.url)
+                  notice.component = route_resolver[:controller]
+                  notice.action = route_resolver[:action]
+                rescue ::ActionController::RoutingError
+                  # if rails can't find the route (like assets)
+                  # we just ignore and keep the old component / action
+                end
+              end
+            end
+          end
+
           require 'rack/request'
           if defined?(::ActionDispatch::DebugExceptions)
             # Rails 3.2.x+

data/lib/honeybadger/plugins/sidekiq.rb

@@ -25,7 +25,15 @@ module Honeybadger
             ::Sidekiq.configure_server do |sidekiq|
               sidekiq.error_handlers << lambda {|ex, params|
                 job = params[:job] || params
-                return if job['retry'.freeze] && job['retry_count'.freeze].to_i < config[:'sidekiq.attempt_threshold'].to_i
+                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
+                end
+
+                return if retry_opt && retry_count < max_retries
                 opts = {parameters: params}
                 opts[:component] = job['wrapped'.freeze] || job['class'.freeze] if config[:'sidekiq.use_component']
                 Honeybadger.notify(ex, opts)

data/lib/honeybadger/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: honeybadger
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.2.0
 platform: ruby
 authors:
 - Honeybadger Industries LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-16 00:00:00.000000000 Z
+date: 2019-01-31 00:00:00.000000000 Z
 dependencies: []
 description: Make managing application errors a more pleasant experience.
 email: