sidekiq 5.2.2 → 7.2.0
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 +5 -5
- data/Changes.md +657 -8
- data/LICENSE.txt +9 -0
- data/README.md +47 -50
- data/bin/sidekiq +22 -3
- data/bin/sidekiqload +213 -115
- data/bin/sidekiqmon +11 -0
- 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 +558 -353
- data/lib/sidekiq/capsule.rb +127 -0
- data/lib/sidekiq/cli.rb +238 -260
- data/lib/sidekiq/client.rb +127 -102
- 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 +49 -42
- data/lib/sidekiq/job.rb +374 -0
- data/lib/sidekiq/job_logger.rb +35 -9
- data/lib/sidekiq/job_retry.rb +162 -102
- data/lib/sidekiq/job_util.rb +107 -0
- data/lib/sidekiq/launcher.rb +203 -105
- data/lib/sidekiq/logger.rb +131 -0
- data/lib/sidekiq/manager.rb +43 -46
- data/lib/sidekiq/metrics/query.rb +155 -0
- data/lib/sidekiq/metrics/shared.rb +95 -0
- data/lib/sidekiq/metrics/tracking.rb +136 -0
- data/lib/sidekiq/middleware/chain.rb +113 -56
- data/lib/sidekiq/middleware/current_attributes.rb +95 -0
- data/lib/sidekiq/middleware/i18n.rb +7 -7
- data/lib/sidekiq/middleware/modules.rb +21 -0
- data/lib/sidekiq/monitor.rb +146 -0
- data/lib/sidekiq/paginator.rb +28 -16
- data/lib/sidekiq/processor.rb +127 -118
- data/lib/sidekiq/rails.rb +50 -39
- data/lib/sidekiq/redis_client_adapter.rb +111 -0
- data/lib/sidekiq/redis_connection.rb +40 -89
- data/lib/sidekiq/ring_buffer.rb +29 -0
- data/lib/sidekiq/scheduled.rb +111 -49
- data/lib/sidekiq/sd_notify.rb +149 -0
- data/lib/sidekiq/systemd.rb +24 -0
- data/lib/sidekiq/testing/inline.rb +6 -5
- data/lib/sidekiq/testing.rb +90 -89
- data/lib/sidekiq/transaction_aware_client.rb +44 -0
- data/lib/sidekiq/version.rb +3 -1
- data/lib/sidekiq/web/action.rb +15 -11
- data/lib/sidekiq/web/application.rb +189 -79
- data/lib/sidekiq/web/csrf_protection.rb +180 -0
- data/lib/sidekiq/web/helpers.rb +160 -114
- data/lib/sidekiq/web/router.rb +23 -19
- data/lib/sidekiq/web.rb +68 -107
- data/lib/sidekiq/worker_compatibility_alias.rb +13 -0
- data/lib/sidekiq.rb +94 -182
- data/sidekiq.gemspec +25 -18
- data/web/assets/images/apple-touch-icon.png +0 -0
- data/web/assets/javascripts/application.js +146 -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 +182 -0
- data/web/assets/javascripts/dashboard.js +35 -283
- data/web/assets/javascripts/metrics.js +298 -0
- data/web/assets/stylesheets/application-dark.css +147 -0
- data/web/assets/stylesheets/application-rtl.css +2 -95
- data/web/assets/stylesheets/application.css +143 -521
- data/web/assets/stylesheets/bootstrap.css +1 -1
- data/web/locales/ar.yml +71 -65
- data/web/locales/cs.yml +62 -62
- data/web/locales/da.yml +60 -53
- data/web/locales/de.yml +65 -53
- data/web/locales/el.yml +43 -24
- data/web/locales/en.yml +86 -66
- data/web/locales/es.yml +70 -54
- data/web/locales/fa.yml +65 -65
- data/web/locales/fr.yml +83 -62
- data/web/locales/gd.yml +99 -0
- 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 +75 -64
- 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 +83 -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 +21 -4
- data/web/views/_metrics_period_select.erb +12 -0
- data/web/views/_nav.erb +4 -18
- data/web/views/_paging.erb +2 -0
- data/web/views/_poll_link.erb +3 -6
- data/web/views/_summary.erb +7 -7
- data/web/views/busy.erb +77 -27
- data/web/views/dashboard.erb +48 -18
- data/web/views/dead.erb +3 -3
- data/web/views/filtering.erb +7 -0
- data/web/views/layout.erb +3 -1
- data/web/views/metrics.erb +91 -0
- data/web/views/metrics_for_job.erb +59 -0
- data/web/views/morgue.erb +14 -15
- data/web/views/queue.erb +33 -24
- data/web/views/queues.erb +19 -5
- data/web/views/retries.erb +16 -17
- data/web/views/retry.erb +3 -3
- data/web/views/scheduled.erb +17 -15
- metadata +80 -65
- data/.github/contributing.md +0 -32
- data/.github/issue_template.md +0 -11
- data/.gitignore +0 -13
- data/.travis.yml +0 -14
- data/3.0-Upgrade.md +0 -70
- data/4.0-Upgrade.md +0 -53
- data/5.0-Upgrade.md +0 -56
- data/COMM-LICENSE +0 -95
- data/Ent-Changes.md +0 -221
- data/Gemfile +0 -14
- 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-Changes.md +0 -746
- data/Rakefile +0 -8
- data/bin/sidekiqctl +0 -99
- data/code_of_conduct.md +0 -50
- data/lib/generators/sidekiq/worker_generator.rb +0 -49
- data/lib/sidekiq/core_ext.rb +0 -1
- data/lib/sidekiq/delay.rb +0 -42
- data/lib/sidekiq/exception_handler.rb +0 -29
- data/lib/sidekiq/extensions/action_mailer.rb +0 -57
- data/lib/sidekiq/extensions/active_record.rb +0 -40
- data/lib/sidekiq/extensions/class_methods.rb +0 -40
- data/lib/sidekiq/extensions/generic_proxy.rb +0 -31
- data/lib/sidekiq/logging.rb +0 -122
- data/lib/sidekiq/middleware/server/active_record.rb +0 -23
- data/lib/sidekiq/util.rb +0 -66
- data/lib/sidekiq/worker.rb +0 -204
data/lib/sidekiq/client.rb
CHANGED
@@ -1,9 +1,12 @@
|
|
1
1
|
# frozen_string_literal: true
|
2
|
-
|
3
|
-
require
|
2
|
+
|
3
|
+
require "securerandom"
|
4
|
+
require "sidekiq/middleware/chain"
|
5
|
+
require "sidekiq/job_util"
|
4
6
|
|
5
7
|
module Sidekiq
|
6
8
|
class Client
|
9
|
+
include Sidekiq::JobUtil
|
7
10
|
|
8
11
|
##
|
9
12
|
# Define client-side middleware:
|
@@ -12,14 +15,13 @@ module Sidekiq
|
|
12
15
|
# client.middleware do |chain|
|
13
16
|
# chain.use MyClientMiddleware
|
14
17
|
# end
|
15
|
-
# client.push('class' => '
|
18
|
+
# client.push('class' => 'SomeJob', 'args' => [1,2,3])
|
16
19
|
#
|
17
20
|
# All client instances default to the globally-defined
|
18
21
|
# Sidekiq.client_middleware but you can change as necessary.
|
19
22
|
#
|
20
23
|
def middleware(&block)
|
21
|
-
|
22
|
-
if block_given?
|
24
|
+
if block
|
23
25
|
@chain = @chain.dup
|
24
26
|
yield @chain
|
25
27
|
end
|
@@ -28,58 +30,76 @@ module Sidekiq
|
|
28
30
|
|
29
31
|
attr_accessor :redis_pool
|
30
32
|
|
31
|
-
# Sidekiq::Client
|
32
|
-
#
|
33
|
-
# Sidekiq jobs across several Redis instances (for scalability
|
34
|
-
# reasons, e.g.)
|
33
|
+
# Sidekiq::Client is responsible for pushing job payloads to Redis.
|
34
|
+
# Requires the :pool or :config keyword argument.
|
35
35
|
#
|
36
|
-
# Sidekiq::Client.new(
|
36
|
+
# Sidekiq::Client.new(pool: Sidekiq::RedisConnection.create)
|
37
37
|
#
|
38
|
-
#
|
39
|
-
#
|
40
|
-
#
|
41
|
-
|
42
|
-
|
38
|
+
# Inside the Sidekiq process, you can reuse the configured resources:
|
39
|
+
#
|
40
|
+
# Sidekiq::Client.new(config: config)
|
41
|
+
#
|
42
|
+
# @param pool [ConnectionPool] explicit Redis pool to use
|
43
|
+
# @param config [Sidekiq::Config] use the pool and middleware from the given Sidekiq container
|
44
|
+
# @param chain [Sidekiq::Middleware::Chain] use the given middleware chain
|
45
|
+
def initialize(*args, **kwargs)
|
46
|
+
if args.size == 1 && kwargs.size == 0
|
47
|
+
warn "Sidekiq::Client.new(pool) is deprecated, please use Sidekiq::Client.new(pool: pool), #{caller(0..3)}"
|
48
|
+
# old calling method, accept 1 pool argument
|
49
|
+
@redis_pool = args[0]
|
50
|
+
@chain = Sidekiq.default_configuration.client_middleware
|
51
|
+
@config = Sidekiq.default_configuration
|
52
|
+
else
|
53
|
+
# new calling method: keyword arguments
|
54
|
+
@config = kwargs[:config] || Sidekiq.default_configuration
|
55
|
+
@redis_pool = kwargs[:pool] || Thread.current[:sidekiq_redis_pool] || @config&.redis_pool
|
56
|
+
@chain = kwargs[:chain] || @config&.client_middleware
|
57
|
+
raise ArgumentError, "No Redis pool available for Sidekiq::Client" unless @redis_pool
|
58
|
+
end
|
43
59
|
end
|
44
60
|
|
45
61
|
##
|
46
62
|
# The main method used to push a job to Redis. Accepts a number of options:
|
47
63
|
#
|
48
64
|
# queue - the named queue to use, default 'default'
|
49
|
-
# class - the
|
65
|
+
# class - the job class to call, required
|
50
66
|
# args - an array of simple arguments to the perform method, must be JSON-serializable
|
51
67
|
# at - timestamp to schedule the job (optional), must be Numeric (e.g. Time.now.to_f)
|
52
68
|
# retry - whether to retry this job if it fails, default true or an integer number of retries
|
69
|
+
# retry_for - relative amount of time to retry this job if it fails, default nil
|
53
70
|
# backtrace - whether to save any error backtrace, default false
|
54
71
|
#
|
55
72
|
# If class is set to the class name, the jobs' options will be based on Sidekiq's default
|
56
|
-
#
|
73
|
+
# job options. Otherwise, they will be based on the job class's options.
|
57
74
|
#
|
58
|
-
# Any options valid for a
|
75
|
+
# Any options valid for a job class's sidekiq_options are also available here.
|
59
76
|
#
|
60
|
-
# All
|
77
|
+
# All keys must be strings, not symbols. NB: because we are serializing to JSON, all
|
61
78
|
# symbols in 'args' will be converted to strings. Note that +backtrace: true+ can take quite a bit of
|
62
79
|
# space in Redis; a large volume of failing jobs can start Redis swapping if you aren't careful.
|
63
80
|
#
|
64
81
|
# Returns a unique Job ID. If middleware stops the job, nil will be returned instead.
|
65
82
|
#
|
66
83
|
# Example:
|
67
|
-
# push('queue' => 'my_queue', 'class' =>
|
84
|
+
# push('queue' => 'my_queue', 'class' => MyJob, 'args' => ['foo', 1, :bat => 'bar'])
|
68
85
|
#
|
69
86
|
def push(item)
|
70
87
|
normed = normalize_item(item)
|
71
|
-
payload =
|
72
|
-
|
88
|
+
payload = middleware.invoke(item["class"], normed, normed["queue"], @redis_pool) do
|
89
|
+
normed
|
90
|
+
end
|
73
91
|
if payload
|
92
|
+
verify_json(payload)
|
74
93
|
raw_push([payload])
|
75
|
-
payload[
|
94
|
+
payload["jid"]
|
76
95
|
end
|
77
96
|
end
|
78
97
|
|
79
98
|
##
|
80
99
|
# Push a large number of jobs to Redis. This method cuts out the redis
|
81
|
-
# network round trip latency.
|
82
|
-
# 1000
|
100
|
+
# network round trip latency. It pushes jobs in batches if more than
|
101
|
+
# `:batch_size` (1000 by default) of jobs are passed. I wouldn't recommend making `:batch_size`
|
102
|
+
# larger than 1000 but YMMV based on network quality, size of job args, etc.
|
83
103
|
# A large number of jobs can cause a bit of Redis command processing latency.
|
84
104
|
#
|
85
105
|
# Takes the same arguments as #push except that args is expected to be
|
@@ -87,22 +107,45 @@ module Sidekiq
|
|
87
107
|
# is run through the client middleware pipeline and each job gets its own Job ID
|
88
108
|
# as normal.
|
89
109
|
#
|
90
|
-
# Returns an array of the of pushed jobs' jids
|
91
|
-
#
|
110
|
+
# Returns an array of the of pushed jobs' jids, may contain nils if any client middleware
|
111
|
+
# prevented a job push.
|
112
|
+
#
|
113
|
+
# Example (pushing jobs in batches):
|
114
|
+
# push_bulk('class' => MyJob, 'args' => (1..100_000).to_a, batch_size: 1_000)
|
115
|
+
#
|
92
116
|
def push_bulk(items)
|
93
|
-
|
94
|
-
|
95
|
-
|
117
|
+
batch_size = items.delete(:batch_size) || items.delete("batch_size") || 1_000
|
118
|
+
args = items["args"]
|
119
|
+
at = items.delete("at")
|
120
|
+
raise ArgumentError, "Job 'at' must be a Numeric or an Array of Numeric timestamps" if at && (Array(at).empty? || !Array(at).all? { |entry| entry.is_a?(Numeric) })
|
121
|
+
raise ArgumentError, "Job 'at' Array must have same size as 'args' Array" if at.is_a?(Array) && at.size != args.size
|
122
|
+
|
123
|
+
jid = items.delete("jid")
|
124
|
+
raise ArgumentError, "Explicitly passing 'jid' when pushing more than one job is not supported" if jid && args.size > 1
|
96
125
|
|
97
126
|
normed = normalize_item(items)
|
98
|
-
|
99
|
-
|
100
|
-
|
101
|
-
|
102
|
-
|
103
|
-
|
104
|
-
|
105
|
-
|
127
|
+
slice_index = 0
|
128
|
+
result = args.each_slice(batch_size).flat_map do |slice|
|
129
|
+
raise ArgumentError, "Bulk arguments must be an Array of Arrays: [[1], [2]]" unless slice.is_a?(Array) && slice.all?(Array)
|
130
|
+
break [] if slice.empty? # no jobs to push
|
131
|
+
|
132
|
+
payloads = slice.map.with_index { |job_args, index|
|
133
|
+
copy = normed.merge("args" => job_args, "jid" => SecureRandom.hex(12))
|
134
|
+
copy["at"] = (at.is_a?(Array) ? at[slice_index + index] : at) if at
|
135
|
+
result = middleware.invoke(items["class"], copy, copy["queue"], @redis_pool) do
|
136
|
+
verify_json(copy)
|
137
|
+
copy
|
138
|
+
end
|
139
|
+
result || nil
|
140
|
+
}
|
141
|
+
slice_index += batch_size
|
142
|
+
|
143
|
+
to_push = payloads.compact
|
144
|
+
raw_push(to_push) unless to_push.empty?
|
145
|
+
payloads.map { |payload| payload&.[]("jid") }
|
146
|
+
end
|
147
|
+
|
148
|
+
result.is_a?(Enumerator::Lazy) ? result.force : result
|
106
149
|
end
|
107
150
|
|
108
151
|
# Allows sharding of jobs across any number of Redis instances. All jobs
|
@@ -110,8 +153,8 @@ module Sidekiq
|
|
110
153
|
#
|
111
154
|
# pool = ConnectionPool.new { Redis.new }
|
112
155
|
# Sidekiq::Client.via(pool) do
|
113
|
-
#
|
114
|
-
#
|
156
|
+
# SomeJob.perform_async(1,2,3)
|
157
|
+
# SomeOtherJob.perform_async(1,2,3)
|
115
158
|
# end
|
116
159
|
#
|
117
160
|
# Generally this is only needed for very large Sidekiq installs processing
|
@@ -119,58 +162,57 @@ module Sidekiq
|
|
119
162
|
# you cannot scale any other way (e.g. splitting your app into smaller apps).
|
120
163
|
def self.via(pool)
|
121
164
|
raise ArgumentError, "No pool given" if pool.nil?
|
122
|
-
current_sidekiq_pool = Thread.current[:
|
123
|
-
Thread.current[:
|
165
|
+
current_sidekiq_pool = Thread.current[:sidekiq_redis_pool]
|
166
|
+
Thread.current[:sidekiq_redis_pool] = pool
|
124
167
|
yield
|
125
168
|
ensure
|
126
|
-
Thread.current[:
|
169
|
+
Thread.current[:sidekiq_redis_pool] = current_sidekiq_pool
|
127
170
|
end
|
128
171
|
|
129
172
|
class << self
|
130
|
-
|
131
173
|
def push(item)
|
132
174
|
new.push(item)
|
133
175
|
end
|
134
176
|
|
135
|
-
def push_bulk(
|
136
|
-
new.push_bulk(
|
177
|
+
def push_bulk(...)
|
178
|
+
new.push_bulk(...)
|
137
179
|
end
|
138
180
|
|
139
181
|
# Resque compatibility helpers. Note all helpers
|
140
|
-
# should go through
|
182
|
+
# should go through Sidekiq::Job#client_push.
|
141
183
|
#
|
142
184
|
# Example usage:
|
143
|
-
# Sidekiq::Client.enqueue(
|
185
|
+
# Sidekiq::Client.enqueue(MyJob, 'foo', 1, :bat => 'bar')
|
144
186
|
#
|
145
187
|
# Messages are enqueued to the 'default' queue.
|
146
188
|
#
|
147
189
|
def enqueue(klass, *args)
|
148
|
-
klass.client_push(
|
190
|
+
klass.client_push("class" => klass, "args" => args)
|
149
191
|
end
|
150
192
|
|
151
193
|
# Example usage:
|
152
|
-
# Sidekiq::Client.enqueue_to(:queue_name,
|
194
|
+
# Sidekiq::Client.enqueue_to(:queue_name, MyJob, 'foo', 1, :bat => 'bar')
|
153
195
|
#
|
154
196
|
def enqueue_to(queue, klass, *args)
|
155
|
-
klass.client_push(
|
197
|
+
klass.client_push("queue" => queue, "class" => klass, "args" => args)
|
156
198
|
end
|
157
199
|
|
158
200
|
# Example usage:
|
159
|
-
# Sidekiq::Client.enqueue_to_in(:queue_name, 3.minutes,
|
201
|
+
# Sidekiq::Client.enqueue_to_in(:queue_name, 3.minutes, MyJob, 'foo', 1, :bat => 'bar')
|
160
202
|
#
|
161
203
|
def enqueue_to_in(queue, interval, klass, *args)
|
162
204
|
int = interval.to_f
|
163
205
|
now = Time.now.to_f
|
164
|
-
ts = (int < 1_000_000_000 ? now + int : int)
|
206
|
+
ts = ((int < 1_000_000_000) ? now + int : int)
|
165
207
|
|
166
|
-
item = {
|
167
|
-
item.delete(
|
208
|
+
item = {"class" => klass, "args" => args, "at" => ts, "queue" => queue}
|
209
|
+
item.delete("at") if ts <= now
|
168
210
|
|
169
211
|
klass.client_push(item)
|
170
212
|
end
|
171
213
|
|
172
214
|
# Example usage:
|
173
|
-
# Sidekiq::Client.enqueue_in(3.minutes,
|
215
|
+
# Sidekiq::Client.enqueue_in(3.minutes, MyJob, 'foo', 1, :bat => 'bar')
|
174
216
|
#
|
175
217
|
def enqueue_in(interval, klass, *args)
|
176
218
|
klass.perform_in(interval, *args)
|
@@ -181,62 +223,45 @@ module Sidekiq
|
|
181
223
|
|
182
224
|
def raw_push(payloads)
|
183
225
|
@redis_pool.with do |conn|
|
184
|
-
|
185
|
-
|
226
|
+
retryable = true
|
227
|
+
begin
|
228
|
+
conn.pipelined do |pipeline|
|
229
|
+
atomic_push(pipeline, payloads)
|
230
|
+
end
|
231
|
+
rescue RedisClient::Error => ex
|
232
|
+
# 2550 Failover can cause the server to become a replica, need
|
233
|
+
# to disconnect and reopen the socket to get back to the primary.
|
234
|
+
# 4495 Use the same logic if we have a "Not enough replicas" error from the primary
|
235
|
+
# 4985 Use the same logic when a blocking command is force-unblocked
|
236
|
+
# The retry logic is copied from sidekiq.rb
|
237
|
+
if retryable && ex.message =~ /READONLY|NOREPLICAS|UNBLOCKED/
|
238
|
+
conn.close
|
239
|
+
retryable = false
|
240
|
+
retry
|
241
|
+
end
|
242
|
+
raise
|
186
243
|
end
|
187
244
|
end
|
188
245
|
true
|
189
246
|
end
|
190
247
|
|
191
248
|
def atomic_push(conn, payloads)
|
192
|
-
if payloads.first
|
193
|
-
conn.zadd(
|
194
|
-
at = hash.delete(
|
249
|
+
if payloads.first.key?("at")
|
250
|
+
conn.zadd("schedule", payloads.flat_map { |hash|
|
251
|
+
at = hash.delete("at").to_s
|
252
|
+
# ActiveJob sets this but the job has not been enqueued yet
|
253
|
+
hash.delete("enqueued_at")
|
195
254
|
[at, Sidekiq.dump_json(hash)]
|
196
|
-
|
255
|
+
})
|
197
256
|
else
|
198
|
-
|
257
|
+
queue = payloads.first["queue"]
|
199
258
|
now = Time.now.to_f
|
200
|
-
to_push = payloads.map
|
201
|
-
entry[
|
259
|
+
to_push = payloads.map { |entry|
|
260
|
+
entry["enqueued_at"] = now
|
202
261
|
Sidekiq.dump_json(entry)
|
203
|
-
|
204
|
-
conn.sadd(
|
205
|
-
conn.lpush("queue:#{
|
206
|
-
end
|
207
|
-
end
|
208
|
-
|
209
|
-
def process_single(worker_class, item)
|
210
|
-
queue = item['queue']
|
211
|
-
|
212
|
-
middleware.invoke(worker_class, item, queue, @redis_pool) do
|
213
|
-
item
|
214
|
-
end
|
215
|
-
end
|
216
|
-
|
217
|
-
def normalize_item(item)
|
218
|
-
raise(ArgumentError, "Job must be a Hash with 'class' and 'args' keys: { 'class' => SomeWorker, 'args' => ['bob', 1, :foo => 'bar'] }") unless item.is_a?(Hash) && item.has_key?('class') && item.has_key?('args')
|
219
|
-
raise(ArgumentError, "Job args must be an Array") unless item['args'].is_a?(Array)
|
220
|
-
raise(ArgumentError, "Job class must be either a Class or String representation of the class name") unless item['class'].is_a?(Class) || item['class'].is_a?(String)
|
221
|
-
raise(ArgumentError, "Job 'at' must be a Numeric timestamp") if item.has_key?('at') && !item['at'].is_a?(Numeric)
|
222
|
-
#raise(ArgumentError, "Arguments must be native JSON types, see https://github.com/mperham/sidekiq/wiki/Best-Practices") unless JSON.load(JSON.dump(item['args'])) == item['args']
|
223
|
-
|
224
|
-
normalized_hash(item['class'])
|
225
|
-
.each{ |key, value| item[key] = value if item[key].nil? }
|
226
|
-
|
227
|
-
item['class'] = item['class'].to_s
|
228
|
-
item['queue'] = item['queue'].to_s
|
229
|
-
item['jid'] ||= SecureRandom.hex(12)
|
230
|
-
item['created_at'] ||= Time.now.to_f
|
231
|
-
item
|
232
|
-
end
|
233
|
-
|
234
|
-
def normalized_hash(item_class)
|
235
|
-
if item_class.is_a?(Class)
|
236
|
-
raise(ArgumentError, "Message must include a Sidekiq::Worker class, not class name: #{item_class.ancestors.inspect}") if !item_class.respond_to?('get_sidekiq_options')
|
237
|
-
item_class.get_sidekiq_options
|
238
|
-
else
|
239
|
-
Sidekiq.default_worker_options
|
262
|
+
}
|
263
|
+
conn.sadd("queues", [queue])
|
264
|
+
conn.lpush("queue:#{queue}", to_push)
|
240
265
|
end
|
241
266
|
end
|
242
267
|
end
|
@@ -0,0 +1,68 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Sidekiq
|
4
|
+
##
|
5
|
+
# Sidekiq::Component assumes a config instance is available at @config
|
6
|
+
module Component # :nodoc:
|
7
|
+
attr_reader :config
|
8
|
+
|
9
|
+
def watchdog(last_words)
|
10
|
+
yield
|
11
|
+
rescue Exception => ex
|
12
|
+
handle_exception(ex, {context: last_words})
|
13
|
+
raise ex
|
14
|
+
end
|
15
|
+
|
16
|
+
def safe_thread(name, &block)
|
17
|
+
Thread.new do
|
18
|
+
Thread.current.name = "sidekiq.#{name}"
|
19
|
+
watchdog(name, &block)
|
20
|
+
end
|
21
|
+
end
|
22
|
+
|
23
|
+
def logger
|
24
|
+
config.logger
|
25
|
+
end
|
26
|
+
|
27
|
+
def redis(&block)
|
28
|
+
config.redis(&block)
|
29
|
+
end
|
30
|
+
|
31
|
+
def tid
|
32
|
+
Thread.current["sidekiq_tid"] ||= (Thread.current.object_id ^ ::Process.pid).to_s(36)
|
33
|
+
end
|
34
|
+
|
35
|
+
def hostname
|
36
|
+
ENV["DYNO"] || Socket.gethostname
|
37
|
+
end
|
38
|
+
|
39
|
+
def process_nonce
|
40
|
+
@@process_nonce ||= SecureRandom.hex(6)
|
41
|
+
end
|
42
|
+
|
43
|
+
def identity
|
44
|
+
@@identity ||= "#{hostname}:#{::Process.pid}:#{process_nonce}"
|
45
|
+
end
|
46
|
+
|
47
|
+
def handle_exception(ex, ctx = {})
|
48
|
+
config.handle_exception(ex, ctx)
|
49
|
+
end
|
50
|
+
|
51
|
+
def fire_event(event, options = {})
|
52
|
+
oneshot = options.fetch(:oneshot, true)
|
53
|
+
reverse = options[:reverse]
|
54
|
+
reraise = options[:reraise]
|
55
|
+
logger.debug("Firing #{event} event") if oneshot
|
56
|
+
|
57
|
+
arr = config[:lifecycle_events][event]
|
58
|
+
arr.reverse! if reverse
|
59
|
+
arr.each do |block|
|
60
|
+
block.call
|
61
|
+
rescue => ex
|
62
|
+
handle_exception(ex, {context: "Exception during Sidekiq lifecycle event.", event: event})
|
63
|
+
raise ex if reraise
|
64
|
+
end
|
65
|
+
arr.clear if oneshot # once we've fired an event, we never fire it again
|
66
|
+
end
|
67
|
+
end
|
68
|
+
end
|