handle sidekiq deprecation warning (#535)

Author: mitchh456

.github/workflows/test.yml

@@ -42,6 +42,12 @@ jobs:
           - ruby: "3.0"
             gemfile: gems/sidekiq.gemfile
             test_features: "sidekiq_install"
+          - ruby: "3.0"
+            gemfile: gems/sidekiq7.gemfile
+            test_features: "sidekiq_install"
+          - ruby: "3.3"
+            gemfile: gems/sidekiq8.gemfile
+            test_features: "sidekiq_install"
           - ruby: 3.1
           - ruby: 3.2
             gemfile: gems/sqlite3-v2.gemfile

CHANGELOG.markdown

@@ -1,4 +1,5 @@
 # Unreleased
+- Fix deprecation warning for Sidekiq 7.1.5+ (#535)
 
 # 5.6.1
 - Fix `job_sample_rate` and `endpoint_sample_rate` default configuration values (#529)

gems/rails7.gemfile

@@ -0,0 +1,4 @@
+eval_gemfile("../Gemfile")
+
+gem "rails", "~> 7.0"
+gem "sqlite3", "~> 1.4"

gems/sidekiq7.gemfile

@@ -0,0 +1,3 @@
+eval_gemfile("../Gemfile")
+
+gem 'sidekiq', '~> 7.0'

gems/sidekiq8.gemfile

@@ -0,0 +1,4 @@
+eval_gemfile("../Gemfile")
+
+gem 'sqlite3', '~> 2.0'
+gem 'sidekiq', '~> 8.0'

lib/scout_apm/error_service/sidekiq.rb

@@ -28,7 +28,7 @@ def install_sidekiq_with_middleware
 
       def install_sidekiq_with_error_handler
         ::Sidekiq.configure_server do |config|
-          config.error_handlers << proc { |exception, job_info|
+          config.error_handlers << proc { |exception, job_info, sidekiq_config|
             context = ScoutApm::Agent.instance.context
 
             # Bail out early, and reraise if the error is not interesting.

test/unit/background_job_integrations/sidekiq_test.rb

@@ -18,7 +18,9 @@ class SidekiqTest < Minitest::Test
     def test_starts_on_startup
       ::ScoutApm::Agent.any_instance.expects(:start)
       SidekiqIntegration.new.install
-      Sidekiq.options[:lifecycle_events][:startup].map(&:call)
+      ::Sidekiq.configure_server do |config|
+        config[:lifecycle_events][:startup].map(&:call)
+      end
     end
   end
 

test/unit/config_test.rb

@@ -89,7 +89,7 @@ def test_nullable_integer_coercion
     assert_equal 0, coercion.coerce("0")
     assert_equal 0, coercion.coerce(0)
     assert_equal 0, coercion.coerce("")
-    assert_equal nil, coercion.coerce(nil)
+    assert_nil coercion.coerce(nil)
   end
 
   def test_any_keys_found

test/unit/sampling_test.rb

@@ -26,7 +26,7 @@ def test_individual_sample_to_hash
       assert_equal({'/foo/bar' => 100, '/foo' => 50, '/bar/zap' => 80}, sampling.individual_sample_to_hash(@individual_config.value('sample_endpoints')))
 
       sampling = ScoutApm::Sampling.new(@global_sample_config)
-      assert_equal nil, sampling.individual_sample_to_hash(@global_sample_config.value('sample_endpoints'))
+      assert_nil sampling.individual_sample_to_hash(@global_sample_config.value('sample_endpoints'))
     end
 
     def test_uri_ignore
@@ -41,10 +41,10 @@ def test_uri_sample
       assert_equal 50, rate
 
       rate = sampling.web_sample_rate('/bar')
-      assert_equal nil, rate
+      assert_nil rate
 
       rate = sampling.web_sample_rate('/baz/bap')
-      assert_equal nil, rate
+      assert_nil rate
 
       rate = sampling.web_sample_rate('/foo/bar/baz')
       assert_equal 100, rate
@@ -59,7 +59,7 @@ def test_job_ignore
     def test_job_sample
       sampling = ScoutApm::Sampling.new(@individual_config)
       assert_equal 50, sampling.job_sample_rate('joba')
-      assert_equal nil, sampling.job_sample_rate('jobb')
+      assert_nil sampling.job_sample_rate('jobb')
     end
 
     def test_sample