exception_handling 2.12.0 → 2.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4e00da46ba75755214ab18ec1fa16bb9b230fbaf708031b97c1bb30f2c2f854
-  data.tar.gz: 2cf79b0eec0a66c825b98062d2b50609c8821500003f36834bded3bc5fc7ea5d
+  metadata.gz: 1125ae1526cff9890e52497ac1a8b8d93a62a481afa49a74709c5f286f53b912
+  data.tar.gz: 3f882364adfb48ee837fc178cb3adcb85ab6c43b90bde5e04f96aea07559efc6
 SHA512:
-  metadata.gz: 29b73b67171866400ce1f5a07e6654593f57cb24e1de9a07d37b8e4ac039c3c8faca4d004bec784b0810c984e8caec9e10ff2aa26357a4a76fbb18dd6ad49632
-  data.tar.gz: 567d9ff144876f3fed8429a892e16f0a4e81440a2881c790bc3dc478ef9500050b0210fca71ed94e00f289a76a234898c46f45ba9de6738ffa351c41251cbdab
+  metadata.gz: efbe4b3c2843a4e07daf38a83606d504714b1bfa2dedc406070fc6a1e68a66ccf379cb459f5364c0c8c8ac43b9265474ab50d9dce7f31ec78de5791ff166c195
+  data.tar.gz: 1a69645d781332b9e7882921dbaded4d001c87ead47a40902b55e385c21e419ed48d9c3790cb38c38392a0fe2c872e05d003814bcd57b54e6cb27b38c3828772

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.13.0] - 2022-09-15
+### Added
+- Added an option for removing the 'exception_handling.' prefix from metric names in ExceptionHandling::default_metric_name
+
 ## [2.12.0] - 2022-08-04
 ### Added
 - Support for passing additional Honeybadger configuration parameters
@@ -95,6 +99,7 @@ Note: this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0
 ### Changed
 - No longer depends on hobo_support. Uses invoca-utils 0.3 instead.
 
+[2.13.0]: https://github.com/Invoca/exception_handling/compare/v2.12.0...v2.13.0
 [2.12.0]: https://github.com/Invoca/exception_handling/compare/v2.11.3...v2.12.0
 [2.11.3]: https://github.com/Invoca/exception_handling/compare/v2.11.2...v2.11.3
 [2.11.2]: https://github.com/Invoca/exception_handling/compare/v2.11.1...v2.11.2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    exception_handling (2.12.0)
+    exception_handling (2.13.0)
       actionmailer (>= 5.2, < 7.0)
       actionpack (>= 5.2, < 7.0)
       activesupport (>= 5.2, < 7.0)
@@ -97,7 +97,7 @@ GEM
     pry-byebug (3.8.0)
       byebug (~> 11.0)
       pry (~> 0.10)
-    psych (3.3.2)
+    psych (3.3.3)
     racc (1.6.0)
     rack (2.2.3)
     rack-test (1.1.0)

data/lib/exception_handling/version.rb

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

data/lib/exception_handling.rb

@@ -71,7 +71,10 @@ module ExceptionHandling # never included
       EscalateCallback.register_if_configured!
     end
 
-    def default_metric_name(exception_data, exception, treat_like_warning)
+    def default_metric_name(exception_data, exception, treat_like_warning, include_prefix: true)
+      include_prefix and Deprecation3_0.deprecation_warning("the 'expection_handling.' prefix in ExceptionHandling::default_metric_name",
+                                                            "do not rely on metric names including the 'exception_handling.' prefix.")
+
       metric_name = if exception_data['metric_name']
                       exception_data['metric_name']
                     elsif exception.is_a?(ExceptionHandling::Warning)
@@ -83,7 +86,7 @@ module ExceptionHandling # never included
                       "exception"
                     end
 
-      "exception_handling.#{metric_name}"
+      "#{'exception_handling.' if include_prefix}#{metric_name}"
     end
 
     def default_honeybadger_metric_name(honeybadger_status)

data/spec/unit/exception_handling_spec.rb

@@ -307,42 +307,91 @@ describe ExceptionHandling do
 
     context "Exception Handling" do
       context "default_metric_name" do
-        context "when metric_name is present in exception_data" do
-          it "include metric_name in resulting metric name" do
-            exception = StandardError.new('this is an exception')
-            metric    = ExceptionHandling.default_metric_name({ 'metric_name' => 'special_metric' }, exception, true)
-            expect(metric).to eq('exception_handling.special_metric')
+        context "with include_prefix true" do
+          it "logs a deprecation warning" do
+            expect { ExceptionHandling.default_metric_name({}, StandardError.new('this is an exception'), false) }
+              .to output(/DEPRECATION WARNING: the 'expection_handling\.' prefix in ExceptionHandling::default_metric_name is deprecated/).to_stderr
           end
-        end
 
-        context "when metric_name is not present in exception_data" do
-          it "return exception_handling.warning when using log warning" do
-            warning = ExceptionHandling::Warning.new('this is a warning')
-            metric  = ExceptionHandling.default_metric_name({}, warning, false)
-            expect(metric).to eq('exception_handling.warning')
+          context "when metric_name is present in exception_data" do
+            it "include metric_name in resulting metric name" do
+              exception = StandardError.new('this is an exception')
+              metric    = ExceptionHandling.default_metric_name({ 'metric_name' => 'special_metric' }, exception, true, include_prefix: true)
+              expect(metric).to eq('exception_handling.special_metric')
+            end
           end
 
-          it "return exception_handling.exception when using log error" do
-            exception = StandardError.new('this is an exception')
-            metric    = ExceptionHandling.default_metric_name({}, exception, false)
-            expect(metric).to eq('exception_handling.exception')
-          end
+          context "when metric_name is not present in exception_data" do
+            it "return exception_handling.warning when using log warning" do
+              warning = ExceptionHandling::Warning.new('this is a warning')
+              metric  = ExceptionHandling.default_metric_name({}, warning, false, include_prefix: true)
+              expect(metric).to eq('exception_handling.warning')
+            end
 
-          context "when using log error with treat_like_warning" do
-            it "return exception_handling.unforwarded_exception when exception not present" do
-              metric = ExceptionHandling.default_metric_name({}, nil, true)
-              expect(metric).to eq('exception_handling.unforwarded_exception')
+            it "return exception_handling.exception when using log error" do
+              exception = StandardError.new('this is an exception')
+              metric    = ExceptionHandling.default_metric_name({}, exception, false, include_prefix: true)
+              expect(metric).to eq('exception_handling.exception')
             end
 
-            it "return exception_handling.unforwarded_exception with exception classname when exception is present" do
-              module SomeModule
-                class SomeException < StandardError
+            context "when using log error with treat_like_warning" do
+              it "return exception_handling.unforwarded_exception when exception not present" do
+                metric = ExceptionHandling.default_metric_name({}, nil, true, include_prefix: true)
+                expect(metric).to eq('exception_handling.unforwarded_exception')
+              end
+
+              it "return exception_handling.unforwarded_exception with exception classname when exception is present" do
+                module SomeModule
+                  class SomeException < StandardError
+                  end
                 end
+
+                exception = SomeModule::SomeException.new('this is an exception')
+                metric    = ExceptionHandling.default_metric_name({}, exception, true, include_prefix: true)
+                expect(metric).to eq('exception_handling.unforwarded_exception_SomeException')
+              end
+            end
+          end
+        end
+
+        context "with include_prefix false" do
+          context "when metric_name is present in exception_data" do
+            it "include metric_name in resulting metric name" do
+              exception = StandardError.new('this is an exception')
+              metric    = ExceptionHandling.default_metric_name({ 'metric_name' => 'special_metric' }, exception, true, include_prefix: false)
+              expect(metric).to eq('special_metric')
+            end
+          end
+
+          context "when metric_name is not present in exception_data" do
+            it "return exception_handling.warning when using log warning" do
+              warning = ExceptionHandling::Warning.new('this is a warning')
+              metric  = ExceptionHandling.default_metric_name({}, warning, false, include_prefix: false)
+              expect(metric).to eq('warning')
+            end
+
+            it "return exception_handling.exception when using log error" do
+              exception = StandardError.new('this is an exception')
+              metric    = ExceptionHandling.default_metric_name({}, exception, false, include_prefix: false)
+              expect(metric).to eq('exception')
+            end
+
+            context "when using log error with treat_like_warning" do
+              it "return exception_handling.unforwarded_exception when exception not present" do
+                metric = ExceptionHandling.default_metric_name({}, nil, true, include_prefix: false)
+                expect(metric).to eq('unforwarded_exception')
               end
 
-              exception = SomeModule::SomeException.new('this is an exception')
-              metric    = ExceptionHandling.default_metric_name({}, exception, true)
-              expect(metric).to eq('exception_handling.unforwarded_exception_SomeException')
+              it "return exception_handling.unforwarded_exception with exception classname when exception is present" do
+                module SomeModule
+                  class SomeException < StandardError
+                  end
+                end
+
+                exception = SomeModule::SomeException.new('this is an exception')
+                metric    = ExceptionHandling.default_metric_name({}, exception, true, include_prefix: false)
+                expect(metric).to eq('unforwarded_exception_SomeException')
+              end
             end
           end
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: exception_handling
 version: !ruby/object:Gem::Version
-  version: 2.12.0
+  version: 2.13.0
 platform: ruby
 authors:
 - Invoca
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-04 00:00:00.000000000 Z
+date: 2022-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer