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 direction]
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 tags
])

Instance Method Summary collapse

Instance Method Details

#add_to_headObject

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

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

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

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

#available_localesObject


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

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

#clear_cachesObject


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

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

#csrf_tagObject


241
242
243
# File 'lib/sidekiq/web/helpers.rb', line 241

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

#current_pathObject


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

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

#current_statusObject


188
189
190
# File 'lib/sidekiq/web/helpers.rb', line 188

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

#delete_or_add_queue(job, params) ⇒ Object


334
335
336
337
338
339
340
# File 'lib/sidekiq/web/helpers.rb', line 334

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


228
229
230
231
232
233
234
235
236
237
238
239
# File 'lib/sidekiq/web/helpers.rb', line 228

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_headObject


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

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

#display_tags(job, within = nil) ⇒ Object

within is used by Sidekiq Pro


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

def display_tags(job, within = nil)
  job.tags.map { |tag|
    "<span class='jobtag label label-info'>#{::Rack::Utils.escape_html(tag)}</span>"
  }.join(" ")
end

#environment_title_prefixObject


303
304
305
306
307
# File 'lib/sidekiq/web/helpers.rb', line 303

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

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

#filteringObject

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


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

def filtering(*)
end

#find_locale_files(lang) ⇒ Object


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

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

#get_localeObject


130
131
132
# File 'lib/sidekiq/web/helpers.rb', line 130

def get_locale
  strings(locale)
end

#h(text) ⇒ Object


283
284
285
286
287
288
289
# File 'lib/sidekiq/web/helpers.rb', line 283

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


197
198
199
# File 'lib/sidekiq/web/helpers.rb', line 197

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

#localeObject

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


102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
# File 'lib/sidekiq/web/helpers.rb', line 102

def locale
  @locale ||= begin
    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_filesObject


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

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

#namespaceObject


172
173
174
# File 'lib/sidekiq/web/helpers.rb', line 172

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

#number_with_delimiter(number) ⇒ Object


270
271
272
273
274
275
276
277
278
279
280
281
# File 'lib/sidekiq/web/helpers.rb', line 270

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


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

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

#poll_pathObject


66
67
68
69
70
71
72
73
74
75
# File 'lib/sidekiq/web/helpers.rb', line 66

def poll_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

#processesObject


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

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

#product_versionObject


309
310
311
# File 'lib/sidekiq/web/helpers.rb', line 309

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

#qparams(options) ⇒ Object

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


209
210
211
212
213
214
215
216
# File 'lib/sidekiq/web/helpers.rb', line 209

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

  to_query_string(params.merge(options))
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.


293
294
295
296
297
298
299
300
301
# File 'lib/sidekiq/web/helpers.rb', line 293

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

#redis_connectionObject


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

def redis_connection
  Sidekiq.redis do |conn|
    c = conn.connection
    "redis://#{c[:location]}/#{c[:db]}"
  end
end

#redis_connection_and_namespaceObject


317
318
319
320
321
322
# File 'lib/sidekiq/web/helpers.rb', line 317

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

#redis_infoObject


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

def redis_info
  Sidekiq.redis_info
end

#relative_time(time) ⇒ Object


192
193
194
195
# File 'lib/sidekiq/web/helpers.rb', line 192

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


159
160
161
162
163
# File 'lib/sidekiq/web/helpers.rb', line 159

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

#retry_extra_items(retry_job) ⇒ Object


262
263
264
265
266
267
268
# File 'lib/sidekiq/web/helpers.rb', line 262

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


324
325
326
327
328
329
330
331
332
# File 'lib/sidekiq/web/helpers.rb', line 324

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_pathObject


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

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

#rtl?Boolean

Returns:

  • (Boolean)

81
82
83
# File 'lib/sidekiq/web/helpers.rb', line 81

def rtl?
  text_direction == "rtl"
end

#server_utc_timeObject


313
314
315
# File 'lib/sidekiq/web/helpers.rb', line 313

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

#sort_direction_labelObject


143
144
145
# File 'lib/sidekiq/web/helpers.rb', line 143

def sort_direction_label
  params[:direction] == "asc" ? "&uarr;" : "&darr;"
end

#statsObject


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

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

#strings(lang) ⇒ Object


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

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


134
135
136
137
138
139
140
141
# File 'lib/sidekiq/web/helpers.rb', line 134

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

#text_directionObject


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

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

#to_display(arg) ⇒ Object


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

def to_display(arg)
  arg.inspect
rescue
  begin
    arg.to_s
  rescue => ex
    "Cannot display argument: [#{ex.class.name}] #{ex.message}"
  end
end

#to_query_string(params) ⇒ Object


218
219
220
221
222
# File 'lib/sidekiq/web/helpers.rb', line 218

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


224
225
226
# File 'lib/sidekiq/web/helpers.rb', line 224

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)

126
127
128
# File 'lib/sidekiq/web/helpers.rb', line 126

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

#user_preferred_languagesObject


86
87
88
89
90
91
92
93
94
95
96
# File 'lib/sidekiq/web/helpers.rb', line 86

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

#workersObject


147
148
149
# File 'lib/sidekiq/web/helpers.rb', line 147

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