kicks 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7899bb171d5e5399547c0b02c33753e23bc8cfaec63e614baa84cd473448a45d
-  data.tar.gz: 3b5b708557aae6c815a2ad23cf86115e5d39ad397cd1e52099ed2e621b26848a
+  metadata.gz: a7bbca9eba169dacb7dc06c6536049d59ccf469f7c006918850dff45e7f6248a
+  data.tar.gz: a9c635d5d1404a4b090df86217c5ffbd28c7dd2dabf3bed1a7d3403236513528
 SHA512:
-  metadata.gz: 57565fbb9e74e4b990f62e482293ff41cdffebb0b75875b4c654a34e4bb6ed037e2cc9305f15c1c6920e789749a484403badbc2f7aad58b811d614b0d2e51080
-  data.tar.gz: e6516ab5c10e167a1e94b0a80f82b68dbe330be53603d4cc7132104e0827f013c3cc930b1f3fe2ecc5f2f65a6cbf140707ccd3bd709fbae5ae0eae0747e2b8d7
+  metadata.gz: 13a7f0407c737d4a263283bd07b44bdba929c23b0e3fe2a724e4c900b9edc5ab60fe1d9695e1fca1b9deba4e6ed435b4a80794ed8f3bf9188335ba1b58c1b373
+  data.tar.gz: 8a0bc7b766d90f3d0789cf5948d2046e7096d9b8ffecd6af9f3dff80166dfcaa948b21b91e10e0172b5a311d2b51b16085f0f0a3e34e2412fc944dfd7a2073a8

data/.github/workflows/ci.yml

@@ -8,9 +8,13 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: [3.0, 3.1, 3.2, 3.3]
+        ruby-version:
+          - "3.4.2"
+          - "3.3.7"
+          - "3.2.7"
+          - "3.1.6"
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
 
       - name: Install Ruby ${{ matrix.ruby-version }}
         uses: ruby/setup-ruby@v1

data/AGENTS.md

@@ -0,0 +1,74 @@
+# Instructions for AI Agents
+
+## Overview
+
+Kicks is a high-performance RabbitMQ background processing framework for Ruby,
+a community-driven continuation of the original [Sneakers](https://github.com/jondot/sneakers) project.
+The internal module name is still `Sneakers`.
+
+Its key dependencies are [Bunny](https://github.com/ruby-amqp/bunny) (a RabbitMQ client that uses AMQP 0-9-1)
+and [ServerEngine](https://github.com/treasure-data/serverengine) for process management.
+
+## Target Ruby Version
+
+This library targets Ruby 3.0 and later versions.
+
+## Build and Test
+
+```bash
+bundle install
+
+bundle exec rake
+```
+
+Tests use Minitest. The default Rake task runs `spec/**/*_spec.rb`.
+
+## Key Files
+
+ * `lib/sneakers/worker.rb`: the core `Sneakers::Worker` module (work processing, [delivery acknowledgements](https://www.rabbitmq.com/docs/confirms))
+ * `lib/sneakers/configuration.rb`: configuration and defaults
+ * `lib/sneakers/queue.rb`: queue declaration and consumer registration
+ * `lib/sneakers/runner.rb`: the main runner that spawns and manages workers
+ * `lib/sneakers/publisher.rb`: message publishing
+ * `lib/sneakers/cli.rb`: CLI, based on Thor
+ * `lib/sneakers/handlers/maxretry.rb`: retry handler with error queue support
+ * `lib/sneakers/handlers/oneshot.rb`: the default handler
+ * `lib/sneakers/version.rb`: `Sneakers::VERSION` constant
+ * `lib/active_job/queue_adapters/sneakers_adapter.rb`: an `ActiveJob` adapter for Ruby on Rails
+
+## Comments
+
+ * Only add important comments that express the non-obvious intent, both in tests and in the implementation
+ * Keep the comments short
+ * Pay attention to the grammar of your comments, including punctuation, full stops, articles, and so on
+
+## Change Log
+
+If asked to perform change log updates, consult and modify `ChangeLog.md` and stick to its
+existing writing style.
+
+## Releases
+
+### How to Roll (Produce) a New Release
+
+Suppose the current development version in `ChangeLog.md` has
+a `## Changes Between Kicks X.Y.0 and X.(Y+1).0 (in development)` section at the top.
+
+To produce a new release:
+
+ 1. Update `ChangeLog.md`: replace `(in development)` with today's date, e.g. `(Mar 30, 2026)`. Make sure all notable changes since the previous release are listed
+ 2. Update the version in `lib/sneakers/version.rb` to match (remove the `.pre` suffix)
+ 3. Commit with the message `X.(Y+1).0` (just the version number, nothing else)
+ 4. Tag the commit: `git tag X.(Y+1).0`
+ 5. Bump the dev version: add a new `## Changes Between Kicks X.(Y+1).0 and X.(Y+2).0 (in development)` section to `ChangeLog.md` with `No changes yet.` underneath, and update `lib/sneakers/version.rb` to the next dev version with a `.pre` suffix
+ 6. Commit with the message `Bump dev version`
+ 7. Push: `git push && git push --tags`
+
+## Git Instructions
+
+ * Never add yourself to the list of commit co-authors
+ * Never mention yourself in commit messages in any way (no "Generated by", no AI tool links, etc)
+
+## Style Guide
+
+ * Never add full stops to Markdown list items

data/ChangeLog.md

@@ -1,16 +1,49 @@
 # Change Log
 
-## Changes Between 3.2.0 and 3.3.0 (in development)
+## Changes Between 3.2.0 and 3.3.0 (Mar 31, 2026)
 
-No (documented) changes yet.
+### Queue Type Inheritance for Retry and Error Queues
+
+The `maxretry` handler now inherits the queue type from the worker queue's
+arguments when declaring retry and error queues.
+
+This can be overridden with the `:retry_queue_arguments` option.
+
+GitHub issue: [#38](https://github.com/ruby-amqp/kicks/pull/38)
+
+Contributed by @chris72205.
+
+### Improved Bunny Exception Handling for Consumers
+
+Contributed by @shashankmehra.
+
+GitHub issue: [#35](https://github.com/ruby-amqp/kicks/pull/35)
+
+### Improved Logger Configuration
+
+Contributed by @cdhagmann.
+
+GitHub issue: [#34](https://github.com/ruby-amqp/kicks/pull/34)
+
+### Bunny Version Bump
+
+Kicks now requires the latest (at the time of writing) Bunny `2.24.x`.
+
+### Support Rails 7.2
+
+Contributed by @sekrett.
+
+GitHub issue: [#32](https://github.com/ruby-amqp/kicks/pull/32)
 
 
 ## Changes Between 3.1.0 and 3.2.0 (Jan 26, 2025)
 
 ### Improved Support for Bring-Your-Own-Connection (BYOC)
 
-Kicks now supports a callable (e.g. a proc) to be passed for an externally-initialized
-and managed Bunny connection. In this case, it is entirely up to the caller
+Kicks now supports passing in a callable (e.g. a proc) instead of an externally-initialized
+and managed Bunny connection.
+
+In this case, it is entirely up to the caller
 to configure the connection and call `Bunny::Session#start` on it
 at the right moment.
 

data/kicks.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
 
   gem.add_dependency 'serverengine', '~> 2.1'
-  gem.add_dependency 'bunny', '~> 2.19'
+  gem.add_dependency 'bunny', '~> 2.24'
   gem.add_dependency 'concurrent-ruby', '~> 1.0'
   gem.add_dependency 'thor'
   gem.add_dependency 'rake', '>= 12.3', '< 14.0'

data/lib/active_job/queue_adapters/sneakers_adapter.rb

@@ -8,7 +8,7 @@ module ActiveJob
     # To use Sneakers set the queue_adapter config to +:sneakers+.
     #
     #   Rails.application.config.active_job.queue_adapter = :sneakers
-    class SneakersAdapter
+    class SneakersAdapter < (const_defined?(:AbstractAdapter) ? AbstractAdapter : Object)
       def initialize
         @monitor = Monitor.new
       end

data/lib/sneakers/configuration.rb

@@ -5,7 +5,7 @@ module Sneakers
   class Configuration
 
     extend Forwardable
-    def_delegators :@hash, :to_hash, :[], :[]=, :==, :fetch, :delete, :has_key?, :dig
+    def_delegators :@hash, :to_hash, :[], :[]=, :==, :fetch, :delete, :has_key?, :dig, :slice
 
     EXCHANGE_OPTION_DEFAULTS = {
       :type               => :direct,
@@ -35,6 +35,11 @@ module Sneakers
       :log                => STDOUT,
       :pid_path           => 'sneakers.pid',
       :amqp_heartbeat     => 30,
+      
+      # Default values from serverengine
+      :log_rotate_age     => 5,
+      :log_rotate_size    => 1048576,
+      :log_level          => 'debug',
 
       # workers
       :prefetch           => 10,

data/lib/sneakers/handlers/maxretry.rb

@@ -60,19 +60,24 @@ module Sneakers
         Sneakers.logger.debug do
           "#{log_prefix} creating queue=#{retry_name} x-dead-letter-exchange=#{requeue_name}"
         end
+        retry_args = retry_queue_arguments.merge(
+          :'x-dead-letter-exchange' => requeue_name,
+          :'x-message-ttl' => @opts[:retry_timeout] || 60000
+        )
         @retry_queue = @channel.queue(retry_name,
                                      :durable => queue_durable?,
-                                     :arguments => {
-                                       :'x-dead-letter-exchange' => requeue_name,
-                                       :'x-message-ttl' => @opts[:retry_timeout] || 60000
-                                     })
+                                     :arguments => retry_args)
         @retry_queue.bind(@retry_exchange, :routing_key => '#')
 
         Sneakers.logger.debug do
           "#{log_prefix} creating queue=#{error_name}"
         end
-        @error_queue = @channel.queue(error_name,
-                                      :durable => queue_durable?)
+        error_args = retry_queue_arguments
+        if error_args.empty?
+          @error_queue = @channel.queue(error_name, :durable => queue_durable?)
+        else
+          @error_queue = @channel.queue(error_name, :durable => queue_durable?, :arguments => error_args)
+        end
         @error_queue.bind(@error_exchange, :routing_key => '#')
 
         # Finally, bind the worker queue to our requeue exchange
@@ -218,6 +223,17 @@ module Sneakers
       def exchange_durable?
         queue_durable?
       end
+
+      def retry_queue_arguments
+        if @opts[:retry_queue_arguments]
+          @opts[:retry_queue_arguments].transform_keys(&:to_sym)
+        elsif (queue_type = @opts.dig(:queue_options, :arguments, :'x-queue-type') ||
+                            @opts.dig(:queue_options, :arguments, 'x-queue-type'))
+          { :'x-queue-type' => queue_type }
+        else
+          {}
+        end
+      end
     end
   end
 end

data/lib/sneakers/version.rb

@@ -1,3 +1,3 @@
 module Sneakers
-  VERSION = "3.2.0"
+  VERSION = "3.3.0"
 end

data/lib/sneakers/worker.rb

@@ -76,7 +76,7 @@ module Sneakers
           end
           res = block_to_call.call(deserialized_msg, delivery_info, metadata, handler)
         end
-      rescue SignalException, SystemExit
+      rescue SignalException, SystemExit, Bunny::Exception
         # ServerEngine handles these exceptions, so they are not expected to be raised within the worker.
         # Nevertheless, they are listed here to ensure that they are not caught by the rescue block below.
         raise

data/lib/sneakers.rb

@@ -46,11 +46,11 @@ module Sneakers
     @configured = false
   end
 
-  def daemonize!(loglevel=Logger::INFO)
+  def daemonize!(loglevel=nil)
     CONFIG[:log] = 'sneakers.log'
+    CONFIG[:log_level] = loglevel || Logger::INFO
     CONFIG[:daemonize] = true
     setup_general_logger!
-    logger.level = loglevel
   end
 
   def rake_worker_classes=(worker_classes)
@@ -109,7 +109,7 @@ module Sneakers
     if [:info, :debug, :error, :warn].all?{ |meth| CONFIG[:log].respond_to?(meth) }
       @logger = CONFIG[:log]
     else
-      @logger = ServerEngine::DaemonLogger.new(CONFIG[:log])
+      @logger = ServerEngine::DaemonLogger.new(CONFIG[:log], CONFIG.slice(:log_level, :log_rotate_age, :log_rotate_size))
       @logger.formatter = Sneakers::Support::ProductionFormatter
     end
   end
@@ -124,4 +124,3 @@ module Sneakers
     @publisher = Sneakers::Publisher.new
   end
 end
-

data/spec/sneakers/worker_handlers_spec.rb

@@ -466,4 +466,118 @@ describe 'Handlers' do
       end
     end
   end
+
+  describe 'Maxretry queue arguments inheritance' do
+    let(:channel) { Object.new }
+    let(:queue) { Object.new }
+
+    before(:each) do
+      Sneakers.configure(:daemonize => true, :log => 'sneakers.log')
+      Sneakers::Worker.configure_logger(Logger.new('/dev/null'))
+      Sneakers::Worker.configure_metrics
+    end
+
+    describe 'with x-queue-type in queue_options' do
+      before do
+        @opts = {
+          :exchange => 'sneakers',
+          :queue_options => {
+            :durable => 'true',
+            :arguments => { :'x-queue-type' => 'quorum' }
+          }
+        }
+
+        mock(queue).name { 'downloads' }
+
+        @retry_exchange = Object.new
+        @error_exchange = Object.new
+        @requeue_exchange = Object.new
+        @retry_queue = Object.new
+        @error_queue = Object.new
+
+        mock(channel).exchange('downloads-retry',
+                               :type => 'topic',
+                               :durable => 'true').once { @retry_exchange }
+        mock(channel).exchange('downloads-error',
+                               :type => 'topic',
+                               :durable => 'true').once { @error_exchange }
+        mock(channel).exchange('downloads-retry-requeue',
+                               :type => 'topic',
+                               :durable => 'true').once { @requeue_exchange }
+
+        mock(channel).queue('downloads-retry',
+                            :durable => 'true',
+                            :arguments => {
+                              :'x-dead-letter-exchange' => 'downloads-retry-requeue',
+                              :'x-message-ttl' => 60000,
+                              :'x-queue-type' => 'quorum'
+                            }).once { @retry_queue }
+        mock(@retry_queue).bind(@retry_exchange, :routing_key => '#')
+
+        mock(channel).queue('downloads-error',
+                            :durable => 'true',
+                            :arguments => { :'x-queue-type' => 'quorum' }).once { @error_queue }
+        mock(@error_queue).bind(@error_exchange, :routing_key => '#')
+
+        mock(queue).bind(@requeue_exchange, :routing_key => '#')
+      end
+
+      it 'inherits queue type for retry and error queues' do
+        handler = Sneakers::Handlers::Maxretry.new(channel, queue, @opts)
+        _(handler).wont_be_nil
+      end
+    end
+
+    describe 'with explicit retry_queue_arguments override' do
+      before do
+        @opts = {
+          :exchange => 'sneakers',
+          :queue_options => {
+            :durable => 'true',
+            :arguments => { :'x-queue-type' => 'quorum' }
+          },
+          :retry_queue_arguments => { :'x-queue-type' => 'classic' }
+        }
+
+        mock(queue).name { 'downloads' }
+
+        @retry_exchange = Object.new
+        @error_exchange = Object.new
+        @requeue_exchange = Object.new
+        @retry_queue = Object.new
+        @error_queue = Object.new
+
+        mock(channel).exchange('downloads-retry',
+                               :type => 'topic',
+                               :durable => 'true').once { @retry_exchange }
+        mock(channel).exchange('downloads-error',
+                               :type => 'topic',
+                               :durable => 'true').once { @error_exchange }
+        mock(channel).exchange('downloads-retry-requeue',
+                               :type => 'topic',
+                               :durable => 'true').once { @requeue_exchange }
+
+        mock(channel).queue('downloads-retry',
+                            :durable => 'true',
+                            :arguments => {
+                              :'x-dead-letter-exchange' => 'downloads-retry-requeue',
+                              :'x-message-ttl' => 60000,
+                              :'x-queue-type' => 'classic'
+                            }).once { @retry_queue }
+        mock(@retry_queue).bind(@retry_exchange, :routing_key => '#')
+
+        mock(channel).queue('downloads-error',
+                            :durable => 'true',
+                            :arguments => { :'x-queue-type' => 'classic' }).once { @error_queue }
+        mock(@error_queue).bind(@error_exchange, :routing_key => '#')
+
+        mock(queue).bind(@requeue_exchange, :routing_key => '#')
+      end
+
+      it 'uses explicit retry_queue_arguments over inherited' do
+        handler = Sneakers::Handlers::Maxretry.new(channel, queue, @opts)
+        _(handler).wont_be_nil
+      end
+    end
+  end
 end

data/spec/sneakers/worker_spec.rb

@@ -218,7 +218,10 @@ describe Sneakers::Worker do
           :hooks => {},
           :handler => Sneakers::Handlers::Oneshot,
           :heartbeat => 30,
-          :amqp_heartbeat => 30
+          :amqp_heartbeat => 30,
+          :log_rotate_age => 5,
+          :log_rotate_size => 1048576,
+          :log_level => "debug"
         )
       end
 
@@ -256,7 +259,10 @@ describe Sneakers::Worker do
           :hooks => {},
           :handler => Sneakers::Handlers::Oneshot,
           :heartbeat => 5,
-          :amqp_heartbeat => 30
+          :amqp_heartbeat => 30,
+          :log_rotate_age => 5,
+          :log_rotate_size => 1048576,
+          :log_level => "debug"
         )
       end
 
@@ -294,7 +300,10 @@ describe Sneakers::Worker do
           :hooks => {},
           :handler => Sneakers::Handlers::Oneshot,
           :heartbeat => 30,
-          :amqp_heartbeat => 30
+          :amqp_heartbeat => 30,
+          :log_rotate_age => 5,
+          :log_rotate_size => 1048576,
+          :log_level => "debug"
         )
       end
     end
@@ -437,6 +446,14 @@ describe Sneakers::Worker do
       w.do_work(header, nil, "msg", handler)
     end
 
+    it "should not catch bunny exceptions" do
+      w = DummyWorker.new(@queue, TestPool.new)
+      mock(w).work("msg").once{ raise Bunny::Exception }
+      assert_raises(Bunny::Exception) do
+        w.do_work(nil, nil, "msg", nil)
+      end
+    end
+
     it "should log exceptions from workers" do
       handler = Object.new
       header = Object.new

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: kicks
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Dotan Nahum
 - Michael Klishin
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-26 00:00:00.000000000 Z
+date: 2026-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: serverengine
@@ -30,14 +31,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.19'
+        version: '2.24'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.19'
+        version: '2.24'
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -265,6 +266,7 @@ files:
 - ".github/dependabot.yml"
 - ".github/workflows/ci.yml"
 - ".gitignore"
+- AGENTS.md
 - ChangeLog.md
 - Dockerfile
 - Dockerfile.slim
@@ -342,6 +344,7 @@ licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/ruby-amqp/kicks
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -356,7 +359,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.4.19
+signing_key:
 specification_version: 4
 summary: Fast background processing framework for Ruby and RabbitMQ
 test_files: