2.0.0: Sidekiq 7 compatibility (#31)

* 2.0.0: Sidekiq 7 compatibility

* Small optimization on redis_handler validation

Author: aalong-tr

CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 
 ### Changed
+
+## [2.0.0] - 2025-06-17
+
+- [BREAKING] Sidekiq major version now targets 7.X
+- [BREAKING] SidekiqScheduler major version now targets 5.X to support Sidekiq 7
+- [BREAKING] SidekiqBus must now be configured with a Redis pool. See the README for more details.
 - [Development] Discontinues use of FakeRedis in favor of real Redis for testing.
 
 ## [1.1.0] - 2025-05-13

lib/sidekiq-bus.rb

@@ -8,6 +8,8 @@
 
 module SidekiqBus
   ConfigurationError = Class.new(StandardError)
+  REDIS_HANDLER_ERROR_MESSAGE = 'Please set SidekiqBus.redis_handler to a Callable that accepts a block and yields a '\
+        'Redis instance. See the SidekiqBus README for more details.'
 
   # This method will analyze the current queues and generate an array that
   # can operate as the sidekiq queues configuration. It should be based on how
@@ -46,20 +48,18 @@ def self.generate_weighted_queues(overrides: {}, default: 1)
   end
 
   def self.redis_handler=(handler)
+    unless handler.respond_to?(:call)
+      raise ConfigurationError, REDIS_HANDLER_ERROR_MESSAGE
+    end
     @redis_handler = handler
-    validate_redis_handler
   end
 
   def self.redis(&block)
-    validate_redis_handler
+    raise ConfigurationError, REDIS_HANDLER_ERROR_MESSAGE unless @redis_handler
     @redis_handler.call(&block)
   end
 
   def self.validate_redis_handler
-    unless @redis_handler.respond_to?(:call)
-      raise ConfigurationError, 'Please set SidekiqBus.redis_handler to a Callable that accepts a block and yields a '\
-        'Redis instance. See the SidekiqBus README for more details.'
-    end
   end
 end
 

lib/sidekiq_bus/adapter.rb

@@ -66,7 +66,8 @@ def set_schedule(queue_name)
           description: 'Enqueues a heart beat every minute for the queue-bus'
         )
 
-        ::Sidekiq::Scheduler.instance.update_schedule unless ::Sidekiq::Scheduler.instance.dynamic
+        # If dynamic is enabled, this will propagate through a different mechanism
+        SidekiqScheduler::Scheduler.instance.reload_schedule! unless ::Sidekiq::Scheduler.instance.dynamic
       end
     end
   end

lib/sidekiq_bus/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SidekiqBus
-  VERSION = '1.1.0'
+  VERSION = '2.0.0'
 end

sidekiq-bus.gemspec

@@ -17,13 +17,11 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency('queue-bus', ['>= 0.7', '< 1'])
-  s.add_dependency('sidekiq', ['>= 3.0.0', '< 7.0'])
   s.add_dependency('redis', ['>= 4.0', '< 6.0'])
-  s.add_dependency('rack', "< 3.0") # Sidekiq 6 was sunset before Rack 3.0 and does not support it
-  s.add_dependency('sidekiq-scheduler', ['>= 3.0', '< 5.0'])
+  s.add_dependency('sidekiq', ['>= 7.0.0', '< 8.0'])
+  s.add_dependency('sidekiq-scheduler', ['>= 5.0', '< 6.0'])
 
   s.add_development_dependency("rspec")
-  s.add_development_dependency("redis-namespace")
   s.add_development_dependency("pry")
   s.add_development_dependency("timecop")
   s.add_development_dependency("json_pure")

spec/adapter/integration_spec.rb

@@ -87,14 +87,14 @@
       val = QueueBus.redis { |redis| redis.lpop('queue:bus_incoming') }
       expect(val).to eq(nil) # nothing really added
 
-      Sidekiq::Scheduled::Poller.new(Sidekiq).enqueue
+      Sidekiq::Scheduled::Poller.new(Sidekiq.default_configuration).enqueue
 
       val = QueueBus.redis { |redis| redis.lpop('queue:bus_incoming') }
       expect(val).to eq(nil) # nothing added yet
 
       # process scheduler in future
       Timecop.freeze(worktime) do
-        Sidekiq::Scheduled::Poller.new(Sidekiq).enqueue
+        Sidekiq::Scheduled::Poller.new(Sidekiq.default_configuration).enqueue
 
         val = QueueBus.redis { |redis| redis.lpop('queue:bus_incoming') }
         hash = JSON.parse(val)

spec/adapter_spec.rb

@@ -19,11 +19,11 @@
 
     around do |example|
       begin
-        old = Sidekiq.options[:lifecycle_events][:startup]
-        Sidekiq.options[:lifecycle_events][:startup] = []
+        old = Sidekiq.default_configuration[:lifecycle_events][:startup]
+        Sidekiq.default_configuration[:lifecycle_events][:startup] = []
         example.run
       ensure
-        Sidekiq.options[:lifecycle_events][:startup] = old
+        Sidekiq.default_configuration[:lifecycle_events][:startup] = old
       end
     end
 
@@ -65,7 +65,7 @@
         allow(Sidekiq::Scheduler.instance).to receive(:dynamic).and_return(true)
 
         # Simulate running startup events
-        Sidekiq.options[:lifecycle_events][:startup].each(&:call)
+        Sidekiq.default_configuration[:lifecycle_events][:startup].each(&:call)
       end
 
       it_behaves_like 'a scheduled heartbeat'
@@ -76,7 +76,7 @@
         allow(Sidekiq::Scheduler.instance).to receive(:dynamic).and_return(false)
 
         # Simulate running startup events
-        Sidekiq.options[:lifecycle_events][:startup].each(&:call)
+        Sidekiq.default_configuration[:lifecycle_events][:startup].each(&:call)
       end
 
       it_behaves_like 'a scheduled heartbeat'

spec/spec_helper.rb

@@ -4,6 +4,10 @@
 require 'queue-bus'
 require 'adapter/support'
 require 'pry'
+require 'redis'
+
+# Require some private Sidekiq APIs to simulate internal scheduling behavior
+require "sidekiq/capsule"
 
 reset_test_adapter
 
@@ -33,7 +37,6 @@
 end
 
 redis_pool = ConnectionPool.new { Redis.new(url: redis_url) }
-Sidekiq.redis = redis_pool
 SidekiqBus.redis_handler = redis_pool.method(:with).to_proc
 
 require 'fileutils'
@@ -45,9 +48,18 @@
 
 logger = Logger.new(File.open(log_file, 'a'))
 
-Sidekiq.logger = logger
 QueueBus.logger = logger
 
+Sidekiq.configure_server do |config|
+  config.redis = { url: redis_url }
+  config.logger = logger
+end
+
+Sidekiq.configure_client do |config|
+  config.redis = { url: redis_url }
+  config.logger = logger
+end
+
 require 'sidekiq/testing'
 
 module QueueBus