sentry-sidekiq 5.3.1 → 5.16.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8732abbcde88b2a9399b0c4b81b1dda8837fb688b3de5c08138e53660c7d41c
-  data.tar.gz: 1e3a534cd890ad29e3cfe92696cd60fee88f1dd618b1c3e35a348c8c9e34e1c9
+  metadata.gz: 99c7773fed4941672765e6032cd6fa034ede2fa1af7ddcbe717d696e7e73f96d
+  data.tar.gz: c059026ff1fb540d7bb7b47ab358a842d1ef2473ae9a32b8114663bead468be0
 SHA512:
-  metadata.gz: 0cdbbcb530b5e91e37d85072ba2510788ea522211d81521f07f60664656e3427df07357084d346b3cbc1721ceb27438b6236173750e9b6e8ee908759779483bf
-  data.tar.gz: 80f966439ea52e3d869f2a40d914ceb63028216b6ede3c9e84735c8052a42773c47c4da58eb061d1dfb3932aa70ec7cf07c46ef7a04182639cba729309d7d4ac
+  metadata.gz: d9249aa9401c67882c6a015eb0346e4e7c916399d1ea2e2175d7b72ef49c2c4cf6cc5ae2ae84a2855bd2dd5969cd7729cd4bfc9f526b42f8e397a3f4bcaf2c89
+  data.tar.gz: 944851f9e32d13bd327e1efb4a4dc42c2d24fffd7d408afce9be5342a6b229ee383edfe07a73076b5d527296db4807f98034e3c6c0a529c7986737f0a5b55e93

data/Gemfile

@@ -3,23 +3,27 @@ git_source(:github) { |name| "https://github.com/#{name}.git" }
 
 # Specify your gem's dependencies in sentry-ruby.gemspec
 gemspec
+gem "sentry-ruby", path: "../sentry-ruby"
+gem "sentry-rails", path: "../sentry-rails"
+
+# https://github.com/flavorjones/loofah/pull/267
+# loofah changed the required ruby version in a patch so we need to explicitly pin it
+gem "loofah", "2.20.0" if RUBY_VERSION.to_f < 2.5
 
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"
-gem 'simplecov'
-gem "simplecov-cobertura", "~> 1.4"
-gem "rexml"
+# For https://github.com/ruby/psych/issues/655
+gem "psych", "5.1.0"
 
 sidekiq_version = ENV["SIDEKIQ_VERSION"]
-sidekiq_version = "6.0" if sidekiq_version.nil?
+sidekiq_version = "7.0" if sidekiq_version.nil?
+sidekiq_version = Gem::Version.new(sidekiq_version)
 
-gem "rails", "< 7.0"
 gem "sidekiq", "~> #{sidekiq_version}"
 
-gem "sentry-ruby", path: "../sentry-ruby"
-gem "sentry-rails", path: "../sentry-rails"
+if RUBY_VERSION.to_f >= 2.7 && sidekiq_version >= Gem::Version.new("6.0")
+  gem "sidekiq-cron"
+  gem "sidekiq-scheduler"
+end
 
-gem "object_tracer"
-gem "debug", github: "ruby/debug", platform: :ruby if RUBY_VERSION.to_f >= 2.6
-gem "pry"
+gem "rails", "> 5.0.0", "< 7.1.0"
 
+eval_gemfile File.expand_path("../Gemfile", __dir__)

data/README.md

@@ -11,7 +11,7 @@
 
 
 [![Gem Version](https://img.shields.io/gem/v/sentry-sidekiq.svg)](https://rubygems.org/gems/sentry-sidekiq)
-![Build Status](https://github.com/getsentry/sentry-ruby/workflows/sentry-sidekiq%20Test/badge.svg)
+![Build Status](https://github.com/getsentry/sentry-ruby/actions/workflows/sentry_sidekiq_test.yml/badge.svg)
 [![Coverage Status](https://img.shields.io/codecov/c/github/getsentry/sentry-ruby/master?logo=codecov)](https://codecov.io/gh/getsentry/sentry-ruby/branch/master)
 [![Gem](https://img.shields.io/gem/dt/sentry-sidekiq.svg)](https://rubygems.org/gems/sentry-sidekiq/)
 [![SemVer](https://api.dependabot.com/badges/compatibility_score?dependency-name=sentry-sidekiq&package-manager=bundler&version-scheme=semver)](https://dependabot.com/compatibility-score.html?dependency-name=sentry-sidekiq&package-manager=bundler&version-scheme=semver)

data/lib/sentry/sidekiq/context_filter.rb

@@ -26,6 +26,9 @@ module Sentry
           end
         end
 
+        # Sidekiq 7.0 started adding `_config` to the context, which is not easily serialisable
+        # And it's presence could be confusing so it's better to remove it until we decided to add it for a reason
+        filtered_context.delete(:_config)
         filtered_context
       end
 

data/lib/sentry/sidekiq/cron/job.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# Try requiring sidekiq-cron to ensure it's loaded before the integration.
+# If sidekiq-cron is not available, do nothing.
+begin
+  require "sidekiq-cron"
+rescue LoadError
+  return
+end
+
+module Sentry
+  module Sidekiq
+    module Cron
+      module Job
+        def save
+          # validation failed, do nothing
+          return false unless super
+
+          # fail gracefully if can't find class
+          klass_const =
+            begin
+              ::Sidekiq::Cron::Support.constantize(klass.to_s)
+            rescue NameError
+              return true
+            end
+
+          # only patch if not explicitly included in job by user
+          unless klass_const.send(:ancestors).include?(Sentry::Cron::MonitorCheckIns)
+            klass_const.send(:include, Sentry::Cron::MonitorCheckIns)
+            klass_const.send(:sentry_monitor_check_ins,
+                             slug: name,
+                             monitor_config: Sentry::Cron::MonitorConfig.from_crontab(cron))
+          end
+
+          true
+        end
+      end
+    end
+  end
+end
+
+Sentry.register_patch(:sidekiq_cron, Sentry::Sidekiq::Cron::Job, ::Sidekiq::Cron::Job)

data/lib/sentry/sidekiq/error_handler.rb

@@ -3,17 +3,28 @@ require 'sentry/sidekiq/context_filter'
 module Sentry
   module Sidekiq
     class ErrorHandler
-      def call(ex, context)
+      WITH_SIDEKIQ_7 = ::Gem::Version.new(::Sidekiq::VERSION) >= ::Gem::Version.new("7.0")
+
+      # @param ex [Exception] the exception / error that occured
+      # @param context [Hash or Array] Sidekiq error context
+      # @param sidekiq_config [Sidekiq::Config, Hash] Sidekiq configuration,
+      #   Defaults to nil.
+      #   Sidekiq will pass the config in starting Sidekiq 7.1.5, see
+      #   https://github.com/sidekiq/sidekiq/pull/6051
+      def call(ex, context, sidekiq_config = nil)
         return unless Sentry.initialized?
 
         context_filter = Sentry::Sidekiq::ContextFilter.new(context)
 
         scope = Sentry.get_current_scope
-        scope.set_transaction_name(context_filter.transaction_name) unless scope.transaction_name
+        scope.set_transaction_name(context_filter.transaction_name, source: :task) unless scope.transaction_name
 
+        # If Sentry is configured to only report an error _after_ all retries have been exhausted,
+        # and if the job is retryable, and have not exceeded the retry_limit,
+        # return early.
         if Sentry.configuration.sidekiq.report_after_job_retries && retryable?(context)
           retry_count = context.dig(:job, "retry_count")
-          if retry_count.nil? || retry_count < retry_limit(context) - 1
+          if retry_count.nil? || retry_count < retry_limit(context, sidekiq_config) - 1
             return
           end
         end
@@ -23,6 +34,8 @@ module Sentry
           contexts: { sidekiq: context_filter.filtered },
           hint: { background: false }
         )
+      ensure
+        scope&.clear
       end
 
       private
@@ -33,14 +46,27 @@ module Sentry
         retry_option == true || (retry_option.is_a?(Integer) && retry_option.positive?)
       end
 
-      def retry_limit(context)
+      # @return [Integer] the number of retries allowed for the job
+      # Tries to fetch the retry limit from the job config first,
+      # then falls back to Sidekiq's configuration.
+      def retry_limit(context, sidekiq_config)
         limit = context.dig(:job, "retry")
 
         case limit
         when Integer
           limit
         when TrueClass
-          ::Sidekiq.options[:max_retries] || 25
+          max_retries =
+            if WITH_SIDEKIQ_7
+              # Sidekiq 7.1.5+ passes the config to the error handler, so we should use that.
+              # Sidekiq 7.0 -> 7.1.5 provides ::Sidekiq.default_configuration.
+              sidekiq_config.is_a?(::Sidekiq::Config) ?
+                sidekiq_config[:max_retries] :
+                ::Sidekiq.default_configuration[:max_retries]
+            else
+              ::Sidekiq.options[:max_retries]
+            end
+          max_retries || 25
         else
           0
         end

data/lib/sentry/sidekiq/sentry_context_middleware.rb

@@ -3,6 +3,8 @@ require 'sentry/sidekiq/context_filter'
 module Sentry
   module Sidekiq
     class SentryContextServerMiddleware
+      OP_NAME = "queue.sidekiq".freeze
+
       def call(_worker, job, queue)
         return yield unless Sentry.initialized?
 
@@ -16,8 +18,8 @@ module Sentry
         scope.set_tags(queue: queue, jid: job["jid"])
         scope.set_tags(build_tags(job["tags"]))
         scope.set_contexts(sidekiq: job.merge("queue" => queue))
-        scope.set_transaction_name(context_filter.transaction_name)
-        transaction = start_transaction(scope.transaction_name, job["sentry_trace"])
+        scope.set_transaction_name(context_filter.transaction_name, source: :task)
+        transaction = start_transaction(scope, job["trace_propagation_headers"])
         scope.set_span(transaction) if transaction
 
         begin
@@ -37,9 +39,9 @@ module Sentry
         Array(tags).each_with_object({}) { |name, tags_hash| tags_hash[:"sidekiq.#{name}"] = true }
       end
 
-      def start_transaction(transaction_name, sentry_trace)
-        options = { name: transaction_name, op: "sidekiq" }
-        transaction = Sentry::Transaction.from_sentry_trace(sentry_trace, **options) if sentry_trace
+      def start_transaction(scope, env)
+        options = { name: scope.transaction_name, source: scope.transaction_source, op: OP_NAME }
+        transaction = Sentry.continue_trace(env, **options)
         Sentry.start_transaction(transaction: transaction, **options)
       end
 
@@ -56,9 +58,8 @@ module Sentry
         return yield unless Sentry.initialized?
 
         user = Sentry.get_current_scope.user
-        transaction = Sentry.get_current_scope.get_transaction
         job["sentry_user"] = user unless user.empty?
-        job["sentry_trace"] = transaction.to_sentry_trace if transaction
+        job["trace_propagation_headers"] ||= Sentry.get_trace_propagation_headers
         yield
       end
     end

data/lib/sentry/sidekiq/version.rb

@@ -1,5 +1,5 @@
 module Sentry
   module Sidekiq
-    VERSION = "5.3.1"
+    VERSION = "5.16.1"
   end
 end

data/lib/sentry/sidekiq-scheduler/scheduler.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+# Try to require sidekiq-scheduler to make sure it's loaded before the integration.
+begin
+  require "sidekiq-scheduler"
+rescue LoadError
+  return
+end
+
+# If we've loaded sidekiq-scheduler, but the API changed,
+# and the Scheduler class is not there, fail gracefully.
+return unless defined?(::SidekiqScheduler::Scheduler)
+
+module Sentry
+  module SidekiqScheduler
+    module Scheduler
+      def new_job(name, interval_type, config, schedule, options)
+        # Schedule the job upstream first
+        # SidekiqScheduler does not validate schedules
+        # It will fail with an error if the schedule in the config is invalid.
+        # If this errors out, let it fall through.
+        rufus_job = super
+
+        klass = config.fetch("class")
+        return rufus_job unless klass
+
+        # Constantize the job class, and fail gracefully if it could not be found
+        klass_const =
+          begin
+            Object.const_get(klass)
+          rescue NameError
+            return rufus_job
+          end
+
+        # For cron, every, or interval jobs — grab their schedule.
+        # Rufus::Scheduler::EveryJob stores it's frequency in seconds,
+        # so we convert it to minutes before passing in to the monitor.
+        monitor_config = case interval_type
+          when "cron"
+            # fugit is a second order dependency of sidekiq-scheduler via rufus-scheduler
+            parsed_cron = ::Fugit.parse_cron(schedule)
+            timezone = parsed_cron.timezone
+
+            # fugit supports having the timezone part of the cron string,
+            # so we need to pull that with some hacky stuff
+            if timezone
+              parsed_cron.instance_variable_set(:@timezone, nil)
+              cron_without_timezone = parsed_cron.to_cron_s
+              Sentry::Cron::MonitorConfig.from_crontab(cron_without_timezone, timezone: timezone.name)
+            else
+              Sentry::Cron::MonitorConfig.from_crontab(schedule)
+            end
+          when "every", "interval"
+            Sentry::Cron::MonitorConfig.from_interval(rufus_job.frequency.to_i / 60, :minute)
+        end
+
+        # If we couldn't build a monitor config, it's either an error, or
+        # it's a one-time job (interval_type is in, or at), in which case
+        # we should not make a monitof for it automaticaly.
+        return rufus_job if monitor_config.nil?
+
+        # only patch if not explicitly included in job by user
+        unless klass_const.send(:ancestors).include?(Sentry::Cron::MonitorCheckIns)
+          klass_const.send(:include, Sentry::Cron::MonitorCheckIns)
+          slug = klass_const.send(:sentry_monitor_slug, name: name)
+          klass_const.send(:sentry_monitor_check_ins,
+                           slug: slug,
+                           monitor_config: monitor_config)
+
+          ::Sidekiq.logger.info "Injected Sentry Crons monitor checkins into #{klass}"
+        end
+
+        rufus_job
+      end
+    end
+  end
+end
+
+Sentry.register_patch(:sidekiq_scheduler, Sentry::SidekiqScheduler::Scheduler, ::SidekiqScheduler::Scheduler)

data/lib/sentry-sidekiq.rb

@@ -39,3 +39,7 @@ Sidekiq.configure_client do |config|
     chain.add Sentry::Sidekiq::SentryContextClientMiddleware
   end
 end
+
+# patches
+require "sentry/sidekiq/cron/job"
+require "sentry/sidekiq-scheduler/scheduler"

data/sentry-sidekiq.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 "sentry-ruby-core", "~> 5.3.1"
+  spec.add_dependency "sentry-ruby", "~> 5.16.1"
   spec.add_dependency "sidekiq", ">= 3.0"
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: sentry-sidekiq
 version: !ruby/object:Gem::Version
-  version: 5.3.1
+  version: 5.16.1
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-05-14 00:00:00.000000000 Z
+date: 2024-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: sentry-ruby-core
+  name: sentry-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.3.1
+        version: 5.16.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.3.1
+        version: 5.16.1
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
@@ -49,7 +49,6 @@ files:
 - ".gitignore"
 - ".rspec"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - Makefile
@@ -62,8 +61,10 @@ files:
 - example/config/sidekiq.yml
 - example/error_worker.rb
 - lib/sentry-sidekiq.rb
+- lib/sentry/sidekiq-scheduler/scheduler.rb
 - lib/sentry/sidekiq/configuration.rb
 - lib/sentry/sidekiq/context_filter.rb
+- lib/sentry/sidekiq/cron/job.rb
 - lib/sentry/sidekiq/error_handler.rb
 - lib/sentry/sidekiq/sentry_context_middleware.rb
 - lib/sentry/sidekiq/version.rb

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at stan001212@gmail.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [https://contributor-covenant.org/version/1/4][version]
-
-[homepage]: https://contributor-covenant.org
-[version]: https://contributor-covenant.org/version/1/4/