sidekiq 7.3.9 → 8.1.7

data/lib/sidekiq/web.rb

@@ -2,27 +2,18 @@
 
 require "erb"
 require "securerandom"
-
-require "sidekiq"
-require "sidekiq/api"
-require "sidekiq/paginator"
-require "sidekiq/web/helpers"
-
-require "sidekiq/web/router"
-require "sidekiq/web/action"
-require "sidekiq/web/application"
-require "sidekiq/web/csrf_protection"
-
-require "rack/content_length"
 require "rack/builder"
 require "rack/static"
+require "sidekiq"
+require "sidekiq/api"
+require "sidekiq/web/config"
 
 module Sidekiq
   class Web
     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 = {
@@ -32,195 +23,118 @@ module Sidekiq
       "Retries" => "retries",
       "Scheduled" => "scheduled",
       "Dead" => "morgue",
-      "Metrics" => "metrics"
+      "Metrics" => "metrics",
+      "Profiles" => "profiles"
     }
 
-    if Gem::Version.new(Rack::RELEASE) < Gem::Version.new("3")
-      CONTENT_LANGUAGE = "Content-Language"
-      CONTENT_SECURITY_POLICY = "Content-Security-Policy"
-      LOCATION = "Location"
-      X_CASCADE = "X-Cascade"
-      X_CONTENT_TYPE_OPTIONS = "X-Content-Type-Options"
-    else
-      CONTENT_LANGUAGE = "content-language"
-      CONTENT_SECURITY_POLICY = "content-security-policy"
-      LOCATION = "location"
-      X_CASCADE = "x-cascade"
-      X_CONTENT_TYPE_OPTIONS = "x-content-type-options"
-    end
+    @@config = Sidekiq::Web::Config.new
 
     class << self
-      # Forward compatibility with 8.0
       def configure
-        yield self
+        if block_given?
+          yield @@config
+        else
+          @@config
+        end
       end
 
-      def settings
-        self
+      def app_url=(url)
+        @@config.app_url = url
       end
 
-      def default_tabs
-        DEFAULT_TABS
+      def assets_path=(path)
+        @@config.assets_path = path
       end
 
-      def custom_tabs
-        @custom_tabs ||= {}
-      end
-      alias_method :tabs, :custom_tabs
+      def assets_path = @@config.assets_path
 
-      def custom_job_info_rows
-        @custom_job_info_rows ||= []
-      end
-
-      def locales
-        @locales ||= LOCALES
-      end
+      def tabs = @@config.tabs
 
-      def views
-        @views ||= VIEWS
-      end
+      def locales = @@config.locales
 
-      def enable(*opts)
-        opts.each { |key| set(key, true) }
-      end
+      def views = @@config.views
 
-      def disable(*opts)
-        opts.each { |key| set(key, false) }
-      end
+      def custom_job_info_rows = @@config.custom_job_info_rows
 
-      def middlewares
-        @middlewares ||= []
+      def redis_pool
+        @pool || Sidekiq.default_configuration.redis_pool
       end
 
-      def use(*args, &block)
-        middlewares << [args, block]
+      def redis_pool=(pool)
+        @pool = pool
       end
 
-      def set(attribute, value)
-        send(:"#{attribute}=", value)
-      end
+      def middlewares = @@config.middlewares
 
-      attr_accessor :app_url, :redis_pool
-      attr_writer :locales, :views
-    end
+      def use(*args, &block) = @@config.middlewares << [args, block]
 
-    def self.inherited(child)
-      child.app_url = app_url
-      child.redis_pool = redis_pool
-    end
-
-    def settings
-      self.class.settings
+      def register(*args, **kw, &block)
+        Sidekiq.logger.warn { "`Sidekiq::Web.register` is deprecated, use `Sidekiq::Web.configure {|cfg| cfg.register(...) }`" }
+        @@config.register(*args, **kw, &block)
+      end
     end
 
-    def middlewares
-      @middlewares ||= self.class.middlewares
+    # Allow user to say
+    #   run Sidekiq::Web
+    # rather than:
+    #   run Sidekiq::Web.new
+    def self.call(env)
+      @inst ||= new
+      @inst.call(env)
     end
 
-    def use(*args, &block)
-      middlewares << [args, block]
+    # testing, internal use only
+    def self.reset!
+      @@config.reset!
+      @inst = nil
     end
 
     def call(env)
-      env[:csp_nonce] = SecureRandom.base64(16)
-      app.call(env)
-    end
-
-    def self.call(env)
-      @app ||= new
-      @app.call(env)
+      env[:web_config] = Sidekiq::Web.configure
+      env[:csp_nonce] = SecureRandom.hex(8)
+      env[:redis_pool] = self.class.redis_pool
+      safe_request?(env) ? app.call(env) : deny(env)
     end
 
     def app
-      @app ||= build
+      @app ||= build(@@config)
     end
 
-    def enable(*opts)
-      opts.each { |key| set(key, true) }
+    def safe_methods?(env)
+      %w[GET HEAD OPTIONS TRACE].include? env["REQUEST_METHOD"]
     end
 
-    def disable(*opts)
-      opts.each { |key| set(key, false) }
+    def safe_request?(env)
+      return true if safe_methods?(env)
+      env["HTTP_SEC_FETCH_SITE"] == "same-origin"
     end
 
-    def set(attribute, value)
-      send(:"#{attribute}=", value)
-    end
-
-    # Register a class as a Sidekiq Web UI extension. The class should
-    # provide one or more tabs which map to an index route. Options:
-    #
-    # @param extension [Class] Class which contains the HTTP actions, required
-    # @param name [String] the name of the extension, used to namespace assets
-    # @param tab [String | Array] labels(s) of the UI tabs
-    # @param index [String | Array] index route(s) for each tab
-    # @param root_dir [String] directory location to find assets, locales and views, typically `web/` within the gemfile
-    # @param asset_paths [Array] one or more directories under {root}/assets/{name} to be publicly served, e.g. ["js", "css", "img"]
-    # @param cache_for [Integer] amount of time to cache assets, default one day
-    #
-    # TODO name, tab and index will be mandatory in 8.0
-    #
-    # Web extensions will have a root `web/` directory with `locales/`, `assets/`
-    # and `views/` subdirectories.
-    def self.register(extension, name: nil, tab: nil, index: nil, root_dir: nil, cache_for: 86400, asset_paths: nil)
-      tab = Array(tab)
-      index = Array(index)
-      tab.zip(index).each do |tab, index|
-        tabs[tab] = index
-      end
-      if root_dir
-        locdir = File.join(root_dir, "locales")
-        locales << locdir if File.directory?(locdir)
-
-        if asset_paths && name
-          # if you have {root}/assets/{name}/js/scripts.js
-          # and {root}/assets/{name}/css/styles.css
-          # you would pass in:
-          #   asset_paths: ["js", "css"]
-          # See script_tag and style_tag in web/helpers.rb
-          assdir = File.join(root_dir, "assets")
-          assurls = Array(asset_paths).map { |x| "/#{name}/#{x}" }
-          assetprops = {
-            urls: assurls,
-            root: assdir,
-            cascade: true
-          }
-          assetprops[:header_rules] = [[:all, {Rack::CACHE_CONTROL => "private, max-age=#{cache_for.to_i}"}]] if cache_for
-          middlewares << [[Rack::Static, assetprops], nil]
-        end
-      end
-
-      yield self if block_given?
-      extension.registered(WebApplication)
+    def deny(env)
+      Sidekiq.logger.warn "attack prevented by #{self.class}"
+      [403, {Rack::CONTENT_TYPE => "text/plain"}, ["Forbidden"]]
     end
 
     private
 
-    def build
-      klass = self.class
-      m = middlewares
+    def build(cfg)
+      cfg.freeze
+      m = cfg.middlewares
 
       rules = []
-      rules = [[:all, {Rack::CACHE_CONTROL => "private, max-age=86400"}]] unless ENV["SIDEKIQ_WEB_TESTING"]
+      rules = [[:all, {"cache-control" => "private, max-age=86400"}]] unless ENV["SIDEKIQ_WEB_TESTING"]
 
       ::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) }
-        use Sidekiq::Web::CsrfProtection unless $TESTING
-        run WebApplication.new(klass)
+        run Sidekiq::Web::Application.new(self.class)
       end
     end
   end
-
-  Sidekiq::WebApplication.helpers WebHelpers
-  Sidekiq::WebApplication.helpers Sidekiq::Paginator
-
-  Sidekiq::WebAction.class_eval <<-RUBY, Web::LAYOUT, -1 # standard:disable Style/EvalWithLocation
-    def _render
-      #{ERB.new(File.read(Web::LAYOUT)).src}
-    end
-  RUBY
 end
+
+require "sidekiq/web/router"
+require "sidekiq/web/action"
+require "sidekiq/web/application"

data/lib/sidekiq.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require "sidekiq/version"
-fail "Sidekiq #{Sidekiq::VERSION} does not support Ruby versions below 2.7.0." if RUBY_PLATFORM != "java" && Gem::Version.new(RUBY_VERSION) < Gem::Version.new("2.7.0")
+fail "Sidekiq #{Sidekiq::VERSION} does not support Ruby versions below 3.2.0." if RUBY_PLATFORM != "java" && Gem::Version.new(RUBY_VERSION) < Gem::Version.new("3.2.0")
 
 begin
   require "sidekiq-ent/version"
@@ -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"
@@ -46,6 +47,13 @@ module Sidekiq
     puts "Take a deep breath and count to ten..."
   end
 
+  def self.testing!(mode = :fake, &block)
+    raise "Unknown testing mode: #{mode}" unless %i[fake disable inline].include?(mode)
+
+    require "sidekiq/test_api"
+    Sidekiq::Testing.__set_test_mode(mode, &block)
+  end
+
   def self.server?
     defined?(Sidekiq::CLI)
   end
@@ -94,6 +102,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

@@ -8,11 +8,11 @@ Gem::Specification.new do |gem|
   gem.homepage = "https://sidekiq.org"
   gem.license = "LGPL-3.0"
 
-  gem.executables = ["sidekiq", "sidekiqmon"]
+  gem.executables = ["sidekiq", "sidekiqmon", "kiq"]
   gem.files = %w[sidekiq.gemspec README.md Changes.md LICENSE.txt] + `git ls-files | grep -E '^(bin|lib|web)'`.split("\n")
   gem.name = "sidekiq"
   gem.version = Sidekiq::VERSION
-  gem.required_ruby_version = ">= 2.7.0"
+  gem.required_ruby_version = ">= 3.2.0"
 
   gem.metadata = {
     "homepage_uri" => "https://sidekiq.org",
@@ -20,12 +20,13 @@ Gem::Specification.new do |gem|
     "documentation_uri" => "https://github.com/sidekiq/sidekiq/wiki",
     "changelog_uri" => "https://github.com/sidekiq/sidekiq/blob/main/Changes.md",
     "source_code_uri" => "https://github.com/sidekiq/sidekiq",
-    "rubygems_mfa_required" => "true"
+    "rubygems_mfa_required" => "true",
+    "mailing_list_uri" => "https://www.rubyforum.org/tag/sidekiq"
   }
 
-  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 "logger"
-  gem.add_dependency "base64"
+  gem.add_dependency "redis-client", ">= 0.29.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,20 +18,12 @@ 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)
   })
 
-  addShiftClickListeners()
+  initializeBulkToggle();
+  addShiftClickListeners();
   updateFuzzyTimes();
   updateNumbers();
   updateProgressBars();
@@ -67,13 +59,24 @@ 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);
-  if (full.style.display == "block") {
-    full.style.display = 'none';
-  } else {
-    full.style.display = 'block';
-  }
+  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() {
@@ -94,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();
@@ -109,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,
@@ -130,11 +133,11 @@ function setLivePollFromUrl() {
 
 function updateLivePollButton() {
   if (localStorage.sidekiqLivePoll == "enabled") {
-    document.querySelectorAll('.live-poll-stop').forEach(box => { box.style.display = "inline-block" })
-    document.querySelectorAll('.live-poll-start').forEach(box => { box.style.display = "none" })
+    document.querySelectorAll('.live-poll-stop').forEach(box => { box.classList.add("active") })
+    document.querySelectorAll('.live-poll-start').forEach(box => { box.classList.remove("active") })
   } else {
-    document.querySelectorAll('.live-poll-start').forEach(box => { box.style.display = "inline-block" })
-    document.querySelectorAll('.live-poll-stop').forEach(box => { box.style.display = "none" })
+    document.querySelectorAll('.live-poll-start').forEach(box => { box.classList.add("active") })
+    document.querySelectorAll('.live-poll-stop').forEach(box => { box.classList.remove("active") })
   }
 }
 
@@ -151,7 +154,7 @@ function livePollCallback() {
 
 function checkResponse(resp) {
   if (!resp.ok) {
-    throw response.error();
+    throw resp.error();
   }
   return resp
 }
@@ -169,9 +172,6 @@ function replacePage(text) {
   var page = doc.querySelector('#page')
   document.querySelector("#page").replaceWith(page)
 
-  var header_status = doc.querySelector('.status')
-  document.querySelector('.status').replaceWith(header_status)
-
   addListeners();
 }
 
@@ -185,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/base-charts.js

@@ -1,27 +1,35 @@
 if (window.matchMedia("(prefers-color-scheme: dark)").matches) {
   Chart.defaults.borderColor = "#333";
   Chart.defaults.color = "#aaa";
+  // Chart.defaults.borderColor = "oklch(22% 0.01 256)";
+  // Chart.defaults.color = "oklch(65% 0.01 256)";
 }
 
 class Colors {
   constructor() {
     this.assignments = {};
-    this.success = "#006f68";
-    this.failure = "#af0014";
-    this.fallback = "#999";
-    this.primary = "#537bc4";
+    if (window.matchMedia("(prefers-color-scheme: dark)").matches) {
+      this.light = "65%";
+      this.chroma = "0.15";
+    } else {
+      this.light = "48%";
+      this.chroma = "0.2";
+    }
+    this.success = "oklch(" + this.light + " " + this.chroma + " 179)";
+    this.failure = "oklch(" + this.light + " " + this.chroma + " 29)";
+    this.fallback = "oklch(" + this.light + " 0.02 269)";
+    this.primary = "oklch(" + this.light + " " + this.chroma + " 269)";
     this.available = [
-      // Colors taken from https://www.chartjs.org/docs/latest/samples/utils.html
-      "#537bc4",
-      "#4dc9f6",
-      "#f67019",
-      "#f53794",
-      "#acc236",
-      "#166a8f",
-      "#00a950",
-      "#58595b",
-      "#8549ba",
-      "#991b1b",
+      "oklch(" + this.light + " " + this.chroma + " 256)",
+      "oklch(" + this.light + " " + this.chroma + " 196)",
+      "oklch(" + this.light + " " + this.chroma + " 46)",
+      "oklch(" + this.light + " " + this.chroma + " 316)",
+      "oklch(" + this.light + " " + this.chroma + " 106)",
+      "oklch(" + this.light + " " + this.chroma + " 226)",
+      "oklch(" + this.light + " " + this.chroma + " 136)",
+      "oklch(" + this.light + " 0.02 269)",
+      "oklch(" + this.light + " " + this.chroma + " 286)",
+      "oklch(" + this.light + " " + this.chroma + " 16)",
     ];
   }
 
@@ -90,12 +98,18 @@ class BaseChart {
     };
 
     if (this.options.marks) {
+      if (window.matchMedia("(prefers-color-scheme: dark)").matches) {
+        this.Borderlight = "30%";
+      } else {
+        this.Borderlight = "65%";
+      }
+
       this.options.marks.forEach(([bucket, label], i) => {
         chartOptions.plugins.annotation.annotations[`deploy-${i}`] = {
           type: "line",
           xMin: bucket,
           xMax: bucket,
-          borderColor: "rgba(220, 38, 38, 0.4)",
+          borderColor: "oklch(" + this.Borderlight + " 0.01 256)",
           borderWidth: 2,
         };
       });