sidekiq 7.3.2 → 7.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce4653de61d5b923ce7556490e95cf6918dd1c94340417ec4093f11cc8ceda39
-  data.tar.gz: e9faa23d4535a5b647c5dc86c28ce64317ea964f44faa9141b5a883f77b80dcd
+  metadata.gz: ada259b22664fbbb740c3d28fa06578cb6fc00a42590ea459a1f2395f8e38a92
+  data.tar.gz: 0636466a99e8a0df4d955b0928d76b504df74bba4e3ab13a2d08237ccd57b162
 SHA512:
-  metadata.gz: 5fa259f415261689936b4f03f179198ea6849fbe63b932b5836fa800714055ce574a80a56462355a92d125440362957ebf02e5bafbde55fe8211805c80573ae5
-  data.tar.gz: 0aaf341ae13c377e6f944344e0feef246e3450ae9eb0d74fcbf8e932e9c9fcf0d8f0dd56ce374064d4f51c4d99f4c306560c3283db27f70ae6aa5af346d83ec3
+  metadata.gz: 209f76b8ceebdb2cac83d22aab78873dad373a9ba488e7d320972e8ced4d3ac71454ef6669db321727ce3e4a85fdc5744005ff64d1a0f4cd48d9a4231bddf384
+  data.tar.gz: df094fd4baa169249e92309814d67d0fb5a53b5da4990c0510f5ae1d96e07541356a3014f75b8b79a97f0a91b03b92b576331422c54f36bb2c4943f2f0f87b08

data/Changes.md

@@ -2,12 +2,50 @@
 
 [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
+----------
+
+- Freeze global configuration once boot is complete, to avoid configuration race conditions [#6466, #6465]
+- Sidekiq now warns if a job iteration takes longer than the `-t` timeout setting (defaults to 25 seconds)
+- Iteration callbacks now have easy access to job arguments via the `arguments` method:
+```ruby
+def on_stop
+  p arguments # => `[123, "string", {"key" => "value"}]`
+  id, str, hash = arguments
+end
+```
+- Iterable jobs can be cancelled via `Sidekiq::Client#cancel!`:
+```ruby
+c = Sidekiq::Client.new
+jid = c.push("class" => SomeJob, "args" => [123])
+c.cancel!(jid) # => true
+```
+- Take over support for ActiveJob's `:sidekiq` adapter [#6430, fatkodima]
+- Ensure CurrentAttributes are in scope when creating batch callbacks [#6455]
+- Add `Sidekiq.gem_version` API.
+- Update Ukranian translations
+
 7.3.2
 ----------
 
 - Adjust ActiveRecord batch iteration to restart an interrupted batch from the beginning.
   Each batch should be processed as a single transaction in order to be idempotent. [#6405]
-- Fix typo in S::DeadSet#kill [#6397]
+- Fix typo in Sidekiq::DeadSet#kill [#6397]
 - Fix CSS issue with bottom bar in Web UI [#6414]
 
 7.3.1

data/lib/active_job/queue_adapters/sidekiq_adapter.rb

@@ -0,0 +1,88 @@
+# 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'.
+    remove_const(:SidekiqAdapter) if defined?("::#{name}::SidekiqAdapter")
+
+    # Sidekiq adapter for Active Job
+    #
+    # To use Sidekiq set the queue_adapter config to +:sidekiq+.
+    #
+    #   Rails.application.config.active_job.queue_adapter = :sidekiq
+    class SidekiqAdapter
+      # Defines whether enqueuing should happen implicitly to after commit when called
+      # from inside a transaction.
+      # @api private
+      def enqueue_after_transaction_commit?
+        true
+      end
+
+      # @api private
+      def enqueue(job)
+        job.provider_job_id = JobWrapper.set(
+          wrapped: job.class,
+          queue: job.queue_name
+        ).perform_async(job.serialize)
+      end
+
+      # @api private
+      def enqueue_at(job, timestamp)
+        job.provider_job_id = JobWrapper.set(
+          wrapped: job.class,
+          queue: job.queue_name
+        ).perform_at(timestamp, job.serialize)
+      end
+
+      # @api private
+      def enqueue_all(jobs)
+        enqueued_count = 0
+        jobs.group_by(&:class).each do |job_class, same_class_jobs|
+          same_class_jobs.group_by(&:queue_name).each do |queue, same_class_and_queue_jobs|
+            immediate_jobs, scheduled_jobs = same_class_and_queue_jobs.partition { |job| job.scheduled_at.nil? }
+
+            if immediate_jobs.any?
+              jids = Sidekiq::Client.push_bulk(
+                "class" => JobWrapper,
+                "wrapped" => job_class,
+                "queue" => queue,
+                "args" => immediate_jobs.map { |job| [job.serialize] }
+              )
+              enqueued_count += jids.compact.size
+            end
+
+            if scheduled_jobs.any?
+              jids = Sidekiq::Client.push_bulk(
+                "class" => JobWrapper,
+                "wrapped" => job_class,
+                "queue" => queue,
+                "args" => scheduled_jobs.map { |job| [job.serialize] },
+                "at" => scheduled_jobs.map { |job| job.scheduled_at&.to_f }
+              )
+              enqueued_count += jids.compact.size
+            end
+          end
+        end
+        enqueued_count
+      end
+
+      # Defines a class alias for backwards compatibility with enqueued Active Job jobs.
+      # @api private
+      class JobWrapper < Sidekiq::ActiveJob::Wrapper
+      end
+    end
+  end
+end

data/lib/sidekiq/api.rb

@@ -373,7 +373,7 @@ module Sidekiq
     def display_class
       # Unwrap known wrappers so they show up in a human-friendly manner in the Web UI
       @klass ||= self["display_class"] || begin
-        if klass == "ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper"
+        if klass == "ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper" || klass == "Sidekiq::ActiveJob::Wrapper"
           job_class = @item["wrapped"] || args[0]
           if job_class == "ActionMailer::DeliveryJob" || job_class == "ActionMailer::MailDeliveryJob"
             # MailerClass#mailer_method
@@ -389,7 +389,7 @@ module Sidekiq
 
     def display_args
       # Unwrap known wrappers so they show up in a human-friendly manner in the Web UI
-      @display_args ||= if klass == "ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper"
+      @display_args ||= if klass == "ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper" || klass == "Sidekiq::ActiveJob::Wrapper"
         job_args = self["wrapped"] ? deserialize_argument(args[0]["arguments"]) : []
         if (self["wrapped"] || args[0]) == "ActionMailer::DeliveryJob"
           # remove MailerClass, mailer_method and 'deliver_now'
@@ -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/capsule.rb

@@ -40,9 +40,9 @@ module Sidekiq
 
     def fetcher
       @fetcher ||= begin
-        inst = (config[:fetch_class] || Sidekiq::BasicFetch).new(self)
-        inst.setup(config[:fetch_setup]) if inst.respond_to?(:setup)
-        inst
+        instance = (config[:fetch_class] || Sidekiq::BasicFetch).new(self)
+        instance.setup(config[:fetch_setup]) if instance.respond_to?(:setup)
+        instance
       end
     end
 

data/lib/sidekiq/client.rb

@@ -58,6 +58,23 @@ module Sidekiq
       end
     end
 
+    # Cancel the IterableJob with the given JID.
+    # **NB: Cancellation is asynchronous.** Iteration checks every
+    # five seconds so this will not immediately stop the given job.
+    def cancel!(jid)
+      key = "it-#{jid}"
+      _, result, _ = Sidekiq.redis do |c|
+        c.pipelined do |p|
+          p.hsetnx(key, "cancelled", Time.now.to_i)
+          p.hget(key, "cancelled")
+          p.expire(key, Sidekiq::Job::Iterable::STATE_TTL)
+          # TODO When Redis 7.2 is required
+          # p.expire(key, Sidekiq::Job::Iterable::STATE_TTL, "nx")
+        end
+      end
+      result.to_i
+    end
+
     ##
     # The main method used to push a job to Redis.  Accepts a number of options:
     #

data/lib/sidekiq/config.rb

@@ -185,7 +185,13 @@ module Sidekiq
 
     # register global singletons which can be accessed elsewhere
     def register(name, instance)
-      @directory[name] = instance
+      # logger.debug("register[#{name}] = #{instance}")
+      # Sidekiq Enterprise lazy registers a few services so we
+      # can't lock down this hash completely.
+      hash = @directory.dup
+      hash[name] = instance
+      @directory = hash.freeze
+      instance
     end
 
     # find a singleton
@@ -193,10 +199,16 @@ module Sidekiq
       # JNDI is just a fancy name for a hash lookup
       @directory.fetch(name) do |key|
         return nil unless default_class
-        @directory[key] = default_class.new(self)
+        register(key, default_class.new(self))
       end
     end
 
+    def freeze!
+      @directory.freeze
+      @options.freeze
+      true
+    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

data/lib/sidekiq/job/iterable.rb

@@ -30,6 +30,40 @@ module Sidekiq
         @_cursor = nil
         @_start_time = nil
         @_runtime = 0
+        @_args = nil
+        @_cancelled = nil
+      end
+
+      def arguments
+        @_args
+      end
+
+      # Three days is the longest period you generally need to wait for a retry to
+      # execute when using the default retry scheme. We don't want to "forget" the job
+      # is cancelled before it has a chance to execute and cancel itself.
+      CANCELLATION_PERIOD = (3 * 86_400).to_s
+
+      # Set a flag in Redis to mark this job as cancelled.
+      # Cancellation is asynchronous and is checked at the start of iteration
+      # and every 5 seconds thereafter as part of the recurring state flush.
+      def cancel!
+        return @_cancelled if cancelled?
+
+        key = "it-#{jid}"
+        _, result, _ = Sidekiq.redis do |c|
+          c.pipelined do |p|
+            p.hsetnx(key, "cancelled", Time.now.to_i)
+            p.hget(key, "cancelled")
+            # TODO When Redis 7.2 is required
+            # p.expire(key, Sidekiq::Job::Iterable::STATE_TTL, "nx")
+            p.expire(key, Sidekiq::Job::Iterable::STATE_TTL)
+          end
+        end
+        @_cancelled = result.to_i
+      end
+
+      def cancelled?
+        @_cancelled
       end
 
       # A hook to override that will be called when the job starts iterating.
@@ -91,13 +125,14 @@ module Sidekiq
       end
 
       # @api private
-      def perform(*arguments)
+      def perform(*args)
+        @_args = args.dup.freeze
         fetch_previous_iteration_state
 
         @_executions += 1
         @_start_time = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
 
-        enumerator = build_enumerator(*arguments, cursor: @_cursor)
+        enumerator = build_enumerator(*args, cursor: @_cursor)
         unless enumerator
           logger.info("'#build_enumerator' returned nil, skipping the job.")
           return
@@ -112,7 +147,7 @@ module Sidekiq
         end
 
         completed = catch(:abort) do
-          iterate_with_enumerator(enumerator, arguments)
+          iterate_with_enumerator(enumerator, args)
         end
 
         on_stop
@@ -128,6 +163,10 @@ module Sidekiq
 
       private
 
+      def is_cancelled?
+        @_cancelled = Sidekiq.redis { |c| c.hget("it-#{jid}", "cancelled") }
+      end
+
       def fetch_previous_iteration_state
         state = Sidekiq.redis { |conn| conn.hgetall(iteration_key) }
 
@@ -144,6 +183,12 @@ module Sidekiq
       STATE_TTL = 30 * 24 * 60 * 60 # one month
 
       def iterate_with_enumerator(enumerator, arguments)
+        if is_cancelled?
+          logger.info { "Job cancelled" }
+          return true
+        end
+
+        time_limit = Sidekiq.default_configuration[:timeout]
         found_record = false
         state_flushed_at = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
 
@@ -153,14 +198,21 @@ module Sidekiq
 
           is_interrupted = interrupted?
           if ::Process.clock_gettime(::Process::CLOCK_MONOTONIC) - state_flushed_at >= STATE_FLUSH_INTERVAL || is_interrupted
-            flush_state
+            _, _, cancelled = flush_state
             state_flushed_at = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
+            if cancelled == 1
+              @_cancelled = true
+              logger.info { "Job cancelled" }
+              return true
+            end
           end
 
           return false if is_interrupted
 
-          around_iteration do
-            each_iteration(object, *arguments)
+          verify_iteration_time(time_limit, object) do
+            around_iteration do
+              each_iteration(object, *arguments)
+            end
           end
         end
 
@@ -170,6 +222,16 @@ module Sidekiq
         @_runtime += (::Process.clock_gettime(::Process::CLOCK_MONOTONIC) - @_start_time)
       end
 
+      def verify_iteration_time(time_limit, object)
+        start = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
+        yield
+        finish = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
+        total = finish - start
+        if total > time_limit
+          logger.warn { "Iteration took longer (%.2f) than Sidekiq's shutdown timeout (%d) when processing `%s`. This can lead to job processing problems during deploys" % [total, time_limit, object] }
+        end
+      end
+
       def reenqueue_iteration_job
         flush_state
         logger.debug { "Interrupting job (cursor=#{@_cursor.inspect})" }
@@ -204,6 +266,7 @@ module Sidekiq
           conn.multi do |pipe|
             pipe.hset(key, state)
             pipe.expire(key, STATE_TTL)
+            pipe.hget(key, "cancelled")
           end
         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/metrics/shared.rb

@@ -1,12 +1,21 @@
 # frozen_string_literal: true
 
-require "concurrent"
-
 module Sidekiq
   module Metrics
-    # This is the only dependency on concurrent-ruby in Sidekiq but it's
-    # mandatory for thread-safety until MRI supports atomic operations on values.
-    Counter = ::Concurrent::AtomicFixnum
+    class Counter
+      def initialize
+        @value = 0
+        @lock = Mutex.new
+      end
+
+      def increment
+        @lock.synchronize { @value += 1 }
+      end
+
+      def value
+        @lock.synchronize { @value }
+      end
+    end
 
     # Implements space-efficient but statistically useful histogram storage.
     # A precise time histogram stores every time. Instead we break times into a set of

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
@@ -88,7 +103,7 @@ module Sidekiq
         cattrs = build_cattrs_hash(klass_or_array)
 
         config.client_middleware.add Save, cattrs
-        config.server_middleware.add Load, cattrs
+        config.server_middleware.prepend Load, cattrs
       end
 
       private

data/lib/sidekiq/processor.rb

@@ -138,11 +138,11 @@ module Sidekiq
               # Effectively this block denotes a "unit of work" to Rails.
               @reloader.call do
                 klass = Object.const_get(job_hash["class"])
-                inst = klass.new
-                inst.jid = job_hash["jid"]
-                inst._context = self
-                @retrier.local(inst, jobstr, queue) do
-                  yield inst
+                instance = klass.new
+                instance.jid = job_hash["jid"]
+                instance._context = self
+                @retrier.local(instance, jobstr, queue) do
+                  yield instance
                 end
               end
             end
@@ -180,9 +180,9 @@ module Sidekiq
       ack = false
       Thread.handle_interrupt(IGNORE_SHUTDOWN_INTERRUPTS) do
         Thread.handle_interrupt(ALLOW_SHUTDOWN_INTERRUPTS) do
-          dispatch(job_hash, queue, jobstr) do |inst|
-            config.server_middleware.invoke(inst, job_hash, queue) do
-              execute_job(inst, job_hash["args"])
+          dispatch(job_hash, queue, jobstr) do |instance|
+            config.server_middleware.invoke(instance, job_hash, queue) do
+              execute_job(instance, job_hash["args"])
             end
           end
           ack = true
@@ -216,8 +216,8 @@ module Sidekiq
       end
     end
 
-    def execute_job(inst, cloned_args)
-      inst.perform(*cloned_args)
+    def execute_job(instance, cloned_args)
+      instance.perform(*cloned_args)
     end
 
     # Ruby doesn't provide atomic counters out of the box so we'll

data/lib/sidekiq/rails.rb

@@ -39,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/testing.rb

@@ -283,11 +283,11 @@ module Sidekiq
       end
 
       def process_job(job)
-        inst = new
-        inst.jid = job["jid"]
-        inst.bid = job["bid"] if inst.respond_to?(:bid=)
-        Sidekiq::Testing.server_middleware.invoke(inst, job, job["queue"]) do
-          execute_job(inst, job["args"])
+        instance = new
+        instance.jid = job["jid"]
+        instance.bid = job["bid"] if instance.respond_to?(:bid=)
+        Sidekiq::Testing.server_middleware.invoke(instance, job, job["queue"]) do
+          execute_job(instance, job["args"])
         end
       end
 

data/lib/sidekiq/version.rb

@@ -1,6 +1,10 @@
 # frozen_string_literal: true
 
 module Sidekiq
-  VERSION = "7.3.2"
+  VERSION = "7.3.5"
   MAJOR = 7
+
+  def self.gem_version
+    Gem::Version.new(VERSION)
+  end
 end

data/lib/sidekiq/web/action.rb

@@ -48,8 +48,12 @@ module Sidekiq
       if content.is_a? Symbol
         unless respond_to?(:"_erb_#{content}")
           views = options[:views] || Web.settings.views
-          src = ERB.new(File.read("#{views}/#{content}.erb")).src
-          WebAction.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          filename = "#{views}/#{content}.erb"
+          src = ERB.new(File.read(filename)).src
+
+          # Need to use lineno less by 1 because erb generates a
+          # comment before the source code.
+          WebAction.class_eval <<-RUBY, filename, -1 # standard:disable Style/EvalWithLocation
             def _erb_#{content}
               #{src}
             end

data/lib/sidekiq/web/application.rb

@@ -331,12 +331,10 @@ module Sidekiq
     ########
     # Filtering
 
-    get "/filter/metrics" do
-      redirect "#{root_path}metrics"
-    end
-
-    post "/filter/metrics" do
+    route :get, :post, "/filter/metrics" do
       x = params[:substr]
+      return redirect "#{root_path}metrics" unless x && x != ""
+
       q = Sidekiq::Metrics::Query.new
       @period = h((params[:period] || "")[0..1])
       @periods = METRICS_PERIODS
@@ -346,15 +344,7 @@ module Sidekiq
       erb :metrics
     end
 
-    get "/filter/retries" do
-      x = params[:substr]
-      return redirect "#{root_path}retries" unless x && x != ""
-
-      @retries = search(Sidekiq::RetrySet.new, params[:substr])
-      erb :retries
-    end
-
-    post "/filter/retries" do
+    route :get, :post, "/filter/retries" do
       x = params[:substr]
       return redirect "#{root_path}retries" unless x && x != ""
 
@@ -362,15 +352,7 @@ module Sidekiq
       erb :retries
     end
 
-    get "/filter/scheduled" do
-      x = params[:substr]
-      return redirect "#{root_path}scheduled" unless x && x != ""
-
-      @scheduled = search(Sidekiq::ScheduledSet.new, params[:substr])
-      erb :scheduled
-    end
-
-    post "/filter/scheduled" do
+    route :get, :post, "/filter/scheduled" do
       x = params[:substr]
       return redirect "#{root_path}scheduled" unless x && x != ""
 
@@ -378,15 +360,7 @@ module Sidekiq
       erb :scheduled
     end
 
-    get "/filter/dead" do
-      x = params[:substr]
-      return redirect "#{root_path}morgue" unless x && x != ""
-
-      @dead = search(Sidekiq::DeadSet.new, params[:substr])
-      erb :morgue
-    end
-
-    post "/filter/dead" do
+    route :get, :post, "/filter/dead" do
       x = params[:substr]
       return redirect "#{root_path}morgue" unless x && x != ""
 

data/lib/sidekiq/web/router.rb

@@ -39,10 +39,13 @@ module Sidekiq
       route(DELETE, path, &block)
     end
 
-    def route(method, path, &block)
+    def route(*methods, path, &block)
       @routes ||= {GET => [], POST => [], PUT => [], PATCH => [], DELETE => [], HEAD => []}
 
-      @routes[method] << WebRoute.new(method, path, block)
+      methods.each do |method|
+        method = method.to_s.upcase
+        @routes[method] << WebRoute.new(method, path, block)
+      end
     end
 
     def match(env)

data/lib/sidekiq/web.rb

@@ -213,7 +213,7 @@ module Sidekiq
   Sidekiq::WebApplication.helpers WebHelpers
   Sidekiq::WebApplication.helpers Sidekiq::Paginator
 
-  Sidekiq::WebAction.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+  Sidekiq::WebAction.class_eval <<-RUBY, Web::LAYOUT, -1 # standard:disable Style/EvalWithLocation
     def _render
       #{ERB.new(File.read(Web::LAYOUT)).src}
     end

data/lib/sidekiq.rb

@@ -102,18 +102,19 @@ module Sidekiq
   def self.freeze!
     @frozen = true
     @config_blocks = nil
+    default_configuration.freeze!
   end
 
   # 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.
   #
-  #   inst = Sidekiq.configure_embed do |config|
+  #   instance = Sidekiq.configure_embed do |config|
   #     config.queues = %w[critical default low]
   #   end
-  #   inst.run
+  #   instance.run
   #   sleep 10
-  #   inst.stop
+  #   instance.stop
   #
   # 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.

data/sidekiq.gemspec

@@ -26,6 +26,5 @@ Gem::Specification.new do |gem|
   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 "concurrent-ruby", "< 2"
   gem.add_dependency "logger"
 end

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/en.yml

@@ -95,7 +95,6 @@ en:
   TotalExecutionTime: Total Execution Time
   AvgExecutionTime: Average Execution Time
   Context: Context
-  Bucket: Bucket
   NoJobMetricsFound: No recent job metrics were found
   Filter: Filter
   AnyJobContent: Any job content

data/web/locales/fr.yml

@@ -95,5 +95,4 @@ fr:
   TotalExecutionTime: Temps d'exécution total
   AvgExecutionTime: Temps d'exécution moyen
   Context: Contexte
-  Bucket: Bucket
   NoJobMetricsFound: Aucune statistique de tâche récente n'a été trouvée

data/web/locales/gd.yml

@@ -95,5 +95,4 @@ gd:
   TotalExecutionTime: Ùine iomlan nan gnìomhan
   AvgExecutionTime: Ùine cuibheasach nan gnìomhan
   Context: Co-theacsa
-  Bucket: Bucaid
   NoJobMetricsFound: Cha deach meatraigeachd o chionn goirid air obair a lorg

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

data/web/locales/ja.yml

@@ -87,5 +87,4 @@ ja:
   TotalExecutionTime: 合計実行時間
   AvgExecutionTime: 平均実行時間
   Context: コンテキスト
-  Bucket: バケット
   NoJobMetricsFound: 直近のジョブメトリクスが見つかりませんでした

data/web/locales/pt-br.yml

@@ -7,7 +7,6 @@
   Arguments: Argumentos
   AvgExecutionTime: Tempo médio de execução
   BackToApp: De volta ao aplicativo
-  Bucket: Bucket
   Busy: Ocupados
   Class: Classe
   Connections: Conexões
@@ -93,4 +92,4 @@
   Utilization: Utilização
   Version: Versão
   When: Quando
-  Worker: Trabalhador
+  Worker: Trabalhador

data/web/locales/tr.yml

@@ -95,7 +95,6 @@ tr:
   TotalExecutionTime: Toplam Yürütme Süresi
   AvgExecutionTime: Ortalama Yürütme Süresi
   Context: Bağlam
-  Bucket: Kova
   NoJobMetricsFound: Son iş metrikleri bulunamadı
   Filter: Filtre
   AnyJobContent: Herhangi bir iş içeriği

data/web/locales/uk.yml

@@ -6,31 +6,39 @@ uk:
   AreYouSureDeleteJob: Ви впевнені у тому, що хочете видалити задачу?
   AreYouSureDeleteQueue: Ви впевнені у тому, що хочете видалити чергу %{queue}?
   Arguments: Аргументи
+  BackToApp: Назад
   Busy: Зайнятих
   Class: Клас
   Connections: З'єднань
+  CreatedAt: Створено
   CurrentMessagesInQueue: Поточні задачі у черзі <span class='title'>%{queue}</span>
   Dashboard: Панель керування
   Dead: Вбитих
   DeadJobs: Вбиті задачі
   Delete: Видалити
   DeleteAll: Видалити усі
+  Deploy: Деплой
   Enqueued: У черзі
   Error: Помилка
   ErrorBacktrace: Трасування помилки
   ErrorClass: Клас помилки
   ErrorMessage: Повідомлення про помилку
+  ExecutionTime: Час виконання
   Extras: Додатково
   Failed: Невдалих
   Failures: Невдачі
+  Failure: Невдача
   GoBack: ← Назад
   History: Історія
   Job: Задача
   Jobs: Задачі
-  Kill: Вбиваємо
+  Kill: Вбити
+  KillAll: Вбити все
   LastRetry: Остання спроба
+  Latency: Затримка
   LivePoll: Постійне опитування
   MemoryUsage: Використання пам'яті
+  Name: Назва
   Namespace: Простір імен
   NextRetry: Наступна спроба
   NoDeadJobsFound: Вбитих задач не знайдено
@@ -40,10 +48,12 @@ uk:
   OneMonth: 1 місяць
   OneWeek: 1 тиждень
   OriginallyFailed: Перша невдала спроба
+  Pause: Призупинити
   Paused: Призупинено
   PeakMemoryUsage: Максимальне використання пам'яті
   Plugins: Плагіни
   PollingInterval: Інтервал опитування
+  Process: Процес
   Processed: Опрацьовано
   Processes: Процеси
   Queue: Черга
@@ -57,6 +67,7 @@ uk:
   RetryNow: Повторити зараз
   Scheduled: Заплановано
   ScheduledJobs: Заплановані задачі
+  Seconds: Секунди
   ShowAll: Відобразити усі
   SixMonths: 6 місяців
   Size: Розмір
@@ -65,13 +76,25 @@ uk:
   Stop: Зупинити
   StopAll: Зупинити усі
   StopPolling: Зупинити опитування
+  Success: Успіх
+  Summary: Підсумок
   Thread: Потік
   Threads: Потоки
   ThreeMonths: 3 місяці
   Time: Час
+  Unpause: Відновити
   Uptime: Днів безперебійної роботи
+  Utilization: Утилізація
   Version: Версія
   When: Коли
   Worker: Обробник
   active: активний
   idle: незайнятий
+  Metrics: Метрики
+  NoDataFound: Даних не знайдено
+  TotalExecutionTime: Загальний час виконання
+  AvgExecutionTime: Середній час виконання
+  Context: Контекст
+  NoJobMetricsFound: Недавніх метрик задачі не знайдено
+  Filter: Фільтр
+  AnyJobContent: Будь-який атрибут задачі

data/web/locales/zh-cn.yml

@@ -89,7 +89,6 @@ zh-cn: # <---- change this to your locale code
   TotalExecutionTime: 总执行时间
   AvgExecutionTime: 平均执行时间
   Context: 上下文
-  Bucket: 桶
   NoJobMetricsFound: 无任务相关指标数据
   Success: 成功
   Failure: 失败

data/web/locales/zh-tw.yml

@@ -98,5 +98,4 @@ zh-tw: # <---- change this to your locale code
   TotalExecutionTime: 總執行時間
   AvgExecutionTime: 平均執行時間
   Context: 上下文
-  Bucket: 桶
   NoJobMetricsFound: 找無工作相關計量資料

data/web/views/metrics.erb

@@ -54,8 +54,8 @@
         <th><%= t('Name') %></th>
         <th><%= t('Success') %></th>
         <th><%= t('Failure') %></th>
-        <th><%= t('TotalExecutionTime') %> (Seconds)</th>
-        <th><%= t('AvgExecutionTime') %> (Seconds)</th>
+        <th><%= t('TotalExecutionTime') %> (<%= t('Seconds') %>)</th>
+        <th><%= t('AvgExecutionTime') %> (<%= t('Seconds') %>)</th>
       </tr>
       <% if job_results.any? %>
         <% job_results.each_with_index do |(kls, jr), i| %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq
 version: !ruby/object:Gem::Version
-  version: 7.3.2
+  version: 7.3.5
 platform: ruby
 authors:
 - Mike Perham
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-04 00:00:00.000000000 Z
+date: 2024-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis-client
@@ -52,20 +52,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.2.4
-- !ruby/object:Gem::Dependency
-  name: concurrent-ruby
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2'
 - !ruby/object:Gem::Dependency
   name: logger
   requirement: !ruby/object:Gem::Requirement
@@ -96,6 +82,7 @@ files:
 - bin/sidekiq
 - bin/sidekiqload
 - bin/sidekiqmon
+- lib/active_job/queue_adapters/sidekiq_adapter.rb
 - lib/generators/sidekiq/job_generator.rb
 - lib/generators/sidekiq/templates/job.rb.erb
 - lib/generators/sidekiq/templates/job_spec.rb.erb
@@ -245,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