sentry-rails 4.7.2 → 5.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 601a533a33e665e2a7b470eead7e2598827189e985903fb78c0391d9a446ddeb
-  data.tar.gz: e33f1dae2e5d5305432f8fcec69bd26daef8217adf582e6d6747ab1bdb79b112
+  metadata.gz: dbb2adfc21656bba09244e0895c88a20f58e2401fcb5d4b693f48d10319c9121
+  data.tar.gz: 6e2c595d8d719208524bfa270d6aa0e8d2123c60b80923fe05323f93bb29f98f
 SHA512:
-  metadata.gz: e459f55b49f1b468ee151f5094e3e2bcc28ba6289f86ec83e69c00b2205c37982f34f4922c3c97af72a02902379c61b3a7bb2cb30cf6f6d8972fc2dbba70eeb2
-  data.tar.gz: 794f8644fe6499cdeeb7bba75e9bf899629afe77ebbd0daca6dd587b8270b53c386f5bbcdae393d747341d3c758983520546e519aecfe23f6c31d94371e76375
+  metadata.gz: b3af907f32e77d292f5d86b99bfa5d62e580118e4971f940eb07278951147a9e53b4680926d436833d69548b0872eb560cb2c73dc44361b86ab2e951271d9519
+  data.tar.gz: daad9ecf642f47a149ff2065ee3ce79e56ab33b2379b477f60d86c85ca051c8e0c4cc924c1c68786bdb015b7eac4e998c336b8d5ad0883fe0f11050586fc1103

data/Gemfile

@@ -5,18 +5,24 @@ gemspec
 gem "sentry-ruby", path: "../sentry-ruby"
 
 rails_version = ENV["RAILS_VERSION"]
-rails_version = "6.1.0" if rails_version.nil?
+rails_version = "7.0.0" if rails_version.nil?
+rails_version = Gem::Version.new(rails_version)
 
 gem 'activerecord-jdbcmysql-adapter', platform: :jruby
 gem "jdbc-sqlite3", platform: :jruby
 
-if rails_version.to_f < 6
+if rails_version < Gem::Version.new("6.0.0")
   gem "sqlite3", "~> 1.3.0", platform: :ruby
 else
   gem "sqlite3", platform: :ruby
 end
 
-gem "rails", "~> #{rails_version}"
+if rails_version >= Gem::Version.new("7.0.0")
+  gem "rails", github: "rails/rails", branch: "7-0-stable"
+else
+  gem "rails", "~> #{rails_version}"
+end
+
 gem "sprockets-rails"
 
 gem "sidekiq"
@@ -24,12 +30,14 @@ gem "sidekiq"
 gem "rspec", "~> 3.0"
 gem "rspec-retry"
 gem "rspec-rails", "~> 4.0"
-gem "codecov", "0.2.12"
+gem 'simplecov'
+gem "simplecov-cobertura", "~> 1.4"
+gem "rexml"
 
 gem "rake", "~> 12.0"
 
 gem "object_tracer"
-gem "debug", github: "ruby/debug" if RUBY_VERSION.to_f >= 2.6
+gem "debug", github: "ruby/debug", platform: :ruby if RUBY_VERSION.to_f >= 2.6
 gem "pry"
 
 gem "benchmark-ips"

data/app/jobs/sentry/send_event_job.rb

@@ -16,8 +16,8 @@ if defined?(ActiveJob)
         discard_on ActiveJob::DeserializationError
       else
         # mimic what discard_on does for Rails 5.0
-        rescue_from ActiveJob::DeserializationError do
-          logger.error "Discarded #{self.class} due to a #{exception}. The original exception was #{error.cause.inspect}."
+        rescue_from ActiveJob::DeserializationError do |exception|
+          logger.error "Discarded #{self.class} due to a #{exception}. The original exception was #{exception.cause.inspect}."
         end
       end
 

data/lib/sentry/rails/action_cable.rb

@@ -0,0 +1,96 @@
+module Sentry
+  module Rails
+    module ActionCableExtensions
+      class ErrorHandler
+        class << self
+          def capture(connection, transaction_name:, extra_context: nil, &block)
+            return block.call unless Sentry.initialized?
+            # ActionCable's ConnectionStub (for testing) doesn't implement the exact same interfaces as Connection::Base.
+            # One thing that's missing is `env`. So calling `connection.env` direclty will fail in test environments when `stub_connection` is used.
+            # See https://github.com/getsentry/sentry-ruby/pull/1684 for more information.
+            env = connection.respond_to?(:env) ? connection.env : {}
+
+            Sentry.with_scope do |scope|
+              scope.set_rack_env(env)
+              scope.set_context("action_cable", extra_context) if extra_context
+              scope.set_transaction_name(transaction_name)
+              transaction = start_transaction(env, scope.transaction_name)
+              scope.set_span(transaction) if transaction
+
+              begin
+                block.call
+                finish_transaction(transaction, 200)
+              rescue Exception => e # rubocop:disable Lint/RescueException
+                Sentry::Rails.capture_exception(e)
+                finish_transaction(transaction, 500)
+
+                raise
+              end
+            end
+          end
+
+          def start_transaction(env, transaction_name)
+            sentry_trace = env["HTTP_SENTRY_TRACE"]
+            options = { name: transaction_name, op: "rails.action_cable".freeze }
+            transaction = Sentry::Transaction.from_sentry_trace(sentry_trace, **options) if sentry_trace
+            Sentry.start_transaction(transaction: transaction, **options)
+          end
+
+          def finish_transaction(transaction, status_code)
+            return unless transaction
+
+            transaction.set_http_status(status_code)
+            transaction.finish
+          end
+        end
+      end
+
+      module Connection
+        private
+
+        def handle_open
+          ErrorHandler.capture(self, transaction_name: "#{self.class.name}#connect") do
+            super
+          end
+        end
+
+        def handle_close
+          ErrorHandler.capture(self, transaction_name: "#{self.class.name}#disconnect") do
+            super
+          end
+        end
+      end
+
+      module Channel
+        module Subscriptions
+          def self.included(base)
+            base.class_eval do
+              set_callback :subscribe, :around, ->(_, block) { sentry_capture(:subscribed, &block) }, prepend: true
+              set_callback :unsubscribe, :around, ->(_, block) { sentry_capture(:unsubscribed, &block) }, prepend: true
+            end
+          end
+
+          private
+
+          def sentry_capture(hook, &block)
+            extra_context = { params: params }
+
+            ErrorHandler.capture(connection, transaction_name: "#{self.class.name}##{hook}", extra_context: extra_context, &block)
+          end
+        end
+
+        module Actions
+          private
+
+          def dispatch_action(action, data)
+            extra_context = { params: params, data: data }
+
+            ErrorHandler.capture(connection, transaction_name: "#{self.class.name}##{action}", extra_context: extra_context) do
+              super
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sentry/rails/active_job.rb

@@ -1,28 +1,22 @@
 module Sentry
   module Rails
     module ActiveJobExtensions
-      def self.included(base)
-        base.class_eval do
-          around_perform do |job, block|
-            if Sentry.initialized?
-              if already_supported_by_specific_integration?(job)
-                block.call
-              else
-                Sentry.with_scope do |scope|
-                  capture_and_reraise_with_sentry(job, scope, block)
-                end
-              end
-            else
-              block.call
+      def perform_now
+        if !Sentry.initialized? || already_supported_by_sentry_integration?
+          super
+        else
+          Sentry.with_scope do |scope|
+            capture_and_reraise_with_sentry(scope) do
+              super
             end
           end
         end
       end
 
-      def capture_and_reraise_with_sentry(job, scope, block)
-        scope.set_transaction_name(job.class.name)
+      def capture_and_reraise_with_sentry(scope, &block)
+        scope.set_transaction_name(self.class.name)
         transaction =
-          if job.is_a?(::Sentry::SendEventJob)
+          if is_a?(::Sentry::SendEventJob)
             nil
           else
             Sentry.start_transaction(name: scope.transaction_name, op: "active_job")
@@ -30,50 +24,46 @@ module Sentry
 
         scope.set_span(transaction) if transaction
 
-        block.call
+        return_value = block.call
 
-        finish_transaction(transaction, 200)
+        finish_sentry_transaction(transaction, 200)
+
+        return_value
       rescue Exception => e # rubocop:disable Lint/RescueException
-        rescue_handler_result = rescue_with_handler(e)
-        finish_transaction(transaction, 500)
-        return rescue_handler_result if rescue_handler_result
+        finish_sentry_transaction(transaction, 500)
 
         Sentry::Rails.capture_exception(
           e,
-          extra: sentry_context(job),
+          extra: sentry_context,
           tags: {
-            job_id: job.job_id,
-            provider_job_id: job.provider_job_id
+            job_id: job_id,
+            provider_job_id:provider_job_id
           }
         )
         raise e
       end
 
-      def finish_transaction(transaction, status)
+      def finish_sentry_transaction(transaction, status)
         return unless transaction
 
         transaction.set_http_status(status)
         transaction.finish
       end
 
-      def already_supported_by_specific_integration?(job)
-        Sentry.configuration.rails.skippable_job_adapters.include?(job.class.queue_adapter.class.to_s)
+      def already_supported_by_sentry_integration?
+        Sentry.configuration.rails.skippable_job_adapters.include?(self.class.queue_adapter.class.to_s)
       end
 
-      def sentry_context(job)
+      def sentry_context
         {
-          active_job: job.class.name,
-          arguments: job.arguments,
-          scheduled_at: job.scheduled_at,
-          job_id: job.job_id,
-          provider_job_id: job.provider_job_id,
-          locale: job.locale
+          active_job: self.class.name,
+          arguments: arguments,
+          scheduled_at: scheduled_at,
+          job_id: job_id,
+          provider_job_id: provider_job_id,
+          locale: locale
         }
       end
     end
   end
 end
-
-class ActiveJob::Base
-  include Sentry::Rails::ActiveJobExtensions
-end

data/lib/sentry/rails/background_worker.rb

@@ -1,11 +1,9 @@
 module Sentry
   class BackgroundWorker
-    def perform(&block)
-      @executor.post do
-        # make sure the background worker returns AR connection if it accidentally acquire one during serialization
-        ActiveRecord::Base.connection_pool.with_connection do
-          block.call
-        end
+    def _perform(&block)
+      # make sure the background worker returns AR connection if it accidentally acquire one during serialization
+      ActiveRecord::Base.connection_pool.with_connection do
+        block.call
       end
     end
   end

data/lib/sentry/rails/configuration.rb

@@ -1,6 +1,7 @@
 require "sentry/rails/tracing/action_controller_subscriber"
 require "sentry/rails/tracing/action_view_subscriber"
 require "sentry/rails/tracing/active_record_subscriber"
+require "sentry/rails/tracing/active_storage_subscriber"
 
 module Sentry
   class Configuration
@@ -59,7 +60,8 @@ module Sentry
         @tracing_subscribers = Set.new([
           Sentry::Rails::Tracing::ActionControllerSubscriber,
           Sentry::Rails::Tracing::ActionViewSubscriber,
-          Sentry::Rails::Tracing::ActiveRecordSubscriber
+          Sentry::Rails::Tracing::ActiveRecordSubscriber,
+          Sentry::Rails::Tracing::ActiveStorageSubscriber
         ])
       end
     end

data/lib/sentry/rails/instrument_payload_cleanup_helper.rb

@@ -1,7 +1,7 @@
 module Sentry
   module Rails
     module InstrumentPayloadCleanupHelper
-      IGNORED_DATA_TYPES = [:request, :response, :headers, :exception, :exception_object]
+      IGNORED_DATA_TYPES = [:request, :response, :headers, :exception, :exception_object, Tracing::START_TIMESTAMP_NAME]
 
       def cleanup_data(data)
         IGNORED_DATA_TYPES.each do |key|

data/lib/sentry/rails/railtie.rb

@@ -7,7 +7,7 @@ module Sentry
     # middlewares can't be injected after initialize
     initializer "sentry.use_rack_middleware" do |app|
       # placed after all the file-sending middlewares so we can avoid unnecessary transactions
-      app.config.middleware.insert_after ActionDispatch::Executor, Sentry::Rails::CaptureExceptions
+      app.config.middleware.insert_after ActionDispatch::ShowExceptions, Sentry::Rails::CaptureExceptions
       # need to place as close to DebugExceptions as possible to intercept most of the exceptions, including those raised by middlewares
       app.config.middleware.insert_after ActionDispatch::DebugExceptions, Sentry::Rails::RescuedExceptionInterceptor
     end
@@ -22,6 +22,19 @@ module Sentry
       end
     end
 
+    initializer "sentry.extend_action_cable", before: :eager_load! do |app|
+      ActiveSupport.on_load(:action_cable_connection) do
+        require "sentry/rails/action_cable"
+        prepend Sentry::Rails::ActionCableExtensions::Connection
+      end
+
+      ActiveSupport.on_load(:action_cable_channel) do
+        require "sentry/rails/action_cable"
+        include Sentry::Rails::ActionCableExtensions::Channel::Subscriptions
+        prepend Sentry::Rails::ActionCableExtensions::Channel::Actions
+      end
+    end
+
     config.after_initialize do |app|
       next unless Sentry.initialized?
 

data/lib/sentry/rails/rescued_exception_interceptor.rb

@@ -11,22 +11,6 @@ module Sentry
         begin
           @app.call(env)
         rescue => e
-          request = ActionDispatch::Request.new(env)
-
-          # Rails' ShowExceptions#render_exception will mutate env for the exceptions app
-          # so we need to hold a copy of env to report the accurate data (like request's url)
-          if request.show_exceptions?
-            scope = Sentry.get_current_scope
-            copied_env = scope.rack_env.dup
-            copied_env["sentry.original_transaction"] = scope.transaction_name
-            scope.set_rack_env(copied_env)
-
-            if report_rescued_exceptions?
-              Sentry::Rails.capture_exception(e)
-              env["sentry.already_captured"] = true
-            end
-          end
-
           env["sentry.rescued_exception"] = e if report_rescued_exceptions?
           raise e
         end

data/lib/sentry/rails/tracing/abstract_subscriber.rb

@@ -9,22 +9,30 @@ module Sentry
           end
 
           def unsubscribe!
-            ActiveSupport::Notifications.unsubscribe(self::EVENT_NAME)
+            self::EVENT_NAMES.each do |name|
+              ActiveSupport::Notifications.unsubscribe(name)
+            end
           end
 
-          def subscribe_to_event(event_name)
-            if ::Rails.version.to_i == 5
-              ActiveSupport::Notifications.subscribe(event_name) do |*args|
-                next unless Tracing.get_current_transaction
+          if ::Rails.version.to_i == 5
+            def subscribe_to_event(event_names)
+              event_names.each do |event_name|
+                ActiveSupport::Notifications.subscribe(event_name) do |*args|
+                  next unless Tracing.get_current_transaction
 
-                event = ActiveSupport::Notifications::Event.new(*args)
-                yield(event_name, event.duration, event.payload)
+                  event = ActiveSupport::Notifications::Event.new(*args)
+                  yield(event_name, event.duration, event.payload)
+                end
               end
-            else
-              ActiveSupport::Notifications.subscribe(event_name) do |event|
-                next unless Tracing.get_current_transaction
-
-                yield(event_name, event.duration, event.payload)
+            end
+          else
+            def subscribe_to_event(event_names)
+              event_names.each do |event_name|
+                ActiveSupport::Notifications.subscribe(event_name) do |event|
+                  next unless Tracing.get_current_transaction
+
+                  yield(event_name, event.duration, event.payload)
+                end
               end
             end
           end

data/lib/sentry/rails/tracing/action_controller_subscriber.rb

@@ -7,16 +7,16 @@ module Sentry
       class ActionControllerSubscriber < AbstractSubscriber
         extend InstrumentPayloadCleanupHelper
 
-        EVENT_NAME = "process_action.action_controller".freeze
+        EVENT_NAMES = ["process_action.action_controller"].freeze
 
         def self.subscribe!
-          subscribe_to_event(EVENT_NAME) do |event_name, duration, payload|
+          subscribe_to_event(EVENT_NAMES) do |event_name, duration, payload|
             controller = payload[:controller]
             action = payload[:action]
 
             record_on_current_span(
               op: event_name,
-              start_timestamp: payload[:start_timestamp],
+              start_timestamp: payload[START_TIMESTAMP_NAME],
               description: "#{controller}##{action}",
               duration: duration
             ) do |span|

data/lib/sentry/rails/tracing/action_view_subscriber.rb

@@ -4,11 +4,11 @@ module Sentry
   module Rails
     module Tracing
       class ActionViewSubscriber < AbstractSubscriber
-        EVENT_NAME = "render_template.action_view".freeze
+        EVENT_NAMES = ["render_template.action_view"].freeze
 
         def self.subscribe!
-          subscribe_to_event(EVENT_NAME) do |event_name, duration, payload|
-            record_on_current_span(op: event_name, start_timestamp: payload[:start_timestamp], description: payload[:identifier], duration: duration)
+          subscribe_to_event(EVENT_NAMES) do |event_name, duration, payload|
+            record_on_current_span(op: event_name, start_timestamp: payload[START_TIMESTAMP_NAME], description: payload[:identifier], duration: duration)
           end
         end
       end

data/lib/sentry/rails/tracing/active_record_subscriber.rb

@@ -4,14 +4,14 @@ module Sentry
   module Rails
     module Tracing
       class ActiveRecordSubscriber < AbstractSubscriber
-        EVENT_NAME = "sql.active_record".freeze
+        EVENT_NAMES = ["sql.active_record"].freeze
         EXCLUDED_EVENTS = ["SCHEMA", "TRANSACTION"].freeze
 
         def self.subscribe!
-          subscribe_to_event(EVENT_NAME) do |event_name, duration, payload|
+          subscribe_to_event(EVENT_NAMES) do |event_name, duration, payload|
             next if EXCLUDED_EVENTS.include? payload[:name]
 
-            record_on_current_span(op: event_name, start_timestamp: payload[:start_timestamp], description: payload[:sql], duration: duration) do |span|
+            record_on_current_span(op: event_name, start_timestamp: payload[START_TIMESTAMP_NAME], description: payload[:sql], duration: duration) do |span|
               span.set_data(:connection_id, payload[:connection_id])
             end
           end

data/lib/sentry/rails/tracing/active_storage_subscriber.rb

@@ -0,0 +1,34 @@
+require "sentry/rails/tracing/abstract_subscriber"
+
+module Sentry
+  module Rails
+    module Tracing
+      class ActiveStorageSubscriber < AbstractSubscriber
+        EVENT_NAMES = %w(
+          service_upload.active_storage
+          service_download.active_storage
+          service_streaming_download.active_storage
+          service_download_chunk.active_storage
+          service_delete.active_storage
+          service_delete_prefixed.active_storage
+          service_exist.active_storage
+          service_url.active_storage
+          service_mirror.active_storage
+          service_update_metadata.active_storage
+          preview.active_storage
+          analyze.active_storage
+        ).freeze
+
+        def self.subscribe!
+          subscribe_to_event(EVENT_NAMES) do |event_name, duration, payload|
+            record_on_current_span(op: event_name, start_timestamp: payload[START_TIMESTAMP_NAME], description: payload[:service], duration: duration) do |span|
+              payload.each do |key, value|
+                span.set_data(key, value) unless key == START_TIMESTAMP_NAME
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sentry/rails/tracing.rb

@@ -1,6 +1,8 @@
 module Sentry
   module Rails
     module Tracing
+      START_TIMESTAMP_NAME = :sentry_start_timestamp
+
       def self.register_subscribers(subscribers)
         @subscribers = subscribers
       end
@@ -9,11 +11,19 @@ module Sentry
         @subscribers
       end
 
+      def self.subscribed_tracing_events
+        @subscribed_tracing_events ||= []
+      end
+
       def self.subscribe_tracing_events
         # need to avoid duplicated subscription
         return if @subscribed
 
-        subscribers.each(&:subscribe!)
+        subscribers.each do |subscriber|
+          subscriber.subscribe!
+          @subscribed_tracing_events ||= []
+          @subscribed_tracing_events += subscriber::EVENT_NAMES
+        end
 
         @subscribed = true
       end
@@ -22,6 +32,7 @@ module Sentry
         return unless @subscribed
 
         subscribers.each(&:unsubscribe!)
+        subscribed_tracing_events.clear
 
         @subscribed = false
       end
@@ -35,9 +46,10 @@ module Sentry
 
         SentryNotificationExtension.module_eval do
           def instrument(name, payload = {}, &block)
-            is_public_event = name[0] != "!"
-
-            payload[:start_timestamp] = Time.now.utc.to_f if is_public_event
+            # only inject timestamp to the events the SDK subscribes to
+            if Tracing.subscribed_tracing_events.include?(name)
+              payload[START_TIMESTAMP_NAME] = Time.now.utc.to_f if name[0] != "!" && payload.is_a?(Hash)
+            end
 
             super(name, payload, &block)
           end

data/lib/sentry/rails/version.rb

@@ -1,5 +1,5 @@
 module Sentry
   module Rails
-    VERSION = "4.7.2"
+    VERSION = "5.0.2"
   end
 end

data/lib/sentry/rails.rb

@@ -1,10 +1,10 @@
 require "rails"
 require "sentry-ruby"
 require "sentry/integrable"
+require "sentry/rails/tracing"
 require "sentry/rails/configuration"
 require "sentry/rails/engine"
 require "sentry/rails/railtie"
-require "sentry/rails/tracing"
 
 module Sentry
   module Rails

data/sentry-rails.gemspec

@@ -23,5 +23,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "railties", ">= 5.0"
-  spec.add_dependency "sentry-ruby-core", "~> 4.7.0"
+  spec.add_dependency "sentry-ruby-core", "~> 5.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-rails
 version: !ruby/object:Gem::Version
-  version: 4.7.2
+  version: 5.0.2
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-09 00:00:00.000000000 Z
+date: 2022-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.7.0
+        version: 5.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.7.0
+        version: 5.0.2
 description: A gem that provides Rails integration for the Sentry error logger
 email: accounts@sentry.io
 executables: []
@@ -60,6 +60,7 @@ files:
 - bin/setup
 - lib/sentry-rails.rb
 - lib/sentry/rails.rb
+- lib/sentry/rails/action_cable.rb
 - lib/sentry/rails/active_job.rb
 - lib/sentry/rails/background_worker.rb
 - lib/sentry/rails/backtrace_cleaner.rb
@@ -79,6 +80,7 @@ files:
 - lib/sentry/rails/tracing/action_controller_subscriber.rb
 - lib/sentry/rails/tracing/action_view_subscriber.rb
 - lib/sentry/rails/tracing/active_record_subscriber.rb
+- lib/sentry/rails/tracing/active_storage_subscriber.rb
 - lib/sentry/rails/version.rb
 - sentry-rails.gemspec
 homepage: https://github.com/getsentry/sentry-ruby