sidekiq 5.2.7 → 8.0.5

data/lib/sidekiq/web/helpers.rb

@@ -1,26 +1,96 @@
 # frozen_string_literal: true
-require 'uri'
-require 'set'
-require 'yaml'
-require 'cgi'
+
+require "uri"
+require "yaml"
+require "cgi/escape"
 
 module Sidekiq
-  # This is not a public API
+  # These methods are available to pages within the Web UI and UI extensions.
+  # They are not public APIs for applications to use.
   module WebHelpers
+    def store_name
+      hash = redis_info
+      return "Dragonfly" if hash.has_key?("dragonfly_version")
+      return "Valkey" if hash.has_key?("valkey_version")
+      "Redis"
+    end
+
+    def store_version
+      hash = redis_info
+      return hash["dragonfly_version"] if hash.has_key?("dragonfly_version")
+      return hash["valkey_version"] if hash.has_key?("valkey_version")
+      hash["redis_version"]
+    end
+
+    def style_tag(location, **kwargs)
+      global = location.match?(/:\/\//)
+      location = root_path + location if !global && !location.start_with?(root_path)
+      attrs = {
+        type: "text/css",
+        media: "screen",
+        rel: "stylesheet",
+        nonce: csp_nonce,
+        href: location
+      }
+      add_to_head do
+        html_tag(:link, attrs.merge(kwargs))
+      end
+    end
+
+    def script_tag(location, **kwargs)
+      global = location.match?(/:\/\//)
+      location = root_path + location if !global && !location.start_with?(root_path)
+      attrs = {
+        type: "text/javascript",
+        nonce: csp_nonce,
+        src: location
+      }
+      html_tag(:script, attrs.merge(kwargs)) {}
+    end
+
+    # NB: keys and values are not escaped; do not allow user input
+    # in the attributes
+    private def html_tag(tagname, attrs)
+      s = "<#{tagname}"
+      attrs.each_pair do |k, v|
+        next unless v
+        s << " #{k}=\"#{v}\""
+      end
+      if block_given?
+        s << ">"
+        yield s
+        s << "</#{tagname}>"
+      else
+        s << " />"
+      end
+      s
+    end
+
     def strings(lang)
       @@strings ||= {}
-      @@strings[lang] ||= begin
-        # Allow sidekiq-web extensions to add locale paths
-        # so extensions can be localized
-        settings.locales.each_with_object({}) do |path, global|
-          find_locale_files(lang).each do |file|
-            strs = YAML.load(File.open(file))
-            global.merge!(strs[lang])
-          end
+
+      # Allow sidekiq-web extensions to add locale paths
+      # so extensions can be localized
+      @@strings[lang] ||= config.locales.each_with_object({}) do |path, global|
+        find_locale_files(lang).each do |file|
+          strs = YAML.safe_load_file(file)
+          global.merge!(strs[lang])
         end
       end
     end
 
+    def to_json(x)
+      Sidekiq.dump_json(x)
+    end
+
+    def singularize(str, count)
+      if count == 1 && str.respond_to?(:singularize) # rails
+        str.singularize
+      else
+        str
+      end
+    end
+
     def clear_caches
       @@strings = nil
       @@locale_files = nil
@@ -28,21 +98,46 @@ module Sidekiq
     end
 
     def locale_files
-      @@locale_files ||= settings.locales.flat_map do |path|
+      @@locale_files ||= config.locales.flat_map { |path|
         Dir["#{path}/*.yml"]
-      end
+      }
     end
 
     def available_locales
-      @@available_locales ||= locale_files.map { |path| File.basename(path, '.yml') }.uniq
+      @@available_locales ||= Set.new(locale_files.map { |path| File.basename(path, ".yml") })
     end
 
     def find_locale_files(lang)
       locale_files.select { |file| file =~ /\/#{lang}\.yml$/ }
     end
 
-    # This is a hook for a Sidekiq Pro feature.  Please don't touch.
-    def filtering(*)
+    def language_name(locale)
+      strings(locale).fetch("LanguageName", locale)
+    end
+
+    def search(jobset, substr)
+      resultset = jobset.scan(substr).to_a
+      @current_page = 1
+      @count = @total_size = resultset.size
+      resultset
+    end
+
+    def filtering(which)
+      erb(:filtering, locals: {which: which})
+    end
+
+    def filter_link(jid, within = "retries")
+      if within.nil?
+        ::Rack::Utils.escape_html(jid)
+      else
+        "<a href='#{root_path}#{within}?substr=#{jid}'>#{::Rack::Utils.escape_html(jid)}</a>"
+      end
+    end
+
+    def display_tags(job, within = "retries")
+      job.tags.map { |tag|
+        "<span class='label label-info jobtag jobtag-#{Rack::Utils.escape_html(tag)}'>#{filter_link(tag, within)}</span>"
+      }.join(" ")
     end
 
     # This view helper provide ability display you html code in
@@ -62,66 +157,73 @@ module Sidekiq
       @head_html.join if defined?(@head_html)
     end
 
-    def poll_path
-      if current_path != '' && params['poll']
-        root_path + current_path
-      else
-        ""
-      end
-    end
-
     def text_direction
-      get_locale['TextDirection'] || 'ltr'
+      get_locale["TextDirection"] || "ltr"
     end
 
     def rtl?
-      text_direction == 'rtl'
+      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.downcase.gsub(/\s+/, '').split(',').map do |language|
-        locale, quality = language.split(';q=', 2)
-        locale  = nil if locale == '*' # Ignore wildcards
+      languages = env["HTTP_ACCEPT_LANGUAGE"]
+      languages.to_s.gsub(/\s+/, "").split(",").map { |language|
+        locale, quality = language.split(";q=", 2)
+        locale = nil if locale == "*" # Ignore wildcards
         quality = quality ? quality.to_f : 1.0
         [locale, quality]
-      end.sort do |(_, left), (_, right)|
+      }.sort { |(_, left), (_, right)|
         right <=> left
-      end.map(&:first).compact
+      }.map(&:first).compact
     end
 
     # 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
-      @locale ||= begin
-        matched_locale = user_preferred_languages.map do |preferred|
-          preferred_language = preferred.split('-', 2).first
+      # 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
 
-          lang_group = available_locales.select do |available|
-            preferred_language == available.split('-', 2).first
-          end
+        return matched_locale if matched_locale
 
-          lang_group.find { |lang| lang == preferred } || lang_group.min_by(&:length)
-        end.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'
+        matched_locale || "en"
       end
     end
 
-    # mperham/sidekiq#3243
+    # sidekiq/sidekiq#3243
     def unfiltered?
-      yield unless env['PATH_INFO'].start_with?("/filter/")
+      s = url_params("substr")
+      yield unless s && s.size > 0
     end
 
     def get_locale
       strings(locale)
     end
 
-    def t(msg, options={})
-      string = get_locale[msg] || strings('en')[msg] || msg
+    def t(msg, options = {})
+      string = get_locale[msg] || strings("en")[msg] || msg
       if options.empty?
         string
       else
@@ -129,118 +231,135 @@ module Sidekiq
       end
     end
 
-    def workers
-      @workers ||= Sidekiq::Workers.new
+    def sort_direction_label
+      (url_params("direction") == "asc") ? "&uarr;" : "&darr;"
+    end
+
+    def workset
+      @work ||= Sidekiq::WorkSet.new
     end
 
     def processes
       @processes ||= Sidekiq::ProcessSet.new
     end
 
-    def stats
-      @stats ||= Sidekiq::Stats.new
+    # Sorts processes by hostname following the natural sort order
+    def sorted_processes
+      @sorted_processes ||= begin
+        return processes unless processes.all? { |p| p["hostname"] }
+
+        processes.to_a.sort_by do |process|
+          # Kudos to `shurikk` on StackOverflow
+          # https://stackoverflow.com/a/15170063/575547
+          process["hostname"].split(/(\d+)/).map { |a| /\d+/.match?(a) ? a.to_i : a }
+        end
+      end
     end
 
-    def retries_with_score(score)
-      Sidekiq.redis do |conn|
-        conn.zrangebyscore('retry', score, score)
-      end.map { |msg| Sidekiq.load_json(msg) }
+    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 redis_connection
-      Sidekiq.redis do |conn|
-        c = conn.connection
-        "redis://#{c[:location]}/#{c[:db]}"
-      end
+    def stats
+      @stats ||= Sidekiq::Stats.new
     end
 
-    def namespace
-      @ns ||= Sidekiq.redis { |conn| conn.respond_to?(:namespace) ? conn.namespace : nil }
+    def redis_url
+      Sidekiq.redis do |conn|
+        conn.config.server_url
+      end
     end
 
     def redis_info
-      Sidekiq.redis_info
+      @info ||= Sidekiq.default_configuration.redis_info
     end
 
     def root_path
-      "#{env['SCRIPT_NAME']}/"
+      "#{env["SCRIPT_NAME"]}/"
     end
 
     def current_path
-      @current_path ||= request.path_info.gsub(/^\//,'')
+      @current_path ||= request.path_info.gsub(/^\//, "")
     end
 
     def current_status
-      workers.size == 0 ? 'idle' : 'active'
+      (workset.size == 0) ? "idle" : "active"
     end
 
     def relative_time(time)
       stamp = time.getutc.iso8601
-      %{<time class="ltr" dir="ltr" title="#{stamp}" datetime="#{stamp}">#{time}</time>}
+      %(<time class="ltr" dir="ltr" title="#{stamp}" datetime="#{stamp}">#{time}</time>)
     end
 
     def job_params(job, score)
-      "#{score}-#{job['jid']}"
+      "#{score}-#{job["jid"]}"
     end
 
-    def parse_params(params)
-      score, jid = params.split("-", 2)
+    def parse_key(key)
+      score, jid = key.split("-", 2)
       [score.to_f, jid]
     end
 
-    SAFE_QPARAMS = %w(page poll)
+    SAFE_QPARAMS = %w[page direction]
 
     # Merge options with current params, filter safe params, and stringify to query string
     def qparams(options)
-      # stringify
-      options.keys.each do |key|
-        options[key.to_s] = options.delete(key)
-      end
+      stringified_options = options.transform_keys(&:to_s)
+
+      to_query_string(request.params.merge(stringified_options))
+    end
 
-      params.merge(options).map do |key, value|
+    def to_query_string(hash)
+      hash.map { |key, value|
         SAFE_QPARAMS.include?(key) ? "#{key}=#{CGI.escape(value.to_s)}" : next
-      end.compact.join("&")
+      }.compact.join("&")
     end
 
     def truncate(text, truncate_after_chars = 2000)
-      truncate_after_chars && text.size > truncate_after_chars ? "#{text[0..truncate_after_chars]}..." : text
+      (truncate_after_chars && text.size > truncate_after_chars) ? "#{text[0..truncate_after_chars]}..." : text
     end
 
     def display_args(args, truncate_after_chars = 2000)
-      return "Invalid job payload, args is nil" if args == nil
-      return "Invalid job payload, args must be an Array, not #{args.class.name}" if !args.is_a?(Array)
+      return "Invalid job payload, args is nil" if args.nil?
+      return "Invalid job payload, args must be an Array, not #{args.class.name}" unless args.is_a?(Array)
 
       begin
-        args.map do |arg|
+        args.map { |arg|
           h(truncate(to_display(arg), truncate_after_chars))
-        end.join(", ")
+        }.join(", ")
       rescue
         "Illegal job arguments: #{h args.inspect}"
       end
     end
 
     def csrf_tag
-      "<input type='hidden' name='authenticity_token' value='#{session[:csrf]}'/>"
+      "<input type='hidden' name='authenticity_token' value='#{env[:csrf_token]}'/>"
+    end
+
+    def csp_nonce
+      env[:csp_nonce]
     end
 
     def to_display(arg)
+      arg.inspect
+    rescue
       begin
-        arg.inspect
-      rescue
-        begin
-          arg.to_s
-        rescue => ex
-          "Cannot display argument: [#{ex.class.name}] #{ex.message}"
-        end
+        arg.to_s
+      rescue => ex
+        "Cannot display argument: [#{ex.class.name}] #{ex.message}"
       end
     end
 
-    RETRY_JOB_KEYS = Set.new(%w(
+    RETRY_JOB_KEYS = Set.new(%w[
       queue class args retry_count retried_at failed_at
       jid error_message error_class backtrace
       error_backtrace enqueued_at retry wrapped
-      created_at
-    ))
+      created_at tags display_class
+    ])
 
     def retry_extra_items(retry_job)
       @retry_extra_items ||= {}.tap do |extra|
@@ -250,24 +369,28 @@ module Sidekiq
       end
     end
 
-    def number_with_delimiter(number)
-      begin
-        Float(number)
-      rescue ArgumentError, TypeError
-        return number
+    def format_memory(rss_kb)
+      return "0" if rss_kb.nil? || rss_kb == 0
+
+      if rss_kb < 100_000
+        "#{number_with_delimiter(rss_kb)} KB"
+      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"
       end
+    end
 
-      options = {delimiter: ',', separator: '.'}
-      parts = number.to_s.to_str.split('.')
-      parts[0].gsub!(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1#{options[:delimiter]}")
-      parts.join(options[:separator])
+    def number_with_delimiter(number, options = {})
+      precision = options[:precision] || 0
+      %(<span data-nwp="#{precision}">#{number.round(precision)}</span>)
     end
 
     def h(text)
-      ::Rack::Utils.escape_html(text)
+      ::Rack::Utils.escape_html(text.to_s)
     rescue ArgumentError => e
-      raise unless e.message.eql?('invalid byte sequence in UTF-8')
-      text.encode!('UTF-16', 'UTF-8', invalid: :replace, replace: '').encode!('UTF-8', 'UTF-16')
+      raise unless e.message.eql?("invalid byte sequence in UTF-8")
+      text.encode!("UTF-16", "UTF-8", invalid: :replace, replace: "").encode!("UTF-8", "UTF-16")
       retry
     end
 
@@ -284,7 +407,7 @@ module Sidekiq
     end
 
     def environment_title_prefix
-      environment = Sidekiq.options[:environment] || ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'
+      environment = Sidekiq.default_configuration[:environment] || ENV["APP_ENV"] || ENV["RAILS_ENV"] || ENV["RACK_ENV"] || "development"
 
       "[#{environment.upcase}] " unless environment == "production"
     end
@@ -294,30 +417,28 @@ module Sidekiq
     end
 
     def server_utc_time
-      Time.now.utc.strftime('%H:%M:%S UTC')
+      Time.now.utc.strftime("%H:%M:%S UTC")
     end
 
-    def redis_connection_and_namespace
-      @redis_connection_and_namespace ||= begin
-        namespace_suffix = namespace == nil ? '' : "##{namespace}"
-        "#{redis_connection}#{namespace_suffix}"
-      end
+    def pollable?
+      # there's no point to refreshing the metrics pages every N seconds
+      !(current_path == "" || current_path.index("metrics"))
     end
 
     def retry_or_delete_or_kill(job, params)
-      if params['retry']
+      if params["retry"]
         job.retry
-      elsif params['delete']
+      elsif params["delete"]
         job.delete
-      elsif params['kill']
+      elsif params["kill"]
         job.kill
       end
     end
 
     def delete_or_add_queue(job, params)
-      if params['delete']
+      if params["delete"]
         job.delete
-      elsif params['add_to_queue']
+      elsif params["add_to_queue"]
         job.add_to_queue
       end
     end