sidekiq 5.2.1 → 6.0.7

data/lib/sidekiq/web/helpers.rb

@@ -1,15 +1,16 @@
 # frozen_string_literal: true
-require 'uri'
-require 'set'
-require 'yaml'
-require 'cgi'
+
+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
+      @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|
@@ -22,19 +23,19 @@ module Sidekiq
     end
 
     def clear_caches
-      @@strings = nil
-      @@locale_files = nil
-      @@available_locales = 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
+      @available_locales ||= locale_files.map { |path| File.basename(path, ".yml") }.uniq
     end
 
     def find_locale_files(lang)
@@ -63,32 +64,35 @@ module Sidekiq
     end
 
     def poll_path
-      if current_path != '' && params['poll']
-        root_path + current_path
+      if current_path != "" && params["poll"]
+        path = root_path + current_path
+        query_string = to_query_string(params.slice(*params.keys - %w[page poll]))
+        path += "?#{query_string}" unless query_string.empty?
+        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
     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.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]
-      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"
@@ -97,31 +101,38 @@ module Sidekiq
     # 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
+        matched_locale = user_preferred_languages.map { |preferred|
+          preferred_language = preferred.split("-", 2).first
 
-          lang_group = available_locales.select do |available|
-            preferred_language == available.split('-', 2).first
-          end
+          lang_group = available_locales.select { |available|
+            preferred_language == available.split("-", 2).first
+          }
 
           lang_group.find { |lang| lang == preferred } || lang_group.min_by(&:length)
-        end.compact.first
+        }.compact.first
 
-        matched_locale || 'en'
+        matched_locale || "en"
       end
     end
 
+    # within is used by Sidekiq Pro
+    def display_tags(job, within = nil)
+      job.tags.map { |tag|
+        "<span class='jobtag label label-info'>#{::Rack::Utils.escape_html(tag)}</span>"
+      }.join(" ")
+    end
+
     # mperham/sidekiq#3243
     def unfiltered?
-      yield unless env['PATH_INFO'].start_with?("/filter/")
+      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
@@ -129,6 +140,10 @@ module Sidekiq
       end
     end
 
+    def sort_direction_label
+      params[:direction] == "asc" ? "&uarr;" : "&darr;"
+    end
+
     def workers
       @workers ||= Sidekiq::Workers.new
     end
@@ -141,12 +156,6 @@ 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 redis_connection
       Sidekiq.redis do |conn|
         c = conn.connection
@@ -163,24 +172,24 @@ 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)
       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)
@@ -188,7 +197,7 @@ module Sidekiq
       [score.to_f, jid]
     end
 
-    SAFE_QPARAMS = %w(page poll)
+    SAFE_QPARAMS = %w[page poll direction]
 
     # Merge options with current params, filter safe params, and stringify to query string
     def qparams(options)
@@ -197,9 +206,13 @@ module Sidekiq
         options[key.to_s] = options.delete(key)
       end
 
-      params.merge(options).map do |key, value|
+      to_query_string(params.merge(options))
+    end
+
+    def to_query_string(params)
+      params.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)
@@ -207,9 +220,16 @@ 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
@@ -217,23 +237,21 @@ module Sidekiq
     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|
@@ -250,8 +268,8 @@ module Sidekiq
         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
@@ -259,8 +277,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
 
@@ -277,7 +295,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
@@ -287,30 +305,30 @@ 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}"
+        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,19 @@
 # frozen_string_literal: true
-require 'rack'
+
+require "rack"
 
 module Sidekiq
   module WebRouter
-    GET = 'GET'
-    DELETE = 'DELETE'
-    POST = 'POST'
-    PUT = 'PUT'
-    PATCH = 'PATCH'
-    HEAD = 'HEAD'
+    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'
+    ROUTE_PARAMS = "rack.route_params"
+    REQUEST_METHOD = "REQUEST_METHOD"
+    PATH_INFO = "PATH_INFO"
 
     def get(path, &block)
       route(GET, path, &block)
@@ -35,7 +36,7 @@ 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
@@ -50,7 +51,8 @@ module Sidekiq
       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)
@@ -77,7 +79,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")
@@ -91,9 +93,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

data/lib/sidekiq/web.rb

@@ -1,20 +1,21 @@
 # frozen_string_literal: true
-require 'erb'
 
-require 'sidekiq'
-require 'sidekiq/api'
-require 'sidekiq/paginator'
-require 'sidekiq/web/helpers'
+require "erb"
 
-require 'sidekiq/web/router'
-require 'sidekiq/web/action'
-require 'sidekiq/web/application'
+require "sidekiq"
+require "sidekiq/api"
+require "sidekiq/paginator"
+require "sidekiq/web/helpers"
 
-require 'rack/protection'
+require "sidekiq/web/router"
+require "sidekiq/web/action"
+require "sidekiq/web/application"
 
-require 'rack/builder'
-require 'rack/file'
-require 'rack/session/cookie'
+require "rack/protection"
+
+require "rack/builder"
+require "rack/file"
+require "rack/session/cookie"
 
 module Sidekiq
   class Web
@@ -25,12 +26,12 @@ module Sidekiq
     ASSETS = "#{ROOT}/assets"
 
     DEFAULT_TABS = {
-      "Dashboard" => '',
-      "Busy"      => 'busy',
-      "Queues"    => 'queues',
-      "Retries"   => 'retries',
-      "Scheduled" => 'scheduled',
-      "Dead"      => 'morgue',
+      "Dashboard" => "",
+      "Busy" => "busy",
+      "Queues" => "queues",
+      "Retries" => "retries",
+      "Scheduled" => "scheduled",
+      "Dead" => "morgue"
     }
 
     class << self
@@ -64,11 +65,11 @@ module Sidekiq
       end
 
       def enable(*opts)
-        opts.each {|key| set(key, true) }
+        opts.each { |key| set(key, true) }
       end
 
       def disable(*opts)
-        opts.each {|key| set(key, false) }
+        opts.each { |key| set(key, false) }
       end
 
       # Helper for the Sinatra syntax: Sidekiq::Web.set(:session_secret, Rails.application.secrets...)
@@ -81,10 +82,10 @@ module Sidekiq
     end
 
     def self.inherited(child)
-      child.app_url = self.app_url
-      child.session_secret = self.session_secret
-      child.redis_pool = self.redis_pool
-      child.sessions = self.sessions
+      child.app_url = app_url
+      child.session_secret = session_secret
+      child.redis_pool = redis_pool
+      child.sessions = sessions
     end
 
     def settings
@@ -113,11 +114,11 @@ module Sidekiq
     end
 
     def enable(*opts)
-      opts.each {|key| set(key, true) }
+      opts.each { |key| set(key, true) }
     end
 
     def disable(*opts)
-      opts.each {|key| set(key, false) }
+      opts.each { |key| set(key, false) }
     end
 
     def set(attribute, value)
@@ -145,28 +146,28 @@ module Sidekiq
     private
 
     def using?(middleware)
-      middlewares.any? do |(m,_)|
-        m.kind_of?(Array) && (m[0] == middleware || m[0].kind_of?(middleware))
+      middlewares.any? do |(m, _)|
+        m.is_a?(Array) && (m[0] == middleware || m[0].is_a?(middleware))
       end
     end
 
     def build_sessions
       middlewares = self.middlewares
 
-      unless using?(::Rack::Protection) || ENV['RACK_ENV'] == 'test'
-        middlewares.unshift [[::Rack::Protection, { use: :authenticity_token }], nil]
+      unless using?(::Rack::Protection) || ENV["RACK_ENV"] == "test"
+        middlewares.unshift [[::Rack::Protection, {use: :authenticity_token}], nil]
       end
 
       s = sessions
       return unless s
 
       unless using? ::Rack::Session::Cookie
-        unless secret = Web.session_secret
-          require 'securerandom'
+        unless (secret = Web.session_secret)
+          require "securerandom"
           secret = SecureRandom.hex(64)
         end
 
-        options = { secret: secret }
+        options = {secret: secret}
         options = options.merge(s.to_hash) if s.respond_to? :to_hash
 
         middlewares.unshift [[::Rack::Session::Cookie, options], nil]
@@ -180,13 +181,13 @@ module Sidekiq
       klass = self.class
 
       ::Rack::Builder.new do
-        %w(stylesheets javascripts images).each do |asset_dir|
+        %w[stylesheets javascripts images].each do |asset_dir|
           map "/#{asset_dir}" do
-            run ::Rack::File.new("#{ASSETS}/#{asset_dir}", { 'Cache-Control' => 'public, max-age=86400' })
+            run ::Rack::File.new("#{ASSETS}/#{asset_dir}", {"Cache-Control" => "public, max-age=86400"})
           end
         end
 
-        middlewares.each {|middleware, block| use(*middleware, &block) }
+        middlewares.each { |middleware, block| use(*middleware, &block) }
 
         run WebApplication.new(klass)
       end
@@ -196,18 +197,9 @@ module Sidekiq
   Sidekiq::WebApplication.helpers WebHelpers
   Sidekiq::WebApplication.helpers Sidekiq::Paginator
 
-  Sidekiq::WebAction.class_eval "def _render\n#{ERB.new(File.read(Web::LAYOUT)).src}\nend"
-end
-
-if defined?(::ActionDispatch::Request::Session) &&
-    !::ActionDispatch::Request::Session.method_defined?(:each)
-  # mperham/sidekiq#2460
-  # Rack apps can't reuse the Rails session store without
-  # this monkeypatch, fixed in Rails 5.
-  class ActionDispatch::Request::Session
-    def each(&block)
-      hash = self.to_hash
-      hash.each(&block)
+  Sidekiq::WebAction.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+    def _render
+      #{ERB.new(File.read(Web::LAYOUT)).src}
     end
-  end
+  RUBY
 end