airbrake 9.3.0 → 13.0.3

data/lib/airbrake/rails/railties/middleware_tie.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Airbrake
+  module Rails
+    module Railties
+      # Ties Airbrake Rails Middleware with Rails (error sending).
+      #
+      # Since Rails 3.2 the ActionDispatch::DebugExceptions middleware is
+      # responsible for logging exceptions and showing a debugging page in case
+      # the request is local. We want to insert our middleware after
+      # DebugExceptions, so we don't notify Airbrake about local requests.
+      #
+      # @api private
+      # @since v13.0.1
+      class MiddlewareTie
+        def initialize(app)
+          @app = app
+          @middleware = app.config.middleware
+        end
+
+        def call
+          return tie_rails_5_or_above if ::Rails.version.to_i >= 5
+
+          if defined?(::ActiveRecord::ConnectionAdapters::ConnectionManagement)
+            return tie_rails_4_or_below_with_active_record
+          end
+
+          tie_rails_4_or_below_without_active_record
+        end
+
+        private
+
+        # Avoid the warning about deprecated strings.
+        # Insert after DebugExceptions, since ConnectionManagement doesn't
+        # exist in Rails 5 anymore.
+        def tie_rails_5_or_above
+          @middleware.insert_after(
+            ActionDispatch::DebugExceptions,
+            Airbrake::Rack::Middleware,
+          )
+        end
+
+        # Insert after ConnectionManagement to avoid DB connection leakage:
+        # https://github.com/airbrake/airbrake/pull/568
+        def tie_rails_4_or_below_with_active_record
+          @middleware.insert_after(
+            ::ActiveRecord::ConnectionAdapters::ConnectionManagement,
+            'Airbrake::Rack::Middleware',
+          )
+        end
+
+        # Insert after DebugExceptions for apps without ActiveRecord.
+        def tie_rails_4_or_below_without_active_record
+          @middleware.insert_after(
+            ActionDispatch::DebugExceptions,
+            'Airbrake::Rack::Middleware',
+          )
+        end
+      end
+    end
+  end
+end

data/lib/airbrake/rails/typhoeus.rb

@@ -1,12 +1,16 @@
-module Typhoeus
-  # Monkey-patch to measure request timing.
-  class Request
-    alias run_without_airbrake run
+# frozen_string_literal: true
 
-    def run
-      Airbrake::Rack.capture_timing(:http) do
-        run_without_airbrake
+module Airbrake
+  module Rails
+    # Allow measuring request timing.
+    module TyphoeusRequest
+      def run
+        Airbrake::Rack.capture_timing(:http) do
+          super
+        end
       end
     end
   end
 end
+
+Typhoeus::Request.prepend(Airbrake::Rails::TyphoeusRequest)

data/lib/airbrake/rails.rb

@@ -1,140 +1,19 @@
-module Airbrake
-  module Rails
-    # This railtie works for any Rails application that supports railties (Rails
-    # 3.2+ apps). It makes Airbrake Ruby work with Rails and report errors
-    # occurring in the application automatically.
-    class Railtie < ::Rails::Railtie
-      initializer('airbrake.middleware') do |app|
-        # Since Rails 3.2 the ActionDispatch::DebugExceptions middleware is
-        # responsible for logging exceptions and showing a debugging page in
-        # case the request is local. We want to insert our middleware after
-        # DebugExceptions, so we don't notify Airbrake about local requests.
-
-        if ::Rails.version.to_i >= 5
-          # Avoid the warning about deprecated strings.
-          # Insert after DebugExceptions, since ConnectionManagement doesn't
-          # exist in Rails 5 anymore.
-          app.config.middleware.insert_after(
-            ActionDispatch::DebugExceptions,
-            Airbrake::Rack::Middleware
-          )
-        elsif defined?(::ActiveRecord::ConnectionAdapters::ConnectionManagement)
-          # Insert after ConnectionManagement to avoid DB connection leakage:
-          # https://github.com/airbrake/airbrake/pull/568
-          app.config.middleware.insert_after(
-            ::ActiveRecord::ConnectionAdapters::ConnectionManagement,
-            'Airbrake::Rack::Middleware'
-          )
-        else
-          # Insert after DebugExceptions for apps without ActiveRecord.
-          app.config.middleware.insert_after(
-            ActionDispatch::DebugExceptions,
-            'Airbrake::Rack::Middleware'
-          )
-        end
-      end
-
-      rake_tasks do
-        # Report exceptions occurring in Rake tasks.
-        require 'airbrake/rake'
-
-        # Defines tasks such as `airbrake:test` & `airbrake:deploy`.
-        require 'airbrake/rake/tasks'
-      end
-
-      # rubocop:disable Metrics/BlockLength
-      initializer('airbrake.action_controller') do
-        ActiveSupport.on_load(:action_controller) do
-          # Patches ActionController with methods that allow us to retrieve
-          # interesting request data. Appends that information to notices.
-          require 'airbrake/rails/action_controller'
-          include Airbrake::Rails::ActionController
-
-          if Airbrake::Config.instance.performance_stats
-            # Cache route information for the duration of the request.
-            require 'airbrake/rails/action_controller_route_subscriber'
-            ActiveSupport::Notifications.subscribe(
-              'start_processing.action_controller',
-              Airbrake::Rails::ActionControllerRouteSubscriber.new
-            )
-
-            # Send route stats.
-            require 'airbrake/rails/action_controller_notify_subscriber'
-            ActiveSupport::Notifications.subscribe(
-              'process_action.action_controller',
-              Airbrake::Rails::ActionControllerNotifySubscriber.new
-            )
-
-            # Send performance breakdown: where a request spends its time.
-            require 'airbrake/rails/action_controller_performance_breakdown_subscriber'
-            ActiveSupport::Notifications.subscribe(
-              'process_action.action_controller',
-              Airbrake::Rails::ActionControllerPerformanceBreakdownSubscriber.new
-            )
-
-            require 'airbrake/rails/net_http' if defined?(Net) && defined?(Net::HTTP)
-
-            if defined?(Curl) && defined?(Curl::CURB_VERSION)
-              require 'airbrake/rails/curb'
-            end
+# frozen_string_literal: true
 
-            require 'airbrake/rails/http' if defined?(HTTP) && defined?(HTTP::Client)
-            require 'airbrake/rails/http_client' if defined?(HTTPClient)
-            require 'airbrake/rails/typhoeus' if defined?(Typhoeus)
+require 'airbrake/rails/railtie'
 
-            if defined?(Excon)
-              require 'airbrake/rails/excon_subscriber'
-              ActiveSupport::Notifications.subscribe(/excon/, Airbrake::Rails::Excon.new)
-              ::Excon.defaults[:instrumentor] = ActiveSupport::Notifications
-            end
-          end
-        end
-      end
-      # rubocop:enable Metrics/BlockLength
-
-      initializer('airbrake.active_record') do
-        ActiveSupport.on_load(:active_record) do
-          # Reports exceptions occurring in some bugged ActiveRecord callbacks.
-          # Applicable only to the versions of Rails lower than 4.2.
-          require 'airbrake/rails/active_record'
-          include Airbrake::Rails::ActiveRecord
-
-          if defined?(ActiveRecord) && Airbrake::Config.instance.performance_stats
-            # Send SQL queries.
-            require 'airbrake/rails/active_record_subscriber'
-            ActiveSupport::Notifications.subscribe(
-              'sql.active_record', Airbrake::Rails::ActiveRecordSubscriber.new
-            )
-
-            # Filter out parameters from SQL body.
-            Airbrake.add_performance_filter(
-              Airbrake::Filters::SqlFilter.new(
-                ::ActiveRecord::Base.connection_config[:adapter]
-              )
-            )
-          end
-        end
-      end
-
-      initializer('airbrake.active_job') do
-        ActiveSupport.on_load(:active_job) do
-          # Reports exceptions occurring in ActiveJob jobs.
-          require 'airbrake/rails/active_job'
-          include Airbrake::Rails::ActiveJob
-        end
-      end
-
-      initializer('airbrake.action_cable') do
-        ActiveSupport.on_load(:action_cable) do
-          # Reports exceptions occurring in ActionCable connections.
-          require 'airbrake/rails/action_cable'
-        end
-      end
-
-      runner do
-        at_exit do
-          Airbrake.notify_sync($ERROR_INFO) if $ERROR_INFO
-        end
+module Airbrake
+  # Rails namespace holds all Rails-related functionality.
+  module Rails
+    def self.logger
+      # Rails.logger is not set in some Rake tasks such as
+      # 'airbrake:deploy'. In this case we use a sensible fallback.
+      level = (::Rails.logger ? ::Rails.logger.level : Logger::ERROR)
+
+      if ENV['RAILS_LOG_TO_STDOUT'].present?
+        Logger.new($stdout, level: level)
+      else
+        Logger.new(::Rails.root.join('log', 'airbrake.log'), level: level)
       end
     end
   end

data/lib/airbrake/rake/tasks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'airbrake-ruby'
 
 namespace :airbrake do
@@ -51,11 +53,11 @@ namespace :airbrake do
     raise Airbrake::Error, 'airbrake-ruby is not configured' unless Airbrake.configured?
 
     deploy_params = {
-      environment: ENV['ENVIRONMENT'],
-      username: ENV['USERNAME'],
-      revision: ENV['REVISION'],
-      repository: ENV['REPOSITORY'],
-      version: ENV['VERSION']
+      environment: ENV.fetch('ENVIRONMENT', nil),
+      username: ENV.fetch('USERNAME', nil),
+      revision: ENV.fetch('REVISION', nil),
+      repository: ENV.fetch('REPOSITORY', nil),
+      version: ENV.fetch('VERSION', nil),
     }
     promise = Airbrake.notify_deploy(deploy_params)
     promise.then do
@@ -66,10 +68,10 @@ namespace :airbrake do
 
   desc 'Install a Heroku deploy hook to notify Airbrake of deploys'
   task :install_heroku_deploy_hook do
-    app = ENV['HEROKU_APP']
+    app = ENV.fetch('HEROKU_APP', nil)
 
     config = Bundler.with_clean_env do
-      `heroku config --shell#{ " --app #{app}" if app }`
+      `heroku config --shell#{" --app #{app}" if app}`
     end
 
     heroku_env = config.each_line.with_object({}) do |line, h|
@@ -83,11 +85,11 @@ namespace :airbrake do
 
     unless (env = heroku_env['RAILS_ENV'])
       env = 'production'
-      puts "Airbrake couldn't identify your app's environment, so the '#{env}'" \
-           " environment will be used."
+      puts "Airbrake couldn't identify your app's environment, " \
+           "so the '#{env}' environment will be used."
     end
 
-    unless (repo = ENV['REPOSITORY_URL'])
+    unless (repo = ENV.fetch('REPOSITORY_URL', nil))
       repo = `git remote get-url origin 2>/dev/null`.chomp
       if repo.empty?
         puts "Airbrake couldn't identify your app's repository."
@@ -97,14 +99,14 @@ namespace :airbrake do
       end
     end
 
-    url = "https://airbrake.io/api/v3/projects/#{id}/heroku-deploys?key=#{key}"
+    url = ["https://airbrake.io/api/v3/projects/#{id}/heroku-deploys?key=#{key}"]
     url << "&environment=#{env}"
     url << "&repository=#{repo}" unless repo.empty?
 
-    command = %(heroku addons:create deployhooks:http --url="#{url}")
+    command = [%(heroku addons:create deployhooks:http --url="#{url.join}")]
     command << " --app #{app}" if app
 
-    puts "$ #{command}"
+    puts "$ #{command.join}"
     Bundler.with_clean_env { puts `#{command}` }
   end
 end

data/lib/airbrake/rake.rb

@@ -1,63 +1,66 @@
+# frozen_string_literal: true
+
 # This is not bulletproof, but if this file is executed before a task
 # definition, we can grab tasks descriptions and locations.
 # See: https://goo.gl/ksn6PE
 Rake::TaskManager.record_task_metadata = true
 
-module Rake
-  # Redefine +Rake::Task#execute+, so it can report errors to Airbrake.
-  class Task
-    # Store the original method to use it later.
-    alias execute_without_airbrake execute
-
-    # A wrapper around the original +#execute+, that catches all errors and
-    # notifies Airbrake.
-    #
-    # rubocop:disable Lint/RescueException
-    def execute(args = nil)
-      execute_without_airbrake(args)
-    rescue Exception => ex
-      notify_airbrake(ex, args)
-      raise ex
-    end
-    # rubocop:enable Lint/RescueException
+module Airbrake
+  module Rake
+    # Redefine +Rake::Task#execute+, so it can report errors to Airbrake.
+    module Task
+      # A wrapper around the original +#execute+, that catches all errors and
+      # notifies Airbrake.
+      #
+      # rubocop:disable Lint/RescueException
+      def execute(args = nil)
+        super(args)
+      rescue Exception => ex
+        notify_airbrake(ex, args)
+        raise ex
+      end
+      # rubocop:enable Lint/RescueException
 
-    private
+      private
 
-    def notify_airbrake(exception, args)
-      notice = Airbrake.build_notice(exception)
-      notice[:context][:component] = 'rake'
-      notice[:context][:action] = name
-      notice[:params].merge!(
-        rake_task: task_info,
-        execute_args: args,
-        argv: ARGV.join(' ')
-      )
+      def notify_airbrake(exception, args)
+        notice = Airbrake.build_notice(exception)
+        notice[:context][:component] = 'rake'
+        notice[:context][:action] = name
+        notice[:params].merge!(
+          rake_task: task_info,
+          execute_args: args,
+          argv: ARGV.join(' '),
+        )
 
-      Airbrake.notify_sync(notice)
-    end
+        Airbrake.notify_sync(notice)
+      end
 
-    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize
-    def task_info
-      info = {}
+      # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize
+      def task_info
+        info = {}
 
-      info[:name] = name
-      info[:timestamp] = timestamp.to_s
-      info[:investigation] = investigation
+        info[:name] = name
+        info[:timestamp] = timestamp.to_s
+        info[:investigation] = investigation
 
-      info[:full_comment] = full_comment if full_comment
-      info[:arg_names] = arg_names if arg_names.any?
-      info[:arg_description] = arg_description if arg_description
-      info[:locations] = locations if locations.any?
-      info[:sources] = sources if sources.any?
+        info[:full_comment] = full_comment if full_comment
+        info[:arg_names] = arg_names if arg_names.any?
+        info[:arg_description] = arg_description if arg_description
+        info[:locations] = locations if locations.any?
+        info[:sources] = sources if sources.any?
 
-      if prerequisite_tasks.any?
-        info[:prerequisite_tasks] = prerequisite_tasks.map do |p|
-          p.__send__(:task_info)
+        if prerequisite_tasks.any?
+          info[:prerequisite_tasks] = prerequisite_tasks.map do |p|
+            p.__send__(:task_info)
+          end
         end
-      end
 
-      info
+        info
+      end
+      # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize
     end
-    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize
   end
 end
+
+Rake::Task.prepend(Airbrake::Rake::Task)

data/lib/airbrake/resque.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Resque
   module Failure
     # Provides Resque integration with Airbrake.
@@ -27,3 +29,34 @@ module Resque
     end
   end
 end
+
+module Airbrake
+  module Resque
+    # Measures elapsed time of a job and notifies Airbrake of the execution
+    # status.
+    #
+    # @since v9.6.0
+    module Job
+      def perform
+        timing = Airbrake::Benchmark.measure do
+          super
+        end
+      rescue StandardError => exception
+        Airbrake.notify_queue_sync(
+          queue: payload['class'],
+          error_count: 1,
+          timing: 0.01,
+        )
+        raise exception
+      else
+        Airbrake.notify_queue_sync(
+          queue: payload['class'],
+          error_count: 0,
+          timing: timing,
+        )
+      end
+    end
+  end
+end
+
+Resque::Job.prepend(Airbrake::Resque::Job)

data/lib/airbrake/shoryuken.rb

@@ -1,14 +1,26 @@
+# frozen_string_literal: true
+
 module Airbrake
   module Shoryuken
     # Provides integration with Shoryuken.
     class ErrorHandler
       # rubocop:disable Lint/RescueException
-      def call(worker, queue, _sqs_msg, body)
-        yield
+      def call(worker, queue, _sqs_msg, body, &block)
+        timing = Airbrake::Benchmark.measure(&block)
       rescue Exception => exception
         notify_airbrake(exception, worker, queue, body)
-
+        Airbrake.notify_queue(
+          queue: worker.class.to_s,
+          error_count: 1,
+          timing: 0.01,
+        )
         raise exception
+      else
+        Airbrake.notify_queue(
+          queue: worker.class.to_s,
+          error_count: 0,
+          timing: timing,
+        )
       end
       # rubocop:enable Lint/RescueException
 
@@ -24,7 +36,7 @@ module Airbrake
       def notice_context(queue, body)
         {
           queue: queue,
-          body: body.is_a?(Array) ? { batch: body } : { body: body }
+          body: body.is_a?(Array) ? { batch: body } : { body: body },
         }
       end
     end

data/lib/airbrake/sidekiq/retryable_jobs_filter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Airbrake
   module Sidekiq
     # Filter that can ignore notices from jobs that failed but will be retried
@@ -13,6 +15,10 @@ module Airbrake
         DEFAULT_MAX_RETRY_ATTEMPTS = ::Sidekiq::JobRetry::DEFAULT_MAX_RETRY_ATTEMPTS
       end
 
+      def initialize(max_retries: nil)
+        @max_retries = max_retries
+      end
+
       def call(notice)
         job = notice[:params][:job]
 
@@ -30,7 +36,9 @@ module Airbrake
       end
 
       def max_attempts_for(job)
-        if job['retry'].is_a?(Integer)
+        if @max_retries
+          @max_retries
+        elsif job['retry'].is_a?(Integer)
           job['retry']
         else
           max_retries

data/lib/airbrake/sidekiq.rb

@@ -1,22 +1,33 @@
+# frozen_string_literal: true
+
 require 'airbrake/sidekiq/retryable_jobs_filter'
 
 module Airbrake
   module Sidekiq
     # Provides integration with Sidekiq v2+.
     class ErrorHandler
-      # rubocop:disable Lint/RescueException
-      def call(_worker, context, _queue)
-        yield
-      rescue Exception => exception
+      def call(_worker, context, _queue, &block)
+        timing = Airbrake::Benchmark.measure(&block)
+      rescue Exception => exception # rubocop:disable Lint/RescueException
         notify_airbrake(exception, context)
+        Airbrake.notify_queue(
+          queue: context['class'],
+          error_count: 1,
+          timing: 0.01,
+        )
         raise exception
+      else
+        Airbrake.notify_queue(
+          queue: context['class'],
+          error_count: 0,
+          timing: timing,
+        )
       end
-      # rubocop:enable Lint/RescueException
 
       private
 
       def notify_airbrake(exception, context)
-        Airbrake.notify(exception, context) do |notice|
+        Airbrake.notify(exception, job: context) do |notice|
           notice[:context][:component] = 'sidekiq'
           notice[:context][:action] = action(context)
         end
@@ -25,23 +36,18 @@ module Airbrake
       # @return [String] job's name. When ActiveJob is present, retrieve
       #   job_class. When used directly, use worker's name
       def action(context)
-        klass = context['class'] || context[:job] && context[:job]['class']
+        klass = context['class'] || (context[:job] && context[:job]['class'])
         return klass unless context[:job] && context[:job]['args'].first.is_a?(Hash)
         return klass unless (job_class = context[:job]['args'].first['job_class'])
+
         job_class
       end
     end
   end
 end
 
-if Sidekiq::VERSION < '3'
-  Sidekiq.configure_server do |config|
-    config.server_middleware do |chain|
-      chain.add(Airbrake::Sidekiq::ErrorHandler)
-    end
-  end
-else
-  Sidekiq.configure_server do |config|
-    config.error_handlers << Airbrake::Sidekiq::ErrorHandler.new.method(:notify_airbrake)
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add(Airbrake::Sidekiq::ErrorHandler)
   end
 end

data/lib/airbrake/sneakers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Airbrake
   module Sneakers
     # Provides integration with Sneakers.
@@ -10,17 +12,21 @@ module Airbrake
       # @see https://github.com/airbrake/airbrake/issues/850
       IGNORED_KEYS = %i[delivery_tag consumer channel].freeze
 
-      def call(exception, worker = nil, **context)
+      # rubocop:disable Style/OptionalArguments
+      def call(exception, worker = nil, context)
+        # Later versions add a middle argument.
         Airbrake.notify(exception, filter_context(context)) do |notice|
           notice[:context][:component] = 'sneakers'
           notice[:context][:action] = worker.class.to_s
         end
       end
+      # rubocop:enable Style/OptionalArguments
 
       private
 
       def filter_context(context)
         return context unless context[:delivery_info]
+
         h = context.dup
         h[:delivery_info] = context[:delivery_info].reject do |k, _v|
           IGNORED_KEYS.include?(k)
@@ -32,3 +38,35 @@ module Airbrake
 end
 
 Sneakers.error_reporters << Airbrake::Sneakers::ErrorReporter.new
+
+module Airbrake
+  module Sneakers
+    # @todo Migrate to Sneakers v2.12.0 middleware API when it's released
+    # @see https://github.com/jondot/sneakers/pull/364
+    module Worker
+      # Sneakers v2.7.0+ renamed `do_work` to `process_work`.
+      define_method(
+        ::Sneakers::Worker.method_defined?(:process_work) ? :process_work : :do_work,
+      ) do |delivery_info, metadata, msg, handler|
+        timing = Airbrake::Benchmark.measure do
+          super(delivery_info, metadata, msg, handler)
+        end
+      rescue Exception => exception # rubocop:disable Lint/RescueException
+        Airbrake.notify_queue(
+          queue: self.class.to_s,
+          error_count: 1,
+          timing: 0.01,
+        )
+        raise exception
+      else
+        Airbrake.notify_queue(
+          queue: self.class.to_s,
+          error_count: 0,
+          timing: timing,
+        )
+      end
+    end
+  end
+end
+
+Sneakers::Worker.prepend(Airbrake::Sneakers::Worker)

data/lib/airbrake/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 # We use Semantic Versioning v2.0.0
 # More information: http://semver.org/
 module Airbrake
-  AIRBRAKE_VERSION = '9.3.0'.freeze
+  AIRBRAKE_VERSION = '13.0.3'
 end

data/lib/airbrake.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'shellwords'
 require 'English'