Fix ActiveJob keyword arguments support (#961) (#962)

ActiveJob jobs with keyword arguments were broken in Shoryuken 7.0 because
the SQSSendMessageParametersSupport module's initialize method did not
properly forward keyword arguments to the base class.

Use argument forwarding (...) to ensure all arguments including keyword
arguments are correctly passed through when prepending the module to
ActiveJob::Base.

Fixes #961

Author: mensfeld

CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+- Fix: ActiveJob keyword arguments support
+  - Jobs with keyword arguments were broken due to improper argument forwarding in `SQSSendMessageParametersSupport#initialize`
+  - Use Ruby's argument forwarding (`...`) to properly pass all arguments including keyword arguments
+  - [#962](https://github.com/ruby-shoryuken/shoryuken/pull/962)
+
 - Fix: Replace `ArgumentError` with custom `FifoDelayNotSupportedError` for FIFO delay errors
   - Provides more specific error type for programmatic error handling
   - [#957](https://github.com/ruby-shoryuken/shoryuken/pull/957)

lib/active_job/extensions.rb

@@ -20,9 +20,10 @@ module SQSSendMessageParametersAccessor
     module SQSSendMessageParametersSupport
       # Initializes a new ActiveJob instance with empty SQS parameters
       #
-      # @param arguments [Array] the job arguments
-      def initialize(*arguments)
-        super(*arguments)
+      # Uses argument forwarding (...) to properly pass all arguments including
+      # keyword arguments to the base class.
+      def initialize(...)
+        super(...)
         self.sqs_send_message_parameters = {}
       end
 

lib/shoryuken/version.rb

@@ -2,5 +2,5 @@
 
 module Shoryuken
   # Current version of the Shoryuken gem
-  VERSION = '7.0.0'
+  VERSION = '7.0.1'
 end

spec/integration/active_job/keyword_arguments/keyword_arguments_spec.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+# Integration test for ActiveJob keyword arguments support
+# Regression test for: https://github.com/ruby-shoryuken/shoryuken/issues/961
+#
+# In Shoryuken 7.0, the SQSSendMessageParametersSupport module's initialize method
+# breaks keyword argument passing to ActiveJob jobs because it lacks ruby2_keywords.
+
+setup_localstack
+setup_active_job
+
+queue_name = DT.queue
+create_test_queue(queue_name)
+
+# Job that accepts keyword arguments - this was broken in Shoryuken 7.0
+class KeywordArgumentsTestJob < ActiveJob::Base
+  def perform(name:, count:, enabled: false)
+    DT[:executions] << {
+      name: name,
+      count: count,
+      enabled: enabled,
+      job_id: job_id
+    }
+  end
+end
+
+KeywordArgumentsTestJob.queue_as(queue_name)
+
+Shoryuken.add_group('default', 1)
+Shoryuken.add_queue(queue_name, 1, 'default')
+Shoryuken.register_worker(queue_name, Shoryuken::ActiveJob::JobWrapper)
+
+# Enqueue jobs with keyword arguments
+# This is where the bug manifests - the job instantiation fails
+KeywordArgumentsTestJob.perform_later(name: 'first', count: 1)
+KeywordArgumentsTestJob.perform_later(name: 'second', count: 2, enabled: true)
+
+poll_queues_until(timeout: 30) do
+  DT[:executions].size >= 2
+end
+
+assert_equal(2, DT[:executions].size, "Expected 2 job executions, got #{DT[:executions].size}")
+
+# Find the executions by name
+first_exec = DT[:executions].find { |e| e[:name] == 'first' }
+second_exec = DT[:executions].find { |e| e[:name] == 'second' }
+
+assert(first_exec, "Expected to find 'first' job execution")
+assert(second_exec, "Expected to find 'second' job execution")
+
+# Verify keyword arguments were passed correctly
+assert_equal('first', first_exec[:name])
+assert_equal(1, first_exec[:count])
+assert_equal(false, first_exec[:enabled])
+
+assert_equal('second', second_exec[:name])
+assert_equal(2, second_exec[:count])
+assert_equal(true, second_exec[:enabled])
+
+# Verify job IDs
+job_ids = DT[:executions].map { |e| e[:job_id] }
+assert(job_ids.all? { |id| id && !id.empty? }, "All jobs should have job IDs")
+assert_equal(2, job_ids.uniq.size, "All job IDs should be unique")

spec/lib/active_job/extensions_spec.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'spec_helper'
+require 'active_job'
 
 # Skip this spec if ActiveSupport is not available, as the extensions require it
 if defined?(ActiveSupport)
@@ -69,6 +70,81 @@ def enqueue(options = {})
             expect(job_class.method(:new)).to respond_to(:ruby2_keywords) if RUBY_VERSION >= '2.7'
           end
         end
+
+        # Regression test for https://github.com/ruby-shoryuken/shoryuken/issues/961
+        # ActiveJob with keyword arguments was broken in Shoryuken 7.0 because
+        # the SQSSendMessageParametersSupport module's initialize method did not
+        # properly forward keyword arguments using ruby2_keywords.
+        context 'with keyword arguments' do
+          let(:base_class_with_kwargs) do
+            Class.new do
+              attr_accessor :sqs_send_message_parameters
+              attr_reader :received_name, :received_count, :received_enabled
+
+              def initialize(name:, count:, enabled: false)
+                @received_name = name
+                @received_count = count
+                @received_enabled = enabled
+              end
+            end
+          end
+
+          let(:job_class_with_kwargs) do
+            Class.new(base_class_with_kwargs) do
+              prepend Shoryuken::ActiveJob::SQSSendMessageParametersSupport
+            end
+          end
+
+          it 'properly forwards keyword arguments to the base class' do
+            job = job_class_with_kwargs.new(name: 'test_name', count: 42, enabled: true)
+
+            expect(job.received_name).to eq('test_name')
+            expect(job.received_count).to eq(42)
+            expect(job.received_enabled).to eq(true)
+            expect(job.sqs_send_message_parameters).to eq({})
+          end
+
+          it 'properly forwards keyword arguments with default values' do
+            job = job_class_with_kwargs.new(name: 'another_test', count: 10)
+
+            expect(job.received_name).to eq('another_test')
+            expect(job.received_count).to eq(10)
+            expect(job.received_enabled).to eq(false)
+            expect(job.sqs_send_message_parameters).to eq({})
+          end
+        end
+
+        # Regression test for https://github.com/ruby-shoryuken/shoryuken/issues/961
+        # Test with a mix of positional and keyword arguments
+        context 'with mixed positional and keyword arguments' do
+          let(:base_class_mixed) do
+            Class.new do
+              attr_accessor :sqs_send_message_parameters
+              attr_reader :received_id, :received_data, :received_options
+
+              def initialize(id, data, options: {})
+                @received_id = id
+                @received_data = data
+                @received_options = options
+              end
+            end
+          end
+
+          let(:job_class_mixed) do
+            Class.new(base_class_mixed) do
+              prepend Shoryuken::ActiveJob::SQSSendMessageParametersSupport
+            end
+          end
+
+          it 'properly forwards mixed arguments to the base class' do
+            job = job_class_mixed.new('job_id', { key: 'value' }, options: { retry: true })
+
+            expect(job.received_id).to eq('job_id')
+            expect(job.received_data).to eq({ key: 'value' })
+            expect(job.received_options).to eq({ retry: true })
+            expect(job.sqs_send_message_parameters).to eq({})
+          end
+        end
       end
 
       describe '#enqueue' do