exception_notification 4.2.0 → 4.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 96b7601841d70bce96aac4688ff838b6547413e3
-  data.tar.gz: f1d812c03809294aabec50f4c22b5d8d56403bcb
+  metadata.gz: 6de21b765af1465df6205f174cbab7e10b403048
+  data.tar.gz: cade5525679b528aded7b1ad6369e97f40b58947
 SHA512:
-  metadata.gz: 07b9e4c6337d2edde00e095780487a1fe3eda8f391c327d9d2b1ad815aa2a595b9804d0890c1c6338cf015e42b70af1ad8fe7db6ecb1d2769b567af17a7214da
-  data.tar.gz: e4bf5df059d85c029acb2cac6160218a5e9c822886b17884deed3b1f186b85a40a536b26c516dc546fc4ca1500daf8260e34e7959656c728cf03ad69814f2a7c
+  metadata.gz: fe4b7770171a25a7e131d97c922e5c518531f71add293ce42359eb9f2fc84ea7330f2f935657cbf4dc13fa4a8ba2d3d492397469555d665d12d36c52603a82fd
+  data.tar.gz: 92774d00ec26d97246ca9d4e6334f3aac06f04c5242a555eb3a5bd5addfd8a8485bdd72787b0d304146c50e79a7ff4500aaf2a08aca744be963f3a779221b193

data/CHANGELOG.rdoc

@@ -1,3 +1,13 @@
+== 4.2.1
+
+* enhancements
+  * Allow customizable backtrace for Slack (by @aried3r)
+  * Add `Mongoid::Errors::DocumentNotFound` to ignored_exceptions (by @nazarok)
+  * Improved text in Slack notifier (by @vojtad)
+
+* bug fixes
+  * Fix data being sent on webhook notifier
+
 == 4.2.0
 
 * enhancements

data/README.md

@@ -823,7 +823,7 @@ You can choose to ignore certain exceptions, which will make ExceptionNotificati
 
 ### :ignore_exceptions
 
-*Array of strings, default: %w{ActiveRecord::RecordNotFound AbstractController::ActionNotFound ActionController::RoutingError ActionController::UnknownFormat}*
+*Array of strings, default: %w{ActiveRecord::RecordNotFound Mongoid::Errors::DocumentNotFound AbstractController::ActionNotFound ActionController::RoutingError ActionController::UnknownFormat}*
 
 Ignore specified exception types. To achieve that, you should use the `:ignore_exceptions` option, like this:
 
@@ -950,21 +950,13 @@ As above, make sure the gem is not listed solely under the `production` group, s
 
 ## Versions
 
-For v4.0.1, see this tag:
+For v4.2.1, see this tag:
 
-http://github.com/smartinez87/exception_notification/tree/v4.0.1
+http://github.com/smartinez87/exception_notification/tree/v4.2.1
 
-For v4.0.0, see this tag:
+For v4.2.0, see this tag:
 
-http://github.com/smartinez87/exception_notification/tree/v4.0.0
-
-For v3.0.1, see this tag:
-
-http://github.com/smartinez87/exception_notification/tree/v3.0.1
-
-For v3.0.0, see this tag:
-
-http://github.com/smartinez87/exception_notification/tree/v3.0.0
+http://github.com/smartinez87/exception_notification/tree/v4.2.0
 
 For previous releases, visit:
 

data/exception_notification.gemspec

@@ -1,8 +1,8 @@
 Gem::Specification.new do |s|
   s.name = 'exception_notification'
-  s.version = '4.2.0'
+  s.version = '4.2.1'
   s.authors = ["Jamis Buck", "Josh Peek"]
-  s.date = %q{2016-07-12}
+  s.date = %q{2016-07-17}
   s.summary = "Exception notification for Rails apps"
   s.homepage = "https://smartinez87.github.io/exception_notification/"
   s.email = "smartinez87@gmail.com"

data/lib/exception_notification/rack.rb

@@ -9,22 +9,22 @@ module ExceptionNotification
 
       if options.key?(:ignore_if)
         rack_ignore = options.delete(:ignore_if)
-        ExceptionNotifier.ignore_if do |exception, options|
-          options.key?(:env) && rack_ignore.call(options[:env], exception)
+        ExceptionNotifier.ignore_if do |exception, opts|
+          opts.key?(:env) && rack_ignore.call(opts[:env], exception)
         end
       end
 
       if options.key?(:ignore_crawlers)
         ignore_crawlers = options.delete(:ignore_crawlers)
-        ExceptionNotifier.ignore_if do |exception, options|
-          options.key?(:env) && from_crawler(options[:env], ignore_crawlers)
+        ExceptionNotifier.ignore_if do |exception, opts|
+          opts.key?(:env) && from_crawler(opts[:env], ignore_crawlers)
         end
       end
 
       @ignore_cascade_pass = options.delete(:ignore_cascade_pass) { true }
 
-      options.each do |notifier_name, options|
-        ExceptionNotifier.register_exception_notifier(notifier_name, options)
+      options.each do |notifier_name, opts|
+        ExceptionNotifier.register_exception_notifier(notifier_name, opts)
       end
     end
 

data/lib/exception_notifier.rb

@@ -24,7 +24,7 @@ module ExceptionNotifier
 
   # Define a set of exceptions to be ignored, ie, dont send notifications when any of them are raised.
   mattr_accessor :ignored_exceptions
-  @@ignored_exceptions = %w{ActiveRecord::RecordNotFound AbstractController::ActionNotFound ActionController::RoutingError ActionController::UnknownFormat ActionController::UrlGenerationError}
+  @@ignored_exceptions = %w{ActiveRecord::RecordNotFound Mongoid::Errors::DocumentNotFound AbstractController::ActionNotFound ActionController::RoutingError ActionController::UnknownFormat ActionController::UrlGenerationError}
 
   mattr_accessor :testing_mode
   @@testing_mode = false

data/lib/exception_notifier/slack_notifier.rb

@@ -8,6 +8,7 @@ module ExceptionNotifier
       super
       begin
         @ignore_data_if = options[:ignore_data_if]
+        @backtrace_lines = options[:backtrace_lines]
 
         webhook_url = options.fetch(:webhook_url)
         @message_opts = options.fetch(:additional_parameters, {})
@@ -18,10 +19,21 @@ module ExceptionNotifier
     end
 
     def call(exception, options={})
-      env = options[:env] || {}
-      title = "#{env['REQUEST_METHOD']} <#{env['REQUEST_URI']}>"
-      data = (env['exception_notifier.exception_data'] || {}).merge(options[:data] || {})
-      text = "*An exception occurred while doing*: `#{title}`\n"
+      exception_name = "*#{exception.class.to_s =~ /^[aeiou]/i ? 'An' : 'A'}* `#{exception.class.to_s}`"
+
+      if options[:env].nil?
+        data = options[:data] || {}
+        text = "#{exception_name} *occured in background*\n"
+      else
+        env = options[:env]
+        data = (env['exception_notifier.exception_data'] || {}).merge(options[:data] || {})
+
+        kontroller = env['action_controller.instance']
+        request = "#{env['REQUEST_METHOD']} <#{env['REQUEST_URI']}>"
+        text = "#{exception_name} *occurred while* `#{env['REQUEST_METHOD']} <#{env['REQUEST_URI']}>`"
+        text += " *was processed by* `#{kontroller.controller_name}##{kontroller.action_name}`" if kontroller
+        text += "\n"
+      end
 
       clean_message = exception.message.gsub("`", "'")
       fields = [ { title: 'Exception', value: clean_message} ]
@@ -29,7 +41,7 @@ module ExceptionNotifier
       fields.push({ title: 'Hostname', value: Socket.gethostname })
 
       if exception.backtrace
-        formatted_backtrace = "```#{exception.backtrace.join("\n")}```"
+        formatted_backtrace = @backtrace_lines ? "```#{exception.backtrace.first(@backtrace_lines).join("\n")}```" : "```#{exception.backtrace.join("\n")}```"
         fields.push({ title: 'Backtrace', value: formatted_backtrace })
       end
 

data/lib/exception_notifier/webhook_notifier.rb

@@ -40,8 +40,8 @@ module ExceptionNotifier
         options[:body][:session] = request.session
         options[:body][:environment] = request.filtered_env
       end
-      send_notice(exception, options, nil, @default_options) do |msg, opts|
-        HTTParty.send(http_method, url, opts)
+      send_notice(exception, options, nil, @default_options) do |_, _|
+        HTTParty.send(http_method, url, options)
       end
     end
   end

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

@@ -13,7 +13,7 @@ Resque::Failure.backend = Resque::Failure::Multiple
 
 ExceptionNotification.configure do |config|
   # Ignore additional exception types.
-  # ActiveRecord::RecordNotFound, AbstractController::ActionNotFound and ActionController::RoutingError are already added.
+  # 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.

data/test/dummy/config/boot.rb

@@ -3,4 +3,4 @@ require 'rubygems'
 # Set up gems listed in the Gemfile.
 ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
 
-require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])

data/test/dummy/config/environments/test.rb

@@ -8,9 +8,6 @@ Dummy::Application.configure do
   # and recreated between test runs.  Don't rely on the data there!
   config.cache_classes = true
 
-  # Log error messages when you accidentally call methods on nil.
-  config.whiny_nils = true
-
   # Show full error reports and disable caching
   config.consider_all_requests_local       = true
   config.action_controller.perform_caching = false

data/test/exception_notifier/campfire_notifier_test.rb

@@ -1,5 +1,11 @@
 require 'test_helper'
-require 'tinder'
+
+# 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
 
@@ -80,7 +86,7 @@ class CampfireNotifierTest < ActiveSupport::TestCase
   end
 
   def fake_exception
-    exception = begin
+    begin
       5/0
     rescue Exception => e
       e

data/test/exception_notifier/email_notifier_test.rb

@@ -101,7 +101,7 @@ class EmailNotifierTest < ActiveSupport::TestCase
   end
 
   test "mail should have a descriptive subject" do
-    assert_match /^\[Dummy ERROR\]\s+\(ZeroDivisionError\) "divided by 0"$/, @mail.subject
+    assert_match(/^\[Dummy ERROR\]\s+\(ZeroDivisionError\) "divided by 0"$/, @mail.subject)
   end
 
   test "mail should say exception was raised in background at show timestamp" do
@@ -165,7 +165,7 @@ class EmailNotifierTest < ActiveSupport::TestCase
       :email_format => :text
     )
 
-    assert_match /invalid_encoding\s+: R__sum__/, mail.encoded
+    assert_match(/invalid_encoding\s+: R__sum__/, mail.encoded)
   end
 
   test "should send email using ActionMailer" do

data/test/exception_notifier/hipchat_notifier_test.rb

@@ -1,5 +1,11 @@
 require 'test_helper'
-require 'hipchat'
+
+# silence_warnings trick around require can be removed once
+# https://github.com/hipchat/hipchat-rb/pull/174
+# gets merged and released
+silence_warnings do
+  require 'hipchat'
+end
 
 class HipchatNotifierTest < ActiveSupport::TestCase
 
@@ -152,7 +158,7 @@ class HipchatNotifierTest < ActiveSupport::TestCase
   end
 
   def fake_exception
-    exception = begin
+    begin
       5/0
     rescue Exception => e
       e
@@ -160,7 +166,7 @@ class HipchatNotifierTest < ActiveSupport::TestCase
   end
 
   def fake_exception_with_html_characters
-    exception = begin
+    begin
       raise StandardError.new('an error with <html> characters')
     rescue Exception => e
       e

data/test/exception_notifier/irc_notifier_test.rb

@@ -108,7 +108,7 @@ class IrcNotifierTest < ActiveSupport::TestCase
   private
 
   def fake_exception
-    exception = begin
+    begin
       5/0
     rescue Exception => e
       e

data/test/exception_notifier/sidekiq_test.rb

@@ -12,6 +12,13 @@ class MockSidekiqServer
 end
 
 class SidekiqTest < ActiveSupport::TestCase
+  setup do
+    @_original_sidekiq_logger = Sidekiq::Logging.logger
+
+    # Silence sidekiq warning to stdout
+    Sidekiq::Logging.logger = nil
+  end
+
   test "should call notify_exception when sidekiq raises an error" do
     server = MockSidekiqServer.new
     message = Hash.new
@@ -24,4 +31,8 @@ class SidekiqTest < ActiveSupport::TestCase
 
     server.handle_exception(exception, message)
   end
+
+  teardown do
+    Sidekiq::Logging.logger = @_original_sidekiq_logger
+  end
 end

data/test/exception_notifier/slack_notifier_test.rb

@@ -60,6 +60,18 @@ class SlackNotifierTest < ActiveSupport::TestCase
     assert_equal slack_notifier.notifier.username, options[:username]
   end
 
+  test "should send the notification with specific backtrace lines" do
+    options = {
+      webhook_url: "http://slack.webhook.url",
+      backtrace_lines: 1
+    }
+
+    Slack::Notifier.any_instance.expects(:ping).with('', fake_notification(@exception, {}, nil, 1))
+
+    slack_notifier = ExceptionNotifier::SlackNotifier.new(options)
+    slack_notifier.call(@exception)
+  end
+
   test "should pass the additional parameters to Slack::Notifier.ping" do
     options = {
       webhook_url: "http://slack.webhook.url",
@@ -106,7 +118,7 @@ class SlackNotifierTest < ActiveSupport::TestCase
 
     expected_data_string = "foo: bar\njohn: doe\nuser_id: 5"
 
-    Slack::Notifier.any_instance.expects(:ping).with('', fake_notification(@exception, expected_data_string))
+    Slack::Notifier.any_instance.expects(:ping).with('', fake_notification(@exception, notification_options, expected_data_string))
     slack_notifier = ExceptionNotifier::SlackNotifier.new(options)
     slack_notifier.call(@exception, notification_options)
   end
@@ -165,12 +177,28 @@ class SlackNotifierTest < ActiveSupport::TestCase
     ]
   end
 
-  def fake_notification(exception = @exception, data_string = nil)
-    text = "*An exception occurred while doing*: ` <>`\n"
+  def fake_notification(exception = @exception, notification_options = {}, data_string = nil, expected_backtrace_lines = nil)
+    exception_name = "*#{exception.class.to_s =~ /^[aeiou]/i ? 'An' : 'A'}* `#{exception.class.to_s}`"
+    if notification_options[:env].nil?
+      text = "#{exception_name} *occured in background*"
+    else
+      env = notification_options[:env]
+
+      kontroller = env['action_controller.instance']
+      request = "#{env['REQUEST_METHOD']} <#{env['REQUEST_URI']}>"
+
+      text = "#{exception_name} *occurred while* `#{request}`"
+      text += " *was processed by* `#{kontroller.controller_name}##{kontroller.action_name}`" if kontroller
+    end
+
+    text += "\n"
 
     fields = [ { title: 'Exception', value: exception.message} ]
     fields.push({ title: 'Hostname', value: 'example.com' })
-    fields.push({ title: 'Backtrace', value: "```#{fake_backtrace.join("\n")}```" }) if exception.backtrace
+    if exception.backtrace
+      formatted_backtrace = expected_backtrace_lines ? "```#{exception.backtrace.first(expected_backtrace_lines).join("\n")}```" : "```#{exception.backtrace.join("\n")}```"
+      fields.push({ title: 'Backtrace', value: formatted_backtrace })
+    end
     fields.push({ title: 'Data', value: "```#{data_string}```" }) if data_string
 
     { attachments: [ color: 'danger', text: text, fields: fields, mrkdwn_in: %w(text fields) ] }

data/test/exception_notifier/webhook_notifier_test.rb

@@ -14,7 +14,7 @@ class WebhookNotifierTest < ActiveSupport::TestCase
     assert_equal response[:body][:exception][:error_class], "ZeroDivisionError"
     assert_includes response[:body][:exception][:message], "divided by 0"
     assert_includes response[:body][:exception][:backtrace], "/exception_notification/test/webhook_notifier_test.rb:48"
-    
+
     assert response[:body][:request][:cookies].has_key?(:cookie_item1)
     assert_equal response[:body][:request][:url], "http://example.com/example"
     assert_equal response[:body][:request][:ip_address], "192.168.1.1"
@@ -25,6 +25,16 @@ class WebhookNotifierTest < ActiveSupport::TestCase
     assert response[:body][:data][:extra_data].has_key?(:data_item1)
   end
 
+  test "should send webhook notification with correct params data" do
+    url = 'http://localhost:8000'
+    fake_exception.stubs(:backtrace).returns('the backtrace')
+    webhook = ExceptionNotifier::WebhookNotifier.new({:url => url})
+
+    HTTParty.expects(:send).with(:post, url, fake_params)
+
+    webhook.call(fake_exception)
+  end
+
   test "should call pre/post_callback if specified" do
     HTTParty.stubs(:send).returns(fake_response)
     webhook = ExceptionNotifier::WebhookNotifier.new({:url => 'http://localhost:8000'})
@@ -58,8 +68,24 @@ class WebhookNotifierTest < ActiveSupport::TestCase
     }
   end
 
+  def fake_params
+    {
+      :body => {
+        :server => Socket.gethostname,
+        :process => $$,
+        :rails_root => Rails.root,
+        :exception => {
+          :error_class => 'ZeroDivisionError',
+          :message => 'divided by 0'.inspect,
+          :backtrace => 'the backtrace'
+        },
+        :data => {}
+      }
+    }
+  end
+
   def fake_exception
-    exception = begin
+    @fake_exception ||= begin
       5/0
     rescue Exception => e
       e

data/test/exception_notifier_test.rb

@@ -3,8 +3,8 @@ require 'test_helper'
 class ExceptionNotifierTest < ActiveSupport::TestCase
   test "should have default ignored exceptions" do
     assert_equal ExceptionNotifier.ignored_exceptions,
-      ['ActiveRecord::RecordNotFound', '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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: exception_notification
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 4.2.1
 platform: ruby
 authors:
 - Jamis Buck
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-12 00:00:00.000000000 Z
+date: 2016-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer