exception_notification 4.6.0 → 5.0.0

data/lib/generators/exception_notification/templates/exception_notification.rb.erb

@@ -1,22 +1,21 @@
 # Move this require to your `config/application.rb` if you want to be notified from runner commands too.
-require 'exception_notification/rails'
-require 'exception_notification/rake'
+require "exception_notification/rails"
+require "exception_notification/rake"
 <% if options.sidekiq? %>
-require 'exception_notification/sidekiq'
-<% end %>
-<% if options.resque? %>
-require 'resque/failure/multiple'
-require 'resque/failure/redis'
-require 'exception_notification/resque'
+require "exception_notification/sidekiq"<% end %><% if options.resque? %>
+require "resque/failure/multiple"
+require "resque/failure/redis"
+require "exception_notification/resque"
 
-Resque::Failure::Multiple.classes = [Resque::Failure::Redis, ExceptionNotification::Resque]
-Resque::Failure.backend = Resque::Failure::Multiple
-<% end %>
+Resque::Failure::Multiple.classes = [ Resque::Failure::Redis, ExceptionNotification::Resque ]
+Resque::Failure.backend = Resque::Failure::Multiple<% end %>
 
 ExceptionNotification.configure do |config|
-  # Ignore additional exception types.
-  # ActiveRecord::RecordNotFound, Mongoid::Errors::DocumentNotFound, AbstractController::ActionNotFound and ActionController::RoutingError are already added.
-  # config.ignored_exceptions += %w{ActionView::TemplateError CustomError}
+  # Ignore additional exception types. The default list of exception classes is:
+  #   ActiveRecord::RecordNotFound Mongoid::Errors::DocumentNotFound AbstractController::ActionNotFound
+  #   ActionController::RoutingError ActionController::UnknownFormat ActionController::UrlGenerationError
+  #   ActionDispatch::Http::MimeNegotiation::InvalidType Rack::Utils::InvalidParameterError
+  # config.ignored_exceptions += %w[ActionView::TemplateError CustomError]
 
   # Adds a condition to decide when an exception must be ignored or not.
   # The ignore_if method can be invoked multiple times to add extra conditions.
@@ -25,33 +24,33 @@ ExceptionNotification.configure do |config|
   # end
 
   # Ignore exceptions generated by crawlers
-  # config.ignore_crawlers %w{Googlebot bingbot}
+  # config.ignore_crawlers %w[Googlebot bingbot]
 
   # Notifiers =================================================================
 
   # Email notifier sends notifications by email.
   config.add_notifier :email, {
-    email_prefix: '[ERROR] ',
-    sender_address: %{"Notifier" <notifier@example.com>},
-    exception_recipients: %w{exceptions@example.com}
+    email_prefix: "[ERROR] ",
+    sender_address: %("Notifier" <notifier@example.com>),
+    exception_recipients: %w[exceptions@example.com]
   }
 
-  # Campfire notifier sends notifications to your Campfire room. Requires 'tinder' gem.
+  # Campfire notifier sends notifications to your Campfire room. Requires "tinder" gem.
   # config.add_notifier :campfire, {
-  #   subdomain: 'my_subdomain',
-  #   token: 'my_token',
-  #   room_name: 'my_room'
+  #   subdomain: "my_subdomain",
+  #   token: "my_token",
+  #   room_name: "my_room"
   # }
 
-  # HipChat notifier sends notifications to your HipChat room. Requires 'hipchat' gem.
+  # HipChat notifier sends notifications to your HipChat room. Requires "hipchat" gem.
   # config.add_notifier :hipchat, {
-  #   api_token: 'my_token',
-  #   room_name: 'my_room'
+  #   api_token: "my_token",
+  #   room_name: "my_room"
   # }
 
-  # Webhook notifier sends notifications over HTTP protocol. Requires 'httparty' gem.
+  # Webhook notifier sends notifications over HTTP protocol. Requires "httparty" gem.
   # config.add_notifier :webhook, {
-  #   url: 'http://example.com:5555/hubot/path',
+  #   url: "http://example.com:5555/hubot/path",
   #   http_method: :post
   # }
 end

data/test/exception_notification/rack_test.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require 'test_helper'
+require "test_helper"
 
 class RackTest < ActiveSupport::TestCase
   setup do
     @pass_app = Object.new
-    @pass_app.stubs(:call).returns([nil, { 'X-Cascade' => 'pass' }, nil])
+    @pass_app.stubs(:call).returns([nil, {"X-Cascade" => "pass"}, nil])
 
     @normal_app = Object.new
     @normal_app.stubs(:call).returns([nil, {}, nil])
@@ -25,41 +25,41 @@ class RackTest < ActiveSupport::TestCase
     ExceptionNotification::Rack.new(@pass_app, ignore_cascade_pass: false).call({})
   end
 
-  test 'should assign error_grouping if error_grouping is specified' do
+  test "should assign error_grouping if error_grouping is specified" do
     refute ExceptionNotifier.error_grouping
     ExceptionNotification::Rack.new(@normal_app, error_grouping: true).call({})
     assert ExceptionNotifier.error_grouping
   end
 
-  test 'should assign notification_trigger if notification_trigger is specified' do
+  test "should assign notification_trigger if notification_trigger is specified" do
     assert_nil ExceptionNotifier.notification_trigger
     ExceptionNotification::Rack.new(@normal_app, notification_trigger: ->(_i) { true }).call({})
     assert_respond_to ExceptionNotifier.notification_trigger, :call
   end
 
   if defined?(Rails) && Rails.respond_to?(:cache)
-    test 'should set default cache to Rails cache' do
+    test "should set default cache to Rails cache" do
       ExceptionNotification::Rack.new(@normal_app, error_grouping: true).call({})
       assert_equal Rails.cache, ExceptionNotifier.error_grouping_cache
     end
   end
 
-  test 'should ignore exceptions with Usar Agent in ignore_crawlers' do
+  test "should ignore exceptions with Usar Agent in ignore_crawlers" do
     exception_app = Object.new
     exception_app.stubs(:call).raises(RuntimeError)
 
-    env = { 'HTTP_USER_AGENT' => 'Mozilla/5.0 (compatible; Crawlerbot/2.1;)' }
+    env = {"HTTP_USER_AGENT" => "Mozilla/5.0 (compatible; Crawlerbot/2.1;)"}
 
     begin
       ExceptionNotification::Rack.new(exception_app, ignore_crawlers: %w[Crawlerbot]).call(env)
 
       flunk
-    rescue StandardError
-      refute env['exception_notifier.delivered']
+    rescue
+      refute env["exception_notifier.delivered"]
     end
   end
 
-  test 'should ignore exceptions if ignore_if condition is met' do
+  test "should ignore exceptions if ignore_if condition is met" do
     exception_app = Object.new
     exception_app.stubs(:call).raises(RuntimeError)
 
@@ -72,12 +72,12 @@ class RackTest < ActiveSupport::TestCase
       ).call(env)
 
       flunk
-    rescue StandardError
-      refute env['exception_notifier.delivered']
+    rescue
+      refute env["exception_notifier.delivered"]
     end
   end
 
-  test 'should ignore exceptions with notifiers that satisfies ignore_notifier_if condition' do
+  test "should ignore exceptions with notifiers that satisfies ignore_notifier_if condition" do
     exception_app = Object.new
     exception_app.stubs(:call).raises(RuntimeError)
 
@@ -98,7 +98,7 @@ class RackTest < ActiveSupport::TestCase
       ).call(env)
 
       flunk
-    rescue StandardError
+    rescue
       refute notifier1_called
       assert notifier2_called
     end

data/test/exception_notification/rake_test.rb

@@ -1,33 +1,33 @@
 # frozen_string_literal: true
 
-require 'test_helper'
+require "test_helper"
 
-require 'rake'
-require 'exception_notification/rake'
+require "rake"
+require "exception_notification/rake"
 
 class RakeTest < ActiveSupport::TestCase
   setup do
     Rake::Task.define_task :dependency_1 do
-      puts :dependency_1
+      nil # noop but could puts for debugging
     end
     Rake::Task.define_task raise_exception: :dependency_1 do
-      raise 'test exception'
+      raise "test exception"
     end
     @task = Rake::Task[:raise_exception]
   end
 
-  test 'notifies of exception' do
+  test "notifies of exception" do
     ExceptionNotifier.expects(:notify_exception).with do |ex, opts|
       data = opts[:data]
       ex.is_a?(RuntimeError) &&
-        ex.message == 'test exception' &&
-        data[:error_class] == 'RuntimeError' &&
-        data[:error_message] == 'test exception' &&
-        data[:rake][:rake_command_line] == 'rake ' &&
-        data[:rake][:name] == 'raise_exception' &&
+        ex.message == "test exception" &&
+        data[:error_class] == "RuntimeError" &&
+        data[:error_message] == "test exception" &&
+        data[:rake][:rake_command_line] == "rake " &&
+        data[:rake][:name] == "raise_exception" &&
         data[:rake][:timestamp] &&
-        data[:rake][:sources] == ['dependency_1'] &&
-        data[:rake][:prerequisite_tasks][0][:name] == 'dependency_1'
+        data[:rake][:sources] == ["dependency_1"] &&
+        data[:rake][:prerequisite_tasks][0][:name] == "dependency_1"
     end
 
     # The original error is re-raised

data/test/exception_notification/resque_test.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require 'test_helper'
+require "test_helper"
 
-require 'exception_notification/resque'
-require 'resque'
-require 'mock_redis'
-require 'resque/failure/multiple'
-require 'resque/failure/redis'
+require "exception_notification/resque"
+require "resque"
+require "mock_redis"
+require "resque/failure/multiple"
+require "resque/failure/redis"
 
 class ResqueTest < ActiveSupport::TestCase
   setup do
@@ -21,22 +21,22 @@ class ResqueTest < ActiveSupport::TestCase
     @worker.cant_fork = true
   end
 
-  test 'count returns the number of failures' do
+  test "count returns the number of failures" do
     Resque::Job.create(:jobs, BadJob)
     @worker.work(0)
     assert_equal 1, ExceptionNotification::Resque.count
   end
 
-  test 'notifies exception when job fails' do
+  test "notifies exception when job fails" do
     ExceptionNotifier.expects(:notify_exception).with do |ex, opts|
       ex.is_a?(RuntimeError) &&
-        ex.message == 'Bad job!' &&
-        opts[:data][:resque][:error_class] == 'RuntimeError' &&
-        opts[:data][:resque][:error_message] == 'Bad job!' &&
+        ex.message == "Bad job!" &&
+        opts[:data][:resque][:error_class] == "RuntimeError" &&
+        opts[:data][:resque][:error_message] == "Bad job!" &&
         opts[:data][:resque][:failed_at].present? &&
         opts[:data][:resque][:payload] == {
-          'class' => 'ResqueTest::BadJob',
-          'args' => []
+          "class" => "ResqueTest::BadJob",
+          "args" => []
         } &&
         opts[:data][:resque][:queue] == :jobs &&
         opts[:data][:resque][:worker].present?
@@ -48,7 +48,7 @@ class ResqueTest < ActiveSupport::TestCase
 
   class BadJob
     def self.perform
-      raise 'Bad job!'
+      raise "Bad job!"
     end
   end
 end

data/test/exception_notifier/datadog_notifier_test.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'test_helper'
-require 'dogapi/common'
-require 'dogapi/event'
+require "test_helper"
+require "dogapi/common"
+require "dogapi/event"
 
 class DatadogNotifierTest < ActiveSupport::TestCase
   def setup
@@ -16,7 +16,7 @@ class DatadogNotifierTest < ActiveSupport::TestCase
     @request = FakeRequest.new
   end
 
-  test 'should send an event to datadog' do
+  test "should send an event to datadog" do
     fake_event = Dogapi::Event.any_instance
     @client.expects(:emit_event).with(fake_event)
 
@@ -24,15 +24,15 @@ class DatadogNotifierTest < ActiveSupport::TestCase
     @notifier.call(@exception)
   end
 
-  test 'should include exception class in event title' do
+  test "should include exception class in event title" do
     event = @notifier.datadog_event(@exception)
-    assert_includes event.msg_title, 'FakeException'
+    assert_includes event.msg_title, "FakeException"
   end
 
-  test 'should include prefix in event title and not append previous events' do
+  test "should include prefix in event title and not append previous events" do
     options = {
       client: @client,
-      title_prefix: 'prefix'
+      title_prefix: "prefix"
     }
 
     notifier = ExceptionNotifier::DatadogNotifier.new(options)
@@ -43,43 +43,43 @@ class DatadogNotifierTest < ActiveSupport::TestCase
     assert_equal event2.msg_title, 'prefix (DatadogNotifierTest::FakeException) "Fake exception message"'
   end
 
-  test 'should include exception message in event title' do
+  test "should include exception message in event title" do
     event = @notifier.datadog_event(@exception)
-    assert_includes event.msg_title, 'Fake exception message'
+    assert_includes event.msg_title, "Fake exception message"
   end
 
-  test 'should include controller info in event title if controller information is available' do
+  test "should include controller info in event title if controller information is available" do
     event = @notifier.datadog_event(@exception,
-                                    env: {
-                                      'action_controller.instance' => @controller,
-                                      'REQUEST_METHOD' => 'GET',
-                                      'rack.input' => ''
-                                    })
-    assert_includes event.msg_title, 'Fake controller'
-    assert_includes event.msg_title, 'Fake action'
+      env: {
+        "action_controller.instance" => @controller,
+        "REQUEST_METHOD" => "GET",
+        "rack.input" => ""
+      })
+    assert_includes event.msg_title, "Fake controller"
+    assert_includes event.msg_title, "Fake action"
   end
 
-  test 'should include backtrace info in event body' do
+  test "should include backtrace info in event body" do
     event = @notifier.datadog_event(@exception)
     assert_includes event.msg_text, "backtrace line 1\nbacktrace line 2\nbacktrace line 3"
   end
 
-  test 'should include request info in event body' do
+  test "should include request info in event body" do
     ActionDispatch::Request.stubs(:new).returns(@request)
 
     event = @notifier.datadog_event(@exception,
-                                    env: {
-                                      'action_controller.instance' => @controller,
-                                      'REQUEST_METHOD' => 'GET',
-                                      'rack.input' => ''
-                                    })
-    assert_includes event.msg_text, 'http://localhost:8080'
-    assert_includes event.msg_text, 'GET'
-    assert_includes event.msg_text, '127.0.0.1'
-    assert_includes event.msg_text, '{"param 1"=>"value 1", "param 2"=>"value 2"}'
+      env: {
+        "action_controller.instance" => @controller,
+        "REQUEST_METHOD" => "GET",
+        "rack.input" => ""
+      })
+    assert_includes event.msg_text, "http://localhost:8080"
+    assert_includes event.msg_text, "GET"
+    assert_includes event.msg_text, "127.0.0.1"
+    assert_includes event.msg_text, {"param 1" => "value 1", "param 2" => "value 2"}.to_s
   end
 
-  test 'should include tags in event' do
+  test "should include tags in event" do
     options = {
       client: @client,
       tags: %w[error production]
@@ -89,64 +89,65 @@ class DatadogNotifierTest < ActiveSupport::TestCase
     assert_equal event.tags, %w[error production]
   end
 
-  test 'should include event title in event aggregation key' do
+  test "should include event title in event aggregation key" do
     event = @notifier.datadog_event(@exception)
     assert_equal event.aggregation_key, [event.msg_title]
   end
 
   class FakeDatadogClient
-    def emit_event(event); end
+    def emit_event(event)
+    end
   end
 
   class FakeController
     def controller_name
-      'Fake controller'
+      "Fake controller"
     end
 
     def action_name
-      'Fake action'
+      "Fake action"
     end
   end
 
   class FakeException
     def backtrace
       [
-        'backtrace line 1',
-        'backtrace line 2',
-        'backtrace line 3',
-        'backtrace line 4',
-        'backtrace line 5'
+        "backtrace line 1",
+        "backtrace line 2",
+        "backtrace line 3",
+        "backtrace line 4",
+        "backtrace line 5"
       ]
     end
 
     def message
-      'Fake exception message'
+      "Fake exception message"
     end
   end
 
   class FakeRequest
     def url
-      'http://localhost:8080'
+      "http://localhost:8080"
     end
 
     def request_method
-      'GET'
+      "GET"
     end
 
     def remote_ip
-      '127.0.0.1'
+      "127.0.0.1"
     end
 
     def filtered_parameters
       {
-        'param 1' => 'value 1',
-        'param 2' => 'value 2'
+        "param 1" => "value 1",
+        "param 2" => "value 2"
       }
     end
 
     def session
       {
-        'session_id' => '1234'
+        "session_id" => "1234"
       }
     end
   end