shoryuken 3.0.9 → 3.1.0

data/lib/shoryuken.rb

@@ -20,185 +20,51 @@ 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'
+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/fetcher'
+require 'shoryuken/options'
 
 module Shoryuken
-  DEFAULTS = {
-    concurrency: 25,
-    queues: [],
-    aws: {},
-    delay: 0,
-    timeout: 8,
-    lifecycle_events: {
-      startup: [],
-      dispatch: [],
-      quiet: [],
-      shutdown: []
-    },
-    polling_strategy: Polling::WeightedRoundRobin
-  }.freeze
-
-  @@queues                          = []
-  @@worker_registry                 = DefaultWorkerRegistry.new
-  @@active_job_queue_name_prefixing = false
-  @@sqs_client                      = nil
-  @@sqs_client_receive_message_opts = {}
-  @@start_callback                  = nil
-  @@stop_callback                   = nil
-
-  class << self
-    def queues
-      @@queues
-    end
-
-    def add_queue(queue, priority = 1)
-      priority.times { queues << queue }
-    end
-
-    def worker_registry
-      @@worker_registry
-    end
-
-    def worker_registry=(worker_registry)
-      @@worker_registry = worker_registry
-    end
-
-    def start_callback
-      @@start_callback
-    end
-
-    def start_callback=(start_callback)
-      @@start_callback = start_callback
-    end
-
-    def stop_callback
-      @@stop_callback
-    end
-
-    def stop_callback=(stop_callback)
-      @@stop_callback = stop_callback
-    end
-
-    def active_job_queue_name_prefixing
-      @@active_job_queue_name_prefixing
-    end
-
-    def active_job_queue_name_prefixing=(active_job_queue_name_prefixing)
-      @@active_job_queue_name_prefixing = active_job_queue_name_prefixing
-    end
-
-    def sqs_client
-      @@sqs_client ||= Aws::SQS::Client.new
-    end
-
-    def sqs_client=(sqs_client)
-      @@sqs_client = sqs_client
-    end
-
-    def sqs_client_receive_message_opts
-      @@sqs_client_receive_message_opts
-    end
-
-    def sqs_client_receive_message_opts=(sqs_client_receive_message_opts)
-      @@sqs_client_receive_message_opts = sqs_client_receive_message_opts
-    end
-
-    def options
-      @@options ||= DEFAULTS.dup
-    end
-
-    def logger
-      Shoryuken::Logging.logger
-    end
-
-    def register_worker(*args)
-      @@worker_registry.register_worker(*args)
-    end
-
-    def configure_server
-      yield self if server?
-    end
-
-    def server_middleware
-      @@server_chain ||= default_server_middleware
-      yield @@server_chain if block_given?
-      @@server_chain
-    end
-
-    def configure_client
-      yield self unless server?
-    end
-
-    def client_middleware
-      @@client_chain ||= default_client_middleware
-      yield @@client_chain if block_given?
-      @@client_chain
-    end
-
-    def default_worker_options
-      @@default_worker_options ||= {
-        'queue'                   => 'default',
-        'delete'                  => false,
-        'auto_delete'             => false,
-        'auto_visibility_timeout' => false,
-        'retry_intervals'         => nil,
-        'batch'                   => false
-      }
-    end
-
-    def default_worker_options=(default_worker_options)
-      @@default_worker_options = default_worker_options
-    end
-
-    def on_start(&block)
-      @@start_callback = block
-    end
-
-    def on_stop(&block)
-      @@stop_callback = block
-    end
-
-    # Register a block to run at a point in the Shoryuken lifecycle.
-    # :startup, :quiet or :shutdown are valid events.
-    #
-    #   Shoryuken.configure_server do |config|
-    #     config.on(:shutdown) do
-    #       puts "Goodbye cruel world!"
-    #     end
-    #   end
-    def on(event, &block)
-      fail ArgumentError, "Symbols only please: #{event}" unless event.is_a?(Symbol)
-      fail ArgumentError, "Invalid event name: #{event}" unless options[:lifecycle_events].key?(event)
-      options[:lifecycle_events][event] << block
-    end
-
-    private
-
-    def default_server_middleware
-      Middleware::Chain.new do |m|
-        m.add Middleware::Server::Timing
-        m.add Middleware::Server::ExponentialBackoffRetry
-        m.add Middleware::Server::AutoDelete
-        m.add Middleware::Server::AutoExtendVisibility
-        if defined?(::ActiveRecord::Base)
-          require 'shoryuken/middleware/server/active_record'
-          m.add Middleware::Server::ActiveRecord
-        end
-      end
-    end
-
-    def default_client_middleware
-      Middleware::Chain.new
-    end
-
-    def server?
-      defined?(Shoryuken::CLI)
-    end
-  end
+  extend SingleForwardable
+
+  def_delegators(
+    :'Shoryuken::Options',
+    :add_group,
+    :groups,
+    :add_queue,
+    :ungrouped_queues,
+    :worker_registry,
+    :worker_registry=,
+    :polling_strategy,
+    :start_callback,
+    :start_callback=,
+    :stop_callback,
+    :stop_callback=,
+    :active_job_queue_name_prefixing,
+    :active_job_queue_name_prefixing=,
+    :sqs_client,
+    :sqs_client=,
+    :sqs_client_receive_message_opts,
+    :sqs_client_receive_message_opts=,
+    :options,
+    :logger,
+    :register_worker,
+    :configure_server,
+    :server?,
+    :server_middleware,
+    :configure_client,
+    :client_middleware,
+    :default_worker_options,
+    :default_worker_options=,
+    :on_start,
+    :on_stop,
+    :on
+  )
 end
 
 require 'shoryuken/extensions/active_job_adapter' if defined?(::ActiveJob)

data/shoryuken.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry-byebug'
   spec.add_development_dependency 'dotenv'
 
-  spec.add_dependency 'aws-sdk-core', '~> 2'
+  spec.add_dependency 'aws-sdk-core', '> 2'
   spec.add_dependency 'concurrent-ruby'
   spec.add_dependency 'thor'
 end

data/spec/integration/launcher_spec.rb

@@ -6,25 +6,31 @@ require 'securerandom'
 RSpec.describe Shoryuken::Launcher do
   describe 'Consuming messages', slow: :true do
     before do
+      Aws.config[:stub_responses] = false
+      Aws.config[:region] = 'us-east-1'
+
       StandardWorker.received_messages = 0
 
-      queue = "test_shoryuken#{StandardWorker}_#{SecureRandom.uuid}"
+      queue = "shoryuken-travis-#{StandardWorker}-#{SecureRandom.uuid}"
 
-      Shoryuken::Client.sqs.create_queue queue_name: queue
+      Shoryuken::Client.sqs.create_queue(queue_name: queue)
 
-      Shoryuken.queues << queue
+      Shoryuken.add_group('default', 1)
+      Shoryuken.add_queue(queue, 1, 'default')
 
       StandardWorker.get_shoryuken_options['queue'] = queue
 
-      Shoryuken.register_worker queue, StandardWorker
+      Shoryuken.register_worker(queue, StandardWorker)
     end
 
     after do
+      Aws.config[:stub_responses] = true
+
       queue_url = Shoryuken::Client.sqs.get_queue_url(
         queue_name: StandardWorker.get_shoryuken_options['queue']
       ).queue_url
 
-      Shoryuken::Client.sqs.delete_queue queue_url: queue_url
+      Shoryuken::Client.sqs.delete_queue(queue_url: queue_url)
     end
 
     it 'consumes as a command worker' do
@@ -61,7 +67,7 @@ RSpec.describe Shoryuken::Launcher do
     end
 
     def poll_queues_until
-      subject.run
+      subject.start
 
       Timeout::timeout(10) do
         begin

data/spec/shoryuken/environment_loader_spec.rb

@@ -15,20 +15,11 @@ RSpec.describe Shoryuken::EnvironmentLoader do
       allow(subject).to receive(:patch_deprecated_workers)
     end
 
-    it 'parses' do
-      Shoryuken.options[:queues] = ['queue_1']
+    specify do
+      Shoryuken.options[:queues] = ['queue1', ['queue2', 2]]
       subject.load
 
-      expect(Shoryuken.queues).to eq(%w(queue_1))
-    end
-
-    context 'with priority' do
-      it 'parses' do
-        Shoryuken.options[:queues] = ['queue_1', ['queue_2', 2]]
-        subject.load
-
-        expect(Shoryuken.queues).to eq(%w(queue_1 queue_2 queue_2))
-      end
+      expect(Shoryuken.groups['default'][:queues]).to eq(%w(queue1 queue2 queue2))
     end
   end
 end

data/spec/shoryuken/fetcher_spec.rb

@@ -2,36 +2,51 @@ require 'spec_helper'
 require 'shoryuken/manager'
 require 'shoryuken/fetcher'
 
-describe Shoryuken::Fetcher do
-  let(:queue)      { instance_double('Shoryuken::Queue') }
-  let(:queue_name) { 'default' }
+RSpec.describe Shoryuken::Fetcher do
+  let(:queue)        { instance_double('Shoryuken::Queue') }
+  let(:queue_name)   { 'default' }
   let(:queue_config) { Shoryuken::Polling::QueueConfiguration.new(queue_name, {}) }
+  let(:group)        { 'default' }
 
   let(:sqs_msg) do
-    double(Shoryuken::Message,
+    double(
+      Shoryuken::Message,
       queue_url: queue_name,
       body: 'test',
       message_id: 'fc754df79cc24c4196ca5996a44b771e',
-          )
+    )
   end
 
-  subject { described_class.new }
+  subject { described_class.new(group) }
 
   describe '#fetch' do
-    it 'calls Shoryuken::Client to receive messages' do
+    let(:limit) { 1 }
+
+    specify do
       expect(Shoryuken::Client).to receive(:queues).with(queue_name).and_return(queue)
+
+      Shoryuken.sqs_client_receive_message_opts[group] = { wait_time_seconds: 10 }
+
       expect(queue).to receive(:receive_messages).
-        with(max_number_of_messages: 1, attribute_names: ['All'], message_attribute_names: ['All']).
+        with(wait_time_seconds: 10, max_number_of_messages: limit, message_attribute_names: ['All'], attribute_names: ['All']).
         and_return([])
-      subject.fetch(queue_config, 1)
+
+      subject.fetch(queue_config, limit)
     end
 
-    it 'maxes messages to receive to 10 (SQS limit)' do
-      allow(Shoryuken::Client).to receive(:queues).with(queue_name).and_return(queue)
-      expect(queue).to receive(:receive_messages).
-        with(max_number_of_messages: 10, attribute_names: ['All'], message_attribute_names: ['All']).
-        and_return([])
-      subject.fetch(queue_config, 20)
+    context 'when limit is greater than FETCH_LIMIT' do
+      let(:limit) { 20 }
+
+      specify do
+        Shoryuken.sqs_client_receive_message_opts[group] = {}
+
+        allow(Shoryuken::Client).to receive(:queues).with(queue_name).and_return(queue)
+        expect(queue).to receive(:receive_messages).
+          with(max_number_of_messages: described_class::FETCH_LIMIT, attribute_names: ['All'], message_attribute_names: ['All']).
+          and_return([])
+
+        subject.fetch(queue_config, limit)
+      end
     end
   end
 end

data/spec/shoryuken/manager_spec.rb

@@ -11,28 +11,20 @@ RSpec.describe Shoryuken::Manager do
   let(:queue) { 'default' }
   let(:queues) { [queue] }
   let(:polling_strategy) { Shoryuken::Polling::WeightedRoundRobin.new(queues) }
-  let(:fetcher) { Shoryuken::Fetcher.new }
+  let(:fetcher) { double Shoryuken::Fetcher }
   let(:concurrency) { 1 }
 
-  subject { Shoryuken::Manager.new(fetcher, polling_strategy) }
+  subject { Shoryuken::Manager.new(fetcher, polling_strategy, concurrency) }
 
-  before(:each) do
-    Shoryuken.options[:concurrency] = concurrency
+  before do
+    allow(fetcher).to receive(:fetch).and_return([])
   end
 
-  after(:each) do
+  after do
     Shoryuken.options[:concurrency] = 1
     TestWorker.get_shoryuken_options['batch'] = false
   end
 
-  describe 'Invalid concurrency setting' do
-    it 'raises ArgumentError if concurrency is not positive number' do
-      Shoryuken.options[:concurrency] = -1
-      expect { Shoryuken::Manager.new(nil, nil) }
-        .to raise_error(ArgumentError, 'Concurrency value -1 is invalid, it needs to be a positive number')
-    end
-  end
-
   describe '#start' do
     xit 'pauses when there are no active queues' do
       expect(polling_strategy).to receive(:next_queue).and_return(nil)
@@ -55,10 +47,10 @@ RSpec.describe Shoryuken::Manager do
     end
   end
 
-  describe '#dispatch_now' do
-    it 'fires a dispatch event' do
-      expect(subject).to receive(:fire_event).with(:dispatch).once
-      subject.send(:dispatch_now)
+  describe '#dispatch' do
+    xit 'fires a dispatch event' do
+      expect(subject).to receive(:fire_event).with(:dispatch)
+      subject.send(:dispatch)
     end
   end
 

data/spec/shoryuken/options_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+
+RSpec.describe Shoryuken::Options do
+  describe '.add_group' do
+    before do
+      Shoryuken.groups.clear
+      Shoryuken.add_group('group1', 25)
+      Shoryuken.add_group('group2', 25)
+    end
+
+    specify do
+      described_class.add_queue('queue1', 1, 'group1')
+      described_class.add_queue('queue2', 2, 'group2')
+
+      expect(described_class.groups['group1'][:queues]).to eq(%w(queue1))
+      expect(described_class.groups['group2'][:queues]).to eq(%w(queue2 queue2))
+    end
+  end
+
+  describe '.ungrouped_queues' do
+    before do
+      Shoryuken.groups.clear
+      Shoryuken.add_group('group1', 25)
+      Shoryuken.add_group('group2', 25)
+    end
+
+    specify do
+      described_class.add_queue('queue1', 1, 'group1')
+      described_class.add_queue('queue2', 2, 'group2')
+
+      expect(described_class.ungrouped_queues).to eq(%w(queue1 queue2 queue2))
+    end
+  end
+
+  describe '.sqs_client_receive_message_opts' do
+    before do
+      Shoryuken.sqs_client_receive_message_opts
+    end
+
+    specify do
+      Shoryuken.sqs_client_receive_message_opts = { test: 1 }
+      expect(Shoryuken.sqs_client_receive_message_opts).to eq('default' => { test: 1 })
+
+      Shoryuken.sqs_client_receive_message_opts['group1'] = { test: 2 }
+
+      expect(Shoryuken.sqs_client_receive_message_opts).to eq(
+        'default' => { test: 1 },
+        'group1'  => { test: 2 },
+      )
+    end
+  end
+
+  describe '.register_worker' do
+    it 'registers a worker' do
+      described_class.worker_registry.clear
+      described_class.register_worker('default', TestWorker)
+      expect(described_class.worker_registry.workers('default')).to eq([TestWorker])
+    end
+
+    it 'registers a batchable worker' do
+      described_class.worker_registry.clear
+      TestWorker.get_shoryuken_options['batch'] = true
+      described_class.register_worker('default', TestWorker)
+      expect(described_class.worker_registry.workers('default')).to eq([TestWorker])
+    end
+
+    it 'allows multiple workers' do
+      described_class.worker_registry.clear
+      described_class.register_worker('default', TestWorker)
+      expect(described_class.worker_registry.workers('default')).to eq([TestWorker])
+
+      class Test2Worker
+        include Shoryuken::Worker
+
+        shoryuken_options queue: 'default'
+
+        def perform(sqs_msg, body); end
+      end
+
+      expect(described_class.worker_registry.workers('default')).to eq([Test2Worker])
+    end
+
+    it 'raises an exception when mixing batchable with non batchable' do
+      described_class.worker_registry.clear
+      TestWorker.get_shoryuken_options['batch'] = true
+      described_class.register_worker('default', TestWorker)
+
+      expect {
+        class BatchableWorker
+          include Shoryuken::Worker
+
+          shoryuken_options queue: 'default', batch: true
+
+          def perform(sqs_msg, body); end
+        end
+      }.to raise_error("Could not register BatchableWorker for default, because TestWorker is already registered for this queue, " \
+        "and Shoryuken doesn't support a batchable worker for a queue with multiple workers")
+    end
+  end
+end

data/spec/shoryuken/{polling_spec.rb → polling/strict_priority_spec.rb}

@@ -1,105 +1,6 @@
 require 'spec_helper'
-require 'shoryuken/polling'
 
-describe Shoryuken::Polling::WeightedRoundRobin do
-  let(:queue1) { 'shoryuken' }
-  let(:queue2) { 'uppercut' }
-  let(:queues) { Array.new }
-  subject { Shoryuken::Polling::WeightedRoundRobin.new(queues) }
-
-  describe '#next_queue' do
-    it 'cycles' do
-      # [shoryuken, 2]
-      # [uppercut,  1]
-      queues << queue1
-      queues << queue1
-      queues << queue2
-
-      expect(subject.next_queue).to eq(queue1)
-      expect(subject.next_queue).to eq(queue2)
-      expect(subject.next_queue).to eq(queue1)
-    end
-
-    it 'returns nil if there are no active queues' do
-      expect(subject.next_queue).to eq(nil)
-    end
-
-    it 'unpauses queues whose pause is expired' do
-      # [shoryuken, 2]
-      # [uppercut,  1]
-      queues << queue1
-      queues << queue1
-      queues << queue2
-
-      allow(subject).to receive(:delay).and_return(10)
-
-      now = Time.now
-      allow(Time).to receive(:now).and_return(now)
-
-      # pause the first queue
-      subject.messages_found(queue1, 0)
-      expect(subject.next_queue).to eq(queue2)
-
-      now += 5
-      allow(Time).to receive(:now).and_return(now)
-
-      # pause the second queue
-      subject.messages_found(queue2, 0)
-      expect(subject.next_queue).to eq(nil)
-
-      # queue1 should be unpaused now
-      now += 6
-      allow(Time).to receive(:now).and_return(now)
-      expect(subject.next_queue).to eq(queue1)
-
-      # queue1 should be unpaused and added to the end of queues now
-      now += 6
-      allow(Time).to receive(:now).and_return(now)
-      expect(subject.next_queue).to eq(queue1)
-      expect(subject.next_queue).to eq(queue2)
-    end
-  end
-
-  describe '#messages_found' do
-    it 'pauses a queue if there are no messages found' do
-      # [shoryuken, 2]
-      # [uppercut,  1]
-      queues << queue1
-      queues << queue1
-      queues << queue2
-
-      expect(subject).to receive(:pause).with(queue1).and_call_original
-      subject.messages_found(queue1, 0)
-      expect(subject.instance_variable_get(:@queues)).to eq([queue2])
-    end
-
-    it 'increased the weight if message is found' do
-      # [shoryuken, 2]
-      # [uppercut,  1]
-      queues << queue1
-      queues << queue1
-      queues << queue2
-
-      expect(subject.instance_variable_get(:@queues)).to eq([queue1, queue2])
-      subject.messages_found(queue1, 1)
-      expect(subject.instance_variable_get(:@queues)).to eq([queue1, queue2, queue1])
-    end
-
-    it 'respects the maximum queue weight' do
-      # [shoryuken, 2]
-      # [uppercut,  1]
-      queues << queue1
-      queues << queue1
-      queues << queue2
-
-      subject.messages_found(queue1, 1)
-      subject.messages_found(queue1, 1)
-      expect(subject.instance_variable_get(:@queues)).to eq([queue1, queue2, queue1])
-    end
-  end
-end
-
-describe Shoryuken::Polling::StrictPriority do
+RSpec.describe Shoryuken::Polling::StrictPriority do
   let(:queue1) { 'shoryuken' }
   let(:queue2) { 'uppercut' }
   let(:queue3) { 'other' }