sidekiq-unique-jobs 7.1.5 → 7.1.25
Sign up to get free protection for your applications and to get access to all the features.
Potentially problematic release.
This version of sidekiq-unique-jobs might be problematic. Click here for more details.
- checksums.yaml +4 -4
- data/CHANGELOG.md +244 -4
- data/README.md +16 -14
- data/lib/sidekiq_unique_jobs/batch_delete.rb +6 -6
- data/lib/sidekiq_unique_jobs/changelog.rb +3 -3
- data/lib/sidekiq_unique_jobs/config.rb +43 -4
- data/lib/sidekiq_unique_jobs/constants.rb +44 -44
- data/lib/sidekiq_unique_jobs/deprecation.rb +30 -0
- data/lib/sidekiq_unique_jobs/digests.rb +6 -9
- data/lib/sidekiq_unique_jobs/exceptions.rb +4 -3
- data/lib/sidekiq_unique_jobs/json.rb +7 -0
- data/lib/sidekiq_unique_jobs/lock/base_lock.rb +30 -22
- data/lib/sidekiq_unique_jobs/lock/until_and_while_executing.rb +9 -3
- data/lib/sidekiq_unique_jobs/lock/until_executed.rb +14 -4
- data/lib/sidekiq_unique_jobs/lock/until_executing.rb +14 -4
- data/lib/sidekiq_unique_jobs/lock/until_expired.rb +13 -5
- data/lib/sidekiq_unique_jobs/lock/while_executing.rb +9 -4
- data/lib/sidekiq_unique_jobs/lock.rb +10 -10
- data/lib/sidekiq_unique_jobs/lock_args.rb +19 -15
- data/lib/sidekiq_unique_jobs/lock_config.rb +6 -6
- data/lib/sidekiq_unique_jobs/lock_digest.rb +6 -6
- data/lib/sidekiq_unique_jobs/lock_info.rb +2 -2
- data/lib/sidekiq_unique_jobs/lock_timeout.rb +4 -4
- data/lib/sidekiq_unique_jobs/lock_ttl.rb +5 -5
- data/lib/sidekiq_unique_jobs/locksmith.rb +5 -4
- data/lib/sidekiq_unique_jobs/logging.rb +9 -0
- data/lib/sidekiq_unique_jobs/lua/lock.lua +3 -3
- data/lib/sidekiq_unique_jobs/lua/shared/_common.lua +1 -1
- data/lib/sidekiq_unique_jobs/lua/unlock.lua +12 -5
- data/lib/sidekiq_unique_jobs/middleware/client.rb +3 -1
- data/lib/sidekiq_unique_jobs/middleware/server.rb +2 -0
- data/lib/sidekiq_unique_jobs/middleware.rb +4 -4
- data/lib/sidekiq_unique_jobs/on_conflict/reject.rb +4 -4
- data/lib/sidekiq_unique_jobs/on_conflict/reschedule.rb +3 -3
- data/lib/sidekiq_unique_jobs/options_with_fallback.rb +5 -7
- data/lib/sidekiq_unique_jobs/orphans/manager.rb +38 -10
- data/lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb +77 -14
- data/lib/sidekiq_unique_jobs/redis/string.rb +3 -1
- data/lib/sidekiq_unique_jobs/reflectable.rb +11 -2
- data/lib/sidekiq_unique_jobs/reflections.rb +12 -1
- data/lib/sidekiq_unique_jobs/server.rb +13 -1
- data/lib/sidekiq_unique_jobs/sidekiq_unique_ext.rb +35 -13
- data/lib/sidekiq_unique_jobs/sidekiq_worker_methods.rb +40 -21
- data/lib/sidekiq_unique_jobs/testing.rb +45 -20
- data/lib/sidekiq_unique_jobs/timer_task.rb +266 -45
- data/lib/sidekiq_unique_jobs/timing.rb +1 -1
- data/lib/sidekiq_unique_jobs/upgrade_locks.rb +6 -6
- data/lib/sidekiq_unique_jobs/version.rb +1 -1
- data/lib/sidekiq_unique_jobs/web/helpers.rb +1 -1
- data/lib/tasks/changelog.rake +16 -16
- metadata +11 -15
@@ -76,6 +76,9 @@ if pttl and pttl > 0 then
|
|
76
76
|
|
77
77
|
log_debug("PEXPIRE", locked, pttl)
|
78
78
|
redis.call("PEXPIRE", locked, pttl)
|
79
|
+
|
80
|
+
log_debug("PEXPIRE", info, pttl)
|
81
|
+
redis.call("PEXPIRE", info, pttl)
|
79
82
|
end
|
80
83
|
|
81
84
|
log_debug("PEXPIRE", queued, 1000)
|
@@ -84,9 +87,6 @@ redis.call("PEXPIRE", queued, 1000)
|
|
84
87
|
log_debug("PEXPIRE", primed, 1000)
|
85
88
|
redis.call("PEXPIRE", primed, 1000)
|
86
89
|
|
87
|
-
log_debug("PEXPIRE", info, 1000)
|
88
|
-
redis.call("PEXPIRE", info, 1000)
|
89
|
-
|
90
90
|
log("Locked")
|
91
91
|
log_debug("END lock digest:", digest, "job_id:", job_id)
|
92
92
|
return job_id
|
@@ -31,7 +31,7 @@ local function log(message, prev_jid)
|
|
31
31
|
log_debug("ZADD", changelog, current_time, entry);
|
32
32
|
redis.call("ZADD", changelog, current_time, entry);
|
33
33
|
local total_entries = redis.call("ZCARD", changelog)
|
34
|
-
local removed_entries = redis.call("ZREMRANGEBYRANK", changelog,
|
34
|
+
local removed_entries = redis.call("ZREMRANGEBYRANK", changelog, 0, -1 * max_history)
|
35
35
|
if removed_entries > 0 then
|
36
36
|
log_debug("Removing", removed_entries , "entries from changelog (total entries", total_entries, "exceeds max_history:", max_history ..")");
|
37
37
|
end
|
@@ -65,11 +65,6 @@ redis.call("LREM", queued, -1, job_id)
|
|
65
65
|
log_debug("LREM", primed, -1, job_id)
|
66
66
|
redis.call("LREM", primed, -1, job_id)
|
67
67
|
|
68
|
-
if limit and limit <= 1 and locked_count and locked_count <= 1 then
|
69
|
-
log_debug("ZREM", digests, digest)
|
70
|
-
redis.call("ZREM", digests, digest)
|
71
|
-
end
|
72
|
-
|
73
68
|
local redis_version = toversion(redisversion)
|
74
69
|
local del_cmd = "DEL"
|
75
70
|
|
@@ -83,6 +78,18 @@ if lock_type ~= "until_expired" then
|
|
83
78
|
redis.call("HDEL", locked, job_id)
|
84
79
|
end
|
85
80
|
|
81
|
+
local locked_count = redis.call("HLEN", locked)
|
82
|
+
|
83
|
+
if locked_count and locked_count < 1 then
|
84
|
+
log_debug(del_cmd, locked)
|
85
|
+
redis.call(del_cmd, locked)
|
86
|
+
end
|
87
|
+
|
88
|
+
if limit and limit <= 1 and locked_count and locked_count <= 1 then
|
89
|
+
log_debug("ZREM", digests, digest)
|
90
|
+
redis.call("ZREM", digests, digest)
|
91
|
+
end
|
92
|
+
|
86
93
|
log_debug("LPUSH", queued, "1")
|
87
94
|
redis.call("LPUSH", queued, "1")
|
88
95
|
|
@@ -6,6 +6,8 @@ module SidekiqUniqueJobs
|
|
6
6
|
#
|
7
7
|
# @author Mikael Henriksson <mikael@mhenrixon.com>
|
8
8
|
class Client
|
9
|
+
include Sidekiq::ClientMiddleware if defined?(Sidekiq::ClientMiddleware)
|
10
|
+
|
9
11
|
# prepend "SidekiqUniqueJobs::Middleware"
|
10
12
|
# @!parse prepends SidekiqUniqueJobs::Middleware
|
11
13
|
prepend SidekiqUniqueJobs::Middleware
|
@@ -30,7 +32,7 @@ module SidekiqUniqueJobs
|
|
30
32
|
private
|
31
33
|
|
32
34
|
def lock
|
33
|
-
lock_instance.lock do
|
35
|
+
lock_instance.lock do
|
34
36
|
reflect(:locked, item)
|
35
37
|
return yield
|
36
38
|
end
|
@@ -6,6 +6,8 @@ module SidekiqUniqueJobs
|
|
6
6
|
#
|
7
7
|
# @author Mikael Henriksson <mikael@mhenrixon.com>
|
8
8
|
class Server
|
9
|
+
include Sidekiq::ServerMiddleware if defined?(Sidekiq::ServerMiddleware)
|
10
|
+
|
9
11
|
# prepend "SidekiqUniqueJobs::Middleware"
|
10
12
|
# @!parse prepends SidekiqUniqueJobs::Middleware
|
11
13
|
prepend SidekiqUniqueJobs::Middleware
|
@@ -29,10 +29,10 @@ module SidekiqUniqueJobs
|
|
29
29
|
# @yieldparam [<type>] if <description>
|
30
30
|
# @yieldreturn [<type>] <describe what yield should return>
|
31
31
|
def call(worker_class, item, queue, redis_pool = nil)
|
32
|
-
@
|
33
|
-
@
|
34
|
-
@
|
35
|
-
|
32
|
+
@item = item
|
33
|
+
@queue = queue
|
34
|
+
@redis_pool = redis_pool
|
35
|
+
self.job_class = item[CLASS]
|
36
36
|
return yield if unique_disabled?
|
37
37
|
|
38
38
|
SidekiqUniqueJobs::Job.prepare(item) unless item[LOCK_DIGEST]
|
@@ -96,10 +96,10 @@ module SidekiqUniqueJobs
|
|
96
96
|
#
|
97
97
|
def push_to_deadset
|
98
98
|
redis do |conn|
|
99
|
-
conn.multi do
|
100
|
-
|
101
|
-
|
102
|
-
|
99
|
+
conn.multi do |pipeline|
|
100
|
+
pipeline.zadd("dead", now_f, payload)
|
101
|
+
pipeline.zremrangebyscore("dead", "-inf", now_f - Sidekiq::DeadSet.timeout)
|
102
|
+
pipeline.zremrangebyrank("dead", 0, -Sidekiq::DeadSet.max_jobs)
|
103
103
|
end
|
104
104
|
end
|
105
105
|
end
|
@@ -14,14 +14,14 @@ module SidekiqUniqueJobs
|
|
14
14
|
# @param [Hash] item sidekiq job hash
|
15
15
|
def initialize(item, redis_pool = nil)
|
16
16
|
super(item, redis_pool)
|
17
|
-
|
17
|
+
self.job_class = item[CLASS]
|
18
18
|
end
|
19
19
|
|
20
20
|
# Create a new job from the current one.
|
21
21
|
# This will mess up sidekiq stats because a new job is created
|
22
22
|
def call
|
23
|
-
if
|
24
|
-
if
|
23
|
+
if sidekiq_job_class?
|
24
|
+
if job_class.set(queue: item["queue"].to_sym).perform_in(5, *item[ARGS])
|
25
25
|
reflect(:rescheduled, item)
|
26
26
|
else
|
27
27
|
reflect(:reschedule_failed, item)
|
@@ -6,7 +6,7 @@ module SidekiqUniqueJobs
|
|
6
6
|
# Requires the following methods to be defined in the including class
|
7
7
|
# 1. item (required)
|
8
8
|
# 2. options (can be nil)
|
9
|
-
# 3.
|
9
|
+
# 3. job_class (required, can be anything)
|
10
10
|
# @author Mikael Henriksson <mikael@mhenrixon.com>
|
11
11
|
module OptionsWithFallback
|
12
12
|
def self.included(base)
|
@@ -46,10 +46,8 @@ module SidekiqUniqueJobs
|
|
46
46
|
# @return [Class]
|
47
47
|
#
|
48
48
|
def lock_class
|
49
|
-
@lock_class ||=
|
50
|
-
|
51
|
-
raise UnknownLock, "No implementation for `lock: :#{lock_type}`"
|
52
|
-
end
|
49
|
+
@lock_class ||= locks.fetch(lock_type.to_sym) do
|
50
|
+
raise UnknownLock, "No implementation for `lock: :#{lock_type}`"
|
53
51
|
end
|
54
52
|
end
|
55
53
|
|
@@ -71,8 +69,8 @@ module SidekiqUniqueJobs
|
|
71
69
|
#
|
72
70
|
def options
|
73
71
|
@options ||= begin
|
74
|
-
opts =
|
75
|
-
opts.merge!(
|
72
|
+
opts = default_job_options.dup
|
73
|
+
opts.merge!(job_options) if sidekiq_job_class?
|
76
74
|
(opts || {}).stringify_keys
|
77
75
|
end
|
78
76
|
end
|
@@ -1,5 +1,7 @@
|
|
1
1
|
# frozen_string_literal: true
|
2
2
|
|
3
|
+
require "concurrent/version"
|
4
|
+
|
3
5
|
module SidekiqUniqueJobs
|
4
6
|
module Orphans
|
5
7
|
#
|
@@ -10,10 +12,18 @@ module SidekiqUniqueJobs
|
|
10
12
|
module Manager
|
11
13
|
module_function
|
12
14
|
|
15
|
+
#
|
16
|
+
# @return [Float] the amount to add to the reaper interval
|
13
17
|
DRIFT_FACTOR = 0.02
|
18
|
+
#
|
19
|
+
# @return [Symbol] allowed reapers (:ruby or :lua)
|
14
20
|
REAPERS = [:ruby, :lua].freeze
|
15
21
|
|
22
|
+
# includes "SidekiqUniqueJobs::Connection"
|
23
|
+
# @!parse include SidekiqUniqueJobs::Connection
|
16
24
|
include SidekiqUniqueJobs::Connection
|
25
|
+
# includes "SidekiqUniqueJobs::Logging"
|
26
|
+
# @!parse include SidekiqUniqueJobs::Logging
|
17
27
|
include SidekiqUniqueJobs::Logging
|
18
28
|
|
19
29
|
#
|
@@ -65,6 +75,12 @@ module SidekiqUniqueJobs
|
|
65
75
|
@task ||= default_task
|
66
76
|
end
|
67
77
|
|
78
|
+
#
|
79
|
+
# A properly configured timer task
|
80
|
+
#
|
81
|
+
#
|
82
|
+
# @return [SidekiqUniqueJobs::TimerTask]
|
83
|
+
#
|
68
84
|
def default_task
|
69
85
|
SidekiqUniqueJobs::TimerTask.new(timer_task_options) do
|
70
86
|
with_logging_context do
|
@@ -76,6 +92,13 @@ module SidekiqUniqueJobs
|
|
76
92
|
end
|
77
93
|
end
|
78
94
|
|
95
|
+
#
|
96
|
+
# Store a task to use for scheduled execution
|
97
|
+
#
|
98
|
+
# @param [SidekiqUniqueJobs::TimerTask] task the task to use
|
99
|
+
#
|
100
|
+
# @return [void]
|
101
|
+
#
|
79
102
|
def task=(task)
|
80
103
|
@task = task
|
81
104
|
end
|
@@ -87,9 +110,7 @@ module SidekiqUniqueJobs
|
|
87
110
|
# @return [Hash]
|
88
111
|
#
|
89
112
|
def timer_task_options
|
90
|
-
{ run_now: true,
|
91
|
-
execution_interval: reaper_interval,
|
92
|
-
timeout_interval: reaper_timeout }
|
113
|
+
{ run_now: true, execution_interval: reaper_interval }
|
93
114
|
end
|
94
115
|
|
95
116
|
#
|
@@ -106,13 +127,6 @@ module SidekiqUniqueJobs
|
|
106
127
|
SidekiqUniqueJobs.config.reaper_interval
|
107
128
|
end
|
108
129
|
|
109
|
-
#
|
110
|
-
# @see SidekiqUniqueJobs::Config#reaper_timeout
|
111
|
-
#
|
112
|
-
def reaper_timeout
|
113
|
-
SidekiqUniqueJobs.config.reaper_timeout
|
114
|
-
end
|
115
|
-
|
116
130
|
#
|
117
131
|
# A context to use for all log entries
|
118
132
|
#
|
@@ -201,10 +215,24 @@ module SidekiqUniqueJobs
|
|
201
215
|
redis { |conn| conn.del(UNIQUE_REAPER) }
|
202
216
|
end
|
203
217
|
|
218
|
+
#
|
219
|
+
# Reaper interval with a little drift
|
220
|
+
# Redis isn't exact enough so to give a little bufffer,
|
221
|
+
# we add a tiny value to the reaper interval.
|
222
|
+
#
|
223
|
+
#
|
224
|
+
# @return [Integer] <description>
|
225
|
+
#
|
204
226
|
def drift_reaper_interval
|
205
227
|
reaper_interval + (reaper_interval * DRIFT_FACTOR).to_i
|
206
228
|
end
|
207
229
|
|
230
|
+
#
|
231
|
+
# Current time (as integer value)
|
232
|
+
#
|
233
|
+
#
|
234
|
+
# @return [Integer]
|
235
|
+
#
|
208
236
|
def current_timestamp
|
209
237
|
Time.now.to_i
|
210
238
|
end
|
@@ -9,9 +9,17 @@ module SidekiqUniqueJobs
|
|
9
9
|
#
|
10
10
|
# @author Mikael Henriksson <mikael@mhenrixon.com>
|
11
11
|
#
|
12
|
+
# rubocop:disable Metrics/ClassLength
|
12
13
|
class RubyReaper < Reaper
|
14
|
+
include SidekiqUniqueJobs::Timing
|
15
|
+
|
16
|
+
#
|
17
|
+
# @return [String] the suffix for :RUN locks
|
13
18
|
RUN_SUFFIX = ":RUN"
|
14
19
|
#
|
20
|
+
# @return [Integer] the maximum combined length of sidekiq queues for running the reaper
|
21
|
+
MAX_QUEUE_LENGTH = 1000
|
22
|
+
#
|
15
23
|
# @!attribute [r] digests
|
16
24
|
# @return [SidekiqUniqueJobs::Digests] digest collection
|
17
25
|
attr_reader :digests
|
@@ -24,6 +32,16 @@ module SidekiqUniqueJobs
|
|
24
32
|
# @return [Redis::SortedSet] the Sidekiq RetrySet
|
25
33
|
attr_reader :retried
|
26
34
|
|
35
|
+
#
|
36
|
+
# @!attribute [r] start_time
|
37
|
+
# @return [Integer] The timestamp this execution started represented as integer
|
38
|
+
attr_reader :start_time
|
39
|
+
|
40
|
+
#
|
41
|
+
# @!attribute [r] timeout_ms
|
42
|
+
# @return [Integer] The allowed ms before timeout
|
43
|
+
attr_reader :timeout_ms
|
44
|
+
|
27
45
|
#
|
28
46
|
# Initialize a new instance of DeleteOrphans
|
29
47
|
#
|
@@ -31,9 +49,11 @@ module SidekiqUniqueJobs
|
|
31
49
|
#
|
32
50
|
def initialize(conn)
|
33
51
|
super(conn)
|
34
|
-
@digests
|
35
|
-
@scheduled
|
36
|
-
@retried
|
52
|
+
@digests = SidekiqUniqueJobs::Digests.new
|
53
|
+
@scheduled = Redis::SortedSet.new(SCHEDULE)
|
54
|
+
@retried = Redis::SortedSet.new(RETRY)
|
55
|
+
@start_time = time_source.call
|
56
|
+
@timeout_ms = SidekiqUniqueJobs.config.reaper_timeout * 1000
|
37
57
|
end
|
38
58
|
|
39
59
|
#
|
@@ -43,6 +63,8 @@ module SidekiqUniqueJobs
|
|
43
63
|
# @return [Integer] the number of reaped locks
|
44
64
|
#
|
45
65
|
def call
|
66
|
+
return if queues_very_full?
|
67
|
+
|
46
68
|
BatchDelete.call(orphans, conn)
|
47
69
|
end
|
48
70
|
|
@@ -52,13 +74,37 @@ module SidekiqUniqueJobs
|
|
52
74
|
#
|
53
75
|
# @return [Array<String>] an array of orphaned digests
|
54
76
|
#
|
55
|
-
def orphans
|
56
|
-
|
57
|
-
|
77
|
+
def orphans # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity
|
78
|
+
page = 0
|
79
|
+
per = reaper_count * 2
|
80
|
+
orphans = []
|
81
|
+
results = conn.zrange(digests.key, page * per, (page + 1) * per)
|
82
|
+
|
83
|
+
while results.size.positive?
|
84
|
+
results.each do |digest|
|
85
|
+
break if timeout?
|
86
|
+
next if belongs_to_job?(digest)
|
87
|
+
|
88
|
+
orphans << digest
|
89
|
+
break if orphans.size >= reaper_count
|
90
|
+
end
|
91
|
+
|
92
|
+
break if timeout?
|
93
|
+
break if orphans.size >= reaper_count
|
58
94
|
|
59
|
-
|
60
|
-
|
95
|
+
page += 1
|
96
|
+
results = conn.zrange(digests.key, page * per, (page + 1) * per)
|
61
97
|
end
|
98
|
+
|
99
|
+
orphans
|
100
|
+
end
|
101
|
+
|
102
|
+
def timeout?
|
103
|
+
elapsed_ms >= timeout_ms
|
104
|
+
end
|
105
|
+
|
106
|
+
def elapsed_ms
|
107
|
+
time_source.call - start_time
|
62
108
|
end
|
63
109
|
|
64
110
|
#
|
@@ -124,14 +170,14 @@ module SidekiqUniqueJobs
|
|
124
170
|
return false if procs.empty?
|
125
171
|
|
126
172
|
procs.sort.each do |key|
|
127
|
-
valid, workers = conn.pipelined do
|
173
|
+
valid, workers = conn.pipelined do |pipeline|
|
128
174
|
# TODO: Remove the if statement in the future
|
129
|
-
if
|
130
|
-
|
175
|
+
if pipeline.respond_to?(:exists?)
|
176
|
+
pipeline.exists?(key)
|
131
177
|
else
|
132
|
-
|
178
|
+
pipeline.exists(key)
|
133
179
|
end
|
134
|
-
|
180
|
+
pipeline.hgetall("#{key}:workers")
|
135
181
|
end
|
136
182
|
|
137
183
|
next unless valid
|
@@ -182,7 +228,7 @@ module SidekiqUniqueJobs
|
|
182
228
|
page_size = 50
|
183
229
|
|
184
230
|
loop do
|
185
|
-
range_start = page * page_size - deleted_size
|
231
|
+
range_start = (page * page_size) - deleted_size
|
186
232
|
range_end = range_start + page_size - 1
|
187
233
|
entries = conn.lrange(queue_key, range_start, range_end)
|
188
234
|
page += 1
|
@@ -195,6 +241,22 @@ module SidekiqUniqueJobs
|
|
195
241
|
end
|
196
242
|
end
|
197
243
|
|
244
|
+
# If sidekiq queues are very full, it becomes highly inefficient for the reaper
|
245
|
+
# because it must check every queued job to verify a digest is safe to delete
|
246
|
+
# The reaper checks queued jobs in batches of 50, adding 2 reads per digest
|
247
|
+
# With a queue length of 1,000 jobs, that's over 20 extra reads per digest.
|
248
|
+
def queues_very_full?
|
249
|
+
total_queue_size = 0
|
250
|
+
Sidekiq.redis do |conn|
|
251
|
+
queues(conn) do |queue|
|
252
|
+
total_queue_size += conn.llen("queue:#{queue}")
|
253
|
+
|
254
|
+
return true if total_queue_size > MAX_QUEUE_LENGTH
|
255
|
+
end
|
256
|
+
end
|
257
|
+
false
|
258
|
+
end
|
259
|
+
|
198
260
|
#
|
199
261
|
# Checks a sorted set for the existance of this digest
|
200
262
|
#
|
@@ -209,5 +271,6 @@ module SidekiqUniqueJobs
|
|
209
271
|
conn.zscan_each(key, match: "*#{digest}*", count: 1).to_a.any?
|
210
272
|
end
|
211
273
|
end
|
274
|
+
# rubocop:enable Metrics/ClassLength
|
212
275
|
end
|
213
276
|
end
|
@@ -7,11 +7,20 @@ module SidekiqUniqueJobs
|
|
7
7
|
# @author Mikael Henriksson <mikael@mhenrixon.com>
|
8
8
|
#
|
9
9
|
module Reflectable
|
10
|
-
|
11
|
-
|
10
|
+
#
|
11
|
+
# Reflects on specific event
|
12
|
+
#
|
13
|
+
# @param [Symbol] reflection the reflected event
|
14
|
+
# @param [Array] args arguments to provide to reflector
|
15
|
+
#
|
16
|
+
# @return [void]
|
17
|
+
#
|
18
|
+
def reflect(reflection, *args)
|
19
|
+
SidekiqUniqueJobs.reflections.dispatch(reflection, *args)
|
12
20
|
nil
|
13
21
|
rescue UniqueJobsError => ex
|
14
22
|
SidekiqUniqueJobs.logger.error(ex)
|
23
|
+
nil
|
15
24
|
end
|
16
25
|
end
|
17
26
|
end
|
@@ -42,6 +42,14 @@ module SidekiqUniqueJobs
|
|
42
42
|
@reflections = {}
|
43
43
|
end
|
44
44
|
|
45
|
+
#
|
46
|
+
# Dispatch a reflected event
|
47
|
+
#
|
48
|
+
# @param [reflection] reflection the reflected event
|
49
|
+
# @param [Array] args the arguments to provide to the block
|
50
|
+
#
|
51
|
+
# @return [void] <description>
|
52
|
+
#
|
45
53
|
def dispatch(reflection, *args)
|
46
54
|
if (block = @reflections[reflection])
|
47
55
|
block.call(*args)
|
@@ -49,12 +57,15 @@ module SidekiqUniqueJobs
|
|
49
57
|
if DEPRECATIONS.key?(reflection)
|
50
58
|
replacement, removal_version = DEPRECATIONS[reflection]
|
51
59
|
SidekiqUniqueJobs::Deprecation.warn(
|
52
|
-
"#{reflection} is deprecated and will be removed in version #{removal_version}.
|
60
|
+
"#{reflection} is deprecated and will be removed in version #{removal_version}." \
|
61
|
+
" Use #{replacement} instead.",
|
53
62
|
)
|
54
63
|
end
|
55
64
|
elsif misconfigured?(reflection)
|
56
65
|
raise NoSuchNotificationError, reflection
|
57
66
|
end
|
67
|
+
|
68
|
+
nil
|
58
69
|
end
|
59
70
|
|
60
71
|
def configured?(reflection)
|
@@ -5,7 +5,7 @@ module SidekiqUniqueJobs
|
|
5
5
|
#
|
6
6
|
# @author Mikael Henriksson <mikael@mhenrixon.com>
|
7
7
|
class Server
|
8
|
-
DEATH_HANDLER
|
8
|
+
DEATH_HANDLER = (lambda do |job, _ex|
|
9
9
|
return unless (digest = job["lock_digest"])
|
10
10
|
|
11
11
|
SidekiqUniqueJobs::Digests.new.delete_by_digest(digest)
|
@@ -25,6 +25,12 @@ module SidekiqUniqueJobs
|
|
25
25
|
config.death_handlers << death_handler
|
26
26
|
end
|
27
27
|
|
28
|
+
#
|
29
|
+
# Start the sidekiq unique jobs server process
|
30
|
+
#
|
31
|
+
#
|
32
|
+
# @return [void]
|
33
|
+
#
|
28
34
|
def self.start
|
29
35
|
SidekiqUniqueJobs::UpdateVersion.call
|
30
36
|
SidekiqUniqueJobs::UpgradeLocks.call
|
@@ -32,6 +38,12 @@ module SidekiqUniqueJobs
|
|
32
38
|
SidekiqUniqueJobs::Orphans::ReaperResurrector.start
|
33
39
|
end
|
34
40
|
|
41
|
+
#
|
42
|
+
# Stop the sidekiq unique jobs server process
|
43
|
+
#
|
44
|
+
#
|
45
|
+
# @return [void]
|
46
|
+
#
|
35
47
|
def self.stop
|
36
48
|
SidekiqUniqueJobs::Orphans::Manager.stop
|
37
49
|
end
|
@@ -68,24 +68,46 @@ module Sidekiq
|
|
68
68
|
prepend UniqueExtension
|
69
69
|
end
|
70
70
|
|
71
|
-
|
72
|
-
|
73
|
-
|
74
|
-
# Provides extensions for unlocking jobs that are removed and deleted
|
75
|
-
#
|
76
|
-
# @author Mikael Henriksson <mikael@mhenrixon.com>
|
77
|
-
#
|
78
|
-
module UniqueExtension
|
71
|
+
if Sidekiq.const_defined?(:JobRecord)
|
72
|
+
# See Sidekiq::Api
|
73
|
+
class JobRecord
|
79
74
|
#
|
80
|
-
#
|
75
|
+
# Provides extensions for unlocking jobs that are removed and deleted
|
81
76
|
#
|
82
|
-
|
83
|
-
|
84
|
-
|
77
|
+
# @author Mikael Henriksson <mikael@mhenrixon.com>
|
78
|
+
#
|
79
|
+
module UniqueExtension
|
80
|
+
#
|
81
|
+
# Wraps the original method to ensure locks for the job are deleted
|
82
|
+
#
|
83
|
+
def delete
|
84
|
+
SidekiqUniqueJobs::Unlockable.delete!(item)
|
85
|
+
super
|
86
|
+
end
|
85
87
|
end
|
88
|
+
|
89
|
+
prepend UniqueExtension
|
86
90
|
end
|
91
|
+
else
|
92
|
+
# See Sidekiq::Api
|
93
|
+
class Job
|
94
|
+
#
|
95
|
+
# Provides extensions for unlocking jobs that are removed and deleted
|
96
|
+
#
|
97
|
+
# @author Mikael Henriksson <mikael@mhenrixon.com>
|
98
|
+
#
|
99
|
+
module UniqueExtension
|
100
|
+
#
|
101
|
+
# Wraps the original method to ensure locks for the job are deleted
|
102
|
+
#
|
103
|
+
def delete
|
104
|
+
SidekiqUniqueJobs::Unlockable.delete!(item)
|
105
|
+
super
|
106
|
+
end
|
107
|
+
end
|
87
108
|
|
88
|
-
|
109
|
+
prepend UniqueExtension
|
110
|
+
end
|
89
111
|
end
|
90
112
|
|
91
113
|
# See Sidekiq::Api
|