shoryuken 3.2.3 → 3.3.0

data/lib/shoryuken/queue.rb

@@ -2,9 +2,9 @@ module Shoryuken
   class Queue
     include Util
 
-    FIFO_ATTR               = 'FifoQueue'
-    MESSAGE_GROUP_ID        = 'ShoryukenMessage'
-    VISIBILITY_TIMEOUT_ATTR = 'VisibilityTimeout'
+    FIFO_ATTR               = 'FifoQueue'.freeze
+    MESSAGE_GROUP_ID        = 'ShoryukenMessage'.freeze
+    VISIBILITY_TIMEOUT_ATTR = 'VisibilityTimeout'.freeze
 
     attr_accessor :name, :client, :url
 

data/lib/shoryuken/runner.rb

@@ -8,7 +8,6 @@ require 'shoryuken'
 
 module Shoryuken
   # rubocop:disable Lint/InheritException
-  # rubocop:disable Metrics/AbcSize
   # See: https://github.com/mperham/sidekiq/blob/33f5d6b2b6c0dfaab11e5d39688cab7ebadc83ae/lib/sidekiq/cli.rb#L20
   class Shutdown < Interrupt; end
 
@@ -19,7 +18,7 @@ module Shoryuken
     def run(options)
       self_read, self_write = IO.pipe
 
-      %w(INT TERM USR1 TTIN).each do |sig|
+      %w[INT TERM USR1 TSTP TTIN].each do |sig|
         begin
           trap sig do
             self_write.puts(sig)
@@ -106,6 +105,12 @@ module Shoryuken
       exit 0
     end
 
+    def execute_terminal_stop
+      logger.info { 'Received TSTP, will stop accepting new work' }
+
+      @launcher.stop
+    end
+
     def print_threads_backtrace
       Thread.list.each do |thread|
         logger.info { "Thread TID-#{thread.object_id.to_s(36)} #{thread['label']}" }
@@ -123,8 +128,9 @@ module Shoryuken
       case sig
       when 'USR1' then execute_soft_shutdown
       when 'TTIN' then print_threads_backtrace
+      when 'TSTP' then execute_terminal_stop
       when 'TERM', 'INT'
-        logger.info { "Received #{sig}, will shutdown down" }
+        logger.info { "Received #{sig}, will shutdown" }
 
         raise Interrupt
       end

data/lib/shoryuken/version.rb

@@ -1,3 +1,3 @@
 module Shoryuken
-  VERSION = '3.2.3'.freeze
+  VERSION = '3.3.0'.freeze
 end

data/lib/shoryuken/worker/inline_executor.rb

@@ -2,7 +2,7 @@ module Shoryuken
   module Worker
     class InlineExecutor
       class << self
-        def perform_async(worker_class, body, options = {})
+        def perform_async(worker_class, body, _options = {})
           body = JSON.dump(body) if body.is_a?(Hash)
 
           sqs_msg = OpenStruct.new(
@@ -16,11 +16,20 @@ module Shoryuken
             delete: nil
           )
 
-          worker_class.new.perform(sqs_msg, BodyParser.parse(worker_class, sqs_msg))
+          call(worker_class, sqs_msg)
         end
 
         def perform_in(worker_class, _interval, body, options = {})
-          perform_async(worker_class, body, options)
+          worker_class.perform_async(body, options)
+        end
+
+        private
+
+        def call(worker_class, sqs_msg)
+          parsed_body = BodyParser.parse(worker_class, sqs_msg)
+          batch = worker_class.shoryuken_options_hash['batch']
+          args = batch ? [[sqs_msg], [parsed_body]] : [sqs_msg, parsed_body]
+          worker_class.new.perform(*args)
         end
       end
     end

data/lib/shoryuken/worker_registry.rb

@@ -1,6 +1,6 @@
 module Shoryuken
   class WorkerRegistry
-    def batch_receive_messages?(queue)
+    def batch_receive_messages?(_queue)
       # true if the workers for queue support batch processing of messages
       fail NotImplementedError
     end
@@ -10,7 +10,7 @@ module Shoryuken
       fail NotImplementedError
     end
 
-    def fetch_worker(queue, message)
+    def fetch_worker(_queue, _message)
       # must return an instance of the worker that handles
       # message received on queue
       fail NotImplementedError
@@ -21,12 +21,12 @@ module Shoryuken
       fail NotImplementedError
     end
 
-    def register_worker(queue, clazz)
+    def register_worker(_queue, _clazz)
       # must register the worker as a consumer of messages from queue
       fail NotImplementedError
     end
 
-    def workers(queue)
+    def workers(_queue)
       # must return the list of workers registered for queue, or []
       fail NotImplementedError
     end

data/shoryuken.gemspec

@@ -1,5 +1,5 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'shoryuken/version'
 
@@ -13,15 +13,15 @@ Gem::Specification.new do |spec|
   spec.license       = 'LGPL-3.0'
 
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = %w(shoryuken)
+  spec.executables   = %w[shoryuken]
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'dotenv'
+  spec.add_development_dependency 'pry-byebug'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'pry-byebug'
-  spec.add_development_dependency 'dotenv'
 
   spec.add_dependency 'aws-sdk-core', '>= 2'
   spec.add_dependency 'concurrent-ruby'

data/spec/integration/launcher_spec.rb

@@ -4,7 +4,7 @@ require 'shoryuken/launcher'
 require 'securerandom'
 
 RSpec.describe Shoryuken::Launcher do
-  describe 'Consuming messages', slow: :true do
+  describe 'Consuming messages', slow: true do
     before do
       Aws.config[:stub_responses] = false
       Aws.config[:region] = 'us-east-1'
@@ -85,7 +85,7 @@ RSpec.describe Shoryuken::Launcher do
 
       shoryuken_options auto_delete: true
 
-      def perform(sqs_msg, body)
+      def perform(sqs_msg, _body)
         @@received_messages += Array(sqs_msg).size
       end
 

data/spec/shoryuken/body_parser_spec.rb

@@ -69,8 +69,8 @@ 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, /unexpected token at 'invalid JSON'/)
       end
     end
 

data/spec/shoryuken/client_spec.rb

@@ -12,7 +12,7 @@ RSpec.describe Shoryuken::Client do
     end
 
     it 'memoizes queues' do
-      sqs.stub_responses(:get_queue_url, { queue_url: queue_url }, { queue_url: 'xyz' })
+      sqs.stub_responses(:get_queue_url, { queue_url: queue_url }, queue_url: 'xyz')
 
       expect(Shoryuken::Client.queues(queue_name).url).to eq queue_url
       expect(Shoryuken::Client.queues(queue_name).url).to eq queue_url

data/spec/shoryuken/core_ext_spec.rb

@@ -10,7 +10,7 @@ RSpec.describe 'Core Extensions' do
 
     describe '#symbolize_keys' do
       it 'converts keys into symbols' do
-        expect({ :key1 => 'value1', 'key2' => 'value2' }.symbolize_keys).to eq(:key1 => 'value1', key2: 'value2')
+        expect({ :key1 => 'value1', 'key2' => 'value2' }.symbolize_keys).to eq(key1: 'value1', key2: 'value2')
       end
     end
 
@@ -20,11 +20,11 @@ RSpec.describe 'Core Extensions' do
                  'key2' => 'value2',
                  'key3' => {
                    'key31' => { 'key311' => 'value311' },
-                   'key32' => 'value32' } }.deep_symbolize_keys).to eq({ :key1 => 'value1',
-                                                                         :key2 => 'value2',
-                                                                         :key3 => { :key31 =>
-                                                                                    { :key311 => 'value311' },
-                                                                                      :key32 => 'value32' } })
+                   'key32' => 'value32'
+                 } }.deep_symbolize_keys).to eq(key1: 'value1',
+                                                key2: 'value2',
+                                                key3: { key31:                                                                                     { key311: 'value311' },
+                                                        key32: 'value32' })
       end
     end
   end

data/spec/shoryuken/default_worker_registry_spec.rb

@@ -43,12 +43,10 @@ RSpec.describe Shoryuken::DefaultWorkerRegistry do
   end
 
   describe 'a registry with workers is handling messages' do
-    def build_message(queue, explicit_worker = nil)
+    def build_message(_queue, explicit_worker = nil)
       attributes = {}
 
-      if explicit_worker
-        attributes['shoryuken_class'] = { string_value: explicit_worker.to_s, data_type: 'String' }
-      end
+      attributes['shoryuken_class'] = { string_value: explicit_worker.to_s, data_type: 'String' } if explicit_worker
 
       double(Shoryuken::Message,
              body: 'test',

data/spec/shoryuken/environment_loader_spec.rb

@@ -18,7 +18,7 @@ RSpec.describe Shoryuken::EnvironmentLoader do
       Shoryuken.options[:queues] = ['queue1', ['queue2', 2]]
       subject.load
 
-      expect(Shoryuken.groups['default'][:queues]).to eq(%w(queue1 queue2 queue2))
+      expect(Shoryuken.groups['default'][:queues]).to eq(%w[queue1 queue2 queue2])
     end
   end
 
@@ -42,13 +42,13 @@ RSpec.describe Shoryuken::EnvironmentLoader do
       Shoryuken.options[:queues] = ['queue1', ['queue2', 2]]
 
       Shoryuken.options[:groups] = {
-        'group1' => { queues: %w(group1_queue1 group1_queue2) }
+        'group1' => { queues: %w[group1_queue1 group1_queue2] }
       }
 
       subject.load
 
-      expect(Shoryuken.groups['default'][:queues]).to eq(%w(test_queue1 test_queue2 test_queue2))
-      expect(Shoryuken.groups['group1'][:queues]).to eq(%w(test_group1_queue1 test_group1_queue2))
+      expect(Shoryuken.groups['default'][:queues]).to eq(%w[test_queue1 test_queue2 test_queue2])
+      expect(Shoryuken.groups['group1'][:queues]).to eq(%w[test_group1_queue1 test_group1_queue2])
     end
   end
 end

data/spec/shoryuken/extensions/active_job_adapter_spec.rb

@@ -9,13 +9,13 @@ RSpec.describe ActiveJob::QueueAdapters::ShoryukenAdapter do
 
   before do
     allow(Shoryuken::Client).to receive(:queues).with(job.queue_name).and_return(queue)
-    allow(job).to receive(:serialize).and_return({
-      'job_class'  => 'Worker',
+    allow(job).to receive(:serialize).and_return(
+      'job_class' => 'Worker',
       'job_id'     => job.id,
       'queue_name' => job.queue_name,
       'arguments'  => nil,
       'locale'     => nil
-    })
+    )
   end
 
   describe '#enqueue' do

data/spec/shoryuken/manager_spec.rb

@@ -79,7 +79,7 @@ RSpec.describe Shoryuken::Manager do
 
     context 'when batch' do
       specify do
-        messages = %w(test1 test2 test3)
+        messages = %w[test1 test2 test3]
         q = Shoryuken::Polling::QueueConfiguration.new(queue, {})
 
         expect(fetcher).to receive(:fetch).with(q, described_class::BATCH_LIMIT).and_return(messages)

data/spec/shoryuken/middleware/chain_spec.rb

@@ -7,7 +7,7 @@ RSpec.describe Shoryuken::Middleware::Chain do
       @recorder = recorder
     end
 
-    def call(*args)
+    def call(*_args)
       @recorder << [@name, 'before']
       yield
       @recorder << [@name, 'after']
@@ -39,7 +39,7 @@ RSpec.describe Shoryuken::Middleware::Chain do
     final_action = nil
     subject.invoke { final_action = true }
     expect(final_action).to eq true
-    expect(recorder).to eq [%w(custom before), %w(custom after)]
+    expect(recorder).to eq [%w[custom before], %w[custom after]]
   end
 
   class NonYieldingMiddleware

data/spec/shoryuken/middleware/server/auto_delete_spec.rb

@@ -6,9 +6,9 @@ describe Shoryuken::Middleware::Server::AutoDelete do
 
   def build_message
     double Shoryuken::Message,
-      queue_url: queue,
-      body: 'test',
-      receipt_handle: SecureRandom.uuid
+           queue_url: queue,
+           body: 'test',
+           receipt_handle: SecureRandom.uuid
   end
 
   let(:sqs_msg) { build_message }
@@ -21,7 +21,8 @@ describe Shoryuken::Middleware::Server::AutoDelete do
     TestWorker.get_shoryuken_options['auto_delete'] = true
 
     expect(sqs_queue).to receive(:delete_messages).with(entries: [
-      { id: '0', receipt_handle: sqs_msg.receipt_handle }])
+                                                          { id: '0', receipt_handle: sqs_msg.receipt_handle }
+                                                        ])
 
     subject.call(TestWorker.new, queue, sqs_msg, sqs_msg.body) {}
   end
@@ -35,9 +36,10 @@ describe Shoryuken::Middleware::Server::AutoDelete do
     sqs_msgs = [sqs_msg, sqs_msg2, sqs_msg3]
 
     expect(sqs_queue).to receive(:delete_messages).with(entries: [
-      { id: '0', receipt_handle: sqs_msg.receipt_handle },
-      { id: '1', receipt_handle: sqs_msg2.receipt_handle },
-      { id: '2', receipt_handle: sqs_msg3.receipt_handle }])
+                                                          { id: '0', receipt_handle: sqs_msg.receipt_handle },
+                                                          { id: '1', receipt_handle: sqs_msg2.receipt_handle },
+                                                          { id: '2', receipt_handle: sqs_msg3.receipt_handle }
+                                                        ])
 
     subject.call(TestWorker.new, queue, sqs_msgs, [sqs_msg.body, sqs_msg2.body, sqs_msg3.body]) {}
   end

data/spec/shoryuken/middleware/server/auto_extend_visibility_spec.rb

@@ -18,9 +18,9 @@ RSpec.describe Shoryuken::Middleware::Server::AutoExtendVisibility do
       end
     end
 
-    def run_and_raise(worker, queue, sqs_msg, error_class)
+    def run_and_raise(worker, queue, sqs_msg)
       Shoryuken::Middleware::Server::AutoExtendVisibility.new.call(worker, queue, sqs_msg, sqs_msg.body) do
-        raise error_class.new
+        raise
       end
     end
   end
@@ -53,7 +53,7 @@ RSpec.describe Shoryuken::Middleware::Server::AutoExtendVisibility do
     allow(sqs_msg).to receive(:queue) { sqs_queue }
     expect(sqs_msg).to_not receive(:change_visibility)
 
-    expect { Runner.new.run_and_raise(TestWorker.new, queue, sqs_msg, StandardError) }.to raise_error(StandardError)
+    expect { Runner.new.run_and_raise(TestWorker.new, queue, sqs_msg) }.to raise_error
   end
 
   it 'does not extend message visibility if auto_visibility_timeout is not true' do

data/spec/shoryuken/middleware/server/exponential_backoff_retry_spec.rb

@@ -1,11 +1,13 @@
 require 'spec_helper'
 
-# rubocop:disable Metrics/BlockLength, Metrics/BlockDelimiters
+# rubocop:disable /BlockLength, Metrics/
 RSpec.describe Shoryuken::Middleware::Server::ExponentialBackoffRetry do
   let(:queue)     { 'default' }
   let(:sqs_queue) { double Shoryuken::Queue }
-  let(:sqs_msg)   { double Shoryuken::Message, queue_url: queue, body: 'test', receipt_handle: SecureRandom.uuid,
-                    attributes: {'ApproximateReceiveCount' => 1}, message_id: SecureRandom.uuid }
+  let(:sqs_msg)   {
+    double Shoryuken::Message, queue_url: queue, body: 'test', receipt_handle: SecureRandom.uuid,
+                               attributes: { 'ApproximateReceiveCount' => 1 }, message_id: SecureRandom.uuid
+  }
 
   before do
     allow(Shoryuken::Client).to receive(:queues).with(queue).and_return(sqs_queue)

data/spec/shoryuken/options_spec.rb

@@ -12,8 +12,8 @@ RSpec.describe Shoryuken::Options 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))
+      expect(described_class.groups['group1'][:queues]).to eq(%w[queue1])
+      expect(described_class.groups['group2'][:queues]).to eq(%w[queue2 queue2])
     end
   end
 
@@ -28,7 +28,7 @@ RSpec.describe Shoryuken::Options 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))
+      expect(described_class.ungrouped_queues).to eq(%w[queue1 queue2 queue2])
     end
   end
 
@@ -45,7 +45,7 @@ RSpec.describe Shoryuken::Options do
 
       expect(Shoryuken.sqs_client_receive_message_opts).to eq(
         'default' => { test: 1 },
-        'group1'  => { test: 2 },
+        'group1'  => { test: 2 }
       )
     end
   end
@@ -93,7 +93,7 @@ RSpec.describe Shoryuken::Options do
 
           def perform(sqs_msg, body); end
         end
-      }.to raise_error("Could not register BatchableWorker for default, because TestWorker is already registered for this queue, " \
+      }.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

data/spec/shoryuken/polling/strict_priority_spec.rb

@@ -4,7 +4,7 @@ RSpec.describe Shoryuken::Polling::StrictPriority do
   let(:queue1) { 'shoryuken' }
   let(:queue2) { 'uppercut' }
   let(:queue3) { 'other' }
-  let(:queues) { Array.new }
+  let(:queues) { [] }
   subject { Shoryuken::Polling::StrictPriority.new(queues) }
 
   describe '#next_queue' do

data/spec/shoryuken/polling/weighted_round_robin_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 RSpec.describe Shoryuken::Polling::WeightedRoundRobin do
   let(:queue1) { 'shoryuken' }
   let(:queue2) { 'uppercut' }
-  let(:queues) { Array.new }
+  let(:queues) { [] }
   subject { Shoryuken::Polling::WeightedRoundRobin.new(queues) }
 
   describe '#next_queue' do

data/spec/shoryuken/processor_spec.rb

@@ -38,7 +38,7 @@ RSpec.describe Shoryuken::Processor do
       let(:queue) { 'worker_called_middleware' }
 
       class WorkerCalledMiddleware
-        def call(worker, queue, sqs_msg, body)
+        def call(worker, queue, sqs_msg, _body)
           # called is defined with `allow(...).to receive(...)`
           worker.called(sqs_msg, queue)
           yield