sidekiq 8.0.1 → 8.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0775f0003b32ada04699c457af4644880f18381cff189168ca7cde5790ced21
-  data.tar.gz: c7824fe9533b2d733cbd8f65d80cbd1bfd3216bb45ca44f158f9ab344164ad10
+  metadata.gz: 5862bbba5b859c1983788b6aeb49193fad724a1186426084c1e42747cb226ba2
+  data.tar.gz: 11fbaba14b814b87d09d809173ca59f9477c119f9ab6d556e4a9baa8e4e83d63
 SHA512:
-  metadata.gz: ece6582faad9d3139cf7eb8e113f73ed94c983c59578d51e64caaeee52d48071b7d93f6af76942bf28735744f8047efa8d98dd571132ac3636b8509a54e36337
-  data.tar.gz: a5d0cea61952c74b6ab862dbb3843b8c728ea9b341c43915c8c9c5d889665641fedd5e82382b783cd02be44e90451522e523b5418ce21523f475494383574101
+  metadata.gz: 67d640ff21778c036ba15db434bafe0582a61e1b462d1bee2502fa7a9b8978208b4099c46d8ad6bd6214f198558de8985deeb11b6e7d99f1e603b15f087f0215
+  data.tar.gz: 4becc4ea36c062f52667fea91d4f49b5bfb759fe43f75ef6427c1aeacdc36764408f442cafccc3595585cf13ef2ff71da98212d7db0fcb89ff198ace0cd19caa

data/Changes.md

@@ -2,6 +2,19 @@
 
 [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
+----------
+
+- Configure Vernier output directory [#6674]
+- Rework Rails integration [#6669]
+- Implement flash messages for the Web UI [#6675]
+
+8.0.2
+----------
+
+- Add `on(:exit)` event to run code right before the Sidekiq process exits [#6637]
+- Metrics page crashes with Rack 3.1+ [#6646]
+
 8.0.1
 ----------
 

data/lib/active_job/queue_adapters/sidekiq_adapter.rb

@@ -1,75 +1,111 @@
 # frozen_string_literal: true
 
-module ActiveJob
-  module QueueAdapters
-    # Explicitly remove the implementation existing in older Rails.
-    remove_const(:SidekiqAdapter) if const_defined?(:SidekiqAdapter)
+begin
+  gem "activejob", ">= 7.0"
+  require "active_job"
 
-    # 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.
+  module Sidekiq
+    module ActiveJob
       # @api private
-      def enqueue_after_transaction_commit?
-        true
-      end
+      class Wrapper
+        include Sidekiq::Job
 
-      # @api private
-      def enqueue(job)
-        job.provider_job_id = Sidekiq::ActiveJob::Wrapper.set(
-          wrapped: job.class,
-          queue: job.queue_name
-        ).perform_async(job.serialize)
+        def perform(job_data)
+          ::ActiveJob::Base.execute(job_data.merge("provider_job_id" => jid))
+        end
       end
+    end
+  end
 
-      # @api private
-      def enqueue_at(job, timestamp)
-        job.provider_job_id = Sidekiq::ActiveJob::Wrapper.set(
-          wrapped: job.class,
-          queue: job.queue_name
-        ).perform_at(timestamp, job.serialize)
-      end
+  unless ActiveJob::Base.respond_to?(:sidekiq_options)
+    # By including the Options module, we allow AJs to directly control sidekiq features
+    # via the *sidekiq_options* class method and, for instance, not use AJ's retry system.
+    # AJ retries don't show up in the Sidekiq UI Retries tab, don't save any error data, can't be
+    # manually retried, don't automatically die, etc.
+    #
+    #   class SomeJob < ActiveJob::Base
+    #     queue_as :default
+    #     sidekiq_options retry: 3, backtrace: 10
+    #     def perform
+    #     end
+    #   end
+    ActiveJob::Base.include Sidekiq::Job::Options
+  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? }
+  # Patch the ActiveJob module
+  module ActiveJob
+    module QueueAdapters
+      # Explicitly remove the implementation existing in older Rails.
+      remove_const(:SidekiqAdapter) if const_defined?(:SidekiqAdapter)
 
-            if immediate_jobs.any?
-              jids = Sidekiq::Client.push_bulk(
-                "class" => Sidekiq::ActiveJob::Wrapper,
-                "wrapped" => job_class,
-                "queue" => queue,
-                "args" => immediate_jobs.map { |job| [job.serialize] }
-              )
-              enqueued_count += jids.compact.size
-            end
+      # 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 = Sidekiq::ActiveJob::Wrapper.set(
+            wrapped: job.class,
+            queue: job.queue_name
+          ).perform_async(job.serialize)
+        end
+
+        # @api private
+        def enqueue_at(job, timestamp)
+          job.provider_job_id = Sidekiq::ActiveJob::Wrapper.set(
+            wrapped: job.class,
+            queue: job.queue_name
+          ).perform_at(timestamp, job.serialize)
+        end
 
-            if scheduled_jobs.any?
-              jids = Sidekiq::Client.push_bulk(
-                "class" => Sidekiq::ActiveJob::Wrapper,
-                "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
+        # @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" => Sidekiq::ActiveJob::Wrapper,
+                  "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" => Sidekiq::ActiveJob::Wrapper,
+                  "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
-        enqueued_count
-      end
 
-      # Defines a class alias for backwards compatibility with enqueued Active Job jobs.
-      # @api private
-      class JobWrapper < Sidekiq::ActiveJob::Wrapper
+        # Defines a class alias for backwards compatibility with enqueued Active Job jobs.
+        # @api private
+        class JobWrapper < Sidekiq::ActiveJob::Wrapper
+        end
       end
     end
   end
+rescue Gem::LoadError
+  # ActiveJob not available or version requirement not met
 end

data/lib/sidekiq/api.rb

@@ -1166,8 +1166,8 @@ module Sidekiq
   #    works.each do |process_id, thread_id, work|
   #      # process_id is a unique identifier per Sidekiq process
   #      # thread_id is a unique identifier per thread
-  #      # work is a Hash which looks like:
-  #      # { 'queue' => name, 'run_at' => timestamp, 'payload' => job_hash }
+  #      # work is a `Sidekiq::Work` instance that has the following accessor methods.
+  #      # [work.queue, work.run_at, work.payload]
   #      # run_at is an epoch Integer.
   #    end
   #

data/lib/sidekiq/config.rb

@@ -27,6 +27,7 @@ module Sidekiq
         startup: [],
         quiet: [],
         shutdown: [],
+        exit: [],
         # triggers when we fire the first heartbeat on startup OR repairing a network partition
         heartbeat: [],
         # triggers on EVERY heartbeat call, every 10 seconds
@@ -258,7 +259,7 @@ module Sidekiq
     end
 
     # Register a block to run at a point in the Sidekiq lifecycle.
-    # :startup, :quiet or :shutdown are valid events.
+    # :startup, :quiet, :shutdown, or :exit are valid events.
     #
     #   Sidekiq.configure_server do |config|
     #     config.on(:shutdown) do

data/lib/sidekiq/embedded.rb

@@ -43,7 +43,7 @@ module Sidekiq
       # fire startup and start multithreading.
       info = config.redis_info
       ver = Gem::Version.new(info["redis_version"])
-      raise "You are connecting to Redis #{ver}, Sidekiq requires Redis 6.2.0 or greater" if ver < Gem::Version.new("6.2.0")
+      raise "You are connected to Redis #{ver}, Sidekiq requires Redis 7.0.0 or greater" if ver < Gem::Version.new("7.0.0")
 
       maxmemory_policy = info["maxmemory_policy"]
       if maxmemory_policy != "noeviction"

data/lib/sidekiq/launcher.rb

@@ -68,6 +68,7 @@ module Sidekiq
       stoppers.each(&:join)
 
       clear_heartbeat
+      fire_event(:exit, reverse: true)
     end
 
     def stopping?

data/lib/sidekiq/profiler.rb

@@ -13,6 +13,7 @@ module Sidekiq
     include Sidekiq::Component
     def initialize(config)
       @config = config
+      @vernier_output_dir = ENV.fetch("VERNIER_OUTPUT_DIR") { Dir.tmpdir }
     end
 
     def call(job, &block)
@@ -22,7 +23,6 @@ module Sidekiq
       type = job["class"]
       jid = job["jid"]
       started_at = Time.now
-      options = DEFAULT_OPTIONS.merge((job["profiler_options"] || {}).transform_keys!(&:to_sym))
 
       rundata = {
         started_at: started_at.to_i,
@@ -30,13 +30,17 @@ module Sidekiq
         type: type,
         jid: jid,
         # .gz extension tells Vernier to compress the data
-        filename: "#{token}-#{type}-#{jid}-#{started_at.strftime("%Y%m%d-%H%M%S")}.json.gz"
+        filename: File.join(
+          @vernier_output_dir,
+          "#{token}-#{type}-#{jid}-#{started_at.strftime("%Y%m%d-%H%M%S")}.json.gz"
+        )
       }
+      profiler_options = profiler_options(job, rundata)
 
       require "vernier"
       begin
         a = Time.now
-        rc = Vernier.profile(**options.merge(out: rundata[:filename]), &block)
+        rc = Vernier.profile(**profiler_options, &block)
         b = Time.now
 
         # Failed jobs will raise an exception on previous line and skip this
@@ -55,5 +59,14 @@ module Sidekiq
         FileUtils.rm_f(rundata[:filename])
       end
     end
+
+    private
+
+    def profiler_options(job, rundata)
+      profiler_options = (job["profiler_options"] || {}).transform_keys(&:to_sym)
+      profiler_options[:mode] = profiler_options[:mode].to_sym if profiler_options[:mode]
+
+      DEFAULT_OPTIONS.merge(profiler_options, {out: rundata[:filename]})
+    end
   end
 end

data/lib/sidekiq/rails.rb

@@ -1,84 +1,62 @@
 # frozen_string_literal: true
 
 require "sidekiq/job"
-require "rails"
+require_relative "../active_job/queue_adapters/sidekiq_adapter"
 
 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)
-        @app = app
-      end
-
-      def call
-        params = (::Rails::VERSION::STRING >= "7.1") ? {source: "job.sidekiq"} : {}
-        @app.reloader.wrap(**params) do
-          yield
+  begin
+    gem "railties", ">= 7.0"
+    require "rails"
+
+    class Rails < ::Rails::Engine
+      class Reloader
+        def initialize(app = ::Rails.application)
+          @app = app
         end
-      end
 
-      def inspect
-        "#<Sidekiq::Rails::Reloader @app=#{@app.class.name}>"
-      end
+        def call
+          params = (::Rails::VERSION::STRING >= "7.1") ? {source: "job.sidekiq"} : {}
+          @app.reloader.wrap(**params) do
+            yield
+          end
+        end
 
-      def to_hash
-        {app: @app.class.name}
-      end
-    end
+        def inspect
+          "#<Sidekiq::Rails::Reloader @app=#{@app.class.name}>"
+        end
 
-    # By including the Options module, we allow AJs to directly control sidekiq features
-    # via the *sidekiq_options* class method and, for instance, not use AJ's retry system.
-    # AJ retries don't show up in the Sidekiq UI Retries tab, don't save any error data, can't be
-    # manually retried, don't automatically die, etc.
-    #
-    #   class SomeJob < ActiveJob::Base
-    #     queue_as :default
-    #     sidekiq_options retry: 3, backtrace: 10
-    #     def perform
-    #     end
-    #   end
-    initializer "sidekiq.active_job_integration" do
-      ActiveSupport.on_load(:active_job) do
-        require_relative "../active_job/queue_adapters/sidekiq_adapter"
-        include ::Sidekiq::Job::Options unless respond_to?(:sidekiq_options)
+        def to_hash
+          {app: @app.class.name}
+        end
       end
-    end
 
-    initializer "sidekiq.backtrace_cleaner" do
-      Sidekiq.configure_server do |config|
-        config[:backtrace_cleaner] = ->(backtrace) { ::Rails.backtrace_cleaner.clean(backtrace) }
+      initializer "sidekiq.backtrace_cleaner" do
+        Sidekiq.configure_server do |config|
+          config[:backtrace_cleaner] = ->(backtrace) { ::Rails.backtrace_cleaner.clean(backtrace) }
+        end
       end
-    end
-
-    # This hook happens after all initializers are run, just before returning
-    # from config/environment.rb back to sidekiq/cli.rb.
-    #
-    # None of this matters on the client-side, only within the Sidekiq process itself.
-    config.after_initialize do
-      Sidekiq.configure_server do |config|
-        config[:reloader] = Sidekiq::Rails::Reloader.new
 
-        # This is the integration code necessary so that if a job uses `Rails.logger.info "Hello"`,
-        # it will appear in the Sidekiq console with all of the job context.
-        unless ::Rails.logger == config.logger || ::ActiveSupport::Logger.logger_outputs_to?(::Rails.logger, $stdout)
-          if ::Rails.logger.respond_to?(:broadcast_to)
-            ::Rails.logger.broadcast_to(config.logger)
-          else
-            ::Rails.logger.extend(::ActiveSupport::Logger.broadcast(config.logger))
+      # This hook happens after all initializers are run, just before returning
+      # from config/environment.rb back to sidekiq/cli.rb.
+      #
+      # None of this matters on the client-side, only within the Sidekiq process itself.
+      config.after_initialize do
+        Sidekiq.configure_server do |config|
+          config[:reloader] = Sidekiq::Rails::Reloader.new
+
+          # This is the integration code necessary so that if a job uses `Rails.logger.info "Hello"`,
+          # it will appear in the Sidekiq console with all of the job context.
+          unless ::Rails.logger == config.logger || ::ActiveSupport::Logger.logger_outputs_to?(::Rails.logger, $stdout)
+            if ::Rails.logger.respond_to?(:broadcast_to)
+              ::Rails.logger.broadcast_to(config.logger)
+            else
+              ::Rails.logger.extend(::ActiveSupport::Logger.broadcast(config.logger))
+            end
           end
         end
       end
     end
+  rescue Gem::LoadError
+    # Rails not available or version requirement not met
   end
 end

data/lib/sidekiq/version.rb

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

data/lib/sidekiq/web/action.rb

@@ -30,16 +30,16 @@ module Sidekiq
 
       # external redirect
       def redirect_to(url)
-        throw :halt, [302, {"Location" => url}, []]
+        throw :halt, [302, {"location" => url}, []]
       end
 
       def header(key, value)
-        env["response_headers"][key] = value
+        env["response_headers"][key] = value.to_s
       end
 
       # internal redirect
       def redirect(location)
-        throw :halt, [302, {"Location" => "#{request.base_url}#{location}"}, []]
+        throw :halt, [302, {"location" => "#{request.base_url}#{location}"}, []]
       end
 
       def reload_page
@@ -70,6 +70,25 @@ module Sidekiq
         env["rack.session"]
       end
 
+      def logger
+        Sidekiq.logger
+      end
+
+      # flash { "Some message to show on redirect" }
+      def flash
+        msg = yield
+        logger.info msg
+        session[:flash] = msg
+      end
+
+      def flash?
+        session&.[](:flash)
+      end
+
+      def get_flash
+        @flash ||= session.delete(:flash)
+      end
+
       def erb(content, options = {})
         if content.is_a? Symbol
           unless respond_to?(:"_erb_#{content}")

data/lib/sidekiq/web/application.rb

@@ -43,9 +43,9 @@ module Sidekiq
 
       head "/" do
         # HEAD / is the cheapest heartbeat possible,
-        # it hits Redis to ensure connectivity and returns
-        # the size of the default queue
-        Sidekiq.redis { |c| c.llen("queue:default") }.to_s
+        # it hits Redis to ensure connectivity
+        _ = Sidekiq.redis { |c| c.llen("queue:default") }
+        ""
       end
 
       get "/" do
@@ -240,8 +240,6 @@ module Sidekiq
       end
 
       post "/retries" do
-        route_params("mike")
-        url_params(:mike)
         redirect(request.path) unless url_params("key")
 
         url_params("key").each do |key|

data/lib/sidekiq.rb

@@ -146,4 +146,4 @@ module Sidekiq
   class Shutdown < Interrupt; end
 end
 
-require "sidekiq/rails" if defined?(::Rails::Engine)
+require "sidekiq/rails"

data/web/assets/stylesheets/style.css

@@ -748,3 +748,10 @@ body > footer .nav {
 .w-50 {
   width: 50%;
 }
+
+.flash {
+  width: 100%;
+  text-align: center;
+  padding: 20px;
+  background: var(--color-success);
+}

data/web/locales/it.yml

@@ -35,6 +35,7 @@ it:
   Jobs: Lavori
   Kill: Uccidere
   KillAll: Uccidere tutti
+  Language: Lingua
   LastRetry: Ultimo tentativo
   Latency: Latenza
   LivePoll: Live poll
@@ -54,6 +55,7 @@ it:
   PeakMemoryUsage: Memoria utilizzata (max.)
   Plugins: Plugins
   PollingInterval: Intervallo di polling
+  PollingIntervalMilliseconds: Intervallo di polling in millisecondi
   Process: Processo
   Processed: Processato
   Processes: Processi
@@ -99,3 +101,8 @@ it:
   NoJobMetricsFound: Metriche recenti di lavoro non trovate
   Filter: Filtro
   AnyJobContent: Qualsiasi contenuto di lavoro
+  Profiles: Profili
+  Data: Dati
+  View: Vista
+  Token: Token
+  ElapsedTime: Tempo Trascorso

data/web/views/layout.erb

@@ -2,15 +2,14 @@
 <html dir="<%= text_direction %>" lang="<%= locale %>">
   <head>
     <title><%= environment_title_prefix %><%= Sidekiq::NAME %></title>
-    <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
-
-    <link href="<%= root_path %>stylesheets/style.css" media="screen" rel="stylesheet" type="text/css" nonce="<%= csp_nonce %>" />
-
-    <link rel="apple-touch-icon" href="<%= root_path %>images/apple-touch-icon.png">
-    <link rel="shortcut icon" type="image/ico" href="<%= root_path %>images/favicon.ico" />
+    <meta charset="utf-8"/>
+    <meta name="viewport" content="width=device-width,initial-scale=1.0"/>
+    <meta name="color-scheme" content="light dark"/>
+    <link href="<%= root_path %>stylesheets/style.css" media="screen" rel="stylesheet" type="text/css" nonce="<%= csp_nonce %>"/>
+    <link rel="apple-touch-icon" href="<%= root_path %>images/apple-touch-icon.png"/>
+    <link rel="shortcut icon" type="image/ico" href="<%= root_path %>images/favicon.ico"/>
     <script type="text/javascript" src="<%= root_path %>javascripts/application.js" nonce="<%= csp_nonce %>"></script>
-    <meta name="google" content="notranslate" />
+    <meta name="google" content="notranslate"/>
     <%= display_custom_head %>
   </head>
   <body class="admin" data-locale="<%= locale %>">
@@ -18,6 +17,7 @@
     <main id="page">
       <div class="container">
         <%= erb :_summary %>
+        <% if flash? %><p class="flash"><%= get_flash %></p><% end %>
         <%= yield %>
       </div>
     </main>

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq
 version: !ruby/object:Gem::Version
-  version: 8.0.1
+  version: 8.0.3
 platform: ruby
 authors:
 - Mike Perham
 bindir: bin
 cert_chain: []
-date: 2025-03-06 00:00:00.000000000 Z
+date: 2025-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis-client