sidekiq 0.10.0 → 7.1.6
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Changes.md +2047 -0
- data/LICENSE.txt +9 -0
- data/README.md +73 -27
- data/bin/sidekiq +25 -9
- data/bin/sidekiqload +247 -0
- data/bin/sidekiqmon +11 -0
- data/lib/generators/sidekiq/job_generator.rb +57 -0
- data/lib/generators/sidekiq/templates/job.rb.erb +9 -0
- data/lib/generators/sidekiq/templates/job_spec.rb.erb +6 -0
- data/lib/generators/sidekiq/templates/job_test.rb.erb +8 -0
- data/lib/sidekiq/api.rb +1145 -0
- data/lib/sidekiq/capsule.rb +127 -0
- data/lib/sidekiq/cli.rb +348 -109
- data/lib/sidekiq/client.rb +241 -41
- data/lib/sidekiq/component.rb +68 -0
- data/lib/sidekiq/config.rb +287 -0
- data/lib/sidekiq/deploy.rb +62 -0
- data/lib/sidekiq/embedded.rb +61 -0
- data/lib/sidekiq/fetch.rb +88 -0
- data/lib/sidekiq/job.rb +374 -0
- data/lib/sidekiq/job_logger.rb +51 -0
- data/lib/sidekiq/job_retry.rb +300 -0
- data/lib/sidekiq/job_util.rb +107 -0
- data/lib/sidekiq/launcher.rb +271 -0
- data/lib/sidekiq/logger.rb +131 -0
- data/lib/sidekiq/manager.rb +96 -103
- data/lib/sidekiq/metrics/query.rb +153 -0
- data/lib/sidekiq/metrics/shared.rb +95 -0
- data/lib/sidekiq/metrics/tracking.rb +136 -0
- data/lib/sidekiq/middleware/chain.rb +149 -38
- data/lib/sidekiq/middleware/current_attributes.rb +95 -0
- data/lib/sidekiq/middleware/i18n.rb +42 -0
- data/lib/sidekiq/middleware/modules.rb +21 -0
- data/lib/sidekiq/monitor.rb +146 -0
- data/lib/sidekiq/paginator.rb +55 -0
- data/lib/sidekiq/processor.rb +246 -61
- data/lib/sidekiq/rails.rb +60 -13
- data/lib/sidekiq/redis_client_adapter.rb +95 -0
- data/lib/sidekiq/redis_connection.rb +68 -15
- data/lib/sidekiq/ring_buffer.rb +29 -0
- data/lib/sidekiq/scheduled.rb +236 -0
- data/lib/sidekiq/sd_notify.rb +149 -0
- data/lib/sidekiq/systemd.rb +24 -0
- data/lib/sidekiq/testing/inline.rb +30 -0
- data/lib/sidekiq/testing.rb +304 -10
- data/lib/sidekiq/transaction_aware_client.rb +44 -0
- data/lib/sidekiq/version.rb +4 -1
- data/lib/sidekiq/web/action.rb +93 -0
- data/lib/sidekiq/web/application.rb +447 -0
- data/lib/sidekiq/web/csrf_protection.rb +180 -0
- data/lib/sidekiq/web/helpers.rb +370 -0
- data/lib/sidekiq/web/router.rb +104 -0
- data/lib/sidekiq/web.rb +143 -74
- data/lib/sidekiq/worker_compatibility_alias.rb +13 -0
- data/lib/sidekiq.rb +120 -73
- data/sidekiq.gemspec +26 -23
- data/web/assets/images/apple-touch-icon.png +0 -0
- data/web/assets/images/favicon.ico +0 -0
- data/web/assets/images/logo.png +0 -0
- data/web/assets/images/status.png +0 -0
- data/web/assets/javascripts/application.js +162 -3
- data/web/assets/javascripts/base-charts.js +106 -0
- data/web/assets/javascripts/chart.min.js +13 -0
- data/web/assets/javascripts/chartjs-plugin-annotation.min.js +7 -0
- data/web/assets/javascripts/dashboard-charts.js +168 -0
- data/web/assets/javascripts/dashboard.js +59 -0
- data/web/assets/javascripts/metrics.js +264 -0
- data/web/assets/stylesheets/application-dark.css +147 -0
- data/web/assets/stylesheets/application-rtl.css +153 -0
- data/web/assets/stylesheets/application.css +720 -7
- data/web/assets/stylesheets/bootstrap-rtl.min.css +9 -0
- data/web/assets/stylesheets/bootstrap.css +5 -0
- data/web/locales/ar.yml +87 -0
- data/web/locales/cs.yml +78 -0
- data/web/locales/da.yml +75 -0
- data/web/locales/de.yml +81 -0
- data/web/locales/el.yml +87 -0
- data/web/locales/en.yml +101 -0
- data/web/locales/es.yml +86 -0
- data/web/locales/fa.yml +80 -0
- data/web/locales/fr.yml +99 -0
- data/web/locales/gd.yml +99 -0
- data/web/locales/he.yml +80 -0
- data/web/locales/hi.yml +75 -0
- data/web/locales/it.yml +69 -0
- data/web/locales/ja.yml +91 -0
- data/web/locales/ko.yml +68 -0
- data/web/locales/lt.yml +83 -0
- data/web/locales/nb.yml +77 -0
- data/web/locales/nl.yml +68 -0
- data/web/locales/pl.yml +59 -0
- data/web/locales/pt-br.yml +96 -0
- data/web/locales/pt.yml +67 -0
- data/web/locales/ru.yml +83 -0
- data/web/locales/sv.yml +68 -0
- data/web/locales/ta.yml +75 -0
- data/web/locales/uk.yml +77 -0
- data/web/locales/ur.yml +80 -0
- data/web/locales/vi.yml +83 -0
- data/web/locales/zh-cn.yml +95 -0
- data/web/locales/zh-tw.yml +102 -0
- data/web/views/_footer.erb +23 -0
- data/web/views/_job_info.erb +105 -0
- data/web/views/_metrics_period_select.erb +12 -0
- data/web/views/_nav.erb +52 -0
- data/web/views/_paging.erb +25 -0
- data/web/views/_poll_link.erb +4 -0
- data/web/views/_status.erb +4 -0
- data/web/views/_summary.erb +40 -0
- data/web/views/busy.erb +148 -0
- data/web/views/dashboard.erb +115 -0
- data/web/views/dead.erb +34 -0
- data/web/views/filtering.erb +7 -0
- data/web/views/layout.erb +42 -0
- data/web/views/metrics.erb +82 -0
- data/web/views/metrics_for_job.erb +68 -0
- data/web/views/morgue.erb +74 -0
- data/web/views/queue.erb +55 -0
- data/web/views/queues.erb +40 -0
- data/web/views/retries.erb +79 -0
- data/web/views/retry.erb +34 -0
- data/web/views/scheduled.erb +56 -0
- data/web/views/scheduled_job_info.erb +8 -0
- metadata +159 -237
- data/.gitignore +0 -6
- data/.rvmrc +0 -4
- data/COMM-LICENSE +0 -75
- data/Gemfile +0 -10
- data/LICENSE +0 -22
- data/Rakefile +0 -9
- data/TODO.md +0 -1
- data/bin/client +0 -7
- data/bin/sidekiqctl +0 -43
- data/config.ru +0 -8
- data/examples/chef/cookbooks/sidekiq/README.rdoc +0 -11
- data/examples/chef/cookbooks/sidekiq/recipes/default.rb +0 -55
- data/examples/chef/cookbooks/sidekiq/templates/default/monitrc.conf.erb +0 -8
- data/examples/chef/cookbooks/sidekiq/templates/default/sidekiq.erb +0 -219
- data/examples/chef/cookbooks/sidekiq/templates/default/sidekiq.yml.erb +0 -22
- data/examples/config.yml +0 -9
- data/examples/monitrc.conf +0 -6
- data/examples/por.rb +0 -27
- data/examples/scheduling.rb +0 -37
- data/examples/sinkiq.rb +0 -57
- data/examples/web-ui.png +0 -0
- data/lib/sidekiq/capistrano.rb +0 -32
- data/lib/sidekiq/extensions/action_mailer.rb +0 -26
- data/lib/sidekiq/extensions/active_record.rb +0 -27
- data/lib/sidekiq/extensions/generic_proxy.rb +0 -21
- data/lib/sidekiq/middleware/client/unique_jobs.rb +0 -32
- data/lib/sidekiq/middleware/server/active_record.rb +0 -13
- data/lib/sidekiq/middleware/server/exception_handler.rb +0 -38
- data/lib/sidekiq/middleware/server/failure_jobs.rb +0 -24
- data/lib/sidekiq/middleware/server/logging.rb +0 -27
- data/lib/sidekiq/middleware/server/retry_jobs.rb +0 -59
- data/lib/sidekiq/middleware/server/unique_jobs.rb +0 -15
- data/lib/sidekiq/retry.rb +0 -57
- data/lib/sidekiq/util.rb +0 -61
- data/lib/sidekiq/worker.rb +0 -37
- data/myapp/.gitignore +0 -15
- data/myapp/Capfile +0 -5
- data/myapp/Gemfile +0 -19
- data/myapp/Gemfile.lock +0 -143
- data/myapp/Rakefile +0 -7
- data/myapp/app/controllers/application_controller.rb +0 -3
- data/myapp/app/controllers/work_controller.rb +0 -38
- data/myapp/app/helpers/application_helper.rb +0 -2
- data/myapp/app/mailers/.gitkeep +0 -0
- data/myapp/app/mailers/user_mailer.rb +0 -9
- data/myapp/app/models/.gitkeep +0 -0
- data/myapp/app/models/post.rb +0 -5
- data/myapp/app/views/layouts/application.html.erb +0 -14
- data/myapp/app/views/user_mailer/greetings.html.erb +0 -3
- data/myapp/app/views/work/index.html.erb +0 -1
- data/myapp/app/workers/hard_worker.rb +0 -9
- data/myapp/config/application.rb +0 -59
- data/myapp/config/boot.rb +0 -6
- data/myapp/config/database.yml +0 -25
- data/myapp/config/deploy.rb +0 -15
- data/myapp/config/environment.rb +0 -5
- data/myapp/config/environments/development.rb +0 -38
- data/myapp/config/environments/production.rb +0 -67
- data/myapp/config/environments/test.rb +0 -37
- data/myapp/config/initializers/backtrace_silencers.rb +0 -7
- data/myapp/config/initializers/inflections.rb +0 -15
- data/myapp/config/initializers/mime_types.rb +0 -5
- data/myapp/config/initializers/secret_token.rb +0 -7
- data/myapp/config/initializers/session_store.rb +0 -8
- data/myapp/config/initializers/sidekiq.rb +0 -6
- data/myapp/config/initializers/wrap_parameters.rb +0 -14
- data/myapp/config/locales/en.yml +0 -5
- data/myapp/config/routes.rb +0 -10
- data/myapp/config.ru +0 -4
- data/myapp/db/migrate/20120123214055_create_posts.rb +0 -10
- data/myapp/db/seeds.rb +0 -7
- data/myapp/lib/assets/.gitkeep +0 -0
- data/myapp/lib/tasks/.gitkeep +0 -0
- data/myapp/log/.gitkeep +0 -0
- data/myapp/script/rails +0 -6
- data/test/config.yml +0 -9
- data/test/fake_env.rb +0 -0
- data/test/helper.rb +0 -15
- data/test/test_cli.rb +0 -168
- data/test/test_client.rb +0 -105
- data/test/test_extensions.rb +0 -68
- data/test/test_manager.rb +0 -43
- data/test/test_middleware.rb +0 -92
- data/test/test_processor.rb +0 -32
- data/test/test_retry.rb +0 -83
- data/test/test_stats.rb +0 -78
- data/test/test_testing.rb +0 -65
- data/test/test_web.rb +0 -61
- data/web/assets/images/bootstrap/glyphicons-halflings-white.png +0 -0
- data/web/assets/images/bootstrap/glyphicons-halflings.png +0 -0
- data/web/assets/javascripts/vendor/bootstrap/bootstrap-alert.js +0 -91
- data/web/assets/javascripts/vendor/bootstrap/bootstrap-button.js +0 -98
- data/web/assets/javascripts/vendor/bootstrap/bootstrap-carousel.js +0 -154
- data/web/assets/javascripts/vendor/bootstrap/bootstrap-collapse.js +0 -136
- data/web/assets/javascripts/vendor/bootstrap/bootstrap-dropdown.js +0 -92
- data/web/assets/javascripts/vendor/bootstrap/bootstrap-modal.js +0 -210
- data/web/assets/javascripts/vendor/bootstrap/bootstrap-popover.js +0 -95
- data/web/assets/javascripts/vendor/bootstrap/bootstrap-scrollspy.js +0 -125
- data/web/assets/javascripts/vendor/bootstrap/bootstrap-tab.js +0 -130
- data/web/assets/javascripts/vendor/bootstrap/bootstrap-tooltip.js +0 -270
- data/web/assets/javascripts/vendor/bootstrap/bootstrap-transition.js +0 -51
- data/web/assets/javascripts/vendor/bootstrap/bootstrap-typeahead.js +0 -271
- data/web/assets/javascripts/vendor/bootstrap.js +0 -12
- data/web/assets/javascripts/vendor/jquery.js +0 -9266
- data/web/assets/stylesheets/vendor/bootstrap-responsive.css +0 -567
- data/web/assets/stylesheets/vendor/bootstrap.css +0 -3365
- data/web/views/index.slim +0 -62
- data/web/views/layout.slim +0 -24
- data/web/views/queue.slim +0 -11
@@ -0,0 +1,447 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Sidekiq
|
4
|
+
class WebApplication
|
5
|
+
extend WebRouter
|
6
|
+
|
7
|
+
REDIS_KEYS = %w[redis_version uptime_in_days connected_clients used_memory_human used_memory_peak_human]
|
8
|
+
CSP_HEADER = [
|
9
|
+
"default-src 'self' https: http:",
|
10
|
+
"child-src 'self'",
|
11
|
+
"connect-src 'self' https: http: wss: ws:",
|
12
|
+
"font-src 'self' https: http:",
|
13
|
+
"frame-src 'self'",
|
14
|
+
"img-src 'self' https: http: data:",
|
15
|
+
"manifest-src 'self'",
|
16
|
+
"media-src 'self'",
|
17
|
+
"object-src 'none'",
|
18
|
+
"script-src 'self' https: http: 'unsafe-inline'",
|
19
|
+
"style-src 'self' https: http: 'unsafe-inline'",
|
20
|
+
"worker-src 'self'",
|
21
|
+
"base-uri 'self'"
|
22
|
+
].join("; ").freeze
|
23
|
+
METRICS_PERIODS = {
|
24
|
+
"1h" => 60,
|
25
|
+
"2h" => 120,
|
26
|
+
"4h" => 240,
|
27
|
+
"8h" => 480
|
28
|
+
}
|
29
|
+
|
30
|
+
def initialize(klass)
|
31
|
+
@klass = klass
|
32
|
+
end
|
33
|
+
|
34
|
+
def settings
|
35
|
+
@klass.settings
|
36
|
+
end
|
37
|
+
|
38
|
+
def self.settings
|
39
|
+
Sidekiq::Web.settings
|
40
|
+
end
|
41
|
+
|
42
|
+
def self.tabs
|
43
|
+
Sidekiq::Web.tabs
|
44
|
+
end
|
45
|
+
|
46
|
+
def self.set(key, val)
|
47
|
+
# nothing, backwards compatibility
|
48
|
+
end
|
49
|
+
|
50
|
+
head "/" do
|
51
|
+
# HEAD / is the cheapest heartbeat possible,
|
52
|
+
# it hits Redis to ensure connectivity
|
53
|
+
Sidekiq.redis { |c| c.llen("queue:default") }
|
54
|
+
""
|
55
|
+
end
|
56
|
+
|
57
|
+
get "/" do
|
58
|
+
@redis_info = redis_info.select { |k, v| REDIS_KEYS.include? k }
|
59
|
+
days = (params["days"] || 30).to_i
|
60
|
+
return halt(401) if days < 1 || days > 180
|
61
|
+
|
62
|
+
stats_history = Sidekiq::Stats::History.new(days)
|
63
|
+
@processed_history = stats_history.processed
|
64
|
+
@failed_history = stats_history.failed
|
65
|
+
|
66
|
+
erb(:dashboard)
|
67
|
+
end
|
68
|
+
|
69
|
+
get "/metrics" do
|
70
|
+
q = Sidekiq::Metrics::Query.new
|
71
|
+
@period = h((params[:period] || "")[0..1])
|
72
|
+
@periods = METRICS_PERIODS
|
73
|
+
minutes = @periods.fetch(@period, @periods.values.first)
|
74
|
+
@query_result = q.top_jobs(minutes: minutes)
|
75
|
+
erb(:metrics)
|
76
|
+
end
|
77
|
+
|
78
|
+
get "/metrics/:name" do
|
79
|
+
@name = route_params[:name]
|
80
|
+
@period = h((params[:period] || "")[0..1])
|
81
|
+
q = Sidekiq::Metrics::Query.new
|
82
|
+
@periods = METRICS_PERIODS
|
83
|
+
minutes = @periods.fetch(@period, @periods.values.first)
|
84
|
+
@query_result = q.for_job(@name, minutes: minutes)
|
85
|
+
erb(:metrics_for_job)
|
86
|
+
end
|
87
|
+
|
88
|
+
get "/busy" do
|
89
|
+
@count = (params["count"] || 100).to_i
|
90
|
+
(@current_page, @total_size, @workset) = page_items(workset, params["page"], @count)
|
91
|
+
|
92
|
+
erb(:busy)
|
93
|
+
end
|
94
|
+
|
95
|
+
post "/busy" do
|
96
|
+
if params["identity"]
|
97
|
+
pro = Sidekiq::ProcessSet[params["identity"]]
|
98
|
+
|
99
|
+
pro.quiet! if params["quiet"]
|
100
|
+
pro.stop! if params["stop"]
|
101
|
+
else
|
102
|
+
processes.each do |pro|
|
103
|
+
next if pro.embedded?
|
104
|
+
|
105
|
+
pro.quiet! if params["quiet"]
|
106
|
+
pro.stop! if params["stop"]
|
107
|
+
end
|
108
|
+
end
|
109
|
+
|
110
|
+
redirect "#{root_path}busy"
|
111
|
+
end
|
112
|
+
|
113
|
+
get "/queues" do
|
114
|
+
@queues = Sidekiq::Queue.all
|
115
|
+
|
116
|
+
erb(:queues)
|
117
|
+
end
|
118
|
+
|
119
|
+
QUEUE_NAME = /\A[a-z_:.\-0-9]+\z/i
|
120
|
+
|
121
|
+
get "/queues/:name" do
|
122
|
+
@name = route_params[:name]
|
123
|
+
|
124
|
+
halt(404) if !@name || @name !~ QUEUE_NAME
|
125
|
+
|
126
|
+
@count = (params["count"] || 25).to_i
|
127
|
+
@queue = Sidekiq::Queue.new(@name)
|
128
|
+
(@current_page, @total_size, @jobs) = page("queue:#{@name}", params["page"], @count, reverse: params["direction"] == "asc")
|
129
|
+
@jobs = @jobs.map { |msg| Sidekiq::JobRecord.new(msg, @name) }
|
130
|
+
|
131
|
+
erb(:queue)
|
132
|
+
end
|
133
|
+
|
134
|
+
post "/queues/:name" do
|
135
|
+
queue = Sidekiq::Queue.new(route_params[:name])
|
136
|
+
|
137
|
+
if Sidekiq.pro? && params["pause"]
|
138
|
+
queue.pause!
|
139
|
+
elsif Sidekiq.pro? && params["unpause"]
|
140
|
+
queue.unpause!
|
141
|
+
else
|
142
|
+
queue.clear
|
143
|
+
end
|
144
|
+
|
145
|
+
redirect "#{root_path}queues"
|
146
|
+
end
|
147
|
+
|
148
|
+
post "/queues/:name/delete" do
|
149
|
+
name = route_params[:name]
|
150
|
+
Sidekiq::JobRecord.new(params["key_val"], name).delete
|
151
|
+
|
152
|
+
redirect_with_query("#{root_path}queues/#{CGI.escape(name)}")
|
153
|
+
end
|
154
|
+
|
155
|
+
get "/morgue" do
|
156
|
+
@count = (params["count"] || 25).to_i
|
157
|
+
(@current_page, @total_size, @dead) = page("dead", params["page"], @count, reverse: true)
|
158
|
+
@dead = @dead.map { |msg, score| Sidekiq::SortedEntry.new(nil, score, msg) }
|
159
|
+
|
160
|
+
erb(:morgue)
|
161
|
+
end
|
162
|
+
|
163
|
+
get "/morgue/:key" do
|
164
|
+
key = route_params[:key]
|
165
|
+
halt(404) unless key
|
166
|
+
|
167
|
+
@dead = Sidekiq::DeadSet.new.fetch(*parse_params(key)).first
|
168
|
+
|
169
|
+
if @dead.nil?
|
170
|
+
redirect "#{root_path}morgue"
|
171
|
+
else
|
172
|
+
erb(:dead)
|
173
|
+
end
|
174
|
+
end
|
175
|
+
|
176
|
+
post "/morgue" do
|
177
|
+
redirect(request.path) unless params["key"]
|
178
|
+
|
179
|
+
params["key"].each do |key|
|
180
|
+
job = Sidekiq::DeadSet.new.fetch(*parse_params(key)).first
|
181
|
+
retry_or_delete_or_kill job, params if job
|
182
|
+
end
|
183
|
+
|
184
|
+
redirect_with_query("#{root_path}morgue")
|
185
|
+
end
|
186
|
+
|
187
|
+
post "/morgue/all/delete" do
|
188
|
+
Sidekiq::DeadSet.new.clear
|
189
|
+
|
190
|
+
redirect "#{root_path}morgue"
|
191
|
+
end
|
192
|
+
|
193
|
+
post "/morgue/all/retry" do
|
194
|
+
Sidekiq::DeadSet.new.retry_all
|
195
|
+
|
196
|
+
redirect "#{root_path}morgue"
|
197
|
+
end
|
198
|
+
|
199
|
+
post "/morgue/:key" do
|
200
|
+
key = route_params[:key]
|
201
|
+
halt(404) unless key
|
202
|
+
|
203
|
+
job = Sidekiq::DeadSet.new.fetch(*parse_params(key)).first
|
204
|
+
retry_or_delete_or_kill job, params if job
|
205
|
+
|
206
|
+
redirect_with_query("#{root_path}morgue")
|
207
|
+
end
|
208
|
+
|
209
|
+
get "/retries" do
|
210
|
+
@count = (params["count"] || 25).to_i
|
211
|
+
(@current_page, @total_size, @retries) = page("retry", params["page"], @count)
|
212
|
+
@retries = @retries.map { |msg, score| Sidekiq::SortedEntry.new(nil, score, msg) }
|
213
|
+
|
214
|
+
erb(:retries)
|
215
|
+
end
|
216
|
+
|
217
|
+
get "/retries/:key" do
|
218
|
+
@retry = Sidekiq::RetrySet.new.fetch(*parse_params(route_params[:key])).first
|
219
|
+
|
220
|
+
if @retry.nil?
|
221
|
+
redirect "#{root_path}retries"
|
222
|
+
else
|
223
|
+
erb(:retry)
|
224
|
+
end
|
225
|
+
end
|
226
|
+
|
227
|
+
post "/retries" do
|
228
|
+
redirect(request.path) unless params["key"]
|
229
|
+
|
230
|
+
params["key"].each do |key|
|
231
|
+
job = Sidekiq::RetrySet.new.fetch(*parse_params(key)).first
|
232
|
+
retry_or_delete_or_kill job, params if job
|
233
|
+
end
|
234
|
+
|
235
|
+
redirect_with_query("#{root_path}retries")
|
236
|
+
end
|
237
|
+
|
238
|
+
post "/retries/all/delete" do
|
239
|
+
Sidekiq::RetrySet.new.clear
|
240
|
+
|
241
|
+
redirect "#{root_path}retries"
|
242
|
+
end
|
243
|
+
|
244
|
+
post "/retries/all/retry" do
|
245
|
+
Sidekiq::RetrySet.new.retry_all
|
246
|
+
|
247
|
+
redirect "#{root_path}retries"
|
248
|
+
end
|
249
|
+
|
250
|
+
post "/retries/all/kill" do
|
251
|
+
Sidekiq::RetrySet.new.kill_all
|
252
|
+
|
253
|
+
redirect "#{root_path}retries"
|
254
|
+
end
|
255
|
+
|
256
|
+
post "/retries/:key" do
|
257
|
+
job = Sidekiq::RetrySet.new.fetch(*parse_params(route_params[:key])).first
|
258
|
+
|
259
|
+
retry_or_delete_or_kill job, params if job
|
260
|
+
|
261
|
+
redirect_with_query("#{root_path}retries")
|
262
|
+
end
|
263
|
+
|
264
|
+
get "/scheduled" do
|
265
|
+
@count = (params["count"] || 25).to_i
|
266
|
+
(@current_page, @total_size, @scheduled) = page("schedule", params["page"], @count)
|
267
|
+
@scheduled = @scheduled.map { |msg, score| Sidekiq::SortedEntry.new(nil, score, msg) }
|
268
|
+
|
269
|
+
erb(:scheduled)
|
270
|
+
end
|
271
|
+
|
272
|
+
get "/scheduled/:key" do
|
273
|
+
@job = Sidekiq::ScheduledSet.new.fetch(*parse_params(route_params[:key])).first
|
274
|
+
|
275
|
+
if @job.nil?
|
276
|
+
redirect "#{root_path}scheduled"
|
277
|
+
else
|
278
|
+
erb(:scheduled_job_info)
|
279
|
+
end
|
280
|
+
end
|
281
|
+
|
282
|
+
post "/scheduled" do
|
283
|
+
redirect(request.path) unless params["key"]
|
284
|
+
|
285
|
+
params["key"].each do |key|
|
286
|
+
job = Sidekiq::ScheduledSet.new.fetch(*parse_params(key)).first
|
287
|
+
delete_or_add_queue job, params if job
|
288
|
+
end
|
289
|
+
|
290
|
+
redirect_with_query("#{root_path}scheduled")
|
291
|
+
end
|
292
|
+
|
293
|
+
post "/scheduled/:key" do
|
294
|
+
key = route_params[:key]
|
295
|
+
halt(404) unless key
|
296
|
+
|
297
|
+
job = Sidekiq::ScheduledSet.new.fetch(*parse_params(key)).first
|
298
|
+
delete_or_add_queue job, params if job
|
299
|
+
|
300
|
+
redirect_with_query("#{root_path}scheduled")
|
301
|
+
end
|
302
|
+
|
303
|
+
get "/dashboard/stats" do
|
304
|
+
redirect "#{root_path}stats"
|
305
|
+
end
|
306
|
+
|
307
|
+
get "/stats" do
|
308
|
+
sidekiq_stats = Sidekiq::Stats.new
|
309
|
+
redis_stats = redis_info.select { |k, v| REDIS_KEYS.include? k }
|
310
|
+
json(
|
311
|
+
sidekiq: {
|
312
|
+
processed: sidekiq_stats.processed,
|
313
|
+
failed: sidekiq_stats.failed,
|
314
|
+
busy: sidekiq_stats.workers_size,
|
315
|
+
processes: sidekiq_stats.processes_size,
|
316
|
+
enqueued: sidekiq_stats.enqueued,
|
317
|
+
scheduled: sidekiq_stats.scheduled_size,
|
318
|
+
retries: sidekiq_stats.retry_size,
|
319
|
+
dead: sidekiq_stats.dead_size,
|
320
|
+
default_latency: sidekiq_stats.default_queue_latency
|
321
|
+
},
|
322
|
+
redis: redis_stats,
|
323
|
+
server_utc_time: server_utc_time
|
324
|
+
)
|
325
|
+
end
|
326
|
+
|
327
|
+
get "/stats/queues" do
|
328
|
+
json Sidekiq::Stats.new.queues
|
329
|
+
end
|
330
|
+
|
331
|
+
########
|
332
|
+
# Filtering
|
333
|
+
get "/filter/retries" do
|
334
|
+
x = params[:substr]
|
335
|
+
return redirect "#{root_path}retries" unless x && x != ""
|
336
|
+
|
337
|
+
@retries = search(Sidekiq::RetrySet.new, params[:substr])
|
338
|
+
erb :retries
|
339
|
+
end
|
340
|
+
|
341
|
+
post "/filter/retries" do
|
342
|
+
x = params[:substr]
|
343
|
+
return redirect "#{root_path}retries" unless x && x != ""
|
344
|
+
|
345
|
+
@retries = search(Sidekiq::RetrySet.new, params[:substr])
|
346
|
+
erb :retries
|
347
|
+
end
|
348
|
+
|
349
|
+
get "/filter/scheduled" do
|
350
|
+
x = params[:substr]
|
351
|
+
return redirect "#{root_path}scheduled" unless x && x != ""
|
352
|
+
|
353
|
+
@scheduled = search(Sidekiq::ScheduledSet.new, params[:substr])
|
354
|
+
erb :scheduled
|
355
|
+
end
|
356
|
+
|
357
|
+
post "/filter/scheduled" do
|
358
|
+
x = params[:substr]
|
359
|
+
return redirect "#{root_path}scheduled" unless x && x != ""
|
360
|
+
|
361
|
+
@scheduled = search(Sidekiq::ScheduledSet.new, params[:substr])
|
362
|
+
erb :scheduled
|
363
|
+
end
|
364
|
+
|
365
|
+
get "/filter/dead" do
|
366
|
+
x = params[:substr]
|
367
|
+
return redirect "#{root_path}morgue" unless x && x != ""
|
368
|
+
|
369
|
+
@dead = search(Sidekiq::DeadSet.new, params[:substr])
|
370
|
+
erb :morgue
|
371
|
+
end
|
372
|
+
|
373
|
+
post "/filter/dead" do
|
374
|
+
x = params[:substr]
|
375
|
+
return redirect "#{root_path}morgue" unless x && x != ""
|
376
|
+
|
377
|
+
@dead = search(Sidekiq::DeadSet.new, params[:substr])
|
378
|
+
erb :morgue
|
379
|
+
end
|
380
|
+
|
381
|
+
def call(env)
|
382
|
+
action = self.class.match(env)
|
383
|
+
return [404, {Rack::CONTENT_TYPE => "text/plain", Web::X_CASCADE => "pass"}, ["Not Found"]] unless action
|
384
|
+
|
385
|
+
app = @klass
|
386
|
+
resp = catch(:halt) do
|
387
|
+
self.class.run_befores(app, action)
|
388
|
+
action.instance_exec env, &action.block
|
389
|
+
ensure
|
390
|
+
self.class.run_afters(app, action)
|
391
|
+
end
|
392
|
+
|
393
|
+
case resp
|
394
|
+
when Array
|
395
|
+
# redirects go here
|
396
|
+
resp
|
397
|
+
else
|
398
|
+
# rendered content goes here
|
399
|
+
headers = {
|
400
|
+
Rack::CONTENT_TYPE => "text/html",
|
401
|
+
Rack::CACHE_CONTROL => "private, no-store",
|
402
|
+
Web::CONTENT_LANGUAGE => action.locale,
|
403
|
+
Web::CONTENT_SECURITY_POLICY => CSP_HEADER
|
404
|
+
}
|
405
|
+
# we'll let Rack calculate Content-Length for us.
|
406
|
+
[200, headers, [resp]]
|
407
|
+
end
|
408
|
+
end
|
409
|
+
|
410
|
+
def self.helpers(mod = nil, &block)
|
411
|
+
if block
|
412
|
+
WebAction.class_eval(&block)
|
413
|
+
else
|
414
|
+
WebAction.send(:include, mod)
|
415
|
+
end
|
416
|
+
end
|
417
|
+
|
418
|
+
def self.before(path = nil, &block)
|
419
|
+
befores << [path && Regexp.new("\\A#{path.gsub("*", ".*")}\\z"), block]
|
420
|
+
end
|
421
|
+
|
422
|
+
def self.after(path = nil, &block)
|
423
|
+
afters << [path && Regexp.new("\\A#{path.gsub("*", ".*")}\\z"), block]
|
424
|
+
end
|
425
|
+
|
426
|
+
def self.run_befores(app, action)
|
427
|
+
run_hooks(befores, app, action)
|
428
|
+
end
|
429
|
+
|
430
|
+
def self.run_afters(app, action)
|
431
|
+
run_hooks(afters, app, action)
|
432
|
+
end
|
433
|
+
|
434
|
+
def self.run_hooks(hooks, app, action)
|
435
|
+
hooks.select { |p, _| !p || p =~ action.env[WebRouter::PATH_INFO] }
|
436
|
+
.each { |_, b| action.instance_exec(action.env, app, &b) }
|
437
|
+
end
|
438
|
+
|
439
|
+
def self.befores
|
440
|
+
@befores ||= []
|
441
|
+
end
|
442
|
+
|
443
|
+
def self.afters
|
444
|
+
@afters ||= []
|
445
|
+
end
|
446
|
+
end
|
447
|
+
end
|
@@ -0,0 +1,180 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# this file originally based on authenticity_token.rb from the sinatra/rack-protection project
|
4
|
+
#
|
5
|
+
# The MIT License (MIT)
|
6
|
+
#
|
7
|
+
# Copyright (c) 2011-2017 Konstantin Haase
|
8
|
+
# Copyright (c) 2015-2017 Zachary Scott
|
9
|
+
#
|
10
|
+
# Permission is hereby granted, free of charge, to any person obtaining
|
11
|
+
# a copy of this software and associated documentation files (the
|
12
|
+
# 'Software'), to deal in the Software without restriction, including
|
13
|
+
# without limitation the rights to use, copy, modify, merge, publish,
|
14
|
+
# distribute, sublicense, and/or sell copies of the Software, and to
|
15
|
+
# permit persons to whom the Software is furnished to do so, subject to
|
16
|
+
# the following conditions:
|
17
|
+
#
|
18
|
+
# The above copyright notice and this permission notice shall be
|
19
|
+
# included in all copies or substantial portions of the Software.
|
20
|
+
#
|
21
|
+
# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
|
22
|
+
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
23
|
+
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
24
|
+
# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
25
|
+
# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
26
|
+
# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
27
|
+
# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
28
|
+
|
29
|
+
require "securerandom"
|
30
|
+
require "base64"
|
31
|
+
require "rack/request"
|
32
|
+
|
33
|
+
module Sidekiq
|
34
|
+
class Web
|
35
|
+
class CsrfProtection
|
36
|
+
def initialize(app, options = nil)
|
37
|
+
@app = app
|
38
|
+
end
|
39
|
+
|
40
|
+
def call(env)
|
41
|
+
accept?(env) ? admit(env) : deny(env)
|
42
|
+
end
|
43
|
+
|
44
|
+
private
|
45
|
+
|
46
|
+
def admit(env)
|
47
|
+
# On each successful request, we create a fresh masked token
|
48
|
+
# which will be used in any forms rendered for this request.
|
49
|
+
s = session(env)
|
50
|
+
s[:csrf] ||= SecureRandom.base64(TOKEN_LENGTH)
|
51
|
+
env[:csrf_token] = mask_token(s[:csrf])
|
52
|
+
@app.call(env)
|
53
|
+
end
|
54
|
+
|
55
|
+
def safe?(env)
|
56
|
+
%w[GET HEAD OPTIONS TRACE].include? env["REQUEST_METHOD"]
|
57
|
+
end
|
58
|
+
|
59
|
+
def logger(env)
|
60
|
+
@logger ||= (env["rack.logger"] || ::Logger.new(env["rack.errors"]))
|
61
|
+
end
|
62
|
+
|
63
|
+
def deny(env)
|
64
|
+
logger(env).warn "attack prevented by #{self.class}"
|
65
|
+
[403, {Rack::CONTENT_TYPE => "text/plain"}, ["Forbidden"]]
|
66
|
+
end
|
67
|
+
|
68
|
+
def session(env)
|
69
|
+
env["rack.session"] || fail(<<~EOM)
|
70
|
+
Sidekiq::Web needs a valid Rack session for CSRF protection. If this is a Rails app,
|
71
|
+
make sure you mount Sidekiq::Web *inside* your application routes:
|
72
|
+
|
73
|
+
|
74
|
+
Rails.application.routes.draw do
|
75
|
+
mount Sidekiq::Web => "/sidekiq"
|
76
|
+
....
|
77
|
+
end
|
78
|
+
|
79
|
+
|
80
|
+
If this is a Rails app in API mode, you need to enable sessions.
|
81
|
+
|
82
|
+
https://guides.rubyonrails.org/api_app.html#using-session-middlewares
|
83
|
+
|
84
|
+
If this is a bare Rack app, use a session middleware before Sidekiq::Web:
|
85
|
+
|
86
|
+
# first, use IRB to create a shared secret key for sessions and commit it
|
87
|
+
require 'securerandom'; File.open(".session.key", "w") {|f| f.write(SecureRandom.hex(32)) }
|
88
|
+
|
89
|
+
# now use the secret with a session cookie middleware
|
90
|
+
use Rack::Session::Cookie, secret: File.read(".session.key"), same_site: true, max_age: 86400
|
91
|
+
run Sidekiq::Web
|
92
|
+
|
93
|
+
EOM
|
94
|
+
end
|
95
|
+
|
96
|
+
def accept?(env)
|
97
|
+
return true if safe?(env)
|
98
|
+
|
99
|
+
giventoken = ::Rack::Request.new(env).params["authenticity_token"]
|
100
|
+
valid_token?(env, giventoken)
|
101
|
+
end
|
102
|
+
|
103
|
+
TOKEN_LENGTH = 32
|
104
|
+
|
105
|
+
# Checks that the token given to us as a parameter matches
|
106
|
+
# the token stored in the session.
|
107
|
+
def valid_token?(env, giventoken)
|
108
|
+
return false if giventoken.nil? || giventoken.empty?
|
109
|
+
|
110
|
+
begin
|
111
|
+
token = decode_token(giventoken)
|
112
|
+
rescue ArgumentError # client input is invalid
|
113
|
+
return false
|
114
|
+
end
|
115
|
+
|
116
|
+
sess = session(env)
|
117
|
+
localtoken = sess[:csrf]
|
118
|
+
|
119
|
+
# Checks that Rack::Session::Cookie actualy contains the csrf toekn
|
120
|
+
return false if localtoken.nil?
|
121
|
+
|
122
|
+
# Rotate the session token after every use
|
123
|
+
sess[:csrf] = SecureRandom.base64(TOKEN_LENGTH)
|
124
|
+
|
125
|
+
# See if it's actually a masked token or not. We should be able
|
126
|
+
# to handle any unmasked tokens that we've issued without error.
|
127
|
+
|
128
|
+
if unmasked_token?(token)
|
129
|
+
compare_with_real_token token, localtoken
|
130
|
+
elsif masked_token?(token)
|
131
|
+
unmasked = unmask_token(token)
|
132
|
+
compare_with_real_token unmasked, localtoken
|
133
|
+
else
|
134
|
+
false # Token is malformed
|
135
|
+
end
|
136
|
+
end
|
137
|
+
|
138
|
+
# Creates a masked version of the authenticity token that varies
|
139
|
+
# on each request. The masking is used to mitigate SSL attacks
|
140
|
+
# like BREACH.
|
141
|
+
def mask_token(token)
|
142
|
+
token = decode_token(token)
|
143
|
+
one_time_pad = SecureRandom.random_bytes(token.length)
|
144
|
+
encrypted_token = xor_byte_strings(one_time_pad, token)
|
145
|
+
masked_token = one_time_pad + encrypted_token
|
146
|
+
Base64.urlsafe_encode64(masked_token)
|
147
|
+
end
|
148
|
+
|
149
|
+
# Essentially the inverse of +mask_token+.
|
150
|
+
def unmask_token(masked_token)
|
151
|
+
# Split the token into the one-time pad and the encrypted
|
152
|
+
# value and decrypt it
|
153
|
+
token_length = masked_token.length / 2
|
154
|
+
one_time_pad = masked_token[0...token_length]
|
155
|
+
encrypted_token = masked_token[token_length..]
|
156
|
+
xor_byte_strings(one_time_pad, encrypted_token)
|
157
|
+
end
|
158
|
+
|
159
|
+
def unmasked_token?(token)
|
160
|
+
token.length == TOKEN_LENGTH
|
161
|
+
end
|
162
|
+
|
163
|
+
def masked_token?(token)
|
164
|
+
token.length == TOKEN_LENGTH * 2
|
165
|
+
end
|
166
|
+
|
167
|
+
def compare_with_real_token(token, local)
|
168
|
+
::Rack::Utils.secure_compare(token.to_s, decode_token(local).to_s)
|
169
|
+
end
|
170
|
+
|
171
|
+
def decode_token(token)
|
172
|
+
Base64.urlsafe_decode64(token)
|
173
|
+
end
|
174
|
+
|
175
|
+
def xor_byte_strings(s1, s2)
|
176
|
+
s1.bytes.zip(s2.bytes).map { |(c1, c2)| c1 ^ c2 }.pack("c*")
|
177
|
+
end
|
178
|
+
end
|
179
|
+
end
|
180
|
+
end
|