honeybadger 5.12.0 → 5.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3af996859bb642a3538e9d55e4a0e69bfa6221c7096f3d27c6729bd2ab7cb6b
-  data.tar.gz: '06482049c556f1723d29aa07a392867760f58cc751abfc3cc9dd23e2f70702bb'
+  metadata.gz: 02da7e28bdfb138d80a3e8e3e591d45383406fac1676ed04f0df139125e56247
+  data.tar.gz: 2c08c2e0e4e42ea9b7532c09f28f8d1c60a4944dab1e0d1ebc277becb58f8947
 SHA512:
-  metadata.gz: c6a336e2b8a4934e2a052a738f6b413cf6c9909daec09c465ac5d25ff7a324dfa89455e3103ea20231a8cf07e9ab65fe4bead675954cf5f5bf069def03c205f8
-  data.tar.gz: 627d74ee326242416ab420d46690b2813f35a608347c2b2cf5f8e1ec3618d446edee4ed925cf2274caa97b65759f1d6584770fa8889bed077f35fa7ee5456c16
+  metadata.gz: cd07b8f3bfe423336690f00dc80addfb4fbda2db27bbcca0739204888b1565455ea09cbb6d5e643162f00c247ce09ff867e3eab0d71d7f59ca8d39bfc26164cd
+  data.tar.gz: 93e0ad66065c9be2c216e69a0d631effe6ba795ff90f328bf05a24bd2d45b60369e1cf3df4b0fc15478c7a73ec497a8661265bdb3daf52b39668117a7b123c9b

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 # Change Log
 
 
+## [5.13.0](https://github.com/honeybadger-io/honeybadger-ruby/compare/v5.12.0...v5.13.0) (2024-06-18)
+
+
+### Features
+
+* add before_event hook for intercepting events ([#567](https://github.com/honeybadger-io/honeybadger-ruby/issues/567)) ([2f86728](https://github.com/honeybadger-io/honeybadger-ruby/commit/2f8672814af3b12b3bfbc775de63b7a34b5087ad))
+
 ## [5.12.0](https://github.com/honeybadger-io/honeybadger-ruby/compare/v5.11.2...v5.12.0) (2024-06-17)
 
 

data/lib/honeybadger/agent.rb

@@ -4,6 +4,7 @@ require 'honeybadger/version'
 require 'honeybadger/config'
 require 'honeybadger/context_manager'
 require 'honeybadger/notice'
+require 'honeybadger/event'
 require 'honeybadger/plugin'
 require 'honeybadger/logging'
 require 'honeybadger/worker'
@@ -392,28 +393,21 @@ module Honeybadger
     def event(event_type, payload = {})
       init_events_worker
 
-      ts = Time.now.utc.strftime("%FT%T.%LZ")
-      merged = {ts: ts}
-
-      if event_type.is_a?(String)
-        merged[:event_type] = event_type
-      else
-        merged.merge!(Hash(event_type))
+      extra_payload = {}.tap do |p|
+        p[:request_id] = context_manager.get_request_id if context_manager.get_request_id
+        p[:hostname] = config[:hostname].to_s if config[:'events.attach_hostname']
       end
 
-      if (request_id = context_manager.get_request_id)
-        merged[:request_id] = request_id
-      end
+      event = Event.new(event_type, extra_payload.merge(payload))
 
-      if config[:'events.attach_hostname']
-        merged[:hostname] = config[:hostname].to_s
+      config.before_event_hooks.each do |hook|
+        with_error_handling { hook.call(event) }
       end
 
-      merged.merge!(Hash(payload))
-
-      return if config.ignored_events.any? { |check| merged[:event_type]&.match?(check) }
+      return if config.ignored_events.any? { |check| event.event_type&.match?(check) }
+      return if event.halted?
 
-      events_worker.push(merged)
+      events_worker.push(event.as_json)
     end
 
     # @api private
@@ -590,7 +584,7 @@ module Honeybadger
     def with_error_handling
       yield
     rescue => ex
-      error { "Rescued an error in a before notify hook: #{ex.message}" }
+      error { "Rescued an error in a before hook: #{ex.message}" }
     end
 
     @instance = new(Config.new)

data/lib/honeybadger/config/ruby.rb

@@ -89,15 +89,27 @@ module Honeybadger
       def before_notify(action = nil, &block)
         hooks = Array(get(:before_notify)).dup
 
-        if action && validate_before_action(action)
+        if action && validate_before_action(action, 'notify')
           hooks << action
-        elsif block_given? && validate_before_action(block)
+        elsif block_given? && validate_before_action(block, 'notify')
           hooks << block
         end
 
         hash[:before_notify] = hooks
       end
 
+      def before_event(action = nil, &block)
+        hooks = Array(get(:before_event)).dup
+
+        if action && validate_before_action(action, 'event')
+          hooks << action
+        elsif block_given? && validate_before_action(block, 'event')
+          hooks << block
+        end
+
+        hash[:before_event] = hooks
+      end
+
       def backtrace_filter(&block)
         if block_given?
           logger.warn('DEPRECATED: backtrace_filter is deprecated. Please use before_notify instead. See https://docs.honeybadger.io/ruby/support/v4-upgrade#backtrace_filter')
@@ -127,17 +139,17 @@ module Honeybadger
 
       private
 
-      def validate_before_action(action)
+      def validate_before_action(action, type)
         if !action.respond_to?(:call)
           logger.warn(
-            'You attempted to add a before notify hook that does not respond ' \
+            "You attempted to add a before #{type} 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 ' \
+            "You attempted to add a before #{type} hook that has an arity " \
             'other than one. We are discarding this hook so your intended ' \
             'behavior will not occur.'
           )

data/lib/honeybadger/config.rb

@@ -92,6 +92,10 @@ module Honeybadger
       (ruby[:before_notify] || []).clone
     end
 
+    def before_event_hooks
+      (ruby[:before_event] || []).clone
+    end
+
     def exception_filter(&block)
       if block_given?
         warn('DEPRECATED: exception_filter is deprecated. Please use before_notify instead. See https://docs.honeybadger.io/ruby/support/v4-upgrade#exception_filter')

data/lib/honeybadger/event.rb

@@ -0,0 +1,56 @@
+require 'forwardable'
+
+module Honeybadger
+  class Event
+    extend Forwardable
+
+    # The timestamp of the event
+    attr_reader :ts
+
+    # The event_type of the event
+    attr_reader :event_type
+
+    # The payload data of the event
+    attr_reader :payload
+
+    def_delegator :payload, :[]
+
+    # @api private
+    def initialize(event_type_or_payload, payload={})
+      if event_type_or_payload.is_a?(String)
+        @event_type = event_type_or_payload
+        @payload = payload
+      elsif event_type_or_payload.is_a?(Hash)
+        @event_type = event_type_or_payload[:event_type] || event_type_or_payload["event_type"]
+        @payload = event_type_or_payload
+      end
+
+      @ts = payload[:ts] || Time.now.utc.strftime("%FT%T.%LZ")
+      @halted = false
+    end
+
+    # Halts the event and the before_event callback chain.
+    #
+    # Returns nothing.
+    def halt!
+      @halted ||= true
+    end
+
+    # @api private
+    # Determines if this event will be discarded.
+    def halted?
+      !!@halted
+    end
+
+    # @api private
+    # Template used to create JSON payload.
+    #
+    # @return [Hash] JSON representation of the event.
+    def as_json(*args)
+      payload.tap do |p|
+        p[:ts] = ts
+        p[:event_type] = event_type if event_type
+      end
+    end
+  end
+end

data/lib/honeybadger/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: honeybadger
 version: !ruby/object:Gem::Version
-  version: 5.12.0
+  version: 5.13.0
 platform: ruby
 authors:
 - Honeybadger Industries LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-17 00:00:00.000000000 Z
+date: 2024-06-18 00:00:00.000000000 Z
 dependencies: []
 description: Make managing application errors a more pleasant experience.
 email:
@@ -56,6 +56,7 @@ files:
 - lib/honeybadger/context_manager.rb
 - lib/honeybadger/conversions.rb
 - lib/honeybadger/counter.rb
+- lib/honeybadger/event.rb
 - lib/honeybadger/events_worker.rb
 - lib/honeybadger/gauge.rb
 - lib/honeybadger/histogram.rb