sidekiq 8.0.0.beta2 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1701d726f9433f505053b19c5c708c76ec16cc815cef96492f085e914f52c016
-  data.tar.gz: 81504bd7aad6e5815027008a4d61908d898742b4f64ceb518e1fff078de228a6
+  metadata.gz: e6ce813e475bd69e3cb05f0ebe216e1dcbd6b4865584a4761c889a97761d5fe1
+  data.tar.gz: 855e4b4db0b7c080f9a4347c338eff1c4b62be91e233d0e20447b15a3251756a
 SHA512:
-  metadata.gz: 96c78d5229328a1fcfc4663afc4c32437ec8438e246641739409876f608aa90ad19aca7185f0ae7b1e2a26291e105bf3fccda538dde508d1aaea854c4fcc9ef6
-  data.tar.gz: cbb162697c348a02d4b9cd35a8f215d6b42e381ba1236ad4c5b41ccbcd55f4a8a601087c7bb4cbf3f9c63447c2406544b248465735398d66e55e981577dcbbc9
+  metadata.gz: 20f3dfd6b5e9aba7f8d2a0ef0fb9bef6ee7918aa31a8deee0bc592dcd957e44c08ca5d6a30e16064c81a5f68bc571fe8585c2e3ba453a81db0d565862e67454b
+  data.tar.gz: cdfea6f26e591ac0fb7c4bfe8874d8272615b27bfdd91daef13d1620e902fd5ba8a3c818d70a5729a89104c6ae7ac576c0f0df65717f514999d5c1c651605bd8

data/Changes.md

@@ -2,7 +2,7 @@
 
 [Sidekiq Changes](https://github.com/sidekiq/sidekiq/blob/main/Changes.md) | [Sidekiq Pro Changes](https://github.com/sidekiq/sidekiq/blob/main/Pro-Changes.md) | [Sidekiq Enterprise Changes](https://github.com/sidekiq/sidekiq/blob/main/Ent-Changes.md)
 
-HEAD / main
+8.0.0
 ----------
 
 - **WARNING** The underlying class name for Active Jobs has changed from `ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper` to `Sidekiq::ActiveJob::Wrapper`.
@@ -26,14 +26,25 @@ HEAD / main
 - Job tags now allow custom CSS display [#6595]
 - The Web UI's language picker now shows options in the native language
 - Remove global variable usage within the codebase
+- Colorize and adjust logging for easier reading
 - Adjust Sidekiq's default thread priority to -1 for a 50ms timeslice.
   This can help avoid TimeoutErrors when Sidekiq is overloaded. [#6543]
-- Support: Redis 7.2+, Ruby 3.2+, Rails 7.0+
+- Use `Logger#with_level`, remove Sidekiq's custom impl
+- Remove `base64` gem dependency
+- Support: (Dragonfly 1.27+, Valkey 7.2+, Redis 7.2+), Ruby 3.2+, Rails 7.0+
+
+7.3.10
+----------
+
+- Deprecate Redis :password as a String to avoid log disclosure. [#6625]
+  Use a Proc instead: `config.redis = { password: ->(username) { "password" } }`
 
 7.3.9
 ----------
 
 - Only require activejob if necessary [#6584]
+  You might get `uninitialized constant Sidekiq::ActiveJob` if you
+  `require 'sidekiq'` before `require 'rails'`.
 - Fix iterable job cancellation [#6589]
 - Web UI accessibility improvements [#6604]
 

data/README.md

@@ -13,7 +13,7 @@ same process. Sidekiq can be used by any Ruby application.
 Requirements
 -----------------
 
-- Redis: Redis 7.2+, Valkey 7.2+ or Dragonfly 1.13+
+- Redis: Redis 7.2+, Valkey 7.2+ or Dragonfly 1.27+
 - Ruby: MRI 3.2+ or JRuby 9.4+.
 
 Sidekiq 8.0 supports Rails and Active Job 7.0+.

data/lib/sidekiq/job_logger.rb

@@ -26,16 +26,16 @@ module Sidekiq
       # If we're using a wrapper class, like ActiveJob, use the "wrapped"
       # attribute to expose the underlying thing.
       h = {
-        class: job_hash["display_class"] || job_hash["wrapped"] || job_hash["class"],
-        jid: job_hash["jid"]
+        jid: job_hash["jid"],
+        class: job_hash["display_class"] || job_hash["wrapped"] || job_hash["class"]
       }
       h[:bid] = job_hash["bid"] if job_hash.has_key?("bid")
       h[:tags] = job_hash["tags"] if job_hash.has_key?("tags")
 
       Thread.current[:sidekiq_context] = h
       level = job_hash["log_level"]
-      if level && @logger.respond_to?(:log_at)
-        @logger.log_at(level, &block)
+      if level
+        @logger.with_level(level, &block)
       else
         yield
       end

data/lib/sidekiq/logger.rb

@@ -22,88 +22,41 @@ module Sidekiq
     end
   end
 
-  module LoggingUtils
-    LEVELS = {
-      "debug" => 0,
-      "info" => 1,
-      "warn" => 2,
-      "error" => 3,
-      "fatal" => 4
-    }
-    LEVELS.default_proc = proc do |_, level|
-      puts("Invalid log level: #{level.inspect}")
-      nil
-    end
-
-    LEVELS.each do |level, numeric_level|
-      define_method(:"#{level}?") do
-        local_level.nil? ? super() : local_level <= numeric_level
-      end
-    end
-
-    def local_level
-      Thread.current[:sidekiq_log_level]
-    end
-
-    def local_level=(level)
-      case level
-      when Integer
-        Thread.current[:sidekiq_log_level] = level
-      when Symbol, String
-        Thread.current[:sidekiq_log_level] = LEVELS[level.to_s]
-      when nil
-        Thread.current[:sidekiq_log_level] = nil
-      else
-        raise ArgumentError, "Invalid log level: #{level.inspect}"
-      end
-    end
-
-    def level
-      local_level || super
-    end
-
-    # Change the thread-local level for the duration of the given block.
-    def log_at(level)
-      old_local_level = local_level
-      self.local_level = level
-      yield
-    ensure
-      self.local_level = old_local_level
-    end
-  end
-
   class Logger < ::Logger
-    include LoggingUtils
-
     module Formatters
+      COLORS = {
+        "DEBUG" => "\e[1;32mDEBUG\e[0m", # green
+        "INFO" => "\e[1;34mINFO \e[0m", # blue
+        "WARN" => "\e[1;33mWARN \e[0m", # yellow
+        "ERROR" => "\e[1;31mERROR\e[0m", # red
+        "FATAL" => "\e[1;35mFATAL\e[0m" # pink
+      }
       class Base < ::Logger::Formatter
         def tid
           Thread.current["sidekiq_tid"] ||= (Thread.current.object_id ^ ::Process.pid).to_s(36)
         end
 
         def format_context(ctxt = Sidekiq::Context.current)
-          if ctxt.size > 0
-            ctxt.map { |k, v|
-              case v
-              when Array
-                "#{k}=#{v.join(",")}"
-              else
-                "#{k}=#{v}"
-              end
-            }.join(" ")
-          end
+          (ctxt.size == 0) ? "" : " #{ctxt.map { |k, v|
+            case v
+            when Array
+              "#{k}=#{v.join(",")}"
+            else
+              "#{k}=#{v}"
+            end
+          }.join(" ")}"
         end
       end
 
       class Pretty < Base
         def call(severity, time, program_name, message)
-          "#{time.utc.iso8601(3)} pid=#{::Process.pid} tid=#{tid} #{format_context} #{severity}: #{message}\n"
+          "#{Formatters::COLORS[severity]} #{time.utc.iso8601(3)} pid=#{::Process.pid} tid=#{tid}#{format_context}: #{message}\n"
         end
       end
 
       class WithoutTimestamp < Pretty
         def call(severity, time, program_name, message)
-          "pid=#{::Process.pid} tid=#{tid} #{format_context} #{severity}: #{message}\n"
+          "#{Formatters::COLORS[severity]} pid=#{::Process.pid} tid=#{tid} #{format_context}: #{message}\n"
         end
       end
 

data/lib/sidekiq/metrics/shared.rb

@@ -85,15 +85,15 @@ module Sidekiq
       end
 
       def fetch(conn, now = Time.now)
-        window = now.utc.strftime("%d-%H:%-M")
-        key = "#{@klass}-#{window}"
+        window = now.utc.strftime("%-d-%-H:%-M")
+        key = "h|#{@klass}-#{window}"
         conn.bitfield_ro(key, *FETCH)
       end
 
       def persist(conn, now = Time.now)
         buckets, @buckets = @buckets, []
-        window = now.utc.strftime("%d-%H:%-M")
-        key = "#{@klass}-#{window}"
+        window = now.utc.strftime("%-d-%-H:%-M")
+        key = "h|#{@klass}-#{window}"
         cmd = [key, "OVERFLOW", "SAT"]
         buckets.each_with_index do |counter, idx|
           val = counter.value

data/lib/sidekiq/redis_connection.rb

@@ -10,6 +10,8 @@ module Sidekiq
       def create(options = {})
         symbolized_options = deep_symbolize_keys(options)
         symbolized_options[:url] ||= determine_redis_provider
+        symbolized_options[:password] = wrap(symbolized_options[:password]) if symbolized_options.key?(:password)
+        symbolized_options[:sentinel_password] = wrap(symbolized_options[:sentinel_password]) if symbolized_options.key?(:sentinel_password)
 
         logger = symbolized_options.delete(:logger)
         logger&.info { "Sidekiq #{Sidekiq::VERSION} connecting to Redis with options #{scrub(symbolized_options)}" }
@@ -38,6 +40,15 @@ module Sidekiq
 
       private
 
+      # Wrap hard-coded passwords in a Proc to avoid logging the value
+      def wrap(pwd)
+        if pwd.is_a?(String)
+          ->(username) { pwd }
+        else
+          pwd
+        end
+      end
+
       def deep_symbolize_keys(object)
         case object
         when Hash
@@ -57,14 +68,14 @@ module Sidekiq
         # Deep clone so we can muck with these options all we want and exclude
         # params from dump-and-load that may contain objects that Marshal is
         # unable to safely dump.
-        keys = options.keys - [:logger, :ssl_params]
+        keys = options.keys - [:logger, :ssl_params, :password, :sentinel_password]
         scrubbed_options = Marshal.load(Marshal.dump(options.slice(*keys)))
         if scrubbed_options[:url] && (uri = URI.parse(scrubbed_options[:url])) && uri.password
           uri.password = redacted
           scrubbed_options[:url] = uri.to_s
         end
-        scrubbed_options[:password] = redacted if scrubbed_options[:password]
-        scrubbed_options[:sentinel_password] = redacted if scrubbed_options[:sentinel_password]
+        scrubbed_options[:password] = redacted if options.key?(:password)
+        scrubbed_options[:sentinel_password] = redacted if options.key?(:sentinel_password)
         scrubbed_options[:sentinels]&.each do |sentinel|
           if sentinel.is_a?(String)
             if (uri = URI(sentinel)) && uri.password

data/lib/sidekiq/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Sidekiq
-  VERSION = "8.0.0.beta2"
+  VERSION = "8.0.0"
   MAJOR = 8
 
   def self.gem_version

data/lib/sidekiq/web/application.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "base64"
 require "sidekiq/paginator"
 require "sidekiq/web/helpers"
 
@@ -50,7 +49,7 @@ module Sidekiq
       end
 
       get "/" do
-        @redis_info = redis_info.select { |k, v| REDIS_KEYS.include? k }
+        @redis_info = redis_info.slice(*REDIS_KEYS)
         days = (url_params("days") || 30).to_i
         return halt(401) if days < 1 || days > 180
 
@@ -327,7 +326,7 @@ module Sidekiq
 
       get "/stats" do
         sidekiq_stats = Sidekiq::Stats.new
-        redis_stats = redis_info.select { |k, v| REDIS_KEYS.include? k }
+        redis_stats = redis_info.slice(*REDIS_KEYS)
         json(
           sidekiq: {
             processed: sidekiq_stats.processed,
@@ -368,7 +367,8 @@ module Sidekiq
             {"Accept" => "application/vnd.firefox-profiler+json;version=1.0",
              "User-Agent" => "Sidekiq #{Sidekiq::VERSION} job profiler"})
           # https://raw.githubusercontent.com/firefox-devtools/profiler-server/master/tools/decode_jwt_payload.py
-          sid = Sidekiq.load_json(Base64.decode64(resp.body.split(".")[1]))["profileToken"]
+          rawjson = resp.body.split(".")[1].unpack1("m")
+          sid = Sidekiq.load_json(rawjson)["profileToken"]
           Sidekiq.redis { |c| c.hset(key, "sid", sid) }
         end
         url = config[:profile_view_url] % sid

data/lib/sidekiq/web/config.rb

@@ -14,7 +14,8 @@ module Sidekiq
     #
     # This should go in your `config/routes.rb` or similar. It
     # does not belong in your initializer since Web should not be
-    # loaded in some processes (like an actual Sidekiq process)
+    # loaded in some processes (like an actual Sidekiq process).
+    # See `examples/webui-ext` for a sample web extension.
     class Config
       extend Forwardable
 

data/lib/sidekiq/web.rb

@@ -63,8 +63,7 @@ module Sidekiq
       def use(*args, &block) = @@config.middlewares << [args, block]
 
       def register(*args, **kw, &block)
-        # TODO
-        puts "`Sidekiq::Web.register` is deprecated, use `Sidekiq::Web.configure {|cfg| cfg.register(...) }`"
+        Sidekiq.logger.warn { "`Sidekiq::Web.register` is deprecated, use `Sidekiq::Web.configure {|cfg| cfg.register(...) }`" }
         @@config.register(*args, **kw, &block)
       end
     end

data/sidekiq.gemspec

@@ -27,6 +27,5 @@ Gem::Specification.new do |gem|
   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"
-  gem.add_dependency "base64"
+  gem.add_dependency "logger", ">= 1.6.2"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq
 version: !ruby/object:Gem::Version
-  version: 8.0.0.beta2
+  version: 8.0.0
 platform: ruby
 authors:
 - Mike Perham
 bindir: bin
 cert_chain: []
-date: 2025-02-26 00:00:00.000000000 Z
+date: 2025-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis-client
@@ -71,28 +71,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.6.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: base64
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.6.2
 description: Simple, efficient background processing for Ruby.
 email:
 - info@contribsys.com