exception_notification 4.6.0 → 5.0.0

data/gemfiles/rails7_2.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "rails", "~> 7.2.0"
+
+gemspec path: "../"

data/gemfiles/rails8_0.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "rails", "~> 8.0.0"
+
+gemspec path: "../"

data/lib/exception_notification/rack.rb

@@ -48,15 +48,15 @@ module ExceptionNotification
     def call(env)
       _, headers, = response = @app.call(env)
 
-      if !@ignore_cascade_pass && headers['X-Cascade'] == 'pass'
+      if !@ignore_cascade_pass && headers["X-Cascade"] == "pass"
         msg = "This exception means that the preceding Rack middleware set the 'X-Cascade' header to 'pass' -- in " \
-              'Rails, this often means that the route was not found (404 error).'
+              "Rails, this often means that the route was not found (404 error)."
         raise CascadePassException, msg
       end
 
       response
-    rescue Exception => e
-      env['exception_notifier.delivered'] = true if ExceptionNotifier.notify_exception(e, env: env)
+    rescue Exception => e # standard:disable Lint/RescueException
+      env["exception_notifier.delivered"] = true if ExceptionNotifier.notify_exception(e, env: env)
 
       raise e unless e.is_a?(CascadePassException)
 

data/lib/exception_notification/rails.rb

@@ -15,12 +15,12 @@ module ExceptionNotification
 
     rake_tasks do
       # Report exceptions occurring in Rake tasks.
-      require 'exception_notification/rake'
+      require "exception_notification/rake"
     end
 
     runner do
       # Report exceptions occurring in runner commands.
-      require 'exception_notification/rails/runner_tie'
+      require "exception_notification/rails/runner_tie"
       Rails::RunnerTie.new.call
     end
   end

data/lib/exception_notification/rake.rb

@@ -8,15 +8,12 @@ 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
+      super
+    rescue Exception => e # standard:disable Lint/RescueException
       ExceptionNotifier.notify_exception(e, data: data_for_exception_notifier(e)) unless e.is_a?(SystemExit)
       raise e
     end
-    # rubocop:enable Lint/RescueException
 
     private
 
@@ -45,10 +42,9 @@ module ExceptionNotification
 
       data
     end
-    # rubocop:enable
 
     def reconstruct_command_line
-      "rake #{ARGV.join(' ')}"
+      "rake #{ARGV.join(" ")}"
     end
   end
 end

data/lib/exception_notification/resque.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'resque/failure/base'
+require "resque/failure/base"
 
 module ExceptionNotification
   class Resque < Resque::Failure::Base
@@ -18,7 +18,7 @@ module ExceptionNotification
         worker: worker.to_s
       }
 
-      ExceptionNotifier.notify_exception(exception, data: { resque: data })
+      ExceptionNotifier.notify_exception(exception, data: {resque: data})
     end
   end
 end

data/lib/exception_notification/sidekiq.rb

@@ -1,29 +1,14 @@
 # frozen_string_literal: true
 
-require 'sidekiq'
+require "sidekiq"
 
-# Note: this class is only needed for Sidekiq version < 3.
-module ExceptionNotification
-  class Sidekiq
-    def call(_worker, msg, _queue)
-      yield
-    rescue Exception => e
-      ExceptionNotifier.notify_exception(e, data: { sidekiq: msg })
-      raise e
-    end
-  end
-end
-
-if ::Sidekiq::VERSION < '3'
-  ::Sidekiq.configure_server do |config|
-    config.server_middleware do |chain|
-      chain.add ::ExceptionNotification::Sidekiq
-    end
-  end
-else
-  ::Sidekiq.configure_server do |config|
-    config.error_handlers << proc do |ex, context|
-      ExceptionNotifier.notify_exception(ex, data: { sidekiq: context })
+::Sidekiq.configure_server do |config|
+  config.error_handlers << proc do |ex, context, config|
+    # Before Sidekiq 7.1.5 the config was not passed to the proc
+    if config
+      ExceptionNotifier.notify_exception(ex, data: {sidekiq: {context: context, config: config}})
+    else
+      ExceptionNotifier.notify_exception(ex, data: {sidekiq: context})
     end
   end
 end

data/lib/exception_notification/version.rb

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

data/lib/exception_notification.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'exception_notifier'
-require 'exception_notification/rack'
-require 'exception_notification/version'
+require "exception_notifier"
+require "exception_notification/rack"
+require "exception_notification/version"
 
 module ExceptionNotification
   # Alternative way to setup ExceptionNotification.

data/lib/exception_notifier/datadog_notifier.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require 'action_dispatch'
+require "action_dispatch"
 
 module ExceptionNotifier
   class DatadogNotifier < BaseNotifier
     attr_reader :client,
-                :default_options
+      :default_options
 
     def initialize(options)
       super
@@ -32,10 +32,10 @@ module ExceptionNotifier
       MAX_TITLE_LENGTH = 120
       MAX_VALUE_LENGTH = 300
       MAX_BACKTRACE_SIZE = 3
-      ALERT_TYPE = 'error'
+      ALERT_TYPE = "error"
 
       attr_reader :exception,
-                  :options
+        :options
 
       def initialize(exception, options)
         @exception = exception
@@ -47,7 +47,7 @@ module ExceptionNotifier
       end
 
       def controller
-        @controller ||= options[:env] && options[:env]['action_controller.instance']
+        @controller ||= options[:env] && options[:env]["action_controller.instance"]
       end
 
       def backtrace
@@ -59,7 +59,7 @@ module ExceptionNotifier
       end
 
       def title_prefix
-        options[:title_prefix] || ''
+        options[:title_prefix] || ""
       end
 
       def event
@@ -85,11 +85,11 @@ module ExceptionNotifier
       def formatted_body
         text = []
 
-        text << '%%%'
+        text << "%%%"
         text << formatted_request if request
         text << formatted_session if request
         text << formatted_backtrace
-        text << '%%%'
+        text << "%%%"
 
         text.join("\n")
       end
@@ -100,24 +100,24 @@ module ExceptionNotifier
 
       def formatted_request
         text = []
-        text << '### **Request**'
-        text << formatted_key_value('URL', request.url)
-        text << formatted_key_value('HTTP Method', request.request_method)
-        text << formatted_key_value('IP Address', request.remote_ip)
-        text << formatted_key_value('Parameters', request.filtered_parameters.inspect)
-        text << formatted_key_value('Timestamp', Time.current)
-        text << formatted_key_value('Server', Socket.gethostname)
-        text << formatted_key_value('Rails root', Rails.root) if defined?(Rails) && Rails.respond_to?(:root)
-        text << formatted_key_value('Process', $PROCESS_ID)
-        text << '___'
+        text << "### **Request**"
+        text << formatted_key_value("URL", request.url)
+        text << formatted_key_value("HTTP Method", request.request_method)
+        text << formatted_key_value("IP Address", request.remote_ip)
+        text << formatted_key_value("Parameters", request.filtered_parameters.inspect)
+        text << formatted_key_value("Timestamp", Time.current)
+        text << formatted_key_value("Server", Socket.gethostname)
+        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")
       end
 
       def formatted_session
         text = []
-        text << '### **Session**'
-        text << formatted_key_value('Data', request.session.to_hash)
-        text << '___'
+        text << "### **Session**"
+        text << formatted_key_value("Data", request.session.to_hash)
+        text << "___"
         text.join("\n")
       end
 
@@ -125,16 +125,16 @@ module ExceptionNotifier
         size = [backtrace.size, MAX_BACKTRACE_SIZE].min
 
         text = []
-        text << '### **Backtrace**'
-        text << '````'
+        text << "### **Backtrace**"
+        text << "````"
         size.times { |i| text << backtrace[i] }
-        text << '````'
-        text << '___'
+        text << "````"
+        text << "___"
         text.join("\n")
       end
 
       def truncate(string, max)
-        string.length > max ? "#{string[0...max]}..." : string
+        (string.length > max) ? "#{string[0...max]}..." : string
       end
 
       def inspect_object(object)

data/lib/exception_notifier/email_notifier.rb

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
 
-require 'active_support/core_ext/time'
-require 'action_mailer'
-require 'action_dispatch'
-require 'pp'
+require "active_support/core_ext/time"
+require "action_mailer"
+require "action_dispatch"
+require "pp"
 
 module ExceptionNotifier
   class EmailNotifier < BaseNotifier
     DEFAULT_OPTIONS = {
       sender_address: %("Exception Notifier" <exception.notifier@example.com>),
       exception_recipients: [],
-      email_prefix: '[ERROR] ',
+      email_prefix: "[ERROR] ",
       email_format: :text,
       sections: %w[request session environment backtrace],
       background_sections: %w[backtrace data],
@@ -20,14 +20,18 @@ module ExceptionNotifier
       delivery_method: nil,
       mailer_settings: nil,
       email_headers: {},
-      mailer_parent: 'ActionMailer::Base',
-      template_path: 'exception_notifier',
+      mailer_parent: "ActionMailer::Base",
+      template_path: "exception_notifier",
       deliver_with: nil
     }.freeze
 
     module Mailer
       class MissingController
-        def method_missing(*args, &block); end
+        def method_missing(*args, &block)
+        end
+
+        def respond_to_missing?(*args)
+        end
       end
 
       def self.extended(base)
@@ -40,18 +44,18 @@ module ExceptionNotifier
           def exception_notification(env, exception, options = {}, default_options = {})
             load_custom_views
 
-            @env        = env
-            @exception  = exception
+            @env = env
+            @exception = exception
 
-            env_options = env['exception_notifier.options'] || {}
-            @options    = default_options.merge(env_options).merge(options)
+            env_options = env["exception_notifier.options"] || {}
+            @options = default_options.merge(env_options).merge(options)
 
-            @kontroller = env['action_controller.instance'] || MissingController.new
-            @request    = ActionDispatch::Request.new(env)
-            @backtrace  = exception.backtrace ? clean_backtrace(exception) : []
-            @timestamp  = Time.current
-            @sections   = @options[:sections]
-            @data       = (env['exception_notifier.exception_data'] || {}).merge(options[:data] || {})
+            @kontroller = env["action_controller.instance"] || MissingController.new
+            @request = ActionDispatch::Request.new(env)
+            @backtrace = exception.backtrace ? clean_backtrace(exception) : []
+            @timestamp = Time.current
+            @sections = @options[:sections]
+            @data = (env["exception_notifier.exception_data"] || {}).merge(options[:data] || {})
             @sections += %w[data] unless @data.empty?
 
             compose_email
@@ -61,11 +65,11 @@ module ExceptionNotifier
             load_custom_views
 
             @exception = exception
-            @options   = default_options.merge(options).symbolize_keys
+            @options = default_options.merge(options).symbolize_keys
             @backtrace = exception.backtrace || []
             @timestamp = Time.current
-            @sections  = @options[:background_sections]
-            @data      = options[:data] || {}
+            @sections = @options[:background_sections]
+            @data = options[:data] || {}
             @env = @kontroller = nil
 
             compose_email
@@ -80,7 +84,7 @@ module ExceptionNotifier
             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
+            (subject.length > 120) ? subject[0...120] + "..." : subject
           end
 
           def include_controller?
@@ -89,14 +93,14 @@ module ExceptionNotifier
 
           def set_data_variables
             @data.each do |name, value|
-              instance_variable_set("@#{name}", value)
+              instance_variable_set(:"@#{name}", value)
             end
           end
 
           helper_method :inspect_object
 
           def truncate(string, max)
-            string.length > max ? "#{string[0...max]}..." : string
+            (string.length > max) ? "#{string[0...max]}..." : string
           end
 
           def inspect_object(object)
@@ -111,7 +115,7 @@ module ExceptionNotifier
           helper_method :safe_encode
 
           def safe_encode(value)
-            value.encode('utf-8', invalid: :replace, undef: :replace, replace: '_')
+            value.encode("utf-8", invalid: :replace, undef: :replace, replace: "_")
           end
 
           def html_mail?
@@ -121,7 +125,7 @@ module ExceptionNotifier
           def compose_email
             set_data_variables
             subject = compose_subject
-            name = @env.nil? ? 'background_exception_notification' : 'exception_notification'
+            name = @env.nil? ? "background_exception_notification" : "exception_notification"
             exception_recipients = maybe_call(@options[:exception_recipients])
 
             headers = {
@@ -145,7 +149,7 @@ module ExceptionNotifier
           def load_custom_views
             return unless defined?(Rails) && Rails.respond_to?(:root)
 
-            prepend_view_path Rails.root.nil? ? 'app/views' : "#{Rails.root}/app/views"
+            prepend_view_path Rails.root.nil? ? "app/views" : "#{Rails.root}/app/views"
           end
 
           def maybe_call(maybe_proc)
@@ -158,8 +162,8 @@ module ExceptionNotifier
     def initialize(options)
       super
 
-      delivery_method = (options[:delivery_method] || :smtp)
-      mailer_settings_key = "#{delivery_method}_settings".to_sym
+      delivery_method = options[:delivery_method] || :smtp
+      mailer_settings_key = :"#{delivery_method}_settings"
       options[:mailer_settings] = options.delete(mailer_settings_key)
 
       @base_options = DEFAULT_OPTIONS.merge(options)
@@ -184,7 +188,7 @@ module ExceptionNotifier
     end
 
     def self.normalize_digits(string)
-      string.gsub(/[0-9]+/, 'N')
+      string.gsub(/[0-9]+/, "N")
     end
 
     private

data/lib/exception_notifier/google_chat_notifier.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'httparty'
+require "httparty"
 
 module ExceptionNotifier
   class GoogleChatNotifier < BaseNotifier
@@ -10,8 +10,8 @@ module ExceptionNotifier
 
       HTTParty.post(
         options[:webhook_url],
-        body: { text: body(exception, formatter) }.to_json,
-        headers: { 'Content-Type' => 'application/json' }
+        body: {text: body(exception, formatter)}.to_json,
+        headers: {"Content-Type" => "application/json"}
       )
     end
 
@@ -21,20 +21,20 @@ module ExceptionNotifier
       text = [
         "\nApplication: *#{formatter.app_name}*",
         formatter.subtitle,
-        '',
+        "",
         formatter.title,
-        "*#{exception.message.tr('`', "'")}*"
+        "*#{exception.message.tr("`", "'")}*"
       ]
 
       if (request = formatter.request_message.presence)
-        text << ''
-        text << '*Request:*'
+        text << ""
+        text << "*Request:*"
         text << request
       end
 
       if (backtrace = formatter.backtrace_message.presence)
-        text << ''
-        text << '*Backtrace:*'
+        text << ""
+        text << "*Backtrace:*"
         text << backtrace
       end
 

data/lib/exception_notifier/hipchat_notifier.rb

@@ -9,26 +9,26 @@ module ExceptionNotifier
     def initialize(options)
       super
       begin
-        api_token         = options.delete(:api_token)
-        room_name         = options.delete(:room_name)
-        opts              = {
-          api_version: options.delete(:api_version) || 'v1'
+        api_token = options.delete(:api_token)
+        room_name = options.delete(:room_name)
+        opts = {
+          api_version: options.delete(:api_version) || "v1"
         }
         opts[:server_url] = options.delete(:server_url) if options[:server_url]
-        @from             = options.delete(:from) || 'Exception'
-        @room             = HipChat::Client.new(api_token, opts)[room_name]
+        @from = options.delete(:from) || "Exception"
+        @room = HipChat::Client.new(api_token, opts)[room_name]
         @message_template = options.delete(:message_template) || lambda { |exception, errors_count|
           msg = if errors_count > 1
-                  "The exception occurred #{errors_count} times: '#{Rack::Utils.escape_html(exception.message)}'"
-                else
-                  "A new exception occurred: '#{Rack::Utils.escape_html(exception.message)}'"
-                end
+            "The exception occurred #{errors_count} times: '#{Rack::Utils.escape_html(exception.message)}'"
+          else
+            "A new exception occurred: '#{Rack::Utils.escape_html(exception.message)}'"
+          end
           msg += " on '#{exception.backtrace.first}'" if exception.backtrace
           msg
         }
         @message_options = options
-        @message_options[:color] ||= 'red'
-      rescue StandardError
+        @message_options[:color] ||= "red"
+      rescue
         @room = nil
       end
     end

data/lib/exception_notifier/irc_notifier.rb

@@ -18,7 +18,7 @@ module ExceptionNotifier
       return unless active?
 
       send_notice(exception, options, message) do |msg, _|
-        send_message([*@config.prefix, *msg].join(' '))
+        send_message([*@config.prefix, *msg].join(" "))
       end
     end
 
@@ -29,20 +29,20 @@ module ExceptionNotifier
     private
 
     def parse_options(options)
-      nick = options.fetch(:nick, 'ExceptionNotifierBot')
+      nick = options.fetch(:nick, "ExceptionNotifierBot")
       password = options[:password] ? ":#{options[:password]}" : nil
       domain = options.fetch(:domain, nil)
       port = options[:port] ? ":#{options[:port]}" : nil
-      channel = options.fetch(:channel, '#log')
+      channel = options.fetch(:channel, "#log")
       notice = options.fetch(:notice, false)
       ssl = options.fetch(:ssl, false)
       join = options.fetch(:join, false)
       uri = "irc://#{nick}#{password}@#{domain}#{port}/#{channel}"
       prefix = options.fetch(:prefix, nil)
-      recipients = options[:recipients] ? options[:recipients].join(', ') + ':' : nil
+      recipients = options[:recipients] ? options[:recipients].join(", ") + ":" : nil
 
-      @config.prefix = [*prefix, *recipients].join(' ')
-      @config.irc = { uri: uri, ssl: ssl, notice: notice, join: join }
+      @config.prefix = [*prefix, *recipients].join(" ")
+      @config.irc = {uri: uri, ssl: ssl, notice: notice, join: join}
     end
 
     def active?

data/lib/exception_notifier/mattermost_notifier.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'httparty'
+require "httparty"
 
 module ExceptionNotifier
   class MattermostNotifier < BaseNotifier
@@ -16,7 +16,7 @@ module ExceptionNotifier
 
       payload = {
         text: message_text.compact.join("\n"),
-        username: options[:username] || 'Exception Notifier'
+        username: options[:username] || "Exception Notifier"
       }
 
       payload[:icon_url] = options[:avatar] if options[:avatar]
@@ -29,7 +29,7 @@ module ExceptionNotifier
 
       httparty_options[:body] = payload.to_json
       httparty_options[:headers] ||= {}
-      httparty_options[:headers]['Content-Type'] = 'application/json'
+      httparty_options[:headers]["Content-Type"] = "application/json"
 
       HTTParty.post(options[:webhook_url], httparty_options)
     end
@@ -40,24 +40,24 @@ module ExceptionNotifier
 
     def message_text
       text = [
-        '@channel',
+        "@channel",
         "### #{formatter.title}",
         formatter.subtitle,
         "*#{@exception.message}*"
       ]
 
       if (request = formatter.request_message.presence)
-        text << '### Request'
+        text << "### Request"
         text << request
       end
 
       if (backtrace = formatter.backtrace_message.presence)
-        text << '### Backtrace'
+        text << "### Backtrace"
         text << backtrace
       end
 
-      if (exception_data = @env['exception_notifier.exception_data'])
-        text << '### Data'
+      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
@@ -68,12 +68,12 @@ module ExceptionNotifier
     end
 
     def message_issue_link
-      link = [@gitlab_url, formatter.app_name, 'issues', 'new'].join('/')
+      link = [@gitlab_url, formatter.app_name, "issues", "new"].join("/")
       params = {
-        'issue[title]' => ['[BUG] Error 500 :',
-                           formatter.controller_and_action || '',
-                           "(#{@exception.class})",
-                           @exception.message].compact.join(' ')
+        "issue[title]" => ["[BUG] Error 500 :",
+          formatter.controller_and_action || "",
+          "(#{@exception.class})",
+          @exception.message].compact.join(" ")
       }.to_query
 
       "[Create an issue](#{link}/?#{params})"

data/lib/exception_notifier/modules/error_grouping.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'active_support'
-require 'active_support/core_ext/numeric/time'
-require 'active_support/concern'
+require "active_support"
+require "active_support/core_ext/numeric/time"
+require "active_support/concern"
 
 module ExceptionNotifier
   module ErrorGrouping
@@ -31,7 +31,7 @@ module ExceptionNotifier
         count =
           begin
             error_grouping_cache.read(error_key)
-          rescue StandardError => e
+          rescue => e
             log_cache_error(error_grouping_cache, e, :read)
             fallback_cache_store.read(error_key)
           end
@@ -41,7 +41,7 @@ module ExceptionNotifier
 
       def save_error_count(error_key, count)
         error_grouping_cache.write(error_key, count, expires_in: error_grouping_period)
-      rescue StandardError => e
+      rescue => e
         log_cache_error(error_grouping_cache, e, :write)
         fallback_cache_store.write(error_key, count, expires_in: error_grouping_period)
       end