sidekiq 7.3.6 → 7.3.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c9bd0a03b27535a34a0525397e84c429a9332e6754dba43c088558ab8f362e9
-  data.tar.gz: '08fee2db2d83996d1df6f78e7eb9a226cb98d951cba336dd422771f9127cf95a'
+  metadata.gz: dccc402e8f4e309a47a2adb62418fa29989012e8c94f34aa11200b098dc375f2
+  data.tar.gz: 71b64a582d5971b045d60bae38dc26da265b60ff9a099ca3b2f9c7df9035e805
 SHA512:
-  metadata.gz: f4876eb7594d0c87e4dba08a752dbcb65bbf45ae8213fb9b9ee6a1e12d7a48750c161ffe632f3b13eacfed73de3c3c73a9dc06a2548ddf7e5f6dde0f7de161bd
-  data.tar.gz: a0f485adef4ba6751114daf0d2c1d509966d530bc620e00ebf17a9c244f1eb0821ae5e8214d88d3652106d932cae7acfd2b66874647acc8c33fe6ec2e3b9d691
+  metadata.gz: d9148b613a222ca9617ceebe25bb04a5d086edacdafad4a426b6232662d3b583db462dc5e0491297f7859037c5166bcb541bddcd3949f6d3b5a1c2e3fc572b65
+  data.tar.gz: 93a797cefd1a68adb236c7538c28571467c328d6965af0bc5ce505a1391d6f5b6e2ae2c87b42110e837dcfa8d788aff55309806bbb1bcd181e205c3bc66adc29

data/Changes.md

@@ -2,6 +2,27 @@
 
 [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.9
+----------
+
+- Only require activejob if necessary [#6584]
+- Fix iterable job cancellation [#6589]
+- Web UI accessibility improvements [#6604]
+
+7.3.8
+----------
+
+- Fix dead tag links [#6554]
+- Massive Web UI performance improvement, some pages up to 15x faster [#6555]
+
+7.3.7
+----------
+
+- Backport `Sidekiq::Web.configure` for compatibility with 8.0 [#6532]
+- Backport `url_params(key)` and `route_params(key)` for compatibility with 8.0 [#6532]
+- Various fixes for UI filtering [#6508]
+- Tune `inspect` for internal S::Components to keep size managable [#6553]
+
 7.3.6
 ----------
 

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

@@ -64,5 +64,27 @@ module Sidekiq
       end
       arr.clear if oneshot # once we've fired an event, we never fire it again
     end
+
+    # When you have a large tree of components, the `inspect` output
+    # can get out of hand, especially with lots of Sidekiq::Config
+    # references everywhere. We avoid calling `inspect` on more complex
+    # state and use `to_s` instead to keep output manageable, #6553
+    def inspect
+      "#<#{self.class.name} #{
+        instance_variables.map do |name|
+          value = instance_variable_get(name)
+          case value
+          when Proc
+            "#{name}=#{value}"
+          when Sidekiq::Config
+            "#{name}=#{value}"
+          when Sidekiq::Component
+            "#{name}=#{value}"
+          else
+            "#{name}=#{value.inspect}"
+          end
+        end.join(", ")
+      }>"
+    end
   end
 end

data/lib/sidekiq/config.rb

@@ -61,6 +61,12 @@ module Sidekiq
     def_delegators :@options, :[], :[]=, :fetch, :key?, :has_key?, :merge!, :dig
     attr_reader :capsules
 
+    def inspect
+      "#<#{self.class.name} @options=#{
+        @options.except(:lifecycle_events, :reloader, :death_handlers, :error_handlers).inspect
+      }>"
+    end
+
     def to_json(*)
       Sidekiq.dump_json(@options)
     end

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

@@ -2,6 +2,12 @@
 
 module Sidekiq
   module Paginator
+    TYPE_CACHE = {
+      "dead" => "zset",
+      "retry" => "zset",
+      "schedule" => "zset"
+    }
+
     def page(key, pageidx = 1, page_size = 25, opts = nil)
       current_page = (pageidx.to_i < 1) ? 1 : pageidx.to_i
       pageidx = current_page - 1

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)
@@ -39,8 +50,7 @@ module Sidekiq
     #   end
     initializer "sidekiq.active_job_integration" do
       ActiveSupport.on_load(:active_job) do
-        require "active_job/queue_adapters/sidekiq_adapter"
-
+        require_relative "../active_job/queue_adapters/sidekiq_adapter"
         include ::Sidekiq::Job::Options unless respond_to?(:sidekiq_options)
       end
     end

data/lib/sidekiq/version.rb

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

data/lib/sidekiq/web/action.rb

@@ -27,6 +27,7 @@ module Sidekiq
       redirect current_location
     end
 
+    # deprecated, will warn in 8.0
     def params
       indifferent_hash = Hash.new { |hash, key| hash[key.to_s] if Symbol === key }
 
@@ -36,8 +37,19 @@ module Sidekiq
       indifferent_hash
     end
 
-    def route_params
-      env[WebRouter::ROUTE_PARAMS]
+    # Use like `url_params("page")` within your action blocks
+    def url_params(key)
+      request.params[key]
+    end
+
+    # Use like `route_params(:name)` within your action blocks
+    # key is required in 8.0, nil is only used for backwards compatibility
+    def route_params(key = nil)
+      if key
+        env[WebRouter::ROUTE_PARAMS][key]
+      else
+        env[WebRouter::ROUTE_PARAMS]
+      end
     end
 
     def session

data/lib/sidekiq/web/application.rb

@@ -184,7 +184,7 @@ module Sidekiq
     end
 
     post "/morgue" do
-      redirect(request.path) unless params["key"]
+      redirect(request.path) unless url_params("key")
 
       params["key"].each do |key|
         job = Sidekiq::DeadSet.new.fetch(*parse_params(key)).first
@@ -207,7 +207,7 @@ module Sidekiq
     end
 
     post "/morgue/:key" do
-      key = route_params[:key]
+      key = route_params(:key)
       halt(404) unless key
 
       job = Sidekiq::DeadSet.new.fetch(*parse_params(key)).first
@@ -217,7 +217,7 @@ module Sidekiq
     end
 
     get "/retries" do
-      x = params[:substr]
+      x = url_params("substr")
 
       if x && x != ""
         @retries = search(Sidekiq::RetrySet.new, x)

data/lib/sidekiq/web/helpers.rb

@@ -52,11 +52,11 @@ module Sidekiq
     end
 
     def strings(lang)
-      @strings ||= {}
+      @@strings ||= {}
 
       # Allow sidekiq-web extensions to add locale paths
       # so extensions can be localized
-      @strings[lang] ||= settings.locales.each_with_object({}) do |path, global|
+      @@strings[lang] ||= settings.locales.each_with_object({}) do |path, global|
         find_locale_files(lang).each do |file|
           strs = YAML.safe_load(File.read(file))
           global.merge!(strs[lang])
@@ -77,19 +77,19 @@ module Sidekiq
     end
 
     def clear_caches
-      @strings = nil
-      @locale_files = nil
-      @available_locales = nil
+      @@strings = nil
+      @@locale_files = nil
+      @@available_locales = nil
     end
 
     def locale_files
-      @locale_files ||= settings.locales.flat_map { |path|
+      @@locale_files ||= settings.locales.flat_map { |path|
         Dir["#{path}/*.yml"]
       }
     end
 
     def available_locales
-      @available_locales ||= Set.new(locale_files.map { |path| File.basename(path, ".yml") })
+      @@available_locales ||= Set.new(locale_files.map { |path| File.basename(path, ".yml") })
     end
 
     def find_locale_files(lang)
@@ -111,7 +111,7 @@ module Sidekiq
       if within.nil?
         ::Rack::Utils.escape_html(jid)
       else
-        "<a href='#{root_path}filter/#{within}?substr=#{jid}'>#{::Rack::Utils.escape_html(jid)}</a>"
+        "<a href='#{root_path}#{within}?substr=#{jid}'>#{::Rack::Utils.escape_html(jid)}</a>"
       end
     end
 
@@ -184,7 +184,8 @@ module Sidekiq
 
     # sidekiq/sidekiq#3243
     def unfiltered?
-      yield unless env["PATH_INFO"].start_with?("/filter/")
+      s = url_params("substr")
+      yield unless s && s.size > 0
     end
 
     def get_locale

data/lib/sidekiq/web.rb

@@ -50,6 +50,11 @@ module Sidekiq
     end
 
     class << self
+      # Forward compatibility with 8.0
+      def configure
+        yield self
+      end
+
       def settings
         self
       end

data/sidekiq.gemspec

@@ -27,4 +27,5 @@ Gem::Specification.new do |gem|
   gem.add_dependency "connection_pool", ">= 2.3.0"
   gem.add_dependency "rack", ">= 2.2.4"
   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/morgue.erb

@@ -3,7 +3,7 @@
   <% if @dead.size > 0 && @total_size > @count %>
     <%= erb :_paging, locals: { url: "#{root_path}morgue" } %>
   <% end %>
-  <%= filtering('dead') %>
+  <%= filtering('morgue') %>
 </div>
 
 <% if @dead.size > 0 %>
@@ -40,7 +40,7 @@
             </td>
             <td>
               <%= entry.display_class %>
-              <%= display_tags(entry, "dead") %>
+              <%= display_tags(entry, "morgue") %>
             </td>
             <td>
               <div class="args"><%= display_args(entry.display_args) %></div>

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.6
+  version: 7.3.9
 platform: ruby
 authors:
 - Mike Perham
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-20 00:00:00.000000000 Z
+date: 2025-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis-client
@@ -66,6 +65,20 @@ dependencies:
     - - ">="
       - !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'
 description: Simple, efficient background processing for Ruby.
 email:
 - info@contribsys.com
@@ -217,7 +230,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
@@ -232,8 +244,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Simple, efficient background processing for Ruby
 test_files: []