sidekiq 6.0.4 → 7.0.2
Sign up to get free protection for your applications and to get access to all the features.
Potentially problematic release.
This version of sidekiq might be problematic. Click here for more details.
- checksums.yaml +4 -4
- data/Changes.md +336 -6
- data/LICENSE.txt +9 -0
- data/README.md +22 -20
- data/bin/sidekiq +22 -3
- data/bin/sidekiqload +71 -76
- data/bin/sidekiqmon +1 -1
- data/lib/generators/sidekiq/job_generator.rb +57 -0
- data/lib/generators/sidekiq/templates/{worker.rb.erb → job.rb.erb} +2 -2
- data/lib/generators/sidekiq/templates/{worker_spec.rb.erb → job_spec.rb.erb} +1 -1
- data/lib/generators/sidekiq/templates/{worker_test.rb.erb → job_test.rb.erb} +1 -1
- data/lib/sidekiq/api.rb +365 -230
- data/lib/sidekiq/capsule.rb +110 -0
- data/lib/sidekiq/cli.rb +120 -86
- data/lib/sidekiq/client.rb +81 -85
- data/lib/sidekiq/{util.rb → component.rb} +13 -14
- data/lib/sidekiq/config.rb +270 -0
- data/lib/sidekiq/deploy.rb +62 -0
- data/lib/sidekiq/embedded.rb +61 -0
- data/lib/sidekiq/fetch.rb +42 -32
- data/lib/sidekiq/{worker.rb → job.rb} +165 -34
- data/lib/sidekiq/job_logger.rb +18 -30
- data/lib/sidekiq/job_retry.rb +80 -60
- data/lib/sidekiq/job_util.rb +71 -0
- data/lib/sidekiq/launcher.rb +173 -85
- data/lib/sidekiq/logger.rb +13 -47
- data/lib/sidekiq/manager.rb +40 -41
- data/lib/sidekiq/metrics/query.rb +153 -0
- data/lib/sidekiq/metrics/shared.rb +95 -0
- data/lib/sidekiq/metrics/tracking.rb +134 -0
- data/lib/sidekiq/middleware/chain.rb +90 -46
- data/lib/sidekiq/middleware/current_attributes.rb +58 -0
- data/lib/sidekiq/middleware/i18n.rb +6 -4
- data/lib/sidekiq/middleware/modules.rb +21 -0
- data/lib/sidekiq/monitor.rb +19 -4
- data/lib/sidekiq/paginator.rb +17 -9
- data/lib/sidekiq/processor.rb +57 -60
- data/lib/sidekiq/rails.rb +33 -23
- data/lib/sidekiq/redis_client_adapter.rb +115 -0
- data/lib/sidekiq/redis_connection.rb +21 -87
- data/lib/sidekiq/ring_buffer.rb +29 -0
- data/lib/sidekiq/scheduled.rb +102 -39
- data/lib/sidekiq/sd_notify.rb +149 -0
- data/lib/sidekiq/systemd.rb +24 -0
- data/lib/sidekiq/testing/inline.rb +4 -4
- data/lib/sidekiq/testing.rb +43 -72
- data/lib/sidekiq/transaction_aware_client.rb +44 -0
- data/lib/sidekiq/version.rb +2 -1
- data/lib/sidekiq/web/action.rb +3 -3
- data/lib/sidekiq/web/application.rb +47 -24
- data/lib/sidekiq/web/csrf_protection.rb +180 -0
- data/lib/sidekiq/web/helpers.rb +59 -47
- data/lib/sidekiq/web/router.rb +6 -5
- data/lib/sidekiq/web.rb +31 -74
- data/lib/sidekiq/worker_compatibility_alias.rb +13 -0
- data/lib/sidekiq.rb +86 -199
- data/sidekiq.gemspec +36 -7
- data/web/assets/images/apple-touch-icon.png +0 -0
- data/web/assets/javascripts/application.js +130 -61
- 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 +166 -0
- data/web/assets/javascripts/dashboard.js +36 -273
- data/web/assets/javascripts/metrics.js +236 -0
- data/web/assets/stylesheets/application-dark.css +146 -124
- data/web/assets/stylesheets/application-rtl.css +2 -95
- data/web/assets/stylesheets/application.css +100 -529
- data/web/locales/ar.yml +71 -65
- data/web/locales/cs.yml +62 -62
- data/web/locales/da.yml +52 -52
- data/web/locales/de.yml +65 -65
- data/web/locales/el.yml +43 -24
- data/web/locales/en.yml +83 -67
- data/web/locales/es.yml +70 -54
- data/web/locales/fa.yml +65 -65
- data/web/locales/fr.yml +69 -62
- data/web/locales/he.yml +65 -64
- data/web/locales/hi.yml +59 -59
- data/web/locales/it.yml +53 -53
- data/web/locales/ja.yml +73 -65
- data/web/locales/ko.yml +52 -52
- data/web/locales/lt.yml +83 -0
- data/web/locales/nb.yml +61 -61
- data/web/locales/nl.yml +52 -52
- data/web/locales/pl.yml +45 -45
- data/web/locales/pt-br.yml +63 -55
- data/web/locales/pt.yml +51 -51
- data/web/locales/ru.yml +68 -63
- data/web/locales/sv.yml +53 -53
- data/web/locales/ta.yml +60 -60
- data/web/locales/uk.yml +62 -61
- data/web/locales/ur.yml +64 -64
- data/web/locales/vi.yml +83 -0
- data/web/locales/zh-cn.yml +43 -16
- data/web/locales/zh-tw.yml +42 -8
- data/web/views/_footer.erb +6 -3
- data/web/views/_job_info.erb +17 -1
- data/web/views/_nav.erb +1 -1
- data/web/views/_poll_link.erb +3 -6
- data/web/views/_summary.erb +7 -7
- data/web/views/busy.erb +70 -21
- data/web/views/dashboard.erb +58 -18
- data/web/views/dead.erb +1 -1
- data/web/views/layout.erb +3 -2
- data/web/views/metrics.erb +80 -0
- data/web/views/metrics_for_job.erb +69 -0
- data/web/views/morgue.erb +7 -7
- data/web/views/queue.erb +15 -11
- data/web/views/queues.erb +4 -4
- data/web/views/retries.erb +8 -8
- data/web/views/retry.erb +1 -1
- data/web/views/scheduled.erb +2 -2
- metadata +79 -55
- data/.circleci/config.yml +0 -82
- data/.github/contributing.md +0 -32
- data/.github/issue_template.md +0 -11
- data/.gitignore +0 -13
- data/.standard.yml +0 -20
- data/3.0-Upgrade.md +0 -70
- data/4.0-Upgrade.md +0 -53
- data/5.0-Upgrade.md +0 -56
- data/6.0-Upgrade.md +0 -72
- data/COMM-LICENSE +0 -97
- data/Ent-2.0-Upgrade.md +0 -37
- data/Ent-Changes.md +0 -256
- data/Gemfile +0 -24
- data/Gemfile.lock +0 -199
- data/LICENSE +0 -9
- data/Pro-2.0-Upgrade.md +0 -138
- data/Pro-3.0-Upgrade.md +0 -44
- data/Pro-4.0-Upgrade.md +0 -35
- data/Pro-5.0-Upgrade.md +0 -25
- data/Pro-Changes.md +0 -776
- data/Rakefile +0 -10
- data/code_of_conduct.md +0 -50
- data/lib/generators/sidekiq/worker_generator.rb +0 -57
- data/lib/sidekiq/delay.rb +0 -41
- data/lib/sidekiq/exception_handler.rb +0 -27
- data/lib/sidekiq/extensions/action_mailer.rb +0 -47
- data/lib/sidekiq/extensions/active_record.rb +0 -42
- data/lib/sidekiq/extensions/class_methods.rb +0 -42
- data/lib/sidekiq/extensions/generic_proxy.rb +0 -31
@@ -0,0 +1,44 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require "securerandom"
|
4
|
+
require "sidekiq/client"
|
5
|
+
|
6
|
+
module Sidekiq
|
7
|
+
class TransactionAwareClient
|
8
|
+
def initialize(pool: nil, config: nil)
|
9
|
+
@redis_client = Client.new(pool: pool, config: config)
|
10
|
+
end
|
11
|
+
|
12
|
+
def push(item)
|
13
|
+
# pre-allocate the JID so we can return it immediately and
|
14
|
+
# save it to the database as part of the transaction.
|
15
|
+
item["jid"] ||= SecureRandom.hex(12)
|
16
|
+
AfterCommitEverywhere.after_commit { @redis_client.push(item) }
|
17
|
+
item["jid"]
|
18
|
+
end
|
19
|
+
|
20
|
+
##
|
21
|
+
# We don't provide transactionality for push_bulk because we don't want
|
22
|
+
# to hold potentially hundreds of thousands of job records in memory due to
|
23
|
+
# a long running enqueue process.
|
24
|
+
def push_bulk(items)
|
25
|
+
@redis_client.push_bulk(items)
|
26
|
+
end
|
27
|
+
end
|
28
|
+
end
|
29
|
+
|
30
|
+
##
|
31
|
+
# Use `Sidekiq.transactional_push!` in your sidekiq.rb initializer
|
32
|
+
module Sidekiq
|
33
|
+
def self.transactional_push!
|
34
|
+
begin
|
35
|
+
require "after_commit_everywhere"
|
36
|
+
rescue LoadError
|
37
|
+
raise %q(You need to add `gem "after_commit_everywhere"` to your Gemfile to use Sidekiq's transactional client)
|
38
|
+
end
|
39
|
+
|
40
|
+
Sidekiq.default_job_options["client_class"] = Sidekiq::TransactionAwareClient
|
41
|
+
Sidekiq::JobUtil::TRANSIENT_ATTRIBUTES << "client_class"
|
42
|
+
true
|
43
|
+
end
|
44
|
+
end
|
data/lib/sidekiq/version.rb
CHANGED
data/lib/sidekiq/web/action.rb
CHANGED
@@ -15,11 +15,11 @@ module Sidekiq
|
|
15
15
|
end
|
16
16
|
|
17
17
|
def halt(res)
|
18
|
-
throw :halt, res
|
18
|
+
throw :halt, [res, {"content-type" => "text/plain"}, [res.to_s]]
|
19
19
|
end
|
20
20
|
|
21
21
|
def redirect(location)
|
22
|
-
throw :halt, [302, {"
|
22
|
+
throw :halt, [302, {"location" => "#{request.base_url}#{location}"}, []]
|
23
23
|
end
|
24
24
|
|
25
25
|
def params
|
@@ -68,7 +68,7 @@ module Sidekiq
|
|
68
68
|
end
|
69
69
|
|
70
70
|
def json(payload)
|
71
|
-
[200, {"
|
71
|
+
[200, {"content-type" => "application/json", "cache-control" => "private, no-store"}, [Sidekiq.dump_json(payload)]]
|
72
72
|
end
|
73
73
|
|
74
74
|
def initialize(env, block)
|
@@ -4,7 +4,6 @@ module Sidekiq
|
|
4
4
|
class WebApplication
|
5
5
|
extend WebRouter
|
6
6
|
|
7
|
-
CONTENT_LENGTH = "Content-Length"
|
8
7
|
REDIS_KEYS = %w[redis_version uptime_in_days connected_clients used_memory_human used_memory_peak_human]
|
9
8
|
CSP_HEADER = [
|
10
9
|
"default-src 'self' https: http:",
|
@@ -19,7 +18,7 @@ module Sidekiq
|
|
19
18
|
"script-src 'self' https: http: 'unsafe-inline'",
|
20
19
|
"style-src 'self' https: http: 'unsafe-inline'",
|
21
20
|
"worker-src 'self'",
|
22
|
-
"base-uri 'self'"
|
21
|
+
"base-uri 'self'"
|
23
22
|
].join("; ").freeze
|
24
23
|
|
25
24
|
def initialize(klass)
|
@@ -42,16 +41,42 @@ module Sidekiq
|
|
42
41
|
# nothing, backwards compatibility
|
43
42
|
end
|
44
43
|
|
44
|
+
head "/" do
|
45
|
+
# HEAD / is the cheapest heartbeat possible,
|
46
|
+
# it hits Redis to ensure connectivity
|
47
|
+
Sidekiq.redis { |c| c.llen("queue:default") }
|
48
|
+
""
|
49
|
+
end
|
50
|
+
|
45
51
|
get "/" do
|
46
52
|
@redis_info = redis_info.select { |k, v| REDIS_KEYS.include? k }
|
47
|
-
|
53
|
+
days = (params["days"] || 30).to_i
|
54
|
+
return halt(401) if days < 1 || days > 180
|
55
|
+
|
56
|
+
stats_history = Sidekiq::Stats::History.new(days)
|
48
57
|
@processed_history = stats_history.processed
|
49
58
|
@failed_history = stats_history.failed
|
50
59
|
|
51
60
|
erb(:dashboard)
|
52
61
|
end
|
53
62
|
|
63
|
+
get "/metrics" do
|
64
|
+
q = Sidekiq::Metrics::Query.new
|
65
|
+
@query_result = q.top_jobs
|
66
|
+
erb(:metrics)
|
67
|
+
end
|
68
|
+
|
69
|
+
get "/metrics/:name" do
|
70
|
+
@name = route_params[:name]
|
71
|
+
q = Sidekiq::Metrics::Query.new
|
72
|
+
@query_result = q.for_job(@name)
|
73
|
+
erb(:metrics_for_job)
|
74
|
+
end
|
75
|
+
|
54
76
|
get "/busy" do
|
77
|
+
@count = (params["count"] || 100).to_i
|
78
|
+
(@current_page, @total_size, @workset) = page_items(workset, params["page"], @count)
|
79
|
+
|
55
80
|
erb(:busy)
|
56
81
|
end
|
57
82
|
|
@@ -76,15 +101,17 @@ module Sidekiq
|
|
76
101
|
erb(:queues)
|
77
102
|
end
|
78
103
|
|
104
|
+
QUEUE_NAME = /\A[a-z_:.\-0-9]+\z/i
|
105
|
+
|
79
106
|
get "/queues/:name" do
|
80
107
|
@name = route_params[:name]
|
81
108
|
|
82
|
-
halt(404)
|
109
|
+
halt(404) if !@name || @name !~ QUEUE_NAME
|
83
110
|
|
84
111
|
@count = (params["count"] || 25).to_i
|
85
112
|
@queue = Sidekiq::Queue.new(@name)
|
86
|
-
(@current_page, @total_size, @
|
87
|
-
@
|
113
|
+
(@current_page, @total_size, @jobs) = page("queue:#{@name}", params["page"], @count, reverse: params["direction"] == "asc")
|
114
|
+
@jobs = @jobs.map { |msg| Sidekiq::JobRecord.new(msg, @name) }
|
88
115
|
|
89
116
|
erb(:queue)
|
90
117
|
end
|
@@ -105,7 +132,7 @@ module Sidekiq
|
|
105
132
|
|
106
133
|
post "/queues/:name/delete" do
|
107
134
|
name = route_params[:name]
|
108
|
-
Sidekiq::
|
135
|
+
Sidekiq::JobRecord.new(params["key_val"], name).delete
|
109
136
|
|
110
137
|
redirect_with_query("#{root_path}queues/#{CGI.escape(name)}")
|
111
138
|
end
|
@@ -275,7 +302,7 @@ module Sidekiq
|
|
275
302
|
scheduled: sidekiq_stats.scheduled_size,
|
276
303
|
retries: sidekiq_stats.retry_size,
|
277
304
|
dead: sidekiq_stats.dead_size,
|
278
|
-
default_latency: sidekiq_stats.default_queue_latency
|
305
|
+
default_latency: sidekiq_stats.default_queue_latency
|
279
306
|
},
|
280
307
|
redis: redis_stats,
|
281
308
|
server_utc_time: server_utc_time
|
@@ -283,44 +310,40 @@ module Sidekiq
|
|
283
310
|
end
|
284
311
|
|
285
312
|
get "/stats/queues" do
|
286
|
-
json Sidekiq::Stats
|
313
|
+
json Sidekiq::Stats.new.queues
|
287
314
|
end
|
288
315
|
|
289
316
|
def call(env)
|
290
317
|
action = self.class.match(env)
|
291
|
-
return [404, {"
|
318
|
+
return [404, {"content-type" => "text/plain", "x-cascade" => "pass"}, ["Not Found"]] unless action
|
292
319
|
|
293
320
|
app = @klass
|
294
|
-
resp = catch(:halt) do
|
321
|
+
resp = catch(:halt) do
|
295
322
|
self.class.run_befores(app, action)
|
296
323
|
action.instance_exec env, &action.block
|
297
324
|
ensure
|
298
325
|
self.class.run_afters(app, action)
|
299
326
|
end
|
300
327
|
|
301
|
-
|
328
|
+
case resp
|
302
329
|
when Array
|
330
|
+
# redirects go here
|
303
331
|
resp
|
304
332
|
else
|
333
|
+
# rendered content goes here
|
305
334
|
headers = {
|
306
|
-
"
|
307
|
-
"
|
308
|
-
"
|
309
|
-
"
|
335
|
+
"content-type" => "text/html",
|
336
|
+
"cache-control" => "private, no-store",
|
337
|
+
"content-language" => action.locale,
|
338
|
+
"content-security-policy" => CSP_HEADER
|
310
339
|
}
|
311
|
-
|
340
|
+
# we'll let Rack calculate Content-Length for us.
|
312
341
|
[200, headers, [resp]]
|
313
342
|
end
|
314
|
-
|
315
|
-
resp[1] = resp[1].dup
|
316
|
-
|
317
|
-
resp[1][CONTENT_LENGTH] = resp[2].sum(&:bytesize).to_s
|
318
|
-
|
319
|
-
resp
|
320
343
|
end
|
321
344
|
|
322
345
|
def self.helpers(mod = nil, &block)
|
323
|
-
if
|
346
|
+
if block
|
324
347
|
WebAction.class_eval(&block)
|
325
348
|
else
|
326
349
|
WebAction.send(:include, mod)
|
@@ -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, {"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
|
data/lib/sidekiq/web/helpers.rb
CHANGED
@@ -10,18 +10,25 @@ module Sidekiq
|
|
10
10
|
module WebHelpers
|
11
11
|
def strings(lang)
|
12
12
|
@strings ||= {}
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
end
|
13
|
+
|
14
|
+
# Allow sidekiq-web extensions to add locale paths
|
15
|
+
# so extensions can be localized
|
16
|
+
@strings[lang] ||= settings.locales.each_with_object({}) do |path, global|
|
17
|
+
find_locale_files(lang).each do |file|
|
18
|
+
strs = YAML.safe_load(File.open(file))
|
19
|
+
global.merge!(strs[lang])
|
21
20
|
end
|
22
21
|
end
|
23
22
|
end
|
24
23
|
|
24
|
+
def singularize(str, count)
|
25
|
+
if count == 1 && str.respond_to?(:singularize) # rails
|
26
|
+
str.singularize
|
27
|
+
else
|
28
|
+
str
|
29
|
+
end
|
30
|
+
end
|
31
|
+
|
25
32
|
def clear_caches
|
26
33
|
@strings = nil
|
27
34
|
@locale_files = nil
|
@@ -63,17 +70,6 @@ module Sidekiq
|
|
63
70
|
@head_html.join if defined?(@head_html)
|
64
71
|
end
|
65
72
|
|
66
|
-
def poll_path
|
67
|
-
if current_path != "" && params["poll"]
|
68
|
-
path = root_path + current_path
|
69
|
-
query_string = to_query_string(params.slice(*params.keys - %w[page poll]))
|
70
|
-
path += "?#{query_string}" unless query_string.empty?
|
71
|
-
path
|
72
|
-
else
|
73
|
-
""
|
74
|
-
end
|
75
|
-
end
|
76
|
-
|
77
73
|
def text_direction
|
78
74
|
get_locale["TextDirection"] || "ltr"
|
79
75
|
end
|
@@ -118,7 +114,7 @@ module Sidekiq
|
|
118
114
|
# within is used by Sidekiq Pro
|
119
115
|
def display_tags(job, within = nil)
|
120
116
|
job.tags.map { |tag|
|
121
|
-
"<span class='
|
117
|
+
"<span class='label label-info jobtag'>#{::Rack::Utils.escape_html(tag)}</span>"
|
122
118
|
}.join(" ")
|
123
119
|
end
|
124
120
|
|
@@ -141,34 +137,42 @@ module Sidekiq
|
|
141
137
|
end
|
142
138
|
|
143
139
|
def sort_direction_label
|
144
|
-
params[:direction] == "asc" ? "↑" : "↓"
|
140
|
+
(params[:direction] == "asc") ? "↑" : "↓"
|
145
141
|
end
|
146
142
|
|
147
|
-
def
|
148
|
-
@
|
143
|
+
def workset
|
144
|
+
@work ||= Sidekiq::WorkSet.new
|
149
145
|
end
|
150
146
|
|
151
147
|
def processes
|
152
148
|
@processes ||= Sidekiq::ProcessSet.new
|
153
149
|
end
|
154
150
|
|
151
|
+
# Sorts processes by hostname following the natural sort order
|
152
|
+
def sorted_processes
|
153
|
+
@sorted_processes ||= begin
|
154
|
+
return processes unless processes.all? { |p| p["hostname"] }
|
155
|
+
|
156
|
+
processes.to_a.sort_by do |process|
|
157
|
+
# Kudos to `shurikk` on StackOverflow
|
158
|
+
# https://stackoverflow.com/a/15170063/575547
|
159
|
+
process["hostname"].split(/(\d+)/).map { |a| /\d+/.match?(a) ? a.to_i : a }
|
160
|
+
end
|
161
|
+
end
|
162
|
+
end
|
163
|
+
|
155
164
|
def stats
|
156
165
|
@stats ||= Sidekiq::Stats.new
|
157
166
|
end
|
158
167
|
|
159
|
-
def
|
168
|
+
def redis_url
|
160
169
|
Sidekiq.redis do |conn|
|
161
|
-
|
162
|
-
"redis://#{c[:location]}/#{c[:db]}"
|
170
|
+
conn.config.server_url
|
163
171
|
end
|
164
172
|
end
|
165
173
|
|
166
|
-
def namespace
|
167
|
-
@ns ||= Sidekiq.redis { |conn| conn.respond_to?(:namespace) ? conn.namespace : nil }
|
168
|
-
end
|
169
|
-
|
170
174
|
def redis_info
|
171
|
-
Sidekiq.redis_info
|
175
|
+
Sidekiq.default_configuration.redis_info
|
172
176
|
end
|
173
177
|
|
174
178
|
def root_path
|
@@ -180,7 +184,7 @@ module Sidekiq
|
|
180
184
|
end
|
181
185
|
|
182
186
|
def current_status
|
183
|
-
|
187
|
+
(workset.size == 0) ? "idle" : "active"
|
184
188
|
end
|
185
189
|
|
186
190
|
def relative_time(time)
|
@@ -197,16 +201,13 @@ module Sidekiq
|
|
197
201
|
[score.to_f, jid]
|
198
202
|
end
|
199
203
|
|
200
|
-
SAFE_QPARAMS = %w[page
|
204
|
+
SAFE_QPARAMS = %w[page direction]
|
201
205
|
|
202
206
|
# Merge options with current params, filter safe params, and stringify to query string
|
203
207
|
def qparams(options)
|
204
|
-
|
205
|
-
options.keys.each do |key|
|
206
|
-
options[key.to_s] = options.delete(key)
|
207
|
-
end
|
208
|
+
stringified_options = options.transform_keys(&:to_s)
|
208
209
|
|
209
|
-
to_query_string(params.merge(
|
210
|
+
to_query_string(params.merge(stringified_options))
|
210
211
|
end
|
211
212
|
|
212
213
|
def to_query_string(params)
|
@@ -216,7 +217,7 @@ module Sidekiq
|
|
216
217
|
end
|
217
218
|
|
218
219
|
def truncate(text, truncate_after_chars = 2000)
|
219
|
-
truncate_after_chars && text.size > truncate_after_chars ? "#{text[0..truncate_after_chars]}..." : text
|
220
|
+
(truncate_after_chars && text.size > truncate_after_chars) ? "#{text[0..truncate_after_chars]}..." : text
|
220
221
|
end
|
221
222
|
|
222
223
|
def display_args(args, truncate_after_chars = 2000)
|
@@ -233,7 +234,7 @@ module Sidekiq
|
|
233
234
|
end
|
234
235
|
|
235
236
|
def csrf_tag
|
236
|
-
"<input type='hidden' name='authenticity_token' value='#{
|
237
|
+
"<input type='hidden' name='authenticity_token' value='#{env[:csrf_token]}'/>"
|
237
238
|
end
|
238
239
|
|
239
240
|
def to_display(arg)
|
@@ -250,7 +251,7 @@ module Sidekiq
|
|
250
251
|
queue class args retry_count retried_at failed_at
|
251
252
|
jid error_message error_class backtrace
|
252
253
|
error_backtrace enqueued_at retry wrapped
|
253
|
-
created_at tags
|
254
|
+
created_at tags display_class
|
254
255
|
])
|
255
256
|
|
256
257
|
def retry_extra_items(retry_job)
|
@@ -261,7 +262,21 @@ module Sidekiq
|
|
261
262
|
end
|
262
263
|
end
|
263
264
|
|
265
|
+
def format_memory(rss_kb)
|
266
|
+
return "0" if rss_kb.nil? || rss_kb == 0
|
267
|
+
|
268
|
+
if rss_kb < 100_000
|
269
|
+
"#{number_with_delimiter(rss_kb)} KB"
|
270
|
+
elsif rss_kb < 10_000_000
|
271
|
+
"#{number_with_delimiter((rss_kb / 1024.0).to_i)} MB"
|
272
|
+
else
|
273
|
+
"#{number_with_delimiter((rss_kb / (1024.0 * 1024.0)).round(1))} GB"
|
274
|
+
end
|
275
|
+
end
|
276
|
+
|
264
277
|
def number_with_delimiter(number)
|
278
|
+
return "" if number.nil?
|
279
|
+
|
265
280
|
begin
|
266
281
|
Float(number)
|
267
282
|
rescue ArgumentError, TypeError
|
@@ -295,7 +310,7 @@ module Sidekiq
|
|
295
310
|
end
|
296
311
|
|
297
312
|
def environment_title_prefix
|
298
|
-
environment = Sidekiq.
|
313
|
+
environment = Sidekiq.default_configuration[:environment] || ENV["APP_ENV"] || ENV["RAILS_ENV"] || ENV["RACK_ENV"] || "development"
|
299
314
|
|
300
315
|
"[#{environment.upcase}] " unless environment == "production"
|
301
316
|
end
|
@@ -308,11 +323,8 @@ module Sidekiq
|
|
308
323
|
Time.now.utc.strftime("%H:%M:%S UTC")
|
309
324
|
end
|
310
325
|
|
311
|
-
def
|
312
|
-
|
313
|
-
namespace_suffix = namespace.nil? ? "" : "##{namespace}"
|
314
|
-
"#{redis_connection}#{namespace_suffix}"
|
315
|
-
end
|
326
|
+
def pollable?
|
327
|
+
!(current_path == "" || current_path.start_with?("metrics"))
|
316
328
|
end
|
317
329
|
|
318
330
|
def retry_or_delete_or_kill(job, params)
|
data/lib/sidekiq/web/router.rb
CHANGED
@@ -15,6 +15,10 @@ module Sidekiq
|
|
15
15
|
REQUEST_METHOD = "REQUEST_METHOD"
|
16
16
|
PATH_INFO = "PATH_INFO"
|
17
17
|
|
18
|
+
def head(path, &block)
|
19
|
+
route(HEAD, path, &block)
|
20
|
+
end
|
21
|
+
|
18
22
|
def get(path, &block)
|
19
23
|
route(GET, path, &block)
|
20
24
|
end
|
@@ -39,7 +43,6 @@ module Sidekiq
|
|
39
43
|
@routes ||= {GET => [], POST => [], PUT => [], PATCH => [], DELETE => [], HEAD => []}
|
40
44
|
|
41
45
|
@routes[method] << WebRoute.new(method, path, block)
|
42
|
-
@routes[HEAD] << WebRoute.new(method, path, block) if method == GET
|
43
46
|
end
|
44
47
|
|
45
48
|
def match(env)
|
@@ -66,7 +69,7 @@ module Sidekiq
|
|
66
69
|
class WebRoute
|
67
70
|
attr_accessor :request_method, :pattern, :block, :name
|
68
71
|
|
69
|
-
NAMED_SEGMENTS_PATTERN = /\/([^\/]*):([
|
72
|
+
NAMED_SEGMENTS_PATTERN = /\/([^\/]*):([^.:$\/]+)/
|
70
73
|
|
71
74
|
def initialize(request_method, pattern, block)
|
72
75
|
@request_method = request_method
|
@@ -94,9 +97,7 @@ module Sidekiq
|
|
94
97
|
{} if path == matcher
|
95
98
|
else
|
96
99
|
path_match = path.match(matcher)
|
97
|
-
|
98
|
-
Hash[path_match.names.map(&:to_sym).zip(path_match.captures)]
|
99
|
-
end
|
100
|
+
path_match&.named_captures&.transform_keys(&:to_sym)
|
100
101
|
end
|
101
102
|
end
|
102
103
|
end
|