sidekiq 4.2.4 → 6.4.0

data/lib/sidekiq/web/helpers.rb

@@ -1,33 +1,48 @@
 # frozen_string_literal: true
-require 'uri'
-require 'yaml'
+
+require "uri"
+require "set"
+require "yaml"
+require "cgi"
 
 module Sidekiq
   # This is not a public API
   module WebHelpers
     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.deep_merge!(strs[lang])
-          end
+      @strings ||= {}
+
+      # Allow sidekiq-web extensions to add locale paths
+      # so extensions can be localized
+      @strings[lang] ||= 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
       end
     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
+      @strings = nil
+      @locale_files = nil
+      @available_locales = nil
     end
 
     def locale_files
-      @@locale_files ||= settings.locales.flat_map do |path|
+      @locale_files ||= settings.locales.flat_map { |path|
         Dir["#{path}/*.yml"]
-      end
+      }
+    end
+
+    def available_locales
+      @available_locales ||= locale_files.map { |path| File.basename(path, ".yml") }.uniq
     end
 
     def find_locale_files(lang)
@@ -55,37 +70,65 @@ module Sidekiq
       @head_html.join if defined?(@head_html)
     end
 
-    def poll_path
-      if current_path != '' && params['poll']
-        root_path + current_path
-      else
-        ""
-      end
+    def text_direction
+      get_locale["TextDirection"] || "ltr"
     end
 
-    # Given a browser request Accept-Language header like
-    # "fr-FR,fr;q=0.8,en-US;q=0.6,en;q=0.4,ru;q=0.2", this function
-    # will return "fr" since that's the first code with a matching
-    # locale in web/locales
+    def rtl?
+      text_direction == "rtl"
+    end
+
+    # See https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.4
+    def user_preferred_languages
+      languages = env["HTTP_ACCEPT_LANGUAGE"]
+      languages.to_s.downcase.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]
+      }.sort { |(_, left), (_, right)|
+        right <=> left
+      }.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
-        locale = 'en'.freeze
-        languages = env['HTTP_ACCEPT_LANGUAGE'.freeze] || 'en'.freeze
-        languages.downcase.split(','.freeze).each do |lang|
-          next if lang == '*'.freeze
-          lang = lang.split(';'.freeze)[0]
-          break locale = lang if find_locale_files(lang).any?
-        end
-        locale
+        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
+          }
+
+          lang_group.find { |lang| lang == preferred } || lang_group.min_by(&:length)
+        }.compact.first
+
+        matched_locale || "en"
       end
     end
 
+    # within is used by Sidekiq Pro
+    def display_tags(job, within = nil)
+      job.tags.map { |tag|
+        "<span class='label label-info jobtag'>#{::Rack::Utils.escape_html(tag)}</span>"
+      }.join(" ")
+    end
+
+    # mperham/sidekiq#3243
+    def unfiltered?
+      yield unless env["PATH_INFO"].start_with?("/filter/")
+    end
+
     def get_locale
       strings(locale)
     end
 
-    def t(msg, options={})
-      string = get_locale[msg] || msg
+    def t(msg, options = {})
+      string = get_locale[msg] || strings("en")[msg] || msg
       if options.empty?
         string
       else
@@ -93,6 +136,10 @@ module Sidekiq
       end
     end
 
+    def sort_direction_label
+      params[:direction] == "asc" ? "&uarr;" : "&darr;"
+    end
+
     def workers
       @workers ||= Sidekiq::Workers.new
     end
@@ -105,22 +152,14 @@ module Sidekiq
       @stats ||= Sidekiq::Stats.new
     end
 
-    def retries_with_score(score)
-      Sidekiq.redis do |conn|
-        conn.zrangebyscore('retry', score, score)
-      end.map { |msg| Sidekiq.load_json(msg) }
-    end
-
-    def location
-      Sidekiq.redis { |conn| conn.client.location }
-    end
-
     def redis_connection
-      Sidekiq.redis { |conn| conn.client.id }
+      Sidekiq.redis do |conn|
+        conn.connection[:id]
+      end
     end
 
     def namespace
-      @@ns ||= Sidekiq.redis { |conn| conn.respond_to?(:namespace) ? conn.namespace : nil }
+      @ns ||= Sidekiq.redis { |conn| conn.respond_to?(:namespace) ? conn.namespace : nil }
     end
 
     def redis_info
@@ -128,38 +167,44 @@ module Sidekiq
     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'
+      workers.size == 0 ? "idle" : "active"
     end
 
     def relative_time(time)
-      %{<time datetime="#{time.getutc.iso8601}">#{time}</time>}
+      stamp = time.getutc.iso8601
+      %(<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("-")
+      score, jid = params.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)
-      options = options.stringify_keys
-      params.merge(options).map do |key, value|
-        SAFE_QPARAMS.include?(key) ? "#{key}=#{value}" : next
-      end.compact.join("&")
+      stringified_options = options.transform_keys(&:to_s)
+
+      to_query_string(params.merge(stringified_options))
+    end
+
+    def to_query_string(params)
+      params.map { |key, value|
+        SAFE_QPARAMS.include?(key) ? "#{key}=#{CGI.escape(value.to_s)}" : next
+      }.compact.join("&")
     end
 
     def truncate(text, truncate_after_chars = 2000)
@@ -167,33 +212,38 @@ module Sidekiq
     end
 
     def display_args(args, truncate_after_chars = 2000)
-      args.map do |arg|
-        h(truncate(to_display(arg), truncate_after_chars))
-      end.join(", ")
+      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 { |arg|
+          h(truncate(to_display(arg), truncate_after_chars))
+        }.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 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
+    ])
 
     def retry_extra_items(retry_job)
       @retry_extra_items ||= {}.tap do |extra|
@@ -203,15 +253,29 @@ module Sidekiq
       end
     end
 
+    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)).round(1))} GB"
+      end
+    end
+
     def number_with_delimiter(number)
+      return "" if number.nil?
+
       begin
         Float(number)
       rescue ArgumentError, TypeError
         return number
       end
 
-      options = {delimiter: ',', separator: '.'}
-      parts = number.to_s.to_str.split('.')
+      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])
     end
@@ -219,8 +283,8 @@ module Sidekiq
     def h(text)
       ::Rack::Utils.escape_html(text)
     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
 
@@ -237,7 +301,7 @@ module Sidekiq
     end
 
     def environment_title_prefix
-      environment = Sidekiq.options[:environment] || ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'
+      environment = Sidekiq.options[:environment] || ENV["APP_ENV"] || ENV["RAILS_ENV"] || ENV["RACK_ENV"] || "development"
 
       "[#{environment.upcase}] " unless environment == "production"
     end
@@ -246,27 +310,31 @@ module Sidekiq
       "Sidekiq v#{Sidekiq::VERSION}"
     end
 
+    def server_utc_time
+      Time.now.utc.strftime("%H:%M:%S UTC")
+    end
+
     def redis_connection_and_namespace
       @redis_connection_and_namespace ||= begin
-        namespace_suffix = namespace == nil ? '' : "##{namespace}"
+        namespace_suffix = namespace.nil? ? "" : "##{namespace}"
         "#{redis_connection}#{namespace_suffix}"
       end
     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

data/lib/sidekiq/web/router.rb

@@ -1,18 +1,23 @@
 # frozen_string_literal: true
-require 'rack'
+
+require "rack"
 
 module Sidekiq
   module WebRouter
-    GET = 'GET'.freeze
-    DELETE = 'DELETE'.freeze
-    POST = 'POST'.freeze
-    PUT = 'PUT'.freeze
-    PATCH = 'PATCH'.freeze
-    HEAD = 'HEAD'.freeze
-
-    ROUTE_PARAMS = 'rack.route_params'.freeze
-    REQUEST_METHOD = 'REQUEST_METHOD'.freeze
-    PATH_INFO = 'PATH_INFO'.freeze
+    GET = "GET"
+    DELETE = "DELETE"
+    POST = "POST"
+    PUT = "PUT"
+    PATCH = "PATCH"
+    HEAD = "HEAD"
+
+    ROUTE_PARAMS = "rack.route_params"
+    REQUEST_METHOD = "REQUEST_METHOD"
+    PATH_INFO = "PATH_INFO"
+
+    def head(path, &block)
+      route(HEAD, path, &block)
+    end
 
     def get(path, &block)
       route(GET, path, &block)
@@ -35,18 +40,22 @@ module Sidekiq
     end
 
     def route(method, path, &block)
-      @routes ||= { GET => [], POST => [], PUT => [], PATCH => [], DELETE => [], HEAD => [] }
+      @routes ||= {GET => [], POST => [], PUT => [], PATCH => [], DELETE => [], HEAD => []}
 
       @routes[method] << WebRoute.new(method, path, block)
-      @routes[HEAD] << WebRoute.new(method, path, block) if method == GET
     end
 
     def match(env)
       request_method = env[REQUEST_METHOD]
       path_info = ::Rack::Utils.unescape env[PATH_INFO]
 
+      # There are servers which send an empty string when requesting the root.
+      # These servers should be ashamed of themselves.
+      path_info = "/" if path_info == ""
+
       @routes[request_method].each do |route|
-        if params = route.match(request_method, path_info)
+        params = route.match(request_method, path_info)
+        if params
           env[ROUTE_PARAMS] = params
 
           return WebAction.new(env, route.block)
@@ -60,7 +69,7 @@ module Sidekiq
   class WebRoute
     attr_accessor :request_method, :pattern, :block, :name
 
-    NAMED_SEGMENTS_PATTERN = /\/([^\/]*):([^\.:$\/]+)/.freeze
+    NAMED_SEGMENTS_PATTERN = /\/([^\/]*):([^.:$\/]+)/
 
     def initialize(request_method, pattern, block)
       @request_method = request_method
@@ -73,7 +82,7 @@ module Sidekiq
     end
 
     def compile
-      if pattern.match(NAMED_SEGMENTS_PATTERN)
+      if pattern.match?(NAMED_SEGMENTS_PATTERN)
         p = pattern.gsub(NAMED_SEGMENTS_PATTERN, '/\1(?<\2>[^$/]+)')
 
         Regexp.new("\\A#{p}\\Z")
@@ -87,9 +96,8 @@ module Sidekiq
       when String
         {} if path == matcher
       else
-        if path_match = path.match(matcher)
-          Hash[path_match.names.map(&:to_sym).zip(path_match.captures)]
-        end
+        path_match = path.match(matcher)
+        path_match&.named_captures&.transform_keys(&:to_sym)
       end
     end
   end