exception_handling 2.15.0 → 2.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14ca7f66e702ec2ae46aa9f7b7669cd8f8136b9305c0683b76339faafc87558a
-  data.tar.gz: db7863d32347f5f859971222f2b215b0f84a8c7604eb0326cfd9b656910cd9ff
+  metadata.gz: 71ab070f1ab59f2f12838fb7d123fa541a71a8bb42fe0d057f06acb015bf32a2
+  data.tar.gz: 1c268f42c4a302c88b98411890db5a4870d31bb96ca712e0f6463ba6629f188a
 SHA512:
-  metadata.gz: 3274bf4d7f67fb83aa2d71633572d19c14c99e3c40746de20e20efea1ff570a0d49f5163efd74c60ce0167af3495ad259d2950bc198c28a219ff6b30dadf551b
-  data.tar.gz: 858ce36039ecfbd5a79a22c0a56f9accff534e7b7e27e288509ffd9d34feca3ccd0983a092f6d536e554dce8d4312cb877df5f3a6729305aed8828ed0fe36d8a
+  metadata.gz: f571e8c9dd62c70eba4b01c917af6c4715e3d4750900fec8ad7e4a3d5c67fc30ddc299c1456b48adef17c74a3860769806fd0df4e410cb5180c3f778e58c1aad
+  data.tar.gz: 98f1596f0a95e1591a768b23574c76e4b4039b54a7bb95f07b4f6d41d40336bae360b7ce76750cc5fec7d9c1a64c78ffc4c72d15b88b4924734bab228bb30c94

data/.github/workflows/pipeline.yml

@@ -34,7 +34,7 @@ jobs:
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
-        bundler: 2.2.29
+        bundler: 2.3.26
         bundler-cache: true
     - name: Unit tests
       run: bundle exec rspec

data/CHANGELOG.md

@@ -4,6 +4,10 @@ Inspired by [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 **Note:** this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.16.0] - 2023-05-01
+### Added
+- Add interface for automatically adding honeybadger tags `ExceptionHandling.honeybadger_auto_tagger=`
+
 ## [2.15.0] - 2023-03-07
 ### Added
 - Added support for ActionMailer 7.x
@@ -109,6 +113,7 @@ Inspired by [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 ### Changed
 - No longer depends on hobo_support. Uses invoca-utils 0.3 instead.
 
+[2.16.0]: https://github.com/Invoca/exception_handling/compare/v2.15.0...v2.16.0
 [2.15.0]: https://github.com/Invoca/exception_handling/compare/v2.14.0...v2.15.0
 [2.14.0]: https://github.com/Invoca/exception_handling/compare/v2.13.0...v2.14.0
 [2.13.0]: https://github.com/Invoca/exception_handling/compare/v2.12.0...v2.13.0

data/Gemfile

@@ -4,6 +4,9 @@ source 'https://rubygems.org'
 
 gemspec
 
+gem 'actionmailer', '~> 6.0'
+gem 'actionpack', '~> 6.0'
+gem 'activesupport', '~> 6.0'
 gem 'appraisal', '~> 2.2'
 gem 'honeybadger', '~> 4.11'
 gem 'pry'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    exception_handling (2.15.0)
+    exception_handling (2.16.0)
       actionmailer (>= 5.2)
       actionpack (>= 5.2)
       activesupport (>= 5.2)
@@ -144,6 +144,9 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  actionmailer (~> 6.0)
+  actionpack (~> 6.0)
+  activesupport (~> 6.0)
   appraisal (~> 2.2)
   exception_handling!
   honeybadger (~> 4.11)
@@ -156,4 +159,4 @@ DEPENDENCIES
   test-unit
 
 BUNDLED WITH
-   2.2.29
+   2.3.22

data/README.md

@@ -25,24 +25,26 @@ Or install it yourself as:
 Add some code to initialize the settings in your application.
 For example:
 
-    require "exception_handling"
-
-    # required
-    ExceptionHandling.server_name             = Cluster['server_name']
-    ExceptionHandling.sender_address          = %("Exceptions" <exceptions@example.com>)
-    ExceptionHandling.exception_recipients    = ['exceptions@example.com']
-    ExceptionHandling.logger                  = Rails.logger
-
-    # optional
-    ExceptionHandling.escalation_recipients   = ['escalation@example.com']
-    ExceptionHandling.filter_list_filename    = "#{Rails.root}/config/exception_filters.yml"
-    ExceptionHandling.email_environment       = Rails.env
-    ExceptionHandling.eventmachine_safe       = false
-    ExceptionHandling.eventmachine_synchrony  = false
-    ExceptionHandling.sensu_host              = "127.0.0.1"
-    ExceptionHandling.sensu_port              = 3030
-    ExceptionHandling.sensu_prefix            = ""
-
+```ruby
+require "exception_handling"
+
+# required
+ExceptionHandling.server_name             = Cluster['server_name']
+ExceptionHandling.sender_address          = %("Exceptions" <exceptions@example.com>)
+ExceptionHandling.exception_recipients    = ['exceptions@example.com']
+ExceptionHandling.logger                  = Rails.logger
+
+# optional
+ExceptionHandling.escalation_recipients   = ['escalation@example.com']
+ExceptionHandling.filter_list_filename    = "#{Rails.root}/config/exception_filters.yml"
+ExceptionHandling.email_environment       = Rails.env
+ExceptionHandling.eventmachine_safe       = false
+ExceptionHandling.eventmachine_synchrony  = false
+ExceptionHandling.sensu_host              = "127.0.0.1"
+ExceptionHandling.sensu_port              = 3030
+ExceptionHandling.sensu_prefix            = ""
+ExceptionHandling.honeybadger_auto_tagger = ->(exception) { [] } # See "Automatically Tagging Exceptions" section below for examples
+```
 
 ## Usage
 
@@ -62,6 +64,40 @@ Then call any method available in the `ExceptionHandling::Methods` mixin:
       flash.now['error'] = "A specific error occurred. Support has been notified."
     end
 
+### Tagging Exceptions in Honeybadger
+
+⚠️ Honeybadger differentiates tags by spaces and/or commas, so you should **not** include spaces or commas in your tags.
+
+⚠️ Tags are case-sensitive.
+
+#### Manually Tagging Exceptions
+
+Add `:honeybadger_tags` to your `log_context` usage with an array of strings.
+
+```ruby
+log_error(ex, "A specific error occurred.", honeybadger_tags: ["critical", "sequoia"])
+```
+
+**Note**: Manual tags will be merged with any automatic tags.
+
+#### Automatically Tagging Exceptions (`honeybadger_auto_tagger=`)
+
+Configure exception handling so that you can automatically apply multiple tags to exceptions sent to honeybadger.
+
+The Proc must accept an `exception` argument that will be the exception in question and must always return an array of strings (the array can be empty).
+
+Example to enable auto-tagging:
+```ruby
+ExceptionHandling.honeybadger_auto_tagger = ->(exception) do
+  exception.message.match?(/fire/) ? ["high-urgency", "danger"] : ["low-urgency"]
+end
+```
+
+Example to disable auto-tagging:
+```ruby
+ExceptionHandling.honeybadger_auto_tagger = nil
+```
+
 ## Custom Hooks
 
 ### custom_data_hook

data/lib/exception_handling/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ExceptionHandling
-  VERSION = '2.15.0'
+  VERSION = '2.16.0'
 end

data/lib/exception_handling.rb

@@ -114,6 +114,7 @@ module ExceptionHandling # never included
     attr_reader :filter_list_filename
     attr_reader :eventmachine_safe
     attr_reader :eventmachine_synchrony
+    attr_reader :honeybadger_auto_tagger
 
     @filter_list_filename = "./config/exception_filters.yml"
     @email_environment = ""
@@ -154,6 +155,14 @@ module ExceptionHandling # never included
       @exception_catalog ||= ExceptionCatalog.new(@filter_list_filename)
     end
 
+    # rubocop:disable Style/TrivialAccessors
+    # @param value [Proc|nil] Proc that accepts 1 parameter that will be the exception object or nil to disable the auto-tagger.
+    #                         The proc is always expected to return an array of strings. The array can be empty.
+    def honeybadger_auto_tagger=(value)
+      @honeybadger_auto_tagger = value
+    end
+    # rubocop:enable Style/TrivialAccessors
+
     #
     # internal settings (don't set directly)
     #
@@ -270,9 +279,10 @@ module ExceptionHandling # never included
     def send_exception_to_honeybadger(exception_info)
       exception             = exception_info.exception
       exception_description = exception_info.exception_description
+
       # Note: Both commas and spaces are treated as delimiters for the :tags string. Space-delimiters are not officially documented.
       # https://github.com/honeybadger-io/honeybadger-ruby/pull/422
-      tags = exception_info.honeybadger_tags.join(' ')
+      tags = (honeybadger_auto_tags(exception) + exception_info.honeybadger_tags).join(' ')
       response = Honeybadger.notify(error_class: exception_description ? exception_description.filter_name : exception.class.name,
                                     error_message: exception.message.to_s,
                                     exception:     exception,
@@ -286,6 +296,18 @@ module ExceptionHandling # never included
       :failure
     end
 
+    # @param exception [Exception]
+    #
+    # @return [Array<String>]
+    def honeybadger_auto_tags(exception)
+      @honeybadger_auto_tagger&.call(exception) || []
+    rescue => ex
+      traces = ex.backtrace.join("\n")
+      message = "Unable to execute honeybadger_auto_tags callback. #{ExceptionHandling.encode_utf8(ex.message.to_s)} #{traces}\n"
+      ExceptionHandling.log_info(message)
+      []
+    end
+
     #
     # Check if Honeybadger defined.
     #

data/spec/unit/exception_handling_spec.rb

@@ -107,6 +107,11 @@ describe ExceptionHandling do
   class SmtpClientErrbackStub < SmtpClientStub
   end
 
+  before(:each) do
+    # Reset this for every test since they are applied to the class
+    ExceptionHandling.honeybadger_auto_tagger = nil
+  end
+
   context "with warn and honeybadger notify stubbed" do
     before do
       allow(ExceptionHandling).to receive(:warn).with(any_args)
@@ -149,6 +154,14 @@ describe ExceptionHandling do
           expect(service_name: 'exception_handling').to eq(logged_excluding_reload_filter.last[:context])
         end
 
+        it "passes :honeybadger_tags in log context to honeybadger" do
+          expect(Honeybadger).to receive(:notify).with(hash_including({ tags: "  , awesome  ,  totallytubular,  " }))
+          ExceptionHandling.log_error('This is an Error', 'This is the prefix context', honeybadger_tags: '  , awesome  ,  totallytubular,  ')
+
+          expect(Honeybadger).to receive(:notify).with(hash_including({ tags: "    cool  neat" }))
+          ExceptionHandling.log_error('This is an Error', 'This is the prefix context', honeybadger_tags: ["  ", " cool ", "neat"])
+        end
+
         it "logs with Severity::FATAL" do
           ExceptionHandling.log_error('This is a Warning', service_name: 'exception_handling')
           expect('FATAL').to eq(logged_excluding_reload_filter.last[:severity])
@@ -1245,6 +1258,53 @@ describe ExceptionHandling do
         expect(logged_excluding_reload_filter.size).to eq(3)
       end
     end
+
+    context "#honeybadger_auto_tagger=" do
+      context "with proc that runs successfully" do
+        before do
+          ExceptionHandling.honeybadger_auto_tagger =
+            ->(exception) do
+              if exception.message =~ /donuts/
+                ['donut-error', 'high-urgency']
+              else
+                ['low-urgency']
+              end
+            end
+        end
+
+        context "without manually passed tags" do
+          let(:exception) { StandardError.new("We are out of chocolate milk") }
+
+          it "adds tags from autotagger" do
+            expect(Honeybadger).to receive(:notify).with(hash_including({ tags: "low-urgency" }))
+            ExceptionHandling.log_error(exception, nil)
+          end
+        end
+
+        context "with manually passed tags" do
+          let(:exception) { StandardError.new("The donuts are burning") }
+
+          it "merges tags from autotagger with manually passed tags" do
+            expect(Honeybadger).to receive(:notify).with(hash_including({ tags: "donut-error high-urgency upset-customers" }))
+            ExceptionHandling.log_error(exception, nil, honeybadger_tags: ["upset-customers"])
+          end
+        end
+      end
+    end
+
+    context "with proc that raises an exception" do
+      let(:exception) { StandardError.new("Something else occurred") }
+
+      before do
+        ExceptionHandling.honeybadger_auto_tagger = ->(_exception) { raise StandardError, "boom" }
+      end
+
+      it "logs a message and returns [] for the tags" do
+        expect(Honeybadger).to receive(:notify).with(hash_including({ tags: "some-other-tag" }))
+        expect(ExceptionHandling).to receive(:log_info).with(/Unable to execute honeybadger_auto_tags callback. boom/)
+        ExceptionHandling.log_error(exception, nil, honeybadger_tags: ["some-other-tag"])
+      end
+    end
   end
 
   context "ExceptionHandling < 3.0 " do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: exception_handling
 version: !ruby/object:Gem::Version
-  version: 2.15.0
+  version: 2.16.0
 platform: ruby
 authors:
 - Invoca
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-07 00:00:00.000000000 Z
+date: 2023-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -211,7 +211,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.7
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Invoca's exception handling logger/emailer layer, based on exception_notifier.