module Sidekiq::WebHelpers

These methods are available to pages within the Web UI and UI extensions. They are not public APIs for applications to use.

Constants

RETRY_JOB_KEYS
SAFE_QPARAMS

Public Instance Methods

add_to_head() { || ... } click to toggle source

This view helper provide ability display you html code in to head of page. Example:

<% add_to_head do %>
  <link rel="stylesheet" .../>
  <meta .../>
<% end %>
# File lib/sidekiq/web/helpers.rb, line 132
def add_to_head
  @head_html ||= []
  @head_html << yield.dup if block_given?
end
available_locales() click to toggle source
# File lib/sidekiq/web/helpers.rb, line 91
def available_locales
  @available_locales ||= Set.new(locale_files.map { |path| File.basename(path, ".yml") })
end
busy_weights(capsule_weights) click to toggle source
# File lib/sidekiq/web/helpers.rb, line 228
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
clear_caches() click to toggle source
# File lib/sidekiq/web/helpers.rb, line 79
def clear_caches
  @strings = nil
  @locale_files = nil
  @available_locales = nil
end
csp_nonce() click to toggle source
# File lib/sidekiq/web/helpers.rb, line 312
def csp_nonce
  env[:csp_nonce]
end
csrf_tag() click to toggle source
# File lib/sidekiq/web/helpers.rb, line 308
def csrf_tag
  "<input type='hidden' name='authenticity_token' value='#{env[:csrf_token]}'/>"
end
current_path() click to toggle source
# File lib/sidekiq/web/helpers.rb, line 254
def current_path
  @current_path ||= request.path_info.gsub(/^\//, "")
end
current_status() click to toggle source
# File lib/sidekiq/web/helpers.rb, line 258
def current_status
  (workset.size == 0) ? "idle" : "active"
end
delete_or_add_queue(job, params) click to toggle source
# File lib/sidekiq/web/helpers.rb, line 407
def delete_or_add_queue(job, params)
  if params["delete"]
    job.delete
  elsif params["add_to_queue"]
    job.add_to_queue
  end
end
display_args(args, truncate_after_chars = 2000) click to toggle source
# File lib/sidekiq/web/helpers.rb, line 295
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}" 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
display_custom_head() click to toggle source
# File lib/sidekiq/web/helpers.rb, line 137
def display_custom_head
  @head_html.join if defined?(@head_html)
end
display_tags(job, within = "retries") click to toggle source
# File lib/sidekiq/web/helpers.rb, line 118
def display_tags(job, within = "retries")
  job.tags.map { |tag|
    "<span class='label label-info jobtag'>#{filter_link(tag, within)}</span>"
  }.join(" ")
end
environment_title_prefix() click to toggle source
# File lib/sidekiq/web/helpers.rb, line 378
def environment_title_prefix
  environment = Sidekiq.default_configuration[:environment] || ENV["APP_ENV"] || ENV["RAILS_ENV"] || ENV["RACK_ENV"] || "development"

  "[#{environment.upcase}] " unless environment == "production"
end
filtering(which) click to toggle source
# File lib/sidekiq/web/helpers.rb, line 106
def filtering(which)
  erb(:filtering, locals: {which: which})
end
find_locale_files(lang) click to toggle source
# File lib/sidekiq/web/helpers.rb, line 95
def find_locale_files(lang)
  locale_files.select { |file| file =~ /\/#{lang}\.yml$/ }
end
format_memory(rss_kb) click to toggle source
# File lib/sidekiq/web/helpers.rb, line 341
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
get_locale() click to toggle source
# File lib/sidekiq/web/helpers.rb, line 190
def get_locale
  strings(locale)
end
h(text) click to toggle source
# File lib/sidekiq/web/helpers.rb, line 358
def h(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")
  retry
end
job_params(job, score) click to toggle source
# File lib/sidekiq/web/helpers.rb, line 267
def job_params(job, score)
  "#{score}-#{job["jid"]}"
end
locale() click to toggle source

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 github.com/iain/http_accept_language/blob/master/lib/http_accept_language/parser.rb

# File lib/sidekiq/web/helpers.rb, line 166
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 = 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
locale_files() click to toggle source
# File lib/sidekiq/web/helpers.rb, line 85
def locale_files
  @locale_files ||= settings.locales.flat_map { |path|
    Dir["#{path}/*.yml"]
  }
end
number_with_delimiter(number, options = {}) click to toggle source
# File lib/sidekiq/web/helpers.rb, line 353
def number_with_delimiter(number, options = {})
  precision = options[:precision] || 0
  %(<span data-nwp="#{precision}">#{number.round(precision)}</span>)
end
parse_params(params) click to toggle source
# File lib/sidekiq/web/helpers.rb, line 271
def parse_params(params)
  score, jid = params.split("-", 2)
  [score.to_f, jid]
end
pollable?() click to toggle source
# File lib/sidekiq/web/helpers.rb, line 392
def pollable?
  # there's no point to refreshing the metrics pages every N seconds
  !(current_path == "" || current_path.index("metrics"))
end
processes() click to toggle source
# File lib/sidekiq/web/helpers.rb, line 211
def processes
  @processes ||= Sidekiq::ProcessSet.new
end
product_version() click to toggle source
# File lib/sidekiq/web/helpers.rb, line 384
def product_version
  "Sidekiq v#{Sidekiq::VERSION}"
end
qparams(options) click to toggle source

Merge options with current params, filter safe params, and stringify to query string

# File lib/sidekiq/web/helpers.rb, line 279
def qparams(options)
  stringified_options = options.transform_keys(&:to_s)

  to_query_string(params.merge(stringified_options))
end
redirect_with_query(url) click to toggle source

Any paginated list that performs an action needs to redirect back to the proper page after performing that action.

# File lib/sidekiq/web/helpers.rb, line 368
def redirect_with_query(url)
  r = request.referer
  if r && r =~ /\?/
    ref = URI(r)
    redirect("#{url}?#{ref.query}")
  else
    redirect url
  end
end
redis_info() click to toggle source
# File lib/sidekiq/web/helpers.rb, line 246
def redis_info
  Sidekiq.default_configuration.redis_info
end
redis_url() click to toggle source
# File lib/sidekiq/web/helpers.rb, line 240
def redis_url
  Sidekiq.redis do |conn|
    conn.config.server_url
  end
end
relative_time(time) click to toggle source
# File lib/sidekiq/web/helpers.rb, line 262
def relative_time(time)
  stamp = time.getutc.iso8601
  %(<time class="ltr" dir="ltr" title="#{stamp}" datetime="#{stamp}">#{time}</time>)
end
retry_extra_items(retry_job) click to toggle source
# File lib/sidekiq/web/helpers.rb, line 333
def retry_extra_items(retry_job)
  @retry_extra_items ||= {}.tap do |extra|
    retry_job.item.each do |key, value|
      extra[key] = value unless RETRY_JOB_KEYS.include?(key)
    end
  end
end
retry_or_delete_or_kill(job, params) click to toggle source
# File lib/sidekiq/web/helpers.rb, line 397
def retry_or_delete_or_kill(job, params)
  if params["retry"]
    job.retry
  elsif params["delete"]
    job.delete
  elsif params["kill"]
    job.kill
  end
end
root_path() click to toggle source
# File lib/sidekiq/web/helpers.rb, line 250
def root_path
  "#{env["SCRIPT_NAME"]}/"
end
rtl?() click to toggle source
# File lib/sidekiq/web/helpers.rb, line 145
def rtl?
  text_direction == "rtl"
end
script_tag(location, **kwargs) click to toggle source
# File lib/sidekiq/web/helpers.rb, line 25
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
server_utc_time() click to toggle source
# File lib/sidekiq/web/helpers.rb, line 388
def server_utc_time
  Time.now.utc.strftime("%H:%M:%S UTC")
end
singularize(str, count) click to toggle source
# File lib/sidekiq/web/helpers.rb, line 71
def singularize(str, count)
  if count == 1 && str.respond_to?(:singularize) # rails
    str.singularize
  else
    str
  end
end
sort_direction_label() click to toggle source
# File lib/sidekiq/web/helpers.rb, line 203
def sort_direction_label
  (params[:direction] == "asc") ? "&uarr;" : "&darr;"
end
sorted_processes() click to toggle source

Sorts processes by hostname following the natural sort order

# File lib/sidekiq/web/helpers.rb, line 216
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
stats() click to toggle source
# File lib/sidekiq/web/helpers.rb, line 236
def stats
  @stats ||= Sidekiq::Stats.new
end
strings(lang) click to toggle source
# File lib/sidekiq/web/helpers.rb, line 54
def strings(lang)
  @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.safe_load(File.read(file))
      global.merge!(strs[lang])
    end
  end
end
style_tag(location, **kwargs) click to toggle source
# File lib/sidekiq/web/helpers.rb, line 12
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
  }
  html_tag(:link, attrs.merge(kwargs))
end
t(msg, options = {}) click to toggle source
# File lib/sidekiq/web/helpers.rb, line 194
def t(msg, options = {})
  string = get_locale[msg] || strings("en")[msg] || msg
  if options.empty?
    string
  else
    string % options
  end
end
text_direction() click to toggle source
# File lib/sidekiq/web/helpers.rb, line 141
def text_direction
  get_locale["TextDirection"] || "ltr"
end
to_display(arg) click to toggle source
# File lib/sidekiq/web/helpers.rb, line 316
def to_display(arg)
  arg.inspect
rescue
  begin
    arg.to_s
  rescue => ex
    "Cannot display argument: [#{ex.class.name}] #{ex.message}"
  end
end
to_json(x) click to toggle source
# File lib/sidekiq/web/helpers.rb, line 67
def to_json(x)
  Sidekiq.dump_json(x)
end
to_query_string(params) click to toggle source
# File lib/sidekiq/web/helpers.rb, line 285
def to_query_string(params)
  params.map { |key, value|
    SAFE_QPARAMS.include?(key) ? "#{key}=#{CGI.escape(value.to_s)}" : next
  }.compact.join("&")
end
truncate(text, truncate_after_chars = 2000) click to toggle source
# File lib/sidekiq/web/helpers.rb, line 291
def truncate(text, truncate_after_chars = 2000)
  (truncate_after_chars && text.size > truncate_after_chars) ? "#{text[0..truncate_after_chars]}..." : text
end
unfiltered?() { || ... } click to toggle source

sidekiq/sidekiq#3243

# File lib/sidekiq/web/helpers.rb, line 186
def unfiltered?
  yield unless env["PATH_INFO"].start_with?("/filter/")
end
user_preferred_languages() click to toggle source

See www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.4

# File lib/sidekiq/web/helpers.rb, line 150
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
workset() click to toggle source
# File lib/sidekiq/web/helpers.rb, line 207
def workset
  @work ||= Sidekiq::WorkSet.new
end

Private Instance Methods

html_tag(tagname, attrs) { |s| ... } click to toggle source

NB: keys and values are not escaped; do not allow user input in the attributes

# File lib/sidekiq/web/helpers.rb, line 38
        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