sidekiq-unique-jobs 7.0.0.beta29 → 7.0.4
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 +138 -36
- data/README.md +169 -37
- data/lib/sidekiq-unique-jobs.rb +0 -2
- data/lib/sidekiq_unique_jobs.rb +4 -1
- data/lib/sidekiq_unique_jobs/batch_delete.rb +1 -1
- data/lib/sidekiq_unique_jobs/changelog.rb +11 -4
- data/lib/sidekiq_unique_jobs/constants.rb +1 -0
- data/lib/sidekiq_unique_jobs/digests.rb +1 -1
- data/lib/sidekiq_unique_jobs/json.rb +7 -1
- data/lib/sidekiq_unique_jobs/lock.rb +31 -1
- data/lib/sidekiq_unique_jobs/lock_config.rb +2 -0
- data/lib/sidekiq_unique_jobs/lua/lock.lua +10 -11
- data/lib/sidekiq_unique_jobs/lua/reap_orphans.lua +8 -7
- data/lib/sidekiq_unique_jobs/lua/shared/_find_digest_in_process_set.lua +9 -2
- data/lib/sidekiq_unique_jobs/middleware.rb +0 -57
- data/lib/sidekiq_unique_jobs/on_conflict/replace.rb +9 -8
- data/lib/sidekiq_unique_jobs/on_conflict/reschedule.rb +1 -1
- data/lib/sidekiq_unique_jobs/orphans/lua_reaper.rb +1 -1
- data/lib/sidekiq_unique_jobs/orphans/manager.rb +13 -3
- data/lib/sidekiq_unique_jobs/orphans/reaper.rb +10 -0
- data/lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb +14 -5
- data/lib/sidekiq_unique_jobs/redis/entity.rb +9 -3
- data/lib/sidekiq_unique_jobs/redis/sorted_set.rb +27 -0
- data/lib/sidekiq_unique_jobs/server.rb +48 -0
- data/lib/sidekiq_unique_jobs/timer_task.rb +78 -0
- data/lib/sidekiq_unique_jobs/version.rb +1 -1
- data/lib/sidekiq_unique_jobs/web.rb +28 -4
- data/lib/sidekiq_unique_jobs/web/helpers.rb +24 -3
- data/lib/sidekiq_unique_jobs/web/views/changelogs.erb +54 -0
- data/lib/sidekiq_unique_jobs/web/views/locks.erb +1 -1
- metadata +13 -8
- data/lib/sidekiq_unique_jobs/profiler.rb +0 -55
@@ -69,25 +69,24 @@ redis.call("LREM", queued, -1, job_id)
|
|
69
69
|
log_debug("LREM", primed, 1, job_id)
|
70
70
|
redis.call("LREM", primed, 1, job_id)
|
71
71
|
|
72
|
-
-- The Sidekiq client
|
73
|
-
-- The Sidekiq server should set pttl for all other jobs
|
72
|
+
-- The Sidekiq client sets pttl
|
74
73
|
if pttl and pttl > 0 then
|
75
74
|
log_debug("PEXPIRE", digest, pttl)
|
76
75
|
redis.call("PEXPIRE", digest, pttl)
|
77
76
|
|
78
|
-
log_debug("PEXPIRE", queued, pttl)
|
79
|
-
redis.call("PEXPIRE", queued, pttl)
|
80
|
-
|
81
|
-
log_debug("PEXPIRE", primed, pttl)
|
82
|
-
redis.call("PEXPIRE", primed, pttl)
|
83
|
-
|
84
77
|
log_debug("PEXPIRE", locked, pttl)
|
85
78
|
redis.call("PEXPIRE", locked, pttl)
|
86
|
-
|
87
|
-
log_debug("PEXPIRE", info, pttl)
|
88
|
-
redis.call("PEXPIRE", info, pttl)
|
89
79
|
end
|
90
80
|
|
81
|
+
log_debug("PEXPIRE", queued, 1000)
|
82
|
+
redis.call("PEXPIRE", queued, 1000)
|
83
|
+
|
84
|
+
log_debug("PEXPIRE", primed, 1000)
|
85
|
+
redis.call("PEXPIRE", primed, 1000)
|
86
|
+
|
87
|
+
log_debug("PEXPIRE", info, 1000)
|
88
|
+
redis.call("PEXPIRE", info, 1000)
|
89
|
+
|
91
90
|
log("Locked")
|
92
91
|
log_debug("END lock digest:", digest, "job_id:", job_id)
|
93
92
|
return job_id
|
@@ -7,15 +7,16 @@ local retry_set = KEYS[3]
|
|
7
7
|
-------- END keys ---------
|
8
8
|
|
9
9
|
-------- BEGIN argv ---------
|
10
|
-
local reaper_count
|
10
|
+
local reaper_count = tonumber(ARGV[1])
|
11
|
+
local threshold = tonumber(ARGV[2])
|
11
12
|
-------- END argv ---------
|
12
13
|
|
13
14
|
-------- BEGIN injected arguments --------
|
14
|
-
local current_time = tonumber(ARGV[
|
15
|
-
local debug_lua = ARGV[
|
16
|
-
local max_history = tonumber(ARGV[
|
17
|
-
local script_name = ARGV[
|
18
|
-
local redisversion = ARGV[
|
15
|
+
local current_time = tonumber(ARGV[3])
|
16
|
+
local debug_lua = ARGV[4] == "true"
|
17
|
+
local max_history = tonumber(ARGV[5])
|
18
|
+
local script_name = ARGV[6] .. ".lua"
|
19
|
+
local redisversion = ARGV[7]
|
19
20
|
--------- END injected arguments ---------
|
20
21
|
|
21
22
|
|
@@ -65,7 +66,7 @@ repeat
|
|
65
66
|
-- TODO: Add check for jobs checked out by process
|
66
67
|
if found ~= true then
|
67
68
|
log_debug("Searching for digest:", digest, "in process sets")
|
68
|
-
found = find_digest_in_process_set(digest)
|
69
|
+
found = find_digest_in_process_set(digest, threshold)
|
69
70
|
end
|
70
71
|
|
71
72
|
if found ~= true then
|
@@ -1,4 +1,4 @@
|
|
1
|
-
local function find_digest_in_process_set(digest)
|
1
|
+
local function find_digest_in_process_set(digest, threshold)
|
2
2
|
local process_cursor = 0
|
3
3
|
local job_cursor = 0
|
4
4
|
local pattern = "*" .. digest .. "*"
|
@@ -26,11 +26,18 @@ local function find_digest_in_process_set(digest)
|
|
26
26
|
log_debug("No entries in:", workers_key)
|
27
27
|
else
|
28
28
|
for i = 1, #jobs, 2 do
|
29
|
-
|
29
|
+
local jobstr = jobs[i +1]
|
30
|
+
if string.find(jobstr, digest) then
|
30
31
|
log_debug("Found digest", digest, "in:", workers_key)
|
31
32
|
found = true
|
32
33
|
break
|
33
34
|
end
|
35
|
+
|
36
|
+
local job = cjson.decode(jobstr)
|
37
|
+
if job.payload.created_at > threshold then
|
38
|
+
found = true
|
39
|
+
break
|
40
|
+
end
|
34
41
|
end
|
35
42
|
end
|
36
43
|
|
@@ -11,63 +11,6 @@ module SidekiqUniqueJobs
|
|
11
11
|
include SidekiqUniqueJobs::OptionsWithFallback
|
12
12
|
include SidekiqUniqueJobs::JSON
|
13
13
|
|
14
|
-
#
|
15
|
-
# Configure both server and client
|
16
|
-
#
|
17
|
-
def self.configure
|
18
|
-
configure_server
|
19
|
-
configure_client
|
20
|
-
end
|
21
|
-
|
22
|
-
#
|
23
|
-
# Configures the Sidekiq server
|
24
|
-
#
|
25
|
-
def self.configure_server # rubocop:disable Metrics/MethodLength
|
26
|
-
Sidekiq.configure_server do |config|
|
27
|
-
config.client_middleware do |chain|
|
28
|
-
if defined?(Apartment::Sidekiq::Middleware::Client)
|
29
|
-
chain.insert_after Apartment::Sidekiq::Middleware::Client, SidekiqUniqueJobs::Middleware::Client
|
30
|
-
else
|
31
|
-
chain.add SidekiqUniqueJobs::Middleware::Client
|
32
|
-
end
|
33
|
-
end
|
34
|
-
|
35
|
-
config.server_middleware do |chain|
|
36
|
-
if defined?(Apartment::Sidekiq::Middleware::Server)
|
37
|
-
chain.insert_after Apartment::Sidekiq::Middleware::Server, SidekiqUniqueJobs::Middleware::Server
|
38
|
-
else
|
39
|
-
chain.add SidekiqUniqueJobs::Middleware::Server
|
40
|
-
end
|
41
|
-
end
|
42
|
-
|
43
|
-
config.on(:startup) do
|
44
|
-
SidekiqUniqueJobs::UpdateVersion.call
|
45
|
-
SidekiqUniqueJobs::UpgradeLocks.call
|
46
|
-
|
47
|
-
SidekiqUniqueJobs::Orphans::Manager.start
|
48
|
-
end
|
49
|
-
|
50
|
-
config.on(:shutdown) do
|
51
|
-
SidekiqUniqueJobs::Orphans::Manager.stop
|
52
|
-
end
|
53
|
-
end
|
54
|
-
end
|
55
|
-
|
56
|
-
#
|
57
|
-
# Configures the Sidekiq client
|
58
|
-
#
|
59
|
-
def self.configure_client
|
60
|
-
Sidekiq.configure_client do |config|
|
61
|
-
config.client_middleware do |chain|
|
62
|
-
if defined?(Apartment::Sidekiq::Middleware::Client)
|
63
|
-
chain.insert_after Apartment::Sidekiq::Middleware::Client, SidekiqUniqueJobs::Middleware::Client
|
64
|
-
else
|
65
|
-
chain.add SidekiqUniqueJobs::Middleware::Client
|
66
|
-
end
|
67
|
-
end
|
68
|
-
end
|
69
|
-
end
|
70
|
-
|
71
14
|
# The sidekiq job hash
|
72
15
|
# @return [Hash] the Sidekiq job hash
|
73
16
|
attr_reader :item
|
@@ -11,9 +11,9 @@ module SidekiqUniqueJobs
|
|
11
11
|
# @return [String] rthe sidekiq queue this job belongs to
|
12
12
|
attr_reader :queue
|
13
13
|
#
|
14
|
-
# @!attribute [r]
|
14
|
+
# @!attribute [r] lock_digest
|
15
15
|
# @return [String] the unique digest to use for locking
|
16
|
-
attr_reader :
|
16
|
+
attr_reader :lock_digest
|
17
17
|
|
18
18
|
#
|
19
19
|
# Initialize a new Replace strategy
|
@@ -22,8 +22,8 @@ module SidekiqUniqueJobs
|
|
22
22
|
#
|
23
23
|
def initialize(item, redis_pool = nil)
|
24
24
|
super(item, redis_pool)
|
25
|
-
@queue
|
26
|
-
@
|
25
|
+
@queue = item[QUEUE]
|
26
|
+
@lock_digest = item[LOCK_DIGEST]
|
27
27
|
end
|
28
28
|
|
29
29
|
#
|
@@ -37,10 +37,11 @@ module SidekiqUniqueJobs
|
|
37
37
|
def call(&block)
|
38
38
|
return unless (deleted_job = delete_job_by_digest)
|
39
39
|
|
40
|
-
log_info("
|
40
|
+
log_info("Deleted job: #{deleted_job}")
|
41
41
|
if (del_count = delete_lock)
|
42
|
-
log_info("Deleted `#{del_count}` keys for #{
|
42
|
+
log_info("Deleted `#{del_count}` keys for #{lock_digest}")
|
43
43
|
end
|
44
|
+
|
44
45
|
block&.call
|
45
46
|
end
|
46
47
|
|
@@ -54,7 +55,7 @@ module SidekiqUniqueJobs
|
|
54
55
|
def delete_job_by_digest
|
55
56
|
call_script(:delete_job_by_digest,
|
56
57
|
keys: ["#{QUEUE}:#{queue}", SCHEDULE, RETRY],
|
57
|
-
argv: [
|
58
|
+
argv: [lock_digest])
|
58
59
|
end
|
59
60
|
|
60
61
|
#
|
@@ -64,7 +65,7 @@ module SidekiqUniqueJobs
|
|
64
65
|
# @return [Integer] the number of keys deleted
|
65
66
|
#
|
66
67
|
def delete_lock
|
67
|
-
digests.delete_by_digest(
|
68
|
+
digests.delete_by_digest(lock_digest)
|
68
69
|
end
|
69
70
|
|
70
71
|
#
|
@@ -21,7 +21,7 @@ module SidekiqUniqueJobs
|
|
21
21
|
def call
|
22
22
|
if sidekiq_worker_class?
|
23
23
|
log_info("Rescheduling #{item[LOCK_DIGEST]}")
|
24
|
-
worker_class
|
24
|
+
worker_class.perform_in(5, *item[ARGS])
|
25
25
|
else
|
26
26
|
log_warn("Skip rescheduling of #{item[LOCK_DIGEST]} because #{worker_class} is not a Sidekiq::Worker")
|
27
27
|
end
|
@@ -20,12 +20,14 @@ module SidekiqUniqueJobs
|
|
20
20
|
# Starts a separate thread that periodically reaps orphans
|
21
21
|
#
|
22
22
|
#
|
23
|
-
# @return [
|
23
|
+
# @return [SidekiqUniqueJobs::TimerTask] the task that was started
|
24
24
|
#
|
25
|
-
def start # rubocop:disable
|
25
|
+
def start(test_task = nil) # rubocop:disable
|
26
26
|
return if disabled?
|
27
27
|
return if registered?
|
28
28
|
|
29
|
+
self.task = test_task || default_task
|
30
|
+
|
29
31
|
with_logging_context do
|
30
32
|
register_reaper_process
|
31
33
|
log_info("Starting Reaper")
|
@@ -59,7 +61,11 @@ module SidekiqUniqueJobs
|
|
59
61
|
# @return [<type>] <description>
|
60
62
|
#
|
61
63
|
def task
|
62
|
-
@task ||=
|
64
|
+
@task ||= default_task
|
65
|
+
end
|
66
|
+
|
67
|
+
def default_task
|
68
|
+
SidekiqUniqueJobs::TimerTask.new(timer_task_options) do
|
63
69
|
with_logging_context do
|
64
70
|
redis do |conn|
|
65
71
|
refresh_reaper_mutex
|
@@ -69,6 +75,10 @@ module SidekiqUniqueJobs
|
|
69
75
|
end
|
70
76
|
end
|
71
77
|
|
78
|
+
def task=(task)
|
79
|
+
@task = task
|
80
|
+
end
|
81
|
+
|
72
82
|
#
|
73
83
|
# Arguments passed on to the timer task
|
74
84
|
#
|
@@ -76,6 +76,16 @@ module SidekiqUniqueJobs
|
|
76
76
|
config.reaper
|
77
77
|
end
|
78
78
|
|
79
|
+
#
|
80
|
+
# The configured timeout for the reaper
|
81
|
+
#
|
82
|
+
#
|
83
|
+
# @return [Integer] timeout in seconds
|
84
|
+
#
|
85
|
+
def reaper_timeout
|
86
|
+
config.reaper_timeout
|
87
|
+
end
|
88
|
+
|
79
89
|
#
|
80
90
|
# The number of locks to reap at a time
|
81
91
|
#
|
@@ -52,11 +52,11 @@ module SidekiqUniqueJobs
|
|
52
52
|
# @return [Array<String>] an array of orphaned digests
|
53
53
|
#
|
54
54
|
def orphans
|
55
|
-
conn.zrevrange(digests.key, 0, -1).each_with_object([]) do |digest,
|
55
|
+
conn.zrevrange(digests.key, 0, -1).each_with_object([]) do |digest, memo|
|
56
56
|
next if belongs_to_job?(digest)
|
57
57
|
|
58
|
-
|
59
|
-
break if
|
58
|
+
memo << digest
|
59
|
+
break if memo.size >= reaper_count
|
60
60
|
end
|
61
61
|
end
|
62
62
|
|
@@ -117,7 +117,7 @@ module SidekiqUniqueJobs
|
|
117
117
|
end
|
118
118
|
end
|
119
119
|
|
120
|
-
def active?(digest) # rubocop:disable Metrics/MethodLength
|
120
|
+
def active?(digest) # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
|
121
121
|
Sidekiq.redis do |conn|
|
122
122
|
procs = conn.sscan_each("processes").to_a
|
123
123
|
return false if procs.empty?
|
@@ -132,7 +132,12 @@ module SidekiqUniqueJobs
|
|
132
132
|
next unless workers.any?
|
133
133
|
|
134
134
|
workers.each_pair do |_tid, job|
|
135
|
-
|
135
|
+
next unless (item = safe_load_json(job))
|
136
|
+
|
137
|
+
payload = safe_load_json(item[PAYLOAD])
|
138
|
+
|
139
|
+
return true if payload[LOCK_DIGEST] == digest
|
140
|
+
return true if considered_active?(payload[CREATED_AT])
|
136
141
|
end
|
137
142
|
end
|
138
143
|
|
@@ -140,6 +145,10 @@ module SidekiqUniqueJobs
|
|
140
145
|
end
|
141
146
|
end
|
142
147
|
|
148
|
+
def considered_active?(time_f)
|
149
|
+
(Time.now - reaper_timeout).to_f < time_f
|
150
|
+
end
|
151
|
+
|
143
152
|
#
|
144
153
|
# Loops through all the redis queues and yields them one by one
|
145
154
|
#
|
@@ -48,10 +48,10 @@ module SidekiqUniqueJobs
|
|
48
48
|
def exist?
|
49
49
|
redis do |conn|
|
50
50
|
value = conn.exists(key)
|
51
|
-
return true if value.is_a?(TrueClass)
|
52
|
-
return false if value.is_a?(FalseClass)
|
53
51
|
|
54
|
-
value
|
52
|
+
return value if boolean?(value)
|
53
|
+
|
54
|
+
value.to_i.positive?
|
55
55
|
end
|
56
56
|
end
|
57
57
|
|
@@ -95,6 +95,12 @@ module SidekiqUniqueJobs
|
|
95
95
|
def count
|
96
96
|
0
|
97
97
|
end
|
98
|
+
|
99
|
+
private
|
100
|
+
|
101
|
+
def boolean?(value)
|
102
|
+
[TrueClass, FalseClass].any? { |klazz| value.is_a?(klazz) }
|
103
|
+
end
|
98
104
|
end
|
99
105
|
end
|
100
106
|
end
|
@@ -23,6 +23,23 @@ module SidekiqUniqueJobs
|
|
23
23
|
entrys.each_with_object({}) { |pair, hash| hash[pair[0]] = pair[1] }
|
24
24
|
end
|
25
25
|
|
26
|
+
#
|
27
|
+
# Adds a value to the sorted set
|
28
|
+
#
|
29
|
+
# @param [Array<Float, String>, String] the values to add
|
30
|
+
#
|
31
|
+
# @return [Boolean, Integer] <description>
|
32
|
+
#
|
33
|
+
def add(values)
|
34
|
+
redis do |conn|
|
35
|
+
if values.is_a?(Array)
|
36
|
+
conn.zadd(key, values)
|
37
|
+
else
|
38
|
+
conn.zadd(key, now_f, values)
|
39
|
+
end
|
40
|
+
end
|
41
|
+
end
|
42
|
+
|
26
43
|
#
|
27
44
|
# Return the zrak of the member
|
28
45
|
#
|
@@ -45,6 +62,16 @@ module SidekiqUniqueJobs
|
|
45
62
|
redis { |conn| conn.zscore(key, member) }
|
46
63
|
end
|
47
64
|
|
65
|
+
#
|
66
|
+
# Clears the sorted set from all entries
|
67
|
+
#
|
68
|
+
#
|
69
|
+
# @return [Integer] number of entries removed
|
70
|
+
#
|
71
|
+
def clear
|
72
|
+
redis { |conn| conn.zremrangebyrank(key, 0, count) }
|
73
|
+
end
|
74
|
+
|
48
75
|
#
|
49
76
|
# Returns the count for this sorted set
|
50
77
|
#
|
@@ -0,0 +1,48 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module SidekiqUniqueJobs
|
4
|
+
# The unique sidekiq middleware for the server processor
|
5
|
+
#
|
6
|
+
# @author Mikael Henriksson <mikael@mhenrixon.com>
|
7
|
+
class Server
|
8
|
+
DEATH_HANDLER ||= (lambda do |job, _ex|
|
9
|
+
return unless (digest = job["lock_digest"])
|
10
|
+
|
11
|
+
SidekiqUniqueJobs::Digests.new.delete_by_digest(digest)
|
12
|
+
end).freeze
|
13
|
+
#
|
14
|
+
# Configure the server middleware
|
15
|
+
#
|
16
|
+
#
|
17
|
+
# @return [Sidekiq] the sidekiq configuration
|
18
|
+
#
|
19
|
+
def self.configure(config)
|
20
|
+
config.on(:startup) { start }
|
21
|
+
config.on(:shutdown) { stop }
|
22
|
+
|
23
|
+
return unless config.respond_to?(:death_handlers)
|
24
|
+
|
25
|
+
config.death_handlers << death_handler
|
26
|
+
end
|
27
|
+
|
28
|
+
def self.start
|
29
|
+
SidekiqUniqueJobs::UpdateVersion.call
|
30
|
+
SidekiqUniqueJobs::UpgradeLocks.call
|
31
|
+
SidekiqUniqueJobs::Orphans::Manager.start
|
32
|
+
end
|
33
|
+
|
34
|
+
def self.stop
|
35
|
+
SidekiqUniqueJobs::Orphans::Manager.stop
|
36
|
+
end
|
37
|
+
|
38
|
+
#
|
39
|
+
# A death handler for dead jobs
|
40
|
+
#
|
41
|
+
#
|
42
|
+
# @return [lambda]
|
43
|
+
#
|
44
|
+
def self.death_handler
|
45
|
+
DEATH_HANDLER
|
46
|
+
end
|
47
|
+
end
|
48
|
+
end
|