shoryuken 6.2.1 → 7.0.0.alpha2

data/lib/shoryuken/polling/base_strategy.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+module Shoryuken
+  module Polling
+    # Abstract base class for queue polling strategies.
+    #
+    # This class defines the interface that all polling strategies must implement
+    # to manage queue selection and message flow control in Shoryuken workers.
+    # Polling strategies determine which queue to fetch messages from next and
+    # how to handle scenarios where queues have no messages available.
+    #
+    # @abstract Subclass and override {#next_queue}, {#messages_found}, and {#active_queues}
+    #   to implement a custom polling strategy.
+    #
+    # @example Implementing a custom polling strategy
+    #   class CustomStrategy < BaseStrategy
+    #     def initialize(queues)
+    #       @queues = queues
+    #     end
+    #
+    #     def next_queue
+    #       # Return next queue to poll
+    #       @queues.sample
+    #     end
+    #
+    #     def messages_found(queue, count)
+    #       # Handle result of polling
+    #       logger.info "Found #{count} messages in #{queue}"
+    #     end
+    #
+    #     def active_queues
+    #       # Return list of active queues
+    #       @queues
+    #     end
+    #   end
+    #
+    # @see WeightedRoundRobin
+    # @see StrictPriority
+    class BaseStrategy
+      include Util
+
+      # Returns the next queue to poll for messages.
+      #
+      # This method should return a QueueConfiguration object representing
+      # the next queue that should be polled for messages, or nil if no
+      # queues are currently available for polling.
+      #
+      # @abstract Subclasses must implement this method
+      # @return [QueueConfiguration, nil] Next queue to poll, or nil if none available
+      # @raise [NotImplementedError] if not implemented by subclass
+      def next_queue
+        fail NotImplementedError
+      end
+
+      # Called when messages are found (or not found) in a queue.
+      #
+      # This method is invoked after polling a queue to inform the strategy
+      # about the number of messages that were retrieved. Strategies can use
+      # this information to make decisions about future polling behavior,
+      # such as pausing empty queues or adjusting queue weights.
+      #
+      # @abstract Subclasses must implement this method
+      # @param _queue [String] The name of the queue that was polled
+      # @param _messages_found [Integer] The number of messages retrieved
+      # @raise [NotImplementedError] if not implemented by subclass
+      def messages_found(_queue, _messages_found)
+        fail NotImplementedError
+      end
+
+      # Called when a message from a queue has been processed.
+      #
+      # This optional callback is invoked after a message has been successfully
+      # processed by a worker. Strategies can use this information for cleanup
+      # or to adjust their polling behavior.
+      #
+      # @param _queue [String] The name of the queue whose message was processed
+      # @return [void]
+      def message_processed(_queue); end
+
+      # Returns the list of currently active queues.
+      #
+      # This method should return an array representing the queues that are
+      # currently active and available for polling. The format may vary by
+      # strategy implementation.
+      #
+      # @abstract Subclasses must implement this method
+      # @return [Array] List of active queues
+      # @raise [NotImplementedError] if not implemented by subclass
+      def active_queues
+        fail NotImplementedError
+      end
+
+      # Compares this strategy with another object for equality.
+      #
+      # Two strategies are considered equal if they have the same active queues.
+      # This method also supports comparison with Array objects for backward
+      # compatibility.
+      #
+      # @param other [Object] Object to compare with
+      # @return [Boolean] true if strategies are equivalent
+      def ==(other)
+        case other
+        when Array
+          @queues == other
+        else
+          if other.respond_to?(:active_queues)
+            active_queues == other.active_queues
+          else
+            false
+          end
+        end
+      end
+
+      # Returns the delay time for pausing empty queues.
+      #
+      # This method returns the amount of time (in seconds) that empty queues
+      # should be paused before being polled again. The delay can be set at
+      # the strategy level or falls back to the global Shoryuken delay setting.
+      #
+      # @return [Float] Delay time in seconds
+      def delay
+        @delay || Shoryuken.options[:delay].to_f
+      end
+    end
+  end
+end

data/lib/shoryuken/polling/queue_configuration.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+module Shoryuken
+  module Polling
+    # Configuration object representing a queue and its associated options.
+    #
+    # This class encapsulates a queue name along with any polling-specific
+    # options or metadata. It provides a structured way to pass queue
+    # information between polling strategies and the message fetching system.
+    #
+    # The class extends Struct to provide attribute accessors for name and options
+    # while adding custom behavior for equality comparison and string representation.
+    #
+    # @example Creating a basic queue configuration
+    #   config = QueueConfiguration.new('my_queue', {})
+    #   config.name     # => 'my_queue'
+    #   config.options  # => {}
+    #
+    # @example Creating a queue configuration with options
+    #   config = QueueConfiguration.new('priority_queue', { priority: :high })
+    #   config.name     # => 'priority_queue'
+    #   config.options  # => { priority: :high }
+    #
+    # @example Comparing configurations
+    #   config1 = QueueConfiguration.new('queue', {})
+    #   config2 = QueueConfiguration.new('queue', {})
+    #   config1 == config2  # => true
+    #   config1 == 'queue'  # => true (when options are empty)
+    #
+    # @attr_reader [String] name The name of the queue
+    # @attr_reader [Hash] options Additional options or metadata for the queue
+    QueueConfiguration = Struct.new(:name, :options) do
+      # Generates a hash value based on the queue name.
+      #
+      # This method ensures that QueueConfiguration objects can be used
+      # as hash keys and that configurations with the same queue name
+      # will have the same hash value regardless of their options.
+      #
+      # @return [Integer] Hash value based on the queue name
+      def hash
+        name.hash
+      end
+
+      # Compares this configuration with another object for equality.
+      #
+      # Two QueueConfiguration objects are equal if they have the same name
+      # and options. For convenience, a configuration with empty options can
+      # also be compared directly with a string queue name.
+      #
+      # @param other [Object] The object to compare with
+      # @return [Boolean] true if the objects are considered equal
+      #
+      # @example Comparing with another QueueConfiguration
+      #   config1 = QueueConfiguration.new('queue', {})
+      #   config2 = QueueConfiguration.new('queue', {})
+      #   config1 == config2  # => true
+      #
+      # @example Comparing with a string (only when options are empty)
+      #   config = QueueConfiguration.new('queue', {})
+      #   config == 'queue'  # => true
+      #
+      #   config_with_options = QueueConfiguration.new('queue', { weight: 5 })
+      #   config_with_options == 'queue'  # => false
+      def ==(other)
+        case other
+        when String
+          if options.empty?
+            name == other
+          else
+            false
+          end
+        else
+          super
+        end
+      end
+
+      alias_method :eql?, :==
+
+      # Returns a string representation of the queue configuration.
+      #
+      # For configurations with empty options, returns just the queue name.
+      # For configurations with options, returns a detailed representation
+      # showing both the name and the options hash.
+      #
+      # @return [String] String representation of the configuration
+      #
+      # @example Simple queue without options
+      #   config = QueueConfiguration.new('simple_queue', {})
+      #   config.to_s  # => 'simple_queue'
+      #
+      # @example Queue with options
+      #   config = QueueConfiguration.new('complex_queue', { priority: :high })
+      #   config.to_s  # => '#<QueueConfiguration complex_queue options={:priority=>:high}>'
+      def to_s
+        if options&.empty?
+          name
+        else
+          "#<QueueConfiguration #{name} options=#{options.inspect}>"
+        end
+      end
+    end
+  end
+end

data/lib/shoryuken/polling/strict_priority.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Shoryuken
   module Polling
     class StrictPriority < BaseStrategy

data/lib/shoryuken/polling/weighted_round_robin.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Shoryuken
   module Polling
     class WeightedRoundRobin < BaseStrategy

data/lib/shoryuken/processor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Shoryuken
   class Processor
     include Util
@@ -16,6 +18,7 @@ module Shoryuken
     def process
       worker_perform = proc do
         return logger.error { "No worker found for #{queue}" } unless worker
+
         Shoryuken::Logging.with_context("#{worker_name(worker.class, sqs_msg, body)}/#{queue}/#{sqs_msg.message_id}") do
           worker.class.server_middleware.invoke(worker, queue, sqs_msg, body) do
             worker.perform(sqs_msg, body)
@@ -30,8 +33,8 @@ module Shoryuken
       else
         worker_perform.call
       end
-    rescue Exception => ex
-      Array(Shoryuken.exception_handlers).each { |handler| handler.call(ex, queue, sqs_msg) }
+    rescue Exception => e
+      Array(Shoryuken.exception_handlers).each { |handler| handler.call(e, queue, sqs_msg) }
 
       raise
     end

data/lib/shoryuken/queue.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Shoryuken
   class Queue
     include Util
 
-    FIFO_ATTR               = 'FifoQueue'.freeze
-    MESSAGE_GROUP_ID        = 'ShoryukenMessage'.freeze
-    VISIBILITY_TIMEOUT_ATTR = 'VisibilityTimeout'.freeze
+    FIFO_ATTR               = 'FifoQueue'
+    MESSAGE_GROUP_ID        = 'ShoryukenMessage'
+    VISIBILITY_TIMEOUT_ATTR = 'VisibilityTimeout'
 
     attr_accessor :name, :client, :url
 
@@ -50,7 +52,7 @@ module Shoryuken
 
     def fifo?
       # Make sure the memoization work with boolean to avoid multiple calls to SQS
-      # see https://github.com/phstc/shoryuken/pull/529
+      # see https://github.com/ruby-shoryuken/shoryuken/pull/529
       return @_fifo if defined?(@_fifo)
 
       @_fifo = queue_attributes.attributes[FIFO_ATTR] == 'true'

data/lib/shoryuken/runner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $stdout.sync = true
 
 require 'singleton'
@@ -7,7 +9,6 @@ require 'erb'
 require 'shoryuken'
 
 module Shoryuken
-  # rubocop:disable Lint/InheritException
   # See: https://github.com/mperham/sidekiq/blob/33f5d6b2b6c0dfaab11e5d39688cab7ebadc83ae/lib/sidekiq/cli.rb#L20
   class Shutdown < Interrupt; end
 
@@ -19,13 +20,11 @@ module Shoryuken
       self_read, self_write = IO.pipe
 
       %w[INT TERM USR1 TSTP TTIN].each do |sig|
-        begin
-          trap sig do
-            self_write.puts(sig)
-          end
-        rescue ArgumentError
-          puts "Signal #{sig} not supported"
+        trap sig do
+          self_write.puts(sig)
         end
+      rescue ArgumentError
+        puts "Signal #{sig} not supported"
       end
 
       loader = EnvironmentLoader.setup_options(options)
@@ -77,11 +76,9 @@ module Shoryuken
       Process.daemon(true, true)
 
       files_to_reopen.each do |file|
-        begin
-          file.reopen file.path, 'a+'
-          file.sync = true
-        rescue ::Exception
-        end
+        file.reopen file.path, 'a+'
+        file.sync = true
+      rescue ::Exception
       end
 
       [$stdout, $stderr].each do |io|

data/lib/shoryuken/util.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Shoryuken
   module Util
     def logger
@@ -9,12 +11,10 @@ module Shoryuken
       arr = Shoryuken.options[:lifecycle_events][event]
       arr.reverse! if reverse
       arr.each do |block|
-        begin
-          block.call(event_options)
-        rescue => ex
-          logger.warn(event: event)
-          logger.warn "#{ex.class.name}: #{ex.message}"
-        end
+        block.call(event_options)
+      rescue => e
+        logger.warn(event: event)
+        logger.warn "#{e.class.name}: #{e.message}"
       end
     end
 

data/lib/shoryuken/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Shoryuken
-  VERSION = '6.2.1'.freeze
+  VERSION = '7.0.0.alpha2'
 end

data/lib/shoryuken/worker/default_executor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Shoryuken
   module Worker
     class DefaultExecutor

data/lib/shoryuken/worker/inline_executor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Shoryuken
   module Worker
     class InlineExecutor
@@ -5,13 +7,18 @@ module Shoryuken
         def perform_async(worker_class, body, options = {})
           body = JSON.dump(body) if body.is_a?(Hash)
           queue_name = options.delete(:queue) || worker_class.get_shoryuken_options['queue']
+          message_attributes = options.delete(:message_attributes) || {}
+          message_attributes['shoryuken_class'] = {
+            string_value: worker_class.to_s,
+            data_type: 'String'
+          }
 
-          sqs_msg = OpenStruct.new(
+          sqs_msg = InlineMessage.new(
             body: body,
             attributes: nil,
             md5_of_body: nil,
             md5_of_message_attributes: nil,
-            message_attributes: nil,
+            message_attributes: message_attributes,
             message_id: nil,
             receipt_handle: nil,
             delete: nil,

data/lib/shoryuken/worker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Shoryuken
   module Worker
     def self.included(base)

data/lib/shoryuken/worker_registry.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Shoryuken
   class WorkerRegistry
     def batch_receive_messages?(_queue)

data/lib/shoryuken.rb

@@ -1,43 +1,17 @@
+# frozen_string_literal: true
+
 require 'yaml'
 require 'json'
-require 'aws-sdk-core'
-begin
-  require 'aws-sdk-sqs' unless defined?(Aws::SQS)
-rescue LoadError
-  fail "AWS SDK 3 requires aws-sdk-sqs to be installed separately. Please add gem 'aws-sdk-sqs' to your Gemfile"
-end
+require 'aws-sdk-sqs'
 require 'time'
 require 'concurrent'
 require 'forwardable'
+require 'zeitwerk'
 
-require 'shoryuken/version'
-require 'shoryuken/core_ext'
-require 'shoryuken/util'
-require 'shoryuken/logging'
-require 'shoryuken/environment_loader'
-require 'shoryuken/queue'
-require 'shoryuken/message'
-require 'shoryuken/client'
-require 'shoryuken/worker'
-require 'shoryuken/worker/default_executor'
-require 'shoryuken/worker/inline_executor'
-require 'shoryuken/worker_registry'
-require 'shoryuken/default_worker_registry'
-require 'shoryuken/default_exception_handler'
-require 'shoryuken/middleware/chain'
-require 'shoryuken/middleware/server/auto_delete'
-Shoryuken::Middleware::Server.autoload :AutoExtendVisibility, 'shoryuken/middleware/server/auto_extend_visibility'
-require 'shoryuken/middleware/server/exponential_backoff_retry'
-require 'shoryuken/middleware/server/timing'
-require 'shoryuken/polling/base'
-require 'shoryuken/polling/weighted_round_robin'
-require 'shoryuken/polling/strict_priority'
-require 'shoryuken/manager'
-require 'shoryuken/launcher'
-require 'shoryuken/processor'
-require 'shoryuken/body_parser'
-require 'shoryuken/fetcher'
-require 'shoryuken/options'
+# Set up Zeitwerk loader
+loader = Zeitwerk::Loader.for_gem
+loader.ignore("#{__dir__}/shoryuken/extensions")
+loader.setup
 
 module Shoryuken
   extend SingleForwardable
@@ -57,6 +31,8 @@ module Shoryuken
     :groups,
     :add_queue,
     :ungrouped_queues,
+    :thread_priority,
+    :thread_priority=,
     :worker_registry,
     :worker_registry=,
     :worker_executor,
@@ -78,6 +54,7 @@ module Shoryuken
     :exception_handlers=,
     :options,
     :logger,
+    :logger=,
     :register_worker,
     :configure_server,
     :server?,

data/renovate.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:recommended"
+  ],
+  "github-actions": {
+    "enabled": true,
+    "pinDigests": true
+  },
+  "packageRules": [
+    {
+      "matchManagers": ["github-actions"],
+      "minimumReleaseAge": "7 days"
+    }
+  ]
+}

data/shoryuken.gemspec

@@ -1,4 +1,3 @@
-
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'shoryuken/version'
@@ -17,11 +16,15 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'aws-sdk-sqs', '>= 1.66.0'
+  spec.add_dependency 'concurrent-ruby'
+  spec.add_dependency 'thor'
+  spec.add_dependency 'zeitwerk', '~> 2.6'
+
   spec.add_development_dependency 'dotenv'
+  spec.add_development_dependency 'ostruct'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
 
-  spec.add_dependency 'aws-sdk-core', '>= 2'
-  spec.add_dependency 'concurrent-ruby'
-  spec.add_dependency 'thor'
+  spec.required_ruby_version = '>= 3.1.0'
 end

data/spec/integration/launcher_spec.rb

@@ -1,13 +1,12 @@
-require 'spec_helper'
-require 'shoryuken/manager'
-require 'shoryuken/launcher'
+# frozen_string_literal: true
+
 require 'securerandom'
 
 RSpec.describe Shoryuken::Launcher do
   let(:sqs_client) do
     Aws::SQS::Client.new(
       region: 'us-east-1',
-      endpoint: 'http://localhost:5000',
+      endpoint: 'http://localhost:4566',
       access_key_id: 'fake',
       secret_access_key: 'fake'
     )

data/spec/shared_examples_for_active_job.rb

@@ -24,7 +24,7 @@ RSpec.shared_examples 'active_job_adapters' do
       expect(queue).to receive(:send_message) do |hash|
         expect(hash[:message_deduplication_id]).to_not be
         expect(hash[:message_attributes]['shoryuken_class'][:string_value]).to eq(described_class::JobWrapper.to_s)
-        expect(hash[:message_attributes]['shoryuken_class'][:data_type]).to eq("String")
+        expect(hash[:message_attributes]['shoryuken_class'][:data_type]).to eq('String')
         expect(hash[:message_attributes].keys).to eq(['shoryuken_class'])
       end
       expect(Shoryuken).to receive(:register_worker).with(job.queue_name, described_class::JobWrapper)
@@ -133,9 +133,9 @@ RSpec.shared_examples 'active_job_adapters' do
 
         expect(queue).to receive(:send_message) do |hash|
           expect(hash[:message_attributes]['shoryuken_class'][:string_value]).to eq(described_class::JobWrapper.to_s)
-          expect(hash[:message_attributes]['shoryuken_class'][:data_type]).to eq("String")
+          expect(hash[:message_attributes]['shoryuken_class'][:data_type]).to eq('String')
           expect(hash[:message_attributes]['tracer_id'][:string_value]).to eq(custom_message_attributes['tracer_id'][:string_value])
-          expect(hash[:message_attributes]['tracer_id'][:data_type]).to eq("String")
+          expect(hash[:message_attributes]['tracer_id'][:data_type]).to eq('String')
         end
         expect(Shoryuken).to receive(:register_worker).with(job.queue_name, described_class::JobWrapper)
 
@@ -157,7 +157,8 @@ RSpec.shared_examples 'active_job_adapters' do
         it 'should enqueue a message with the message_attributes specified on the job' do
           expect(queue).to receive(:send_message) do |hash|
             expect(hash[:message_attributes]['tracer_id']).to eq({ data_type: 'String', string_value: 'job-value' })
-            expect(hash[:message_attributes]['shoryuken_class']).to eq({ data_type: 'String', string_value: described_class::JobWrapper.to_s })
+            expect(hash[:message_attributes]['shoryuken_class']).to eq({ data_type: 'String',
+                                                                         string_value: described_class::JobWrapper.to_s })
           end
           subject.enqueue job
         end
@@ -185,8 +186,10 @@ RSpec.shared_examples 'active_job_adapters' do
 
           expect(queue).to receive(:send_message) do |hash|
             expect(hash[:message_attributes]['tracer_id']).to be_nil
-            expect(hash[:message_attributes]['options_tracer_id']).to eq({ data_type: 'String', string_value: 'options-value' })
-            expect(hash[:message_attributes]['shoryuken_class']).to eq({ data_type: 'String', string_value: described_class::JobWrapper.to_s })
+            expect(hash[:message_attributes]['options_tracer_id']).to eq({ data_type: 'String',
+                                                                           string_value: 'options-value' })
+            expect(hash[:message_attributes]['shoryuken_class']).to eq({ data_type: 'String',
+                                                                         string_value: described_class::JobWrapper.to_s })
           end
           subject.enqueue job, message_attributes: custom_message_attributes
         end
@@ -225,7 +228,8 @@ RSpec.shared_examples 'active_job_adapters' do
 
       it 'should enqueue a message with the message_system_attributes specified on the job' do
         expect(queue).to receive(:send_message) do |hash|
-          expect(hash[:message_system_attributes]['AWSTraceHeader']).to eq({ data_type: 'String', string_value: 'job-value' })
+          expect(hash[:message_system_attributes]['AWSTraceHeader']).to eq({ data_type: 'String',
+                                                                             string_value: 'job-value' })
         end
         subject.enqueue job
       end
@@ -253,7 +257,8 @@ RSpec.shared_examples 'active_job_adapters' do
 
         expect(queue).to receive(:send_message) do |hash|
           expect(hash[:message_system_attributes]['job_trace_header']).to be_nil
-          expect(hash[:message_system_attributes]['options_trace_header']).to eq({ data_type: 'String', string_value: 'options-value' })
+          expect(hash[:message_system_attributes]['options_trace_header']).to eq({ data_type: 'String',
+                                                                                   string_value: 'options-value' })
         end
         subject.enqueue job, message_system_attributes: custom_message_attributes
       end

data/spec/shoryuken/body_parser_spec.rb

@@ -1,5 +1,4 @@
-require 'spec_helper'
-require 'shoryuken/body_parser'
+# frozen_string_literal: true
 
 RSpec.describe Shoryuken::BodyParser do
   let(:sqs_msg) { double }
@@ -69,8 +68,7 @@ RSpec.describe Shoryuken::BodyParser do
       end
 
       specify do
-        expect { described_class.parse(TestWorker, sqs_msg) }
-          .to raise_error(JSON::ParserError, /unexpected token at 'invalid JSON'/)
+        expect { described_class.parse(TestWorker, sqs_msg) }.to raise_error(JSON::ParserError)
       end
     end
 

data/spec/shoryuken/client_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
 RSpec.describe Shoryuken::Client do
   let(:credentials) { Aws::Credentials.new('access_key_id', 'secret_access_key') }