honeybadger 5.12.0 → 5.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3af996859bb642a3538e9d55e4a0e69bfa6221c7096f3d27c6729bd2ab7cb6b
-  data.tar.gz: '06482049c556f1723d29aa07a392867760f58cc751abfc3cc9dd23e2f70702bb'
+  metadata.gz: 49f0e76e4da63a4398fcb71cc8fb153f5a854cd13a0d163924adc41473460401
+  data.tar.gz: f8adacb9335c3d42f3fa2991eb05453551cb546b1d439e504fff32d5c41703b5
 SHA512:
-  metadata.gz: c6a336e2b8a4934e2a052a738f6b413cf6c9909daec09c465ac5d25ff7a324dfa89455e3103ea20231a8cf07e9ab65fe4bead675954cf5f5bf069def03c205f8
-  data.tar.gz: 627d74ee326242416ab420d46690b2813f35a608347c2b2cf5f8e1ec3618d446edee4ed925cf2274caa97b65759f1d6584770fa8889bed077f35fa7ee5456c16
+  metadata.gz: e5022f0122bb51b147f6014e25f204250906b33c4e0e25c9699302e8e8a1bc97bad41497546f93c2d8cb9442de53d207309003699dfc55ae6190e14c2b110cff
+  data.tar.gz: dc28062240092dd136fb22ccd54b45882e850a6982f13225924606ff4e7805451e12a9516a9deba75ee83c71d0f2fcae400c70df2be191d8d5b1b402c8a71365

data/CHANGELOG.md

@@ -1,6 +1,22 @@
 # Change Log
 
 
+## [5.13.1](https://github.com/honeybadger-io/honeybadger-ruby/compare/v5.13.0...v5.13.1) (2024-07-01)
+
+
+### Bug Fixes
+
+* do not check for rails console ([#574](https://github.com/honeybadger-io/honeybadger-ruby/issues/574)) ([ba74af8](https://github.com/honeybadger-io/honeybadger-ruby/commit/ba74af8b55393ea0a96962085ea48c4376380be3))
+* ignore content-less SQL statements ([#572](https://github.com/honeybadger-io/honeybadger-ruby/issues/572)) ([e7ecd36](https://github.com/honeybadger-io/honeybadger-ruby/commit/e7ecd36969922496e276a246406fe7d792de00e3))
+* sanitize SQL when reporting SQL queries ([#571](https://github.com/honeybadger-io/honeybadger-ruby/issues/571)) ([40d4a79](https://github.com/honeybadger-io/honeybadger-ruby/commit/40d4a79a5c1f758fe49779e63697d56599537235))
+
+## [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')
@@ -273,7 +277,6 @@ module Honeybadger
     end
 
     def insights_enabled?
-      return false if defined?(::Rails.application) && ::Rails.const_defined?("Console")
       !!self[:'insights.enabled']
     end
 

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/notification_subscriber.rb

@@ -1,4 +1,5 @@
 require 'honeybadger/instrumentation_helper'
+require 'honeybadger/util/sql'
 
 module Honeybadger
   class NotificationSubscriber
@@ -9,7 +10,7 @@ module Honeybadger
     def finish(name, id, payload)
       @finish_time = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
 
-      return unless process?(name)
+      return unless process?(name, payload)
 
       payload = {
         instrumenter_id: id,
@@ -23,7 +24,7 @@ module Honeybadger
       Honeybadger.event(name, payload)
     end
 
-    def process?(event)
+    def process?(event, payload)
       true
     end
 
@@ -58,10 +59,16 @@ module Honeybadger
   class ActiveRecordSubscriber < NotificationSubscriber
     def format_payload(payload)
       {
-        query: payload[:sql].to_s.gsub(/\s+/, ' ').strip,
+        query: Util::SQL.obfuscate(payload[:sql], payload[:connection].adapter_name),
         async: payload[:async]
       }
     end
+
+    def process?(event, payload)
+      return false if payload[:name] == "SCHEMA"
+      return false if payload[:sql]&.match?(/^(begin|commit)( transaction)?$/i)
+      true
+    end
   end
 
   class ActiveJobSubscriber < NotificationSubscriber

data/lib/honeybadger/plugins/rails.rb

@@ -71,16 +71,18 @@ module Honeybadger
       end
 
       Plugin.register :rails do
-        requirement { config.load_plugin_insights?(:rails_metrics) && defined?(::Rails.application) && ::Rails.application }
+        requirement { defined?(::Rails.application) && ::Rails.application }
 
         execution do
-          ::ActiveSupport::Notifications.subscribe(/(process_action|send_file|redirect_to|halted_callback|unpermitted_parameters)\.action_controller/, Honeybadger::ActionControllerSubscriber.new)
-          ::ActiveSupport::Notifications.subscribe(/(write_fragment|read_fragment|expire_fragment|exist_fragment\?)\.action_controller/, Honeybadger::ActionControllerCacheSubscriber.new)
-          ::ActiveSupport::Notifications.subscribe(/cache_(read|read_multi|generate|fetch_hit|write|write_multi|increment|decrement|delete|delete_multi|cleanup|prune|exist\?)\.active_support/, Honeybadger::ActiveSupportCacheSubscriber.new)
-          ::ActiveSupport::Notifications.subscribe(/^render_(template|partial|collection)\.action_view/, Honeybadger::ActionViewSubscriber.new)
-          ::ActiveSupport::Notifications.subscribe("sql.active_record", Honeybadger::ActiveRecordSubscriber.new)
-          ::ActiveSupport::Notifications.subscribe("process.action_mailer", Honeybadger::ActionMailerSubscriber.new)
-          ::ActiveSupport::Notifications.subscribe(/(service_upload|service_download)\.active_storage/, Honeybadger::ActiveStorageSubscriber.new)
+          if config.load_plugin_insights?(:rails)
+            ::ActiveSupport::Notifications.subscribe(/(process_action|send_file|redirect_to|halted_callback|unpermitted_parameters)\.action_controller/, Honeybadger::ActionControllerSubscriber.new)
+            ::ActiveSupport::Notifications.subscribe(/(write_fragment|read_fragment|expire_fragment|exist_fragment\?)\.action_controller/, Honeybadger::ActionControllerCacheSubscriber.new)
+            ::ActiveSupport::Notifications.subscribe(/cache_(read|read_multi|generate|fetch_hit|write|write_multi|increment|decrement|delete|delete_multi|cleanup|prune|exist\?)\.active_support/, Honeybadger::ActiveSupportCacheSubscriber.new)
+            ::ActiveSupport::Notifications.subscribe(/^render_(template|partial|collection)\.action_view/, Honeybadger::ActionViewSubscriber.new)
+            ::ActiveSupport::Notifications.subscribe("sql.active_record", Honeybadger::ActiveRecordSubscriber.new)
+            ::ActiveSupport::Notifications.subscribe("process.action_mailer", Honeybadger::ActionMailerSubscriber.new)
+            ::ActiveSupport::Notifications.subscribe(/(service_upload|service_download)\.active_storage/, Honeybadger::ActiveStorageSubscriber.new)
+          end
         end
       end
     end

data/lib/honeybadger/util/sql.rb

@@ -1,32 +1,29 @@
 module Honeybadger
   module Util
     class SQL
-      EscapedQuotes = /(\\"|\\')/.freeze
-      SQuotedData = /'(?:[^']|'')*'/.freeze
-      DQuotedData = /"(?:[^"]|"")*"/.freeze
-      NumericData = /\b\d+\b/.freeze
-      Newline = /\n/.freeze
-      Replacement = "?".freeze
-      EmptyReplacement = "".freeze
-      DoubleQuoters = /(postgres|sqlite|postgis)/.freeze
+      ESCAPE_QUOTES = /(\\"|\\')/
+      SQUOTE_DATA = /'(?:[^']|'')*'/
+      DQUOTE_DATA = /"(?:[^"]|"")*"/
+      NUMBER_DATA = /\b\d+\b/
+      DOUBLE_QUOTERS = /(postgres|sqlite|postgis)/i
 
       def self.obfuscate(sql, adapter)
-        force_utf_8(sql.dup).tap do |s|
-          s.gsub!(EscapedQuotes, EmptyReplacement)
-          s.gsub!(SQuotedData, Replacement)
-          s.gsub!(DQuotedData, Replacement) if adapter =~ DoubleQuoters
-          s.gsub!(NumericData, Replacement)
-          s.gsub!(Newline, EmptyReplacement)
-          s.squeeze!(' ')
+        force_utf_8(sql.to_s.dup).tap do |s|
+          s.gsub!(/\s+/, " ")
+          s.gsub!(ESCAPE_QUOTES, "".freeze)
+          s.gsub!(SQUOTE_DATA, "'?'".freeze)
+          s.gsub!(DQUOTE_DATA, '"?"'.freeze) unless adapter.to_s.match?(DOUBLE_QUOTERS)
+          s.gsub!(NUMBER_DATA, "?".freeze)
+          s.strip!
         end
       end
 
       def self.force_utf_8(string)
         string.encode(
-          Encoding.find('UTF-8'),
-          invalid: :replace, 
-          undef: :replace, 
-          replace: ''
+          Encoding.find("UTF-8"),
+          invalid: :replace,
+          undef: :replace,
+          replace: ""
         )
       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.1'.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.1
 platform: ruby
 authors:
 - Honeybadger Industries LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-17 00:00:00.000000000 Z
+date: 2024-07-01 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