honeybadger 5.13.0 → 5.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02da7e28bdfb138d80a3e8e3e591d45383406fac1676ed04f0df139125e56247
-  data.tar.gz: 2c08c2e0e4e42ea9b7532c09f28f8d1c60a4944dab1e0d1ebc277becb58f8947
+  metadata.gz: 49f0e76e4da63a4398fcb71cc8fb153f5a854cd13a0d163924adc41473460401
+  data.tar.gz: f8adacb9335c3d42f3fa2991eb05453551cb546b1d439e504fff32d5c41703b5
 SHA512:
-  metadata.gz: cd07b8f3bfe423336690f00dc80addfb4fbda2db27bbcca0739204888b1565455ea09cbb6d5e643162f00c247ce09ff867e3eab0d71d7f59ca8d39bfc26164cd
-  data.tar.gz: 93e0ad66065c9be2c216e69a0d631effe6ba795ff90f328bf05a24bd2d45b60369e1cf3df4b0fc15478c7a73ec497a8661265bdb3daf52b39668117a7b123c9b
+  metadata.gz: e5022f0122bb51b147f6014e25f204250906b33c4e0e25c9699302e8e8a1bc97bad41497546f93c2d8cb9442de53d207309003699dfc55ae6190e14c2b110cff
+  data.tar.gz: dc28062240092dd136fb22ccd54b45882e850a6982f13225924606ff4e7805451e12a9516a9deba75ee83c71d0f2fcae400c70df2be191d8d5b1b402c8a71365

data/CHANGELOG.md

@@ -1,6 +1,15 @@
 # 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)
 
 

data/lib/honeybadger/config.rb

@@ -277,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/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.13.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.13.0
+  version: 5.13.1
 platform: ruby
 authors:
 - Honeybadger Industries LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-18 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: