honeybadger 3.3.1 → 3.4.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2dbccf9f60503c126bc9f6b66cdde42481fac83e
-  data.tar.gz: f659d0157462c409907932c85a4b9a5e0e2cf8cf
+SHA256:
+  metadata.gz: b610a8fe048c882cb15dadd39ae9adc1955e82952d58cd5852ee6ed0477a72bf
+  data.tar.gz: d65617bd6beb55778cc44001c0d1a8703b797b180e628d5f66f1c3278986fafe
 SHA512:
-  metadata.gz: 1db263977550ca7fe10f9c47c8a49518b3c25ccc23f9e5b47b49980c944f2c4e86eeddf6e41a9fe70e93d07a87b19f45b9bc7f3acdce34dc9e5b1065ca1e91f0
-  data.tar.gz: efd096b1bb6b968796bc2c00b46c0cb59b0c3d593e028b8551efb84e21e7a2de9e0f124500584b2f106af92c7c0f9c89357b6a10f42aa97f6de80551d05694d8
+  metadata.gz: 66818e625bb5e5c8ca2c06f8ebd3e7bbac07f4caacb4955ecb90fbb77f08df014df579adf1f3606ed4d26b315c5f108764f61f459d35253a50d0473ddf3b34ec
+  data.tar.gz: 2df50c6580e2ebed48cc1e4a9001cd94588f5cd23bfd80f451166a5ce9d6d1ecf6db4301dab7e5eddaaea67af5cf5e85e81fd6ff985800fb1738fb2dba8340b0

data/CHANGELOG.md

@@ -4,10 +4,14 @@ CHANGELOG](http://keepachangelog.com/) for how to update this file. This project
 adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
+### Added
+- Added `before_notify` hooks to be defined, this allows setting up of multiple
+  hooks which will be invoked with a `notice` before a `notice` is sent. Each
+  `before_notify` hook MUST be a `callable` (lambda, Proc etc,) with an arity of 1.
+- Added the ability to halt notices in callbacks using `notice.halt!`
 
-## [3.3.1] - 2018-08-02
 ### Fixed
-- Fix synchronous throttling in shoryuken
+- Ignore SIGTERM SignalExceptions.
 
 ## [3.3.0] - 2018-01-29
 ### Changed

data/lib/honeybadger/agent.rb

@@ -127,6 +127,11 @@ module Honeybadger
 
       notice = Notice.new(config, opts)
 
+      config.before_notify_hooks.each do |hook|
+        break if notice.halted?
+        with_error_handling { hook.call(notice) }
+      end
+
       unless notice.api_key =~ NOT_BLANK
         error { sprintf('Unable to send error report: API key is missing. id=%s', notice.id) }
         return false
@@ -137,6 +142,11 @@ module Honeybadger
         return false
       end
 
+      if notice.halted?
+        debug { 'halted notice feature=notices' }
+        return false
+      end
+
       info { sprintf('Reporting error id=%s', notice.id) }
 
       if opts[:sync]
@@ -381,6 +391,12 @@ module Honeybadger
       @worker = Worker.new(config)
     end
 
+    def with_error_handling
+      yield
+    rescue => ex
+      error { "Rescued an error in a before notify hook: #{ex.message}" }
+    end
+
     @instance = new(Config.new)
   end
 end

data/lib/honeybadger/config.rb

@@ -84,6 +84,10 @@ module Honeybadger
       self[:backtrace_filter]
     end
 
+    def before_notify_hooks
+      (ruby[:before_notify] || []).clone
+    end
+
     def exception_filter
       self[:exception_filter] = Proc.new if block_given?
       self[:exception_filter]

data/lib/honeybadger/config/ruby.rb

@@ -70,7 +70,7 @@ module Honeybadger
       end
 
       def logger
-        get(:logger)
+        get(:logger) || config.logger
       end
 
       def backend=(backend)
@@ -78,7 +78,7 @@ module Honeybadger
       end
 
       def backend
-        get(:backend)
+        get(:backend) || config.backend
       end
 
       def backtrace_filter
@@ -86,6 +86,16 @@ module Honeybadger
         get(:backtrace_filter)
       end
 
+      def before_notify(action = nil, &block)
+        (hash[:before_notify] ||= []).tap do |before_notify_hooks|
+          if action && validate_before_action(action)
+            before_notify_hooks << action
+          elsif block_given? && validate_before_action(block)
+            before_notify_hooks << block
+          end
+        end
+      end
+
       def exception_filter
         hash[:exception_filter] = Proc.new if block_given?
         get(:exception_filter)
@@ -95,6 +105,28 @@ module Honeybadger
         hash[:exception_fingerprint] = Proc.new if block_given?
         get(:exception_fingerprint)
       end
+
+      private
+
+      def validate_before_action(action)
+        if !action.respond_to?(:call)
+          logger.warn(
+            'You attempted to add a before notify hook that does not respond ' \
+            'to #call. We are discarding this hook so your intended behavior ' \
+            'will not occur.'
+          )
+          false
+        elsif action.arity != 1
+          logger.warn(
+            'You attempted to add a before notify hook that has an arity ' \
+            'other than one. We are discarding this hook so your intended ' \
+            'behavior will not occur.'
+          )
+          false
+        else
+          true
+        end
+      end
     end
   end
 end

data/lib/honeybadger/notice.rb

@@ -107,8 +107,8 @@ module Honeybadger
     # Local variables are extracted from first frame of backtrace.
     attr_reader :local_variables
 
-    # The API key used to deliver this notice.
-    attr_reader :api_key
+    # Public: The API key used to deliver this notice.
+    attr_accessor :api_key
 
     # @api private
     # Cache project path substitutions for backtrace lines.
@@ -246,6 +246,19 @@ module Honeybadger
       ignore_by_origin? || ignore_by_class? || ignore_by_callbacks?
     end
 
+    # Halts the notice and the before_notify callback chain.
+    #
+    # Returns nothing.
+    def halt!
+      @halted ||= true
+    end
+
+    # @api private
+    # Determines if this notice will be discarded.
+    def halted?
+      !!@halted
+    end
+
     private
 
     attr_reader :config, :opts, :context, :stats, :now, :pid, :causes,
@@ -536,5 +549,6 @@ module Honeybadger
         @request.session
       end
     end
+
   end
 end

data/lib/honeybadger/plugins/shoryuken.rb

@@ -6,14 +6,16 @@ module Honeybadger
     module Shoryuken
       class Middleware
         def call(_worker, _queue, sqs_msg, body)
-          begin
-            yield
-          rescue => e
-            if attempt_threshold <= receive_count(sqs_msg)
-              Honeybadger.notify(e, parameters: notification_params(body))
+          Honeybadger.flush do
+            begin
+              yield
+            rescue => e
+              if attempt_threshold <= receive_count(sqs_msg)
+                Honeybadger.notify(e, parameters: notification_params(body))
+              end
+
+              raise e
             end
-
-            raise e
           end
         ensure
           Honeybadger.context.clear!

data/lib/honeybadger/singleton.rb

@@ -64,7 +64,7 @@ module Honeybadger
   # @api private
   def install_at_exit_callback
     at_exit do
-      if $! && !$!.is_a?(SystemExit) && Honeybadger.config[:'exceptions.notify_at_exit']
+      if $! && !ignored_exception?($!) && Honeybadger.config[:'exceptions.notify_at_exit']
         Honeybadger.notify($!, component: 'at_exit', sync: true)
       end
 
@@ -85,4 +85,15 @@ module Honeybadger
   end
 WARNING
   end
+
+  private
+  # @api private
+  def ignored_exception?(exception)
+    exception.is_a?(SystemExit) ||
+      ( exception.is_a?(SignalException) &&
+         ( (exception.respond_to?(:signm) && exception.signm == "SIGTERM") ||
+          # jruby has a missing #signm implementation
+          ["TERM", "SIGTERM"].include?(exception.to_s) )
+    )
+  end
 end

data/lib/honeybadger/version.rb

@@ -1,4 +1,4 @@
 module Honeybadger
   # The current String Honeybadger version.
-  VERSION = '3.3.1'.freeze
+  VERSION = '3.4.0.beta1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: honeybadger
 version: !ruby/object:Gem::Version
-  version: 3.3.1
+  version: 3.4.0.beta1
 platform: ruby
 authors:
 - Honeybadger Industries LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-02 00:00:00.000000000 Z
+date: 2018-03-22 00:00:00.000000000 Z
 dependencies: []
 description: Make managing application errors a more pleasant experience.
 email:
@@ -138,12 +138,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Error reports you can be happy about.