exception_notification 4.4.3 → 4.6.0

data/exception_notification.gemspec

@@ -6,22 +6,22 @@ Gem::Specification.new do |s|
   s.name = 'exception_notification'
   s.version = ExceptionNotification::VERSION
   s.authors = ['Jamis Buck', 'Josh Peek']
-  s.date = '2020-06-29'
   s.summary = 'Exception notification for Rails apps'
   s.homepage = 'https://smartinez87.github.io/exception_notification/'
   s.email = 'smartinez87@gmail.com'
   s.license = 'MIT'
+  s.metadata = { 'changelog_uri' => 'https://github.com/smartinez87/exception_notification/blob/master/CHANGELOG.rdoc' }
 
   s.required_ruby_version     = '>= 2.3'
   s.required_rubygems_version = '>= 1.8.11'
 
-  s.files = `git ls-files`.split("\n")
+  s.files = `git ls-files | grep -v '^examples'`.split("\n")
   s.files -= `git ls-files -- .??*`.split("\n")
   s.test_files = `git ls-files -- test`.split("\n")
   s.require_path = 'lib'
 
-  s.add_dependency('actionmailer', '>= 4.0', '< 7')
-  s.add_dependency('activesupport', '>= 4.0', '< 7')
+  s.add_dependency('actionmailer', '>= 5.2', '< 9')
+  s.add_dependency('activesupport', '>= 5.2', '< 9')
 
   s.add_development_dependency 'appraisal', '~> 2.2.0'
   s.add_development_dependency 'aws-sdk-sns', '~> 1'
@@ -32,11 +32,11 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'httparty', '~> 0.10.2'
   s.add_development_dependency 'mocha', '>= 0.13.0'
   s.add_development_dependency 'mock_redis', '~> 0.19.0'
-  s.add_development_dependency 'rails', '>= 4.0', '< 7'
+  s.add_development_dependency 'net-smtp'
+  s.add_development_dependency 'rails', '>= 5.2', '< 9'
   s.add_development_dependency 'resque', '~> 1.8.0'
-  s.add_development_dependency 'rubocop', '0.78.0'
+  s.add_development_dependency 'rubocop'
   s.add_development_dependency 'sidekiq', '>= 5.0.4'
   s.add_development_dependency 'slack-notifier', '>= 1.0.0'
   s.add_development_dependency 'timecop', '~> 0.9.0'
-  s.add_development_dependency 'tinder', '~> 1.8'
 end

data/gemfiles/{rails5_0.gemfile → rails6_1.gemfile}

@@ -2,6 +2,6 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~> 5.0.0"
+gem "rails", "~> 6.1.0"
 
 gemspec path: "../"

data/gemfiles/{rails4_2.gemfile → rails7_0.gemfile}

@@ -2,6 +2,6 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~> 4.2.0"
+gem "rails", "~> 7.0.0"
 
 gemspec path: "../"

data/lib/exception_notification/rails/runner_tie.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module ExceptionNotification
+  module Rails
+    class RunnerTie
+      # Registers an at_exit callback, which checks if there was an exception. This is a pretty
+      # crude way to detect exceptions from runner commands, but Rails doesn't provide a better API.
+      #
+      # This should only be called from a runner callback in your Rails config; otherwise you may
+      # register the at_exit callback in more places than you need or want it.
+      def call
+        at_exit do
+          exception = $ERROR_INFO
+          if exception && !exception.is_a?(SystemExit)
+            ExceptionNotifier.notify_exception(exception, data: data_for_exception_notifier(exception))
+          end
+        end
+      end
+
+      private
+
+      def data_for_exception_notifier(exception = nil)
+        data = {}
+        data[:error_class] = exception.class.name if exception
+        data[:error_message] = exception.message if exception
+
+        data
+      end
+    end
+  end
+end

data/lib/exception_notification/rails.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+# Warning: This must be required after rails but before initializers have been run. If you require
+# it from config/initializers/exception_notification.rb, then the rails and rake_task callbacks
+# registered here will have no effect, because Rails will have already invoked all registered rails
+# and rake_tasks handlers.
+
 module ExceptionNotification
   class Engine < ::Rails::Engine
     config.exception_notification = ExceptionNotifier
@@ -7,5 +12,16 @@ module ExceptionNotification
     config.exception_notification.error_grouping_cache = Rails.cache
 
     config.app_middleware.use ExceptionNotification::Rack
+
+    rake_tasks do
+      # Report exceptions occurring in Rake tasks.
+      require 'exception_notification/rake'
+    end
+
+    runner do
+      # Report exceptions occurring in runner commands.
+      require 'exception_notification/rails/runner_tie'
+      Rails::RunnerTie.new.call
+    end
   end
 end

data/lib/exception_notification/rake.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# Copied/adapted from https://github.com/airbrake/airbrake/blob/master/lib/airbrake/rake.rb
+
+Rake::TaskManager.record_task_metadata = true if Rake.const_defined?(:TaskManager)
+
+module ExceptionNotification
+  module RakeTaskExtensions
+    # A wrapper around the original +#execute+, that catches all errors and
+    # passes them on to ExceptionNotifier.
+    #
+    # rubocop:disable Lint/RescueException
+    def execute(args = nil)
+      super(args)
+    rescue Exception => e
+      ExceptionNotifier.notify_exception(e, data: data_for_exception_notifier(e)) unless e.is_a?(SystemExit)
+      raise e
+    end
+    # rubocop:enable Lint/RescueException
+
+    private
+
+    def data_for_exception_notifier(exception = nil)
+      data = {}
+      data[:error_class] = exception.class.name if exception
+      data[:error_message] = exception.message if exception
+
+      data[:rake] = {}
+      data[:rake][:rake_command_line] = reconstruct_command_line
+      data[:rake][:name] = name
+      data[:rake][:timestamp] = timestamp.to_s
+      # data[:investigation] = investigation
+
+      data[:rake][:full_comment] = full_comment if full_comment
+      data[:rake][:arg_names] = arg_names if arg_names.any?
+      data[:rake][:arg_description] = arg_description if arg_description
+      data[:rake][:locations] = locations if locations.any?
+      data[:rake][:sources] = sources if sources.any?
+
+      if prerequisite_tasks.any?
+        data[:rake][:prerequisite_tasks] = prerequisite_tasks.map do |p|
+          p.__send__(:data_for_exception_notifier)[:rake]
+        end
+      end
+
+      data
+    end
+    # rubocop:enable
+
+    def reconstruct_command_line
+      "rake #{ARGV.join(' ')}"
+    end
+  end
+end
+
+module Rake
+  class Task
+    prepend ExceptionNotification::RakeTaskExtensions
+  end
+end

data/lib/exception_notification/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ExceptionNotification
-  VERSION = '4.4.3'
+  VERSION = '4.6.0'
 end

data/lib/exception_notifier/email_notifier.rb

@@ -76,7 +76,7 @@ module ExceptionNotifier
           def compose_subject
             subject = @options[:email_prefix].to_s.dup
             subject << "(#{@options[:accumulated_errors_count]} times)" if @options[:accumulated_errors_count].to_i > 1
-            subject << "#{@kontroller.controller_name} #{@kontroller.action_name}" if include_controller?
+            subject << "#{@kontroller.controller_name}##{@kontroller.action_name}" if include_controller?
             subject << " (#{@exception.class})"
             subject << " #{@exception.message.inspect}" if @options[:verbose_subject]
             subject = EmailNotifier.normalize_digits(subject) if @options[:normalize_subject]

data/lib/exception_notifier/modules/error_grouping.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'active_support'
 require 'active_support/core_ext/numeric/time'
 require 'active_support/concern'
 

data/lib/exception_notifier/modules/formatter.rb

@@ -111,7 +111,11 @@ module ExceptionNotifier
     def rails_app_name
       return unless defined?(::Rails) && ::Rails.respond_to?(:application)
 
-      Rails.application.class.parent_name.underscore
+      if Rails::VERSION::MAJOR >= 6
+        Rails.application.class.module_parent_name.underscore
+      else
+        Rails.application.class.parent_name.underscore
+      end
     end
 
     def controller

data/lib/exception_notifier/slack_notifier.rb

@@ -72,6 +72,9 @@ module ExceptionNotifier
       exception_name = "*#{measure_word}* `#{exception_class}`"
       env = options[:env]
 
+      options[:headers] ||= {}
+      options[:headers]['Content-Type'] = 'application/json'
+
       if env.nil?
         data = options[:data] || {}
         text = "#{exception_name} *occured in background*\n"

data/lib/exception_notifier/sns_notifier.rb

@@ -45,10 +45,12 @@ module ExceptionNotifier
 
       if options[:env].nil?
         text = "#{exception_name} occured in background\n"
+        data = options[:data] || {}
       else
         env = options[:env]
 
         kontroller = env['action_controller.instance']
+        data = (env['exception_notifier.exception_data'] || {}).merge(options[:data] || {})
         request = "#{env['REQUEST_METHOD']} <#{env['REQUEST_URI']}>"
 
         text = "#{exception_name} occurred while #{request}"
@@ -57,6 +59,7 @@ module ExceptionNotifier
 
       text += "Exception: #{exception.message}\n"
       text += "Hostname: #{Socket.gethostname}\n"
+      text += "Data: #{data}\n"
 
       return unless exception.backtrace
 

data/lib/exception_notifier/teams_notifier.rb

@@ -38,7 +38,7 @@ module ExceptionNotifier
         @controller = @request_items = nil
       else
         @controller = @env['action_controller.instance'] || MissingController.new
-
+        @additional_exception_data = @env['exception_notifier.exception_data']
         request = ActionDispatch::Request.new(@env)
 
         @request_items = { url: request.original_url,
@@ -47,10 +47,6 @@ module ExceptionNotifier
                            parameters: request.filtered_parameters,
                            timestamp: Time.current }
 
-        if request.session['warden.user.user.key']
-          current_user = User.find(request.session['warden.user.user.key'][0][0])
-          @request_items[:current_user] = { id: current_user.id, email: current_user.email }
-        end
       end
 
       payload = message_text
@@ -96,7 +92,7 @@ module ExceptionNotifier
 
       details['facts'].push message_request unless @request_items.nil?
       details['facts'].push message_backtrace unless @backtrace.nil?
-
+      details['facts'].push additional_exception_data unless @additional_exception_data.nil?
       details
     end
 
@@ -127,6 +123,13 @@ module ExceptionNotifier
       }
     end
 
+    def additional_exception_data
+      {
+        'name' => 'Data',
+        'value' => "`#{@additional_exception_data}`\n  "
+      }
+    end
+
     def gitlab_view_link
       {
         '@type' => 'ViewAction',

data/lib/exception_notifier/views/exception_notifier/_data.html.erb

@@ -1,6 +1,6 @@
 <ul style="list-style: none">
   <li>
     <strong>data:</strong>
-    <span><%= PP.pp(@data, "") %></span>
+    <span><%= PP.pp(@data, +"") %></span>
   </li>
 </ul>

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

@@ -1 +1 @@
-* data: <%= raw PP.pp(@data, "") %>
+* data: <%= raw PP.pp(@data, +"") %>

data/lib/exception_notifier/views/exception_notifier/_session.html.erb

@@ -5,6 +5,6 @@
   </li>
   <li>
     <strong>data: </strong>
-    <span><%= PP.pp(@request.session.to_hash, "") %></span>
+    <span><%= PP.pp(@request.session.to_hash, +"") %></span>
   </li>
 </ul>

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

@@ -1,2 +1,2 @@
 * session id: <%= @request.ssl? ? "[FILTERED]" : (raw (@request.session['session_id'] || (@request.env["rack.session.options"] and @request.env["rack.session.options"][:id])).inspect.html_safe) %>
-* data: <%= raw PP.pp(@request.session.to_hash, "") %>
+* data: <%= raw PP.pp(@request.session.to_hash, +"") %>

data/lib/exception_notifier.rb

@@ -14,7 +14,6 @@ module ExceptionNotifier
 
   autoload :Notifier, 'exception_notifier/notifier'
   autoload :EmailNotifier, 'exception_notifier/email_notifier'
-  autoload :CampfireNotifier, 'exception_notifier/campfire_notifier'
   autoload :HipchatNotifier, 'exception_notifier/hipchat_notifier'
   autoload :WebhookNotifier, 'exception_notifier/webhook_notifier'
   autoload :IrcNotifier, 'exception_notifier/irc_notifier'

data/lib/generators/exception_notification/install_generator.rb

@@ -2,7 +2,7 @@
 
 module ExceptionNotification
   module Generators
-    class InstallGenerator < Rails::Generators::Base
+    class InstallGenerator < ::Rails::Generators::Base
       desc 'Creates a ExceptionNotification initializer.'
 
       source_root File.expand_path('templates', __dir__)

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

@@ -1,4 +1,6 @@
+# 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'
 <% if options.sidekiq? %>
 require 'exception_notification/sidekiq'
 <% end %>
@@ -19,7 +21,7 @@ ExceptionNotification.configure do |config|
   # 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?
+  #   Rails.env.local?
   # end
 
   # Ignore exceptions generated by crawlers

data/test/exception_notification/rake_test.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+require 'rake'
+require 'exception_notification/rake'
+
+class RakeTest < ActiveSupport::TestCase
+  setup do
+    Rake::Task.define_task :dependency_1 do
+      puts :dependency_1
+    end
+    Rake::Task.define_task raise_exception: :dependency_1 do
+      raise 'test exception'
+    end
+    @task = Rake::Task[:raise_exception]
+  end
+
+  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' &&
+        data[:rake][:timestamp] &&
+        data[:rake][:sources] == ['dependency_1'] &&
+        data[:rake][:prerequisite_tasks][0][:name] == 'dependency_1'
+    end
+
+    # The original error is re-raised
+    assert_raises(RuntimeError) do
+      @task.invoke
+    end
+  end
+end

data/test/exception_notifier/email_notifier_test.rb

@@ -239,6 +239,7 @@ class EmailNotifierWithEnvTest < ActiveSupport::TestCase
       'action_dispatch.parameter_filter' => ['secret'],
       'HTTPS' => 'on',
       'action_controller.instance' => @controller,
+      'rack.session.options' => {},
       params: { id: 'foo', secret: 'secret' }
     )
 
@@ -248,7 +249,7 @@ class EmailNotifierWithEnvTest < ActiveSupport::TestCase
   test 'sends mail with correct content' do
     assert_equal %("Dummy Notifier" <dummynotifier@example.com>), @mail[:from].value
     assert_equal %w[dummyexceptions@example.com], @mail.to
-    assert_equal '[Dummy ERROR] home index (ZeroDivisionError) "divided by 0"', @mail.subject
+    assert_equal '[Dummy ERROR] home#index (ZeroDivisionError) "divided by 0"', @mail.subject
     assert_equal 'foobar', @mail['X-Custom-Header'].value
     assert_equal 'text/plain; charset=UTF-8', @mail.content_type
     assert_equal [], @mail.attachments
@@ -294,8 +295,7 @@ class EmailNotifierWithEnvTest < ActiveSupport::TestCase
       Environment:
       -------------------------------
 
-        * CONTENT_LENGTH                            : 0
-          * HTTPS                                     : on
+        * HTTPS                                     : on
           * HTTP_HOST                                 : test.address
           * HTTP_USER_AGENT                           : Rails Testing
           * PATH_INFO                                 : /
@@ -305,23 +305,19 @@ class EmailNotifierWithEnvTest < ActiveSupport::TestCase
           * SCRIPT_NAME                               :
           * SERVER_NAME                               : example.org
           * SERVER_PORT                               : 80
+          * SERVER_PROTOCOL                           : HTTP/1.1
           * action_controller.instance                : #{@controller}
           * action_dispatch.parameter_filter          : [\"secret\"]
-          * action_dispatch.request.content_type      :
           * action_dispatch.request.parameters        : {"id"=>"foo", "secret"=>"[FILTERED]"}
           * action_dispatch.request.path_parameters   : {}
           * action_dispatch.request.query_parameters  : {"id"=>"foo", "secret"=>"[FILTERED]"}
           * action_dispatch.request.request_parameters: {}
           * rack.errors                               : #{@test_env['rack.errors']}
-          * rack.input                                : #{@test_env['rack.input']}
-          * rack.multiprocess                         : true
-          * rack.multithread                          : true
-          * rack.request.query_hash                   : {"id"=>"foo", "secret"=>"[FILTERED]"}
-          * rack.request.query_string                 : id=foo&secret=secret
-          * rack.run_once                             : false
-          * rack.session                              : {}
+          * rack.request.form_hash                    : {}
+          * rack.request.form_input                   :
+          * rack.session                              : #{@test_env['rack.session']}
+          * rack.session.options                      : #{@test_env['rack.session.options']}
           * rack.url_scheme                           : http
-          * rack.version                              : #{Rack::VERSION}
 
       -------------------------------
       Backtrace:

data/test/exception_notifier/hipchat_notifier_test.rb

@@ -2,13 +2,7 @@
 
 require 'test_helper'
 require 'rack'
-
-# 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
+require 'hipchat'
 
 class HipchatNotifierTest < ActiveSupport::TestCase
   test 'should send hipchat notification if properly configured' do

data/test/exception_notifier/sidekiq_test.rb

@@ -11,7 +11,11 @@ require 'sidekiq/testing'
 require 'exception_notification/sidekiq'
 
 class MockSidekiqServer
-  include ::Sidekiq::ExceptionHandler
+  include ::Sidekiq::Component
+
+  def config
+    Sidekiq.default_configuration
+  end
 end
 
 class SidekiqTest < ActiveSupport::TestCase

data/test/exception_notifier/sns_notifier_test.rb

@@ -66,6 +66,7 @@ class SnsNotifierTest < ActiveSupport::TestCase
       message: "3 MyException occured in background\n" \
              "Exception: undefined method 'method=' for Empty\n" \
              "Hostname: example.com\n" \
+             "Data: {}\n" \
              "Backtrace:\n#{fake_backtrace.join("\n")}\n",
       subject: '[App Exception] - 3 MyException occurred'
     )
@@ -85,6 +86,7 @@ class SnsNotifierTest < ActiveSupport::TestCase
              "was processed by examples#index\n" \
              "Exception: undefined method 'method=' for Empty\n" \
              "Hostname: example.com\n" \
+             "Data: {}\n" \
              "Backtrace:\n#{fake_backtrace.join("\n")}\n",
       subject: '[App Exception] - A MyException occurred'
     )
@@ -98,6 +100,59 @@ class SnsNotifierTest < ActiveSupport::TestCase
                       })
   end
 
+  test 'should put data from env["exception_notifier.exception_data"] into text' do
+    controller = mock('controller')
+    controller.stubs(:action_name).returns('index')
+    controller.stubs(:controller_name).returns('examples')
+
+    Aws::SNS::Client.any_instance.expects(:publish).with(
+      topic_arn: 'topicARN',
+      message: 'A MyException occurred while GET </examples> ' \
+             "was processed by examples#index\n" \
+             "Exception: undefined method 'method=' for Empty\n" \
+             "Hostname: example.com\n" \
+             "Data: {:current_user=>12}\n" \
+             "Backtrace:\n#{fake_backtrace.join("\n")}\n",
+      subject: '[App Exception] - A MyException occurred'
+    )
+
+    sns_notifier = ExceptionNotifier::SnsNotifier.new(@options)
+    sns_notifier.call(@exception,
+                      env: {
+                        'REQUEST_METHOD' => 'GET',
+                        'REQUEST_URI' => '/examples',
+                        'action_controller.instance' => controller,
+                        'exception_notifier.exception_data' => { current_user: 12 }
+                      })
+  end
+  test 'should put optional data into text' do
+    controller = mock('controller')
+    controller.stubs(:action_name).returns('index')
+    controller.stubs(:controller_name).returns('examples')
+
+    Aws::SNS::Client.any_instance.expects(:publish).with(
+      topic_arn: 'topicARN',
+      message: 'A MyException occurred while GET </examples> ' \
+             "was processed by examples#index\n" \
+             "Exception: undefined method 'method=' for Empty\n" \
+             "Hostname: example.com\n" \
+             "Data: {:current_user=>12}\n" \
+             "Backtrace:\n#{fake_backtrace.join("\n")}\n",
+      subject: '[App Exception] - A MyException occurred'
+    )
+
+    sns_notifier = ExceptionNotifier::SnsNotifier.new(@options)
+    sns_notifier.call(@exception,
+                      env: {
+                        'REQUEST_METHOD' => 'GET',
+                        'REQUEST_URI' => '/examples',
+                        'action_controller.instance' => controller
+                      },
+                      data: {
+                        current_user: 12
+                      })
+  end
+
   private
 
   def fake_exception