airbrake 10.0.2 → 13.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5138c1675426cc908ae8b1857898ddc04c135fda23dfe21db19e6b1bf0b36faf
-  data.tar.gz: '085abd9125a9a615935ac2b1171cdfd74205bde892708e073bfbda44103c72ca'
+  metadata.gz: 4f91f4d04951002ed983c872b4d6042c1cc4c01ae609d3969b4b7e9b344bdf12
+  data.tar.gz: 58ee6fd62567a65f7df5178f6d0d9e6bd9cd58e9debbf62d9d75fa741b20b6d3
 SHA512:
-  metadata.gz: 39bc3cfe3510b0db2adece334666b4e753298fd4d09f4d7d445086c0512aa0436ec8c5b38a85933fae822efeea155d7d2bea7e25866e169878b6f1b330fb4d4d
-  data.tar.gz: 9c189959ccdfa6c30752462dffb49e8925df101f18597180ab6a31e2320a620431bcbcf6d66c83838d1acfd9be1b6c98623253e60cea77e8881fc84e5996aa14
+  metadata.gz: 6b464a25e936fafa269f35bb5c19ed6134ba65f4184f9d76e5f5a349370e1277dc71418393c21a8427dcecc572aabaa941a5ae41dbbfa1547fa280d1416fc630
+  data.tar.gz: a78fdeaba2521c51e47b4f9bbee5674b1d3228e25345e7d20cac5c3186c856c6c860a5daee82adc32f8001bce3b6422be50c31dbba32912f43dd535ba1dc965b

data/lib/airbrake/capistrano/capistrano2.rb

@@ -21,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

@@ -13,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/delayed_job.rb

@@ -7,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

@@ -9,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')
@@ -24,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

@@ -20,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']
@@ -60,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

@@ -8,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/instrumentable.rb

@@ -57,6 +57,7 @@ module Airbrake
         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
@@ -65,6 +66,7 @@ module Airbrake
               end
               #{visibility} :#{method_name}
             RUBY
+            # rubocop:enable Style/DocumentDynamicEvalDefinition
           end
           prepend mod
         end
@@ -83,6 +85,7 @@ module Airbrake
         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
@@ -91,6 +94,7 @@ module Airbrake
             end
             #{visibility} :#{method_name}
           RUBY
+          # rubocop:enable Style/DocumentDynamicEvalDefinition
         end
       end
 
@@ -98,11 +102,11 @@ module Airbrake
       def self.method_visibility(klass, method_name)
         klass.module_exec do
           if protected_method_defined?(method_name)
-            "protected".freeze
+            "protected"
           elsif private_method_defined?(method_name)
-            "private".freeze
+            "private"
           else
-            "public".freeze
+            "public"
           end
         end
       end
@@ -111,11 +115,11 @@ module Airbrake
       # 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".freeze
+          "*args, **kw_args, &block"
         end
       else
         def self.method_signature
-          "*args, &block".freeze
+          "*args, &block"
         end
       end
 

data/lib/airbrake/rack/route_filter.rb

@@ -28,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/user.rb

@@ -28,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
@@ -59,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.rb

@@ -18,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.rb

@@ -10,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

@@ -14,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
 
@@ -22,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
 
@@ -29,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

@@ -10,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

@@ -7,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

@@ -11,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

@@ -22,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_subscriber.rb

@@ -10,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?
 

data/lib/airbrake/rails/app.rb

@@ -11,12 +11,19 @@ module Airbrake
 
       # @param [] request
       # @return [Airbrake::Rails::App::Route, nil]
+      # rubocop:disable Metrics/AbcSize
       def self.recognize_route(request)
         # Duplicate `request` because `recognize` *can* strip the request's
         # `path_info`, which results in broken engine links (when the engine has
         # an isolated namespace).
         request_copy = request.dup
 
+        # Save original script name because `router.recognize(request)` mutates
+        # it. It's a Rails bug. More info in:
+        #   * https://github.com/airbrake/airbrake/issues/1072
+        #   * https://github.com/rails/rails/issues/31152
+        original_script_name = request.env['SCRIPT_NAME']
+
         # We must search every engine individually to find a concrete route. If
         # we rely only on the `Rails.application.routes.router`, then the
         # recognize call would return the root route, neglecting PATH_INFO
@@ -26,6 +33,20 @@ module Airbrake
         #   * `Marketing::Engine` recognizes it as `marketing#/pricing` (correct)
         engines.each do |engine|
           engine.routes.router.recognize(request_copy) do |route, _params|
+            # Restore original script name. Remove this code when/if the Rails
+            # bug is fixed: https://github.com/airbrake/airbrake/issues/1072
+            request.env['SCRIPT_NAME'] = original_script_name
+
+            # Skip "catch-all" routes such as:
+            #   get '*path => 'pages#about'
+            #
+            # Ideally, we should be using `route.glob?` but in Rails 7+ this
+            # call would fail with a `NoMethodError`. This is because in
+            # Rails 7+ the AST for the route is not kept in memory anymore.
+            #
+            # See: https://github.com/rails/rails/pull/43006#discussion_r783895766
+            next if route.path.spec.any?(ActionDispatch::Journey::Nodes::Star)
+
             path =
               if engine == ::Rails.application
                 route.path.spec.to_s
@@ -46,6 +67,7 @@ module Airbrake
 
         nil
       end
+      # rubocop:enable Metrics/AbcSize
 
       def self.engines
         @engines ||= [*::Rails::Engine.subclasses, ::Rails.application]

data/lib/airbrake/rails/backtrace_cleaner.rb

@@ -4,9 +4,20 @@ module Airbrake
   module Rails
     # BacktraceCleaner is a wrapper around Rails.backtrace_cleaner.
     class BacktraceCleaner
+      # @return [Regexp]
+      AIRBRAKE_FRAME_PATTERN = %r{/airbrake/lib/airbrake/}.freeze
+
       def self.clean(backtrace)
         ::Rails.backtrace_cleaner.clean(backtrace).first(1)
       end
     end
   end
 end
+
+if defined?(Rails)
+  # Silence own frames to let the cleaner proceed to the next line (and probably
+  # find the correct call-site coming from the app code rather this library).
+  Rails.backtrace_cleaner.add_silencer do |line|
+    line =~ Airbrake::Rails::BacktraceCleaner::AIRBRAKE_FRAME_PATTERN
+  end
+end

data/lib/airbrake/rails/curb.rb

@@ -1,37 +1,32 @@
 # frozen_string_literal: true
 
-module Curl
-  # Monkey-patch to measure request timing.
-  class Easy
-    alias http_without_airbrake http
-
-    def http(verb)
-      Airbrake::Rack.capture_timing(:http) do
-        http_without_airbrake(verb)
+module Airbrake
+  module Rails
+    # Allows measuring request timing.
+    module CurlEasy
+      def http(verb)
+        Airbrake::Rack.capture_timing(:http) do
+          super(verb)
+        end
       end
-    end
-
-    alias perform_without_airbrake perform
 
-    def perform(&block)
-      Airbrake::Rack.capture_timing(:http) do
-        perform_without_airbrake(&block)
+      def perform(&block)
+        Airbrake::Rack.capture_timing(:http) do
+          super(&block)
+        end
       end
     end
-  end
-end
-
-module Curl
-  # Monkey-patch to measure request timing.
-  class Multi
-    class << self
-      alias http_without_airbrake http
 
+    # Allows measuring request timing.
+    module CurlMulti
       def http(urls_with_config, multi_options = {}, &block)
         Airbrake::Rack.capture_timing(:http) do
-          http_without_airbrake(urls_with_config, multi_options, &block)
+          super(urls_with_config, multi_options, &block)
         end
       end
     end
   end
 end
+
+Curl::Easy.prepend(Airbrake::Rails::CurlEasy)
+Curl::Multi.singleton_class.prepend(Airbrake::Rails::CurlMulti)

data/lib/airbrake/rails/event.rb

@@ -8,12 +8,16 @@ module Airbrake
     # @api private
     class Event
       # @see https://github.com/rails/rails/issues/8987
-      HTML_RESPONSE_WILDCARD = "*/*".freeze
+      HTML_RESPONSE_WILDCARD = "*/*"
+
+      # @return [Integer]
+      MILLISECOND = 1000
 
       include Airbrake::Loggable
 
       def initialize(*args)
         @event = ActiveSupport::Notifications::Event.new(*args)
+        @rails_7_or_greater = ::Rails::VERSION::MAJOR >= 7
       end
 
       def method
@@ -42,7 +46,15 @@ module Airbrake
       end
 
       def time
-        @event.time
+        # On Rails 7+ `ActiveSupport::Notifications::Event#time` returns an
+        # instance of Float. It represents monotonic time in milliseconds.
+        # Airbrake Ruby expects that the provided time is in seconds. Hence,
+        # we need to convert it from milliseconds to seconds. In the
+        # versions below Rails 7, time is an instance of Time.
+        #
+        # Relevant commit:
+        # https://github.com/rails/rails/commit/81d0dc90becfe0b8e7f7f26beb66c25d84b8ec7f
+        @rails_7_or_greater ? @event.time / MILLISECOND : @event.time
       end
 
       def groups

data/lib/airbrake/rails/excon_subscriber.rb

@@ -8,6 +8,8 @@ module Airbrake
     # @since v9.2.0
     class Excon
       def call(*args)
+        return unless Airbrake::Config.instance.performance_stats
+
         routes = Airbrake::Rack::RequestStore[:routes]
         return if !routes || routes.none?
 

data/lib/airbrake/rails/http.rb

@@ -1,14 +1,18 @@
 # frozen_string_literal: true
 
-module HTTP
-  # Monkey-patch to measure request timing.
-  class Client
-    alias perform_without_airbrake perform
-
-    def perform(request, options)
-      Airbrake::Rack.capture_timing(:http) do
-        perform_without_airbrake(request, options)
+module Airbrake
+  module Rails
+    # Monkey-patch to measure request timing.
+    # @api private
+    # @since v11.0.2
+    module HTTP
+      def perform(request, options)
+        Airbrake::Rack.capture_timing(:http) do
+          super(request, options)
+        end
       end
     end
   end
 end
+
+HTTP::Client.prepend(Airbrake::Rails::HTTP)

data/lib/airbrake/rails/http_client.rb

@@ -1,12 +1,16 @@
 # frozen_string_literal: true
 
-# Monkey-patch to measure request timing.
-class HTTPClient
-  alias do_get_without_airbrake do_get_block
-
-  def do_get_block(request, proxy, connection, &block)
-    Airbrake::Rack.capture_timing(:http) do
-      do_get_without_airbrake(request, proxy, connection, &block)
+module Airbrake
+  module Rails
+    # Allows measuring request timing.
+    module HTTPClient
+      def do_get_block(request, proxy, connection, &block)
+        Airbrake::Rack.capture_timing(:http) do
+          super(request, proxy, connection, &block)
+        end
+      end
     end
   end
 end
+
+HTTPClient.prepend(Airbrake::Rails::HTTPClient)