shoryuken 2.0.11 → 3.0.6

data/lib/shoryuken/manager.rb

@@ -1,245 +1,142 @@
-require 'shoryuken/processor'
-require 'shoryuken/fetcher'
-
 module Shoryuken
   class Manager
-    include Celluloid
     include Util
 
-    attr_accessor :fetcher
+    BATCH_LIMIT = 10
+    # See https://github.com/phstc/shoryuken/issues/348#issuecomment-292847028
+    MIN_DISPATCH_INTERVAL = 0.1
 
-    trap_exit :processor_died
+    def initialize(fetcher, polling_strategy)
+      @count = Shoryuken.options.fetch(:concurrency, 25)
 
-    def initialize(condvar)
-      @count = Shoryuken.options[:concurrency] || 25
       raise(ArgumentError, "Concurrency value #{@count} is invalid, it needs to be a positive number") unless @count > 0
+
       @queues = Shoryuken.queues.dup.uniq
-      @finished = condvar
 
-      @done = false
+      @done = Concurrent::AtomicBoolean.new(false)
 
-      @busy  = []
-      @ready = @count.times.map { build_processor }
-      @threads = {}
+      @fetcher = fetcher
+      @polling_strategy = polling_strategy
+
+      @pool = Concurrent::FixedThreadPool.new(@count, max_queue: @count)
+      @dispatcher_executor = Concurrent::SingleThreadExecutor.new
     end
 
     def start
       logger.info { 'Starting' }
 
-      dispatch
+      dispatch_async
     end
 
     def stop(options = {})
-      watchdog('Manager#stop died') do
-        @done = true
-
-        if (callback = Shoryuken.stop_callback)
-          logger.info { 'Calling Shoryuken.on_stop block' }
-          callback.call
-        end
-
-        fire_event(:shutdown, true)
-
-        @fetcher.terminate if @fetcher.alive?
-
-        logger.info { "Shutting down #{@ready.size} quiet workers" }
+      @done.make_true
 
-        @ready.each do |processor|
-          processor.terminate if processor.alive?
-        end
-        @ready.clear
-
-        return after(0) { @finished.signal } if @busy.empty?
-
-        if options[:shutdown]
-          hard_shutdown_in(options[:timeout])
-        else
-          soft_shutdown(options[:timeout])
-        end
+      if (callback = Shoryuken.stop_callback)
+        logger.info { 'Calling Shoryuken.on_stop block' }
+        callback.call
       end
-    end
-
-    def processor_done(queue, processor)
-      watchdog('Manager#processor_done died') do
-        logger.debug { "Process done for '#{queue}'" }
-
-        @threads.delete(processor.object_id)
-        @busy.delete processor
 
-        if stopped?
-          processor.terminate if processor.alive?
-          return after(0) { @finished.signal } if @busy.empty?
-        else
-          @ready << processor
-        end
-      end
-    end
+      fire_event(:shutdown, true)
 
-    def processor_died(processor, reason)
-      watchdog("Manager#processor_died died") do
-        logger.error { "Process died, reason: #{reason}" unless reason.to_s.empty? }
+      logger.info { 'Shutting down workers' }
 
-        @threads.delete(processor.object_id)
-        @busy.delete processor
+      @dispatcher_executor.kill
 
-        if stopped?
-          return after(0) { @finished.signal } if @busy.empty?
-        else
-          @ready << build_processor
-        end
+      if options[:shutdown]
+        hard_shutdown_in(options[:timeout])
+      else
+        soft_shutdown
       end
     end
 
-    def stopped?
-      @done
+    def processor_failed(ex)
+      logger.error ex
+      logger.error ex.backtrace.join("\n") unless ex.backtrace.nil?
     end
 
-    def assign(queue, sqs_msg)
-      watchdog('Manager#assign died') do
-        logger.debug { "Assigning #{sqs_msg.message_id}" }
-
-        processor = @ready.pop
-        @busy << processor
-
-        processor.async.process(queue, sqs_msg)
-      end
+    def processor_done(queue)
+      logger.debug { "Process done for '#{queue}'" }
     end
 
-    def rebalance_queue_weight!(queue)
-      watchdog('Manager#rebalance_queue_weight! died') do
-        if (original = original_queue_weight(queue)) > (current = current_queue_weight(queue))
-          logger.info { "Increasing '#{queue}' weight to #{current + 1}, max: #{original}" }
-
-          @queues << queue
-        end
-      end
-    end
-
-    def pause_queue!(queue)
-      return if !@queues.include?(queue) || Shoryuken.options[:delay].to_f <= 0
-
-      logger.debug { "Pausing '#{queue}' for #{Shoryuken.options[:delay].to_f} seconds, because it's empty" }
-
-      @queues.delete(queue)
+    private
 
-      after(Shoryuken.options[:delay].to_f) { async.restart_queue!(queue) }
+    def dispatch_async
+      @dispatcher_executor.post(&method(:dispatch_now))
     end
 
+    def dispatch_now
+      return if @done.true?
 
-    def dispatch
-      return if stopped?
-
-      logger.debug { "Ready: #{@ready.size}, Busy: #{@busy.size}, Active Queues: #{unparse_queues(@queues)}" }
-
-      if @ready.empty?
-        logger.debug { 'Pausing fetcher, because all processors are busy' }
+      begin
+        if ready.zero? || (queue = @polling_strategy.next_queue).nil?
+          sleep MIN_DISPATCH_INTERVAL
+          return
+        end
 
-        after(1) { dispatch }
+        logger.debug { "Ready: #{ready}, Busy: #{busy}, Active Queues: #{@polling_strategy.active_queues}" }
 
-        return
-      end
-
-      if (queue = next_queue)
-        @fetcher.async.fetch(queue, @ready.size)
-      else
-        logger.debug { 'Pausing fetcher, because all queues are paused' }
-
-        @fetcher_paused = true
+        batched_queue?(queue) ? dispatch_batch(queue) : dispatch_single_messages(queue)
+      ensure
+        dispatch_async
       end
     end
 
-    def real_thread(proxy_id, thr)
-      @threads[proxy_id] = thr
+    def busy
+      @count - ready
     end
 
-    private
-
-    def build_processor
-      processor = Processor.new_link(current_actor)
-      processor.proxy_id = processor.object_id
-      processor
+    def ready
+      @pool.remaining_capacity
     end
 
-    def restart_queue!(queue)
-      return if stopped?
-
-      unless @queues.include? queue
-        logger.debug { "Restarting '#{queue}'" }
-
-        @queues << queue
-
-        if @fetcher_paused
-          logger.debug { 'Restarting fetcher' }
-
-          @fetcher_paused = false
+    def assign(queue, sqs_msg)
+      logger.debug { "Assigning #{sqs_msg.message_id}" }
 
-          dispatch
-        end
-      end
+      @pool.post { Processor.new(self).process(queue, sqs_msg) }
     end
 
-    def current_queue_weight(queue)
-      queue_weight(@queues, queue)
+    def dispatch_batch(queue)
+      batch = @fetcher.fetch(queue, BATCH_LIMIT)
+      @polling_strategy.messages_found(queue.name, batch.size)
+      assign(queue.name, patch_batch!(batch))
     end
 
-    def original_queue_weight(queue)
-      queue_weight(Shoryuken.queues, queue)
+    def dispatch_single_messages(queue)
+      messages = @fetcher.fetch(queue, ready)
+      @polling_strategy.messages_found(queue.name, messages.size)
+      messages.each { |message| assign(queue.name, message) }
     end
 
-    def queue_weight(queues, queue)
-      queues.count { |q| q == queue }
+    def batched_queue?(queue)
+      Shoryuken.worker_registry.batch_receive_messages?(queue.name)
     end
 
-    def next_queue
-      return nil if @queues.empty?
-
-      # get/remove the first queue in the list
-      queue = @queues.shift
-
-      unless defined?(::ActiveJob) ||  !Shoryuken.worker_registry.workers(queue).empty?
-        # when no worker registered pause the queue to avoid endless recursion
-        logger.debug { "Pausing '#{queue}' for #{Shoryuken.options[:delay].to_f} seconds, because no workers registered" }
-
-        after(Shoryuken.options[:delay].to_f) { async.restart_queue!(queue) }
+    def soft_shutdown
+      @pool.shutdown
+      @pool.wait_for_termination
+    end
 
-        return next_queue
+    def hard_shutdown_in(delay)
+      if busy > 0
+        logger.info { "Pausing up to #{delay} seconds to allow workers to finish..." }
       end
 
-      # add queue back to the end of the list
-      @queues << queue
-
-      queue
-    end
+      @pool.shutdown
 
-    def soft_shutdown(delay)
-      logger.info { "Waiting for #{@busy.size} busy workers" }
+      return if @pool.wait_for_termination(delay)
 
-      if @busy.size > 0
-        after(delay) { soft_shutdown(delay) }
-      else
-        @finished.signal
-      end
+      logger.info { "Hard shutting down #{busy} busy workers" }
+      @pool.kill
     end
 
-    def hard_shutdown_in(delay)
-      logger.info { "Waiting for #{@busy.size} busy workers" }
-      logger.info { "Pausing up to #{delay} seconds to allow workers to finish..." }
-
-      after(delay) do
-        watchdog('Manager#hard_shutdown_in died') do
-          if @busy.size > 0
-            logger.info { "Hard shutting down #{@busy.size} busy workers" }
-
-            @busy.each do |processor|
-              if processor.alive? && t = @threads.delete(processor.object_id)
-                t.raise Shutdown
-              end
-            end
-          end
-
-          @finished.signal
+    def patch_batch!(sqs_msgs)
+      sqs_msgs.instance_eval do
+        def message_id
+          "batch-with-#{size}-messages"
         end
       end
+
+      sqs_msgs
     end
   end
 end

data/lib/shoryuken/message.rb

@@ -3,19 +3,10 @@ module Shoryuken
     attr_accessor :client, :queue_url, :queue_name, :data
 
     def initialize(client, queue, data)
-      self.client = client
-      self.data = data
-
-      if queue.is_a?(Shoryuken::Queue)
-        self.queue_url = queue.url
-        self.queue_name = queue.name
-      else
-        # TODO: Remove next major release
-        Shoryuken.logger.warn do
-          '[DEPRECATION] Passing a queue url into Shoryuken::Message is deprecated, please pass the queue itself'
-        end
-        self.queue_url = queue
-      end
+      self.client     = client
+      self.data       = data
+      self.queue_url  = queue.url
+      self.queue_name = queue.name
     end
 
     def delete

data/lib/shoryuken/middleware/chain.rb

@@ -102,32 +102,15 @@ module Shoryuken
 
     class Entry
       attr_reader :klass
+
       def initialize(klass, *args)
         @klass = klass
         @args  = args
-
-        patch_deprecated_middleware!(klass)
       end
 
       def make_new
         @klass.new(*@args)
       end
-
-      private
-
-      def patch_deprecated_middleware!(klass)
-        if klass.instance_method(:call).arity == 3
-          Shoryuken.logger.warn { "[DEPRECATION] #{klass.name}#call(worker_instance, queue, sqs_msg) is deprecated. Please use #{klass.name}#call(worker_instance, queue, sqs_msg, body)" }
-
-          klass.class_eval do
-            alias_method :deprecated_call, :call
-
-            def call(worker_instance, queue, sqs_msg, body = nil, &block)
-              deprecated_call(worker_instance, queue, sqs_msg, &block)
-            end
-          end
-        end
-      end
     end
   end
 end

data/lib/shoryuken/middleware/server/auto_extend_visibility.rb

@@ -1,51 +1,54 @@
-require 'celluloid' unless defined?(Celluloid)
-
 module Shoryuken
   module Middleware
     module Server
       class AutoExtendVisibility
+        include Util
+
         EXTEND_UPFRONT_SECONDS = 5
 
         def call(worker, queue, sqs_msg, body)
-          timer = auto_visibility_timer(queue, sqs_msg, worker.class)
-          begin
-            yield
-          ensure
-            timer.cancel if timer
+          if sqs_msg.is_a?(Array)
+            logger.warn { "Auto extend visibility isn't supported for batch workers" }
+            return yield
           end
+
+          timer = auto_visibility_timer(worker, queue, sqs_msg, body)
+          yield
+        ensure
+          timer.kill if timer
         end
 
         private
 
         class MessageVisibilityExtender
-          include Celluloid
           include Util
 
-          def auto_extend(queue, sqs_msg, worker_class)
+          def auto_extend(worker, queue, sqs_msg, body)
             queue_visibility_timeout = Shoryuken::Client.queues(queue).visibility_timeout
 
-            every(queue_visibility_timeout - EXTEND_UPFRONT_SECONDS) do
+            Concurrent::TimerTask.new(execution_interval: queue_visibility_timeout - EXTEND_UPFRONT_SECONDS) do
               begin
                 logger.debug do
-                  "Extending message #{worker_name(worker_class, sqs_msg)}/#{queue}/#{sqs_msg.message_id}  " \
-                               "visibility timeout by #{queue_visibility_timeout}s."
+                  "Extending message #{worker_name(worker.class, sqs_msg, body)}/#{queue}/#{sqs_msg.message_id} " \
+                  "visibility timeout by #{queue_visibility_timeout}s."
                 end
 
                 sqs_msg.change_visibility(visibility_timeout: queue_visibility_timeout)
               rescue => e
                 logger.error do
-                  "Could not auto extend the message #{worker_class}/#{queue}/#{sqs_msg.message_id} " \
-                               "visibility timeout. Error: #{e.message}"
+                  'Could not auto extend the message ' \
+                  "#{worker_name(worker.class, sqs_msg, body)}/#{queue}/#{sqs_msg.message_id} " \
+                  "visibility timeout. Error: #{e.message}"
                 end
               end
             end
           end
         end
 
-        def auto_visibility_timer(queue, sqs_msg, worker_class)
-          return unless worker_class.auto_visibility_timeout?
-          @visibility_extender ||= MessageVisibilityExtender.new_link
-          @visibility_extender.auto_extend(queue, sqs_msg, worker_class)
+        def auto_visibility_timer(worker, queue, sqs_msg, body)
+          return unless worker.class.auto_visibility_timeout?
+
+          MessageVisibilityExtender.new.auto_extend(worker, queue, sqs_msg, body).tap(&:execute)
         end
       end
     end

data/lib/shoryuken/middleware/server/exponential_backoff_retry.rb

@@ -5,12 +5,17 @@ module Shoryuken
         include Util
 
         def call(worker, queue, sqs_msg, body)
+          if sqs_msg.is_a?(Array)
+            logger.warn { "Exponential backoff isn't supported for batch workers" }
+            return yield
+          end
+
           started_at = Time.now
           yield
         rescue
-          retry_intervals = Array(worker.class.get_shoryuken_options['retry_intervals'])
+          retry_intervals = worker.class.get_shoryuken_options['retry_intervals']
 
-          if retry_intervals.empty? || !handle_failure(sqs_msg, started_at, retry_intervals)
+          if retry_intervals.nil? || !handle_failure(sqs_msg, started_at, retry_intervals)
             # Re-raise the exception if the job is not going to be exponential backoff retried.
             # This allows custom middleware (like exception notifiers) to be aware of the unhandled failure.
             raise
@@ -19,30 +24,32 @@ module Shoryuken
 
         private
 
-        def handle_failure(sqs_msg, started_at, retry_intervals)
-          attempts = sqs_msg.attributes['ApproximateReceiveCount']
+        def get_interval(retry_intervals, attempts)
+          return retry_intervals.call(attempts) if retry_intervals.respond_to?(:call)
 
-          return unless attempts
+          if attempts <= (retry_intervals = Array(retry_intervals)).size
+            retry_intervals[attempts - 1]
+          else
+            retry_intervals.last
+          end
+        end
 
-          attempts = attempts.to_i - 1
+        def next_visibility_timeout(interval, started_at)
+          max_timeout = 43_200 - (Time.now - started_at).ceil - 1
+          interval = max_timeout if interval > max_timeout
+          interval.to_i
+        end
 
-          interval = if attempts < retry_intervals.size
-                       retry_intervals[attempts]
-                     else
-                       retry_intervals.last
-                     end
+        def handle_failure(sqs_msg, started_at, retry_intervals)
+          receive_count = sqs_msg.attributes['ApproximateReceiveCount'].to_i
 
-          # Visibility timeouts are limited to a total 12 hours, starting from the receipt of the message.
-          # We calculate the maximum timeout by subtracting the amount of time since the receipt of the message.
-          #
-          # From the docs:  "Amazon SQS restarts the timeout period using the new value."
-          # http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AboutVT.html#AboutVT-extending-message-visibility-timeout
-          max_timeout = 43200 - (Time.now - started_at).ceil - 1
-          interval = max_timeout if interval > max_timeout
+          return false unless (interval = get_interval(retry_intervals, receive_count))
 
-          sqs_msg.change_visibility(visibility_timeout: interval.to_i)
+          sqs_msg.change_visibility(visibility_timeout: next_visibility_timeout(interval.to_i, started_at))
 
           logger.info { "Message #{sqs_msg.message_id} failed, will be retried in #{interval} seconds." }
+
+          true
         end
       end
     end