sidekiq 6.0.7 → 6.4.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 +189 -2
- data/LICENSE +3 -3
- data/README.md +11 -10
- data/bin/sidekiq +8 -3
- data/bin/sidekiqload +57 -65
- 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 +164 -116
- data/lib/sidekiq/cli.rb +49 -15
- data/lib/sidekiq/client.rb +51 -70
- data/lib/sidekiq/delay.rb +2 -0
- data/lib/sidekiq/extensions/action_mailer.rb +3 -2
- data/lib/sidekiq/extensions/active_record.rb +4 -3
- data/lib/sidekiq/extensions/class_methods.rb +5 -4
- data/lib/sidekiq/extensions/generic_proxy.rb +4 -2
- data/lib/sidekiq/fetch.rb +32 -23
- data/lib/sidekiq/job.rb +13 -0
- data/lib/sidekiq/job_logger.rb +16 -28
- data/lib/sidekiq/job_retry.rb +32 -33
- data/lib/sidekiq/job_util.rb +67 -0
- data/lib/sidekiq/launcher.rb +113 -54
- data/lib/sidekiq/logger.rb +11 -20
- data/lib/sidekiq/manager.rb +16 -18
- data/lib/sidekiq/middleware/chain.rb +10 -8
- data/lib/sidekiq/middleware/current_attributes.rb +57 -0
- data/lib/sidekiq/middleware/i18n.rb +4 -4
- data/lib/sidekiq/monitor.rb +1 -1
- data/lib/sidekiq/paginator.rb +8 -8
- data/lib/sidekiq/processor.rb +31 -31
- data/lib/sidekiq/rails.rb +36 -20
- data/lib/sidekiq/redis_connection.rb +16 -15
- data/lib/sidekiq/scheduled.rb +51 -16
- data/lib/sidekiq/sd_notify.rb +1 -1
- data/lib/sidekiq/testing/inline.rb +4 -4
- data/lib/sidekiq/testing.rb +38 -39
- data/lib/sidekiq/util.rb +41 -0
- data/lib/sidekiq/version.rb +1 -1
- data/lib/sidekiq/web/action.rb +2 -2
- data/lib/sidekiq/web/application.rb +21 -12
- data/lib/sidekiq/web/csrf_protection.rb +180 -0
- data/lib/sidekiq/web/helpers.rb +39 -33
- data/lib/sidekiq/web/router.rb +5 -2
- data/lib/sidekiq/web.rb +36 -72
- data/lib/sidekiq/worker.rb +135 -16
- data/lib/sidekiq.rb +33 -17
- data/sidekiq.gemspec +11 -4
- data/web/assets/images/apple-touch-icon.png +0 -0
- data/web/assets/javascripts/application.js +113 -65
- data/web/assets/javascripts/dashboard.js +51 -51
- data/web/assets/stylesheets/application-dark.css +64 -43
- data/web/assets/stylesheets/application-rtl.css +0 -4
- data/web/assets/stylesheets/application.css +42 -239
- data/web/locales/ar.yml +8 -2
- data/web/locales/en.yml +4 -1
- data/web/locales/es.yml +18 -2
- data/web/locales/fr.yml +8 -1
- data/web/locales/ja.yml +3 -0
- data/web/locales/lt.yml +1 -1
- data/web/locales/pl.yml +4 -4
- data/web/locales/ru.yml +4 -0
- data/web/views/_footer.erb +1 -1
- data/web/views/_job_info.erb +1 -1
- data/web/views/_poll_link.erb +2 -5
- data/web/views/_summary.erb +7 -7
- data/web/views/busy.erb +51 -20
- data/web/views/dashboard.erb +22 -14
- data/web/views/dead.erb +1 -1
- data/web/views/layout.erb +2 -1
- data/web/views/morgue.erb +6 -6
- data/web/views/queue.erb +11 -11
- data/web/views/queues.erb +4 -4
- data/web/views/retries.erb +7 -7
- data/web/views/retry.erb +1 -1
- data/web/views/scheduled.erb +1 -1
- metadata +24 -49
- data/.circleci/config.yml +0 -60
- 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 -208
- 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 -782
- data/Rakefile +0 -10
- data/code_of_conduct.md +0 -50
- data/lib/generators/sidekiq/worker_generator.rb +0 -57
data/lib/sidekiq/util.rb
CHANGED
@@ -1,5 +1,6 @@
|
|
1
1
|
# frozen_string_literal: true
|
2
2
|
|
3
|
+
require "forwardable"
|
3
4
|
require "socket"
|
4
5
|
require "securerandom"
|
5
6
|
require "sidekiq/exception_handler"
|
@@ -8,9 +9,49 @@ module Sidekiq
|
|
8
9
|
##
|
9
10
|
# This module is part of Sidekiq core and not intended for extensions.
|
10
11
|
#
|
12
|
+
|
13
|
+
class RingBuffer
|
14
|
+
include Enumerable
|
15
|
+
extend Forwardable
|
16
|
+
def_delegators :@buf, :[], :each, :size
|
17
|
+
|
18
|
+
def initialize(size, default = 0)
|
19
|
+
@size = size
|
20
|
+
@buf = Array.new(size, default)
|
21
|
+
@index = 0
|
22
|
+
end
|
23
|
+
|
24
|
+
def <<(element)
|
25
|
+
@buf[@index % @size] = element
|
26
|
+
@index += 1
|
27
|
+
element
|
28
|
+
end
|
29
|
+
|
30
|
+
def buffer
|
31
|
+
@buf
|
32
|
+
end
|
33
|
+
|
34
|
+
def reset(default = 0)
|
35
|
+
@buf.fill(default)
|
36
|
+
end
|
37
|
+
end
|
38
|
+
|
11
39
|
module Util
|
12
40
|
include ExceptionHandler
|
13
41
|
|
42
|
+
# hack for quicker development / testing environment #2774
|
43
|
+
PAUSE_TIME = $stdout.tty? ? 0.1 : 0.5
|
44
|
+
|
45
|
+
# Wait for the orblock to be true or the deadline passed.
|
46
|
+
def wait_for(deadline, &condblock)
|
47
|
+
remaining = deadline - ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
|
48
|
+
while remaining > PAUSE_TIME
|
49
|
+
return if condblock.call
|
50
|
+
sleep PAUSE_TIME
|
51
|
+
remaining = deadline - ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
|
52
|
+
end
|
53
|
+
end
|
54
|
+
|
14
55
|
def watchdog(last_words)
|
15
56
|
yield
|
16
57
|
rescue Exception => ex
|
data/lib/sidekiq/version.rb
CHANGED
data/lib/sidekiq/web/action.rb
CHANGED
@@ -15,7 +15,7 @@ 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)
|
@@ -68,7 +68,7 @@ module Sidekiq
|
|
68
68
|
end
|
69
69
|
|
70
70
|
def json(payload)
|
71
|
-
[200, {"Content-Type" => "application/json", "Cache-Control" => "no-
|
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:",
|
@@ -42,9 +41,19 @@ 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
|
|
@@ -76,15 +85,17 @@ module Sidekiq
|
|
76
85
|
erb(:queues)
|
77
86
|
end
|
78
87
|
|
88
|
+
QUEUE_NAME = /\A[a-z_:.\-0-9]+\z/i
|
89
|
+
|
79
90
|
get "/queues/:name" do
|
80
91
|
@name = route_params[:name]
|
81
92
|
|
82
|
-
halt(404)
|
93
|
+
halt(404) if !@name || @name !~ QUEUE_NAME
|
83
94
|
|
84
95
|
@count = (params["count"] || 25).to_i
|
85
96
|
@queue = Sidekiq::Queue.new(@name)
|
86
|
-
(@current_page, @total_size, @
|
87
|
-
@
|
97
|
+
(@current_page, @total_size, @jobs) = page("queue:#{@name}", params["page"], @count, reverse: params["direction"] == "asc")
|
98
|
+
@jobs = @jobs.map { |msg| Sidekiq::JobRecord.new(msg, @name) }
|
88
99
|
|
89
100
|
erb(:queue)
|
90
101
|
end
|
@@ -105,7 +116,7 @@ module Sidekiq
|
|
105
116
|
|
106
117
|
post "/queues/:name/delete" do
|
107
118
|
name = route_params[:name]
|
108
|
-
Sidekiq::
|
119
|
+
Sidekiq::JobRecord.new(params["key_val"], name).delete
|
109
120
|
|
110
121
|
redirect_with_query("#{root_path}queues/#{CGI.escape(name)}")
|
111
122
|
end
|
@@ -291,14 +302,14 @@ module Sidekiq
|
|
291
302
|
return [404, {"Content-Type" => "text/plain", "X-Cascade" => "pass"}, ["Not Found"]] unless action
|
292
303
|
|
293
304
|
app = @klass
|
294
|
-
resp = catch(:halt) do
|
305
|
+
resp = catch(:halt) do
|
295
306
|
self.class.run_befores(app, action)
|
296
307
|
action.instance_exec env, &action.block
|
297
308
|
ensure
|
298
309
|
self.class.run_afters(app, action)
|
299
310
|
end
|
300
311
|
|
301
|
-
|
312
|
+
case resp
|
302
313
|
when Array
|
303
314
|
# redirects go here
|
304
315
|
resp
|
@@ -306,19 +317,17 @@ module Sidekiq
|
|
306
317
|
# rendered content goes here
|
307
318
|
headers = {
|
308
319
|
"Content-Type" => "text/html",
|
309
|
-
"Cache-Control" => "no-
|
320
|
+
"Cache-Control" => "private, no-store",
|
310
321
|
"Content-Language" => action.locale,
|
311
322
|
"Content-Security-Policy" => CSP_HEADER
|
312
323
|
}
|
313
324
|
# we'll let Rack calculate Content-Length for us.
|
314
325
|
[200, headers, [resp]]
|
315
326
|
end
|
316
|
-
|
317
|
-
resp
|
318
327
|
end
|
319
328
|
|
320
329
|
def self.helpers(mod = nil, &block)
|
321
|
-
if
|
330
|
+
if block
|
322
331
|
WebAction.class_eval(&block)
|
323
332
|
else
|
324
333
|
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..-1]
|
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.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
|
|
@@ -144,8 +140,8 @@ module Sidekiq
|
|
144
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
|
@@ -158,8 +154,7 @@ module Sidekiq
|
|
158
154
|
|
159
155
|
def redis_connection
|
160
156
|
Sidekiq.redis do |conn|
|
161
|
-
|
162
|
-
"redis://#{c[:location]}/#{c[:db]}"
|
157
|
+
conn.connection[:id]
|
163
158
|
end
|
164
159
|
end
|
165
160
|
|
@@ -180,7 +175,7 @@ module Sidekiq
|
|
180
175
|
end
|
181
176
|
|
182
177
|
def current_status
|
183
|
-
|
178
|
+
workset.size == 0 ? "idle" : "active"
|
184
179
|
end
|
185
180
|
|
186
181
|
def relative_time(time)
|
@@ -197,16 +192,13 @@ module Sidekiq
|
|
197
192
|
[score.to_f, jid]
|
198
193
|
end
|
199
194
|
|
200
|
-
SAFE_QPARAMS = %w[page
|
195
|
+
SAFE_QPARAMS = %w[page direction]
|
201
196
|
|
202
197
|
# Merge options with current params, filter safe params, and stringify to query string
|
203
198
|
def qparams(options)
|
204
|
-
|
205
|
-
options.keys.each do |key|
|
206
|
-
options[key.to_s] = options.delete(key)
|
207
|
-
end
|
199
|
+
stringified_options = options.transform_keys(&:to_s)
|
208
200
|
|
209
|
-
to_query_string(params.merge(
|
201
|
+
to_query_string(params.merge(stringified_options))
|
210
202
|
end
|
211
203
|
|
212
204
|
def to_query_string(params)
|
@@ -233,7 +225,7 @@ module Sidekiq
|
|
233
225
|
end
|
234
226
|
|
235
227
|
def csrf_tag
|
236
|
-
"<input type='hidden' name='authenticity_token' value='#{
|
228
|
+
"<input type='hidden' name='authenticity_token' value='#{env[:csrf_token]}'/>"
|
237
229
|
end
|
238
230
|
|
239
231
|
def to_display(arg)
|
@@ -250,7 +242,7 @@ module Sidekiq
|
|
250
242
|
queue class args retry_count retried_at failed_at
|
251
243
|
jid error_message error_class backtrace
|
252
244
|
error_backtrace enqueued_at retry wrapped
|
253
|
-
created_at tags
|
245
|
+
created_at tags display_class
|
254
246
|
])
|
255
247
|
|
256
248
|
def retry_extra_items(retry_job)
|
@@ -261,7 +253,21 @@ module Sidekiq
|
|
261
253
|
end
|
262
254
|
end
|
263
255
|
|
256
|
+
def format_memory(rss_kb)
|
257
|
+
return "0" if rss_kb.nil? || rss_kb == 0
|
258
|
+
|
259
|
+
if rss_kb < 100_000
|
260
|
+
"#{number_with_delimiter(rss_kb)} KB"
|
261
|
+
elsif rss_kb < 10_000_000
|
262
|
+
"#{number_with_delimiter((rss_kb / 1024.0).to_i)} MB"
|
263
|
+
else
|
264
|
+
"#{number_with_delimiter((rss_kb / (1024.0 * 1024.0)).round(1))} GB"
|
265
|
+
end
|
266
|
+
end
|
267
|
+
|
264
268
|
def number_with_delimiter(number)
|
269
|
+
return "" if number.nil?
|
270
|
+
|
265
271
|
begin
|
266
272
|
Float(number)
|
267
273
|
rescue ArgumentError, TypeError
|
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
|
data/lib/sidekiq/web.rb
CHANGED
@@ -10,12 +10,11 @@ require "sidekiq/web/helpers"
|
|
10
10
|
require "sidekiq/web/router"
|
11
11
|
require "sidekiq/web/action"
|
12
12
|
require "sidekiq/web/application"
|
13
|
+
require "sidekiq/web/csrf_protection"
|
13
14
|
|
14
|
-
require "rack/
|
15
|
-
|
15
|
+
require "rack/content_length"
|
16
16
|
require "rack/builder"
|
17
|
-
require "rack/
|
18
|
-
require "rack/session/cookie"
|
17
|
+
require "rack/static"
|
19
18
|
|
20
19
|
module Sidekiq
|
21
20
|
class Web
|
@@ -39,14 +38,6 @@ module Sidekiq
|
|
39
38
|
self
|
40
39
|
end
|
41
40
|
|
42
|
-
def middlewares
|
43
|
-
@middlewares ||= []
|
44
|
-
end
|
45
|
-
|
46
|
-
def use(*middleware_args, &block)
|
47
|
-
middlewares << [middleware_args, block]
|
48
|
-
end
|
49
|
-
|
50
41
|
def default_tabs
|
51
42
|
DEFAULT_TABS
|
52
43
|
end
|
@@ -72,32 +63,45 @@ module Sidekiq
|
|
72
63
|
opts.each { |key| set(key, false) }
|
73
64
|
end
|
74
65
|
|
75
|
-
|
66
|
+
def middlewares
|
67
|
+
@middlewares ||= []
|
68
|
+
end
|
69
|
+
|
70
|
+
def use(*args, &block)
|
71
|
+
middlewares << [args, block]
|
72
|
+
end
|
73
|
+
|
76
74
|
def set(attribute, value)
|
77
75
|
send(:"#{attribute}=", value)
|
78
76
|
end
|
79
77
|
|
80
|
-
|
78
|
+
def sessions=(val)
|
79
|
+
puts "WARNING: Sidekiq::Web.sessions= is no longer relevant and will be removed in Sidekiq 7.0. #{caller(1..1).first}"
|
80
|
+
end
|
81
|
+
|
82
|
+
def session_secret=(val)
|
83
|
+
puts "WARNING: Sidekiq::Web.session_secret= is no longer relevant and will be removed in Sidekiq 7.0. #{caller(1..1).first}"
|
84
|
+
end
|
85
|
+
|
86
|
+
attr_accessor :app_url, :redis_pool
|
81
87
|
attr_writer :locales, :views
|
82
88
|
end
|
83
89
|
|
84
90
|
def self.inherited(child)
|
85
91
|
child.app_url = app_url
|
86
|
-
child.session_secret = session_secret
|
87
92
|
child.redis_pool = redis_pool
|
88
|
-
child.sessions = sessions
|
89
93
|
end
|
90
94
|
|
91
95
|
def settings
|
92
96
|
self.class.settings
|
93
97
|
end
|
94
98
|
|
95
|
-
def
|
96
|
-
middlewares
|
99
|
+
def middlewares
|
100
|
+
@middlewares ||= self.class.middlewares
|
97
101
|
end
|
98
102
|
|
99
|
-
def
|
100
|
-
|
103
|
+
def use(*args, &block)
|
104
|
+
middlewares << [args, block]
|
101
105
|
end
|
102
106
|
|
103
107
|
def call(env)
|
@@ -125,18 +129,8 @@ module Sidekiq
|
|
125
129
|
send(:"#{attribute}=", value)
|
126
130
|
end
|
127
131
|
|
128
|
-
|
129
|
-
|
130
|
-
|
131
|
-
attr_writer :sessions
|
132
|
-
|
133
|
-
def sessions
|
134
|
-
unless instance_variable_defined?("@sessions")
|
135
|
-
@sessions = self.class.sessions
|
136
|
-
@sessions = @sessions.to_hash.dup if @sessions.respond_to?(:to_hash)
|
137
|
-
end
|
138
|
-
|
139
|
-
@sessions
|
132
|
+
def sessions=(val)
|
133
|
+
puts "Sidekiq::Web#sessions= is no longer relevant and will be removed in Sidekiq 7.0. #{caller[2..2].first}"
|
140
134
|
end
|
141
135
|
|
142
136
|
def self.register(extension)
|
@@ -145,50 +139,20 @@ module Sidekiq
|
|
145
139
|
|
146
140
|
private
|
147
141
|
|
148
|
-
def using?(middleware)
|
149
|
-
middlewares.any? do |(m, _)|
|
150
|
-
m.is_a?(Array) && (m[0] == middleware || m[0].is_a?(middleware))
|
151
|
-
end
|
152
|
-
end
|
153
|
-
|
154
|
-
def build_sessions
|
155
|
-
middlewares = self.middlewares
|
156
|
-
|
157
|
-
unless using?(::Rack::Protection) || ENV["RACK_ENV"] == "test"
|
158
|
-
middlewares.unshift [[::Rack::Protection, {use: :authenticity_token}], nil]
|
159
|
-
end
|
160
|
-
|
161
|
-
s = sessions
|
162
|
-
return unless s
|
163
|
-
|
164
|
-
unless using? ::Rack::Session::Cookie
|
165
|
-
unless (secret = Web.session_secret)
|
166
|
-
require "securerandom"
|
167
|
-
secret = SecureRandom.hex(64)
|
168
|
-
end
|
169
|
-
|
170
|
-
options = {secret: secret}
|
171
|
-
options = options.merge(s.to_hash) if s.respond_to? :to_hash
|
172
|
-
|
173
|
-
middlewares.unshift [[::Rack::Session::Cookie, options], nil]
|
174
|
-
end
|
175
|
-
end
|
176
|
-
|
177
142
|
def build
|
178
|
-
build_sessions
|
179
|
-
|
180
|
-
middlewares = self.middlewares
|
181
143
|
klass = self.class
|
144
|
+
m = middlewares
|
182
145
|
|
183
|
-
|
184
|
-
|
185
|
-
map "/#{asset_dir}" do
|
186
|
-
run ::Rack::File.new("#{ASSETS}/#{asset_dir}", {"Cache-Control" => "public, max-age=86400"})
|
187
|
-
end
|
188
|
-
end
|
189
|
-
|
190
|
-
middlewares.each { |middleware, block| use(*middleware, &block) }
|
146
|
+
rules = []
|
147
|
+
rules = [[:all, {"Cache-Control" => "public, max-age=86400"}]] unless ENV["SIDEKIQ_WEB_TESTING"]
|
191
148
|
|
149
|
+
::Rack::Builder.new do
|
150
|
+
use Rack::Static, urls: ["/stylesheets", "/images", "/javascripts"],
|
151
|
+
root: ASSETS,
|
152
|
+
cascade: true,
|
153
|
+
header_rules: rules
|
154
|
+
m.each { |middleware, block| use(*middleware, &block) }
|
155
|
+
use Sidekiq::Web::CsrfProtection unless $TESTING
|
192
156
|
run WebApplication.new(klass)
|
193
157
|
end
|
194
158
|
end
|