exception_notification 3.0.1 → 4.4.0

data/lib/exception_notifier/views/exception_notifier/exception_notification.text.erb

@@ -8,18 +8,17 @@
       begin
         summary = render(section).strip
         unless summary.blank?
-          title = render("title", :title => section).strip
+          title = render("title", title: section).strip
           "#{title}\n\n#{summary.gsub(/^/, "  ")}\n\n"
         end
 
       rescue Exception => e
-        title = render("title", :title => section).strip
+        title = render("title", title: section).strip
         summary = ["ERROR: Failed to generate exception summary:", [e.class.to_s, e.message].join(": "), e.backtrace && e.backtrace.join("\n")].compact.join("\n\n")
 
         [title, summary.gsub(/^/, "  "), nil].join("\n\n")
       end
     end.join
-    sections = sections.force_encoding('UTF-8').encode('UTF-16LE', :invalid => :replace).encode('UTF-8') if sections.respond_to?(:force_encoding)
 %>
 
 <%= raw sections %>

data/lib/exception_notifier/webhook_notifier.rb

@@ -0,0 +1,51 @@
+require 'action_dispatch'
+require 'active_support/core_ext/time'
+
+module ExceptionNotifier
+  class WebhookNotifier < BaseNotifier
+    def initialize(options)
+      super
+      @default_options = options
+    end
+
+    def call(exception, options = {})
+      env = options[:env]
+
+      options = options.reverse_merge(@default_options)
+      url = options.delete(:url)
+      http_method = options.delete(:http_method) || :post
+
+      options[:body] ||= {}
+      options[:body][:server] = Socket.gethostname
+      options[:body][:process] = $PROCESS_ID
+      if defined?(Rails) && Rails.respond_to?(:root)
+        options[:body][:rails_root] = Rails.root
+      end
+      options[:body][:exception] = {
+        error_class: exception.class.to_s,
+        message: exception.message.inspect,
+        backtrace: exception.backtrace
+      }
+      options[:body][:data] = (env && env['exception_notifier.exception_data'] || {}).merge(options[:data] || {})
+
+      unless env.nil?
+        request = ActionDispatch::Request.new(env)
+
+        request_items = {
+          url: request.original_url,
+          http_method: request.method,
+          ip_address: request.remote_ip,
+          parameters: request.filtered_parameters,
+          timestamp: Time.current
+        }
+
+        options[:body][:request] = request_items
+        options[:body][:session] = request.session
+        options[:body][:environment] = request.filtered_env
+      end
+      send_notice(exception, options, nil, @default_options) do |_, _|
+        HTTParty.send(http_method, url, options)
+      end
+    end
+  end
+end

data/lib/generators/exception_notification/install_generator.rb

@@ -0,0 +1,15 @@
+module ExceptionNotification
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc 'Creates a ExceptionNotification initializer.'
+
+      source_root File.expand_path('templates', __dir__)
+      class_option :resque, type: :boolean, desc: 'Add support for sending notifications when errors occur in Resque jobs.'
+      class_option :sidekiq, type: :boolean, desc: 'Add support for sending notifications when errors occur in Sidekiq jobs.'
+
+      def copy_initializer
+        template 'exception_notification.rb.erb', 'config/initializers/exception_notification.rb'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+require 'exception_notification/rails'
+<% if options.sidekiq? %>
+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 %>
+
+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}
+
+  # 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.
+  # config.ignore_if do |exception, options|
+  #   not Rails.env.production?
+  # end
+
+  # Ignore exceptions generated by crawlers
+  # 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}
+  }
+
+  # 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'
+  # }
+
+  # HipChat notifier sends notifications to your HipChat room. Requires 'hipchat' gem.
+  # config.add_notifier :hipchat, {
+  #   api_token: 'my_token',
+  #   room_name: 'my_room'
+  # }
+
+  # Webhook notifier sends notifications over HTTP protocol. Requires 'httparty' gem.
+  # config.add_notifier :webhook, {
+  #   url: 'http://example.com:5555/hubot/path',
+  #   http_method: :post
+  # }
+end

data/test/exception_notification/rack_test.rb

@@ -0,0 +1,60 @@
+require 'test_helper'
+
+class RackTest < ActiveSupport::TestCase
+  setup do
+    @pass_app = Object.new
+    @pass_app.stubs(:call).returns([nil, { 'X-Cascade' => 'pass' }, nil])
+
+    @normal_app = Object.new
+    @normal_app.stubs(:call).returns([nil, {}, nil])
+  end
+
+  teardown do
+    ExceptionNotifier.error_grouping = false
+    ExceptionNotifier.notification_trigger = nil
+  end
+
+  test 'should ignore "X-Cascade" header by default' do
+    ExceptionNotifier.expects(:notify_exception).never
+    ExceptionNotification::Rack.new(@pass_app).call({})
+  end
+
+  test 'should notify on "X-Cascade" = "pass" if ignore_cascade_pass option is false' do
+    ExceptionNotifier.expects(:notify_exception).once
+    ExceptionNotification::Rack.new(@pass_app, ignore_cascade_pass: false).call({})
+  end
+
+  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
+    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
+      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
+    exception_app = Object.new
+    exception_app.stubs(:call).raises(RuntimeError)
+
+    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']
+    end
+  end
+end

data/test/exception_notification/resque_test.rb

@@ -0,0 +1,52 @@
+require 'test_helper'
+
+require 'exception_notification/resque'
+require 'resque'
+require 'mock_redis'
+require 'resque/failure/multiple'
+require 'resque/failure/redis'
+
+class ResqueTest < ActiveSupport::TestCase
+  setup do
+    # Resque.redis=() only supports a String or Redis instance in Resque 1.8
+    Resque.instance_variable_set(:@redis, MockRedis.new)
+
+    Resque::Failure::Multiple.classes = [Resque::Failure::Redis, ExceptionNotification::Resque]
+    Resque::Failure.backend = Resque::Failure::Multiple
+
+    @worker = Resque::Worker.new(:jobs)
+    # Forking causes issues with Mocha's `.expects`
+    @worker.cant_fork = true
+  end
+
+  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
+    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!' &&
+        opts[:data][:resque][:failed_at].present? &&
+        opts[:data][:resque][:payload] == {
+          'class' => 'ResqueTest::BadJob',
+          'args' => []
+        } &&
+        opts[:data][:resque][:queue] == :jobs &&
+        opts[:data][:resque][:worker].present?
+    end
+
+    Resque::Job.create(:jobs, BadJob)
+    @worker.work(0)
+  end
+
+  class BadJob
+    def self.perform
+      raise 'Bad job!'
+    end
+  end
+end

data/test/exception_notifier/campfire_notifier_test.rb

@@ -0,0 +1,120 @@
+require 'test_helper'
+
+# silence_warnings trick around require can be removed once
+# https://github.com/collectiveidea/tinder/pull/77
+# gets merged and released
+silence_warnings do
+  require 'tinder'
+end
+
+class CampfireNotifierTest < ActiveSupport::TestCase
+  test 'should send campfire notification if properly configured' do
+    ExceptionNotifier::CampfireNotifier.stubs(:new).returns(Object.new)
+    campfire = ExceptionNotifier::CampfireNotifier.new(subdomain: 'test', token: 'test_token', room_name: 'test_room')
+    campfire.stubs(:call).returns(fake_notification)
+    notif = campfire.call(fake_exception)
+
+    assert !notif[:message].empty?
+    assert_equal notif[:message][:type], 'PasteMessage'
+    assert_includes notif[:message][:body], 'A new exception occurred:'
+    assert_includes notif[:message][:body], 'divided by 0'
+    assert_includes notif[:message][:body], '/exception_notification/test/campfire_test.rb:45'
+  end
+
+  test 'should send campfire notification without backtrace info if properly configured' do
+    ExceptionNotifier::CampfireNotifier.stubs(:new).returns(Object.new)
+    campfire = ExceptionNotifier::CampfireNotifier.new(subdomain: 'test', token: 'test_token', room_name: 'test_room')
+    campfire.stubs(:call).returns(fake_notification_without_backtrace)
+    notif = campfire.call(fake_exception_without_backtrace)
+
+    assert !notif[:message].empty?
+    assert_equal notif[:message][:type], 'PasteMessage'
+    assert_includes notif[:message][:body], 'A new exception occurred:'
+    assert_includes notif[:message][:body], 'my custom error'
+  end
+
+  test 'should not send campfire notification if badly configured' do
+    wrong_params = { subdomain: 'test', token: 'bad_token', room_name: 'test_room' }
+    Tinder::Campfire.stubs(:new).with('test', token: 'bad_token').returns(nil)
+    campfire = ExceptionNotifier::CampfireNotifier.new(wrong_params)
+
+    assert_nil campfire.room
+    assert_nil campfire.call(fake_exception)
+  end
+
+  test 'should not send campfire notification if config attr missing' do
+    wrong_params = { subdomain: 'test', room_name: 'test_room' }
+    Tinder::Campfire.stubs(:new).with('test', {}).returns(nil)
+    campfire = ExceptionNotifier::CampfireNotifier.new(wrong_params)
+
+    assert_nil campfire.room
+    assert_nil campfire.call(fake_exception)
+  end
+
+  test 'should send the new exception message if no :accumulated_errors_count option' do
+    campfire = ExceptionNotifier::CampfireNotifier.new({})
+    campfire.stubs(:active?).returns(true)
+    campfire.expects(:send_notice).with { |_, _, message| message.start_with?('A new exception occurred') }.once
+    campfire.call(fake_exception)
+  end
+
+  test 'shoud send the exception message if :accumulated_errors_count option greater than 1' do
+    campfire = ExceptionNotifier::CampfireNotifier.new({})
+    campfire.stubs(:active?).returns(true)
+    campfire.expects(:send_notice).with { |_, _, message| message.start_with?('The exception occurred 3 times:') }.once
+    campfire.call(fake_exception, accumulated_errors_count: 3)
+  end
+
+  test 'should call pre/post_callback if specified' do
+    pre_callback_called = 0
+    post_callback_called = 0
+    Tinder::Campfire.stubs(:new).returns(Object.new)
+
+    campfire = ExceptionNotifier::CampfireNotifier.new(
+      subdomain: 'test',
+      token: 'test_token',
+      room_name: 'test_room',
+      pre_callback: proc { |_opts, _notifier, _backtrace, _message, _message_opts|
+        pre_callback_called += 1
+      },
+      post_callback: proc { |_opts, _notifier, _backtrace, _message, _message_opts|
+        post_callback_called += 1
+      }
+    )
+    campfire.room = Object.new
+    campfire.room.stubs(:paste).returns(fake_notification)
+    campfire.call(fake_exception)
+    assert_equal(1, pre_callback_called)
+    assert_equal(1, post_callback_called)
+  end
+
+  private
+
+  def fake_notification
+    {
+      message: {
+        type: 'PasteMessage',
+        body: "A new exception occurred: 'divided by 0' on '/Users/sebastian/exception_notification/test/campfire_test.rb:45:in `/'"
+      }
+    }
+  end
+
+  def fake_exception
+    5 / 0
+  rescue StandardError => e
+    e
+  end
+
+  def fake_notification_without_backtrace
+    {
+      message: {
+        type: 'PasteMessage',
+        body: "A new exception occurred: 'my custom error'"
+      }
+    }
+  end
+
+  def fake_exception_without_backtrace
+    StandardError.new('my custom error')
+  end
+end

data/test/exception_notifier/datadog_notifier_test.rb

@@ -0,0 +1,151 @@
+require 'test_helper'
+require 'dogapi/common'
+require 'dogapi/event'
+
+class DatadogNotifierTest < ActiveSupport::TestCase
+  def setup
+    @client = FakeDatadogClient.new
+    @options = {
+      client: @client
+    }
+    @notifier = ExceptionNotifier::DatadogNotifier.new(@options)
+    @exception = FakeException.new
+    @controller = FakeController.new
+    @request = FakeRequest.new
+  end
+
+  test 'should send an event to datadog' do
+    fake_event = Dogapi::Event.any_instance
+    @client.expects(:emit_event).with(fake_event)
+
+    @notifier.stubs(:datadog_event).returns(fake_event)
+    @notifier.call(@exception)
+  end
+
+  test 'should include exception class in event title' do
+    event = @notifier.datadog_event(@exception)
+    assert_includes event.msg_title, 'FakeException'
+  end
+
+  test 'should include prefix in event title and not append previous events' do
+    options = {
+      client: @client,
+      title_prefix: 'prefix'
+    }
+
+    notifier = ExceptionNotifier::DatadogNotifier.new(options)
+    event = notifier.datadog_event(@exception)
+    assert_equal event.msg_title, 'prefix (DatadogNotifierTest::FakeException) "Fake exception message"'
+
+    event2 = notifier.datadog_event(@exception)
+    assert_equal event2.msg_title, 'prefix (DatadogNotifierTest::FakeException) "Fake exception message"'
+  end
+
+  test 'should include exception message in event title' do
+    event = @notifier.datadog_event(@exception)
+    assert_includes event.msg_title, 'Fake exception message'
+  end
+
+  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'
+  end
+
+  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
+    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"}'
+  end
+
+  test 'should include tags in event' do
+    options = {
+      client: @client,
+      tags: %w[error production]
+    }
+    notifier = ExceptionNotifier::DatadogNotifier.new(options)
+    event = notifier.datadog_event(@exception)
+    assert_equal event.tags, %w[error production]
+  end
+
+  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
+  end
+
+  class FakeController
+    def controller_name
+      'Fake controller'
+    end
+
+    def action_name
+      'Fake action'
+    end
+  end
+
+  class FakeException
+    def backtrace
+      [
+        'backtrace line 1',
+        'backtrace line 2',
+        'backtrace line 3',
+        'backtrace line 4',
+        'backtrace line 5'
+      ]
+    end
+
+    def message
+      'Fake exception message'
+    end
+  end
+
+  class FakeRequest
+    def url
+      'http://localhost:8080'
+    end
+
+    def request_method
+      'GET'
+    end
+
+    def remote_ip
+      '127.0.0.1'
+    end
+
+    def filtered_parameters
+      {
+        'param 1' => 'value 1',
+        'param 2' => 'value 2'
+      }
+    end
+
+    def session
+      {
+        'session_id' => '1234'
+      }
+    end
+  end
+end