sidekiq 5.2.7 → 8.0.5

data/lib/sidekiq.rb

@@ -1,237 +1,149 @@
 # frozen_string_literal: true
 
-require 'sidekiq/version'
-fail "Sidekiq #{Sidekiq::VERSION} does not support Ruby versions below 2.2.2." if RUBY_PLATFORM != 'java' && Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.2.2')
+require "sidekiq/version"
+fail "Sidekiq #{Sidekiq::VERSION} does not support Ruby versions below 3.2.0." if RUBY_PLATFORM != "java" && Gem::Version.new(RUBY_VERSION) < Gem::Version.new("3.2.0")
 
-require 'sidekiq/logging'
-require 'sidekiq/client'
-require 'sidekiq/worker'
-require 'sidekiq/redis_connection'
-require 'sidekiq/delay'
+begin
+  require "sidekiq-ent/version"
+  fail <<~EOM  if Gem::Version.new(Sidekiq::Enterprise::VERSION).segments[0] != Sidekiq::MAJOR
 
-require 'json'
+    Sidekiq Enterprise #{Sidekiq::Enterprise::VERSION} does not work with Sidekiq #{Sidekiq::VERSION}.
+    Starting with Sidekiq 7, major versions are synchronized so Sidekiq Enterprise 7 works with Sidekiq 7.
+    Use `bundle up sidekiq-ent` to upgrade.
 
-module Sidekiq
-  NAME = 'Sidekiq'
-  LICENSE = 'See LICENSE and the LGPL-3.0 for licensing details.'
-
-  DEFAULTS = {
-    queues: [],
-    labels: [],
-    concurrency: 10,
-    require: '.',
-    environment: nil,
-    timeout: 8,
-    poll_interval_average: nil,
-    average_scheduled_poll_interval: 5,
-    error_handlers: [],
-    death_handlers: [],
-    lifecycle_events: {
-      startup: [],
-      quiet: [],
-      shutdown: [],
-      heartbeat: [],
-    },
-    dead_max_jobs: 10_000,
-    dead_timeout_in_seconds: 180 * 24 * 60 * 60, # 6 months
-    reloader: proc { |&block| block.call },
-  }
-
-  DEFAULT_WORKER_OPTIONS = {
-    'retry' => true,
-    'queue' => 'default'
-  }
-
-  FAKE_INFO = {
-    "redis_version" => "9.9.9",
-    "uptime_in_days" => "9999",
-    "connected_clients" => "9999",
-    "used_memory_human" => "9P",
-    "used_memory_peak_human" => "9P"
-  }
+  EOM
+rescue LoadError
+end
 
-  def self.❨╯°□°❩╯︵┻━┻
-    puts "Calm down, yo."
-  end
+begin
+  require "sidekiq/pro/version"
+  fail <<~EOM  if Gem::Version.new(Sidekiq::Pro::VERSION).segments[0] != Sidekiq::MAJOR
 
-  def self.options
-    @options ||= DEFAULTS.dup
-  end
+    Sidekiq Pro #{Sidekiq::Pro::VERSION} does not work with Sidekiq #{Sidekiq::VERSION}.
+    Starting with Sidekiq 7, major versions are synchronized so Sidekiq Pro 7 works with Sidekiq 7.
+    Use `bundle up sidekiq-pro` to upgrade.
 
-  def self.options=(opts)
-    @options = opts
-  end
+  EOM
+rescue LoadError
+end
 
-  ##
-  # Configuration for Sidekiq server, use like:
-  #
-  #   Sidekiq.configure_server do |config|
-  #     config.redis = { :namespace => 'myapp', :size => 25, :url => 'redis://myhost:8877/0' }
-  #     config.server_middleware do |chain|
-  #       chain.add MyServerHook
-  #     end
-  #   end
-  def self.configure_server
-    yield self if server?
-  end
+require "sidekiq/config"
+require "sidekiq/logger"
+require "sidekiq/client"
+require "sidekiq/transaction_aware_client"
+require "sidekiq/job"
+require "sidekiq/iterable_job"
+require "sidekiq/worker_compatibility_alias"
+require "sidekiq/redis_client_adapter"
 
-  ##
-  # Configuration for Sidekiq client, use like:
-  #
-  #   Sidekiq.configure_client do |config|
-  #     config.redis = { :namespace => 'myapp', :size => 1, :url => 'redis://myhost:8877/0' }
-  #   end
-  def self.configure_client
-    yield self unless server?
+require "json"
+
+module Sidekiq
+  NAME = "Sidekiq"
+  LICENSE = "See LICENSE and the LGPL-3.0 for licensing details."
+
+  def self.❨╯°□°❩╯︵┻━┻
+    puts "Take a deep breath and count to ten..."
   end
 
   def self.server?
     defined?(Sidekiq::CLI)
   end
 
-  def self.redis
-    raise ArgumentError, "requires a block" unless block_given?
-    redis_pool.with do |conn|
-      retryable = true
-      begin
-        yield conn
-      rescue Redis::CommandError => ex
-        #2550 Failover can cause the server to become a replica, need
-        # to disconnect and reopen the socket to get back to the primary.
-        (conn.disconnect!; retryable = false; retry) if retryable && ex.message =~ /READONLY/
-        raise
-      end
-    end
-  end
-
-  def self.redis_info
-    redis do |conn|
-      begin
-        # admin commands can't go through redis-namespace starting
-        # in redis-namespace 2.0
-        if conn.respond_to?(:namespace)
-          conn.redis.info
-        else
-          conn.info
-        end
-      rescue Redis::CommandError => ex
-        #2850 return fake version when INFO command has (probably) been renamed
-        raise unless ex.message =~ /unknown command/
-        FAKE_INFO
-      end
-    end
+  def self.load_json(string)
+    JSON.parse(string)
   end
 
-  def self.redis_pool
-    @redis ||= Sidekiq::RedisConnection.create
+  def self.dump_json(object)
+    JSON.generate(object)
   end
 
-  def self.redis=(hash)
-    @redis = if hash.is_a?(ConnectionPool)
-      hash
-    else
-      Sidekiq::RedisConnection.create(hash)
-    end
+  def self.pro?
+    defined?(Sidekiq::Pro)
   end
 
-  def self.client_middleware
-    @client_chain ||= Middleware::Chain.new
-    yield @client_chain if block_given?
-    @client_chain
+  def self.ent?
+    defined?(Sidekiq::Enterprise)
   end
 
-  def self.server_middleware
-    @server_chain ||= default_server_middleware
-    yield @server_chain if block_given?
-    @server_chain
+  def self.redis_pool
+    (Thread.current[:sidekiq_capsule] || default_configuration).redis_pool
   end
 
-  def self.default_server_middleware
-    Middleware::Chain.new
+  def self.redis(&block)
+    (Thread.current[:sidekiq_capsule] || default_configuration).redis(&block)
   end
 
-  def self.default_worker_options=(hash)
-    # stringify
-    @default_worker_options = default_worker_options.merge(Hash[hash.map{|k, v| [k.to_s, v]}])
-  end
-  def self.default_worker_options
-    defined?(@default_worker_options) ? @default_worker_options : DEFAULT_WORKER_OPTIONS
+  def self.strict_args!(mode = :raise)
+    Sidekiq::Config::DEFAULTS[:on_complex_arguments] = mode
   end
 
-  def self.default_retries_exhausted=(prok)
-    logger.info { "default_retries_exhausted is deprecated, please use `config.death_handlers << -> {|job, ex| }`" }
-    return nil unless prok
-    death_handlers << prok
+  def self.default_job_options=(hash)
+    @default_job_options = default_job_options.merge(hash.transform_keys(&:to_s))
   end
 
-  ##
-  # Death handlers are called when all retries for a job have been exhausted and
-  # the job dies.  It's the notification to your application
-  # that this job will not succeed without manual intervention.
-  #
-  # Sidekiq.configure_server do |config|
-  #   config.death_handlers << ->(job, ex) do
-  #   end
-  # end
-  def self.death_handlers
-    options[:death_handlers]
+  def self.default_job_options
+    @default_job_options ||= {"retry" => true, "queue" => "default"}
   end
 
-  def self.load_json(string)
-    JSON.parse(string)
-  end
-  def self.dump_json(object)
-    JSON.generate(object)
+  def self.default_configuration
+    @config ||= Sidekiq::Config.new
   end
 
   def self.logger
-    Sidekiq::Logging.logger
+    default_configuration.logger
   end
-  def self.logger=(log)
-    Sidekiq::Logging.logger = log
+
+  def self.configure_server(&block)
+    (@config_blocks ||= []) << block
+    yield default_configuration if server?
   end
 
-  # How frequently Redis should be checked by a random Sidekiq process for
-  # scheduled and retriable jobs. Each individual process will take turns by
-  # waiting some multiple of this value.
-  #
-  # See sidekiq/scheduled.rb for an in-depth explanation of this value
-  def self.average_scheduled_poll_interval=(interval)
-    self.options[:average_scheduled_poll_interval] = interval
+  def self.freeze!
+    @frozen = true
+    @config_blocks = nil
+    default_configuration.freeze!
   end
 
-  # Register a proc to handle any error which occurs within the Sidekiq process.
+  # Creates a Sidekiq::Config instance that is more tuned for embedding
+  # within an arbitrary Ruby process. Notably it reduces concurrency by
+  # default so there is less contention for CPU time with other threads.
   #
-  #   Sidekiq.configure_server do |config|
-  #     config.error_handlers << proc {|ex,ctx_hash| MyErrorService.notify(ex, ctx_hash) }
+  #   instance = Sidekiq.configure_embed do |config|
+  #     config.queues = %w[critical default low]
   #   end
+  #   instance.run
+  #   sleep 10
+  #   instance.stop
   #
-  # The default error handler logs errors to Sidekiq.logger.
-  def self.error_handlers
-    self.options[:error_handlers]
+  # NB: it is really easy to overload a Ruby process with threads due to the GIL.
+  # I do not recommend setting concurrency higher than 2-3.
+  #
+  # NB: Sidekiq only supports one instance in memory. You will get undefined behavior
+  # if you try to embed Sidekiq twice in the same process.
+  def self.configure_embed(&block)
+    raise "Sidekiq global configuration is frozen, you must create all embedded instances BEFORE calling `run`" if @frozen
+
+    require "sidekiq/embedded"
+    cfg = default_configuration
+    cfg.concurrency = 2
+    @config_blocks&.each { |block| block.call(cfg) }
+    yield cfg
+
+    Sidekiq::Embedded.new(cfg)
   end
 
-  # Register a block to run at a point in the Sidekiq lifecycle.
-  # :startup, :quiet or :shutdown are valid events.
-  #
-  #   Sidekiq.configure_server do |config|
-  #     config.on(:shutdown) do
-  #       puts "Goodbye cruel world!"
-  #     end
-  #   end
-  def self.on(event, &block)
-    raise ArgumentError, "Symbols only please: #{event}" unless event.is_a?(Symbol)
-    raise ArgumentError, "Invalid event name: #{event}" unless options[:lifecycle_events].key?(event)
-    options[:lifecycle_events][event] << block
+  def self.configure_client
+    yield default_configuration unless server?
   end
 
-  # We are shutting down Sidekiq but what about workers that
+  # We are shutting down Sidekiq but what about threads that
   # are working on some long job?  This error is
-  # raised in workers that have not finished within the hard
+  # raised in jobs that have not finished within the hard
   # timeout limit.  This is needed to rollback db transactions,
   # otherwise Ruby's Thread#kill will commit.  See #377.
-  # DO NOT RESCUE THIS ERROR IN YOUR WORKERS
+  # DO NOT RESCUE THIS ERROR IN YOUR JOBS
   class Shutdown < Interrupt; end
 end
 
-require 'sidekiq/rails' if defined?(::Rails::Engine)
+require "sidekiq/rails" if defined?(::Rails::Engine)

data/sidekiq.gemspec

@@ -1,21 +1,31 @@
-require_relative 'lib/sidekiq/version'
+require_relative "lib/sidekiq/version"
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["Mike Perham"]
-  gem.email         = ["mperham@gmail.com"]
-  gem.summary       = "Simple, efficient background processing for Ruby"
-  gem.description   = "Simple, efficient background processing for Ruby."
-  gem.homepage      = "http://sidekiq.org"
-  gem.license       = "LGPL-3.0"
+  gem.authors = ["Mike Perham"]
+  gem.email = ["info@contribsys.com"]
+  gem.summary = "Simple, efficient background processing for Ruby"
+  gem.description = "Simple, efficient background processing for Ruby."
+  gem.homepage = "https://sidekiq.org"
+  gem.license = "LGPL-3.0"
 
-  gem.executables   = ['sidekiq', 'sidekiqctl']
-  gem.files         = `git ls-files | grep -Ev '^(test|myapp|examples)'`.split("\n")
-  gem.name          = "sidekiq"
-  gem.version       = Sidekiq::VERSION
-  gem.required_ruby_version = ">= 2.2.2"
+  gem.executables = ["sidekiq", "sidekiqmon"]
+  gem.files = %w[sidekiq.gemspec README.md Changes.md LICENSE.txt] + `git ls-files | grep -E '^(bin|lib|web)'`.split("\n")
+  gem.name = "sidekiq"
+  gem.version = Sidekiq::VERSION
+  gem.required_ruby_version = ">= 3.2.0"
 
-  gem.add_dependency 'redis', '>= 3.3.5', '< 5'
-  gem.add_dependency 'connection_pool', '~> 2.2', '>= 2.2.2'
-  gem.add_dependency 'rack', '>= 1.5.0'
-  gem.add_dependency 'rack-protection', '>= 1.5.0'
+  gem.metadata = {
+    "homepage_uri" => "https://sidekiq.org",
+    "bug_tracker_uri" => "https://github.com/sidekiq/sidekiq/issues",
+    "documentation_uri" => "https://github.com/sidekiq/sidekiq/wiki",
+    "changelog_uri" => "https://github.com/sidekiq/sidekiq/blob/main/Changes.md",
+    "source_code_uri" => "https://github.com/sidekiq/sidekiq",
+    "rubygems_mfa_required" => "true"
+  }
+
+  gem.add_dependency "redis-client", ">= 0.23.2"
+  gem.add_dependency "connection_pool", ">= 2.5.0"
+  gem.add_dependency "rack", ">= 3.1.0"
+  gem.add_dependency "json", ">= 2.9.0"
+  gem.add_dependency "logger", ">= 1.6.2"
 end