sentry-rails 4.2.1 → 4.3.3.pre.beta.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab83fdc945ddfb3c5dbd4a38c34c8748acfc9745f5f9bbf39e47c188778760b6
-  data.tar.gz: 05ac3bde183e9615d292c2c978224b06567347c4b461cd8281d4f308d2b61bdc
+  metadata.gz: 0eb34ee9c167f2366fce7bdacec1876ac5735bc8cce4c587c5d40f353ab1e897
+  data.tar.gz: 4b652a985aeae4fdf14181b4b3f5a46c7d4b0c4168241aa85efd6cb3f09fd957
 SHA512:
-  metadata.gz: 28819d457892ae94280d5f6f5ec44e23eeec4d52f338b68ccc31ccd5f090b63a560eb9b72b626c1bb011288e9beb0e3762eb14229a6b689d8f957aaf7a0ea867
-  data.tar.gz: 2e095079c8ea3e1f8ad552bbe0c94a0a93a87c199832cb19de2beaa242cacea95383bca18529316133949f4ba807fe0b1898783a36db26aacca74eac8c0fcf79
+  metadata.gz: 24fb610289426dc62e67447b4c27b7746b4dfca7283a908888ac53afdf572eb0f7071201776ae8dae3a07cde4d07ce487924ebc28639eca496ef590201fd885f
+  data.tar.gz: 13e584471a08019ececbf409c4e4283aace72e20a18b9b0a7e74f7fdf6ea38a1d027944d92bd8514d959e6d8361c8b6ae3c3a8dc1840e29a2dfa19f8df718480

data/.gitignore

@@ -5,6 +5,7 @@
 /doc/
 /pkg/
 /spec/reports/
+/spec/support/test_rails_app/db
 /tmp/
 
 # rspec failure tracking

data/CHANGELOG.md

@@ -1,5 +1,34 @@
 # Changelog
 
+## 4.3.3-beta.0
+
+- Minimize sentry-rails' dependency requirement [#1352](https://github.com/getsentry/sentry-ruby/pull/1352)
+
+## 4.3.2
+
+- Avoid recording SendEventJob's transaction [#1351](https://github.com/getsentry/sentry-ruby/pull/1351)
+  - Fixes [#1348](https://github.com/getsentry/sentry-ruby/issues/1348)
+
+## 4.3.1
+
+- Only apply background worker patch if ActiveRecord is loaded [#1350](https://github.com/getsentry/sentry-ruby/pull/1350)
+  - Fixes [#1342](https://github.com/getsentry/sentry-ruby/issues/1342) and [#1346](https://github.com/getsentry/sentry-ruby/issues/1346)
+
+## 4.3.0
+
+### Features
+
+- Support performance monitoring on ActiveJob execution [#1304](https://github.com/getsentry/sentry-ruby/pull/1304)
+
+### Bug Fixes
+
+- Prevent background workers from holding ActiveRecord connections [#1320](https://github.com/getsentry/sentry-ruby/pull/1320)
+
+## 4.2.2
+
+- Always define Sentry::SendEventJob to avoid eager load issues [#1286](https://github.com/getsentry/sentry-ruby/pull/1286)
+  - Fixes [#1283](https://github.com/getsentry/sentry-ruby/issues/1283)
+
 ## 4.2.1
 
 - Add additional checks to SendEventJob's definition [#1275](https://github.com/getsentry/sentry-ruby/pull/1275)

data/Gemfile

@@ -17,11 +17,13 @@ end
 
 gem "rails", "~> #{rails_version}"
 gem "sprockets-rails"
+
+gem "rspec", "~> 3.0"
+gem "rspec-retry"
 gem "rspec-rails", "~> 4.0"
 gem "codecov", "0.2.12"
 
 gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"
 
 # TODO: Remove this if https://github.com/jruby/jruby/issues/6547 is addressed
 gem "i18n", "<= 1.8.7"

data/app/jobs/sentry/send_event_job.rb

@@ -1,30 +1,39 @@
-return unless defined?(ActiveJob)
-
-module Sentry
-  parent_job =
-    if defined?(::ApplicationJob) && ::ApplicationJob.ancestors.include?(::ActiveJob::Base)
-      ::ApplicationJob
-    else
-      ::ActiveJob::Base
-    end
+if defined?(ActiveJob)
+  module Sentry
+    parent_job =
+      if defined?(::ApplicationJob) && ::ApplicationJob.ancestors.include?(::ActiveJob::Base)
+        ::ApplicationJob
+      else
+        ::ActiveJob::Base
+      end
 
-  class SendEventJob < parent_job
-    # the event argument is usually large and creates noise
-    self.log_arguments = false if respond_to?(:log_arguments=)
+    class SendEventJob < parent_job
+      # the event argument is usually large and creates noise
+      self.log_arguments = false if respond_to?(:log_arguments=)
 
-    # this will prevent infinite loop when there's an issue deserializing SentryJob
-    if respond_to?(:discard_on)
-      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}."
+      # this will prevent infinite loop when there's an issue deserializing SentryJob
+      if respond_to?(:discard_on)
+        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}."
+        end
       end
-    end
 
-    def perform(event, hint = {})
-      Sentry.send_event(event, hint)
+      def perform(event, hint = {})
+        # users don't need the tracing result of this job
+        if transaction = Sentry.get_current_scope.span
+          transaction.instance_variable_set(:@sampled, false)
+        end
+
+        Sentry.send_event(event, hint)
+      end
     end
   end
+else
+  module Sentry
+    class SendEventJob; end
+  end
 end
 

data/lib/sentry/rails.rb

@@ -1,3 +1,4 @@
+require "rails"
 require "sentry-ruby"
 require "sentry/integrable"
 require "sentry/rails/configuration"

data/lib/sentry/rails/active_job.rb

@@ -8,8 +8,8 @@ module Sentry
               if already_supported_by_specific_integration?(job)
                 block.call
               else
-                Sentry.with_scope do
-                  capture_and_reraise_with_sentry(job, block)
+                Sentry.with_scope do |scope|
+                  capture_and_reraise_with_sentry(job, scope, block)
                 end
               end
             else
@@ -19,10 +19,18 @@ module Sentry
         end
       end
 
-      def capture_and_reraise_with_sentry(job, block)
+      def capture_and_reraise_with_sentry(job, scope, block)
+        scope.set_transaction_name(job.class.name)
+        transaction = Sentry.start_transaction(name: scope.transaction_name, op: "active_job")
+
+        scope.set_span(transaction) if transaction
+
         block.call
+
+        finish_transaction(transaction, 200)
       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
 
         Sentry::Rails.capture_exception(
@@ -36,6 +44,13 @@ module Sentry
         raise e
       end
 
+      def finish_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)
       end

data/lib/sentry/rails/background_worker.rb

@@ -0,0 +1,12 @@
+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
+      end
+    end
+  end
+end

data/lib/sentry/rails/capture_exceptions.rb

@@ -29,11 +29,16 @@ module Sentry
         Sentry::Rails.capture_exception(exception)
       end
 
-      def finish_span(span, status_code)
-        if @assets_regex.nil? || !span.name.match?(@assets_regex)
-          span.set_http_status(status_code)
-          span.finish
+      def start_transaction(env, scope)
+        transaction = super
+
+        return unless transaction
+
+        if @assets_regex && transaction.name.match?(@assets_regex)
+          transaction.instance_variable_set(:@sampled, false)
         end
+
+        transaction
       end
     end
   end

data/lib/sentry/rails/railtie.rb

@@ -1,11 +1,6 @@
-require "rails"
 require "sentry/rails/capture_exceptions"
 require "sentry/rails/rescued_exception_interceptor"
 require "sentry/rails/backtrace_cleaner"
-require "sentry/rails/controller_methods"
-require "sentry/rails/controller_transaction"
-require "sentry/rails/overrides/streaming_reporter"
-require "sentry/rails/overrides/file_handler"
 
 module Sentry
   class Railtie < ::Rails::Railtie
@@ -23,10 +18,11 @@ module Sentry
       configure_project_root
       configure_sentry_logger
       configure_trusted_proxies
-      extend_controller_methods
+      extend_controller_methods if defined?(ActionController)
       extend_active_job if defined?(ActiveJob)
-      override_streaming_reporter
-      override_file_handler if app.config.public_file_server.enabled
+      patch_background_worker if defined?(ActiveRecord)
+      override_streaming_reporter if defined?(ActionView)
+      override_file_handler if defined?(ActionDispatch) && app.config.public_file_server.enabled
       setup_backtrace_cleanup_callback
       inject_breadcrumbs_logger
       activate_tracing
@@ -50,6 +46,10 @@ module Sentry
     end
 
     def extend_controller_methods
+      require "sentry/rails/controller_methods"
+      require "sentry/rails/controller_transaction"
+      require "sentry/rails/overrides/streaming_reporter"
+
       ActiveSupport.on_load :action_controller do
         include Sentry::Rails::ControllerMethods
         include Sentry::Rails::ControllerTransaction
@@ -57,6 +57,10 @@ module Sentry
       end
     end
 
+    def patch_background_worker
+      require "sentry/rails/background_worker"
+    end
+
     def inject_breadcrumbs_logger
       if Sentry.configuration.breadcrumbs_logger.include?(:active_support_logger)
         require 'sentry/rails/breadcrumb/active_support_logger'
@@ -73,12 +77,16 @@ module Sentry
     end
 
     def override_streaming_reporter
+      require "sentry/rails/overrides/streaming_reporter"
+
       ActiveSupport.on_load :action_view do
         ActionView::StreamingTemplateRenderer::Body.send(:prepend, Sentry::Rails::Overrides::StreamingReporter)
       end
     end
 
     def override_file_handler
+      require "sentry/rails/overrides/file_handler"
+
       ActiveSupport.on_load :action_controller do
         ActionDispatch::FileHandler.send(:prepend, Sentry::Rails::Overrides::FileHandler)
       end

data/lib/sentry/rails/version.rb

@@ -1,5 +1,5 @@
 module Sentry
   module Rails
-    VERSION = "4.2.1"
+    VERSION = "4.3.3-beta.0"
   end
 end

data/sentry-rails.gemspec

@@ -22,6 +22,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "rails", ">= 5.0"
-  spec.add_dependency "sentry-ruby-core", "~> 4.2.0"
+  spec.add_dependency "railties", ">= 5.0"
+  spec.add_dependency "sentry-ruby-core", "~> 4.3.0"
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: sentry-rails
 version: !ruby/object:Gem::Version
-  version: 4.2.1
+  version: 4.3.3.pre.beta.0
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-10 00:00:00.000000000 Z
+date: 2021-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 4.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 4.3.0
 description: A gem that provides Rails integration for the Sentry error logger
 email: accounts@sentry.io
 executables: []
@@ -62,6 +62,7 @@ files:
 - lib/sentry-rails.rb
 - lib/sentry/rails.rb
 - lib/sentry/rails/active_job.rb
+- lib/sentry/rails/background_worker.rb
 - lib/sentry/rails/backtrace_cleaner.rb
 - lib/sentry/rails/breadcrumb/active_support_logger.rb
 - lib/sentry/rails/capture_exceptions.rb
@@ -98,9 +99,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.3
 signing_key: