sentry-rails 4.2.0 → 4.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88b2f50f7497ed668cc86fda80d8bbd653e3e01b3a7d3c3f7643e5de81de697c
-  data.tar.gz: e2ee2b20c9a85f947f4fcfe4f5c68b82226336aa54c73b5c116e767307bb4cd0
+  metadata.gz: 71d4bb2da0b6b6702dd19f4af1587d708d1cd74dabff09bb1419544851de273b
+  data.tar.gz: 306860e508e67cd7ba564dac54111c9bfac796ff6e7a96092cdba22e03c4336b
 SHA512:
-  metadata.gz: 1c86549b0348fec623ed863f9f11147d6cf04c20a7c8cd4ba96755959084f8d8436a8ee768edf5011230b7dfe62155aafcca7f1aaebf298a30d2dff1799c9310
-  data.tar.gz: f6ee86657ef5960e22fe72c826b86ee0992a16769416429ab791821b2d974672ebe83d3c8fead135554ad2acdda6c0f59ad4a1c291d0ae3e6e7dc8d1584dfee4
+  metadata.gz: 5ef3910fbe7c2ab373e0642949d7d82babb83e0569cdd7481e423346fa89b26b26426d9175137e0293be99152c27489978ac4c02d29539de5ef0e386f4b31bcc
+  data.tar.gz: b36840b16c8c46ddc1e8d5036135a250f5d2f391cbc94916b85dda206fd17b68194192625d0c4a89e86ae0ef8e5ba8288083e897eb533bfa8c7f5303650de04b

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,38 @@
 # Changelog
 
+## 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)
+- 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.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)
+  - Fixes [#1270](https://github.com/getsentry/sentry-ruby/issues/1270)
+  - Fixes [#1277](https://github.com/getsentry/sentry-ruby/issues/1277)
+
 ## 4.2.0
 
 ### Features

data/Gemfile

@@ -8,15 +8,22 @@ rails_version = "6.1.0" if rails_version.nil?
 
 gem 'activerecord-jdbcmysql-adapter', platform: :jruby
 gem "jdbc-sqlite3", platform: :jruby
-gem "sqlite3", platform: :ruby
+
+if rails_version.to_f < 6
+  gem "sqlite3", "~> 1.3.0", platform: :ruby
+else
+  gem "sqlite3", platform: :ruby
+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,20 +1,39 @@
-return unless defined?(ActiveJob)
+if defined?(ActiveJob)
+  module Sentry
+    parent_job =
+      if defined?(::ApplicationJob) && ::ApplicationJob.ancestors.include?(::ActiveJob::Base)
+        ::ApplicationJob
+      else
+        ::ActiveJob::Base
+      end
 
-module Sentry
-  parent_job =
-    if defined?(ApplicationJob)
-      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=)
+
+      # 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
 
-  class SendEventJob < parent_job
-    self.log_arguments = false if ::Rails.version.to_f >= 6.1
-    discard_on ActiveJob::DeserializationError # this will prevent infinite loop when there's an issue deserializing SentryJob
+      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
 
-    def perform(event, hint = {})
-      Sentry.send_event(event, hint)
+        Sentry.send_event(event, hint)
+      end
     end
   end
+else
+  module Sentry
+    class SendEventJob; end
+  end
 end
 

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

@@ -25,6 +25,7 @@ module Sentry
       configure_trusted_proxies
       extend_controller_methods
       extend_active_job if defined?(ActiveJob)
+      patch_background_worker if defined?(ActiveRecord)
       override_streaming_reporter
       override_file_handler if app.config.public_file_server.enabled
       setup_backtrace_cleanup_callback
@@ -57,6 +58,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'

data/lib/sentry/rails/version.rb

@@ -1,5 +1,5 @@
 module Sentry
   module Rails
-    VERSION = "4.2.0"
+    VERSION = "4.3.2"
   end
 end

data/sentry-rails.gemspec

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-rails
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 4.3.2
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-04 00:00:00.000000000 Z
+date: 2021-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -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