airbrake 13.0.0 → 13.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a07739c02f3e1221ca95e82f58fd79a36a94419144079db6eec8a935b5f8bfad
-  data.tar.gz: 9e4da0976faf90b479903503fb00aa6f21b7bb469089c1795d6019ed5b001d4a
+  metadata.gz: 668e709e9a773bc589715b99f9843ce37c1af8b307551e718c7cbe9f00966398
+  data.tar.gz: 00637f796a64e51709bd2db34f3bc22845d264e21ca9938c1499571e3920025d
 SHA512:
-  metadata.gz: 4954a38023b2bd13afeef26690701876ab90141e7f552a020ce32f6182a5352d1211bba9d7f9965ebafc0603f444c1caeb1d282ef15e291ccec10298a5504e84
-  data.tar.gz: 9bcb90f9b3d621c2be1d3a653be9a434831f42399035af8eb57c8eac94c6f4c00d40d3bc2b8335794460b122277e0a9cee18cd44a57757ee492146188fc89054
+  metadata.gz: e21c16eb3577a99831676f048f7c6543694954eefe17b1115ca6796caab1d88f3fc1610474c69ba98b32f8aad661d5738091ed34442c1b37ec121d62b03ed5e0
+  data.tar.gz: 56677458f588058a4313e93ace216ac6475fb5d8c5d0bd0557e86105e0884296c55450d45930a7f2d91e95d6fe1be7d4a4b325937455fea6bc2d2d59568eda9a

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/rails/action_controller_notify_subscriber.rb

@@ -9,6 +9,10 @@ module Airbrake
     #
     # @since v8.0.0
     class ActionControllerNotifySubscriber
+      def initialize(rails_vsn)
+        @rails_7_or_above = rails_vsn.to_i >= 7
+      end
+
       def call(*args)
         return unless Airbrake::Config.instance.performance_stats
 
@@ -23,7 +27,16 @@ module Airbrake
             route: route,
             status_code: event.status_code,
             timing: event.duration,
-            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
+            time: @rails_7_or_above ? event.time / 1000 : event.time,
           )
         end
       end

data/lib/airbrake/rails/railtie.rb

@@ -5,37 +5,10 @@ module Airbrake
     # 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.
-    #
-    # rubocop:disable Metrics/BlockLength
     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
+        require 'airbrake/rails/railties/middleware_tie'
+        Railties::MiddlewareTie.new(app).call
       end
 
       rake_tasks do
@@ -47,82 +20,13 @@ module Airbrake
       end
 
       initializer('airbrake.action_controller') do
-        ActiveSupport.on_load(:action_controller, run_once: true) 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
-
-          # 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)
-          require 'airbrake/rails/curb' if defined?(Curl) && defined?(Curl::CURB_VERSION)
-          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)
-
-          if defined?(Excon)
-            require 'airbrake/rails/excon_subscriber'
-            ActiveSupport::Notifications.subscribe(/excon/, Airbrake::Rails::Excon.new)
-            ::Excon.defaults[:instrumentor] = ActiveSupport::Notifications
-          end
-        end
+        require 'airbrake/rails/railties/action_controller_tie'
+        Railties::ActionControllerTie.new.call
       end
 
       initializer('airbrake.active_record') do
-        ActiveSupport.on_load(:active_record, run_once: true) do
-          # Reports exceptions occurring in some bugged ActiveRecord callbacks.
-          # Applicable only to the versions of Rails lower than 4.2.
-          if defined?(::Rails) &&
-             Gem::Version.new(::Rails.version) <= Gem::Version.new('4.2')
-            require 'airbrake/rails/active_record'
-            include Airbrake::Rails::ActiveRecord
-          end
-
-          if defined?(ActiveRecord)
-            # 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.
-            if ::ActiveRecord::Base.respond_to?(:connection_db_config)
-              # Rails 6.1+ deprecates "connection_config" in favor of
-              # "connection_db_config", so we need an updated call.
-              Airbrake.add_performance_filter(
-                Airbrake::Filters::SqlFilter.new(
-                  ::ActiveRecord::Base.connection_db_config.configuration_hash[:adapter],
-                ),
-              )
-            else
-              Airbrake.add_performance_filter(
-                Airbrake::Filters::SqlFilter.new(
-                  ::ActiveRecord::Base.connection_config[:adapter],
-                ),
-              )
-            end
-          end
-        end
+        require 'airbrake/rails/railties/active_record_tie'
+        Railties::ActiveRecordTie.new.call
       end
 
       initializer('airbrake.active_job') do
@@ -146,6 +50,5 @@ module Airbrake
         end
       end
     end
-    # rubocop:enable Metrics/BlockLength
   end
 end

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

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require 'airbrake/rails/action_controller'
+require 'airbrake/rails/action_controller_route_subscriber'
+require 'airbrake/rails/action_controller_notify_subscriber'
+require 'airbrake/rails/action_controller_performance_breakdown_subscriber'
+
+module Airbrake
+  module Rails
+    module Railties
+      # Ties Airbrake APM (routes) and HTTP clients with Rails.
+      #
+      # @api private
+      # @since v13.0.1
+      class ActionControllerTie
+        def initialize
+          @route_subscriber = Airbrake::Rails::ActionControllerRouteSubscriber.new
+          @notify_subscriber = Airbrake::Rails::ActionControllerNotifySubscriber.new(
+            ::Rails.version,
+          )
+          @performance_breakdown_subscriber =
+            Airbrake::Rails::ActionControllerPerformanceBreakdownSubscriber.new
+        end
+
+        def call
+          ActiveSupport.on_load(:action_controller, run_once: true, yield: self) do
+            # Patches ActionController with methods that allow us to retrieve
+            # interesting request data. Appends that information to notices.
+            ::ActionController::Base.include(Airbrake::Rails::ActionController)
+
+            tie_routes_apm
+            tie_http_integrations
+          end
+        end
+
+        private
+
+        def tie_routes_apm
+          [
+            # Cache route information for the duration of the request.
+            ['start_processing.action_controller', @route_subscriber],
+
+            # Send route stats.
+            ['process_action.action_controller', @notify_subscriber],
+
+            # Send performance breakdown: where a request spends its time.
+            ['process_action.action_controller', @performance_breakdown_subscriber],
+          ].each do |(event, callback)|
+            ActiveSupport::Notifications.subscribe(event, callback)
+          end
+        end
+
+        def tie_http_integrations
+          tie_net_http
+          tie_curl
+          tie_http
+          tie_http_client
+          tie_typhoeus
+          tie_excon
+        end
+
+        def tie_net_http
+          require 'airbrake/rails/net_http' if defined?(Net) && defined?(Net::HTTP)
+        end
+
+        def tie_curl
+          require 'airbrake/rails/curb' if defined?(Curl) && defined?(Curl::CURB_VERSION)
+        end
+
+        def tie_http
+          require 'airbrake/rails/http' if defined?(HTTP) && defined?(HTTP::Client)
+        end
+
+        def tie_http_client
+          require 'airbrake/rails/http_client' if defined?(HTTPClient)
+        end
+
+        def tie_typhoeus
+          require 'airbrake/rails/typhoeus' if defined?(Typhoeus)
+        end
+
+        def tie_excon
+          return unless defined?(Excon)
+
+          require 'airbrake/rails/excon_subscriber'
+          ActiveSupport::Notifications.subscribe(/excon/, Airbrake::Rails::Excon.new)
+          ::Excon.defaults[:instrumentor] = ActiveSupport::Notifications
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require 'airbrake/rails/active_record'
+require 'airbrake/rails/active_record_subscriber'
+
+module Airbrake
+  module Rails
+    module Railties
+      # Ties Airbrake APM (queries) with Rails.
+      #
+      # @api private
+      # @since v13.0.1
+      class ActiveRecordTie
+        def initialize
+          @active_record_subscriber = Airbrake::Rails::ActiveRecordSubscriber.new
+        end
+
+        def call
+          ActiveSupport.on_load(:active_record, run_once: true, yield: self) do
+            tie_activerecord_callback_fix
+            tie_activerecord_apm
+          end
+        end
+
+        private
+
+        def tie_activerecord_callback_fix
+          # Reports exceptions occurring in some bugged ActiveRecord callbacks.
+          # Applicable only to the versions of Rails lower than 4.2.
+          return unless defined?(::Rails)
+          return if Gem::Version.new(::Rails.version) > Gem::Version.new('4.2')
+
+          ActiveRecord::Base.include(Airbrake::Rails::ActiveRecord)
+        end
+
+        def tie_activerecord_apm
+          # Some Rails apps don't use ActiveRecord.
+          return unless defined?(::ActiveRecord)
+
+          # However, some dependencies might still require it, so we need an
+          # extra check. Apps that don't need ActiveRecord will likely have no
+          # AR configurations defined. We will skip APM integration in that
+          # case. See: https://github.com/airbrake/airbrake/issues/1222
+          configurations = ::ActiveRecord::Base.configurations
+          return unless configurations.any?
+
+          # Send SQL queries.
+          ActiveSupport::Notifications.subscribe(
+            'sql.active_record',
+            @active_record_subscriber,
+          )
+
+          # Filter out parameters from SQL body.
+          sql_filter = Airbrake::Filters::SqlFilter.new(
+            detect_activerecord_adapter(configurations),
+          )
+          Airbrake.add_performance_filter(sql_filter)
+        end
+
+        # Rails 6+ introduces the `configs_for` API instead of the deprecated
+        # `#[]`, so we need an updated call.
+        def detect_activerecord_adapter(configurations)
+          unless configurations.respond_to?(:configs_for)
+            return configurations[::Rails.env]['adapter']
+          end
+
+          cfg = configurations.configs_for(env_name: ::Rails.env).first
+          # Rails 7+ API : Rails 6 API.
+          cfg.respond_to?(:adapter) ? cfg.adapter : cfg.config['adapter']
+        end
+      end
+    end
+  end
+end

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_with_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/rake/tasks.rb

@@ -53,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
@@ -68,7 +68,7 @@ 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}`
@@ -89,7 +89,7 @@ namespace :airbrake do
            " 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."

data/lib/airbrake/version.rb

@@ -3,5 +3,5 @@
 # We use Semantic Versioning v2.0.0
 # More information: http://semver.org/
 module Airbrake
-  AIRBRAKE_VERSION = '13.0.0'
+  AIRBRAKE_VERSION = '13.0.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: airbrake
 version: !ruby/object:Gem::Version
-  version: 13.0.0
+  version: 13.0.1
 platform: ruby
 authors:
 - Airbrake Technologies, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-18 00:00:00.000000000 Z
+date: 2022-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: airbrake-ruby
@@ -335,6 +335,9 @@ files:
 - lib/airbrake/rails/http_client.rb
 - lib/airbrake/rails/net_http.rb
 - lib/airbrake/rails/railtie.rb
+- lib/airbrake/rails/railties/action_controller_tie.rb
+- lib/airbrake/rails/railties/active_record_tie.rb
+- lib/airbrake/rails/railties/middleware_tie.rb
 - lib/airbrake/rails/typhoeus.rb
 - lib/airbrake/rake.rb
 - lib/airbrake/rake/tasks.rb