sidekiq 7.3.3 → 7.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f278eab88087d46198fc13a2f5019f1d7e399810ecfebeba5044ff9bfd25e271
-  data.tar.gz: fb790ae54375a60b30b9eaf6676291a8f42c5a17a9f9487c6f018447810bb46f
+  metadata.gz: ada259b22664fbbb740c3d28fa06578cb6fc00a42590ea459a1f2395f8e38a92
+  data.tar.gz: 0636466a99e8a0df4d955b0928d76b504df74bba4e3ab13a2d08237ccd57b162
 SHA512:
-  metadata.gz: 676ca234e7ce2218a72266f793a686c4fe5c944535ad5a76d7b7c263190a1eccb9341c06fbff0ab2e11acd4875c5dee74d959b9d1019687904b8cb53a84a6267
-  data.tar.gz: ab7f1f5acbfc9064d93d8881354bd5a572a96f45f125c1074cf50212f23a1d60df8ac196843a45963064009f41e074eb322a50acb3680fd62ee727fcae36c14f
+  metadata.gz: 209f76b8ceebdb2cac83d22aab78873dad373a9ba488e7d320972e8ced4d3ac71454ef6669db321727ce3e4a85fdc5744005ff64d1a0f4cd48d9a4231bddf384
+  data.tar.gz: df094fd4baa169249e92309814d67d0fb5a53b5da4990c0510f5ae1d96e07541356a3014f75b8b79a97f0a91b03b92b576331422c54f36bb2c4943f2f0f87b08

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.5
+----------
+
+- Reimplement `retry_all` and `kill_all` API methods to use ZPOPMIN,
+  approximately 30-60% faster. [#6481]
+- Add preload testing binary at `examples/testing/sidekiq_boot` to verify your Rails app boots correctly with Sidekiq Enterprise's app preloading.
+- Fix circular require with ActiveJob adapter [#6477]
+- Fix potential race condition leading to incorrect serialized values for CurrentAttributes [#6475]
+- Restore missing elapsed time when default job logging is disabled
+
+7.3.4
+----------
+
+- Fix FrozenError when starting Sidekiq [#6470]
+
 7.3.3
 ----------
 

data/lib/active_job/queue_adapters/sidekiq_adapter.rb

@@ -16,7 +16,7 @@ end
 module ActiveJob
   module QueueAdapters
     # Explicitly remove the implementation existing in older rails'.
-    remove_const(:SidekiqAdapter) if defined?(:SidekiqAdapter)
+    remove_const(:SidekiqAdapter) if defined?("::#{name}::SidekiqAdapter")
 
     # Sidekiq adapter for Active Job
     #

data/lib/sidekiq/api.rb

@@ -668,6 +668,41 @@ module Sidekiq
       end
     end
 
+    def pop_each
+      Sidekiq.redis do |c|
+        size.times do
+          data, score = c.zpopmin(name, 1)&.first
+          break unless data
+          yield data, score
+        end
+      end
+    end
+
+    def retry_all
+      c = Sidekiq::Client.new
+      pop_each do |msg, _|
+        job = Sidekiq.load_json(msg)
+        # Manual retries should not count against the retry limit.
+        job["retry_count"] -= 1 if job["retry_count"]
+        c.push(job)
+      end
+    end
+
+    # Move all jobs from this Set to the Dead Set.
+    # See DeadSet#kill
+    def kill_all(notify_failure: false, ex: nil)
+      ds = DeadSet.new
+      opts = {notify_failure: notify_failure, ex: ex, trim: false}
+
+      begin
+        pop_each do |msg, _|
+          ds.kill(msg, opts)
+        end
+      ensure
+        ds.trim
+      end
+    end
+
     def each
       initial_size = @_size
       offset_size = 0
@@ -765,10 +800,6 @@ module Sidekiq
 
   ##
   # The set of scheduled jobs within Sidekiq.
-  # Based on this, you can search/filter for jobs.  Here's an
-  # example where I'm selecting jobs based on some complex logic
-  # and deleting them from the scheduled set.
-  #
   # See the API wiki page for usage notes and examples.
   #
   class ScheduledSet < JobSet
@@ -779,26 +810,12 @@ module Sidekiq
 
   ##
   # The set of retries within Sidekiq.
-  # Based on this, you can search/filter for jobs.  Here's an
-  # example where I'm selecting all jobs of a certain type
-  # and deleting them from the retry queue.
-  #
   # See the API wiki page for usage notes and examples.
   #
   class RetrySet < JobSet
     def initialize
       super("retry")
     end
-
-    # Enqueues all jobs pending within the retry set.
-    def retry_all
-      each(&:retry) while size > 0
-    end
-
-    # Kills all jobs pending within the retry set.
-    def kill_all
-      each(&:kill) while size > 0
-    end
   end
 
   ##
@@ -811,20 +828,31 @@ module Sidekiq
       super("dead")
     end
 
+    # Trim dead jobs which are over our storage limits
+    def trim
+      hash = Sidekiq.default_configuration
+      now = Time.now.to_f
+      Sidekiq.redis do |conn|
+        conn.multi do |transaction|
+          transaction.zremrangebyscore(name, "-inf", now - hash[:dead_timeout_in_seconds])
+          transaction.zremrangebyrank(name, 0, - hash[:dead_max_jobs])
+        end
+      end
+    end
+
     # Add the given job to the Dead set.
     # @param message [String] the job data as JSON
-    # @option opts [Boolean] :notify_failure  (true) Whether death handlers should be called
+    # @option opts [Boolean] :notify_failure (true) Whether death handlers should be called
+    # @option opts [Boolean] :trim (true) Whether Sidekiq should trim the structure to keep it within configuration
     # @option opts [Exception] :ex (RuntimeError) An exception to pass to the death handlers
     def kill(message, opts = {})
       now = Time.now.to_f
       Sidekiq.redis do |conn|
-        conn.multi do |transaction|
-          transaction.zadd(name, now.to_s, message)
-          transaction.zremrangebyscore(name, "-inf", now - Sidekiq::Config::DEFAULTS[:dead_timeout_in_seconds])
-          transaction.zremrangebyrank(name, 0, - Sidekiq::Config::DEFAULTS[:dead_max_jobs])
-        end
+        conn.zadd(name, now.to_s, message)
       end
 
+      trim if opts[:trim] != false
+
       if opts[:notify_failure] != false
         job = Sidekiq.load_json(message)
         if opts[:ex]
@@ -839,11 +867,6 @@ module Sidekiq
       end
       true
     end
-
-    # Enqueue all dead jobs
-    def retry_all
-      each(&:retry) while size > 0
-    end
   end
 
   ##

data/lib/sidekiq/job_logger.rb

@@ -5,31 +5,21 @@ module Sidekiq
     def initialize(config)
       @config = config
       @logger = @config.logger
-    end
-
-    # If true we won't do any job logging out of the box.
-    # The user is responsible for any logging.
-    def skip_default_logging?
-      @config[:skip_default_job_logging]
+      @skip = !!@config[:skip_default_job_logging]
     end
 
     def call(item, queue)
-      return yield if skip_default_logging?
-
-      begin
-        start = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
-        @logger.info("start")
+      start = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
+      @logger.info { "start" } unless @skip
 
-        yield
-
-        Sidekiq::Context.add(:elapsed, elapsed(start))
-        @logger.info("done")
-      rescue Exception
-        Sidekiq::Context.add(:elapsed, elapsed(start))
-        @logger.info("fail")
+      yield
 
-        raise
-      end
+      Sidekiq::Context.add(:elapsed, elapsed(start))
+      @logger.info { "done" } unless @skip
+    rescue Exception
+      Sidekiq::Context.add(:elapsed, elapsed(start))
+      @logger.info { "fail" } unless @skip
+      raise
     end
 
     def prepare(job_hash, &block)

data/lib/sidekiq/launcher.rb

@@ -36,8 +36,8 @@ module Sidekiq
     # has a heartbeat thread, caller can use `async_beat: false`
     # and instead have thread call Launcher#heartbeat every N seconds.
     def run(async_beat: true)
-      Sidekiq.freeze!
       logger.debug { @config.merge!({}) }
+      Sidekiq.freeze!
       @thread = safe_thread("heartbeat", &method(:start_heartbeat)) if async_beat
       @poller.start
       @managers.each(&:start)

data/lib/sidekiq/middleware/current_attributes.rb

@@ -33,11 +33,26 @@ module Sidekiq
             attrs = strklass.constantize.attributes
             # Retries can push the job N times, we don't
             # want retries to reset cattr. #5692, #5090
-            job[key] = attrs if attrs.any?
+            if attrs.any?
+              # Older rails has a bug that `CurrentAttributes#attributes` always returns
+              # the same hash instance. We need to dup it to avoid being accidentally mutated.
+              job[key] = if returns_same_object?
+                attrs.dup
+              else
+                attrs
+              end
+            end
           end
         end
         yield
       end
+
+      private
+
+      def returns_same_object?
+        ActiveSupport::VERSION::MAJOR < 8 ||
+          (ActiveSupport::VERSION::MAJOR == 8 && ActiveSupport::VERSION::MINOR == 0)
+      end
     end
 
     class Load

data/lib/sidekiq/rails.rb

@@ -3,12 +3,6 @@
 require "sidekiq/job"
 require "rails"
 
-begin
-  require "active_job"
-  require "active_job/queue_adapters/sidekiq_adapter"
-rescue LoadError
-end
-
 module Sidekiq
   class Rails < ::Rails::Engine
     class Reloader
@@ -45,6 +39,8 @@ module Sidekiq
     #   end
     initializer "sidekiq.active_job_integration" do
       ActiveSupport.on_load(:active_job) do
+        require "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.3"
+  VERSION = "7.3.5"
   MAJOR = 7
 
   def self.gem_version

data/web/assets/stylesheets/application.css

@@ -650,6 +650,11 @@ div.interval-slider input {
   .redis-url {
     max-width: 160px;
   }
+
+  .navbar-fixed-bottom .nav {
+    margin-left: -15px;
+    margin-right: -15px;
+  }
 }
 
 @media (min-width: 992px) {

data/web/locales/it.yml

@@ -6,44 +6,60 @@ it:
   AreYouSureDeleteJob: Sei sicuro di voler cancellare questo lavoro?
   AreYouSureDeleteQueue: Sei sicuro di voler cancellare la coda %{queue}?
   Arguments: Argomenti
+  BackToApp: Torna all'App
   Busy: Occupato
   Class: Classe
   Connections: Connessioni
+  CreatedAt: Creato il
   CurrentMessagesInQueue: Messaggi in <span class='title'>%{queue}</span>
   Dashboard: Dashboard
   Dead: Arrestato
   DeadJobs: Lavori arrestati
   Delete: Cancella
   DeleteAll: Cancella tutti
+  Deploy: Distribuire
   Enqueued: In coda
   Error: Errore
   ErrorBacktrace: Backtrace dell'errore
   ErrorClass: Classe dell'errore
   ErrorMessage: Messaggio di errore
+  ExecutionTime: Tempo di esecuzione
   Extras: Extra
   Failed: Fallito
   Failures: Fallimenti
+  Failure: Fallimento
   GoBack: ← Indietro
   History: Storia
   Job: Lavoro
   Jobs: Lavori
   Kill: Uccidere
+  KillAll: Uccidere tutti
   LastRetry: Ultimo tentativo
+  Latency: Latenza
   LivePoll: Live poll
   MemoryUsage: Memoria utilizzata
+  Name: Nome
   Namespace: Namespace
   NextRetry: Prossimo tentativo
   NoDeadJobsFound: Non ci sono lavori arrestati
   NoRetriesFound: Non sono stati trovati nuovi tentativi
   NoScheduledFound: Non ci sono lavori pianificati
+  NotYetEnqueued: Non ancora in coda
   OneMonth: 1 mese
   OneWeek: 1 settimana
   OriginallyFailed: Primo fallimento
+  Pause: Metti in pausa
+  Paused: In pausa
   PeakMemoryUsage: Memoria utilizzata (max.)
+  Plugins: Plugins
+  PollingInterval: Intervallo di polling
+  Process: Processo
   Processed: Processato
   Processes: Processi
   Queue: Coda
   Queues: Code
+  Quiet: Silenzia
+  QuietAll: Silenzia Tutti
   Realtime: Tempo reale
   Retries: Nuovi tentativi
   RetryAll: Riprova tutti
@@ -51,19 +67,34 @@ it:
   RetryNow: Riprova
   Scheduled: Pianificato
   ScheduledJobs: Lavori pianificati
+  Seconds: Secondi
   ShowAll: Mostra tutti
   SixMonths: 6 mesi
   Size: Dimensione
   Started: Iniziato
   Status: Stato
+  Stop: Ferma
+  StopAll: Ferma Tutti
   StopPolling: Ferma il polling
+  Success: Successo
+  Summary: Riepilogo
   Thread: Thread
-  Threads: Thread
+  Threads: Threads
   ThreeMonths: 3 mesi
   Time: Ora
+  Unpause: Riattiva
   Uptime: Uptime (giorni)
+  Utilization: Utilizzo
   Version: Versione
   When: Quando
   Worker: Lavoratore
   active: attivo
   idle: inattivo
+  Metrics: Metriche
+  NoDataFound: Nessun dato trovato
+  TotalExecutionTime: Tempo totale di esecuzione
+  AvgExecutionTime: Tempo medio di esecuzione
+  Context: Contesto
+  NoJobMetricsFound: Metriche recenti di lavoro non trovate
+  Filter: Filtro
+  AnyJobContent: Qualsiasi contenuto di lavoro

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq
 version: !ruby/object:Gem::Version
-  version: 7.3.3
+  version: 7.3.5
 platform: ruby
 authors:
 - Mike Perham
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-23 00:00:00.000000000 Z
+date: 2024-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis-client
@@ -232,7 +232,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: Simple, efficient background processing for Ruby