shoryuken 3.1.3 → 3.2.0

data/lib/shoryuken/worker/inline_executor.rb

@@ -0,0 +1,28 @@
+module Shoryuken
+  module Worker
+    class InlineExecutor
+      class << self
+        def perform_async(worker_class, body, options = {})
+          body = JSON.dump(body) if body.is_a?(Hash)
+
+          sqs_msg = OpenStruct.new(
+            body: body,
+            attributes: nil,
+            md5_of_body: nil,
+            md5_of_message_attributes: nil,
+            message_attributes: nil,
+            message_id: nil,
+            receipt_handle: nil,
+            delete: nil
+          )
+
+          worker_class.new.perform(sqs_msg, BodyParser.parse(worker_class, sqs_msg))
+        end
+
+        def perform_in(worker_class, _interval, body, options = {})
+          perform_async(worker_class, body, options)
+        end
+      end
+    end
+  end
+end

data/lib/shoryuken/worker.rb

@@ -2,33 +2,16 @@ module Shoryuken
   module Worker
     def self.included(base)
       base.extend(ClassMethods)
+      base.shoryuken_class_attribute :shoryuken_options_hash
     end
 
     module ClassMethods
       def perform_async(body, options = {})
-        options[:message_attributes] ||= {}
-        options[:message_attributes]['shoryuken_class'] = {
-          string_value: self.to_s,
-          data_type: 'String'
-        }
-
-        options[:message_body] = body
-
-        queue = options.delete(:queue) || get_shoryuken_options['queue']
-
-        Shoryuken::Client.queues(queue).send_message(options)
+        Shoryuken.worker_executor.perform_async(self, body, options)
       end
 
       def perform_in(interval, body, options = {})
-        interval = interval.to_f
-        now = Time.now.to_f
-        ts = (interval < 1_000_000_000 ? (now + interval).to_f : interval)
-
-        delay = (ts - now).ceil
-
-        raise 'The maximum allowed delay is 15 minutes' if delay > 15 * 60
-
-        perform_async(body, options.merge(delay_seconds: delay))
+        Shoryuken.worker_executor.perform_in(self, interval, body, options)
       end
 
       alias_method :perform_at, :perform_in
@@ -40,7 +23,7 @@ module Shoryuken
       end
 
       def shoryuken_options(opts = {})
-        @shoryuken_options = get_shoryuken_options.merge(stringify_keys(opts || {}))
+        self.shoryuken_options_hash = get_shoryuken_options.merge(stringify_keys(opts || {}))
         normalize_worker_queue!
       end
 
@@ -57,33 +40,87 @@ module Shoryuken
       end
 
       def get_shoryuken_options # :nodoc:
-        @shoryuken_options || Shoryuken.default_worker_options
+        shoryuken_options_hash || Shoryuken.default_worker_options
       end
 
       def stringify_keys(hash) # :nodoc:
-        hash.keys.each do |key|
-          hash[key.to_s] = hash.delete(key)
+        new_hash = {}
+        hash.each { |key, value| new_hash[key.to_s] = value }
+        new_hash
+      end
+
+      def shoryuken_class_attribute(*attrs) # :nodoc:
+        attrs.each do |name|
+          singleton_class.instance_eval do
+            undef_method(name) if method_defined?(name) || private_method_defined?(name)
+          end
+          define_singleton_method(name) { nil }
+
+          ivar = "@#{name}"
+
+          singleton_class.instance_eval do
+            m = "#{name}="
+            undef_method(m) if method_defined?(m) || private_method_defined?(m)
+          end
+
+          define_singleton_method("#{name}=") do |val|
+            singleton_class.class_eval do
+              undef_method(name) if method_defined?(name) || private_method_defined?(name)
+              define_method(name) { val }
+            end
+
+            # singleton? backwards compatibility for ruby < 2.1
+            singleton_klass = respond_to?(:singleton?) ? singleton? : self != ancestors.first
+
+            if singleton_klass
+              class_eval do
+                undef_method(name) if method_defined?(name) || private_method_defined?(name)
+                define_method(name) do
+                  if instance_variable_defined? ivar
+                    instance_variable_get ivar
+                  else
+                    singleton_class.send name
+                  end
+                end
+              end
+            end
+            val
+          end
+
+          # instance reader
+          undef_method(name) if method_defined?(name) || private_method_defined?(name)
+          define_method(name) do
+            if instance_variable_defined?(ivar)
+              instance_variable_get ivar
+            else
+              self.class.public_send name
+            end
+          end
+
+          # instance writer
+          m = "#{name}="
+          undef_method(m) if method_defined?(m) || private_method_defined?(m)
+          attr_writer name
         end
-        hash
       end
 
       private
 
       def normalize_worker_queue!
-        queue = @shoryuken_options['queue']
+        queue = shoryuken_options_hash['queue']
         if queue.respond_to?(:call)
           queue = queue.call
-          @shoryuken_options['queue'] = queue
+          shoryuken_options_hash['queue'] = queue
         end
 
-        case @shoryuken_options['queue']
+        case shoryuken_options_hash['queue']
         when Array
-          @shoryuken_options['queue'].map!(&:to_s)
+          shoryuken_options_hash['queue'].map!(&:to_s)
         when Symbol
-          @shoryuken_options['queue'] = @shoryuken_options['queue'].to_s
+          shoryuken_options_hash['queue'] = shoryuken_options_hash['queue'].to_s
         end
 
-        [@shoryuken_options['queue']].flatten.compact.each(&method(:register_worker))
+        [shoryuken_options_hash['queue']].flatten.compact.each(&method(:register_worker))
       end
 
       def register_worker(queue)

data/lib/shoryuken.rb

@@ -1,8 +1,14 @@
 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 'time'
 require 'concurrent'
+require 'forwardable'
 
 require 'shoryuken/version'
 require 'shoryuken/core_ext'
@@ -13,6 +19,8 @@ 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/middleware/chain'
@@ -26,9 +34,11 @@ require 'shoryuken/polling/strict_priority'
 require 'shoryuken/manager'
 require 'shoryuken/launcher'
 require 'shoryuken/processor'
+require 'shoryuken/body_parser'
 require 'shoryuken/fetcher'
 require 'shoryuken/options'
 
+
 module Shoryuken
   extend SingleForwardable
 
@@ -41,6 +51,8 @@ module Shoryuken
     :ungrouped_queues,
     :worker_registry,
     :worker_registry=,
+    :worker_executor,
+    :worker_executor=,
     :polling_strategy,
     :start_callback,
     :start_callback=,

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/shoryuken/body_parser_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+require 'shoryuken/body_parser'
+
+RSpec.describe Shoryuken::BodyParser do
+  let(:sqs_msg) { double }
+
+  describe '#parser' do
+    it 'parses the body into JSON' do
+      TestWorker.get_shoryuken_options['body_parser'] = :json
+
+      body = { 'test' => 'hi' }
+
+      allow(sqs_msg).to receive(:body).and_return(JSON.dump(body))
+
+      expect(described_class.parse(TestWorker, sqs_msg)).to eq(body)
+    end
+
+    it 'parses the body calling the proc' do
+      TestWorker.get_shoryuken_options['body_parser'] = proc { |sqs_msg| "*#{sqs_msg.body}*" }
+
+      allow(sqs_msg).to receive(:body).and_return('test')
+
+      expect(described_class.parse(TestWorker, sqs_msg)).to eq('*test*')
+    end
+
+    it 'parses the body as text' do
+      TestWorker.get_shoryuken_options['body_parser'] = :text
+
+      body = 'test'
+
+      allow(sqs_msg).to receive(:body).and_return(body)
+
+      expect(described_class.parse(TestWorker, sqs_msg)).to eq('test')
+    end
+
+    it 'parses calling `.load`' do
+      TestWorker.get_shoryuken_options['body_parser'] = Class.new do
+        def self.load(*args)
+          JSON.load(*args)
+        end
+      end
+
+      body = { 'test' => 'hi' }
+
+      allow(sqs_msg).to receive(:body).and_return(JSON.dump(body))
+
+      expect(described_class.parse(TestWorker, sqs_msg)).to eq(body)
+    end
+
+    it 'parses calling `.parse`' do
+      TestWorker.get_shoryuken_options['body_parser'] = Class.new do
+        def self.parse(*args)
+          JSON.parse(*args)
+        end
+      end
+
+      body = { 'test' => 'hi' }
+
+      allow(sqs_msg).to receive(:body).and_return(JSON.dump(body))
+
+      expect(described_class.parse(TestWorker, sqs_msg)).to eq(body)
+    end
+
+    context 'when parse errors' do
+      before do
+        TestWorker.get_shoryuken_options['body_parser'] = :json
+
+        allow(sqs_msg).to receive(:body).and_return('invalid JSON')
+      end
+
+      specify do
+        expect { described_class.parse(TestWorker, sqs_msg) }.
+          to raise_error(JSON::ParserError, /unexpected token at 'invalid JSON'/)
+      end
+    end
+
+    context 'when `object_type: nil`' do
+      it 'parses the body as text' do
+        TestWorker.get_shoryuken_options['body_parser'] = nil
+
+        body = 'test'
+
+        allow(sqs_msg).to receive(:body).and_return(body)
+
+        expect(described_class.parse(TestWorker, sqs_msg)).to eq(body)
+      end
+    end
+  end
+end

data/spec/shoryuken/fetcher_spec.rb

@@ -2,6 +2,7 @@ require 'spec_helper'
 require 'shoryuken/manager'
 require 'shoryuken/fetcher'
 
+# rubocop:disable Metrics/BlockLength
 RSpec.describe Shoryuken::Fetcher do
   let(:queue)        { instance_double('Shoryuken::Queue') }
   let(:queue_name)   { 'default' }
@@ -13,7 +14,7 @@ RSpec.describe Shoryuken::Fetcher do
       Shoryuken::Message,
       queue_url: queue_name,
       body: 'test',
-      message_id: 'fc754df79cc24c4196ca5996a44b771e',
+      message_id: 'fc754df79cc24c4196ca5996a44b771e'
     )
   end
 
@@ -27,23 +28,74 @@ RSpec.describe Shoryuken::Fetcher do
 
       Shoryuken.sqs_client_receive_message_opts[group] = { wait_time_seconds: 10 }
 
-      expect(queue).to receive(:receive_messages).
-        with(wait_time_seconds: 10, max_number_of_messages: limit, message_attribute_names: ['All'], attribute_names: ['All']).
-        and_return([])
+      expect(queue).to receive(:receive_messages).with(
+        wait_time_seconds: 10,
+        max_number_of_messages: limit,
+        message_attribute_names: ['All'],
+        attribute_names: ['All']
+      ).and_return([])
 
       subject.fetch(queue_config, limit)
     end
 
+    it 'logs debug only' do
+      # See https://github.com/phstc/shoryuken/issues/435
+      logger = double 'logger'
+
+      allow(subject).to receive(:logger).and_return(logger)
+
+      expect(Shoryuken::Client).to receive(:queues).with(queue_name).and_return(queue)
+
+      expect(queue).to receive(:receive_messages).and_return([double('SQS Msg')])
+
+      expect(logger).to receive(:debug).exactly(3).times
+      expect(logger).to_not receive(:info)
+
+      subject.fetch(queue_config, limit)
+    end
+
+    context 'when receive options per queue' do
+      let(:limit) { 5 }
+
+      specify do
+        expect(Shoryuken::Client).to receive(:queues).with(queue_name).and_return(queue)
+
+        Shoryuken.sqs_client_receive_message_opts[queue_name] = { max_number_of_messages: 1 }
+
+        expect(queue).to receive(:receive_messages).with(
+          max_number_of_messages: 1,
+          message_attribute_names: ['All'],
+          attribute_names: ['All']
+        ).and_return([])
+
+        subject.fetch(queue_config, limit)
+      end
+    end
+
+    context 'when max_number_of_messages opt is great than limit' do
+      it 'uses limit' do
+        expect(Shoryuken::Client).to receive(:queues).with(queue_name).and_return(queue)
+
+        Shoryuken.sqs_client_receive_message_opts[queue_name] = { max_number_of_messages: 20 }
+
+        expect(queue).to receive(:receive_messages).with(
+          max_number_of_messages: limit,
+          message_attribute_names: ['All'],
+          attribute_names: ['All']
+        ).and_return([])
+
+        subject.fetch(queue_config, limit)
+      end
+    end
+
     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([])
+        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

data/spec/shoryuken/manager_spec.rb

@@ -70,7 +70,7 @@ RSpec.describe Shoryuken::Manager do
       q = Shoryuken::Polling::QueueConfiguration.new(queue, {})
 
       expect(fetcher).to receive(:fetch).with(q, concurrency).and_return(messages)
-      expect(subject).to receive(:fire_event).with(:dispatch)
+      expect(subject).to receive(:fire_event).with(:dispatch, false, queue_name: q.name)
       expect(Shoryuken::Processor).to receive(:process).with(q, message)
       expect(Shoryuken.logger).to_not receive(:info)
 
@@ -83,7 +83,7 @@ RSpec.describe Shoryuken::Manager do
         q = Shoryuken::Polling::QueueConfiguration.new(queue, {})
 
         expect(fetcher).to receive(:fetch).with(q, described_class::BATCH_LIMIT).and_return(messages)
-        expect(subject).to receive(:fire_event).with(:dispatch)
+        expect(subject).to receive(:fire_event).with(:dispatch, false, queue_name: q.name)
         allow(subject).to receive(:batched_queue?).with(q).and_return(true)
         expect(Shoryuken::Processor).to receive(:process).with(q, messages)
         expect(Shoryuken.logger).to_not receive(:info)

data/spec/shoryuken/middleware/chain_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Shoryuken::Middleware::Chain do
+RSpec.describe Shoryuken::Middleware::Chain do
   class CustomMiddleware
     def initialize(name, recorder)
       @name     = name
@@ -14,20 +14,32 @@ describe Shoryuken::Middleware::Chain do
     end
   end
 
+  class CustomMiddlewareB < CustomMiddleware; end
+
   it 'supports custom middleware' do
     subject.add CustomMiddleware, 1, []
 
     expect(CustomMiddleware).to eq subject.entries.last.klass
   end
 
+  it 'can add middleware to the front of chain' do
+    subject.prepend CustomMiddleware, 1, []
+
+    expect([CustomMiddleware]).to eq subject.entries.map(&:klass)
+
+    subject.prepend CustomMiddlewareB, 1, []
+
+    expect([CustomMiddlewareB, CustomMiddleware]).to eq subject.entries.map(&:klass)
+  end
+
   it 'invokes a middleware' do
     recorder = []
-    subject.add CustomMiddleware, 'Pablo', recorder
+    subject.add CustomMiddleware, 'custom', recorder
 
     final_action = nil
     subject.invoke { final_action = true }
     expect(final_action).to eq true
-    expect(recorder).to eq [%w[Pablo before], %w[Pablo after]]
+    expect(recorder).to eq [%w(custom before), %w(custom after)]
   end
 
   class NonYieldingMiddleware
@@ -37,7 +49,7 @@ describe Shoryuken::Middleware::Chain do
   it 'allows middleware to abruptly stop processing rest of chain' do
     recorder = []
     subject.add NonYieldingMiddleware
-    subject.add CustomMiddleware, 'Pablo', recorder
+    subject.add CustomMiddleware, 'custom', recorder
 
     final_action = nil
     subject.invoke { final_action = true }

data/spec/shoryuken/options_spec.rb

@@ -97,4 +97,84 @@ RSpec.describe Shoryuken::Options do
         "and Shoryuken doesn't support a batchable worker for a queue with multiple workers")
     end
   end
+
+  describe '.polling_strategy' do
+    context 'when not set' do
+      specify do
+        expect(Shoryuken.polling_strategy('default')).to eq Shoryuken::Polling::WeightedRoundRobin
+        expect(Shoryuken.polling_strategy('group1')).to eq Shoryuken::Polling::WeightedRoundRobin
+      end
+    end
+
+    context 'when set to StrictPriority string' do
+      before do
+        Shoryuken.options[:polling_strategy] = 'StrictPriority'
+
+        Shoryuken.options[:groups] = {
+          'group1' => {
+            polling_strategy: 'StrictPriority'
+          }
+        }
+      end
+
+      specify do
+        expect(Shoryuken.polling_strategy('default')).to eq Shoryuken::Polling::StrictPriority
+        expect(Shoryuken.polling_strategy('group1')).to eq Shoryuken::Polling::StrictPriority
+      end
+    end
+
+    context 'when set to WeightedRoundRobin string' do
+      before do
+        Shoryuken.options[:polling_strategy] = 'WeightedRoundRobin'
+
+        Shoryuken.options[:groups] = {
+          'group1' => {
+            polling_strategy: 'WeightedRoundRobin'
+          }
+        }
+      end
+
+      specify do
+        expect(Shoryuken.polling_strategy('default')).to eq Shoryuken::Polling::WeightedRoundRobin
+        expect(Shoryuken.polling_strategy('group1')).to eq Shoryuken::Polling::WeightedRoundRobin
+      end
+    end
+
+    context 'when set to non-existent string' do
+      before do
+        Shoryuken.options[:polling_strategy] = 'NonExistent1'
+
+        Shoryuken.options[:groups] = {
+          'group1' => {
+            polling_strategy: 'NonExistent2'
+          }
+        }
+      end
+
+      specify do
+        expect { Shoryuken.polling_strategy('default') }.to raise_error(ArgumentError)
+        expect { Shoryuken.polling_strategy('group1') }.to raise_error(ArgumentError)
+      end
+    end
+
+    context 'when set to a class' do
+      before do
+        class Foo < Shoryuken::Polling::BaseStrategy; end
+        class Bar < Shoryuken::Polling::BaseStrategy; end
+
+        Shoryuken.options[:polling_strategy] = Foo
+
+        Shoryuken.options[:groups] = {
+          'group1' => {
+            polling_strategy: Bar
+          }
+        }
+      end
+
+      specify do
+        expect(Shoryuken.polling_strategy('default')).to eq Foo
+        expect(Shoryuken.polling_strategy('group1')).to eq Bar
+      end
+    end
+  end
 end