Module: Sidekiq::WebHelpers

Defined in:
lib/sidekiq/web/helpers.rb

Overview

This is not a public API

Constant Summary collapse

SAFE_QPARAMS = 
%w(page poll)
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
))

Instance Method Summary collapse

Instance Method Details

#add_to_head ⇒ Object

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

<% add_to_head do %>
  <link rel="stylesheet" .../>
  <meta .../>
<% end %>



56
57
58
59
 
# File 'lib/sidekiq/web/helpers.rb', line 56

def add_to_head
  @head_html ||= []
  @head_html << yield.dup if block_given?
end

#available_locales ⇒ Object 



36
37
38
 
# File 'lib/sidekiq/web/helpers.rb', line 36

def available_locales
  @@available_locales ||= locale_files.map { |path| File.basename(path, '.yml') }.uniq
end

#clear_caches ⇒ Object 



24
25
26
27
28
 
# File 'lib/sidekiq/web/helpers.rb', line 24

def clear_caches
  @@strings = nil
  @@locale_files = nil
  @@available_locales = nil
end

#csrf_tag ⇒ Object 



212
213
214
 
# File 'lib/sidekiq/web/helpers.rb', line 212

def csrf_tag
  "<input type='hidden' name='authenticity_token' value='#{session[:csrf]}'/>"
end

#current_path ⇒ Object 



166
167
168
 
# File 'lib/sidekiq/web/helpers.rb', line 166

def current_path
  @current_path ||= request.path_info.gsub(/^\//,'')
end

#current_status ⇒ Object 



170
171
172
 
# File 'lib/sidekiq/web/helpers.rb', line 170

def current_status
  workers.size == 0 ? 'idle' : 'active'
end

#delete_or_add_queue(job, params) ⇒ Object 



307
308
309
310
311
312
313
 
# File 'lib/sidekiq/web/helpers.rb', line 307

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) ⇒ Object 



206
207
208
209
210
 
# File 'lib/sidekiq/web/helpers.rb', line 206

def display_args(args, truncate_after_chars = 2000)
  args.map do |arg|
    h(truncate(to_display(arg), truncate_after_chars))
  end.join(", ")
end

#display_custom_head ⇒ Object 



61
62
63
 
# File 'lib/sidekiq/web/helpers.rb', line 61

def display_custom_head
  @head_html.join if defined?(@head_html)
end

#environment_title_prefix ⇒ Object 



276
277
278
279
280
 
# File 'lib/sidekiq/web/helpers.rb', line 276

def environment_title_prefix
  environment = Sidekiq.options[:environment] || ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'

  "[#{environment.upcase}] " unless environment == "production"
end

#filtering ⇒ Object

This is a hook for a Sidekiq Pro feature. Please don’t touch.



45
46
 
# File 'lib/sidekiq/web/helpers.rb', line 45

def filtering(*)
end

#find_locale_files(lang) ⇒ Object 



40
41
42
 
# File 'lib/sidekiq/web/helpers.rb', line 40

def find_locale_files(lang)
  locale_files.select { |file| file =~ /\/#{lang}\.yml$/ }
end

#get_locale ⇒ Object 



119
120
121
 
# File 'lib/sidekiq/web/helpers.rb', line 119

def get_locale
  strings(locale)
end

#h(text) ⇒ Object 



256
257
258
259
260
261
262
 
# File 'lib/sidekiq/web/helpers.rb', line 256

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

#job_params(job, score) ⇒ Object 



179
180
181
 
# File 'lib/sidekiq/web/helpers.rb', line 179

def job_params(job, score)
  "#{score}-#{job['jid']}"
end

#locale ⇒ Object

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



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/sidekiq/web/helpers.rb', line 98

def locale
  @locale ||= begin
    matched_locale = user_preferred_languages.map do |preferred|
      preferred_language = preferred.split('-', 2).first

      lang_group = available_locales.select do |available|
        preferred_language == available.split('-', 2).first
      end

      lang_group.find { |lang| lang == preferred } || lang_group.min_by(&:length)
    end.compact.first

    matched_locale || 'en'
  end
end

#locale_files ⇒ Object 



30
31
32
33
34
 
# File 'lib/sidekiq/web/helpers.rb', line 30

def locale_files
  @@locale_files ||= settings.locales.flat_map do |path|
    Dir["#{path}/*.yml"]
  end
end

#namespace ⇒ Object 



154
155
156
 
# File 'lib/sidekiq/web/helpers.rb', line 154

def namespace
  @@ns ||= Sidekiq.redis { |conn| conn.respond_to?(:namespace) ? conn.namespace : nil }
end

#number_with_delimiter(number) ⇒ Object 



243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/sidekiq/web/helpers.rb', line 243

def number_with_delimiter(number)
  begin
    Float(number)
  rescue ArgumentError, TypeError
    return number
  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])
end

#parse_params(params) ⇒ Object 



183
184
185
186
 
# File 'lib/sidekiq/web/helpers.rb', line 183

def parse_params(params)
  score, jid = params.split("-")
  [score.to_f, jid]
end

#poll_path ⇒ Object 



65
66
67
68
69
70
71
 
# File 'lib/sidekiq/web/helpers.rb', line 65

def poll_path
  if current_path != '' && params['poll']
    root_path + current_path
  else
    ""
  end
end

#processes ⇒ Object 



136
137
138
 
# File 'lib/sidekiq/web/helpers.rb', line 136

def processes
  @processes ||= Sidekiq::ProcessSet.new
end

#product_version ⇒ Object 



282
283
284
 
# File 'lib/sidekiq/web/helpers.rb', line 282

def product_version
  "Sidekiq v#{Sidekiq::VERSION}"
end

#qparams(options) ⇒ Object

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



191
192
193
194
195
196
197
198
199
200
 
# File 'lib/sidekiq/web/helpers.rb', line 191

def qparams(options)
  # stringify
  options.keys.each do |key|
    options[key.to_s] = options.delete(key)
  end

  params.merge(options).map do |key, value|
    SAFE_QPARAMS.include?(key) ? "#{key}=#{CGI.escape(value.to_s)}" : next
  end.compact.join("&")
end

#redirect_with_query(url) ⇒ Object

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



266
267
268
269
270
271
272
273
274
 
# File 'lib/sidekiq/web/helpers.rb', line 266

def redirect_with_query(url)
  r = request.referer
  if r && r =~ /\?/
    ref = URI(r)
    redirect("#{url}?#{ref.query}")
  else
    redirect url
  end
end

#redis_connection ⇒ Object 



150
151
152
 
# File 'lib/sidekiq/web/helpers.rb', line 150

def redis_connection
  Sidekiq.redis { |conn| conn.client.id }
end

#redis_connection_and_namespace ⇒ Object 



290
291
292
293
294
295
 
# File 'lib/sidekiq/web/helpers.rb', line 290

def redis_connection_and_namespace
  @redis_connection_and_namespace ||= begin
    namespace_suffix = namespace == nil ? '' : "##{namespace}"
    "#{redis_connection}#{namespace_suffix}"
  end
end

#redis_info ⇒ Object 



158
159
160
 
# File 'lib/sidekiq/web/helpers.rb', line 158

def redis_info
  Sidekiq.redis_info
end

#relative_time(time) ⇒ Object 



174
175
176
177
 
# File 'lib/sidekiq/web/helpers.rb', line 174

def relative_time(time)
  stamp = time.getutc.iso8601
  %{<time class="ltr" dir="ltr" title="#{stamp}" datetime="#{stamp}">#{time}</time>}
end

#retries_with_score(score) ⇒ Object 



144
145
146
147
148
 
# File 'lib/sidekiq/web/helpers.rb', line 144

def retries_with_score(score)
  Sidekiq.redis do |conn|
    conn.zrangebyscore('retry', score, score)
  end.map { |msg| Sidekiq.load_json(msg) }
end

#retry_extra_items(retry_job) ⇒ Object 



235
236
237
238
239
240
241
 
# File 'lib/sidekiq/web/helpers.rb', line 235

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) ⇒ Object 



297
298
299
300
301
302
303
304
305
 
# File 'lib/sidekiq/web/helpers.rb', line 297

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 ⇒ Object 



162
163
164
 
# File 'lib/sidekiq/web/helpers.rb', line 162

def root_path
  "#{env['SCRIPT_NAME']}/"
end

#rtl? ⇒ Boolean

Returns:

  • (Boolean) 


77
78
79
 
# File 'lib/sidekiq/web/helpers.rb', line 77

def rtl?
  text_direction == 'rtl'
end

#server_utc_time ⇒ Object 



286
287
288
 
# File 'lib/sidekiq/web/helpers.rb', line 286

def server_utc_time
  Time.now.utc.strftime('%H:%M:%S UTC')
end

#stats ⇒ Object 



140
141
142
 
# File 'lib/sidekiq/web/helpers.rb', line 140

def stats
  @stats ||= Sidekiq::Stats.new
end

#strings(lang) ⇒ Object 



10
11
12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/sidekiq/web/helpers.rb', line 10

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
    end
  end
end

#t(msg, options = {}) ⇒ Object 



123
124
125
126
127
128
129
130
 
# File 'lib/sidekiq/web/helpers.rb', line 123

def t(msg, options={})
  string = get_locale[msg] || msg
  if options.empty?
    string
  else
    string % options
  end
end

#text_direction ⇒ Object 



73
74
75
 
# File 'lib/sidekiq/web/helpers.rb', line 73

def text_direction
  get_locale['TextDirection'] || 'ltr'
end

#to_display(arg) ⇒ Object 



216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/sidekiq/web/helpers.rb', line 216

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

#truncate(text, truncate_after_chars = 2000) ⇒ Object 



202
203
204
 
# File 'lib/sidekiq/web/helpers.rb', line 202

def truncate(text, truncate_after_chars = 2000)
  truncate_after_chars && text.size > truncate_after_chars ? "#{text[0..truncate_after_chars]}..." : text
end

#unfiltered? ⇒ Boolean

mperham/sidekiq#3243

Returns:

  • (Boolean) 


115
116
117
 
# File 'lib/sidekiq/web/helpers.rb', line 115

def unfiltered?
  yield unless env['PATH_INFO'].start_with?("/filter/")
end

#user_preferred_languages ⇒ Object

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



82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/sidekiq/web/helpers.rb', line 82

def user_preferred_languages
  languages = env['HTTP_ACCEPT_LANGUAGE'.freeze]
  languages.to_s.downcase.gsub(/\s+/, '').split(',').map do |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)|
    right <=> left
  end.map(&:first).compact
end

#workers ⇒ Object 



132
133
134
 
# File 'lib/sidekiq/web/helpers.rb', line 132

def workers
  @workers ||= Sidekiq::Workers.new
end