sentry-rails 5.2.1 → 5.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8abb9b42e0bad172e91125577c9e675687a6b4a2b1a905c83258fcbc1b1b4402
-  data.tar.gz: '095d6e8fbc545a88ecc6ec0d4a8e2cd046e0d1cfa4816e13cfa5b1f40b656d5d'
+  metadata.gz: ea442f30a8d61b36170660802c51be9e98ffd3591d5298e6a17a39556dcfba5f
+  data.tar.gz: '079dbb354bc8c43a25308fb84a63bfedfe67d51aa5c4265ed78441dd39e989e9'
 SHA512:
-  metadata.gz: 84fdcf91056c8502fa63880a0d456e3677adafa15c7df35c7a1949249623d07c0217fa9286c3edda6ce7f1dcb0f096f48f25bbb54555e598124f67652b168576
-  data.tar.gz: e91d36c193548d10575a3e45c1023c1eb4d7628ded62f604d1659fd9589a5f5ed450592bc3d50ea64fbdc8517385ab439d547e80e8031382e8120b5f3af7dd25
+  metadata.gz: 10116c6cad137020fcbb2569ce0f6d3e57311e28e69851f0ee8bf368c1a382bc8502545a4fd1ae9c8df29bf23495776a7ac4c78161f799c0aa4ee3661561a88c
+  data.tar.gz: b78500b50cad9faad612a8e085f4263bcac024b59fda04457751fc3fe85deae1557af6cde9c5a5c820bab7e9427c1fcb7a31ca2149369e08c8fccc41686ab535

data/Gemfile

@@ -18,12 +18,14 @@ else
   gem "sqlite3", platform: :ruby
 end
 
-if rails_version >= Gem::Version.new("7.0.0")
-  gem "rails", github: "rails/rails", branch: "7-0-stable"
+if rails_version > Gem::Version.new("7.0.0")
+  gem "rails", github: "rails/rails"
 else
   gem "rails", "~> #{rails_version}"
 end
 
+gem "mini_magick"
+
 gem "sprockets-rails"
 
 gem "sidekiq"

data/lib/sentry/rails/background_worker.rb

@@ -1,10 +1,10 @@
 module Sentry
   class BackgroundWorker
     def _perform(&block)
+      block.call
+    ensure
       # 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
+      ActiveRecord::Base.connection_pool.release_connection
     end
   end
 end

data/lib/sentry/rails/capture_exceptions.rb

@@ -20,14 +20,21 @@ module Sentry
         "rails.request".freeze
       end
 
-      def capture_exception(exception)
+      def capture_exception(exception, env)
+        request = ActionDispatch::Request.new(env)
+
+        # the exception will be swallowed by ShowExceptions middleware
+        return if request.show_exceptions? && !Sentry.configuration.rails.report_rescued_exceptions
+
         current_scope = Sentry.get_current_scope
 
-        if original_transaction = current_scope.rack_env["sentry.original_transaction"]
+        if original_transaction = env["sentry.original_transaction"]
           current_scope.set_transaction_name(original_transaction)
         end
 
-        Sentry::Rails.capture_exception(exception)
+        Sentry::Rails.capture_exception(exception).tap do |event|
+          env[ERROR_EVENT_ID_KEY] = event.event_id if event
+        end
       end
 
       def start_transaction(env, scope)
@@ -39,7 +46,7 @@ module Sentry
         end
 
         transaction = Sentry::Transaction.from_sentry_trace(sentry_trace, **options) if sentry_trace
-        Sentry.start_transaction(transaction: transaction, **options)
+        Sentry.start_transaction(transaction: transaction, custom_sampling_context: { env: env }, **options)
       end
     end
   end

data/lib/sentry/rails/configuration.rb

@@ -42,6 +42,12 @@ module Sentry
       'ActiveRecord::RecordNotFound'
     ].freeze
     class Configuration
+      # Rails 7.0 introduced a new error reporter feature, which the SDK once opted-in by default.
+      # But after receiving multiple issue reports, the integration seemed to cause serious troubles to some users.
+      # So the integration is now controlled by this configuration, which is disabled (false) by default.
+      # More information can be found from: https://github.com/rails/rails/pull/43625#issuecomment-1072514175
+      attr_accessor :register_error_subscriber
+
       # Rails catches exceptions in the ActionDispatch::ShowExceptions or
       # ActionDispatch::DebugExceptions middlewares, depending on the environment.
       # When `rails_report_rescued_exceptions` is true (it is by default), Sentry
@@ -55,6 +61,7 @@ module Sentry
       attr_accessor :tracing_subscribers
 
       def initialize
+        @register_error_subscriber = false
         @report_rescued_exceptions = true
         @skippable_job_adapters = []
         @tracing_subscribers = Set.new([

data/lib/sentry/rails/error_subscriber.rb

@@ -3,8 +3,17 @@ module Sentry
     # This is not a user-facing class. You should use it with Rails 7.0's error reporter feature and its interfaces.
     # See https://github.com/rails/rails/blob/main/activesupport/lib/active_support/error_reporter.rb for more information.
     class ErrorSubscriber
-      def report(error, handled:, severity:, context:)
-        Sentry::Rails.capture_exception(error, level: severity, contexts: { "rails.error" => context }, tags: { handled: handled })
+      SKIP_SOURCES = Regexp.union([/.*_cache_store.active_support/])
+
+      def report(error, handled:, severity:, context:, source: nil)
+        tags = { handled: handled }
+
+        if source
+          return if SKIP_SOURCES.match?(source)
+          tags[:source] = source
+        end
+
+        Sentry::Rails.capture_exception(error, level: severity, contexts: { "rails.error" => context }, tags: tags)
       end
     end
   end

data/lib/sentry/rails/railtie.rb

@@ -47,12 +47,17 @@ module Sentry
       inject_breadcrumbs_logger
       activate_tracing
 
-      register_error_subscriber(app) if ::Rails.version.to_f >= 7.0
+      register_error_subscriber(app) if ::Rails.version.to_f >= 7.0 && Sentry.configuration.rails.register_error_subscriber
     end
 
     runner do
       next unless Sentry.initialized?
       Sentry.configuration.background_worker_threads = 0
+
+      at_exit do
+        # TODO: Add a condition for Rails 7.1 to avoid confliction with https://github.com/rails/rails/pull/44999
+        Sentry::Rails.capture_exception($ERROR_INFO, tags: { source: "runner" }) if $ERROR_INFO
+      end
     end
 
     def configure_project_root

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

@@ -40,15 +40,12 @@ module Sentry
           def record_on_current_span(duration:, **options)
             return unless options[:start_timestamp]
 
-            scope = Sentry.get_current_scope
-            transaction = scope.get_transaction
-            return unless transaction && transaction.sampled
-
-            span = transaction.start_child(**options)
-            # duration in ActiveSupport is computed in millisecond
-            # so we need to covert it as second before calculating the timestamp
-            span.set_timestamp(span.start_timestamp + duration / 1000)
-            yield(span) if block_given?
+            Sentry.with_child_span(**options) do |child_span|
+              # duration in ActiveSupport is computed in millisecond
+              # so we need to covert it as second before calculating the timestamp
+              child_span.set_timestamp(child_span.start_timestamp + duration / 1000)
+              yield(child_span) if block_given?
+            end
           end
         end
       end

data/lib/sentry/rails/version.rb

@@ -1,5 +1,5 @@
 module Sentry
   module Rails
-    VERSION = "5.2.1"
+    VERSION = "5.4.0"
   end
 end

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", "~> 5.2.1"
+  spec.add_dependency "sentry-ruby", "~> 5.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-rails
 version: !ruby/object:Gem::Version
-  version: 5.2.1
+  version: 5.4.0
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-18 00:00:00.000000000 Z
+date: 2022-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -25,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: sentry-ruby-core
+  name: sentry-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.2.1
+        version: 5.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.2.1
+        version: 5.4.0
 description: A gem that provides Rails integration for the Sentry error logger
 email: accounts@sentry.io
 executables: []