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

Instance Method Summary collapse

Instance Method Details

#current_path ⇒ Object 



96
97
98
 
# File 'lib/sidekiq/web_helpers.rb', line 96

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

#current_status ⇒ Object 



100
101
102
 
# File 'lib/sidekiq/web_helpers.rb', line 100

def current_status
  workers_size == 0 ? 'idle' : 'active'
end

#display_args(args, truncate_after_chars = 2000) ⇒ Object 



131
132
133
134
135
136
 
# File 'lib/sidekiq/web_helpers.rb', line 131

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

#filtering ⇒ Object

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



20
21
 
# File 'lib/sidekiq/web_helpers.rb', line 20

def filtering(*)
end

#get_locale ⇒ Object 



28
29
30
 
# File 'lib/sidekiq/web_helpers.rb', line 28

def get_locale
  strings[locale]
end

#h(text) ⇒ Object 



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

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 



108
109
110
 
# File 'lib/sidekiq/web_helpers.rb', line 108

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

#locale ⇒ Object 



23
24
25
26
 
# File 'lib/sidekiq/web_helpers.rb', line 23

def locale
  lang = (request.env["HTTP_ACCEPT_LANGUAGE"] || 'en')[0,2]
  strings[lang] ? lang : 'en'
end

#location ⇒ Object 



80
81
82
 
# File 'lib/sidekiq/web_helpers.rb', line 80

def location
  Sidekiq.redis { |conn| conn.client.location }
end

#namespace ⇒ Object 



88
89
90
 
# File 'lib/sidekiq/web_helpers.rb', line 88

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

#number_with_delimiter(number) ⇒ Object 



152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/sidekiq/web_helpers.rb', line 152

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 



112
113
114
115
 
# File 'lib/sidekiq/web_helpers.rb', line 112

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

#qparams(options) ⇒ Object

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



120
121
122
123
124
125
 
# File 'lib/sidekiq/web_helpers.rb', line 120

def qparams(options)
  options = options.stringify_keys
  params.merge(options).map { |key, value|
    SAFE_QPARAMS.include?(key) ? "#{key}=#{value}" : next
  }.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.



175
176
177
178
179
180
181
182
183
 
# File 'lib/sidekiq/web_helpers.rb', line 175

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 



84
85
86
 
# File 'lib/sidekiq/web_helpers.rb', line 84

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

#relative_time(time) ⇒ Object 



104
105
106
 
# File 'lib/sidekiq/web_helpers.rb', line 104

def relative_time(time)
  %{<time datetime="#{time.getutc.iso8601}">#{time}</time>}
end

#reset_worker_list ⇒ Object 



37
38
39
40
41
42
 
# File 'lib/sidekiq/web_helpers.rb', line 37

def reset_worker_list
  Sidekiq.redis do |conn|
    workers = conn.smembers('workers')
    conn.srem('workers', workers) if !workers.empty?
  end
end

#retries_with_score(score) ⇒ Object 



74
75
76
77
78
 
# File 'lib/sidekiq/web_helpers.rb', line 74

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 



144
145
146
147
148
149
150
 
# File 'lib/sidekiq/web_helpers.rb', line 144

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

#root_path ⇒ Object 



92
93
94
 
# File 'lib/sidekiq/web_helpers.rb', line 92

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

#stats ⇒ Object 



70
71
72
 
# File 'lib/sidekiq/web_helpers.rb', line 70

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

#strings ⇒ Object 



6
7
8
9
10
11
12
13
14
15
16
17
 
# File 'lib/sidekiq/web_helpers.rb', line 6

def strings
  @@strings ||= begin
    # Allow sidekiq-web extensions to add locale paths
    # so extensions can be localized
    settings.locales.each_with_object({}) do |path,global|
      Dir["#{path}/*.yml"].each_with_object(global) do |file,hash|
        strs = YAML.load(File.open(file))
        hash.deep_merge!(strs)
      end
    end
  end
end

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



32
33
34
35
 
# File 'lib/sidekiq/web_helpers.rb', line 32

def t(msg, options={})
  string = get_locale[msg] || msg
  string % options
end

#truncate(text, truncate_after_chars = 2000) ⇒ Object 



127
128
129
 
# File 'lib/sidekiq/web_helpers.rb', line 127

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

#workers ⇒ Object 



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/sidekiq/web_helpers.rb', line 50

def workers
  @workers ||= begin
    to_rem = []
    workers = Sidekiq.redis do |conn|
      conn.smembers('workers').map do |w|
        msg = conn.get("worker:#{w}")
        msg ? [w, Sidekiq.load_json(msg)] : (to_rem << w; nil)
      end.compact.sort { |x| x[1] ? -1 : 1 }
    end

    # Detect and clear out any orphaned worker records.
    # These can be left in Redis if Sidekiq crashes hard
    # while processing jobs.
    if to_rem.size > 0
      Sidekiq.redis { |conn| conn.srem('workers', to_rem) }
    end
    workers
  end
end

#workers_size ⇒ Object 



44
45
46
47
48
 
# File 'lib/sidekiq/web_helpers.rb', line 44

def workers_size
  @workers_size ||= Sidekiq.redis do |conn|
    conn.scard('workers')
  end
end