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

Implement compatibility interface with sinatra

This commit is contained in:
Amadeus Folego 2016-07-28 23:36:21 -03:00
parent 91fd77d44e
commit d05066dc1a
20 changed files with 185 additions and 129 deletions

View file

@ -34,6 +34,10 @@ module Sidekiq
}
class << self
def settings
self
end
def default_tabs
DEFAULT_TABS
end
@ -47,12 +51,20 @@ module Sidekiq
@locales ||= LOCALES
end
def views
@views ||= VIEWS
end
def session_secret=(secret)
@secret = secret
@session_secret = secret
end
attr_accessor :app_url, :session_secret
attr_writer :locales
attr_writer :locales, :views
end
def settings
self.class.settings
end
def initialize

View file

@ -6,17 +6,35 @@ module Sidekiq
LOCATION = "Location".freeze
TEXT_HTML = { "Content-Type".freeze => "text/html".freeze }
APPLICATION_JSON = { "Content-Type".freeze => "application/json".freeze }
CONTENT_TYPE = "Content-Type".freeze
TEXT_HTML = { CONTENT_TYPE => "text/html".freeze }
APPLICATION_JSON = { CONTENT_TYPE => "application/json".freeze }
attr_accessor :env, :app
attr_accessor :env, :app, :type
def settings
Web.settings
end
def request
@request ||= Rack::Request.new(env)
end
def halt(res)
throw :halt, res
end
def redirect(location)
throw :halt, [302, { LOCATION => "#{request.base_url}#{location}" }, []]
end
def params
request.params
indifferent_hash = Hash.new {|hash,key| hash[key.to_s] if Symbol === key }
indifferent_hash.merge! request.params
route_params.each {|k,v| indifferent_hash[k.to_s] = v }
indifferent_hash
end
def route_params
@ -27,28 +45,29 @@ module Sidekiq
env[RACK_SESSION]
end
def erb(content, options = {})
b = binding
def content_type(type)
@type = type
end
if locals = options[:locals]
locals.each {|k, v| b.local_variable_set(k, v) }
def erb(content, options = {})
if content.kind_of? Symbol
content = File.read("#{Web.settings.views}/#{content}.erb")
end
_render { ERB.new(content).result(b) }
if @_erb
_erb(content, options[:locals])
else
@_erb = true
content = _erb(content, options[:locals])
_render { content }
end
end
def partial(file, locals = {})
ERB.new(File.read "#{Web::VIEWS}/_#{file}.erb").result(binding)
end
def render(engine, content, options = {})
raise "Only erb templates are supported" if engine != :erb
def redirect(location)
[302, { LOCATION => "#{request.base_url}#{root_path}#{location}" }, []]
end
def render(file, locals = {})
output = erb(File.read "#{Web::VIEWS}/#{file}.erb", locals: locals)
[200, TEXT_HTML, [output]]
erb(content, options)
end
def json(payload)
@ -59,5 +78,13 @@ module Sidekiq
@env = env
@app = app
end
private
def _erb(file, locals)
locals.each {|k, v| define_singleton_method(k){ v } } if locals
ERB.new(file).result(binding)
end
end
end

View file

@ -4,20 +4,25 @@ module Sidekiq
class WebApplication
extend WebRouter
CONTENT_TYPE = "Content-Type".freeze
REDIS_KEYS = %w(redis_version uptime_in_days connected_clients used_memory_human used_memory_peak_human)
NOPE = [404, {}, []]
def self.settings
Web.settings
end
get "/" do
@redis_info = redis_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
render(:dashboard)
erb(:dashboard)
end
get "/busy" do
render(:busy)
erb(:busy)
end
post "/busy" do
@ -32,39 +37,39 @@ module Sidekiq
end
end
redirect "busy"
redirect "#{root_path}busy"
end
get "/queues" do
@queues = Sidekiq::Queue.all
render(:queues)
erb(:queues)
end
get "/queues/:name" do
@name = route_params[:name]
next(NOPE) unless @name
halt(404) unless @name
@count = (params['count'] || 25).to_i
@queue = Sidekiq::Queue.new(@name)
(@current_page, @total_size, @messages) = page("queue:#{@name}", params['page'], @count)
@messages = @messages.map { |msg| Sidekiq::Job.new(msg, @name) }
render(:queue)
erb(:queue)
end
post "/queues/:name" do
Sidekiq::Queue.new(route_params[:name]).clear
redirect "queues"
redirect "#{root_path}queues"
end
post "/queues/:name/delete" do
name = route_params[:name]
Sidekiq::Job.new(params['key_val'], name).delete
redirect_with_query("queues/#{name}")
redirect_with_query("#{root_path}queues/#{name}")
end
get '/morgue' do
@ -72,51 +77,51 @@ module Sidekiq
(@current_page, @total_size, @dead) = page("dead", params['page'], @count, reverse: true)
@dead = @dead.map { |msg, score| Sidekiq::SortedEntry.new(nil, score, msg) }
render(:morgue)
erb(:morgue)
end
get "/morgue/:key" do
next NOPE unless key = route_params[:key]
halt(404) unless key = route_params[:key]
@dead = Sidekiq::DeadSet.new.fetch(*parse_params(key)).first
if @dead.nil?
redirect "morgue"
redirect "#{root_path}morgue"
else
render(:dead)
erb(:dead)
end
end
post '/morgue' do
next redirect(request.path) unless params['key']
redirect(request.path) unless params['key']
params['key'].each do |key|
job = Sidekiq::DeadSet.new.fetch(*parse_params(key)).first
retry_or_delete_or_kill job, params if job
end
redirect_with_query("morgue")
redirect_with_query("#{root_path}morgue")
end
post "/morgue/all/delete" do
Sidekiq::DeadSet.new.clear
redirect "morgue"
redirect "#{root_path}morgue"
end
post "/morgue/all/retry" do
Sidekiq::DeadSet.new.retry_all
redirect "morgue"
redirect "#{root_path}morgue"
end
post "/morgue/:key" do
next NOPE unless key = route_params[:key]
halt(404) unless key = route_params[:key]
job = Sidekiq::DeadSet.new.fetch(*parse_params(key)).first
retry_or_delete_or_kill job, params if job
redirect_with_query("morgue")
redirect_with_query("#{root_path}morgue")
end
get '/retries' do
@ -124,40 +129,40 @@ module Sidekiq
(@current_page, @total_size, @retries) = page("retry", params['page'], @count)
@retries = @retries.map { |msg, score| Sidekiq::SortedEntry.new(nil, score, msg) }
render(:retries)
erb(:retries)
end
get "/retries/:key" do
@retry = Sidekiq::RetrySet.new.fetch(*parse_params(route_params[:key])).first
if @retry.nil?
redirect "retries"
redirect "#{root_path}retries"
else
render(:retry)
erb(:retry)
end
end
post '/retries' do
next redirect(request.path) unless params['key']
redirect(request.path) unless params['key']
params['key'].each do |key|
job = Sidekiq::RetrySet.new.fetch(*parse_params(key)).first
retry_or_delete_or_kill job, params if job
end
redirect_with_query("retries")
redirect_with_query("#{root_path}retries")
end
post "/retries/all/delete" do
Sidekiq::RetrySet.new.clear
redirect "retries"
redirect "#{root_path}retries"
end
post "/retries/all/retry" do
Sidekiq::RetrySet.new.retry_all
redirect "retries"
redirect "#{root_path}retries"
end
post "/retries/:key" do
@ -165,7 +170,7 @@ module Sidekiq
retry_or_delete_or_kill job, params if job
redirect_with_query("retries")
redirect_with_query("#{root_path}retries")
end
get '/scheduled' do
@ -173,41 +178,41 @@ module Sidekiq
(@current_page, @total_size, @scheduled) = page("schedule", params['page'], @count)
@scheduled = @scheduled.map { |msg, score| Sidekiq::SortedEntry.new(nil, score, msg) }
render(:scheduled)
erb(:scheduled)
end
get "/scheduled/:key" do
@job = Sidekiq::ScheduledSet.new.fetch(*parse_params(route_params[:key])).first
if @job.nil?
redirect "scheduled"
redirect "#{root_path}scheduled"
else
render(:scheduled_job_info)
erb(:scheduled_job_info)
end
end
post '/scheduled' do
next redirect(request.path) unless params['key']
redirect(request.path) unless params['key']
params['key'].each do |key|
job = Sidekiq::ScheduledSet.new.fetch(*parse_params(key)).first
delete_or_add_queue job, params if job
end
redirect_with_query("scheduled")
redirect_with_query("#{root_path}scheduled")
end
post "/scheduled/:key" do
next NOPE unless key = route_params[:key]
halt(404) unless key = route_params[:key]
job = Sidekiq::ScheduledSet.new.fetch(*parse_params(key)).first
delete_or_add_queue job, params if job
redirect_with_query("scheduled")
redirect_with_query("#{root_path}scheduled")
end
get '/dashboard/stats' do
redirect "stats"
redirect "#{root_path}stats"
end
get '/stats' do
@ -238,42 +243,60 @@ module Sidekiq
action = self.class.match(env)
return NOPE unless action
self.class.run_befores(env)
resp = action.instance_exec env, &action.app
self.class.run_afters(env)
resp = catch(:halt) do
self.class.run_befores(action)
resp = action.instance_exec env, &action.app
self.class.run_afters(action)
resp
end
case resp
when Array
resp
when Integer
when Fixnum
[resp, {}, []]
else
[200, WebAction::TEXT_HTML, [resp]]
headers = case action.type
when :json
WebAction::APPLICATION_JSON
when String
{ WebAction::CONTENT_TYPE => action.type }
else
WebAction::TEXT_HTML
end
[200, headers, [resp]]
end
end
def self.helpers(mod)
WebAction.send(:include, mod)
end
def self.before(&block)
befores << block
end
def self.after(&block)
afters << block
end
def self.run_befores(env)
befores.each do |b|
b.call(env)
def self.helpers(mod=nil, &block)
if block_given?
WebAction.class_eval(&block)
else
WebAction.send(:include, mod)
end
end
def self.run_afters(env)
afters.each do |b|
b.call(env)
end
def self.before(path=nil, &block)
befores << [path && Regexp.new("\\A#{path.gsub("*", ".*")}\\z"), block]
end
def self.after(path=nil, &block)
afters << [path && Regexp.new("\\A#{path.gsub("*", ".*")}\\z"), block]
end
def self.run_befores(action)
run_hooks(befores, action)
end
def self.run_afters(action)
run_hooks(afters, action)
end
def self.run_hooks(hooks, action)
hooks.select { |p,_| !p || p =~ action.env[WebRouter::PATH_INFO] }.
each {|_,b| action.instance_exec(action.env, &b) }
end
def self.befores

View file

@ -10,7 +10,7 @@ module Sidekiq
@@strings[lang] ||= begin
# Allow sidekiq-web extensions to add locale paths
# so extensions can be localized
Web.locales.each_with_object({}) do |path, global|
settings.locales.each_with_object({}) do |path, global|
find_locale_files(lang).each do |file|
strs = YAML.load(File.open(file))
global.deep_merge!(strs[lang])
@ -25,7 +25,7 @@ module Sidekiq
end
def locale_files
@@locale_files ||= Web.locales.flat_map do |path|
@@locale_files ||= settings.locales.flat_map do |path|
Dir["#{path}/*.yml"]
end
end
@ -46,21 +46,13 @@ module Sidekiq
# <meta .../>
# <% end %>
#
def add_to_head(&block)
def add_to_head
@head_html ||= []
@head_html << block if block_given?
@head_html << yield.dup if block_given?
end
def display_custom_head
return unless defined?(@head_html)
@head_html.map { |block| capture(&block) }.join
end
# Simple capture method for erb templates. The origin was
# capture method from sinatra-contrib library.
def capture(&block)
block.call
eval('', block.binding)
@head_html.join if @head_html
end
# Given a browser request Accept-Language header like

View file

@ -3,6 +3,7 @@
module Sidekiq
module WebRouter
GET = 'GET'.freeze
DELETE = 'DELETE'.freeze
POST = 'POST'.freeze
HEAD = 'HEAD'.freeze
@ -18,6 +19,10 @@ module Sidekiq
route(POST, path, &block)
end
def delete(path, &block)
route(DELETE, path, &block)
end
def route(method, path, &block)
@routes ||= []
@routes << WebRoute.new(method, path, block)

View file

@ -3,7 +3,6 @@
require_relative 'helper'
require 'sidekiq/web'
require 'rack/test'
#require 'tilt/erubis'
class TestWeb < Sidekiq::Test
@ -371,18 +370,17 @@ class TestWeb < Sidekiq::Test
describe 'custom locales' do
before do
Sidekiq::Web.locales << File.join(File.dirname(__FILE__), "fixtures")
Sidekiq::Web.settings.locales << File.join(File.dirname(__FILE__), "fixtures")
Sidekiq::Web.tabs['Custom Tab'] = '/custom'
Sidekiq::WebApplication.get('/custom') do
clear_caches # ugly hack since I can't figure out how to access WebHelpers outside of this context
[200, { "Content-Type" => 'text/html' }, [ t('translated_text') ]]
t('translated_text')
end
end
after do
Sidekiq::Web.tabs.delete 'Custom Tab'
Sidekiq::Web.locales.pop
Sidekiq::Web.settings.locales.pop
end
it 'can show user defined tab with custom locales' do

View file

@ -1,5 +1,3 @@
<% job = locals[:job] %>
<header>
<h3><%= t('Job') %></h3>
</header>
@ -52,7 +50,7 @@
</td>
</tr>
<% end %>
<% if locals[:type] == :retry %>
<% if type == :retry %>
<% if job['retry_count'] && job['retry_count'] > 0 %>
<tr>
<th><%= t('RetryCount') %></th>
@ -73,13 +71,13 @@
<td><%= relative_time(job.at) %></td>
</tr>
<% end %>
<% if locals[:type] == :scheduled %>
<% if type == :scheduled %>
<tr>
<th><%= t('Scheduled') %></th>
<td><%= relative_time(job.at) %></td>
</tr>
<% end %>
<% if locals[:type] == :dead %>
<% if type == :dead %>
<tr>
<th><%= t('LastRetry') %></th>
<td><%= relative_time(job.at) %></td>

View file

@ -7,14 +7,14 @@
<span class="icon-bar"></span>
</button>
<div class="navbar-toggle collapsed navbar-livereload">
<%= partial :poll_link %>
<%= erb :_poll_link %>
<% if Sidekiq::Web.app_url %>
<a class="btn btn-inverse" href="<%= Sidekiq::Web.app_url %>">Back to App</a>
<% end %>
</div>
<a class="navbar-brand" href="<%= root_path %>">
<%= Sidekiq::NAME %>
<%= partial :status %>
<%= erb :_status %>
</a>
</div>
@ -54,7 +54,7 @@
<ul class="nav navbar-nav navbar-right navbar-livereload" data-navbar="static">
<li>
<div class="poll-wrapper pull-right">
<%= partial :poll_link %>
<%= erb :_poll_link %>
<% if Sidekiq::Web.app_url %>
<a class="btn btn-inverse" href="<%= Sidekiq::Web.app_url %>"><%= t('BackToApp') %></a>
<% end %>

View file

@ -1,23 +1,23 @@
<% if @total_size > @count %>
<ul class="pagination pull-right">
<li class="<%= 'disabled' if @current_page == 1 %>">
<a href="<%= locals[:url] %>?page=1">&laquo;</a>
<a href="<%= url %>?page=1">&laquo;</a>
</li>
<% if @current_page > 1 %>
<li>
<a href="<%= locals[:url] %>?<%= qparams(page: @current_page - 1) %>"><%= @current_page - 1 %></a>
<a href="<%= url %>?<%= qparams(page: @current_page - 1) %>"><%= @current_page - 1 %></a>
</li>
<% end %>
<li class="disabled">
<a href="<%= locals[:url] %>?<%= qparams(page: @current_page) %>"><%= @current_page %></a>
<a href="<%= url %>?<%= qparams(page: @current_page) %>"><%= @current_page %></a>
</li>
<% if @total_size > @current_page * @count %>
<li>
<a href="<%= locals[:url] %>?<%= qparams(page: @current_page + 1) %>"><%= @current_page + 1 %></a>
<a href="<%= url %>?<%= qparams(page: @current_page + 1) %>"><%= @current_page + 1 %></a>
</li>
<% end %>
<li class="<%= 'disabled' if @total_size <= @current_page * @count %>">
<a href="<%= locals[:url] %>?<%= qparams(page: (@total_size.to_f / @count).ceil) %>">&raquo;</a>
<a href="<%= url %>?<%= qparams(page: (@total_size.to_f / @count).ceil) %>">&raquo;</a>
</li>
</ul>
<% end %>

View file

@ -1,4 +1,4 @@
<% if current_path != '' && params['poll'] %>
<% if current_path != '' && params[:poll] %>
<script>
updatePage('<%= root_path + current_path %>')
</script>

View file

@ -1,5 +1,5 @@
<% if current_path != '' %>
<% if params['poll'] %>
<% if params[:poll] %>
<a id="live-poll" class="btn btn-primary active" href="<%= root_path + current_path %>"><%= t('StopPolling') %></a>
<% else %>
<a id="live-poll" class="btn btn-primary" href="<%= root_path + current_path %>?<%= qparams(poll: true) %>"><%= t('LivePoll') %></a>

View file

@ -23,10 +23,10 @@
<div class="row chart">
<h5>
<span class="history-heading"><%= t('History') %></span>
<a href="<%= root_path %>?days=7" class="history-graph <%= "active" if params['days'] == "7" %>"><%= t('OneWeek') %></a>
<a href="<%= root_path %>" class="history-graph <%= "active" if params['days'].nil? || params['days'] == "30" %>"><%= t('OneMonth') %></a>
<a href="<%= root_path %>?days=90" class="history-graph <%= "active" if params['days'] == "90" %>"><%= t('ThreeMonths') %></a>
<a href="<%= root_path %>?days=180" class="history-graph <%= "active" if params['days'] == "180" %>"><%= t('SixMonths') %></a>
<a href="<%= root_path %>?days=7" class="history-graph <%= "active" if params[:days] == "7" %>"><%= t('OneWeek') %></a>
<a href="<%= root_path %>" class="history-graph <%= "active" if params[:days].nil? || params[:days] == "30" %>"><%= t('OneMonth') %></a>
<a href="<%= root_path %>?days=90" class="history-graph <%= "active" if params[:days] == "90" %>"><%= t('ThreeMonths') %></a>
<a href="<%= root_path %>?days=180" class="history-graph <%= "active" if params[:days] == "180" %>"><%= t('SixMonths') %></a>
</h5>
<div id="history" data-processed-label="<%= t('Processed') %>" data-failed-label="<%= t('Failed') %>" data-processed="<%= h Sidekiq.dump_json(@processed_history) %>" data-failed="<%= h Sidekiq.dump_json(@failed_history) %>" data-update-url="<%= root_path %>stats"></div>

View file

@ -1,4 +1,4 @@
<%= partial :job_info, job: @dead, type: :dead %>
<%= erb :_job_info, locals: { job: @dead, type: :dead } %>
<h3><%= t('Error') %></h3>
<div class="table_container">

View file

@ -2,6 +2,7 @@
<html>
<head>
<title><%= environment_title_prefix %><%= Sidekiq::NAME %></title>
<meta charset="utf8" />
<meta name="viewport" content="width=device-width,initial-scale=1.0" />
<link href="<%= root_path %>stylesheets/bootstrap.css" media="screen" rel="stylesheet" type="text/css" />
<link href="<%= root_path %>stylesheets/application.css" media="screen" rel="stylesheet" type="text/css" />
@ -12,12 +13,12 @@
<%= display_custom_head %>
</head>
<body class="admin">
<%= partial :nav %>
<%= erb :_nav %>
<div id="page">
<div class="container">
<div class="row">
<div class="col-sm-12 summary_bar">
<%= partial :summary %>
<%= erb :_summary %>
</div>
<div class="col-sm-12">
@ -26,7 +27,7 @@
</div>
</div>
</div>
<%= partial :footer %>
<%= partial :poll_js %>
<%= erb :_footer %>
<%= erb :_poll_js %>
</body>
</html>

View file

@ -4,7 +4,7 @@
</div>
<% if @dead.size > 0 && @total_size > @count %>
<div class="col-sm-4">
<%= partial :paging, url: "#{root_path}morgue" %>
<%= erb :_paging, locals: { url: "#{root_path}morgue" } %>
</div>
<% end %>
<%= filtering('dead') %>

View file

@ -8,7 +8,7 @@
</h3>
</div>
<div class="col-sm-4 pull-right">
<%= partial :paging, url: "#{root_path}queues/#{@name}" %>
<%= erb :_paging, locals: { url: "#{root_path}queues/#{@name}" } %>
</div>
</header>
<div class="table_container">
@ -42,4 +42,4 @@
<% end %>
</table>
</div>
<%= partial :paging, url: "#{root_path}queues/#{@name}" %>
<%= erb :_paging, locals: { url: "#{root_path}queues/#{@name}" } %>

View file

@ -4,7 +4,7 @@
</div>
<% if @retries.size > 0 && @total_size > @count %>
<div class="col-sm-4">
<%= partial :paging, url: "#{root_path}retries" %>
<%= erb :_paging, locals: { url: "#{root_path}retries" } %>
</div>
<% end %>
<%= filtering('retries') %>

View file

@ -1,4 +1,4 @@
<%= partial :job_info, job: @retry, type: :retry %>
<%= erb :_job_info, locals: { job: @retry, type: :retry } %>
<h3><%= t('Error') %></h3>
<div class="table_container">

View file

@ -4,7 +4,7 @@
</div>
<% if @scheduled.size > 0 && @total_size > @count %>
<div class="col-sm-4">
<%= partial :paging, url: "#{root_path}scheduled" %>
<%= erb :_paging, locals: { url: "#{root_path}scheduled" } %>
</div>
<% end %>
<%= filtering('scheduled') %>

View file

@ -1,4 +1,4 @@
<%= partial :job_info, job: @job, type: :scheduled %>
<%= erb :_job_info, locals: { job: @job, type: :scheduled } %>
<form class="form-horizontal" action="<%= root_path %>scheduled/<%= job_params(@job, @job.score) %>" method="post">
<%= csrf_tag %>