sidekiq-bus 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 348236e181a0dfa48615334f28f2f9cc866a44fa93d63377c7780190f47f9e82
-  data.tar.gz: db608296c196894b6e793dc5a6b7a5ad41426307ea2e0cf592b75b9cc580e7f4
+  metadata.gz: 31218b263cfcfbc7226f2f8d30ddc2ffb24019fc9a1ee55a45cc324a592d8a60
+  data.tar.gz: 4bc6d366f8163ec83b392476d4fb4919b3c16c026c5713e7632c6aacab276097
 SHA512:
-  metadata.gz: 865909c8db64b272978af02dcceb551f5f8c5c552ef1cd9e140876bdff8dc4a149385433bebcabe55ecc911a9ef6cd895b31b4d024366b5dee0691ed57bfb6d5
-  data.tar.gz: cb8ca09af0f508755e71f28f3bc7ec212f5380677de55e8c92ea7d6393cc7526103a9a72cd72f274d46da8a9409a0e7772a4a4eec782150eaaa1428f7ad5cfc0
+  metadata.gz: 825f2a4bf78bbfef5e4e02cbd10cbd98833eaa3e29445203877adc238db6aaa0f92aae41c27ddaf11d1ae4a81b49bb63ebf7bfdfe91a13e192d1800a529e08a1
+  data.tar.gz: d42466dd3302d78ed7670fdff75b5b80e59d8da9597e581a1f7324b4e9ab0cd40aa0455c397249300cc41dd5bdcb3e4f644d4743fa51fbc2aca6a2efa3239ce5

data/CHANGELOG.md

@@ -6,6 +6,15 @@ 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
 
 ### Changed

data/README.mdown

@@ -11,6 +11,27 @@ To install, include the 'sidekiq-bus' gem and add the following to your Rakefile
 require "sidekiq_bus/tasks"
 ```
 
+### Configure
+Starting from version 7, Sidekiq no longer provides a standard Redis connection pool, instead providing a limited
+wrapper around the low-level RedisClient gem. To maintain compatibility with both QueueBus and later versions of
+Sidekiq, SidekiqBus now requires an explicit Redis handler. To preserve your existing QueueBus data, this handler should
+connect to the same Redis instance and database as your Sidekiq configuration.
+
+The handler can be any object that responds to `call` and yields a Redis connection. In an initializer, set it with:
+
+```ruby
+  # Naive example
+  SidekiqBus.redis_handler = ->(&block) { block.call(Redis.new(my_config) }
+
+  # More typical example using the Redis-recommended ConnectionPool gem
+  pool = ConnectionPool.new(size: pool_size, timeout: pool_timeout) { Redis.new(my_config) }
+  SidekiqBus.redis_handler = pool.method(:with).to_proc
+  # Or, for clarity:
+  SidekiqBus.redis_handler = ->(&block) do
+    pool.with { |redis| block.call(redis) }
+  end
+```
+
 ### Example
 
 Application A can publish an event
@@ -162,6 +183,22 @@ event to the appropriate code block.
 You can also say `QueueBus.local_mode = :suppress` to turn off publishing altogether.
 This can be helpful inside some sort of migration, for example.
 
+### Development
+
+#### Running Tests
+
+The test suite requires a Redis instance. For convenience, we provide Docker Compose configuration to run Redis in a container:
+
+```bash
+docker-compose up -d
+
+bundle exec rspec
+```
+
+The test suite uses database 15 by default to avoid conflicts with your development Redis data.
+
+You can override the connection string (including the database number) by setting the `REDIS_URL` environment variable.
+
 ### TODO
 
 * Replace local modes with adapters

data/docker-compose.yml

@@ -0,0 +1,18 @@
+version: '3.8'
+
+services:
+  redis:
+    image: redis:7-alpine
+    ports:
+      - "6379:6379"
+    command: redis-server --appendonly yes
+    volumes:
+      - redis_data:/data
+    healthcheck:
+      test: ["CMD", "redis-cli", "ping"]
+      interval: 5s
+      timeout: 3s
+      retries: 5
+
+volumes:
+  redis_data:

data/lib/sidekiq-bus.rb

@@ -7,6 +7,10 @@ require 'sidekiq_bus/server'
 require 'sidekiq_bus/middleware/retry'
 
 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
   # The sidekiq CLI builds weighted queues.
@@ -42,6 +46,21 @@ module SidekiqBus
     # flattened into a single array
     entries.flat_map { |e| Array.new(e.weight, e.queue) }
   end
+
+  def self.redis_handler=(handler)
+    unless handler.respond_to?(:call)
+      raise ConfigurationError, REDIS_HANDLER_ERROR_MESSAGE
+    end
+    @redis_handler = handler
+  end
+
+  def self.redis(&block)
+    raise ConfigurationError, REDIS_HANDLER_ERROR_MESSAGE unless @redis_handler
+    @redis_handler.call(&block)
+  end
+
+  def self.validate_redis_handler
+  end
 end
 
 if QueueBus.has_adapter?

data/lib/sidekiq_bus/adapter.rb

@@ -21,7 +21,7 @@ module QueueBus
       end
 
       def redis(&block)
-        ::Sidekiq.redis(&block)
+        ::SidekiqBus.redis(&block)
       end
 
       def enqueue(queue_name, klass, hash)
@@ -66,7 +66,8 @@ module QueueBus
           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

data/lib/sidekiq_bus/version.rb

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

data/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('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('redis', ['>= 4.0', '< 6.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("fakeredis")
-  s.add_development_dependency("redis-namespace")
   s.add_development_dependency("pry")
   s.add_development_dependency("timecop")
   s.add_development_dependency("json_pure")

data/spec/adapter/integration_spec.rb

@@ -87,17 +87,14 @@ describe 'Sidekiq Integration' do
       val = QueueBus.redis { |redis| redis.lpop('queue:bus_incoming') }
       expect(val).to eq(nil) # nothing really added
 
-      # NOTE: this is silently invoking a monkey patch in spec_helper
-      # since the Poller invokes a Lua script that FakeRedis does not
-      # natively support.
-      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)

data/spec/adapter_spec.rb

@@ -19,11 +19,11 @@ describe 'adapter is set' do
 
     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 @@ describe 'adapter is set' do
         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 @@ describe 'adapter is set' do
         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'

data/spec/spec_helper.rb

@@ -4,11 +4,40 @@ require 'timecop'
 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
 
-require 'fakeredis'
-Sidekiq.redis = ConnectionPool.new { Redis.new(driver: Redis::Connection::Memory) }
+# Use real Redis for testing to ensure compatibility with Sidekiq's Lua scripts
+redis_url = ENV.fetch('REDIS_URL', 'redis://localhost:6379/15')
+
+# Check Redis connection before running tests
+begin
+  test_redis = Redis.new(url: redis_url)
+  test_redis.ping
+  test_redis.disconnect!
+rescue Redis::CannotConnectError, Errno::ECONNREFUSED => e
+  puts "\n❌ Redis connection failed!"
+  puts "   URL: #{redis_url}"
+  puts "   Error: #{e.message}"
+  puts "\n💡 To fix this:"
+  puts "   • Start Redis with Docker: docker-compose up -d redis"
+  puts "   • Or start Redis locally: redis-server"
+  puts "   • Or set REDIS_URL environment variable to a running Redis instance"
+  puts "\n"
+  exit 1
+rescue => e
+  puts "\n❌ Unexpected error connecting to Redis:"
+  puts "   #{e.class}: #{e.message}"
+  puts "\n"
+  exit 1
+end
+
+redis_pool = ConnectionPool.new { Redis.new(url: redis_url) }
+SidekiqBus.redis_handler = redis_pool.method(:with).to_proc
 
 require 'fileutils'
 
@@ -19,9 +48,18 @@ FileUtils.touch(log_file)
 
 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
@@ -53,38 +91,6 @@ module QueueBus
   end
 end
 
-class Redis
-  module Connection
-    class Memory
-      def script(*args)
-        case args[1]
-        when Sidekiq::Scheduled::Enq::LUA_ZPOPBYSCORE
-          QueueBus.redis do |redis|
-            now = Time.now.to_f
-
-            # Process both 'schedule' and 'retry' sets
-            %w[schedule retry].each do |set_name|
-              # Get jobs that are ready to be processed (score <= now)
-              jobs = redis.zrangebyscore(set_name, '-inf', now)
-
-              jobs.each do |job_json|
-                # Remove from scheduled set
-                redis.zrem(set_name, job_json)
-
-                # Parse and re-enqueue the job
-                job_data = JSON.parse(job_json)
-                queue_name = job_data['queue'] || 'default'
-                redis.lpush("queue:#{queue_name}", job_json)
-              end
-            end
-          end
-        else
-          raise "NOSCRIPT - FakeRedis gem does not include Lua support. Please see spec/spec_helper.rb for more information."
-        end
-      end
-    end
-  end
-end
 
 def test_sub(event_name, queue = 'default')
   matcher = { 'bus_event_type' => event_name }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-bus
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Brian Leonard
@@ -30,59 +30,65 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1'
 - !ruby/object:Gem::Dependency
-  name: sidekiq
+  name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '4.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '4.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: sidekiq-scheduler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -97,34 +103,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: fakeredis
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: redis-namespace
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -200,6 +178,7 @@ files:
 - MIT-LICENSE
 - README.mdown
 - Rakefile
+- docker-compose.yml
 - lib/sidekiq-bus.rb
 - lib/sidekiq_bus/adapter.rb
 - lib/sidekiq_bus/middleware/retry.rb