exception_notification 4.4.0 → 4.4.1

data/lib/exception_notifier/base_notifier.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ExceptionNotifier
   class BaseNotifier
     attr_accessor :base_options
@@ -14,11 +16,15 @@ module ExceptionNotifier
     end
 
     def _pre_callback(exception, options, message, message_opts)
-      @base_options[:pre_callback].call(options, self, exception.backtrace, message, message_opts) if @base_options[:pre_callback].respond_to?(:call)
+      return unless @base_options[:pre_callback].respond_to?(:call)
+
+      @base_options[:pre_callback].call(options, self, exception.backtrace, message, message_opts)
     end
 
     def _post_callback(exception, options, message, message_opts)
-      @base_options[:post_callback].call(options, self, exception.backtrace, message, message_opts) if @base_options[:post_callback].respond_to?(:call)
+      return unless @base_options[:post_callback].respond_to?(:call)
+
+      @base_options[:post_callback].call(options, self, exception.backtrace, message, message_opts)
     end
   end
 end

data/lib/exception_notifier/campfire_notifier.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ExceptionNotifier
   class CampfireNotifier < BaseNotifier
     attr_accessor :subdomain

data/lib/exception_notifier/datadog_notifier.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'action_dispatch'
 
 module ExceptionNotifier
@@ -30,7 +32,7 @@ module ExceptionNotifier
       MAX_TITLE_LENGTH = 120
       MAX_VALUE_LENGTH = 300
       MAX_BACKTRACE_SIZE = 3
-      ALERT_TYPE = 'error'.freeze
+      ALERT_TYPE = 'error'
 
       attr_reader :exception,
                   :options
@@ -74,11 +76,8 @@ module ExceptionNotifier
       end
 
       def formatted_title
-        title = ''
-        title << title_prefix
-        title << "#{controller.controller_name} #{controller.action_name}" if controller
-        title << " (#{exception.class})"
-        title << " #{exception.message.inspect}"
+        title =
+          "#{title_prefix}#{controller_subtitle} (#{exception.class}) #{exception.message.inspect}"
 
         truncate(title, MAX_TITLE_LENGTH)
       end
@@ -108,9 +107,7 @@ module ExceptionNotifier
         text << formatted_key_value('Parameters', request.filtered_parameters.inspect)
         text << formatted_key_value('Timestamp', Time.current)
         text << formatted_key_value('Server', Socket.gethostname)
-        if defined?(Rails) && Rails.respond_to?(:root)
-          text << formatted_key_value('Rails root', Rails.root)
-        end
+        text << formatted_key_value('Rails root', Rails.root) if defined?(Rails) && Rails.respond_to?(:root)
         text << formatted_key_value('Process', $PROCESS_ID)
         text << '___'
         text.join("\n")
@@ -148,6 +145,12 @@ module ExceptionNotifier
           object.to_s
         end
       end
+
+      private
+
+      def controller_subtitle
+        "#{controller.controller_name} #{controller.action_name}" if controller
+      end
     end
   end
 end

data/lib/exception_notifier/email_notifier.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/core_ext/time'
 require 'action_mailer'
 require 'action_dispatch'
@@ -74,13 +76,17 @@ 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 @kontroller && @options[:include_controller_and_action_names_in_subject]
+            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]
             subject.length > 120 ? subject[0...120] + '...' : subject
           end
 
+          def include_controller?
+            @kontroller && @options[:include_controller_and_action_names_in_subject]
+          end
+
           def set_data_variables
             @data.each do |name, value|
               instance_variable_set("@#{name}", value)
@@ -121,7 +127,7 @@ module ExceptionNotifier
             headers = {
               delivery_method: @options[:delivery_method],
               to: exception_recipients,
-              from: @options[:sender_address],
+              from: self.class.default[:from] || @options[:sender_address],
               subject: subject,
               template_name: name
             }.merge(@options[:email_headers])
@@ -137,7 +143,9 @@ module ExceptionNotifier
           end
 
           def load_custom_views
-            prepend_view_path Rails.root.nil? ? 'app/views' : "#{Rails.root}/app/views" if defined?(Rails) && Rails.respond_to?(:root)
+            return unless defined?(Rails) && Rails.respond_to?(:root)
+
+            prepend_view_path Rails.root.nil? ? 'app/views' : "#{Rails.root}/app/views"
           end
 
           def maybe_call(maybe_proc)

data/lib/exception_notifier/google_chat_notifier.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'httparty'
 
 module ExceptionNotifier

data/lib/exception_notifier/hipchat_notifier.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ExceptionNotifier
   class HipchatNotifier < BaseNotifier
     attr_accessor :from

data/lib/exception_notifier/irc_notifier.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ExceptionNotifier
   class IrcNotifier < BaseNotifier
     def initialize(options)
@@ -9,9 +11,8 @@ module ExceptionNotifier
     def call(exception, options = {})
       errors_count = options[:accumulated_errors_count].to_i
 
-      message = "'#{exception.message}'"
-      message.prepend("(#{errors_count} times)") if errors_count > 1
-
+      occurrences = "(#{errors_count} times)" if errors_count > 1
+      message = "#{occurrences}'#{exception.message}'"
       message += " on '#{exception.backtrace.first}'" if exception.backtrace
 
       return unless active?

data/lib/exception_notifier/mattermost_notifier.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'httparty'
 
 module ExceptionNotifier
@@ -10,6 +12,8 @@ module ExceptionNotifier
 
       @gitlab_url = options[:git_url]
 
+      @env = options[:env] || {}
+
       payload = {
         text: message_text.compact.join("\n"),
         username: options[:username] || 'Exception Notifier'
@@ -52,6 +56,12 @@ module ExceptionNotifier
         text << backtrace
       end
 
+      if (exception_data = @env['exception_notifier.exception_data'])
+        text << '### Data'
+        data_string = exception_data.map { |k, v| "* #{k} : #{v}" }.join("\n")
+        text << "```\n#{data_string}\n```"
+      end
+
       text << message_issue_link if @gitlab_url
 
       text

data/lib/exception_notifier/modules/backtrace_cleaner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ExceptionNotifier
   module BacktraceCleaner
     def clean_backtrace(exception)

data/lib/exception_notifier/modules/error_grouping.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/core_ext/numeric/time'
 require 'active_support/concern'
 
@@ -25,20 +27,21 @@ module ExceptionNotifier
       end
 
       def error_count(error_key)
-        count = begin
-          error_grouping_cache.read(error_key)
-        rescue StandardError => e
-          ExceptionNotifier.logger.warn("#{error_grouping_cache.inspect} failed to read, reason: #{e.message}. Falling back to memory cache store.")
-          fallback_cache_store.read(error_key)
-        end
+        count =
+          begin
+            error_grouping_cache.read(error_key)
+          rescue StandardError => e
+            log_cache_error(error_grouping_cache, e, :read)
+            fallback_cache_store.read(error_key)
+          end
 
-        count.to_i if count
+        count&.to_i
       end
 
       def save_error_count(error_key, count)
         error_grouping_cache.write(error_key, count, expires_in: error_grouping_period)
       rescue StandardError => e
-        ExceptionNotifier.logger.warn("#{error_grouping_cache.inspect} failed to write, reason: #{e.message}. Falling back to memory cache store.")
+        log_cache_error(error_grouping_cache, e, :write)
         fallback_cache_store.write(error_key, count, expires_in: error_grouping_period)
       end
 
@@ -50,7 +53,8 @@ module ExceptionNotifier
           accumulated_errors_count = count + 1
           save_error_count(message_based_key, accumulated_errors_count)
         else
-          backtrace_based_key = "exception:#{Zlib.crc32("#{exception.class.name}\npath:#{exception.backtrace.try(:first)}")}"
+          backtrace_based_key =
+            "exception:#{Zlib.crc32("#{exception.class.name}\npath:#{exception.backtrace.try(:first)}")}"
 
           if (count = error_grouping_cache.read(backtrace_based_key))
             accumulated_errors_count = count + 1
@@ -72,6 +76,12 @@ module ExceptionNotifier
           factor.to_i == factor
         end
       end
+
+      private
+
+      def log_cache_error(cache, exception, action)
+        "#{cache.inspect} failed to #{action}, reason: #{exception.message}. Falling back to memory cache store."
+      end
     end
   end
 end

data/lib/exception_notifier/modules/formatter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/core_ext/time'
 require 'action_dispatch'
 
@@ -108,6 +110,7 @@ module ExceptionNotifier
 
     def rails_app_name
       return unless defined?(::Rails) && ::Rails.respond_to?(:application)
+
       Rails.application.class.parent_name.underscore
     end
 

data/lib/exception_notifier/notifier.rb

@@ -1,9 +1,13 @@
+# frozen_string_literal: true
+
 require 'active_support/deprecation'
 
 module ExceptionNotifier
   class Notifier
     def self.exception_notification(env, exception, options = {})
-      ActiveSupport::Deprecation.warn 'Please use ExceptionNotifier.notify_exception(exception, options.merge(env: env)).'
+      ActiveSupport::Deprecation.warn(
+        'Please use ExceptionNotifier.notify_exception(exception, options.merge(env: env)).'
+      )
       ExceptionNotifier.registered_exception_notifier(:email).create_email(exception, options.merge(env: env))
     end
 

data/lib/exception_notifier/slack_notifier.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ExceptionNotifier
   class SlackNotifier < BaseNotifier
     include ExceptionNotifier::BacktraceCleaner

data/lib/exception_notifier/sns_notifier.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ExceptionNotifier
   class SnsNotifier < BaseNotifier
     def initialize(options)
@@ -33,9 +35,8 @@ module ExceptionNotifier
     attr_reader :notifier, :options
 
     def build_subject(exception, options)
-      subject = "#{options[:sns_prefix]} - "
-      subject << accumulated_exception_name(exception, options)
-      subject << ' occurred'
+      subject =
+        "#{options[:sns_prefix]} - #{accumulated_exception_name(exception, options)} occurred"
       subject.length > 120 ? subject[0...120] + '...' : subject
     end
 

data/lib/exception_notifier/teams_notifier.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'action_dispatch'
 require 'active_support/core_ext/time'
 require 'json'
@@ -64,8 +66,6 @@ module ExceptionNotifier
     private
 
     def message_text
-      errors_count = @options[:accumulated_errors_count].to_i
-
       text = {
         '@type' => 'MessageCard',
         '@context' => 'http://schema.org/extensions',
@@ -73,7 +73,7 @@ module ExceptionNotifier
         'title' => "⚠️ Exception Occurred in #{env_name} ⚠️",
         'sections' => [
           {
-            'activityTitle' => "#{errors_count > 1 ? errors_count : 'A'} *#{@exception.class}* occurred" + (@controller ? " in *#{controller_and_method}*." : '.'),
+            'activityTitle' => activity_title,
             'activitySubtitle' => @exception.message.to_s
           }
         ],
@@ -100,6 +100,13 @@ module ExceptionNotifier
       details
     end
 
+    def activity_title
+      errors_count = @options[:accumulated_errors_count].to_i
+
+      "#{errors_count > 1 ? errors_count : 'A'} *#{@exception.class}* occurred" +
+        (@controller ? " in *#{controller_and_method}*." : '.')
+    end
+
     def message_request
       {
         'name' => 'Request',

data/lib/exception_notifier/webhook_notifier.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'action_dispatch'
 require 'active_support/core_ext/time'
 
@@ -18,9 +20,7 @@ module ExceptionNotifier
       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][:rails_root] = Rails.root if defined?(Rails) && Rails.respond_to?(:root)
       options[:body][:exception] = {
         error_class: exception.class.to_s,
         message: exception.message.inspect,

data/lib/generators/exception_notification/install_generator.rb

@@ -1,11 +1,17 @@
+# frozen_string_literal: true
+
 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.'
+      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'

data/test/exception_notification/rack_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 class RackTest < ActiveSupport::TestCase
@@ -10,8 +12,7 @@ class RackTest < ActiveSupport::TestCase
   end
 
   teardown do
-    ExceptionNotifier.error_grouping = false
-    ExceptionNotifier.notification_trigger = nil
+    ExceptionNotifier.reset_notifiers!
   end
 
   test 'should ignore "X-Cascade" header by default' do
@@ -57,4 +58,49 @@ class RackTest < ActiveSupport::TestCase
       refute env['exception_notifier.delivered']
     end
   end
+
+  test 'should ignore exceptions if ignore_if condition is met' do
+    exception_app = Object.new
+    exception_app.stubs(:call).raises(RuntimeError)
+
+    env = {}
+
+    begin
+      ExceptionNotification::Rack.new(
+        exception_app,
+        ignore_if: ->(_env, exception) { exception.is_a? RuntimeError }
+      ).call(env)
+
+      flunk
+    rescue StandardError
+      refute env['exception_notifier.delivered']
+    end
+  end
+
+  test 'should ignore exceptions with notifiers that satisfies ignore_notifier_if condition' do
+    exception_app = Object.new
+    exception_app.stubs(:call).raises(RuntimeError)
+
+    notifier1_called = notifier2_called = false
+    notifier1 = ->(_exception, _options) { notifier1_called = true }
+    notifier2 = ->(_exception, _options) { notifier2_called = true }
+
+    env = {}
+
+    begin
+      ExceptionNotification::Rack.new(
+        exception_app,
+        ignore_notifier_if: {
+          notifier1: ->(_env, exception) { exception.is_a? RuntimeError }
+        },
+        notifier1: notifier1,
+        notifier2: notifier2
+      ).call(env)
+
+      flunk
+    rescue StandardError
+      refute notifier1_called
+      assert notifier2_called
+    end
+  end
 end