Contents

# frozen_string_literal: true
# 3rd party
require "sidekiq"

# internal
require "sidekiq/version"
require "sidekiq/throttled/registry"
require "sidekiq/throttled/worker"

# @see https://github.com/mperham/sidekiq/
module Sidekiq
  # Concurrency and threshold throttling for Sidekiq.
  #
  # Just add somewhere in your bootstrap:
  #
  #     require "sidekiq/throttled"
  #     Sidekiq::Throttled.setup!
  #
  # Once you've done that you can include {Sidekiq::Throttled::Worker} to your
  # job classes and configure throttling:
  #
  #     class MyWorker
  #       include Sidekiq::Worker
  #       include Sidekiq::Throttled::Worker
  #
  #       sidekiq_options :queue => :my_queue
  #
  #       sidekiq_throttle({
  #         # Allow maximum 10 concurrent jobs of this class at a time.
  #         :concurrency => { :limit => 10 },
  #         # Allow maximum 1K jobs being processed within one hour window.
  #         :threshold => { :limit => 1_000, :period => 1.hour }
  #       })
  #
  #       def perform
  #         # ...
  #       end
  #     end
  module Throttled
    class << self
      # Hooks throttler into sidekiq.
      # @return [void]
      def setup!
        Sidekiq.configure_server do |config|
          require "sidekiq/throttled/fetch"
          Sidekiq.options[:fetch] = Sidekiq::Throttled::Fetch

          require "sidekiq/throttled/middleware"
          config.server_middleware do |chain|
            chain.add Sidekiq::Throttled::Middleware
          end
        end
      end

      # @param [String] message JSON payload of job
      # @return [TrueClass] if job is not allowed to be processed now
      # @return [FalseClass] otherwise
      def throttled?(message)
        message = JSON.parse message
        job = message.fetch("class".freeze) { return false }
        jid = message.fetch("jid".freeze) { return false }

        Registry.get job do |strategy|
          return strategy.throttled?(jid, *message["args"])
        end

        false
      rescue
        false
      end
    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
sidekiq-throttled-0.5.0	lib/sidekiq/throttled.rb