sidekiq 6.5.10 → 8.1.7

data/lib/sidekiq/web.rb

@@ -1,27 +1,19 @@
 # frozen_string_literal: true
 
 require "erb"
-
-require "sidekiq"
-require "sidekiq/api"
-require "sidekiq/paginator"
-require "sidekiq/web/helpers"
-
-require "sidekiq/web/router"
-require "sidekiq/web/action"
-require "sidekiq/web/application"
-require "sidekiq/web/csrf_protection"
-
-require "rack/content_length"
+require "securerandom"
 require "rack/builder"
 require "rack/static"
+require "sidekiq"
+require "sidekiq/api"
+require "sidekiq/web/config"
 
 module Sidekiq
   class Web
     ROOT = File.expand_path("#{File.dirname(__FILE__)}/../../web")
     VIEWS = "#{ROOT}/views"
     LOCALES = ["#{ROOT}/locales"]
-    LAYOUT = "#{VIEWS}/layout.erb"
+    LAYOUT = "#{VIEWS}/layout.html.erb"
     ASSETS = "#{ROOT}/assets"
 
     DEFAULT_TABS = {
@@ -30,144 +22,119 @@ module Sidekiq
       "Queues" => "queues",
       "Retries" => "retries",
       "Scheduled" => "scheduled",
-      "Dead" => "morgue"
+      "Dead" => "morgue",
+      "Metrics" => "metrics",
+      "Profiles" => "profiles"
     }
 
-    if ENV["SIDEKIQ_METRICS_BETA"] == "1"
-      DEFAULT_TABS["Metrics"] = "metrics"
-    end
+    @@config = Sidekiq::Web::Config.new
 
     class << self
-      def settings
-        self
+      def configure
+        if block_given?
+          yield @@config
+        else
+          @@config
+        end
       end
 
-      def default_tabs
-        DEFAULT_TABS
+      def app_url=(url)
+        @@config.app_url = url
       end
 
-      def custom_tabs
-        @custom_tabs ||= {}
+      def assets_path=(path)
+        @@config.assets_path = path
       end
-      alias_method :tabs, :custom_tabs
 
-      def locales
-        @locales ||= LOCALES
-      end
+      def assets_path = @@config.assets_path
 
-      def views
-        @views ||= VIEWS
-      end
+      def tabs = @@config.tabs
 
-      def enable(*opts)
-        opts.each { |key| set(key, true) }
-      end
+      def locales = @@config.locales
 
-      def disable(*opts)
-        opts.each { |key| set(key, false) }
-      end
-
-      def middlewares
-        @middlewares ||= []
-      end
-
-      def use(*args, &block)
-        middlewares << [args, block]
-      end
+      def views = @@config.views
 
-      def set(attribute, value)
-        send(:"#{attribute}=", value)
-      end
+      def custom_job_info_rows = @@config.custom_job_info_rows
 
-      def sessions=(val)
-        puts "WARNING: Sidekiq::Web.sessions= is no longer relevant and will be removed in Sidekiq 7.0. #{caller(1..1).first}"
+      def redis_pool
+        @pool || Sidekiq.default_configuration.redis_pool
       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}"
+      def redis_pool=(pool)
+        @pool = pool
       end
 
-      attr_accessor :app_url, :redis_pool
-      attr_writer :locales, :views
-    end
+      def middlewares = @@config.middlewares
 
-    def self.inherited(child)
-      child.app_url = app_url
-      child.redis_pool = redis_pool
-    end
+      def use(*args, &block) = @@config.middlewares << [args, block]
 
-    def settings
-      self.class.settings
+      def register(*args, **kw, &block)
+        Sidekiq.logger.warn { "`Sidekiq::Web.register` is deprecated, use `Sidekiq::Web.configure {|cfg| cfg.register(...) }`" }
+        @@config.register(*args, **kw, &block)
+      end
     end
 
-    def middlewares
-      @middlewares ||= self.class.middlewares
+    # Allow user to say
+    #   run Sidekiq::Web
+    # rather than:
+    #   run Sidekiq::Web.new
+    def self.call(env)
+      @inst ||= new
+      @inst.call(env)
     end
 
-    def use(*args, &block)
-      middlewares << [args, block]
+    # testing, internal use only
+    def self.reset!
+      @@config.reset!
+      @inst = nil
     end
 
     def call(env)
-      app.call(env)
-    end
-
-    def self.call(env)
-      @app ||= new
-      @app.call(env)
+      env[:web_config] = Sidekiq::Web.configure
+      env[:csp_nonce] = SecureRandom.hex(8)
+      env[:redis_pool] = self.class.redis_pool
+      safe_request?(env) ? app.call(env) : deny(env)
     end
 
     def app
-      @app ||= build
-    end
-
-    def enable(*opts)
-      opts.each { |key| set(key, true) }
+      @app ||= build(@@config)
     end
 
-    def disable(*opts)
-      opts.each { |key| set(key, false) }
+    def safe_methods?(env)
+      %w[GET HEAD OPTIONS TRACE].include? env["REQUEST_METHOD"]
     end
 
-    def set(attribute, value)
-      send(:"#{attribute}=", value)
+    def safe_request?(env)
+      return true if safe_methods?(env)
+      env["HTTP_SEC_FETCH_SITE"] == "same-origin"
     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)
+    def deny(env)
+      Sidekiq.logger.warn "attack prevented by #{self.class}"
+      [403, {Rack::CONTENT_TYPE => "text/plain"}, ["Forbidden"]]
     end
 
     private
 
-    def build
-      klass = self.class
-      m = middlewares
+    def build(cfg)
+      cfg.freeze
+      m = cfg.middlewares
 
       rules = []
-      rules = [[:all, {"cache-control" => "public, max-age=86400"}]] unless ENV["SIDEKIQ_WEB_TESTING"]
+      rules = [[:all, {"cache-control" => "private, max-age=86400"}]] unless ENV["SIDEKIQ_WEB_TESTING"]
 
       ::Rack::Builder.new do
         use Rack::Static, urls: ["/stylesheets", "/images", "/javascripts"],
-          root: ASSETS,
+          root: cfg.assets_path,
           cascade: true,
           header_rules: rules
         m.each { |middleware, block| use(*middleware, &block) }
-        use Sidekiq::Web::CsrfProtection unless $TESTING
-        run WebApplication.new(klass)
+        run Sidekiq::Web::Application.new(self.class)
       end
     end
   end
-
-  Sidekiq::WebApplication.helpers WebHelpers
-  Sidekiq::WebApplication.helpers Sidekiq::Paginator
-
-  Sidekiq::WebAction.class_eval <<-RUBY, __FILE__, __LINE__ + 1
-    def _render
-      #{ERB.new(File.read(Web::LAYOUT)).src}
-    end
-  RUBY
 end
+
+require "sidekiq/web/router"
+require "sidekiq/web/action"
+require "sidekiq/web/application"

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,15 +1,41 @@
 # 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 3.2.0." if RUBY_PLATFORM != "java" && Gem::Version.new(RUBY_VERSION) < Gem::Version.new("3.2.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/loader"
 require "sidekiq/client"
 require "sidekiq/transaction_aware_client"
-require "sidekiq/worker"
 require "sidekiq/job"
-require "sidekiq/redis_connection"
-require "sidekiq/delay"
+require "sidekiq/iterable_job"
+require "sidekiq/worker_compatibility_alias"
+require "sidekiq/redis_client_adapter"
 
 require "json"
 
@@ -17,320 +43,110 @@ 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,
-    on_complex_arguments: :warn,
-    error_handlers: [],
-    death_handlers: [],
-    lifecycle_events: {
-      startup: [],
-      quiet: [],
-      shutdown: [],
-      # triggers when we fire the first heartbeat on startup OR repairing a network partition
-      heartbeat: [],
-      # triggers on EVERY heartbeat call, every 10 seconds
-      beat: []
-    },
-    dead_max_jobs: 10_000,
-    dead_timeout_in_seconds: 180 * 24 * 60 * 60, # 6 months
-    reloader: proc { |&block| block.call }
-  }
-
-  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
-
-  # config.concurrency = 5
-  def self.concurrency=(val)
-    self[:concurrency] = Integer(val)
-  end
-
-  # config.queues = %w( high default low )                 # strict
-  # config.queues = %w( high,3 default,2 low,1 )           # weighted
-  # config.queues = %w( feature1,1 feature2,1 feature3,1 ) # random
-  #
-  # With weighted priority, queue will be checked first (weight / total) of the time.
-  # high will be checked first (3/6) or 50% of the time.
-  # I'd recommend setting weights between 1-10. Weights in the hundreds or thousands
-  # are ridiculous and unnecessarily expensive. You can get random queue ordering
-  # by explicitly setting all weights to 1.
-  def self.queues=(val)
-    self[:queues] = Array(val).each_with_object([]) do |qstr, memo|
-      name, weight = qstr.split(",")
-      self[:strict] = false if weight.to_i > 0
-      [weight.to_i, 1].max.times do
-        memo << name
-      end
-    end
-  end
-
-  ### Private APIs
-  def self.default_error_handler(ex, ctx)
-    logger.warn(dump_json(ctx)) unless ctx.empty?
-    logger.warn("#{ex.class.name}: #{ex.message}")
-    logger.warn(ex.backtrace.join("\n")) unless ex.backtrace.nil?
-  end
-
-  # DEFAULT_ERROR_HANDLER is a constant that allows the default error handler to
-  # be referenced. It must be defined here, after the default_error_handler
-  # method is defined.
-  DEFAULT_ERROR_HANDLER = method(:default_error_handler)
-
-  @config = DEFAULTS.dup
-  def self.options
-    logger.warn "`config.options[:key] = value` is deprecated, use `config[:key] = value`: #{caller(1..2)}"
-    @config
-  end
-
-  def self.options=(opts)
-    logger.warn "config.options = hash` is deprecated, use `config.merge!(hash)`: #{caller(1..2)}"
-    @config = opts
+    puts "Take a deep breath and count to ten..."
   end
 
-  def self.[](key)
-    @config[key]
-  end
-
-  def self.[]=(key, val)
-    @config[key] = val
-  end
+  def self.testing!(mode = :fake, &block)
+    raise "Unknown testing mode: #{mode}" unless %i[fake disable inline].include?(mode)
 
-  def self.merge!(hash)
-    @config.merge!(hash)
-  end
-
-  def self.fetch(*args, &block)
-    @config.fetch(*args, &block)
-  end
-
-  def self.handle_exception(ex, ctx = {})
-    self[:error_handlers].each do |handler|
-      handler.call(ex, ctx)
-    rescue => ex
-      logger.error "!!! ERROR HANDLER THREW AN ERROR !!!"
-      logger.error ex
-      logger.error ex.backtrace.join("\n") unless ex.backtrace.nil?
-    end
-  end
-  ###
-
-  ##
-  # Configuration for Sidekiq server, use like:
-  #
-  #   Sidekiq.configure_server do |config|
-  #     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 = { size: 1, url: 'redis://myhost:8877/0' }
-  #   end
-  def self.configure_client
-    yield self unless server?
+    require "sidekiq/test_api"
+    Sidekiq::Testing.__set_test_mode(mode, &block)
   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 RedisConnection.adapter::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
-  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 RedisConnection.adapter::CommandError => ex
-      # 2850 return fake version when INFO command has (probably) been renamed
-      raise unless /unknown command/.match?(ex.message)
-      FAKE_INFO
-    end
+  def self.load_json(string)
+    JSON.parse(string)
   end
 
-  def self.redis_pool
-    @redis ||= RedisConnection.create
+  def self.dump_json(object)
+    JSON.generate(object)
   end
 
-  def self.redis=(hash)
-    @redis = if hash.is_a?(ConnectionPool)
-      hash
-    else
-      RedisConnection.create(hash)
-    end
+  def self.pro?
+    defined?(Sidekiq::Pro)
   end
 
-  def self.client_middleware
-    @client_chain ||= Middleware::Chain.new(self)
-    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(self)
+  def self.redis(&block)
+    (Thread.current[:sidekiq_capsule] || default_configuration).redis(&block)
   end
 
-  def self.default_worker_options=(hash) # deprecated
-    @default_job_options = default_job_options.merge(hash.transform_keys(&:to_s))
+  def self.strict_args!(mode = :raise)
+    Sidekiq::Config::DEFAULTS[:on_complex_arguments] = mode
   end
 
   def self.default_job_options=(hash)
     @default_job_options = default_job_options.merge(hash.transform_keys(&:to_s))
   end
 
-  def self.default_worker_options # deprecated
-    @default_job_options ||= {"retry" => true, "queue" => "default"}
-  end
-
   def self.default_job_options
     @default_job_options ||= {"retry" => true, "queue" => "default"}
   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
-    self[:death_handlers]
-  end
-
-  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
+  def self.default_configuration
+    @config ||= Sidekiq::Config.new
   end
 
   def self.logger
-    @logger ||= Sidekiq::Logger.new($stdout, level: :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
+  def self.loader
+    @loader ||= Loader.new
   end
 
-  def self.pro?
-    defined?(Sidekiq::Pro)
+  def self.configure_server(&block)
+    (@config_blocks ||= []) << block
+    yield default_configuration if server?
   end
 
-  def self.ent?
-    defined?(Sidekiq::Enterprise)
+  def self.freeze!
+    @frozen = true
+    @config_blocks = nil
+    default_configuration.freeze!
   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.
+  # 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.
   #
-  # See sidekiq/scheduled.rb for an in-depth explanation of this value
-  def self.average_scheduled_poll_interval=(interval)
-    self[:average_scheduled_poll_interval] = interval
-  end
-
-  # Register a proc to handle any error which occurs within the Sidekiq process.
-  #
-  #   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[:error_handlers]
-  end
-
-  # Register a block to run at a point in the Sidekiq lifecycle.
-  # :startup, :quiet or :shutdown are valid events.
+  # 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.
   #
-  #   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 self[:lifecycle_events].key?(event)
-    self[:lifecycle_events][event] << block
+  # 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
 
-  def self.strict_args!(mode = :raise)
-    self[:on_complex_arguments] = mode
+  def self.configure_client
+    yield default_configuration unless server?
   end
 
   # We are shutting down Sidekiq but what about threads that