airbrake 10.0.0 → 13.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83054730bd07260d0293206623452abacfc4b0006f65900811bac214a026c8a0
-  data.tar.gz: dee0bf02404e401d98b065e0550cffb4fb8bdec9e208cb31d4e37155a4b9e29c
+  metadata.gz: 29da4f7ace6d408a64f855ddab6385fd40863235694a22cd31f5e46d1ae9c957
+  data.tar.gz: 4c08d2305072b5b48936e87dd2e53bf1610459637c7e23c7e75e118e475232b9
 SHA512:
-  metadata.gz: b62c7face7778e77164b5f5222c64b6623984e2925a5b1928de2eb9a5b15a224111aa87b427cdb79b6626e0ae0bee0fc2d59b0780bfc6e5d852f227d4ed4679b
-  data.tar.gz: 41407ade81d73fb1594c67ebd26311f69d3888445fa8b28ae23a0a48031a323dc9ac4a68dc6a9906b532e0855b2878edf9712565b5ef458ec2e9250d59864c2f
+  metadata.gz: 9ddb0e206f5723439061ca14af99f2c228f80f6db5907f07a16a8fde611b4f1e13533a0dea5e5b27d564a90e3044fb449fa09731274042c59fbb84bdb7f83af1
+  data.tar.gz: b78091a0e4391c27eea3c884130e1c6515cf10cf417ea29ec6c6df32075f5917dead2efd2f6e42395a64142f761d3870408ba5f7c7fb3ed1a90f53204c7bc8b2

data/lib/airbrake/capistrano/capistrano2.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Airbrake
   # The Capistrano v2 integration.
   module Capistrano
@@ -19,7 +21,7 @@ module Airbrake
                 RAILS_ENV=#{fetch(:rails_env, nil)} \
 
                 bundle exec rake airbrake:deploy \
-                  USERNAME=#{Shellwords.shellescape(ENV['USER'] || ENV['USERNAME'])} \
+                  USERNAME=#{Shellwords.shellescape(ENV.fetch('USER', nil) || ENV.fetch('USERNAME', nil))} \
                   ENVIRONMENT=#{fetch(:airbrake_env, fetch(:rails_env, 'production'))} \
                   REVISION=#{current_revision.strip} \
                   REPOSITORY=#{repository} \

data/lib/airbrake/capistrano/capistrano3.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 namespace :airbrake do
   desc "Notify Airbrake of the deploy"
   task :deploy do
@@ -11,7 +13,7 @@ namespace :airbrake do
                             REVISION=#{fetch(:current_revision)} \
                             REPOSITORY=#{fetch(:repo_url)} \
                             VERSION=#{fetch(:app_version)}
-            CMD
+          CMD
 
           info 'Notified Airbrake of the deploy'
         end

data/lib/airbrake/capistrano.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 if defined?(Capistrano::VERSION) &&
    Gem::Version.new(Capistrano::VERSION).release >= Gem::Version.new('3.0.0')
   require 'airbrake/capistrano/capistrano3'

data/lib/airbrake/delayed_job.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Delayed
   module Plugins
     # Provides integration with Delayed Job.
@@ -5,41 +7,39 @@ module Delayed
     class Airbrake < ::Delayed::Plugin
       callbacks do |lifecycle|
         lifecycle.around(:invoke_job) do |job, *args, &block|
-          begin
-            timing = ::Airbrake::Benchmark.measure do
-              # Forward the call to the next callback in the callback chain
-              block.call(job, *args)
-            end
-          rescue Exception => exception # rubocop:disable Lint/RescueException
-            params = job.as_json
+          timing = ::Airbrake::Benchmark.measure do
+            # Forward the call to the next callback in the callback chain
+            block.call(job, *args)
+          end
+        rescue Exception => exception # rubocop:disable Lint/RescueException
+          params = job.as_json
 
-            # If DelayedJob is used through ActiveJob, it contains extra info.
-            if job.payload_object.respond_to?(:job_data)
-              params[:active_job] = job.payload_object.job_data
-              job_class = job.payload_object.job_data['job_class']
-            end
+          # If DelayedJob is used through ActiveJob, it contains extra info.
+          if job.payload_object.respond_to?(:job_data)
+            params[:active_job] = job.payload_object.job_data
+            job_class = job.payload_object.job_data['job_class']
+          end
 
-            action = job_class || job.payload_object.class.name
+          action = job_class || job.payload_object.class.name
 
-            ::Airbrake.notify(exception, params) do |notice|
-              notice[:context][:component] = 'delayed_job'
-              notice[:context][:action] = action
-            end
+          ::Airbrake.notify(exception, params) do |notice|
+            notice[:context][:component] = 'delayed_job'
+            notice[:context][:action] = action
+          end
 
-            ::Airbrake.notify_queue_sync(
-              queue: action,
-              error_count: 1,
-              timing: 0.01,
-            )
+          ::Airbrake.notify_queue(
+            queue: action,
+            error_count: 1,
+            timing: 0.01,
+          )
 
-            raise exception
-          else
-            ::Airbrake.notify_queue_sync(
-              queue: job_class || job.payload_object.class.name,
-              error_count: 0,
-              timing: timing,
-            )
-          end
+          raise exception
+        else
+          ::Airbrake.notify_queue(
+            queue: job_class || job.payload_object.class.name,
+            error_count: 0,
+            timing: timing,
+          )
         end
       end
     end

data/lib/airbrake/logger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'logger'
 require 'delegate'
 
@@ -7,7 +9,7 @@ module Airbrake
   #
   # @example
   #   # Create a logger like you normally do and decorate it.
-  #   logger = Airbrake::AirbrakeLogger.new(Logger.new(STDOUT))
+  #   logger = Airbrake::AirbrakeLogger.new(Logger.new($stdout))
   #
   #   # Just use the logger like you normally do.
   #   logger.fatal('oops')
@@ -22,6 +24,8 @@ module Airbrake
     attr_reader :airbrake_level
 
     def initialize(logger)
+      super
+
       __setobj__(logger)
       @airbrake_notifier = Airbrake
       self.level = logger.level

data/lib/airbrake/rack/context_filter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Airbrake
   module Rack
     # Adds context (URL, User-Agent, framework version, controller and more).
@@ -18,14 +20,9 @@ module Airbrake
         context = notice[:context]
 
         context[:url] = request.url
-        context[:userAddr] =
-          if request.respond_to?(:remote_ip)
-            request.remote_ip
-          else
-            request.ip
-          end
         context[:userAgent] = request.user_agent
 
+        add_ip(context, request)
         add_framework_version(context)
 
         controller = request.env['action_controller.instance']
@@ -58,6 +55,15 @@ module Airbrake
             }
           end
       end
+
+      def add_ip(context, request)
+        context[:userAddr] =
+          if request.respond_to?(:remote_ip)
+            request.remote_ip
+          else
+            request.ip
+          end
+      end
     end
   end
 end

data/lib/airbrake/rack/http_headers_filter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Airbrake
   module Rack
     # Adds HTTP request parameters.
@@ -6,10 +8,10 @@ module Airbrake
     class HttpHeadersFilter
       # @return [Array<String>] the prefixes of the majority of HTTP headers in
       #   Rack (some prefixes match the header names for simplicity)
-      HTTP_HEADER_PREFIXES = [
-        'HTTP_'.freeze,
-        'CONTENT_TYPE'.freeze,
-        'CONTENT_LENGTH'.freeze,
+      HTTP_HEADER_PREFIXES = %w[
+        HTTP_
+        CONTENT_TYPE
+        CONTENT_LENGTH
       ].freeze
 
       # @return [Integer]

data/lib/airbrake/rack/http_params_filter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Airbrake
   module Rack
     # Adds HTTP request parameters.

data/lib/airbrake/rack/instrumentable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Airbrake
   module Rack
     # Instrumentable holds methods that simplify instrumenting Rack apps.
@@ -15,14 +17,124 @@ module Airbrake
     # @since v9.2.0
     module Instrumentable
       def airbrake_capture_timing(method_name, label: method_name.to_s)
-        alias_method "#{method_name}_without_airbrake", method_name
+        instrumentable = ::Airbrake::Rack::Instrumentable
+        if instrumentable.should_prepend?(self, method_name)
+          instrumentable.prepend_capture_timing(self, method_name, label)
+        else
+          instrumentable.chain_capture_timing(self, method_name, label)
+        end
+        method_name
+      end
+
+      # @api private
+      def __airbrake_capture_timing_module__
+        # Module used to store prepended wrapper methods, saved as an instance
+        # variable so each target class/module gets its own module. This just
+        # a convenience to avoid prepending a lot of anonymous modules.
+        @__airbrake_capture_timing_module__ ||= ::Module.new
+      end
+      private :__airbrake_capture_timing_module__
+
+      # Using api private self methods so they don't get defined in the target
+      # class or module, but can still be called by the above method.
+
+      # @api private
+      def self.should_prepend?(klass, method_name)
+        # Don't chain already-prepended or operator methods.
+        klass.module_exec do
+          self_class_idx = ancestors.index(self)
+          method_owner_idx = ancestors.index(instance_method(method_name).owner)
+          method_owner_idx < self_class_idx || !(/\A\W/ =~ method_name).nil?
+        end
+      end
+
+      # @api private
+      def self.prepend_capture_timing(klass, method_name, label)
+        args = method_signature
+        visibility = method_visibility(klass, method_name)
+
+        # Generate the wrapper method.
+        klass.module_exec do
+          mod = __airbrake_capture_timing_module__
+          mod.module_exec do
+            # rubocop:disable Style/DocumentDynamicEvalDefinition
+            module_eval <<-RUBY, __FILE__, __LINE__ + 1
+              def #{method_name}(#{args})
+                Airbrake::Rack.capture_timing(#{label.to_s.inspect}) do
+                  super
+                end
+              end
+              #{visibility} :#{method_name}
+            RUBY
+            # rubocop:enable Style/DocumentDynamicEvalDefinition
+          end
+          prepend mod
+        end
+      end
+
+      # @api private
+      def self.chain_capture_timing(klass, method_name, label)
+        args = method_signature
+        visibility = method_visibility(klass, method_name)
 
-        define_method(method_name) do |*args|
-          Airbrake::Rack.capture_timing(label) do
-            __send__("#{method_name}_without_airbrake", *args)
+        # Generate the wrapper method.
+        aliased = method_name.to_s.sub(/([?!=])$/, '')
+        punctuation = Regexp.last_match(1)
+        wrapped_method_name = "#{aliased}_without_airbrake#{punctuation}"
+        needs_removal = method_needs_removal(klass, method_name)
+        klass.module_exec do
+          alias_method wrapped_method_name, method_name
+          remove_method method_name if needs_removal
+          # rubocop:disable Style/DocumentDynamicEvalDefinition
+          module_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def #{method_name}(#{args})
+              Airbrake::Rack.capture_timing(#{label.to_s.inspect}) do
+                __send__("#{aliased}_without_airbrake#{punctuation}", #{args})
+              end
+            end
+            #{visibility} :#{method_name}
+          RUBY
+          # rubocop:enable Style/DocumentDynamicEvalDefinition
+        end
+      end
+
+      # @api private
+      def self.method_visibility(klass, method_name)
+        klass.module_exec do
+          if protected_method_defined?(method_name)
+            "protected"
+          elsif private_method_defined?(method_name)
+            "private"
+          else
+            "public"
           end
         end
       end
+
+      # @api private
+      # A method instead of a constant so it isn't accessible in the target.
+      if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.7")
+        def self.method_signature
+          "*args, **kw_args, &block"
+        end
+      else
+        def self.method_signature
+          "*args, &block"
+        end
+      end
+
+      # @api private
+      if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.6")
+        def self.method_needs_removal(klass, method_name)
+          klass.method_defined?(method_name, false) ||
+            klass.private_method_defined?(method_name, false)
+        end
+      else
+        def self.method_needs_removal(klass, method_name)
+          klass.instance_methods(false).include?(method_name) ||
+            klass.private_instance_methods(false).include?(method_name)
+        end
+      end
     end
   end
 end

data/lib/airbrake/rack/middleware.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Airbrake
   module Rack
     # Airbrake Rack middleware for Rails and Sinatra applications (or any other

data/lib/airbrake/rack/request_body_filter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Airbrake
   module Rack
     # A filter that appends Rack request body to the notice.

data/lib/airbrake/rack/request_store.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Airbrake
   module Rack
     # RequestStore is a thin (and limited) wrapper around *Thread.current* that

data/lib/airbrake/rack/route_filter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'airbrake/rails/app'
 
 module Airbrake
@@ -26,12 +28,14 @@ module Airbrake
 
       def rails_route(request)
         return unless (route = Airbrake::Rails::App.recognize_route(request))
+
         route.path
       end
 
       def sinatra_route(request)
         return unless (route = request.env['sinatra.route'])
-        route.split(' ').drop(1).join(' ')
+
+        route.split.drop(1).join(' ')
       end
 
       def action_dispatch_request?(request)

data/lib/airbrake/rack/session_filter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Airbrake
   module Rack
     # Adds HTTP session.

data/lib/airbrake/rack/user.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Airbrake
   module Rack
     # Represents an authenticated user, which can be converted to Airbrake's
@@ -26,6 +28,7 @@ module Airbrake
         controller = rack_env['action_controller.instance']
         return unless controller.respond_to?(:current_user, true)
         return unless [-1, 0].include?(controller.method(:current_user).arity)
+
         begin
           controller.__send__(:current_user)
         rescue Exception => _e # rubocop:disable Lint/RescueException
@@ -57,6 +60,7 @@ module Airbrake
         # try methods with no arguments or with variable number of arguments,
         # where none of them are required
         return unless @user.method(key).arity.between?(-1, 0)
+
         String(@user.__send__(key))
       end
 

data/lib/airbrake/rack/user_filter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Airbrake
   module Rack
     # Adds current user information.

data/lib/airbrake/rack.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'airbrake/rack/user'
 require 'airbrake/rack/user_filter'
 require 'airbrake/rack/context_filter'
@@ -16,6 +18,8 @@ module Airbrake
     # @since v9.2.0
     # @api public
     def self.capture_timing(label)
+      return yield unless Airbrake::Config.instance.performance_stats
+
       routes = Airbrake::Rack::RequestStore[:routes]
       if !routes || routes.none?
         result = yield

data/lib/airbrake/rails/action_cable/notify_callback.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Airbrake
   module Rails
     module ActionCable

data/lib/airbrake/rails/action_cable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'airbrake/rails/action_cable/notify_callback'
 
 %i[subscribe unsubscribe].each do |callback_name|
@@ -8,26 +10,28 @@ require 'airbrake/rails/action_cable/notify_callback'
   end
 end
 
-module ActionCable
-  module Channel
-    # @since v8.3.0
-    # @api private
-    # @see https://github.com/rails/rails/blob/master/actioncable/lib/action_cable/channel/base.rb
-    class Base
-      alias perform_action_without_airbrake perform_action
+module Airbrake
+  module ActionCable
+    module Channel
+      # @since v8.3.0
+      # @api private
+      # @see https://github.com/rails/rails/blob/master/actioncable/lib/action_cable/channel/base.rb
+      module Base
+        def perform_action(*args, &block)
+          super(*args, &block)
+        rescue Exception => ex # rubocop:disable Lint/RescueException
+          Airbrake.notify(ex) do |notice|
+            notice.stash[:action_cable_connection] = connection
+            notice[:context][:component] = self.class
+            notice[:context][:action] = args.first['action']
+            notice[:params].merge!(args.first)
+          end
 
-      def perform_action(*args, &block)
-        perform_action_without_airbrake(*args, &block)
-      rescue Exception => ex # rubocop:disable Lint/RescueException
-        Airbrake.notify(ex) do |notice|
-          notice.stash[:action_cable_connection] = connection
-          notice[:context][:component] = self.class
-          notice[:context][:action] = args.first['action']
-          notice[:params].merge!(args.first)
+          raise ex
         end
-
-        raise ex
       end
     end
   end
 end
+
+ActionCable::Channel::Base.prepend(Airbrake::ActionCable::Channel::Base)

data/lib/airbrake/rails/action_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Airbrake
   module Rails
     # Contains helper methods that can be used inside Rails controllers to send
@@ -12,6 +14,7 @@ module Airbrake
       # @see Airbrake#notify, #notify_airbrake_sync
       def notify_airbrake(exception, params = {}, &block)
         return unless (notice = build_notice(exception, params))
+
         Airbrake.notify(notice, params, &block)
       end
 
@@ -20,6 +23,7 @@ module Airbrake
       # @see Airbrake#notify_sync, #notify_airbrake
       def notify_airbrake_sync(exception, params = {}, &block)
         return unless (notice = build_notice(exception, params))
+
         Airbrake.notify_sync(notice, params, &block)
       end
 
@@ -27,6 +31,7 @@ module Airbrake
       # @return [Airbrake::Notice] the notice with information from the Rack env
       def build_notice(exception, params = {})
         return unless (notice = Airbrake.build_notice(exception, params))
+
         notice.stash[:rack_request] = request
         notice
       end

data/lib/airbrake/rails/action_controller_notify_subscriber.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'airbrake/rails/event'
 
 module Airbrake
@@ -8,6 +10,8 @@ module Airbrake
     # @since v8.0.0
     class ActionControllerNotifySubscriber
       def call(*args)
+        return unless Airbrake::Config.instance.performance_stats
+
         routes = Airbrake::Rack::RequestStore[:routes]
         return if !routes || routes.none?
 

data/lib/airbrake/rails/action_controller_performance_breakdown_subscriber.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'airbrake/rails/event'
 
 module Airbrake
@@ -5,6 +7,8 @@ module Airbrake
     # @since v8.3.0
     class ActionControllerPerformanceBreakdownSubscriber
       def call(*args)
+        return unless Airbrake::Config.instance.performance_stats
+
         routes = Airbrake::Rack::RequestStore[:routes]
         return if !routes || routes.none?
 

data/lib/airbrake/rails/action_controller_route_subscriber.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'airbrake/rails/event'
 require 'airbrake/rails/app'
 
@@ -9,6 +11,8 @@ module Airbrake
     # @since v8.0.0
     class ActionControllerRouteSubscriber
       def call(*args)
+        return unless Airbrake::Config.instance.performance_stats
+
         # We don't track routeless events.
         return unless (routes = Airbrake::Rack::RequestStore[:routes])
 

data/lib/airbrake/rails/active_job.rb

@@ -1,18 +1,12 @@
+# frozen_string_literal: true
+
 module Airbrake
   module Rails
     # Enables support for exceptions occurring in ActiveJob jobs.
     module ActiveJob
       extend ActiveSupport::Concern
 
-      # @return [Array<Regexp>] the list of known adapters
-      ADAPTERS = [/Resque/, /Sidekiq/, /DelayedJob/].freeze
-
       def self.notify_airbrake(exception, job)
-        queue_adapter = job.class.queue_adapter.to_s
-
-        # Do not notify twice if a queue_adapter is configured already.
-        raise exception if ADAPTERS.any? { |a| a =~ queue_adapter }
-
         notice = Airbrake.build_notice(exception)
         notice[:context][:component] = 'active_job'
         notice[:context][:action] = job.class.name
@@ -28,14 +22,14 @@ module Airbrake
           block.call
         end
       rescue StandardError => exception
-        Airbrake.notify_queue_sync(
+        Airbrake.notify_queue(
           queue: job.class.name,
           error_count: 1,
           timing: 0.01,
         )
         raise exception
       else
-        Airbrake.notify_queue_sync(
+        Airbrake.notify_queue(
           queue: job.class.name,
           error_count: 0,
           timing: timing,

data/lib/airbrake/rails/active_record.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Airbrake
   module Rails
     # Rails <4.2 has a bug with regard to swallowing exceptions in the

data/lib/airbrake/rails/active_record_subscriber.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'airbrake/rails/event'
 require 'airbrake/rails/backtrace_cleaner'
 
@@ -8,6 +10,8 @@ module Airbrake
     # @since v8.1.0
     class ActiveRecordSubscriber
       def call(*args)
+        return unless Airbrake::Config.instance.query_stats
+
         routes = Airbrake::Rack::RequestStore[:routes]
         return if !routes || routes.none?