exception_handling 2.8.0 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 419ff3f511e22c7c1b257b68064f10b825a08b72cff086c2e3f6cfaeffaa8d74
-  data.tar.gz: 163ea2d99bb20d20fa1935a60f9d4b57de666439235274d9a02b340b662addf5
+  metadata.gz: 98d4a360c553e3d8505ddf0d0de7d4028416f3e1bd62f513b9848dfa95de7cf3
+  data.tar.gz: 4e4ee581d5fb7f4490b1db162ba49113eee07b748a32f0854a53801633156a73
 SHA512:
-  metadata.gz: 7def333f20d79f5f8f2979f41d3c823675eca38ca0e31a3bf27b885cb1098fca6ab3ee147821de4ee8d519c29f7575d9c43ebae157d2f18c6ea2958bfb120f03
-  data.tar.gz: 81dbf1e1d1a8dee6f54a5f98227028a75d633a01d99fc70162d0d2e56dfd4d3e97e6a4103aae140e8a970ec38bae200603de3f8ffeaf3630ccc6add3e9121005
+  metadata.gz: f6b7f7e6d8ccd286e97aec2bc28833a041108a3b16043dfe437f688bbdf45a034c5b3f407ccffa06d26bfe949e7e1aa164747ea4e797fac4ace4f2dc7fce9c34
+  data.tar.gz: fea43abeaf0400f78a975037c5e881b9a41e07b20b934fda5ac7bf35b59ca652daee4ccaa1503abafe818ad3b741edc1ec1a3665ce32e7fdc15ee91f1bb1afb4

data/CHANGELOG.md

@@ -4,7 +4,15 @@ 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.8.0] - Unreleased
+## [2.9.0] - 2020-03-02
+### Added
+- Automatically registers with the `escalate` gem's `on_escalate` callback.
+
+## [2.8.1] - 2020-12-01
+### Added
+- If the `log_context` key `honeybadger_grouping:` is set, pass that value to the `controller:` keyword argument of `HoneyBadger.notify`.
+
+## [2.8.0] - 2020-10-19
 ### Deprecated
 - Deprecated Email Escalation Methods: `escalate_to_production_support`, `escalate_error`, `escalate_warning`, `ensure_escalation`
 
@@ -56,6 +64,8 @@ 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.9.0]: https://github.com/Invoca/exception_handling/compare/v2.8.1...v2.9.0
+[2.8.1]: https://github.com/Invoca/exception_handling/compare/v2.8.0...v2.8.1
 [2.8.0]: https://github.com/Invoca/exception_handling/compare/v2.7.0...v2.8.0
 [2.7.0]: https://github.com/Invoca/exception_handling/compare/v2.6.1...v2.7.0
 [2.6.1]: https://github.com/Invoca/exception_handling/compare/v2.6.0...v2.6.1

data/Gemfile

@@ -4,6 +4,8 @@ source 'https://rubygems.org'
 
 gemspec
 
+gem 'actionmailer', '< 6.1'
+gem 'activesupport', '< 6.1'
 gem 'appraisal', '~> 2.2'
 gem 'honeybadger', '3.3.1-1', git: 'git@github.com:Invoca/honeybadger-ruby', ref: 'bb5f2b8a86e4147c38a6270d39ad610fab4dd5e6'
 gem 'pry'

data/Gemfile.lock

@@ -8,40 +8,41 @@ GIT
 PATH
   remote: .
   specs:
-    exception_handling (2.8.0)
+    exception_handling (2.9.0)
       actionmailer (>= 4.2, < 7.0)
       actionpack (>= 4.2, < 7.0)
       activesupport (>= 4.2, < 7.0)
       contextual_logger (~> 0.7)
+      escalate (~> 0.2)
       eventmachine (~> 1.0)
       invoca-utils (~> 0.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionmailer (6.0.3.4)
-      actionpack (= 6.0.3.4)
-      actionview (= 6.0.3.4)
-      activejob (= 6.0.3.4)
+    actionmailer (6.0.3.5)
+      actionpack (= 6.0.3.5)
+      actionview (= 6.0.3.5)
+      activejob (= 6.0.3.5)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (6.0.3.4)
-      actionview (= 6.0.3.4)
-      activesupport (= 6.0.3.4)
+    actionpack (6.0.3.5)
+      actionview (= 6.0.3.5)
+      activesupport (= 6.0.3.5)
       rack (~> 2.0, >= 2.0.8)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (6.0.3.4)
-      activesupport (= 6.0.3.4)
+    actionview (6.0.3.5)
+      activesupport (= 6.0.3.5)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.0.3.4)
-      activesupport (= 6.0.3.4)
+    activejob (6.0.3.5)
+      activesupport (= 6.0.3.5)
       globalid (>= 0.3.6)
-    activesupport (6.0.3.4)
+    activesupport (6.0.3.5)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -55,32 +56,35 @@ GEM
     builder (3.2.4)
     byebug (11.1.3)
     coderay (1.1.2)
-    concurrent-ruby (1.1.7)
+    concurrent-ruby (1.1.8)
     contextual_logger (0.11.0)
       activesupport
       json
     crass (1.0.6)
     diff-lcs (1.4.4)
-    erubi (1.9.0)
+    erubi (1.10.0)
+    escalate (0.2.0)
+      activesupport
     eventmachine (1.2.7)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
-    i18n (1.8.5)
+    i18n (1.8.9)
       concurrent-ruby (~> 1.0)
     invoca-utils (0.4.1)
     jaro_winkler (1.5.3)
-    json (2.3.1)
-    loofah (2.7.0)
+    json (2.5.1)
+    loofah (2.9.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
     method_source (0.9.2)
     mini_mime (1.0.2)
-    mini_portile2 (2.4.0)
-    minitest (5.14.2)
-    nokogiri (1.10.10)
-      mini_portile2 (~> 2.4.0)
+    mini_portile2 (2.5.0)
+    minitest (5.14.4)
+    nokogiri (1.11.1)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
     parallel (1.17.0)
     parser (2.6.3.0)
       ast (~> 2.4.0)
@@ -91,6 +95,7 @@ GEM
     pry-byebug (3.8.0)
       byebug (~> 11.0)
       pry (~> 0.10)
+    racc (1.5.2)
     rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
@@ -128,15 +133,17 @@ GEM
       power_assert
     thor (1.0.1)
     thread_safe (0.3.6)
-    tzinfo (1.2.7)
+    tzinfo (1.2.9)
       thread_safe (~> 0.1)
     unicode-display_width (1.6.0)
-    zeitwerk (2.4.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  actionmailer (< 6.1)
+  activesupport (< 6.1)
   appraisal (~> 2.2)
   exception_handling!
   honeybadger (= 3.3.1.pre.1)!

data/exception_handling.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'actionpack',        '>= 4.2', '< 7.0'
   spec.add_dependency 'activesupport',     '>= 4.2', '< 7.0'
   spec.add_dependency 'contextual_logger', '~> 0.7'
+  spec.add_dependency 'escalate',          '~> 0.2'
   spec.add_dependency 'eventmachine',      '~> 1.0'
   spec.add_dependency 'invoca-utils',      '~> 0.3'
 end

data/gemfiles/rails_4.gemfile

@@ -2,7 +2,10 @@
 
 source "https://rubygems.org"
 
+gem "actionmailer", "~> 4.2"
+gem "activesupport", "~> 4.2"
 gem "appraisal", "~> 2.2"
+gem "escalate", "0.2.0.pre.1"
 gem "honeybadger", "3.3.1-1", git: "git@github.com:Invoca/honeybadger-ruby", ref: "bb5f2b8a86e4147c38a6270d39ad610fab4dd5e6"
 gem "pry"
 gem "pry-byebug"
@@ -11,8 +14,6 @@ gem "rspec"
 gem "rspec_junit_formatter"
 gem "rubocop"
 gem "test-unit"
-gem "actionmailer", "~> 4.2"
 gem "actionpack", "~> 4.2"
-gem "activesupport", "~> 4.2"
 
 gemspec path: "../"

data/gemfiles/rails_5.gemfile

@@ -2,7 +2,10 @@
 
 source "https://rubygems.org"
 
+gem "actionmailer", "~> 5.2"
+gem "activesupport", "~> 5.2"
 gem "appraisal", "~> 2.2"
+gem "escalate", "0.2.0.pre.1"
 gem "honeybadger", "3.3.1-1", git: "git@github.com:Invoca/honeybadger-ruby", ref: "bb5f2b8a86e4147c38a6270d39ad610fab4dd5e6"
 gem "pry"
 gem "pry-byebug"
@@ -11,8 +14,6 @@ gem "rspec"
 gem "rspec_junit_formatter"
 gem "rubocop"
 gem "test-unit"
-gem "actionmailer", "~> 5.2"
 gem "actionpack", "~> 5.2"
-gem "activesupport", "~> 5.2"
 
 gemspec path: "../"

data/gemfiles/rails_6.gemfile

@@ -2,7 +2,10 @@
 
 source "https://rubygems.org"
 
+gem "actionmailer", "~> 6.0"
+gem "activesupport", "~> 6.0"
 gem "appraisal", "~> 2.2"
+gem "escalate", "0.2.0.pre.1"
 gem "honeybadger", "3.3.1-1", git: "git@github.com:Invoca/honeybadger-ruby", ref: "bb5f2b8a86e4147c38a6270d39ad610fab4dd5e6"
 gem "pry"
 gem "pry-byebug"
@@ -11,8 +14,6 @@ gem "rspec"
 gem "rspec_junit_formatter"
 gem "rubocop"
 gem "test-unit"
-gem "actionmailer", "~> 6.0"
 gem "actionpack", "~> 6.0"
-gem "activesupport", "~> 6.0"
 
 gemspec path: "../"

data/lib/exception_handling.rb

@@ -7,14 +7,15 @@ require 'contextual_logger'
 
 require 'invoca/utils'
 
-require "exception_handling/mailer"
-require "exception_handling/sensu"
-require "exception_handling/methods"
-require "exception_handling/log_stub_error"
-require "exception_handling/exception_description"
-require "exception_handling/exception_catalog"
-require "exception_handling/exception_info"
-require "exception_handling/honeybadger_callbacks.rb"
+require 'exception_handling/mailer'
+require 'exception_handling/sensu'
+require 'exception_handling/methods'
+require 'exception_handling/log_stub_error'
+require 'exception_handling/exception_description'
+require 'exception_handling/exception_catalog'
+require 'exception_handling/exception_info'
+require 'exception_handling/honeybadger_callbacks'
+require 'exception_handling/escalate_callback'
 
 _ = ActiveSupport::HashWithIndifferentAccess
 
@@ -52,6 +53,10 @@ module ExceptionHandling # never included
       @exception_recipients or raise ArgumentError, "You must assign a value to #{name}.exception_recipients"
     end
 
+    def configured?
+      !@logger.nil?
+    end
+
     def logger
       @logger or raise ArgumentError, "You must assign a value to #{name}.logger"
     end
@@ -63,6 +68,7 @@ module ExceptionHandling # never included
                   Deprecation3_0.deprecation_warning('implicit extend with ContextualLogger::LoggerMixin', 'extend your logger instance or include into your logger class first')
                   logger.extend(ContextualLogger::LoggerMixin)
                 end
+      EscalateCallback.register_if_configured!
     end
 
     def default_metric_name(exception_data, exception, treat_like_warning)
@@ -484,4 +490,6 @@ module ExceptionHandling # never included
       end
     end
   end
+
+  EscalateCallback.register_if_configured!
 end

data/lib/exception_handling/escalate_callback.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'escalate'
+
+module ExceptionHandling
+  module EscalateCallback
+    class << self
+      def register_if_configured!
+        register! if ::ExceptionHandling.configured?
+      end
+
+      def register!
+        Escalate.on_escalate(log_first: false) do |exception, location_message, **context|
+          ::ExceptionHandling.log_error(exception, location_message, **context)
+        end
+      end
+    end
+  end
+end

data/lib/exception_handling/exception_info.rb

@@ -82,9 +82,10 @@ module ExceptionHandling
     end
 
     def controller_name
-      @controller_name ||= if @controller
-                             @controller.request.parameters.with_indifferent_access[:controller]
-                           end.to_s
+      @controller_name ||= (
+        @merged_log_context[:honeybadger_grouping] ||
+          (@controller && @controller.request.parameters.with_indifferent_access[:controller])
+      ).to_s
     end
 
     private

data/lib/exception_handling/version.rb

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

data/spec/unit/exception_handling/escalate_callback_spec.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require 'exception_handling/escalate_callback'
+require File.expand_path('../../spec_helper',  __dir__)
+
+module ExceptionHandling
+  describe EscalateCallback do
+    before do
+      class TestGem
+        class << self
+          attr_accessor :logger
+        end
+        include Escalate.mixin
+      end
+      TestGem.logger = logger
+      Escalate.clear_on_escalate_callbacks
+    end
+
+    after do
+      Escalate.clear_on_escalate_callbacks
+    end
+
+    let(:exception) do
+      raise "boom!"
+    rescue => ex
+      ex
+    end
+    let(:location_message) { "happened in TestGem" }
+    let(:context_hash) { { cuid: 'AABBCD' } }
+    let(:logger) { double("logger") }
+
+    describe '.register_if_configured!' do
+      context 'when already configured' do
+        before do
+          @original_logger = ExceptionHandling.logger
+          ExceptionHandling.logger = ::Logger.new('/dev/null')
+        end
+
+        after do
+          ExceptionHandling.logger = @original_logger
+        end
+
+        it 'registers a callback' do
+          EscalateCallback.register_if_configured!
+
+          expect(logger).to_not receive(:error)
+          expect(logger).to_not receive(:fatal)
+          expect(ExceptionHandling).to receive(:log_error).with(exception, location_message, context_hash)
+
+          TestGem.escalate(exception, location_message, context_hash)
+        end
+      end
+
+      context 'when not yet configured' do
+        before do
+          @original_logger = ExceptionHandling.logger
+          ExceptionHandling.logger = nil
+        end
+
+        after do
+          ExceptionHandling.logger = @original_logger
+        end
+
+        it 'registers a callback once the logger is set' do
+          EscalateCallback.register_if_configured!
+
+          expect(Escalate.on_escalate_callbacks).to be_empty
+
+          ExceptionHandling.logger = ::Logger.new('/dev/null')
+          expect(Escalate.on_escalate_callbacks).to_not be_empty
+
+          expect(logger).to_not receive(:error)
+          expect(logger).to_not receive(:fatal)
+          expect(ExceptionHandling).to receive(:log_error).with(exception, location_message, context_hash)
+
+          TestGem.escalate(exception, location_message, context_hash)
+        end
+      end
+    end
+  end
+end

data/spec/unit/exception_handling/exception_info_spec.rb

@@ -361,6 +361,26 @@ module ExceptionHandling
         }
       end
 
+      it "returns honeybadger_grouping from the log context" do
+        allow(ExceptionHandling.logger).to receive(:current_context_for_thread).and_return({ honeybadger_grouping: 'Group 1' })
+        exception_info = ExceptionInfo.new(@exception, @exception_context, @timestamp)
+
+        expect(exception_info.controller_name).to eq('Group 1')
+      end
+
+      it "returns honeybadger_grouping from log context even if controller is defined" do
+        allow(ExceptionHandling.logger).to receive(:current_context_for_thread).and_return({ honeybadger_grouping: 'Group 1' })
+
+        env         = { server:     'fe98' }
+        parameters  = { controller: 'some_controller' }
+        session     = { username:   'smith' }
+        request_uri = "host/path"
+        controller  = create_dummy_controller(env, parameters, session, request_uri)
+        exception_info = ExceptionInfo.new(@exception, @exception_context, @timestamp, controller: controller)
+
+        expect(exception_info.controller_name).to eq('Group 1')
+      end
+
       it "return controller_name when controller is present" do
         env         = { server:     'fe98' }
         parameters  = { controller: 'some_controller' }

data/spec/unit/exception_handling/mailer_spec.rb

@@ -93,6 +93,5 @@ module ExceptionHandling
         end
       end
     end
-
   end
 end

data/spec/unit/exception_handling_spec.rb

@@ -117,7 +117,7 @@ describe ExceptionHandling do
       before { @original_logger = ExceptionHandling.logger }
       after { ExceptionHandling.logger = @original_logger }
 
-      it "store logger as-is if it has ContextualLogger::Mixin" do
+      it "stores logger as-is if it has ContextualLogger::Mixin" do
         logger = Logger.new('/dev/null')
         logger.extend(ContextualLogger::LoggerMixin)
         ancestors = logger.singleton_class.ancestors.*.name
@@ -126,33 +126,33 @@ describe ExceptionHandling do
         expect(ExceptionHandling.logger.singleton_class.ancestors.*.name).to eq(ancestors)
       end
 
-      it "allow logger = nil (no deprecation warning)" do
+      it "allows logger = nil (no deprecation warning)" do
         expect(STDERR).to receive(:puts).with(/DEPRECATION WARNING/).never
         ExceptionHandling.logger = nil
       end
 
-      it "[deprecated] mix in ContextualLogger::Mixin if not there" do
+      it "[deprecated] mixes in ContextualLogger::Mixin if not there" do
         expect(STDERR).to receive(:puts).with(/DEPRECATION WARNING: implicit extend with ContextualLogger::LoggerMixin is deprecated and will be removed from exception_handling 3\.0/)
         logger = Logger.new('/dev/null')
         ancestors = logger.singleton_class.ancestors.*.name
 
         ExceptionHandling.logger = logger
-        expect(ExceptionHandling.logger.singleton_class.ancestors.*.name).to_not eq(ancestors)
         expect(ExceptionHandling.logger).to be_kind_of(ContextualLogger::LoggerMixin)
+        expect(ExceptionHandling.logger.singleton_class.ancestors.*.name).to_not eq(ancestors)
       end
-    end
 
-    context "#log_error" do
-      it "take in additional logging context hash and pass it to the logger" do
-        ExceptionHandling.log_error('This is an Error', 'This is the prefix context', service_name: 'exception_handling')
-        expect(logged_excluding_reload_filter.last[:message]).to match(/This is an Error/)
-        expect(logged_excluding_reload_filter.last[:context]).to_not be_empty
-        expect(service_name: 'exception_handling').to eq(logged_excluding_reload_filter.last[:context])
-      end
+      context "#log_error" do
+        it "takes in additional logging context hash and pass it to the logger" do
+          ExceptionHandling.log_error('This is an Error', 'This is the prefix context', service_name: 'exception_handling')
+          expect(logged_excluding_reload_filter.last[:message]).to match(/This is an Error/)
+          expect(logged_excluding_reload_filter.last[:context]).to_not be_empty
+          expect(service_name: 'exception_handling').to eq(logged_excluding_reload_filter.last[:context])
+        end
 
-      it "log 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])
+        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])
+        end
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: exception_handling
 version: !ruby/object:Gem::Version
-  version: 2.8.0
+  version: 2.9.0
 platform: ruby
 authors:
 - Invoca
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-19 00:00:00.000000000 Z
+date: 2021-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -84,6 +84,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: escalate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: eventmachine
   requirement: !ruby/object:Gem::Requirement
@@ -139,6 +153,7 @@ files:
 - gemfiles/rails_5.gemfile
 - gemfiles/rails_6.gemfile
 - lib/exception_handling.rb
+- lib/exception_handling/escalate_callback.rb
 - lib/exception_handling/exception_catalog.rb
 - lib/exception_handling/exception_description.rb
 - lib/exception_handling/exception_info.rb
@@ -154,6 +169,7 @@ files:
 - spec/helpers/exception_helpers.rb
 - spec/rake_test_warning_false.rb
 - spec/spec_helper.rb
+- spec/unit/exception_handling/escalate_callback_spec.rb
 - spec/unit/exception_handling/exception_catalog_spec.rb
 - spec/unit/exception_handling/exception_description_spec.rb
 - spec/unit/exception_handling/exception_info_spec.rb
@@ -172,7 +188,7 @@ licenses: []
 metadata:
   source_code_uri: https://github.com/Invoca/exception_handling
   allowed_push_host: https://rubygems.org
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -188,7 +204,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Invoca's exception handling logger/emailer layer, based on exception_notifier.
   Works with Rails or EventMachine or EventMachine+Synchrony.
@@ -197,6 +213,7 @@ test_files:
 - spec/helpers/exception_helpers.rb
 - spec/rake_test_warning_false.rb
 - spec/spec_helper.rb
+- spec/unit/exception_handling/escalate_callback_spec.rb
 - spec/unit/exception_handling/exception_catalog_spec.rb
 - spec/unit/exception_handling/exception_description_spec.rb
 - spec/unit/exception_handling/exception_info_spec.rb