sentry-rails 7.1.0 → 7.2.0

data/gemfiles/ruby-jruby-9.4.14.0_rails-7.1.0.gemfile.lock

@@ -6,7 +6,7 @@ GIT
 PATH
   remote: ../../sentry-ruby
   specs:
-    sentry-ruby (7.0.0)
+    sentry-ruby (7.1.0)
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
       logger
@@ -14,9 +14,9 @@ PATH
 PATH
   remote: ..
   specs:
-    sentry-rails (7.0.0)
+    sentry-rails (7.1.0)
       railties (>= 5.2.0)
-      sentry-ruby (~> 7.0.0)
+      sentry-ruby (~> 7.1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -119,8 +119,8 @@ GEM
     cgi (0.5.2-java)
     concurrent-ruby (1.3.8)
     connection_pool (2.5.5)
-    crass (1.0.7)
-    date (3.5.1-java)
+    crass (1.0.8)
+    date (3.6.0-java)
     diff-lcs (1.6.2)
     docile (1.4.1)
     drb (2.2.3)
@@ -170,15 +170,15 @@ GEM
       net-protocol
     net-protocol (0.4.0)
       timeout
-    net-smtp (0.5.1)
+    net-smtp (0.5.2)
       net-protocol
     nio4r (2.7.5-java)
     nokogiri (1.18.10-java)
       racc (~> 1.4)
     pp (0.6.4)
       prettyprint
-    prettyprint (0.2.0)
-    prism (1.9.0)
+    prettyprint (0.2.1)
+    prism (2.0.0)
     psych (4.0.6-java)
       jar-dependencies (>= 0.1.7)
     raabro (1.5.0)
@@ -187,7 +187,7 @@ GEM
     rack-session (2.1.2)
       base64 (>= 0.1.0)
       rack (>= 3.0.0)
-    rack-test (2.2.0)
+    rack-test (2.3.0)
       rack (>= 1.3)
     rackup (2.3.1)
       rack (>= 3)
@@ -254,7 +254,7 @@ GEM
       rspec-core (> 3.3)
     rspec-support (3.13.7)
     securerandom (0.4.1)
-    sequel (5.108.0)
+    sequel (5.109.0)
       bigdecimal
     simplecov (0.22.0)
       docile (~> 1.1)
@@ -348,8 +348,8 @@ CHECKSUMS
   cgi (0.5.2-java) sha256=08bbfe06e10e771d36f10db6c1dfb81727ea2a25c3dbcd28d890a1794414a73d
   concurrent-ruby (1.3.8) sha256=b2f1be836e968ccc78ccfce277ea79c72a88633f22306782c16ff23fb415d1e1
   connection_pool (2.5.5) sha256=e54ff92855753df1fd7c59fa04a398833355f27dd14c074f8c83a05f72a716ad
-  crass (1.0.7) sha256=94868719948664c89ddcaf0a37c65048413dfcb1c869470a5f7a7ceb5390b295
-  date (3.5.1-java) sha256=12e09477dc932afe45bf768cd362bf73026804e0db1e6c314186d6cd0bee3344
+  crass (1.0.8) sha256=7a0145c7a2c59f8e7923b3a69ce819c444823a00a5127d805298fea13be24efe
+  date (3.6.0-java) sha256=7276986bbacc2357d0c6d41a863be5906e2f745ea2ccb47eed84bf761f6a7806
   diff-lcs (1.6.2) sha256=9ae0d2cba7d4df3075fe8cd8602a8604993efc0dfa934cff568969efb1909962
   docile (1.4.1) sha256=96159be799bfa73cdb721b840e9802126e4e03dfc26863db73647204c727f21e
   drb (2.2.3) sha256=0b00d6fdb50995fe4a45dea13663493c841112e4068656854646f418fda13373
@@ -377,18 +377,18 @@ CHECKSUMS
   net-imap (0.5.15) sha256=f64dc7f0b456d6a1b62007ead055994034f039f4aa6ff614e35f0b93395c0614
   net-pop (0.1.2) sha256=848b4e982013c15b2f0382792268763b748cce91c9e91e36b0f27ed26420dff3
   net-protocol (0.4.0) sha256=f9f90c8c6f64794a45160bf422177a336db12809de3beeeaa26b88fcd2e8c853
-  net-smtp (0.5.1) sha256=ed96a0af63c524fceb4b29b0d352195c30d82dd916a42f03c62a3a70e5b70736
+  net-smtp (0.5.2) sha256=35103cc04d6b2d94632f9928ede07483c24b70b9c0db1f231fea43909b678f3c
   nio4r (2.7.5-java) sha256=d14779d2a9b012ec0148a53344fbb2ed2a3c4d90c5dd923bf281135ab983b2c9
   nokogiri (1.18.10-java) sha256=cd431a09c45d84a2f870ba0b7e8f571199b3727d530f2b4888a73639f76510b5
   pp (0.6.4) sha256=dfcb0fce700c41456265922884f9fe195d7fbb0674a3578e6c0f69588e82b570
-  prettyprint (0.2.0) sha256=2bc9e15581a94742064a3cc8b0fb9d45aae3d03a1baa6ef80922627a0766f193
-  prism (1.9.0) sha256=7b530c6a9f92c24300014919c9dcbc055bf4cdf51ec30aed099b06cd6674ef85
+  prettyprint (0.2.1) sha256=d555d57ea6d7cf001d4774b693546a6bd88bec1e778ddffb5c60b68ceec4b7d4
+  prism (2.0.0) sha256=fd551446f0c6ca71455ef8d1d40bd2ca1538044834fa22df8837e5095f3a5a39
   psych (4.0.6-java) sha256=78f8708f8b139ee9b258c2f51b4d55dcccc8e7f567f728ba2f9868685bec8623
   raabro (1.5.0) sha256=3f998a7bc84f9c84df3ab580634d2e0a5bda4f0841168d56035f529c9877440a
   racc (1.8.1-java) sha256=54f2e6d1e1b91c154013277d986f52a90e5ececbe91465d29172e49342732b98
   rack (3.2.7) sha256=93e13e1c24f93556671d85d2d79fa228c3485815c50d7e2f265b5330c6528fb7
   rack-session (2.1.2) sha256=595434f8c0c3473ae7d7ac56ecda6cc6dfd9d37c0b2b5255330aa1576967ffe8
-  rack-test (2.2.0) sha256=005a36692c306ac0b4a9350355ee080fd09ddef1148a5f8b2ac636c720f5c463
+  rack-test (2.3.0) sha256=b118d177cc002c572fc1b6fd8d19c9ed5881a36e8d6f689f9e618f9f861241e8
   rackup (2.3.1) sha256=6c79c26753778e90983761d677a48937ee3192b3ffef6bc963c0950f94688868
   rails (7.1.6) sha256=9a0a335e510de3daad7542cd791af3d8ff710c644e1da17ed12e96d2f28a7470
   rails-dom-testing (2.3.0) sha256=8acc7953a7b911ca44588bf08737bc16719f431a1cc3091a292bca7317925c1d
@@ -406,9 +406,9 @@ CHECKSUMS
   rspec-retry (0.6.2) sha256=6101ba23a38809811ae3484acde4ab481c54d846ac66d5037ccb40131a60d858
   rspec-support (3.13.7) sha256=0640e5570872aafefd79867901deeeeb40b0c9875a36b983d85f54fb7381c47c
   securerandom (0.4.1) sha256=cc5193d414a4341b6e225f0cb4446aceca8e50d5e1888743fac16987638ea0b1
-  sentry-rails (7.0.0)
-  sentry-ruby (7.0.0)
-  sequel (5.108.0) sha256=ae5996d1196775427916a2fa36e02f99762ead9affb8ea9b1aec2c0b16bdb3a3
+  sentry-rails (7.1.0)
+  sentry-ruby (7.1.0)
+  sequel (5.109.0) sha256=e0d1d474442d620c8497d7f4851c0cc3a277920519051b8014b2877aa55efffe
   simplecov (0.22.0) sha256=fe2622c7834ff23b98066bb0a854284b2729a569ac659f82621fc22ef36213a5
   simplecov-cobertura (3.2.0) sha256=70d702658677fcb20e5aceb6915ccf8bc62ff2ccd38b62b3ad5c9db5c0888740
   simplecov-html (0.13.2) sha256=bd0b8e54e7c2d7685927e8d6286466359b6f16b18cb0df47b508e8d73c777246

data/lib/sentry/rails/active_job.rb

@@ -253,6 +253,7 @@ module Sentry
           # This handler does not capture error unless `active_job_report_on_retry_error` is true
           def retry_handler(*args)
             handle_error_event(*args) do |job, error|
+              return if error.nil?
               return if !Sentry.initialized? || job.already_supported_by_sentry_integration?
               return unless Sentry.configuration.rails.active_job_report_on_retry_error
 

data/lib/sentry/rails/configuration.rb

@@ -183,6 +183,11 @@ module Sentry
       # Defaults to true. Set to false to opt out.
       attr_accessor :active_job_propagate_traces
 
+      # Solid Queue recurring task keys to skip when the :solid_queue_recurring patch is enabled.
+      # Strings match the key exactly; Regexps are matched against it.
+      # @return [Array<String, Regexp>]
+      attr_accessor :solid_queue_exclude_recurring_tasks
+
       # Configuration for structured logging feature
       # @return [StructuredLoggingConfiguration]
       attr_reader :structured_logging
@@ -205,6 +210,7 @@ module Sentry
         @active_support_logger_subscription_items = Sentry::Rails::ACTIVE_SUPPORT_LOGGER_SUBSCRIPTION_ITEMS_DEFAULT.dup
         @active_job_report_on_retry_error = false
         @active_job_propagate_traces = true
+        @solid_queue_exclude_recurring_tasks = []
         @structured_logging = StructuredLoggingConfiguration.new
       end
     end

data/lib/sentry/rails/overrides/streaming_reporter.rb

@@ -4,6 +4,8 @@ module Sentry
   module Rails
     module Overrides
       module StreamingReporter
+        private
+
         def log_error(exception)
           Sentry::Rails.capture_exception(exception)
           super

data/lib/sentry/rails/railtie.rb

@@ -6,6 +6,11 @@ require "sentry/rails/backtrace_cleaner"
 
 module Sentry
   class Railtie < ::Rails::Railtie
+    # Referencing ActionController::Live loads ActionDispatch::Response, and Rails
+    # warns when that happens before the application has initialized. Rails 8.1.4
+    # added the :action_controller_live load hook so we can wait for it instead.
+    SUPPORTS_ACTION_CONTROLLER_LIVE_LOAD_HOOK = Gem::Version.new(::Rails.version) >= Gem::Version.new("8.1.4")
+
     # 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
@@ -99,7 +104,16 @@ module Sentry
       ActiveSupport.on_load :action_controller do
         include Sentry::Rails::ControllerMethods
         include Sentry::Rails::ControllerTransaction
-        ActionController::Live.send(:prepend, Sentry::Rails::Overrides::StreamingReporter)
+      end
+
+      if SUPPORTS_ACTION_CONTROLLER_LIVE_LOAD_HOOK
+        ActiveSupport.on_load :action_controller_live do
+          prepend Sentry::Rails::Overrides::StreamingReporter
+        end
+      else
+        ActiveSupport.on_load :action_controller do
+          ActionController::Live.send(:prepend, Sentry::Rails::Overrides::StreamingReporter)
+        end
       end
     end
 

data/lib/sentry/rails/solid_queue_recurring.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module Sentry
+  module Rails
+    # Sends Crons check-ins for Solid Queue recurring tasks.
+    # Enable with `config.enabled_patches << :solid_queue_recurring`.
+    module SolidQueueRecurring
+      PAYLOAD_KEY = "_sentry_recurring_task"
+      CURRENT_TASK = :sentry_solid_queue_recurring_task
+
+      module RecurringTask
+        def enqueue(at:)
+          Thread.current[CURRENT_TASK] = self unless Sentry::Rails::SolidQueueRecurring.excluded?(self)
+          super
+        ensure
+          Thread.current[CURRENT_TASK] = nil
+        end
+      end
+
+      module Job
+        def serialize
+          @_sentry_recurring_task ||= Sentry::Rails::SolidQueueRecurring.monitor_for(Thread.current[CURRENT_TASK], self)
+          payload = super
+          payload[PAYLOAD_KEY] = @_sentry_recurring_task if @_sentry_recurring_task
+          payload
+        end
+
+        def deserialize(job_data)
+          super
+          @_sentry_recurring_task = job_data[PAYLOAD_KEY]
+        end
+      end
+
+      class << self
+        def excluded?(task)
+          return false unless Sentry.initialized?
+
+          Array(Sentry.configuration.rails.solid_queue_exclude_recurring_tasks).any? { |pattern| pattern === task.key.to_s }
+        rescue StandardError => e
+          Sentry.sdk_logger.error(Sentry::LOGGER_PROGNAME) { "Could not check solid_queue_exclude_recurring_tasks for #{task.key}: #{e.class}: #{e.message}" }
+          false
+        end
+
+        # Runs in the scheduler, which is where Solid Queue evaluates the schedule.
+        def monitor_for(task, job)
+          return unless task && Sentry.initialized?
+          job_class = task.class_name.present? ? task.class_name.safe_constantize : task.class.default_job_class
+          return unless job.instance_of?(job_class)
+          return if job_class < Sentry::Cron::MonitorCheckIns::Patch
+
+          slug = Sentry::Cron::Slug.from(task.key)
+          return unless slug
+
+          config = Sentry::Cron::FugitSchedule.from_cron(cron_for(task))
+          { "slug" => slug, "crontab" => config&.schedule&.value, "timezone" => config&.timezone }.compact
+        rescue StandardError => e
+          Sentry.sdk_logger.error(Sentry::LOGGER_PROGNAME) { "Not monitoring Solid Queue recurring task #{task.key}: #{e.class}: #{e.message}" }
+          nil
+        end
+
+        def perform(job)
+          data = job.instance_variable_get(:@_sentry_recurring_task)
+          return yield unless data && Sentry.initialized?
+
+          slug = data["slug"]
+          if data["crontab"]
+            cron_config = Sentry.configuration.cron
+            monitor_config = Sentry::Cron::MonitorConfig.from_crontab(
+              data["crontab"],
+              timezone: data["timezone"],
+              checkin_margin: cron_config.default_checkin_margin,
+              max_runtime: cron_config.default_max_runtime
+            )
+          end
+
+          Sentry::Cron::MonitorCheckIns.with_check_in(slug, monitor_config: monitor_config) { yield }
+        end
+
+        def patch
+          return if @patched
+
+          @patched = true
+          ActiveSupport.on_load(:active_job) do
+            prepend Sentry::Rails::SolidQueueRecurring::Job
+            around_perform { |job, block| Sentry::Rails::SolidQueueRecurring.perform(job, &block) }
+          end
+
+          apply = proc do
+            if defined?(::SolidQueue::RecurringTask) && !(::SolidQueue::RecurringTask < Sentry::Rails::SolidQueueRecurring::RecurringTask)
+              ::SolidQueue::RecurringTask.prepend(Sentry::Rails::SolidQueueRecurring::RecurringTask)
+            end
+          end
+          ::Rails.application.reloader.to_prepare(&apply)
+          apply.call if ::Rails.application.initialized?
+        end
+
+        private
+
+        # Mirrors RecurringTask, which applies SolidQueue.time_zone to zoneless schedules.
+        def cron_for(task)
+          cron = ::Fugit.parse(task.schedule)
+          zone = ::SolidQueue.time_zone if ::SolidQueue.respond_to?(:time_zone)
+          return cron unless cron.is_a?(::Fugit::Cron) && cron.zone.nil? && zone.present?
+
+          ::Fugit.parse("#{cron.to_cron_s} #{zone}")
+        end
+      end
+    end
+  end
+end
+
+Sentry.register_patch(:solid_queue_recurring) do |config|
+  if defined?(::SolidQueue) && defined?(::Rails.application) && ::Rails.application
+    Sentry::Rails::SolidQueueRecurring.patch
+  else
+    config.sdk_logger.warn(Sentry::LOGGER_PROGNAME) { "You tried to enable the Solid Queue recurring task integration but the `solid_queue` gem was not detected." }
+  end
+end

data/lib/sentry/rails/version.rb

@@ -2,6 +2,6 @@
 
 module Sentry
   module Rails
-    VERSION = "7.1.0"
+    VERSION = "7.2.0"
   end
 end

data/lib/sentry/rails.rb

@@ -8,6 +8,7 @@ require "sentry/rails/configuration"
 require "sentry/rails/structured_logging"
 require "sentry/rails/engine"
 require "sentry/rails/railtie"
+require "sentry/rails/solid_queue_recurring"
 
 module Sentry
   module Rails

data/sentry-rails.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "railties", ">= 5.2.0"
-  spec.add_dependency "sentry-ruby", "~> 7.1.0"
+  spec.add_dependency "sentry-ruby", "~> 7.2.0"
 
   spec.post_install_message = <<~MSG
     Starting with sentry-rails 7.1.0, Rails structured logging is disabled by default.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sentry-rails
 version: !ruby/object:Gem::Version
-  version: 7.1.0
+  version: 7.2.0
 platform: ruby
 authors:
 - Sentry Team
@@ -29,14 +29,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 7.1.0
+        version: 7.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 7.1.0
+        version: 7.2.0
 description: A gem that provides Rails integration for the Sentry error logger
 email: accounts@sentry.io
 executables: []
@@ -116,6 +116,7 @@ files:
 - lib/sentry/rails/railtie.rb
 - lib/sentry/rails/rescued_exception_interceptor.rb
 - lib/sentry/rails/serializer.rb
+- lib/sentry/rails/solid_queue_recurring.rb
 - lib/sentry/rails/structured_logging.rb
 - lib/sentry/rails/tracing.rb
 - lib/sentry/rails/tracing/abstract_subscriber.rb
@@ -125,15 +126,15 @@ files:
 - lib/sentry/rails/tracing/active_support_subscriber.rb
 - lib/sentry/rails/version.rb
 - sentry-rails.gemspec
-homepage: https://github.com/getsentry/sentry-ruby/tree/7.1.0/sentry-rails
+homepage: https://github.com/getsentry/sentry-ruby/tree/7.2.0/sentry-rails
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/getsentry/sentry-ruby/tree/7.1.0/sentry-rails
-  source_code_uri: https://github.com/getsentry/sentry-ruby/tree/7.1.0/sentry-rails
-  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/7.1.0/CHANGELOG.md
+  homepage_uri: https://github.com/getsentry/sentry-ruby/tree/7.2.0/sentry-rails
+  source_code_uri: https://github.com/getsentry/sentry-ruby/tree/7.2.0/sentry-rails
+  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/7.2.0/CHANGELOG.md
   bug_tracker_uri: https://github.com/getsentry/sentry-ruby/issues
-  documentation_uri: http://www.rubydoc.info/gems/sentry-rails/7.1.0
+  documentation_uri: http://www.rubydoc.info/gems/sentry-rails/7.2.0
 post_install_message: |
   Starting with sentry-rails 7.1.0, Rails structured logging is disabled by default.
   Set `config.rails.structured_logging.enabled = true` to enable it.