sidekiq 7.3.8 → 7.3.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec7c9a4bea6982200a069a9a2f7c134811ccbf1aaceb56a8cb708893cab6e301
-  data.tar.gz: e59152e78eccbf714e485a7772e3a62681974abd114ebd608432c5ab93f55211
+  metadata.gz: 8c8347f3f2281d531c67cac5b8d00a38baa08c2fa144d111e0d380c9520e1d88
+  data.tar.gz: 70f09f133c258fa1239d98f294e66ba9fba21dbb55573a76510d128b795b0180
 SHA512:
-  metadata.gz: 5aac99a9f1a385baaac0204c2799b9821c2146ca045eb2cdabc92ac54da8f20ae6239183eed5256bd96e8c45a8538596aa13714f5dc8fb4943565ec86df16dc9
-  data.tar.gz: 7ae68faedfc60d2354335709e36b51d9217bead4bfcf2e2d9d60a4b321cfcafdf931680f298bae061ac412e26d898b82dc7c7f15549909834f93251f7745bb13
+  metadata.gz: 308446f60faf0b6c180c62562f8e787e68f7654d9339e4c43b0219013b952a945e728117c8b8121d57a91fc1cb71eeecb560779f29579801d76f9a33fdaac963
+  data.tar.gz: '0392876234c063d8d9a2ecc10c6e2a79bd8dfea10fa4d547fb9046c134917d6aa958b9c7946c95797c6dc75ebfc694c52cd8e30602a5598d093e75281ce0f03f'

data/Changes.md

@@ -2,6 +2,21 @@
 
 [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)
 
+7.3.10
+----------
+
+- Allow Redis :password as a Proc [#6625]
+  `config.redis = { password: ->(username) { "password" } }`
+- Bump required redis-client version to 0.23
+- Lock dependencies to known good major versions
+
+7.3.9
+----------
+
+- Only require activejob if necessary [#6584]
+- Fix iterable job cancellation [#6589]
+- Web UI accessibility improvements [#6604]
+
 7.3.8
 ----------
 

data/lib/active_job/queue_adapters/sidekiq_adapter.rb

@@ -1,18 +1,5 @@
 # frozen_string_literal: true
 
-module Sidekiq
-  module ActiveJob
-    # @api private
-    class Wrapper
-      include Sidekiq::Job
-
-      def perform(job_data)
-        ::ActiveJob::Base.execute(job_data.merge("provider_job_id" => jid))
-      end
-    end
-  end
-end
-
 module ActiveJob
   module QueueAdapters
     # Explicitly remove the implementation existing in older rails'.

data/lib/sidekiq/fetch.rb

@@ -7,6 +7,7 @@ require "sidekiq/capsule"
 module Sidekiq # :nodoc:
   class BasicFetch
     include Sidekiq::Component
+
     # We want the fetch operation to timeout every few seconds so the thread
     # can check if the process is shutting down.
     TIMEOUT = 2

data/lib/sidekiq/job/iterable.rb

@@ -200,7 +200,7 @@ module Sidekiq
           if ::Process.clock_gettime(::Process::CLOCK_MONOTONIC) - state_flushed_at >= STATE_FLUSH_INTERVAL || is_interrupted
             _, _, cancelled = flush_state
             state_flushed_at = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
-            if cancelled == 1
+            if cancelled
               @_cancelled = true
               logger.info { "Job cancelled" }
               return true

data/lib/sidekiq/middleware/i18n.rb

@@ -11,6 +11,7 @@ module Sidekiq::Middleware::I18n
   # to be sent to Sidekiq.
   class Client
     include Sidekiq::ClientMiddleware
+
     def call(_jobclass, job, _queue, _redis)
       job["locale"] ||= I18n.locale
       yield
@@ -20,6 +21,7 @@ module Sidekiq::Middleware::I18n
   # Pull the msg locale out and set the current thread to use it.
   class Server
     include Sidekiq::ServerMiddleware
+
     def call(_jobclass, job, _queue, &block)
       I18n.with_locale(job.fetch("locale", I18n.default_locale), &block)
     end

data/lib/sidekiq/rails.rb

@@ -4,6 +4,17 @@ require "sidekiq/job"
 require "rails"
 
 module Sidekiq
+  module ActiveJob
+    # @api private
+    class Wrapper
+      include Sidekiq::Job
+
+      def perform(job_data)
+        ::ActiveJob::Base.execute(job_data.merge("provider_job_id" => jid))
+      end
+    end
+  end
+
   class Rails < ::Rails::Engine
     class Reloader
       def initialize(app = ::Rails.application)
@@ -38,9 +49,8 @@ module Sidekiq
     #     end
     #   end
     initializer "sidekiq.active_job_integration" do
-      require "active_job/queue_adapters/sidekiq_adapter"
-
       ActiveSupport.on_load(:active_job) do
+        require_relative "../active_job/queue_adapters/sidekiq_adapter"
         include ::Sidekiq::Job::Options unless respond_to?(:sidekiq_options)
       end
     end

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/ring_buffer.rb

@@ -6,6 +6,7 @@ module Sidekiq
   class RingBuffer
     include Enumerable
     extend Forwardable
+
     def_delegators :@buf, :[], :each, :size
 
     def initialize(size, default = 0)

data/lib/sidekiq/transaction_aware_client.rb

@@ -7,6 +7,12 @@ module Sidekiq
   class TransactionAwareClient
     def initialize(pool: nil, config: nil)
       @redis_client = Client.new(pool: pool, config: config)
+      @transaction_backend =
+        if ActiveRecord.version >= Gem::Version.new("7.2")
+          ActiveRecord.method(:after_all_transactions_commit)
+        else
+          AfterCommitEverywhere.method(:after_commit)
+        end
     end
 
     def batching?
@@ -20,7 +26,7 @@ module Sidekiq
       # pre-allocate the JID so we can return it immediately and
       # save it to the database as part of the transaction.
       item["jid"] ||= SecureRandom.hex(12)
-      AfterCommitEverywhere.after_commit { @redis_client.push(item) }
+      @transaction_backend.call { @redis_client.push(item) }
       item["jid"]
     end
 
@@ -38,10 +44,12 @@ end
 # Use `Sidekiq.transactional_push!` in your sidekiq.rb initializer
 module Sidekiq
   def self.transactional_push!
-    begin
-      require "after_commit_everywhere"
-    rescue LoadError
-      raise %q(You need to add `gem "after_commit_everywhere"` to your Gemfile to use Sidekiq's transactional client)
+    if ActiveRecord.version < Gem::Version.new("7.2")
+      begin
+        require "after_commit_everywhere"
+      rescue LoadError
+        raise %q(You need ActiveRecord >= 7.2 or to add `gem "after_commit_everywhere"` to your Gemfile to use Sidekiq's transactional client)
+      end
     end
 
     Sidekiq.default_job_options["client_class"] = Sidekiq::TransactionAwareClient

data/lib/sidekiq/version.rb

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

data/lib/sidekiq/web/application.rb

@@ -55,7 +55,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 = (params["days"] || 30).to_i
       return halt(401) if days < 1 || days > 180
 
@@ -328,7 +328,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,

data/lib/sidekiq/web/helpers.rb

@@ -347,7 +347,7 @@ module Sidekiq
       elsif rss_kb < 10_000_000
         "#{number_with_delimiter((rss_kb / 1024.0).to_i)} MB"
       else
-        "#{number_with_delimiter((rss_kb / (1024.0 * 1024.0)), precision: 1)} GB"
+        "#{number_with_delimiter(rss_kb / (1024.0 * 1024.0), precision: 1)} GB"
       end
     end
 

data/sidekiq.gemspec

@@ -23,9 +23,9 @@ Gem::Specification.new do |gem|
     "rubygems_mfa_required" => "true"
   }
 
-  gem.add_dependency "redis-client", ">= 0.22.2"
-  gem.add_dependency "connection_pool", ">= 2.3.0"
-  gem.add_dependency "rack", ">= 2.2.4"
+  gem.add_dependency "redis-client", ">= 0.23.0", "<1"
+  gem.add_dependency "connection_pool", ">= 2.3.0", "<3"
+  gem.add_dependency "rack", ">= 2.2.4", "<3.3"
   gem.add_dependency "logger"
   gem.add_dependency "base64"
 end

data/web/assets/javascripts/dashboard-charts.js

@@ -83,6 +83,8 @@ class RealtimeChart extends DashboardChart {
     this.chart.data.datasets[1].data.push(failed);
     this.chart.update();
 
+    updateScreenReaderDashboardValues(processed, failed);
+
     updateStatsSummary(this.stats.sidekiq);
     updateRedisStats(this.stats.redis);
     updateFooterUTCTime(this.stats.server_utc_time);

data/web/assets/javascripts/dashboard.js

@@ -36,6 +36,12 @@ var ready = (callback) => {
   else document.addEventListener("DOMContentLoaded", callback);
 }
 
+var updateScreenReaderDashboardValues = function(processed, failed) {
+  let lastDashboardUpdateSpan = document.getElementById("sr-last-dashboard-update");
+  var updateText = document.getElementById("sr-last-dashboard-update-template").innerText;
+  lastDashboardUpdateSpan.innerText = updateText.replace("PROCESSED_COUNT", processed).replace("FAILED_COUNT", failed);
+}
+
 ready(() => {
   var sldr = document.getElementById('sldr');
   if (typeof localStorage.sidekiqTimeInterval !== 'undefined') {

data/web/locales/en.yml

@@ -34,6 +34,8 @@ en:
   Jobs: Jobs
   Kill: Kill
   KillAll: Kill All
+  Language: Language
+  LastDashboardUpdateTemplateLiteral: "Latest poll: Processed: PROCESSED_COUNT. Failed: FAILED_COUNT."
   LastRetry: Last Retry
   Latency: Latency
   LivePoll: Live Poll
@@ -53,6 +55,7 @@ en:
   PeakMemoryUsage: Peak Memory Usage
   Plugins: Plugins
   PollingInterval: Polling interval
+  PollingIntervalMilliseconds: Polling interval milliseconds
   Process: Process
   Processed: Processed
   Processes: Processes

data/web/views/_footer.erb

@@ -17,8 +17,7 @@
           <li>
             <form id="locale-form" class="form-inline" action="<%= root_path %>change_locale" method="post">
               <%= csrf_tag %>
-              <label class="sr-only" for="locale">Language</label>
-              <select id="locale-select" class="form-control" name="locale">
+              <select id="locale-select" class="form-control" aria-label="<%= t("Language") %>" name="locale">
                 <% available_locales.each do |locale_option| %>
                   <% if locale_option == locale %>
                     <option selected value="<%= locale_option %>"><%= locale_option %></option>

data/web/views/dashboard.erb

@@ -11,11 +11,14 @@
     <span class="interval-slider-label"><%= t('PollingInterval') %>:</span>
     <span id="sldr-text" class="current-interval">5 s</span>
     <br/>
-    <input id="sldr" type="range" min="2000" max="20000" step="1000" value="5000"/>
+    <input id="sldr" aria-label="<%= t("PollingIntervalMilliseconds") %>" type="range" min="2000" max="20000" step="1000" value="5000"/>
   </div>
 </div>
 
 <div class="row chart">
+  <span id="sr-last-dashboard-update-template" hidden="hidden"><%= t("LastDashboardUpdateTemplateLiteral") %></span>
+  <span id="sr-last-dashboard-update" class="sr-only" role="status"></span>
+
   <canvas id="realtime-chart">
     <%= to_json({
       processedLabel: t('Processed'),

data/web/views/queue.erb

@@ -15,7 +15,7 @@
       <th><%= t('Job') %></th>
       <th><%= t('Arguments') %></th>
       <th><%= t('Context') %></th>
-      <th></th>
+      <th><%= t('Actions') %></th>
     </thead>
     <% @jobs.each_with_index do |job, index| %>
       <tr title="<%= job.jid %>">

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq
 version: !ruby/object:Gem::Version
-  version: 7.3.8
+  version: 7.3.10
 platform: ruby
 authors:
 - Mike Perham
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-20 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis-client
@@ -16,14 +15,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.22.2
+        version: 0.23.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.22.2
+        version: 0.23.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: connection_pool
   requirement: !ruby/object:Gem::Requirement
@@ -31,6 +36,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.3.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -38,6 +46,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.3.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -45,6 +56,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.2.4
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -52,6 +66,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.2.4
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: logger
   requirement: !ruby/object:Gem::Requirement
@@ -231,7 +248,6 @@ metadata:
   changelog_uri: https://github.com/sidekiq/sidekiq/blob/main/Changes.md
   source_code_uri: https://github.com/sidekiq/sidekiq
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -246,8 +262,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Simple, efficient background processing for Ruby
 test_files: []