exception_notification 4.4.0 → 4.4.1

data/test/exception_notifier/webhook_notifier_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 require 'httparty'
 
@@ -88,9 +90,9 @@ class WebhookNotifierTest < ActiveSupport::TestCase
 
   def fake_exception
     @fake_exception ||= begin
-      5 / 0
-    rescue StandardError => e
-      e
-    end
+                          5 / 0
+                        rescue StandardError => e
+                          e
+                        end
   end
 end

data/test/exception_notifier_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 class ExceptionOne < StandardError; end
@@ -12,17 +14,16 @@ class ExceptionNotifierTest < ActiveSupport::TestCase
   end
 
   teardown do
-    ExceptionNotifier.error_grouping = false
-    ExceptionNotifier.notification_trigger = nil
-    ExceptionNotifier.class_eval('@@notifiers.delete_if { |k, _| k.to_s != "email"}') # reset notifiers
+    ExceptionNotifier.reset_notifiers!
 
     Rails.cache.clear if defined?(Rails) && Rails.respond_to?(:cache)
   end
 
   test 'should have default ignored exceptions' do
     assert_equal ExceptionNotifier.ignored_exceptions,
-                 ['ActiveRecord::RecordNotFound', 'Mongoid::Errors::DocumentNotFound', 'AbstractController::ActionNotFound',
-                  'ActionController::RoutingError', 'ActionController::UnknownFormat', 'ActionController::UrlGenerationError']
+                 ['ActiveRecord::RecordNotFound', 'Mongoid::Errors::DocumentNotFound',
+                  'AbstractController::ActionNotFound', 'ActionController::RoutingError',
+                  'ActionController::UnknownFormat', 'ActionController::UrlGenerationError']
   end
 
   test 'should have email notifier registered' do
@@ -97,8 +98,81 @@ class ExceptionNotifierTest < ActiveSupport::TestCase
     env = 'development'
     ExceptionNotifier.notify_exception(exception, notifiers: :test)
     assert_equal @notifier_calls, 1
+  end
+
+  test 'should ignore exception if satisfies by-notifier conditional ignore' do
+    notifier1_calls = 0
+    notifier1 = ->(_exception, _options) { notifier1_calls += 1 }
+    ExceptionNotifier.register_exception_notifier(:notifier1, notifier1)
+
+    notifier2_calls = 0
+    notifier2 = ->(_exception, _options) { notifier2_calls += 1 }
+    ExceptionNotifier.register_exception_notifier(:notifier2, notifier2)
+
+    env = 'production'
+    ExceptionNotifier.ignore_notifier_if(:notifier1) do |_exception, _options|
+      env == 'development'
+    end
+    ExceptionNotifier.ignore_notifier_if(:notifier2) do |_exception, _options|
+      env == 'production'
+    end
+
+    exception = StandardError.new
+
+    ExceptionNotifier.notify_exception(exception)
+    assert_equal notifier1_calls, 1
+    assert_equal notifier2_calls, 0
+
+    env = 'development'
+
+    ExceptionNotifier.notify_exception(exception)
+    assert_equal notifier1_calls, 1
+    assert_equal notifier2_calls, 1
+
+    env = 'test'
+
+    ExceptionNotifier.notify_exception(exception)
+    assert_equal notifier1_calls, 2
+    assert_equal notifier2_calls, 2
+  end
+
+  test 'should return false if all the registered notifiers are ignored' do
+    ExceptionNotifier.notifiers.each do |notifier|
+      # make sure to register no other notifiers but the tested ones
+      ExceptionNotifier.unregister_exception_notifier(notifier)
+    end
+
+    ExceptionNotifier.register_exception_notifier(:notifier1, ->(_, _) {})
+    ExceptionNotifier.register_exception_notifier(:notifier2, ->(_, _) {})
+
+    ExceptionNotifier.ignore_notifier_if(:notifier1) do |exception, _options|
+      exception.message =~ /non_critical_error/
+    end
+    ExceptionNotifier.ignore_notifier_if(:notifier2) do |exception, _options|
+      exception.message =~ /non_critical_error/
+    end
+
+    exception = StandardError.new('a non_critical_error occured.')
+
+    refute ExceptionNotifier.notify_exception(exception)
+  end
+
+  test 'should return true if one of the notifiers fires' do
+    ExceptionNotifier.notifiers.each do |notifier|
+      # make sure to register no other notifiers but the tested ones
+      ExceptionNotifier.unregister_exception_notifier(notifier)
+    end
+
+    ExceptionNotifier.register_exception_notifier(:notifier1, ->(_, _) {})
+    ExceptionNotifier.register_exception_notifier(:notifier2, ->(_, _) {})
 
-    ExceptionNotifier.clear_ignore_conditions!
+    ExceptionNotifier.ignore_notifier_if(:notifier1) do |exception, _options|
+      exception.message =~ /non-critical\serror/
+    end
+
+    exception = StandardError.new('a non-critical error occured')
+
+    assert ExceptionNotifier.notify_exception(exception)
   end
 
   test 'should not send notification if one of ignored exceptions' do
@@ -128,6 +202,38 @@ class ExceptionNotifierTest < ActiveSupport::TestCase
     assert_equal @notifier_calls, 1
   end
 
+  test 'should not send notification if extended module one of ignored exceptions' do
+    ExceptionNotifier.register_exception_notifier(:test, @test_notifier)
+
+    module StandardErrorModule; end
+
+    exception = StandardError.new
+    exception.extend StandardErrorModule
+
+    ExceptionNotifier.notify_exception(exception, notifiers: :test)
+    assert_equal @notifier_calls, 1
+
+    ignore_exceptions = 'ExceptionNotifierTest::StandardErrorModule'
+    ExceptionNotifier.notify_exception(exception, notifiers: :test, ignore_exceptions: ignore_exceptions)
+    assert_equal @notifier_calls, 1
+  end
+
+  test 'should not send notification if prepended module at singleton class one of ignored exceptions' do
+    ExceptionNotifier.register_exception_notifier(:test, @test_notifier)
+
+    module StandardErrorModule; end
+
+    exception = StandardError.new
+    exception.singleton_class.prepend StandardErrorModule
+
+    ExceptionNotifier.notify_exception(exception, notifiers: :test)
+    assert_equal @notifier_calls, 1
+
+    ignore_exceptions = 'ExceptionNotifierTest::StandardErrorModule'
+    ExceptionNotifier.notify_exception(exception, notifiers: :test, ignore_exceptions: ignore_exceptions)
+    assert_equal @notifier_calls, 1
+  end
+
   test 'should call received block' do
     @block_called = false
     notifier = ->(_exception, _options, &block) { block.call }

data/test/support/exception_notifier_helper.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# this extension allows ExceptionNotifier to reset all the glocal settings
+# (i.e. class vars that otherwise remains during the test)
+# please remembeer to call this method each time after you set such settings
+# to prevent order dependent test fails.
+module ExceptionNotifier
+  def self.reset_notifiers!
+    @@notifiers = {}
+    clear_ignore_conditions!
+    ExceptionNotifier.error_grouping = false
+    ExceptionNotifier.notification_trigger = nil
+  end
+end

data/test/test_helper.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require 'coveralls'
 Coveralls.wear!
 
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
 require 'exception_notification'
 
 require 'minitest/autorun'
@@ -10,6 +12,8 @@ require 'active_support/test_case'
 require 'action_mailer'
 
 ExceptionNotifier.testing_mode!
+require 'support/exception_notifier_helper'
+
 Time.zone = 'UTC'
 ActionMailer::Base.delivery_method = :test
 ActionMailer::Base.append_view_path "#{File.dirname(__FILE__)}/support/views"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: exception_notification
 version: !ruby/object:Gem::Version
-  version: 4.4.0
+  version: 4.4.1
 platform: ruby
 authors:
 - Jamis Buck
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-16 00:00:00.000000000 Z
+date: 2020-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -150,33 +150,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.10.2
 - !ruby/object:Gem::Dependency
-  name: mock_redis
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.13.0
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: mock_redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 0.19.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 0.19.0
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -217,34 +217,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: 0.78.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: 0.78.0
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.0.0
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.2
+        version: 5.0.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.0.0
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.2
+        version: 5.0.4
 - !ruby/object:Gem::Dependency
   name: slack-notifier
   requirement: !ruby/object:Gem::Requirement
@@ -386,6 +380,7 @@ files:
 - test/exception_notifier/teams_notifier_test.rb
 - test/exception_notifier/webhook_notifier_test.rb
 - test/exception_notifier_test.rb
+- test/support/exception_notifier_helper.rb
 - test/support/views/exception_notifier/_new_bkg_section.html.erb
 - test/support/views/exception_notifier/_new_bkg_section.text.erb
 - test/support/views/exception_notifier/_new_section.html.erb
@@ -403,15 +398,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: 1.8.11
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Exception notification for Rails apps
@@ -433,6 +427,7 @@ test_files:
 - test/exception_notifier/teams_notifier_test.rb
 - test/exception_notifier/webhook_notifier_test.rb
 - test/exception_notifier_test.rb
+- test/support/exception_notifier_helper.rb
 - test/support/views/exception_notifier/_new_bkg_section.html.erb
 - test/support/views/exception_notifier/_new_bkg_section.text.erb
 - test/support/views/exception_notifier/_new_section.html.erb