sidekiq 8.0.2 → 8.1.0

data/lib/sidekiq/scheduled.rb

@@ -72,6 +72,7 @@ module Sidekiq
       include Sidekiq::Component
 
       INITIAL_WAIT = 10
+      attr_accessor :rnd
 
       def initialize(config)
         @config = config
@@ -80,6 +81,7 @@ module Sidekiq
         @done = false
         @thread = nil
         @count_calls = 0
+        @rnd = Random.new
       end
 
       # Shut down this instance, will pause until the thread is dead.
@@ -115,9 +117,9 @@ module Sidekiq
       private
 
       def wait
-        @sleeper.pop(random_poll_interval)
+        @sleeper.pop(timeout: random_poll_interval)
       rescue Timeout::Error
-        # expected
+        # TODO move to exception: false
       rescue => ex
         # if poll_interval_average hasn't been calculated yet, we can
         # raise an error trying to reach Redis.
@@ -151,11 +153,11 @@ module Sidekiq
 
         if count < 10
           # For small clusters, calculate a random interval that is ±50% the desired average.
-          interval * rand + interval.to_f / 2
+          interval * @rnd.rand + interval.to_f / 2
         else
           # With 10+ processes, we should have enough randomness to get decent polling
           # across the entire timespan
-          interval * rand
+          interval * @rnd.rand * 2
         end
       end
 
@@ -223,7 +225,7 @@ module Sidekiq
         total += INITIAL_WAIT unless @config[:poll_interval_average]
         total += (5 * rand)
 
-        @sleeper.pop(total)
+        @sleeper.pop(timeout: total)
       rescue Timeout::Error
       ensure
         # periodically clean out the `processes` set in Redis which can collect

data/lib/sidekiq/testing.rb

@@ -83,7 +83,7 @@ module Sidekiq
   class EmptyQueueError < RuntimeError; end
 
   module TestingClient
-    def atomic_push(conn, payloads)
+    private def atomic_push(conn, payloads)
       if Sidekiq::Testing.fake?
         payloads.each do |job|
           job = Sidekiq.load_json(Sidekiq.dump_json(job))

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 = "8.0.2"
+  VERSION = "8.1.0"
   MAJOR = 8
 
   def self.gem_version

data/lib/sidekiq/web/action.rb

@@ -67,14 +67,57 @@ module Sidekiq
       end
 
       def session
-        env["rack.session"]
+        env["rack.session"] || fail(<<~EOM)
+          Sidekiq::Web needs a valid Rack session. If this is a Rails app, make
+          sure you mount Sidekiq::Web *inside* your application routes:
+
+
+          Rails.application.routes.draw do
+            mount Sidekiq::Web => "/sidekiq"
+            ....
+          end
+
+
+          If this is a Rails app in API mode, you need to enable sessions.
+
+            https://guides.rubyonrails.org/api_app.html#using-session-middlewares
+
+          If this is a bare Rack app, use a session middleware before Sidekiq::Web:
+
+            # first, use IRB to create a shared secret key for sessions and commit it
+            require 'securerandom'; File.open(".session.key", "w") {|f| f.write(SecureRandom.hex(32)) }
+
+            # now use the secret with a session cookie middleware
+            use Rack::Session::Cookie, secret: File.read(".session.key"), same_site: true, max_age: 86400
+            run Sidekiq::Web
+
+        EOM
+      end
+
+      def logger
+        Sidekiq.logger
+      end
+
+      # flash { "Some message to show on redirect" }
+      def flash
+        msg = yield
+        logger.info msg
+        session[:skq_flash] = msg
+      end
+
+      def flash?
+        session&.[](:skq_flash)
+      end
+
+      def get_flash
+        @flash ||= session.delete(:skq_flash)
       end
 
       def erb(content, options = {})
         if content.is_a? Symbol
           unless respond_to?(:"_erb_#{content}")
             views = options[:views] || Web.views
-            filename = "#{views}/#{content}.erb"
+            filename = "#{views}/#{content}.html.erb"
             src = ERB.new(File.read(filename)).src
 
             # Need to use lineno less by 1 because erb generates a

data/lib/sidekiq/web/application.rb

@@ -318,6 +318,16 @@ module Sidekiq
         redirect_with_query("#{root_path}scheduled")
       end
 
+      post "/scheduled/all/delete" do
+        Sidekiq::ScheduledSet.new.clear
+        redirect "#{root_path}scheduled"
+      end
+
+      post "/scheduled/all/add_to_queue" do
+        Sidekiq::ScheduledSet.new.each(&:add_to_queue)
+        redirect "#{root_path}scheduled"
+      end
+
       get "/dashboard/stats" do
         redirect "#{root_path}stats"
       end
@@ -325,6 +335,8 @@ module Sidekiq
       get "/stats" do
         sidekiq_stats = Sidekiq::Stats.new
         redis_stats = redis_info.slice(*REDIS_KEYS)
+        redis_stats["store_name"] = store_name
+        redis_stats["store_version"] = store_version
         json(
           sidekiq: {
             processed: sidekiq_stats.processed,
@@ -360,10 +372,16 @@ module Sidekiq
         unless sid
           require "net/http"
           data = Sidekiq.redis { |c| c.hget(key, "data") }
-          resp = Net::HTTP.post(URI(store),
-            data,
-            {"Accept" => "application/vnd.firefox-profiler+json;version=1.0",
-             "User-Agent" => "Sidekiq #{Sidekiq::VERSION} job profiler"})
+
+          store_uri = URI(store)
+          http = Net::HTTP.new(store_uri.host, store_uri.port)
+          http.use_ssl = store_uri.scheme == "https"
+          request = Net::HTTP::Post.new(store_uri.request_uri)
+          request.body = data
+          request["Accept"] = "application/vnd.firefox-profiler+json;version=1.0"
+          request["User-Agent"] = "Sidekiq #{Sidekiq::VERSION} job profiler"
+
+          resp = http.request(request)
           # https://raw.githubusercontent.com/firefox-devtools/profiler-server/master/tools/decode_jwt_payload.py
           rawjson = resp.body.split(".")[1].unpack1("m")
           sid = Sidekiq.load_json(rawjson)["profileToken"]

data/lib/sidekiq/web/config.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "sidekiq/web/csrf_protection"
-
 module Sidekiq
   class Web
     ##
@@ -51,13 +49,15 @@ module Sidekiq
 
       # Adds the "Back to App" link in the header
       attr_accessor :app_url
+      attr_accessor :assets_path
 
       def initialize
         @options = OPTIONS.dup
         @locales = LOCALES
         @views = VIEWS
+        @assets_path = ASSETS
         @tabs = DEFAULT_TABS.dup
-        @middlewares = [Sidekiq::Web::CsrfProtection]
+        @middlewares = []
         @custom_job_info_rows = []
       end
 

data/lib/sidekiq/web/helpers.rb

@@ -2,7 +2,7 @@
 
 require "uri"
 require "yaml"
-require "cgi"
+require "cgi/escape"
 
 module Sidekiq
   # These methods are available to pages within the Web UI and UI extensions.
@@ -122,8 +122,8 @@ module Sidekiq
       resultset
     end
 
-    def filtering(which)
-      erb(:filtering, locals: {which: which})
+    def filtering(which, placeholder_key: "AnyJobContent", label_key: "Filter")
+      erb(:filtering, locals: {which:, placeholder_key:, label_key:})
     end
 
     def filter_link(jid, within = "retries")
@@ -165,7 +165,10 @@ module Sidekiq
       text_direction == "rtl"
     end
 
-    # See https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.4
+    # See https://www.rfc-editor.org/rfc/rfc9110.html#section-12.5.4
+    # Returns an array of language tags ordered by their quality value
+    #
+    # Inspiration taken from https://github.com/iain/http_accept_language/blob/master/lib/http_accept_language/parser.rb
     def user_preferred_languages
       languages = env["HTTP_ACCEPT_LANGUAGE"]
       languages.to_s.gsub(/\s+/, "").split(",").map { |language|
@@ -180,28 +183,30 @@ module Sidekiq
 
     # Given an Accept-Language header like "fr-FR,fr;q=0.8,en-US;q=0.6,en;q=0.4,ru;q=0.2"
     # this method will try to best match the available locales to the user's preferred languages.
-    #
-    # Inspiration taken from https://github.com/iain/http_accept_language/blob/master/lib/http_accept_language/parser.rb
     def locale
       # session[:locale] is set via the locale selector from the footer
       @locale ||= if (l = session&.fetch(:locale, nil)) && available_locales.include?(l)
         l
       else
+        matched_locale = nil
+        # Attempt to find a case-insensitive exact match first
+        user_preferred_languages.each do |preferred|
+          # We only care about the language and primary subtag
+          # "en-GB-oxendict" becomes "en-GB"
+          language_tag = preferred.split("-")[0..1].join("-")
+          matched_locale = available_locales.find { |available_locale| available_locale.casecmp?(language_tag) }
+          break if matched_locale
+        end
 
-        # exactly match with preferred like "pt-BR, zh-CN, zh-TW..." first
-        matched_locale = user_preferred_languages.find { |preferred|
-          available_locales.include?(preferred) if preferred.length == 5
-        }
-
-        matched_locale ||= user_preferred_languages.map { |preferred|
-          preferred_language = preferred.split("-", 2).first
-
-          lang_group = available_locales.select { |available|
-            preferred_language == available.split("-", 2).first
-          }
+        return matched_locale if matched_locale
 
-          lang_group.find { |lang| lang == preferred } || lang_group.min_by(&:length)
-        }.compact.first
+        # Find the first base language match
+        # "en-US,es-MX;q=0.9" matches "en"
+        user_preferred_languages.each do |preferred|
+          base_language = preferred.split("-", 2).first
+          matched_locale = available_locales.find { |available_locale| available_locale.casecmp?(base_language) }
+          break if matched_locale
+        end
 
         matched_locale || "en"
       end
@@ -251,14 +256,6 @@ module Sidekiq
       end
     end
 
-    def busy_weights(capsule_weights)
-      # backwards compat with 7.0.0, remove in 7.1
-      cw = [capsule_weights].flatten
-      cw.map { |hash|
-        hash.map { |name, weight| (weight > 0) ? +name << ": " << weight.to_s : name }.join(", ")
-      }.join("; ")
-    end
-
     def stats
       @stats ||= Sidekiq::Stats.new
     end
@@ -332,7 +329,7 @@ module Sidekiq
     end
 
     def csrf_tag
-      "<input type='hidden' name='authenticity_token' value='#{env[:csrf_token]}'/>"
+      ""
     end
 
     def csp_nonce
@@ -372,7 +369,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/lib/sidekiq/web.rb

@@ -13,7 +13,7 @@ module Sidekiq
     ROOT = File.expand_path("#{File.dirname(__FILE__)}/../../web")
     VIEWS = "#{ROOT}/views"
     LOCALES = ["#{ROOT}/locales"]
-    LAYOUT = "#{VIEWS}/layout.erb"
+    LAYOUT = "#{VIEWS}/layout.html.erb"
     ASSETS = "#{ROOT}/assets"
 
     DEFAULT_TABS = {
@@ -42,6 +42,12 @@ module Sidekiq
         @@config.app_url = url
       end
 
+      def assets_path=(path)
+        @@config.assets_path = path
+      end
+
+      def assets_path = @@config.assets_path
+
       def tabs = @@config.tabs
 
       def locales = @@config.locales
@@ -87,13 +93,27 @@ module Sidekiq
       env[:web_config] = Sidekiq::Web.configure
       env[:csp_nonce] = SecureRandom.hex(8)
       env[:redis_pool] = self.class.redis_pool
-      app.call(env)
+      safe_request?(env) ? app.call(env) : deny(env)
     end
 
     def app
       @app ||= build(@@config)
     end
 
+    def safe_methods?(env)
+      %w[GET HEAD OPTIONS TRACE].include? env["REQUEST_METHOD"]
+    end
+
+    def safe_request?(env)
+      return true if safe_methods?(env)
+      env["HTTP_SEC_FETCH_SITE"] == "same-origin"
+    end
+
+    def deny(env)
+      Sidekiq.logger.warn "attack prevented by #{self.class}"
+      [403, {Rack::CONTENT_TYPE => "text/plain"}, ["Forbidden"]]
+    end
+
     private
 
     def build(cfg)
@@ -105,7 +125,7 @@ module Sidekiq
 
       ::Rack::Builder.new do
         use Rack::Static, urls: ["/stylesheets", "/images", "/javascripts"],
-          root: ASSETS,
+          root: cfg.assets_path,
           cascade: true,
           header_rules: rules
         m.each { |middleware, block| use(*middleware, &block) }

data/lib/sidekiq.rb

@@ -29,6 +29,7 @@ end
 
 require "sidekiq/config"
 require "sidekiq/logger"
+require "sidekiq/loader"
 require "sidekiq/client"
 require "sidekiq/transaction_aware_client"
 require "sidekiq/job"
@@ -94,6 +95,10 @@ module Sidekiq
     default_configuration.logger
   end
 
+  def self.loader
+    @loader ||= Loader.new
+  end
+
   def self.configure_server(&block)
     (@config_blocks ||= []) << block
     yield default_configuration if server?

data/sidekiq.gemspec

@@ -23,9 +23,9 @@ Gem::Specification.new do |gem|
     "rubygems_mfa_required" => "true"
   }
 
-  gem.add_dependency "redis-client", ">= 0.23.2"
-  gem.add_dependency "connection_pool", ">= 2.5.0"
-  gem.add_dependency "rack", ">= 3.1.0"
-  gem.add_dependency "json", ">= 2.9.0"
-  gem.add_dependency "logger", ">= 1.6.2"
+  gem.add_dependency "redis-client", ">= 0.26.0"
+  gem.add_dependency "connection_pool", ">= 3.0.0"
+  gem.add_dependency "rack", ">= 3.2.0"
+  gem.add_dependency "json", ">= 2.16.0"
+  gem.add_dependency "logger", ">= 1.7.0"
 end

data/web/assets/javascripts/application.js

@@ -18,19 +18,11 @@ function addListeners() {
     })
   });
 
-  document.querySelectorAll("input[data-confirm]").forEach(node => {
-    node.addEventListener("click", event => {
-      if (!window.confirm(node.getAttribute("data-confirm"))) {
-        event.preventDefault();
-        event.stopPropagation();
-      }
-    })
-  })
-
   document.querySelectorAll("[data-toggle]").forEach(node => {
     node.addEventListener("click", addDataToggleListeners)
   })
 
+  initializeBulkToggle();
   addShiftClickListeners();
   updateFuzzyTimes();
   updateNumbers();
@@ -67,11 +59,26 @@ function addPollingListeners(_event)  {
 
 function addDataToggleListeners(event) {
   var source = event.target || event.srcElement;
-  var targName = source.getAttribute("data-toggle");
+  var targName = source.dataset.toggle;
   var full = document.getElementById(targName);
   full.classList.toggle("is-open");
 }
 
+function toggleBulkButtons() {
+  const checkboxes = document.querySelectorAll('.select-item-checkbox, .check-all-items');
+  const anyChecked = Array.from(checkboxes).some(cb => cb.checked);
+  const buttons = document.querySelectorAll('.bulk-action-buttons');
+  buttons.forEach(btn => {
+    btn.style.display = anyChecked ? 'none' : 'block';
+  });
+}
+
+function initializeBulkToggle(){
+  document.querySelectorAll('.check-all-items, .select-item-checkbox').forEach(cb => {
+    cb.addEventListener('change', toggleBulkButtons);
+  });
+}
+
 function addShiftClickListeners() {
   let checkboxes = Array.from(document.querySelectorAll(".shift_clickable"));
   let lastChecked = null;
@@ -90,7 +97,7 @@ function addShiftClickListeners() {
 }
 
 function updateFuzzyTimes() {
-  var locale = document.body.getAttribute("data-locale");
+  var locale = document.body.dataset.locale;
   var parts = locale.split('-');
   if (typeof parts[1] !== 'undefined') {
     parts[1] = parts[1].toUpperCase();
@@ -105,7 +112,7 @@ function updateFuzzyTimes() {
 function updateNumbers() {
   document.querySelectorAll("[data-nwp]").forEach(node => {
     let number = parseFloat(node.textContent);
-    let precision = parseInt(node.dataset["nwp"] || 0);
+    let precision = parseInt(node.dataset.nwp || 0);
     if (typeof number === "number") {
       let formatted = number.toLocaleString(undefined, {
         minimumFractionDigits: precision,
@@ -178,4 +185,20 @@ function updateLocale(event) {
 
 function updateProgressBars() {
   document.querySelectorAll('.progress-bar').forEach(bar => { bar.style.width = bar.dataset.width + "%"})
-}
+}
+
+function handleConfirmDialog (event) {
+  const target = event.target
+
+  if (target.localName !== "input" && target.localName !== "button" ) { return }
+  const confirmMessage = target.dataset.confirm
+
+  if (confirmMessage === undefined) { return }
+
+  if (!window.confirm(confirmMessage)) {
+    event.preventDefault()
+    event.stopPropagation()
+  }
+}
+
+document.addEventListener("click", handleConfirmDialog)

data/web/assets/javascripts/dashboard.js

@@ -11,7 +11,7 @@ var updateStatsSummary = function(data) {
 }
 
 var updateRedisStats = function(data) {
-  document.getElementById('redis_version').innerText = data.redis_version;
+  document.getElementById('redis_version').innerText = data.store_version;
   document.getElementById('uptime_in_days').innerText = data.uptime_in_days;
   document.getElementById('connected_clients').innerText = data.connected_clients;
   document.getElementById('used_memory_human').innerText = data.used_memory_human;

data/web/assets/stylesheets/style.css

@@ -29,8 +29,6 @@
 
 *, *::before, *::after { box-sizing: border-box; }
 
-::selection { background: var(--color-selected); }
-
 :focus-visible {
   outline: 1px solid oklch(from var(--color-primary) l c h / 50%);
 }
@@ -69,7 +67,7 @@ body {
 
 .container {
   margin: 0 auto;
-  max-width: 1440px;
+  /* max-width: 1440px; */
   padding: var(--space-2x);
 }
 
@@ -90,6 +88,7 @@ code {
   font-family: var(--font-mono);
   font-size: var(--font-size-small);
   padding: var(--space-1-2);
+  word-wrap: anywhere;
 }
 
 time { color: var(--color-text-light); }
@@ -437,7 +436,10 @@ article .count {
 }
 
 /* table */
-.table_container { overflow-x: auto; }
+.table_container {
+  overflow-x: auto;
+  margin-bottom: var(--space-2x);
+}
 
 .table_container + form,
 .table_container + input,
@@ -446,12 +448,14 @@ canvas + .table_container {
 }
 
 .buttons-row {
-  margin-top: var(--space-3x);
   display: flex;
-  flex-wrap: wrap;
   gap: 8px;
 }
 
+.bulk-action-buttons.bulk-lead-button {
+  margin-inline-start: auto;
+}
+
 table {
   background-color: var(--color-elevated);
   border: 1px solid var(--color-border);
@@ -748,3 +752,23 @@ body > footer .nav {
 .w-50 {
   width: 50%;
 }
+
+.flash {
+  width: 100%;
+  text-align: center;
+  padding: 20px;
+  background: var(--color-success);
+}
+
+.args {
+  overflow-y: auto;
+  max-height: 50px;
+  word-break: break-word
+} 
+.args-extended {
+  overflow-y: scroll;
+  max-height: 500px;
+}
+
+.toggle { display: none; }
+.toggle.is-open { display: block; }

data/web/locales/ar.yml

@@ -3,6 +3,7 @@ ar:
   LanguageName: العربية
   Actions: إجراءات
   AddToQueue: إضافة إلى الرتل
+  AddAllToQueue: إضافة الكل إلى الرتل
   AreYouSure: هل انت متأكد؟
   AreYouSureDeleteJob: هل أنت متأكد من حذف الوظيفة؟
   AreYouSureDeleteQueue: هل أنت متأكد من حذف الرتل %{queue}؟

data/web/locales/cs.yml

@@ -3,6 +3,7 @@ cs:
   LanguageName: Čeština
   Actions: Akce
   AddToQueue: Přidat do fronty
+  AddAllToQueue: Přidat vše do fronty
   AreYouSure: Jste si jisti?
   AreYouSureDeleteJob: Jste si jisti, že chcete odstranit tento úkol?
   AreYouSureDeleteQueue: Jste si jisti, že chcete odstranit frontu %{queue}?

data/web/locales/da.yml

@@ -3,6 +3,7 @@ da:
   LanguageName: Dansk
   Actions: Handlinger
   AddToQueue: Tilføj til kø
+  AddAllToQueue: Tilføj alle til kø
   AreYouSure: Er du sikker?
   AreYouSureDeleteJob: Er du sikker på at du vil slette dette job?
   AreYouSureDeleteQueue: Er du sikker på at du vil slette %{queue} køen?

data/web/locales/de.yml

@@ -3,6 +3,7 @@ de:
   LanguageName: Deutsch
   Actions: Aktionen
   AddToQueue: In Warteschlange einreihen
+  AddAllToQueue: Alle in Warteschlange einreihen
   AreYouSure: Bist du sicher?
   AreYouSureDeleteJob: Möchtest du diesen Job wirklich löschen?
   AreYouSureDeleteQueue: Möchtest du %{queue} wirklich löschen?

data/web/locales/el.yml

@@ -26,6 +26,7 @@ el: # <---- change this to your locale code
   ShowAll: Εμφάνιση Όλων
   Enqueued: Μπήκαν στην στοίβα
   AddToQueue: Προσθήκη στην στοίβα
+  AddAllToQueue: Προσθήκη όλων στην στοίβα
   AreYouSureDeleteJob: Θέλετε να διαγράψετε αυτή την εργασία;
   AreYouSureDeleteQueue: Θέλετε να διαγράψετε την στοίβα %{queue}; Αυτό θα διαγράψει όλες τις εργασίες εντός της στοίβας, θα εμφανιστεί ξανά εάν προωθήσετε περισσότερες εργασίες σε αυτήν στο μέλλον.
   Queues: Στοίβες