sidekiq-unique-jobs 6.0.20 → 7.0.10
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 +742 -41
- data/README.md +529 -110
- data/lib/sidekiq_unique_jobs.rb +48 -7
- data/lib/sidekiq_unique_jobs/batch_delete.rb +123 -0
- data/lib/sidekiq_unique_jobs/changelog.rb +78 -0
- data/lib/sidekiq_unique_jobs/cli.rb +34 -31
- data/lib/sidekiq_unique_jobs/config.rb +263 -0
- data/lib/sidekiq_unique_jobs/connection.rb +6 -5
- data/lib/sidekiq_unique_jobs/constants.rb +46 -24
- data/lib/sidekiq_unique_jobs/core_ext.rb +80 -0
- data/lib/sidekiq_unique_jobs/digests.rb +71 -100
- data/lib/sidekiq_unique_jobs/exceptions.rb +78 -12
- data/lib/sidekiq_unique_jobs/job.rb +41 -12
- data/lib/sidekiq_unique_jobs/json.rb +40 -0
- data/lib/sidekiq_unique_jobs/key.rb +93 -0
- data/lib/sidekiq_unique_jobs/lock.rb +325 -0
- data/lib/sidekiq_unique_jobs/lock/base_lock.rb +68 -52
- data/lib/sidekiq_unique_jobs/lock/client_validator.rb +28 -0
- data/lib/sidekiq_unique_jobs/lock/server_validator.rb +27 -0
- data/lib/sidekiq_unique_jobs/lock/until_and_while_executing.rb +7 -10
- data/lib/sidekiq_unique_jobs/lock/until_executed.rb +6 -6
- data/lib/sidekiq_unique_jobs/lock/until_executing.rb +1 -1
- data/lib/sidekiq_unique_jobs/lock/until_expired.rb +4 -21
- data/lib/sidekiq_unique_jobs/lock/validator.rb +96 -0
- data/lib/sidekiq_unique_jobs/lock/while_executing.rb +13 -9
- data/lib/sidekiq_unique_jobs/lock/while_executing_reject.rb +3 -3
- data/lib/sidekiq_unique_jobs/lock_args.rb +123 -0
- data/lib/sidekiq_unique_jobs/lock_config.rb +126 -0
- data/lib/sidekiq_unique_jobs/lock_digest.rb +79 -0
- data/lib/sidekiq_unique_jobs/lock_info.rb +68 -0
- data/lib/sidekiq_unique_jobs/lock_timeout.rb +62 -0
- data/lib/sidekiq_unique_jobs/lock_ttl.rb +77 -0
- data/lib/sidekiq_unique_jobs/locksmith.rb +267 -101
- data/lib/sidekiq_unique_jobs/logging.rb +179 -33
- data/lib/sidekiq_unique_jobs/logging/middleware_context.rb +44 -0
- data/lib/sidekiq_unique_jobs/lua/delete.lua +51 -0
- data/lib/sidekiq_unique_jobs/lua/delete_by_digest.lua +42 -0
- data/lib/sidekiq_unique_jobs/lua/delete_job_by_digest.lua +38 -0
- data/lib/sidekiq_unique_jobs/lua/find_digest_in_queues.lua +26 -0
- data/lib/sidekiq_unique_jobs/lua/lock.lua +93 -0
- data/lib/sidekiq_unique_jobs/lua/locked.lua +35 -0
- data/lib/sidekiq_unique_jobs/lua/queue.lua +87 -0
- data/lib/sidekiq_unique_jobs/lua/reap_orphans.lua +94 -0
- data/lib/sidekiq_unique_jobs/lua/shared/_common.lua +40 -0
- data/lib/sidekiq_unique_jobs/lua/shared/_current_time.lua +8 -0
- data/lib/sidekiq_unique_jobs/lua/shared/_delete_from_queue.lua +22 -0
- data/lib/sidekiq_unique_jobs/lua/shared/_delete_from_sorted_set.lua +18 -0
- data/lib/sidekiq_unique_jobs/lua/shared/_find_digest_in_process_set.lua +53 -0
- data/lib/sidekiq_unique_jobs/lua/shared/_find_digest_in_queues.lua +43 -0
- data/lib/sidekiq_unique_jobs/lua/shared/_find_digest_in_sorted_set.lua +24 -0
- data/lib/sidekiq_unique_jobs/lua/shared/_hgetall.lua +13 -0
- data/lib/sidekiq_unique_jobs/lua/shared/_upgrades.lua +3 -0
- data/lib/sidekiq_unique_jobs/lua/unlock.lua +95 -0
- data/lib/sidekiq_unique_jobs/lua/update_version.lua +40 -0
- data/lib/sidekiq_unique_jobs/lua/upgrade.lua +68 -0
- data/lib/sidekiq_unique_jobs/middleware.rb +29 -31
- data/lib/sidekiq_unique_jobs/middleware/client.rb +42 -0
- data/lib/sidekiq_unique_jobs/middleware/server.rb +27 -0
- data/lib/sidekiq_unique_jobs/normalizer.rb +4 -4
- data/lib/sidekiq_unique_jobs/on_conflict.rb +23 -10
- data/lib/sidekiq_unique_jobs/on_conflict/log.rb +9 -5
- data/lib/sidekiq_unique_jobs/on_conflict/null_strategy.rb +1 -1
- data/lib/sidekiq_unique_jobs/on_conflict/raise.rb +1 -1
- data/lib/sidekiq_unique_jobs/on_conflict/reject.rb +61 -15
- data/lib/sidekiq_unique_jobs/on_conflict/replace.rb +54 -14
- data/lib/sidekiq_unique_jobs/on_conflict/reschedule.rb +12 -5
- data/lib/sidekiq_unique_jobs/on_conflict/strategy.rb +25 -6
- data/lib/sidekiq_unique_jobs/options_with_fallback.rb +41 -27
- data/lib/sidekiq_unique_jobs/orphans/lua_reaper.rb +29 -0
- data/lib/sidekiq_unique_jobs/orphans/manager.rb +212 -0
- data/lib/sidekiq_unique_jobs/orphans/null_reaper.rb +24 -0
- data/lib/sidekiq_unique_jobs/orphans/observer.rb +42 -0
- data/lib/sidekiq_unique_jobs/orphans/reaper.rb +114 -0
- data/lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb +213 -0
- data/lib/sidekiq_unique_jobs/redis.rb +11 -0
- data/lib/sidekiq_unique_jobs/redis/entity.rb +112 -0
- data/lib/sidekiq_unique_jobs/redis/hash.rb +56 -0
- data/lib/sidekiq_unique_jobs/redis/list.rb +32 -0
- data/lib/sidekiq_unique_jobs/redis/set.rb +32 -0
- data/lib/sidekiq_unique_jobs/redis/sorted_set.rb +86 -0
- data/lib/sidekiq_unique_jobs/redis/string.rb +49 -0
- data/lib/sidekiq_unique_jobs/rspec/matchers.rb +26 -0
- data/lib/sidekiq_unique_jobs/rspec/matchers/have_valid_sidekiq_options.rb +51 -0
- data/lib/sidekiq_unique_jobs/script.rb +15 -0
- data/lib/sidekiq_unique_jobs/script/caller.rb +125 -0
- data/lib/sidekiq_unique_jobs/server.rb +48 -0
- data/lib/sidekiq_unique_jobs/sidekiq_unique_ext.rb +92 -65
- data/lib/sidekiq_unique_jobs/sidekiq_unique_jobs.rb +204 -34
- data/lib/sidekiq_unique_jobs/sidekiq_worker_methods.rb +18 -9
- data/lib/sidekiq_unique_jobs/testing.rb +62 -21
- data/lib/sidekiq_unique_jobs/timer_task.rb +78 -0
- data/lib/sidekiq_unique_jobs/timing.rb +58 -0
- data/lib/sidekiq_unique_jobs/unlockable.rb +20 -4
- data/lib/sidekiq_unique_jobs/update_version.rb +25 -0
- data/lib/sidekiq_unique_jobs/upgrade_locks.rb +155 -0
- data/lib/sidekiq_unique_jobs/version.rb +3 -1
- data/lib/sidekiq_unique_jobs/version_check.rb +23 -4
- data/lib/sidekiq_unique_jobs/web.rb +57 -27
- data/lib/sidekiq_unique_jobs/web/helpers.rb +128 -13
- data/lib/sidekiq_unique_jobs/web/views/_paging.erb +4 -4
- data/lib/sidekiq_unique_jobs/web/views/changelogs.erb +54 -0
- data/lib/sidekiq_unique_jobs/web/views/lock.erb +108 -0
- data/lib/sidekiq_unique_jobs/web/views/locks.erb +54 -0
- data/lib/tasks/changelog.rake +5 -5
- metadata +122 -176
- data/lib/sidekiq_unique_jobs/client/middleware.rb +0 -56
- data/lib/sidekiq_unique_jobs/scripts.rb +0 -118
- data/lib/sidekiq_unique_jobs/server/middleware.rb +0 -46
- data/lib/sidekiq_unique_jobs/timeout.rb +0 -8
- data/lib/sidekiq_unique_jobs/timeout/calculator.rb +0 -63
- data/lib/sidekiq_unique_jobs/unique_args.rb +0 -149
- data/lib/sidekiq_unique_jobs/util.rb +0 -103
- data/lib/sidekiq_unique_jobs/web/views/unique_digest.erb +0 -28
- data/lib/sidekiq_unique_jobs/web/views/unique_digests.erb +0 -46
- data/redis/acquire_lock.lua +0 -21
- data/redis/convert_legacy_lock.lua +0 -13
- data/redis/delete.lua +0 -14
- data/redis/delete_by_digest.lua +0 -23
- data/redis/delete_job_by_digest.lua +0 -60
- data/redis/lock.lua +0 -62
- data/redis/release_stale_locks.lua +0 -90
- data/redis/unlock.lua +0 -35
@@ -3,27 +3,56 @@
|
|
3
3
|
module SidekiqUniqueJobs
|
4
4
|
# Utility class to append uniqueness to the sidekiq job hash
|
5
5
|
#
|
6
|
-
# @author Mikael Henriksson <mikael@
|
6
|
+
# @author Mikael Henriksson <mikael@mhenrixon.com>
|
7
7
|
module Job
|
8
8
|
extend self
|
9
9
|
|
10
|
-
# Adds timeout, expiration,
|
11
|
-
# @return [
|
12
|
-
def
|
13
|
-
|
14
|
-
|
10
|
+
# Adds timeout, expiration, lock_args, lock_prefix and lock_digest to the sidekiq job hash
|
11
|
+
# @return [Hash] the job hash
|
12
|
+
def prepare(item)
|
13
|
+
stringify_on_conflict_hash(item)
|
14
|
+
add_lock_timeout(item)
|
15
|
+
add_lock_ttl(item)
|
16
|
+
add_digest(item)
|
17
|
+
end
|
18
|
+
|
19
|
+
# Adds lock_args, lock_prefix and lock_digest to the sidekiq job hash
|
20
|
+
# @return [Hash] the job hash
|
21
|
+
def add_digest(item)
|
22
|
+
add_lock_prefix(item)
|
23
|
+
add_lock_args(item)
|
24
|
+
add_lock_digest(item)
|
25
|
+
|
26
|
+
item
|
15
27
|
end
|
16
28
|
|
17
29
|
private
|
18
30
|
|
19
|
-
def
|
20
|
-
|
21
|
-
|
22
|
-
|
31
|
+
def stringify_on_conflict_hash(item)
|
32
|
+
on_conflict = item[ON_CONFLICT]
|
33
|
+
return unless on_conflict.is_a?(Hash)
|
34
|
+
|
35
|
+
item[ON_CONFLICT] = on_conflict.deep_stringify_keys
|
36
|
+
end
|
37
|
+
|
38
|
+
def add_lock_ttl(item)
|
39
|
+
item[LOCK_TTL] = SidekiqUniqueJobs::LockTTL.calculate(item)
|
40
|
+
end
|
41
|
+
|
42
|
+
def add_lock_timeout(item)
|
43
|
+
item[LOCK_TIMEOUT] ||= SidekiqUniqueJobs::LockTimeout.calculate(item)
|
44
|
+
end
|
45
|
+
|
46
|
+
def add_lock_args(item)
|
47
|
+
item[LOCK_ARGS] ||= SidekiqUniqueJobs::LockArgs.call(item)
|
48
|
+
end
|
49
|
+
|
50
|
+
def add_lock_digest(item)
|
51
|
+
item[LOCK_DIGEST] ||= SidekiqUniqueJobs::LockDigest.call(item)
|
23
52
|
end
|
24
53
|
|
25
|
-
def
|
26
|
-
SidekiqUniqueJobs
|
54
|
+
def add_lock_prefix(item)
|
55
|
+
item[LOCK_PREFIX] ||= SidekiqUniqueJobs.config.lock_prefix
|
27
56
|
end
|
28
57
|
end
|
29
58
|
end
|
@@ -0,0 +1,40 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module SidekiqUniqueJobs
|
4
|
+
# Handles loading and dumping of json
|
5
|
+
#
|
6
|
+
# @author Mikael Henriksson <mikael@mhenrixon.com>
|
7
|
+
module JSON
|
8
|
+
module_function
|
9
|
+
|
10
|
+
#
|
11
|
+
# Parses a JSON string into an object
|
12
|
+
#
|
13
|
+
# @param [String] string the object to parse
|
14
|
+
#
|
15
|
+
# @return [Object]
|
16
|
+
#
|
17
|
+
def load_json(string)
|
18
|
+
return if string.nil? || string.empty?
|
19
|
+
|
20
|
+
::JSON.parse(string)
|
21
|
+
end
|
22
|
+
|
23
|
+
def safe_load_json(string)
|
24
|
+
return string if string.is_a?(Hash)
|
25
|
+
|
26
|
+
load_json(string)
|
27
|
+
end
|
28
|
+
|
29
|
+
#
|
30
|
+
# Dumps an object into a JSON string
|
31
|
+
#
|
32
|
+
# @param [Object] object a JSON convertible object
|
33
|
+
#
|
34
|
+
# @return [String] a JSON string
|
35
|
+
#
|
36
|
+
def dump_json(object)
|
37
|
+
::JSON.generate(object)
|
38
|
+
end
|
39
|
+
end
|
40
|
+
end
|
@@ -0,0 +1,93 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module SidekiqUniqueJobs
|
4
|
+
# Key class wraps logic dealing with various lock keys
|
5
|
+
#
|
6
|
+
# @author Mikael Henriksson <mikael@mhenrixon.com>
|
7
|
+
class Key
|
8
|
+
#
|
9
|
+
# @!attribute [r] digest
|
10
|
+
# @return [String] the digest key for which keys are created
|
11
|
+
attr_reader :digest
|
12
|
+
#
|
13
|
+
# @!attribute [r] queued
|
14
|
+
# @return [String] the list key with queued job_id's
|
15
|
+
attr_reader :queued
|
16
|
+
#
|
17
|
+
# @!attribute [r] primed
|
18
|
+
# @return [String] the list key with primed job_id's
|
19
|
+
attr_reader :primed
|
20
|
+
#
|
21
|
+
# @!attribute [r] locked
|
22
|
+
# @return [String] the hash key with locked job_id's
|
23
|
+
attr_reader :locked
|
24
|
+
#
|
25
|
+
# @!attribute [r] info
|
26
|
+
# @return [String] information about the lock
|
27
|
+
attr_reader :info
|
28
|
+
#
|
29
|
+
# @!attribute [r] changelog
|
30
|
+
# @return [String] the zset with changelog entries
|
31
|
+
attr_reader :changelog
|
32
|
+
#
|
33
|
+
# @!attribute [r] digests
|
34
|
+
# @return [String] the zset with locked digests
|
35
|
+
attr_reader :digests
|
36
|
+
|
37
|
+
#
|
38
|
+
# Initialize a new Key
|
39
|
+
#
|
40
|
+
# @param [String] digest the digest to use as key
|
41
|
+
#
|
42
|
+
def initialize(digest)
|
43
|
+
@digest = digest
|
44
|
+
@queued = suffixed_key("QUEUED")
|
45
|
+
@primed = suffixed_key("PRIMED")
|
46
|
+
@locked = suffixed_key("LOCKED")
|
47
|
+
@info = suffixed_key("INFO")
|
48
|
+
@changelog = CHANGELOGS
|
49
|
+
@digests = DIGESTS
|
50
|
+
end
|
51
|
+
|
52
|
+
#
|
53
|
+
# Provides the only important information about this keys
|
54
|
+
#
|
55
|
+
#
|
56
|
+
# @return [String]
|
57
|
+
#
|
58
|
+
def to_s
|
59
|
+
digest
|
60
|
+
end
|
61
|
+
|
62
|
+
# @see to_s
|
63
|
+
def inspect
|
64
|
+
digest
|
65
|
+
end
|
66
|
+
|
67
|
+
#
|
68
|
+
# Compares keys by digest
|
69
|
+
#
|
70
|
+
# @param [Key] other the key to compare with
|
71
|
+
#
|
72
|
+
# @return [true, false]
|
73
|
+
#
|
74
|
+
def ==(other)
|
75
|
+
digest == other.digest
|
76
|
+
end
|
77
|
+
|
78
|
+
#
|
79
|
+
# Returns all keys as an ordered array
|
80
|
+
#
|
81
|
+
# @return [Array] an ordered array with all keys
|
82
|
+
#
|
83
|
+
def to_a
|
84
|
+
[digest, queued, primed, locked, info, changelog, digests]
|
85
|
+
end
|
86
|
+
|
87
|
+
private
|
88
|
+
|
89
|
+
def suffixed_key(variable)
|
90
|
+
"#{digest}:#{variable}"
|
91
|
+
end
|
92
|
+
end
|
93
|
+
end
|
@@ -0,0 +1,325 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module SidekiqUniqueJobs
|
4
|
+
#
|
5
|
+
# Class Lock provides access to information about a lock
|
6
|
+
#
|
7
|
+
# @author Mikael Henriksson <mikael@mhenrixon.com>
|
8
|
+
#
|
9
|
+
class Lock # rubocop:disable Metrics/ClassLength
|
10
|
+
# includes "SidekiqUniqueJobs::Connection"
|
11
|
+
# @!parse include SidekiqUniqueJobs::Connection
|
12
|
+
include SidekiqUniqueJobs::Connection
|
13
|
+
|
14
|
+
# includes "SidekiqUniqueJobs::Timing"
|
15
|
+
# @!parse include SidekiqUniqueJobs::Timing
|
16
|
+
include SidekiqUniqueJobs::Timing
|
17
|
+
|
18
|
+
# includes "SidekiqUniqueJobs::JSON"
|
19
|
+
# @!parse include SidekiqUniqueJobs::JSON
|
20
|
+
include SidekiqUniqueJobs::JSON
|
21
|
+
|
22
|
+
#
|
23
|
+
# @!attribute [r] key
|
24
|
+
# @return [String] the entity redis key
|
25
|
+
attr_reader :key
|
26
|
+
|
27
|
+
#
|
28
|
+
# Initialize a locked lock
|
29
|
+
#
|
30
|
+
# @param [String] digest a unique digest
|
31
|
+
# @param [String] job_id a sidekiq JID
|
32
|
+
# @param [Hash] lock_info information about the lock
|
33
|
+
#
|
34
|
+
# @return [Lock] a newly lock that has been locked
|
35
|
+
#
|
36
|
+
def self.create(digest, job_id, lock_info = {})
|
37
|
+
lock = new(digest, time: Timing.now_f)
|
38
|
+
lock.lock(job_id, lock_info)
|
39
|
+
lock
|
40
|
+
end
|
41
|
+
|
42
|
+
#
|
43
|
+
# Initialize a new lock
|
44
|
+
#
|
45
|
+
# @param [String, Key] key either a digest or an instance of a {Key}
|
46
|
+
# @param [Timstamp, Float] time nil optional timestamp to initiate this lock with
|
47
|
+
#
|
48
|
+
def initialize(key, time: nil)
|
49
|
+
@key = get_key(key)
|
50
|
+
@created_at = time.is_a?(Float) ? time : time.to_f
|
51
|
+
end
|
52
|
+
|
53
|
+
#
|
54
|
+
# Locks a job_id
|
55
|
+
#
|
56
|
+
# @note intended only for testing purposes
|
57
|
+
#
|
58
|
+
# @param [String] job_id a sidekiq JID
|
59
|
+
# @param [Hash] lock_info information about the lock
|
60
|
+
#
|
61
|
+
# @return [void]
|
62
|
+
#
|
63
|
+
def lock(job_id, lock_info = {})
|
64
|
+
redis do |conn|
|
65
|
+
conn.multi do
|
66
|
+
conn.set(key.digest, job_id)
|
67
|
+
conn.hset(key.locked, job_id, now_f)
|
68
|
+
info.set(lock_info)
|
69
|
+
conn.zadd(key.digests, now_f, key.digest)
|
70
|
+
conn.zadd(key.changelog, now_f, changelog_json(job_id, "queue.lua", "Queued"))
|
71
|
+
conn.zadd(key.changelog, now_f, changelog_json(job_id, "lock.lua", "Locked"))
|
72
|
+
end
|
73
|
+
end
|
74
|
+
end
|
75
|
+
|
76
|
+
#
|
77
|
+
# Create the :QUEUED key
|
78
|
+
#
|
79
|
+
# @note intended only for testing purposes
|
80
|
+
#
|
81
|
+
# @param [String] job_id a sidekiq JID
|
82
|
+
#
|
83
|
+
# @return [void]
|
84
|
+
#
|
85
|
+
def queue(job_id)
|
86
|
+
redis do |conn|
|
87
|
+
conn.lpush(key.queued, job_id)
|
88
|
+
end
|
89
|
+
end
|
90
|
+
|
91
|
+
#
|
92
|
+
# Create the :PRIMED key
|
93
|
+
#
|
94
|
+
# @note intended only for testing purposes
|
95
|
+
#
|
96
|
+
# @param [String] job_id a sidekiq JID
|
97
|
+
#
|
98
|
+
# @return [void]
|
99
|
+
#
|
100
|
+
def prime(job_id)
|
101
|
+
redis do |conn|
|
102
|
+
conn.lpush(key.primed, job_id)
|
103
|
+
end
|
104
|
+
end
|
105
|
+
|
106
|
+
#
|
107
|
+
# Unlock a specific job_id
|
108
|
+
#
|
109
|
+
# @param [String] job_id a sidekiq JID
|
110
|
+
#
|
111
|
+
# @return [true] when job_id was removed
|
112
|
+
# @return [false] when job_id wasn't locked
|
113
|
+
#
|
114
|
+
def unlock(job_id)
|
115
|
+
locked.del(job_id)
|
116
|
+
end
|
117
|
+
|
118
|
+
#
|
119
|
+
# Deletes all the redis keys for this lock
|
120
|
+
#
|
121
|
+
#
|
122
|
+
# @return [Integer] the number of keys deleted in redis
|
123
|
+
#
|
124
|
+
def del
|
125
|
+
redis do |conn|
|
126
|
+
conn.multi do
|
127
|
+
conn.zrem(DIGESTS, key.digest)
|
128
|
+
conn.del(key.digest, key.queued, key.primed, key.locked, key.info)
|
129
|
+
end
|
130
|
+
end
|
131
|
+
end
|
132
|
+
|
133
|
+
#
|
134
|
+
# Returns either the time the lock was initialized with or
|
135
|
+
# the first changelog entry's timestamp
|
136
|
+
#
|
137
|
+
#
|
138
|
+
# @return [Float] a floaty timestamp represantation
|
139
|
+
#
|
140
|
+
def created_at
|
141
|
+
@created_at ||= changelogs.first&.[]("time")
|
142
|
+
end
|
143
|
+
|
144
|
+
#
|
145
|
+
# Returns all job_id's for this lock
|
146
|
+
#
|
147
|
+
# @note a JID can be present in 3 different places
|
148
|
+
#
|
149
|
+
#
|
150
|
+
# @return [Array<String>] an array with JIDs
|
151
|
+
#
|
152
|
+
def all_jids
|
153
|
+
(queued_jids + primed_jids + locked_jids).uniq
|
154
|
+
end
|
155
|
+
|
156
|
+
#
|
157
|
+
# Returns a collection of locked job_id's
|
158
|
+
#
|
159
|
+
# @param [true, false] with_values false provide the timestamp for the lock
|
160
|
+
#
|
161
|
+
# @return [Hash<String, Float>] when given `with_values: true`
|
162
|
+
# @return [Array<String>] when given `with_values: false`
|
163
|
+
#
|
164
|
+
def locked_jids(with_values: false)
|
165
|
+
locked.entries(with_values: with_values)
|
166
|
+
end
|
167
|
+
|
168
|
+
#
|
169
|
+
# Returns the queued JIDs
|
170
|
+
#
|
171
|
+
#
|
172
|
+
# @return [Array<String>] an array with queued job_ids
|
173
|
+
#
|
174
|
+
def queued_jids
|
175
|
+
queued.entries
|
176
|
+
end
|
177
|
+
|
178
|
+
#
|
179
|
+
# Returns the primed JIDs
|
180
|
+
#
|
181
|
+
#
|
182
|
+
# @return [Array<String>] an array with primed job_ids
|
183
|
+
#
|
184
|
+
def primed_jids
|
185
|
+
primed.entries
|
186
|
+
end
|
187
|
+
|
188
|
+
#
|
189
|
+
# Returns all matching changelog entries for this lock
|
190
|
+
#
|
191
|
+
#
|
192
|
+
# @return [Array<Hash>] an array with changelogs
|
193
|
+
#
|
194
|
+
def changelogs
|
195
|
+
changelog.entries(pattern: "*#{key.digest}*")
|
196
|
+
end
|
197
|
+
|
198
|
+
#
|
199
|
+
# The digest key
|
200
|
+
#
|
201
|
+
# @note Used for exists checks to avoid enqueuing
|
202
|
+
# the same lock twice
|
203
|
+
#
|
204
|
+
#
|
205
|
+
# @return [Redis::String] a string representation of the key
|
206
|
+
#
|
207
|
+
def digest
|
208
|
+
@digest ||= Redis::String.new(key.digest)
|
209
|
+
end
|
210
|
+
|
211
|
+
#
|
212
|
+
# The queued list
|
213
|
+
#
|
214
|
+
#
|
215
|
+
# @return [Redis::List] for queued JIDs
|
216
|
+
#
|
217
|
+
def queued
|
218
|
+
@queued ||= Redis::List.new(key.queued)
|
219
|
+
end
|
220
|
+
|
221
|
+
#
|
222
|
+
# The primed list
|
223
|
+
#
|
224
|
+
#
|
225
|
+
# @return [Redis::List] for primed JIDs
|
226
|
+
#
|
227
|
+
def primed
|
228
|
+
@primed ||= Redis::List.new(key.primed)
|
229
|
+
end
|
230
|
+
|
231
|
+
#
|
232
|
+
# The locked hash
|
233
|
+
#
|
234
|
+
#
|
235
|
+
# @return [Redis::Hash] for locked JIDs
|
236
|
+
#
|
237
|
+
def locked
|
238
|
+
@locked ||= Redis::Hash.new(key.locked)
|
239
|
+
end
|
240
|
+
|
241
|
+
#
|
242
|
+
# Information about the lock
|
243
|
+
#
|
244
|
+
#
|
245
|
+
# @return [Redis::Hash] with lock information
|
246
|
+
#
|
247
|
+
def info
|
248
|
+
@info ||= LockInfo.new(key.info)
|
249
|
+
end
|
250
|
+
|
251
|
+
#
|
252
|
+
# A sorted set with changelog entries
|
253
|
+
#
|
254
|
+
# @see Changelog for more information
|
255
|
+
#
|
256
|
+
#
|
257
|
+
# @return [Changelog]
|
258
|
+
#
|
259
|
+
def changelog
|
260
|
+
@changelog ||= Changelog.new
|
261
|
+
end
|
262
|
+
|
263
|
+
#
|
264
|
+
# A nicely formatted string with information about this lock
|
265
|
+
#
|
266
|
+
#
|
267
|
+
# @return [String]
|
268
|
+
#
|
269
|
+
def to_s
|
270
|
+
<<~MESSAGE
|
271
|
+
Lock status for #{key}
|
272
|
+
|
273
|
+
value: #{digest.value}
|
274
|
+
info: #{info.value}
|
275
|
+
queued_jids: #{queued_jids}
|
276
|
+
primed_jids: #{primed_jids}
|
277
|
+
locked_jids: #{locked_jids}
|
278
|
+
changelogs: #{changelogs}
|
279
|
+
MESSAGE
|
280
|
+
end
|
281
|
+
|
282
|
+
#
|
283
|
+
# @see to_s
|
284
|
+
#
|
285
|
+
def inspect
|
286
|
+
to_s
|
287
|
+
end
|
288
|
+
|
289
|
+
private
|
290
|
+
|
291
|
+
#
|
292
|
+
# Ensure the key is a {Key}
|
293
|
+
#
|
294
|
+
# @param [String, Key] key
|
295
|
+
#
|
296
|
+
# @return [Key]
|
297
|
+
#
|
298
|
+
def get_key(key)
|
299
|
+
if key.is_a?(SidekiqUniqueJobs::Key)
|
300
|
+
key
|
301
|
+
else
|
302
|
+
SidekiqUniqueJobs::Key.new(key)
|
303
|
+
end
|
304
|
+
end
|
305
|
+
|
306
|
+
#
|
307
|
+
# Generate a changelog entry for the given arguments
|
308
|
+
#
|
309
|
+
# @param [String] job_id a sidekiq JID
|
310
|
+
# @param [String] script the name of the script generating this entry
|
311
|
+
# @param [String] message a descriptive message for later review
|
312
|
+
#
|
313
|
+
# @return [String] a JSON string matching the Lua script structure
|
314
|
+
#
|
315
|
+
def changelog_json(job_id, script, message)
|
316
|
+
dump_json(
|
317
|
+
digest: key.digest,
|
318
|
+
job_id: job_id,
|
319
|
+
script: script,
|
320
|
+
message: message,
|
321
|
+
time: now_f,
|
322
|
+
)
|
323
|
+
end
|
324
|
+
end
|
325
|
+
end
|