exception_notification 5.0.0 → 5.0.1

data/test/exception_notifier_test.rb

@@ -1,298 +0,0 @@
-# frozen_string_literal: true
-
-require "test_helper"
-
-class ExceptionOne < StandardError; end
-
-class ExceptionTwo < StandardError; end
-
-class StandardErrorSubclass < StandardError; end
-
-class ExceptionNotifierTest < ActiveSupport::TestCase
-  setup do
-    ExceptionNotifier.register_exception_notifier(:email, exception_recipients: %w[dummyexceptions@example.com])
-
-    @notifier_calls = 0
-    @test_notifier = ->(_exception, _options) { @notifier_calls += 1 }
-  end
-
-  teardown do
-    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",
-        "ActionDispatch::Http::MimeNegotiation::InvalidType",
-        "Rack::Utils::InvalidParameterError"]
-  end
-
-  test "should have email notifier registered" do
-    assert_equal ExceptionNotifier.notifiers, [:email]
-  end
-
-  test "should have a valid email notifier" do
-    @email_notifier = ExceptionNotifier.registered_exception_notifier(:email)
-    refute_nil @email_notifier
-    assert_equal @email_notifier.class, ExceptionNotifier::EmailNotifier
-    assert_respond_to @email_notifier, :call
-  end
-
-  test "should allow register/unregister another notifier" do
-    called = false
-    proc_notifier = ->(_exception, _options) { called = true }
-    ExceptionNotifier.register_exception_notifier(:proc, proc_notifier)
-
-    assert_equal ExceptionNotifier.notifiers.sort, %i[email proc]
-
-    exception = StandardError.new
-
-    ExceptionNotifier.notify_exception(exception)
-    assert called
-
-    ExceptionNotifier.unregister_exception_notifier(:proc)
-    assert_equal ExceptionNotifier.notifiers, [:email]
-  end
-
-  test "should allow select notifiers to send error to" 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)
-
-    assert_equal ExceptionNotifier.notifiers.sort, %i[email notifier1 notifier2]
-
-    exception = StandardError.new
-    ExceptionNotifier.notify_exception(exception)
-    assert_equal notifier1_calls, 1
-    assert_equal notifier2_calls, 1
-
-    ExceptionNotifier.notify_exception(exception, notifiers: :notifier1)
-    assert_equal notifier1_calls, 2
-    assert_equal notifier2_calls, 1
-
-    ExceptionNotifier.notify_exception(exception, notifiers: :notifier2)
-    assert_equal notifier1_calls, 2
-    assert_equal notifier2_calls, 2
-
-    ExceptionNotifier.unregister_exception_notifier(:notifier1)
-    ExceptionNotifier.unregister_exception_notifier(:notifier2)
-    assert_equal ExceptionNotifier.notifiers, [:email]
-  end
-
-  test "should ignore exception if satisfies conditional ignore" do
-    env = "production"
-    ExceptionNotifier.ignore_if do |_exception, _options|
-      env != "production"
-    end
-
-    ExceptionNotifier.register_exception_notifier(:test, @test_notifier)
-
-    exception = StandardError.new
-
-    ExceptionNotifier.notify_exception(exception, notifiers: :test)
-    assert_equal @notifier_calls, 1
-
-    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.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
-    ExceptionNotifier.register_exception_notifier(:test, @test_notifier)
-
-    exception = StandardError.new
-
-    ExceptionNotifier.notify_exception(exception, notifiers: :test)
-    assert_equal @notifier_calls, 1
-
-    ExceptionNotifier.notify_exception(exception, notifiers: :test, ignore_exceptions: "StandardError")
-    assert_equal @notifier_calls, 1
-  end
-
-  test "should not send notification if subclass of one of ignored exceptions" do
-    ExceptionNotifier.register_exception_notifier(:test, @test_notifier)
-
-    exception = StandardErrorSubclass.new
-
-    ExceptionNotifier.notify_exception(exception, notifiers: :test)
-    assert_equal @notifier_calls, 1
-
-    ExceptionNotifier.notify_exception(exception, notifiers: :test, ignore_exceptions: "StandardError")
-    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)
-
-    # Define module at runtime
-    Object.const_set(:StandardErrorModule, Module.new)
-
-    exception = StandardError.new
-    exception.extend StandardErrorModule
-
-    ExceptionNotifier.notify_exception(exception, notifiers: :test)
-    assert_equal @notifier_calls, 1
-
-    ignore_exceptions = "StandardErrorModule"
-    ExceptionNotifier.notify_exception(exception, notifiers: :test, ignore_exceptions: ignore_exceptions)
-    assert_equal @notifier_calls, 1
-  ensure
-    # Clean up by removing the module
-    Object.send(:remove_const, :StandardErrorModule)
-  end
-
-  test "should not send notification if prepended module at singleton class one of ignored exceptions" do
-    ExceptionNotifier.register_exception_notifier(:test, @test_notifier)
-
-    # Define module at runtime
-    Object.const_set(:StandardErrorModule, Module.new)
-
-    exception = StandardError.new
-    exception.singleton_class.prepend StandardErrorModule
-
-    ExceptionNotifier.notify_exception(exception, notifiers: :test)
-    assert_equal @notifier_calls, 1
-
-    ignore_exceptions = "StandardErrorModule"
-    ExceptionNotifier.notify_exception(exception, notifiers: :test, ignore_exceptions: ignore_exceptions)
-    assert_equal @notifier_calls, 1
-  ensure
-    # Clean up by removing the module
-    Object.send(:remove_const, :StandardErrorModule)
-  end
-
-  test "should call received block" do
-    @block_called = false
-    notifier = ->(_exception, _options, &block) { block.call }
-    ExceptionNotifier.register_exception_notifier(:test, notifier)
-
-    exception = ExceptionOne.new
-
-    ExceptionNotifier.notify_exception(exception) do
-      @block_called = true
-    end
-
-    assert @block_called
-  end
-
-  test "should not call group_error! or send_notification? if error_grouping false" do
-    exception = StandardError.new
-    ExceptionNotifier.expects(:group_error!).never
-    ExceptionNotifier.expects(:send_notification?).never
-
-    ExceptionNotifier.notify_exception(exception)
-  end
-
-  test "should call group_error! and send_notification? if error_grouping true" do
-    ExceptionNotifier.error_grouping = true
-
-    exception = StandardError.new
-    ExceptionNotifier.expects(:group_error!).once
-    ExceptionNotifier.expects(:send_notification?).once
-
-    ExceptionNotifier.notify_exception(exception)
-  end
-
-  test "should skip notification if send_notification? is false" do
-    ExceptionNotifier.error_grouping = true
-
-    exception = StandardError.new
-    ExceptionNotifier.expects(:group_error!).once.returns(1)
-    ExceptionNotifier.expects(:send_notification?).with(exception, 1).once.returns(false)
-
-    refute ExceptionNotifier.notify_exception(exception)
-  end
-
-  test "should send notification if send_notification? is true" do
-    ExceptionNotifier.error_grouping = true
-
-    exception = StandardError.new
-    ExceptionNotifier.expects(:group_error!).once.returns(1)
-    ExceptionNotifier.expects(:send_notification?).with(exception, 1).once.returns(true)
-
-    assert ExceptionNotifier.notify_exception(exception)
-  end
-end

data/test/support/exception_notifier_helper.rb

@@ -1,14 +0,0 @@
-# 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/support/views/exception_notifier/_new_bkg_section.html.erb

@@ -1 +0,0 @@
-* New background section for testing

data/test/support/views/exception_notifier/_new_bkg_section.text.erb

@@ -1 +0,0 @@
-* New background section for testing

data/test/support/views/exception_notifier/_new_section.html.erb

@@ -1 +0,0 @@
-* New html section for testing

data/test/support/views/exception_notifier/_new_section.text.erb

@@ -1 +0,0 @@
-* New text section for testing

data/test/test_helper.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
-require "exception_notification"
-
-require "minitest/autorun"
-require "mocha/minitest"
-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"