sidekiq 5.1.3 → 6.4.1

data/lib/sidekiq.rb

@@ -1,44 +1,48 @@
 # 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/logging'
-require 'sidekiq/client'
-require 'sidekiq/worker'
-require 'sidekiq/redis_connection'
-require 'sidekiq/delay'
+require "sidekiq/version"
+fail "Sidekiq #{Sidekiq::VERSION} does not support Ruby versions below 2.5.0." if RUBY_PLATFORM != "java" && Gem::Version.new(RUBY_VERSION) < Gem::Version.new("2.5.0")
 
-require 'json'
+require "sidekiq/logger"
+require "sidekiq/client"
+require "sidekiq/worker"
+require "sidekiq/job"
+require "sidekiq/redis_connection"
+require "sidekiq/delay"
+
+require "json"
 
 module Sidekiq
-  NAME = 'Sidekiq'
-  LICENSE = 'See LICENSE and the LGPL-3.0 for licensing details.'
+  NAME = "Sidekiq"
+  LICENSE = "See LICENSE and the LGPL-3.0 for licensing details."
 
   DEFAULTS = {
     queues: [],
     labels: [],
-    concurrency: 25,
-    require: '.',
+    concurrency: 10,
+    require: ".",
+    strict: true,
     environment: nil,
-    timeout: 8,
+    timeout: 25,
     poll_interval_average: nil,
     average_scheduled_poll_interval: 5,
+    on_complex_arguments: :warn,
     error_handlers: [],
     death_handlers: [],
     lifecycle_events: {
       startup: [],
       quiet: [],
       shutdown: [],
-      heartbeat: [],
+      heartbeat: []
     },
     dead_max_jobs: 10_000,
     dead_timeout_in_seconds: 180 * 24 * 60 * 60, # 6 months
-    reloader: proc { |&block| block.call },
+    reloader: proc { |&block| block.call }
   }
 
   DEFAULT_WORKER_OPTIONS = {
-    'retry' => true,
-    'queue' => 'default'
+    "retry" => true,
+    "queue" => "default"
   }
 
   FAKE_INFO = {
@@ -56,6 +60,7 @@ module Sidekiq
   def self.options
     @options ||= DEFAULTS.dup
   end
+
   def self.options=(opts)
     @options = opts
   end
@@ -93,10 +98,17 @@ module Sidekiq
       retryable = true
       begin
         yield conn
-      rescue Redis::CommandError => ex
-        #2550 Failover can cause the server to become a slave, need
-        # to disconnect and reopen the socket to get back to the master.
-        (conn.disconnect!; retryable = false; retry) if retryable && ex.message =~ /READONLY/
+      rescue Redis::BaseError => ex
+        # 2550 Failover can cause the server to become a replica, need
+        # to disconnect and reopen the socket to get back to the primary.
+        # 4495 Use the same logic if we have a "Not enough replicas" error from the primary
+        # 4985 Use the same logic when a blocking command is force-unblocked
+        # The same retry logic is also used in client.rb
+        if retryable && ex.message =~ /READONLY|NOREPLICAS|UNBLOCKED/
+          conn.disconnect!
+          retryable = false
+          retry
+        end
         raise
       end
     end
@@ -104,19 +116,17 @@ module Sidekiq
 
   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
+      # 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 /unknown command/.match?(ex.message)
+      FAKE_INFO
     end
   end
 
@@ -150,18 +160,13 @@ module Sidekiq
 
   def self.default_worker_options=(hash)
     # stringify
-    @default_worker_options = default_worker_options.merge(Hash[hash.map{|k, v| [k.to_s, v]}])
+    @default_worker_options = default_worker_options.merge(hash.transform_keys(&:to_s))
   end
+
   def self.default_worker_options
     defined?(@default_worker_options) ? @default_worker_options : DEFAULT_WORKER_OPTIONS
   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
-  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
@@ -178,15 +183,41 @@ module Sidekiq
   def self.load_json(string)
     JSON.parse(string)
   end
+
   def self.dump_json(object)
     JSON.generate(object)
   end
 
+  def self.log_formatter
+    @log_formatter ||= if ENV["DYNO"]
+      Sidekiq::Logger::Formatters::WithoutTimestamp.new
+    else
+      Sidekiq::Logger::Formatters::Pretty.new
+    end
+  end
+
+  def self.log_formatter=(log_formatter)
+    @log_formatter = log_formatter
+    logger.formatter = log_formatter
+  end
+
   def self.logger
-    Sidekiq::Logging.logger
+    @logger ||= Sidekiq::Logger.new($stdout, level: Logger::INFO)
   end
-  def self.logger=(log)
-    Sidekiq::Logging.logger = log
+
+  def self.logger=(logger)
+    if logger.nil?
+      self.logger.level = Logger::FATAL
+      return self.logger
+    end
+
+    logger.extend(Sidekiq::LoggingUtils)
+
+    @logger = logger
+  end
+
+  def self.pro?
+    defined?(Sidekiq::Pro)
   end
 
   # How frequently Redis should be checked by a random Sidekiq process for
@@ -195,7 +226,7 @@ module Sidekiq
   #
   # 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
+    options[:average_scheduled_poll_interval] = interval
   end
 
   # Register a proc to handle any error which occurs within the Sidekiq process.
@@ -206,7 +237,7 @@ module Sidekiq
   #
   # The default error handler logs errors to Sidekiq.logger.
   def self.error_handlers
-    self.options[:error_handlers]
+    options[:error_handlers]
   end
 
   # Register a block to run at a point in the Sidekiq lifecycle.
@@ -223,6 +254,10 @@ module Sidekiq
     options[:lifecycle_events][event] << block
   end
 
+  def self.strict_args!(mode = :raise)
+    options[:on_complex_arguments] = mode
+  end
+
   # We are shutting down Sidekiq but what about workers that
   # are working on some long job?  This error is
   # raised in workers that have not finished within the hard
@@ -232,4 +267,4 @@ module Sidekiq
   class Shutdown < Interrupt; end
 end
 
-require 'sidekiq/rails' if defined?(::Rails::Engine)
+require "sidekiq/rails" if defined?(::Rails::Engine)

data/sidekiq.gemspec

@@ -1,28 +1,28 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/sidekiq/version', __FILE__)
+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 = ["mperham@gmail.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.test_files    = []
-  gem.name          = "sidekiq"
-  gem.require_paths = ["lib"]
-  gem.version       = Sidekiq::VERSION
-  gem.required_ruby_version = ">= 2.2.2"
+  gem.executables = ["sidekiq", "sidekiqmon"]
+  gem.files = ["sidekiq.gemspec", "README.md", "Changes.md", "LICENSE"] + `git ls-files | grep -E '^(bin|lib|web)'`.split("\n")
+  gem.name = "sidekiq"
+  gem.version = Sidekiq::VERSION
+  gem.required_ruby_version = ">= 2.5.0"
 
-  gem.add_dependency                  'redis', '>= 3.3.5', '< 5'
-  gem.add_dependency                  'connection_pool', '~> 2.2', '>= 2.2.0'
-  gem.add_dependency                  'concurrent-ruby', '~> 1.0'
-  gem.add_dependency                  'rack-protection', '>= 1.5.0'
-  gem.add_development_dependency      'redis-namespace', '~> 1.5', '>= 1.5.2'
-  gem.add_development_dependency      'minitest', '~> 5.10', '>= 5.10.1'
-  gem.add_development_dependency      'rake', '~> 10.0'
-  gem.add_development_dependency      'rails', '>= 3.2.0'
+  gem.metadata = {
+    "homepage_uri" => "https://sidekiq.org",
+    "bug_tracker_uri" => "https://github.com/mperham/sidekiq/issues",
+    "documentation_uri" => "https://github.com/mperham/sidekiq/wiki",
+    "changelog_uri" => "https://github.com/mperham/sidekiq/blob/main/Changes.md",
+    "source_code_uri" => "https://github.com/mperham/sidekiq"
+  }
+
+  gem.add_dependency "redis", ">= 4.2.0"
+  gem.add_dependency "connection_pool", ">= 2.2.2"
+  gem.add_dependency "rack", "~> 2.0"
 end