1
0
Fork 0
mirror of https://github.com/mperham/sidekiq.git synced 2022-11-09 13:52:34 -05:00
mperham--sidekiq/lib/sidekiq/web/helpers.rb

278 lines
6.7 KiB
Ruby
Raw Normal View History

# frozen_string_literal: true
require 'uri'
2016-11-12 17:39:08 -05:00
require 'set'
require 'yaml'
module Sidekiq
# This is not a public API
module WebHelpers
2015-04-09 17:26:03 -04:00
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|
2015-04-09 17:26:03 -04:00
find_locale_files(lang).each do |file|
strs = YAML.load(File.open(file))
2015-04-09 17:26:03 -04:00
global.deep_merge!(strs[lang])
end
end
end
end
def clear_caches
@@strings = nil
@@locale_files = nil
end
2015-04-09 17:26:03 -04:00
def locale_files
@@locale_files ||= settings.locales.flat_map do |path|
2015-04-09 17:26:03 -04:00
Dir["#{path}/*.yml"]
end
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(*)
end
# This view helper provide ability display you html code in
# to head of page. Example:
#
# <% add_to_head do %>
# <link rel="stylesheet" .../>
# <meta .../>
# <% end %>
#
def add_to_head
@head_html ||= []
@head_html << yield.dup if block_given?
end
def display_custom_head
@head_html.join if defined?(@head_html)
end
def poll_path
if current_path != '' && params['poll']
root_path + current_path
else
""
end
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 locale
@locale ||= begin
locale = 'en'.freeze
languages = env['HTTP_ACCEPT_LANGUAGE'.freeze] || 'en'.freeze
languages.downcase.split(','.freeze).each do |lang|
2015-05-15 15:11:01 -04:00
next if lang == '*'.freeze
lang = lang.split(';'.freeze)[0]
2015-04-09 17:26:03 -04:00
break locale = lang if find_locale_files(lang).any?
end
locale
end
end
# mperham/sidekiq#3243
def unfiltered?
yield unless env['PATH_INFO'].start_with?("/filter/")
end
def get_locale
2015-04-09 17:26:03 -04:00
strings(locale)
end
def t(msg, options={})
string = get_locale[msg] || msg
if options.empty?
string
else
string % options
end
end
def workers
@workers ||= Sidekiq::Workers.new
end
2015-01-16 13:59:41 -05:00
def processes
@processes ||= Sidekiq::ProcessSet.new
end
def stats
@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 { |conn| conn.client.id }
end
def namespace
2014-12-17 15:09:20 -05:00
@@ns ||= Sidekiq.redis { |conn| conn.respond_to?(:namespace) ? conn.namespace : nil }
end
def redis_info
Sidekiq.redis_info
end
def root_path
"#{env['SCRIPT_NAME']}/"
end
def current_path
@current_path ||= request.path_info.gsub(/^\//,'')
end
def current_status
2015-01-16 17:03:19 -05:00
workers.size == 0 ? 'idle' : 'active'
end
def relative_time(time)
stamp = time.getutc.iso8601
%{<time title="#{stamp}" datetime="#{stamp}">#{time}</time>}
end
def job_params(job, score)
"#{score}-#{job['jid']}"
end
def parse_params(params)
score, jid = params.split("-")
[score.to_f, jid]
end
SAFE_QPARAMS = %w(page poll)
# Merge options with current params, filter safe params, and stringify to query string
def qparams(options)
options = options.stringify_keys
2014-12-17 15:09:20 -05:00
params.merge(options).map do |key, value|
SAFE_QPARAMS.include?(key) ? "#{key}=#{value}" : next
end.compact.join("&")
end
def truncate(text, truncate_after_chars = 2000)
truncate_after_chars && text.size > truncate_after_chars ? "#{text[0..truncate_after_chars]}..." : text
end
def display_args(args, truncate_after_chars = 2000)
args.map do |arg|
h(truncate(to_display(arg), truncate_after_chars))
end.join(", ")
end
def csrf_tag
"<input type='hidden' name='authenticity_token' value='#{session[:csrf]}'/>"
end
def to_display(arg)
begin
arg.inspect
rescue
begin
arg.to_s
rescue => ex
"Cannot display argument: [#{ex.class.name}] #{ex.message}"
end
end
end
RETRY_JOB_KEYS = Set.new(%w(
queue class args retry_count retried_at failed_at
jid error_message error_class backtrace
2015-03-24 17:57:17 -04:00
error_backtrace enqueued_at retry wrapped
2015-12-09 14:44:47 -05:00
created_at
))
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
def number_with_delimiter(number)
begin
Float(number)
rescue ArgumentError, TypeError
return number
end
2014-12-17 15:09:20 -05:00
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
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')
retry
end
# Any paginated list that performs an action needs to redirect
# back to the proper page after performing that action.
def redirect_with_query(url)
r = request.referer
if r && r =~ /\?/
ref = URI(r)
redirect("#{url}?#{ref.query}")
else
redirect url
end
end
def environment_title_prefix
environment = Sidekiq.options[:environment] || ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'
"[#{environment.upcase}] " unless environment == "production"
end
2015-01-21 13:36:17 -05:00
def product_version
"Sidekiq v#{Sidekiq::VERSION}"
end
2015-11-06 16:24:57 -05:00
def redis_connection_and_namespace
2015-11-09 13:09:51 -05:00
@redis_connection_and_namespace ||= begin
2015-11-13 12:14:00 -05:00
namespace_suffix = namespace == nil ? '' : "##{namespace}"
2015-11-09 13:09:51 -05:00
"#{redis_connection}#{namespace_suffix}"
end
end
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
def delete_or_add_queue(job, params)
if params['delete']
job.delete
elsif params['add_to_queue']
job.add_to_queue
end
end
end
end