sidekiq 6.3.1 → 7.0.7

data/lib/sidekiq/web/csrf_protection.rb

@@ -143,7 +143,7 @@ module Sidekiq
         one_time_pad = SecureRandom.random_bytes(token.length)
         encrypted_token = xor_byte_strings(one_time_pad, token)
         masked_token = one_time_pad + encrypted_token
-        Base64.strict_encode64(masked_token)
+        Base64.urlsafe_encode64(masked_token)
       end
 
       # Essentially the inverse of +mask_token+.
@@ -152,7 +152,7 @@ module Sidekiq
         # value and decrypt it
         token_length = masked_token.length / 2
         one_time_pad = masked_token[0...token_length]
-        encrypted_token = masked_token[token_length..-1]
+        encrypted_token = masked_token[token_length..]
         xor_byte_strings(one_time_pad, encrypted_token)
       end
 
@@ -169,7 +169,7 @@ module Sidekiq
       end
 
       def decode_token(token)
-        Base64.strict_decode64(token)
+        Base64.urlsafe_decode64(token)
       end
 
       def xor_byte_strings(s1, s2)

data/lib/sidekiq/web/helpers.rb

@@ -15,7 +15,7 @@ module Sidekiq
       # so extensions can be localized
       @strings[lang] ||= settings.locales.each_with_object({}) do |path, global|
         find_locale_files(lang).each do |file|
-          strs = YAML.load(File.open(file))
+          strs = YAML.safe_load(File.read(file))
           global.merge!(strs[lang])
         end
       end
@@ -118,7 +118,7 @@ module Sidekiq
       }.join(" ")
     end
 
-    # mperham/sidekiq#3243
+    # sidekiq/sidekiq#3243
     def unfiltered?
       yield unless env["PATH_INFO"].start_with?("/filter/")
     end
@@ -137,33 +137,50 @@ module Sidekiq
     end
 
     def sort_direction_label
-      params[:direction] == "asc" ? "↑" : "↓"
+      (params[:direction] == "asc") ? "↑" : "↓"
     end
 
-    def workers
-      @workers ||= Sidekiq::Workers.new
+    def workset
+      @work ||= Sidekiq::WorkSet.new
     end
 
     def processes
       @processes ||= Sidekiq::ProcessSet.new
     end
 
+    # Sorts processes by hostname following the natural sort order
+    def sorted_processes
+      @sorted_processes ||= begin
+        return processes unless processes.all? { |p| p["hostname"] }
+
+        processes.to_a.sort_by do |process|
+          # Kudos to `shurikk` on StackOverflow
+          # https://stackoverflow.com/a/15170063/575547
+          process["hostname"].split(/(\d+)/).map { |a| /\d+/.match?(a) ? a.to_i : a }
+        end
+      end
+    end
+
+    def busy_weights(capsule_weights)
+      # backwards compat with 7.0.0, remove in 7.1
+      cw = [capsule_weights].flatten
+      cw.map { |hash|
+        hash.map { |name, weight| (weight > 0) ? +name << ": " << weight.to_s : name }.join(", ")
+      }.join("; ")
+    end
+
     def stats
       @stats ||= Sidekiq::Stats.new
     end
 
-    def redis_connection
+    def redis_url
       Sidekiq.redis do |conn|
-        conn.connection[:id]
+        conn.config.server_url
       end
     end
 
-    def namespace
-      @ns ||= Sidekiq.redis { |conn| conn.respond_to?(:namespace) ? conn.namespace : nil }
-    end
-
     def redis_info
-      Sidekiq.redis_info
+      Sidekiq.default_configuration.redis_info
     end
 
     def root_path
@@ -175,7 +192,7 @@ module Sidekiq
     end
 
     def current_status
-      workers.size == 0 ? "idle" : "active"
+      (workset.size == 0) ? "idle" : "active"
     end
 
     def relative_time(time)
@@ -208,7 +225,7 @@ module Sidekiq
     end
 
     def truncate(text, truncate_after_chars = 2000)
-      truncate_after_chars && text.size > truncate_after_chars ? "#{text[0..truncate_after_chars]}..." : text
+      (truncate_after_chars && text.size > truncate_after_chars) ? "#{text[0..truncate_after_chars]}..." : text
     end
 
     def display_args(args, truncate_after_chars = 2000)
@@ -242,7 +259,7 @@ module Sidekiq
       queue class args retry_count retried_at failed_at
       jid error_message error_class backtrace
       error_backtrace enqueued_at retry wrapped
-      created_at tags
+      created_at tags display_class
     ])
 
     def retry_extra_items(retry_job)
@@ -301,7 +318,7 @@ module Sidekiq
     end
 
     def environment_title_prefix
-      environment = Sidekiq.options[:environment] || ENV["APP_ENV"] || ENV["RAILS_ENV"] || ENV["RACK_ENV"] || "development"
+      environment = Sidekiq.default_configuration[:environment] || ENV["APP_ENV"] || ENV["RAILS_ENV"] || ENV["RACK_ENV"] || "development"
 
       "[#{environment.upcase}] " unless environment == "production"
     end
@@ -314,11 +331,8 @@ module Sidekiq
       Time.now.utc.strftime("%H:%M:%S UTC")
     end
 
-    def redis_connection_and_namespace
-      @redis_connection_and_namespace ||= begin
-        namespace_suffix = namespace.nil? ? "" : "##{namespace}"
-        "#{redis_connection}#{namespace_suffix}"
-      end
+    def pollable?
+      !(current_path == "" || current_path.start_with?("metrics"))
     end
 
     def retry_or_delete_or_kill(job, params)

data/lib/sidekiq/web.rb

@@ -30,7 +30,8 @@ module Sidekiq
       "Queues" => "queues",
       "Retries" => "retries",
       "Scheduled" => "scheduled",
-      "Dead" => "morgue"
+      "Dead" => "morgue",
+      "Metrics" => "metrics"
     }
 
     class << self
@@ -47,6 +48,10 @@ module Sidekiq
       end
       alias_method :tabs, :custom_tabs
 
+      def custom_job_info_rows
+        @custom_job_info_rows ||= []
+      end
+
       def locales
         @locales ||= LOCALES
       end
@@ -75,14 +80,6 @@ module Sidekiq
         send(:"#{attribute}=", value)
       end
 
-      def sessions=(val)
-        puts "WARNING: Sidekiq::Web.sessions= is no longer relevant and will be removed in Sidekiq 7.0. #{caller(1..1).first}"
-      end
-
-      def session_secret=(val)
-        puts "WARNING: Sidekiq::Web.session_secret= is no longer relevant and will be removed in Sidekiq 7.0. #{caller(1..1).first}"
-      end
-
       attr_accessor :app_url, :redis_pool
       attr_writer :locales, :views
     end
@@ -129,10 +126,6 @@ module Sidekiq
       send(:"#{attribute}=", value)
     end
 
-    def sessions=(val)
-      puts "Sidekiq::Web#sessions= is no longer relevant and will be removed in Sidekiq 7.0. #{caller[2..2].first}"
-    end
-
     def self.register(extension)
       extension.registered(WebApplication)
     end
@@ -144,13 +137,13 @@ module Sidekiq
       m = middlewares
 
       rules = []
-      rules = [[:all, {"Cache-Control" => "public, max-age=86400"}]] unless ENV["SIDEKIQ_WEB_TESTING"]
+      rules = [[:all, {"cache-control" => "public, max-age=86400"}]] unless ENV["SIDEKIQ_WEB_TESTING"]
 
       ::Rack::Builder.new do
         use Rack::Static, urls: ["/stylesheets", "/images", "/javascripts"],
-                          root: ASSETS,
-                          cascade: true,
-                          header_rules: rules
+          root: ASSETS,
+          cascade: true,
+          header_rules: rules
         m.each { |middleware, block| use(*middleware, &block) }
         use Sidekiq::Web::CsrfProtection unless $TESTING
         run WebApplication.new(klass)

data/lib/sidekiq/worker_compatibility_alias.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Sidekiq
+  # Sidekiq::Job is a new alias for Sidekiq::Worker as of Sidekiq 6.3.0.
+  # Use `include Sidekiq::Job` rather than `include Sidekiq::Worker`.
+  #
+  # The term "worker" is too generic and overly confusing, used in several
+  # different contexts meaning different things. Many people call a Sidekiq
+  # process a "worker". Some people call the thread that executes jobs a
+  # "worker". This change brings Sidekiq closer to ActiveJob where your job
+  # classes extend ApplicationJob.
+  Worker = Job
+end

data/lib/sidekiq.rb

@@ -1,14 +1,39 @@
 # frozen_string_literal: true
 
 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")
+fail "Sidekiq #{Sidekiq::VERSION} does not support Ruby versions below 2.7.0." if RUBY_PLATFORM != "java" && Gem::Version.new(RUBY_VERSION) < Gem::Version.new("2.7.0")
 
+begin
+  require "sidekiq-ent/version"
+  fail <<~EOM  if Gem::Version.new(Sidekiq::Enterprise::VERSION).segments[0] != Sidekiq::MAJOR
+
+    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.
+
+  EOM
+rescue LoadError
+end
+
+begin
+  require "sidekiq/pro/version"
+  fail <<~EOM  if Gem::Version.new(Sidekiq::Pro::VERSION).segments[0] != Sidekiq::MAJOR
+
+    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.
+
+  EOM
+rescue LoadError
+end
+
+require "sidekiq/config"
 require "sidekiq/logger"
 require "sidekiq/client"
-require "sidekiq/worker"
+require "sidekiq/transaction_aware_client"
 require "sidekiq/job"
-require "sidekiq/redis_connection"
-require "sidekiq/delay"
+require "sidekiq/worker_compatibility_alias"
+require "sidekiq/redis_client_adapter"
 
 require "json"
 
@@ -16,248 +41,106 @@ module Sidekiq
   NAME = "Sidekiq"
   LICENSE = "See LICENSE and the LGPL-3.0 for licensing details."
 
-  DEFAULTS = {
-    queues: [],
-    labels: [],
-    concurrency: 10,
-    require: ".",
-    strict: true,
-    environment: nil,
-    timeout: 25,
-    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"
-  }
-
   def self.❨╯°□°❩╯︵┻━┻
-    puts "Calm down, yo."
-  end
-
-  def self.options
-    @options ||= DEFAULTS.dup
-  end
-
-  def self.options=(opts)
-    @options = opts
-  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
-
-  ##
-  # 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?
+    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::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
-        if retryable && ex.message =~ /READONLY|NOREPLICAS|UNBLOCKED/
-          conn.disconnect!
-          retryable = false
-          retry
-        end
-        raise
-      end
-    end
-  end
-
-  def self.redis_info
-    redis do |conn|
-      # 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
-
-  def self.redis_pool
-    @redis ||= Sidekiq::RedisConnection.create
-  end
-
-  def self.redis=(hash)
-    @redis = if hash.is_a?(ConnectionPool)
-      hash
-    else
-      Sidekiq::RedisConnection.create(hash)
-    end
+  def self.load_json(string)
+    JSON.parse(string)
   end
 
-  def self.client_middleware
-    @client_chain ||= Middleware::Chain.new
-    yield @client_chain if block_given?
-    @client_chain
+  def self.dump_json(object)
+    JSON.generate(object)
   end
 
-  def self.server_middleware
-    @server_chain ||= default_server_middleware
-    yield @server_chain if block_given?
-    @server_chain
+  def self.pro?
+    defined?(Sidekiq::Pro)
   end
 
-  def self.default_server_middleware
-    Middleware::Chain.new
+  def self.ent?
+    defined?(Sidekiq::Enterprise)
   end
 
-  def self.default_worker_options=(hash)
-    # stringify
-    @default_worker_options = default_worker_options.merge(hash.transform_keys(&:to_s))
+  def self.redis_pool
+    (Thread.current[:sidekiq_capsule] || default_configuration).redis_pool
   end
 
-  def self.default_worker_options
-    defined?(@default_worker_options) ? @default_worker_options : DEFAULT_WORKER_OPTIONS
+  def self.redis(&block)
+    (Thread.current[:sidekiq_capsule] || default_configuration).redis(&block)
   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.strict_args!(mode = :raise)
+    Sidekiq::Config::DEFAULTS[:on_complex_arguments] = mode
   end
 
-  def self.load_json(string)
-    JSON.parse(string)
+  def self.default_job_options=(hash)
+    @default_job_options = default_job_options.merge(hash.transform_keys(&:to_s))
   end
 
-  def self.dump_json(object)
-    JSON.generate(object)
+  def self.default_job_options
+    @default_job_options ||= {"retry" => true, "queue" => "default"}
   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
+  def self.default_configuration
+    @config ||= Sidekiq::Config.new
   end
 
   def self.logger
-    @logger ||= Sidekiq::Logger.new($stdout, level: Logger::INFO)
+    default_configuration.logger
   end
 
-  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)
+  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)
-    options[:average_scheduled_poll_interval] = interval
+  def self.freeze!
+    @frozen = true
+    @config_blocks = nil
   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) }
+  #   inst = Sidekiq.configure_embed do |config|
+  #     config.queues = %w[critical default low]
   #   end
+  #   inst.run
+  #   sleep 10
+  #   inst.terminate
+  #
+  # 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.
   #
-  # The default error handler logs errors to Sidekiq.logger.
-  def self.error_handlers
-    options[:error_handlers]
+  # 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
 

data/sidekiq.gemspec

@@ -2,27 +2,37 @@ require_relative "lib/sidekiq/version"
 
 Gem::Specification.new do |gem|
   gem.authors = ["Mike Perham"]
-  gem.email = ["mperham@gmail.com"]
+  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", "sidekiqmon"]
-  gem.files = ["sidekiq.gemspec", "README.md", "Changes.md", "LICENSE"] + `git ls-files | grep -E '^(bin|lib|web)'`.split("\n")
+  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 = ">= 2.5.0"
+  gem.required_ruby_version = ">= 2.7.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"
+    "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"
   }
 
-  gem.add_dependency "redis", ">= 4.2.0"
-  gem.add_dependency "connection_pool", ">= 2.2.2"
-  gem.add_dependency "rack", "~> 2.0"
+  gem.add_dependency "redis-client", ">= 0.11.0"
+  gem.add_dependency "connection_pool", ">= 2.3.0"
+  gem.add_dependency "rack", ">= 2.2.4"
+  gem.add_dependency "concurrent-ruby", "< 2"
+  gem.post_install_message = <<~EOM
+    
+    Welcome to Sidekiq 7.0!
+    
+    1. Use `gem 'sidekiq', '<7'` in your Gemfile if you don't want this new version.
+    2. Read the release notes at https://github.com/sidekiq/sidekiq/blob/main/docs/7.0-Upgrade.md
+    3. If you have problems, search for open/closed issues at https://github.com/sidekiq/sidekiq/issues/
+
+  EOM
 end