From 7a41404c04957ec184d1e7d54907fface944785a Mon Sep 17 00:00:00 2001
From: Mike Perham <mperham@gmail.com>
Date: Sun, 13 Oct 2013 15:56:17 -0700
Subject: [PATCH] Web UI cleanup/refactoring, fixes #1247
- Pull out helpers into separate module
- Fix i18n strings to be loaded once, not every request
- Clearer separation between default and custom tabs
- Fix action redirects to contain the query string from the referrer so we don't lose our context upon redirect.
---
lib/sidekiq/web.rb | 189 +++++--------------------------------
lib/sidekiq/web_helpers.rb | 158 +++++++++++++++++++++++++++++++
web/views/_nav.erb | 7 +-
3 files changed, 183 insertions(+), 171 deletions(-)
create mode 100644 lib/sidekiq/web_helpers.rb
diff --git a/lib/sidekiq/web.rb b/lib/sidekiq/web.rb
index 62ff38c2..8bd07339 100644
--- a/lib/sidekiq/web.rb
+++ b/lib/sidekiq/web.rb
@@ -5,6 +5,7 @@ require 'sinatra/base'
require 'sidekiq'
require 'sidekiq/api'
require 'sidekiq/paginator'
+require 'sidekiq/web_helpers'
module Sidekiq
class Web < Sinatra::Base
@@ -15,166 +16,25 @@ module Sidekiq
set :views, Proc.new { "#{root}/views" }
set :locales, Proc.new { "#{root}/locales" }
- helpers do
- def strings
- @strings ||= begin
- Dir["#{settings.locales}/*.yml"].inject({}) do |memo, file|
- memo.merge(YAML.load(File.open(file)))
- end
- end
- end
+ helpers WebHelpers
- def locale
- lang = (request.env["HTTP_ACCEPT_LANGUAGE"] || 'en')[0,2]
- strings[lang] ? lang : 'en'
- end
+ DEFAULT_TABS = {
+ "Dashboard" => '',
+ "Workers" => 'workers',
+ "Queues" => 'queues',
+ "Retries" => 'retries',
+ "Scheduled" => 'scheduled',
+ }
- def get_locale
- strings[locale]
- end
-
- def t(msg, options={})
- string = get_locale[msg] || msg
- string % options
- end
-
- def reset_worker_list
- Sidekiq.redis do |conn|
- workers = conn.smembers('workers')
- conn.srem('workers', workers) if !workers.empty?
- end
- end
-
- def workers_size
- @workers_size ||= Sidekiq.redis do |conn|
- conn.scard('workers')
- end
- end
-
- 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
-
- def stats
- @stats ||= Sidekiq::Stats.new
- end
-
- def retries_with_score(score)
- Sidekiq.redis do |conn|
- results = conn.zrangebyscore('retry', score, score)
- results.map { |msg| Sidekiq.load_json(msg) }
- end
- end
-
- def location
- Sidekiq.redis { |conn| conn.client.location }
- end
-
- def namespace
- @@ns ||= Sidekiq.redis {|conn| conn.respond_to?(:namespace) ? conn.namespace : nil }
- end
-
- def root_path
- "#{env['SCRIPT_NAME']}/"
- end
-
- def current_path
- @current_path ||= request.path_info.gsub(/^\//,'')
- end
-
- def current_status
- return 'idle' if workers_size == 0
- return 'active'
- end
-
- def relative_time(time)
- %{<time datetime="#{time.getutc.iso8601}">#{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
-
- 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|
- a = arg.inspect
- truncate(a)
- end.join(", ")
- end
-
- 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
- ))
-
- 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 tabs
- @tabs ||= {
- "Dashboard" => '',
- "Workers" => 'workers',
- "Queues" => 'queues',
- "Retries" => 'retries',
- "Scheduled" => 'scheduled',
- }
+ class << self
+ def default_tabs
+ DEFAULT_TABS
end
def custom_tabs
- self.class.tabs
- end
-
- 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
-
- def redis_keys
- ["redis_stats", "uptime_in_days", "connected_clients", "used_memory_human", "used_memory_peak_human"]
- end
-
- def h(text)
- ERB::Util.h(text)
+ @custom_tabs ||= {}
end
+ alias_method :tabs, :custom_tabs
end
get "/workers" do
@@ -207,7 +67,7 @@ module Sidekiq
post "/queues/:name/delete" do
Sidekiq::Job.new(params[:key_val], params[:name]).delete
- redirect "#{root_path}queues/#{params[:name]}"
+ redirect_with_query("#{root_path}queues/#{params[:name]}")
end
get '/retries' do
@@ -236,7 +96,7 @@ module Sidekiq
job.delete
end
end
- redirect "#{root_path}retries"
+ redirect_with_query("#{root_path}retries")
end
post "/retries/all/delete" do
@@ -259,7 +119,7 @@ module Sidekiq
job.delete
end
end
- redirect "#{root_path}retries"
+ redirect_with_query("#{root_path}retries")
end
get '/scheduled' do
@@ -289,7 +149,7 @@ module Sidekiq
end
end
end
- redirect "#{root_path}scheduled"
+ redirect_with_query("#{root_path}scheduled")
end
post "/scheduled/:key" do
@@ -302,21 +162,23 @@ module Sidekiq
job.delete
end
end
- redirect "#{root_path}scheduled"
+ redirect_with_query("#{root_path}scheduled")
end
get '/' do
- @redis_info = Sidekiq.redis { |conn| conn.info }.select{ |k, v| redis_keys.include? k }
+ @redis_info = Sidekiq.redis { |conn| conn.info }.select{ |k, v| REDIS_KEYS.include? k }
stats_history = Sidekiq::Stats::History.new((params[:days] || 30).to_i)
@processed_history = stats_history.processed
@failed_history = stats_history.failed
erb :dashboard
end
+ REDIS_KEYS = %w(redis_stats uptime_in_days connected_clients used_memory_human used_memory_peak_human)
+
get '/dashboard/stats' do
sidekiq_stats = Sidekiq::Stats.new
queue = Sidekiq::Queue.new
- redis_stats = Sidekiq.redis { |conn| conn.info }.select{ |k, v| redis_keys.include? k }
+ redis_stats = Sidekiq.redis { |conn| conn.info }.select{ |k, v| REDIS_KEYS.include? k }
content_type :json
Sidekiq.dump_json({
@@ -333,10 +195,5 @@ module Sidekiq
})
end
- def self.tabs
- @custom_tabs ||= {}
- end
-
end
-
end
diff --git a/lib/sidekiq/web_helpers.rb b/lib/sidekiq/web_helpers.rb
new file mode 100644
index 00000000..2054d1cc
--- /dev/null
+++ b/lib/sidekiq/web_helpers.rb
@@ -0,0 +1,158 @@
+require 'uri'
+
+module Sidekiq
+ # This is not a public API
+ module WebHelpers
+ def strings
+ @@strings ||= begin
+ Dir["#{settings.locales}/*.yml"].inject({}) do |memo, file|
+ memo.merge(YAML.load(File.open(file)))
+ end
+ end
+ end
+
+ def locale
+ lang = (request.env["HTTP_ACCEPT_LANGUAGE"] || 'en')[0,2]
+ strings[lang] ? lang : 'en'
+ end
+
+ def get_locale
+ strings[locale]
+ end
+
+ def t(msg, options={})
+ string = get_locale[msg] || msg
+ string % options
+ end
+
+ def reset_worker_list
+ Sidekiq.redis do |conn|
+ workers = conn.smembers('workers')
+ conn.srem('workers', workers) if !workers.empty?
+ end
+ end
+
+ def workers_size
+ @workers_size ||= Sidekiq.redis do |conn|
+ conn.scard('workers')
+ end
+ end
+
+ 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
+
+ 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 location
+ Sidekiq.redis { |conn| conn.client.location }
+ end
+
+ def namespace
+ @@ns ||= Sidekiq.redis {|conn| conn.respond_to?(:namespace) ? conn.namespace : nil }
+ end
+
+ def root_path
+ "#{env['SCRIPT_NAME']}/"
+ end
+
+ def current_path
+ @current_path ||= request.path_info.gsub(/^\//,'')
+ end
+
+ def current_status
+ workers_size == 0 ? 'idle' : 'active'
+ end
+
+ def relative_time(time)
+ %{<time datetime="#{time.getutc.iso8601}">#{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
+
+ 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|
+ a = arg.inspect
+ truncate(a)
+ end.join(", ")
+ end
+
+ 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
+ ))
+
+ 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
+
+ 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)
+ ERB::Util.h(text)
+ 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
+ end
+end
diff --git a/web/views/_nav.erb b/web/views/_nav.erb
index cef78007..f43a68f9 100644
--- a/web/views/_nav.erb
+++ b/web/views/_nav.erb
@@ -5,7 +5,7 @@
<%= erb :_status %>
</a>
<ul class="nav navbar-nav">
- <% tabs.each do |title, url| %>
+ <% Sidekiq::Web.default_tabs.each do |title, url| %>
<% if url == '' %>
<li class="<%= current_path == url ? 'active' : '' %>">
<a href="<%= root_path %><%= url %>"><%= t(title) %></a>
@@ -16,14 +16,11 @@
</li>
<% end %>
<% end %>
- <% custom_tabs.each do |title, url| %>
+ <% Sidekiq::Web.custom_tabs.each do |title, url| %>
<li class="<%= current_path.start_with?(url) ? 'active' : '' %>">
<a href="<%= root_path %><%= url %>"><%= t(title) %></a>
</li>
<% end %>
-
-
-
</ul>
<div class="col-sm-2 pull-right poll-wrapper">