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,7 +3,7 @@
|
|
3
3
|
module SidekiqUniqueJobs
|
4
4
|
# Module with convenience methods for the Sidekiq::Worker class
|
5
5
|
#
|
6
|
-
# @author Mikael Henriksson <mikael@
|
6
|
+
# @author Mikael Henriksson <mikael@mhenrixon.com>
|
7
7
|
module SidekiqWorkerMethods
|
8
8
|
# Avoids duplicating worker_class.respond_to? in multiple places
|
9
9
|
# @return [true, false]
|
@@ -16,7 +16,7 @@ module SidekiqUniqueJobs
|
|
16
16
|
def worker_options
|
17
17
|
return {} unless sidekiq_worker_class?
|
18
18
|
|
19
|
-
worker_class.get_sidekiq_options.
|
19
|
+
worker_class.get_sidekiq_options.deep_stringify_keys
|
20
20
|
end
|
21
21
|
|
22
22
|
# Tests that the
|
@@ -29,24 +29,27 @@ module SidekiqUniqueJobs
|
|
29
29
|
# The Sidekiq::Worker implementation
|
30
30
|
# @return [Sidekiq::Worker]
|
31
31
|
def worker_class
|
32
|
-
@_worker_class ||= worker_class_constantize
|
32
|
+
@_worker_class ||= worker_class_constantize # rubocop:disable Naming/MemoizedInstanceVariableName
|
33
33
|
end
|
34
34
|
|
35
35
|
# The hook to call after a successful unlock
|
36
36
|
# @return [Proc]
|
37
37
|
def after_unlock_hook
|
38
|
-
|
38
|
+
lambda do
|
39
|
+
if @worker_class.respond_to?(:after_unlock)
|
40
|
+
@worker_class.after_unlock # instance method in sidekiq v6
|
41
|
+
elsif worker_class.respond_to?(:after_unlock)
|
42
|
+
worker_class.after_unlock # class method regardless of sidekiq version
|
43
|
+
end
|
44
|
+
end
|
39
45
|
end
|
40
46
|
|
41
47
|
# Attempt to constantize a string worker_class argument, always
|
42
48
|
# failing back to the original argument when the constant can't be found
|
43
49
|
#
|
44
50
|
# @return [Sidekiq::Worker]
|
45
|
-
def worker_class_constantize(klazz)
|
46
|
-
|
47
|
-
return klazz unless klazz.is_a?(String)
|
48
|
-
|
49
|
-
Object.const_get(klazz)
|
51
|
+
def worker_class_constantize(klazz = @worker_class)
|
52
|
+
SidekiqUniqueJobs.constantize(klazz)
|
50
53
|
rescue NameError => ex
|
51
54
|
case ex.message
|
52
55
|
when /uninitialized constant/
|
@@ -56,6 +59,12 @@ module SidekiqUniqueJobs
|
|
56
59
|
end
|
57
60
|
end
|
58
61
|
|
62
|
+
#
|
63
|
+
# Returns the default worker options from Sidekiq
|
64
|
+
#
|
65
|
+
#
|
66
|
+
# @return [Hash<Symbol, Object>]
|
67
|
+
#
|
59
68
|
def default_worker_options
|
60
69
|
Sidekiq.default_worker_options
|
61
70
|
end
|
@@ -1,36 +1,69 @@
|
|
1
1
|
# frozen_string_literal: true
|
2
2
|
|
3
3
|
# :nocov:
|
4
|
+
# :nodoc:
|
4
5
|
|
5
6
|
require "sidekiq"
|
6
7
|
require "sidekiq/testing"
|
8
|
+
require "sidekiq_unique_jobs/rspec/matchers"
|
9
|
+
require "sidekiq_unique_jobs/lock/validator"
|
10
|
+
require "sidekiq_unique_jobs/lock/client_validator"
|
11
|
+
require "sidekiq_unique_jobs/lock/server_validator"
|
7
12
|
|
13
|
+
#
|
14
|
+
# See Sidekiq gem for more details
|
15
|
+
#
|
8
16
|
module Sidekiq
|
17
|
+
#
|
18
|
+
# Temporarily turn Sidekiq's options into something different
|
19
|
+
#
|
20
|
+
# @note this method will restore the original options after yielding
|
21
|
+
#
|
22
|
+
# @param [Hash<Symbol, Object>] tmp_config the temporary config to use
|
23
|
+
#
|
9
24
|
def self.use_options(tmp_config = {})
|
10
|
-
|
25
|
+
old_options = default_worker_options.dup
|
26
|
+
|
11
27
|
default_worker_options.clear
|
12
28
|
self.default_worker_options = tmp_config
|
13
|
-
|
14
29
|
yield
|
15
30
|
ensure
|
16
31
|
default_worker_options.clear
|
17
|
-
self.default_worker_options =
|
32
|
+
self.default_worker_options = DEFAULT_WORKER_OPTIONS
|
33
|
+
self.default_worker_options = old_options
|
18
34
|
end
|
19
35
|
|
36
|
+
#
|
37
|
+
# See Sidekiq::Worker in Sidekiq gem for more details
|
38
|
+
#
|
20
39
|
module Worker
|
40
|
+
#
|
41
|
+
# Adds class methods to Sidekiq::Worker
|
42
|
+
#
|
21
43
|
module ClassMethods
|
44
|
+
#
|
45
|
+
# Temporarily turn a workers sidekiq_options into something different
|
46
|
+
#
|
47
|
+
# @note this method will restore the original configuration after yielding
|
48
|
+
#
|
49
|
+
# @param [Hash<Symbol, Object>] tmp_config the temporary config to use
|
50
|
+
#
|
22
51
|
def use_options(tmp_config = {})
|
23
|
-
|
24
|
-
sidekiq_options(tmp_config)
|
52
|
+
old_options = sidekiq_options_hash.dup
|
53
|
+
sidekiq_options(old_options.merge(tmp_config))
|
25
54
|
|
26
55
|
yield
|
27
56
|
ensure
|
28
|
-
|
57
|
+
self.sidekiq_options_hash = Sidekiq::DEFAULT_WORKER_OPTIONS
|
58
|
+
sidekiq_options(old_options)
|
29
59
|
end
|
30
60
|
|
61
|
+
#
|
62
|
+
# Clears the jobs for this worker and removes all locks
|
63
|
+
#
|
31
64
|
def clear
|
32
65
|
jobs.each do |job|
|
33
|
-
SidekiqUniqueJobs::Unlockable.
|
66
|
+
SidekiqUniqueJobs::Unlockable.unlock(job)
|
34
67
|
end
|
35
68
|
|
36
69
|
Sidekiq::Queues[queue].clear
|
@@ -38,25 +71,33 @@ module Sidekiq
|
|
38
71
|
end
|
39
72
|
end
|
40
73
|
|
74
|
+
#
|
75
|
+
# Prepends deletion of locks to clear_all
|
76
|
+
#
|
41
77
|
module Overrides
|
42
|
-
|
43
|
-
|
44
|
-
|
45
|
-
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
|
78
|
+
#
|
79
|
+
# Overrides sidekiq_options on the worker class to prepend validation
|
80
|
+
#
|
81
|
+
# @param [Hash] options worker options
|
82
|
+
#
|
83
|
+
# @return [void]
|
84
|
+
#
|
85
|
+
def sidekiq_options(options = {})
|
86
|
+
SidekiqUniqueJobs.validate_worker!(options) if SidekiqUniqueJobs.config.raise_on_config_error
|
87
|
+
|
88
|
+
super(options)
|
50
89
|
end
|
51
90
|
|
52
|
-
|
53
|
-
|
54
|
-
|
55
|
-
|
56
|
-
|
91
|
+
#
|
92
|
+
# Clears all jobs for this worker and removes all locks
|
93
|
+
#
|
94
|
+
def clear_all
|
95
|
+
super
|
96
|
+
|
97
|
+
SidekiqUniqueJobs::Digests.new.delete_by_pattern("*", count: 10_000)
|
57
98
|
end
|
58
99
|
end
|
59
100
|
|
60
|
-
|
101
|
+
prepend Overrides
|
61
102
|
end
|
62
103
|
end
|
@@ -0,0 +1,78 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module SidekiqUniqueJobs
|
4
|
+
# @see [Concurrent::TimerTask] https://www.rubydoc.info/gems/concurrent-ruby/Concurrent/TimerTask
|
5
|
+
#
|
6
|
+
class TimerTask < ::Concurrent::TimerTask
|
7
|
+
private
|
8
|
+
|
9
|
+
def ns_initialize(opts, &task)
|
10
|
+
set_deref_options(opts)
|
11
|
+
|
12
|
+
self.execution_interval = opts[:execution] || opts[:execution_interval] || EXECUTION_INTERVAL
|
13
|
+
self.timeout_interval = opts[:timeout] || opts[:timeout_interval] || TIMEOUT_INTERVAL
|
14
|
+
@run_now = opts[:now] || opts[:run_now]
|
15
|
+
@executor = Concurrent::RubySingleThreadExecutor.new
|
16
|
+
@running = Concurrent::AtomicBoolean.new(false)
|
17
|
+
@task = task
|
18
|
+
@value = nil
|
19
|
+
|
20
|
+
self.observers = Concurrent::Collection::CopyOnNotifyObserverSet.new
|
21
|
+
end
|
22
|
+
|
23
|
+
def schedule_next_task(interval = execution_interval)
|
24
|
+
exec_task = ->(completion) { execute_task(completion) }
|
25
|
+
Concurrent::ScheduledTask.execute(interval, args: [Concurrent::Event.new], &exec_task)
|
26
|
+
nil
|
27
|
+
end
|
28
|
+
|
29
|
+
# @!visibility private
|
30
|
+
def execute_task(completion) # rubocop:disable Metrics/MethodLength
|
31
|
+
return nil unless @running.true?
|
32
|
+
|
33
|
+
timeout_task = -> { timeout_task(completion) }
|
34
|
+
|
35
|
+
Concurrent::ScheduledTask.execute(
|
36
|
+
timeout_interval,
|
37
|
+
args: [completion],
|
38
|
+
&timeout_task
|
39
|
+
)
|
40
|
+
@thread_completed = Concurrent::Event.new
|
41
|
+
|
42
|
+
@value = @reason = nil
|
43
|
+
@executor.post do
|
44
|
+
@value = @task.call(self)
|
45
|
+
rescue Exception => ex # rubocop:disable Lint/RescueException
|
46
|
+
@reason = ex
|
47
|
+
ensure
|
48
|
+
@thread_completed.set
|
49
|
+
end
|
50
|
+
|
51
|
+
@thread_completed.wait
|
52
|
+
|
53
|
+
if completion.try?
|
54
|
+
schedule_next_task
|
55
|
+
time = Time.now
|
56
|
+
observers.notify_observers do
|
57
|
+
[time, value, @reason]
|
58
|
+
end
|
59
|
+
end
|
60
|
+
nil
|
61
|
+
end
|
62
|
+
|
63
|
+
# @!visibility private
|
64
|
+
def timeout_task(completion)
|
65
|
+
return unless @running.true?
|
66
|
+
return unless completion.try?
|
67
|
+
|
68
|
+
@executor.kill
|
69
|
+
@executor.wait_for_termination
|
70
|
+
@executor = Concurrent::RubySingleThreadExecutor.new
|
71
|
+
|
72
|
+
@thread_completed.set
|
73
|
+
|
74
|
+
schedule_next_task
|
75
|
+
observers.notify_observers(Time.now, nil, Concurrent::TimeoutError.new)
|
76
|
+
end
|
77
|
+
end
|
78
|
+
end
|
@@ -0,0 +1,58 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module SidekiqUniqueJobs
|
4
|
+
# Handles timing of things
|
5
|
+
#
|
6
|
+
# @author Mikael Henriksson <mikael@mhenrixon.com>
|
7
|
+
module Timing
|
8
|
+
module_function
|
9
|
+
|
10
|
+
#
|
11
|
+
# Used for timing method calls
|
12
|
+
#
|
13
|
+
#
|
14
|
+
# @return [yield return, Float]
|
15
|
+
#
|
16
|
+
def timed
|
17
|
+
start_time = time_source.call
|
18
|
+
|
19
|
+
[yield, time_source.call - start_time]
|
20
|
+
end
|
21
|
+
|
22
|
+
#
|
23
|
+
# Used to get a current representation of time as Integer
|
24
|
+
#
|
25
|
+
#
|
26
|
+
# @return [Integer]
|
27
|
+
#
|
28
|
+
def time_source
|
29
|
+
-> { (clock_stamp * 1000).to_i }
|
30
|
+
end
|
31
|
+
|
32
|
+
#
|
33
|
+
# Returns the current time as float
|
34
|
+
#
|
35
|
+
# @see SidekiqUniqueJobs.now_f
|
36
|
+
#
|
37
|
+
# @return [Float]
|
38
|
+
#
|
39
|
+
def now_f
|
40
|
+
SidekiqUniqueJobs.now_f
|
41
|
+
end
|
42
|
+
|
43
|
+
#
|
44
|
+
# Returns a float representation of the current time.
|
45
|
+
# Either from Process or Time
|
46
|
+
#
|
47
|
+
#
|
48
|
+
# @return [Float]
|
49
|
+
#
|
50
|
+
def clock_stamp
|
51
|
+
if Process.const_defined?("CLOCK_MONOTONIC")
|
52
|
+
Process.clock_gettime(Process::CLOCK_MONOTONIC)
|
53
|
+
else
|
54
|
+
Time.now.to_f
|
55
|
+
end
|
56
|
+
end
|
57
|
+
end
|
58
|
+
end
|
@@ -4,23 +4,39 @@ module SidekiqUniqueJobs
|
|
4
4
|
# Utility module to help manage unique keys in redis.
|
5
5
|
# Useful for deleting keys that for whatever reason wasn't deleted
|
6
6
|
#
|
7
|
-
# @author Mikael Henriksson <mikael@
|
7
|
+
# @author Mikael Henriksson <mikael@mhenrixon.com>
|
8
8
|
module Unlockable
|
9
9
|
module_function
|
10
10
|
|
11
11
|
# Unlocks a job.
|
12
12
|
# @param [Hash] item a Sidekiq job hash
|
13
13
|
def unlock(item)
|
14
|
-
SidekiqUniqueJobs::
|
14
|
+
SidekiqUniqueJobs::Job.add_digest(item)
|
15
15
|
SidekiqUniqueJobs::Locksmith.new(item).unlock
|
16
16
|
end
|
17
17
|
|
18
|
-
#
|
18
|
+
# Unlocks a job.
|
19
|
+
# @param [Hash] item a Sidekiq job hash
|
20
|
+
def unlock!(item)
|
21
|
+
SidekiqUniqueJobs::Job.add_digest(item)
|
22
|
+
SidekiqUniqueJobs::Locksmith.new(item).unlock!
|
23
|
+
end
|
24
|
+
|
25
|
+
# Deletes a lock unless it has ttl
|
19
26
|
#
|
20
27
|
# This is good for situations when a job is locked by another item
|
21
28
|
# @param [Hash] item a Sidekiq job hash
|
22
29
|
def delete(item)
|
23
|
-
SidekiqUniqueJobs::
|
30
|
+
SidekiqUniqueJobs::Job.add_digest(item)
|
31
|
+
SidekiqUniqueJobs::Locksmith.new(item).delete
|
32
|
+
end
|
33
|
+
|
34
|
+
# Deletes a lock regardless of if it was locked or has ttl.
|
35
|
+
#
|
36
|
+
# This is good for situations when a job is locked by another item
|
37
|
+
# @param [Hash] item a Sidekiq job hash
|
38
|
+
def delete!(item)
|
39
|
+
SidekiqUniqueJobs::Job.add_digest(item)
|
24
40
|
SidekiqUniqueJobs::Locksmith.new(item).delete!
|
25
41
|
end
|
26
42
|
end
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module SidekiqUniqueJobs
|
4
|
+
#
|
5
|
+
# Class UpdateVersion sets the right version in redis
|
6
|
+
#
|
7
|
+
# @author Mikael Henriksson <mikael@mhenrixon.com>
|
8
|
+
#
|
9
|
+
class UpdateVersion
|
10
|
+
#
|
11
|
+
# Sets the right versions in redis
|
12
|
+
#
|
13
|
+
# @note the version isn't used yet but will be for automatic upgrades
|
14
|
+
#
|
15
|
+
# @return [true] when version changed
|
16
|
+
#
|
17
|
+
def self.call
|
18
|
+
Script::Caller.call_script(
|
19
|
+
:update_version,
|
20
|
+
keys: [LIVE_VERSION, DEAD_VERSION],
|
21
|
+
argv: [SidekiqUniqueJobs.version],
|
22
|
+
)
|
23
|
+
end
|
24
|
+
end
|
25
|
+
end
|
@@ -0,0 +1,155 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module SidekiqUniqueJobs
|
4
|
+
#
|
5
|
+
# Upgrades locks between gem version upgrades
|
6
|
+
#
|
7
|
+
# @author Mikael Henriksson <mikael@mhenrixon.com>
|
8
|
+
#
|
9
|
+
class UpgradeLocks # rubocop:disable Metrics/ClassLength
|
10
|
+
#
|
11
|
+
# @return [Integer] the number of keys to batch upgrade
|
12
|
+
BATCH_SIZE = 100
|
13
|
+
#
|
14
|
+
# @return [Array<String>] suffixes for old version
|
15
|
+
OLD_SUFFIXES = %w[
|
16
|
+
GRABBED
|
17
|
+
AVAILABLE
|
18
|
+
EXISTS
|
19
|
+
VERSION
|
20
|
+
].freeze
|
21
|
+
|
22
|
+
include SidekiqUniqueJobs::Logging
|
23
|
+
include SidekiqUniqueJobs::Connection
|
24
|
+
|
25
|
+
#
|
26
|
+
# Performs upgrade of old locks
|
27
|
+
#
|
28
|
+
#
|
29
|
+
# @return [Integer] the number of upgrades locks
|
30
|
+
#
|
31
|
+
def self.call
|
32
|
+
redis do |conn|
|
33
|
+
new(conn).call
|
34
|
+
end
|
35
|
+
end
|
36
|
+
|
37
|
+
attr_reader :conn
|
38
|
+
|
39
|
+
def initialize(conn)
|
40
|
+
@count = 0
|
41
|
+
@conn = conn
|
42
|
+
redis_version # Avoid pipelined calling redis_version and getting a future.
|
43
|
+
end
|
44
|
+
|
45
|
+
#
|
46
|
+
# Performs upgrade of old locks
|
47
|
+
#
|
48
|
+
#
|
49
|
+
# @return [Integer] the number of upgrades locks
|
50
|
+
#
|
51
|
+
def call
|
52
|
+
with_logging_context do
|
53
|
+
return log_info("Already upgraded to #{version}") if conn.hget(upgraded_key, version)
|
54
|
+
# TODO: Needs handling of v7.0.0 => v7.0.1 where we don't want to
|
55
|
+
return log_info("Skipping upgrade because #{DEAD_VERSION} has been set") if conn.get(DEAD_VERSION)
|
56
|
+
|
57
|
+
log_info("Start - Upgrading Locks")
|
58
|
+
|
59
|
+
upgrade_v6_locks
|
60
|
+
delete_unused_v6_keys
|
61
|
+
delete_supporting_v6_keys
|
62
|
+
|
63
|
+
conn.hset(upgraded_key, version, now_f)
|
64
|
+
log_info("Done - Upgrading Locks")
|
65
|
+
end
|
66
|
+
|
67
|
+
@count
|
68
|
+
end
|
69
|
+
|
70
|
+
private
|
71
|
+
|
72
|
+
def upgraded_key
|
73
|
+
@upgraded_key ||= "#{LIVE_VERSION}:UPGRADED"
|
74
|
+
end
|
75
|
+
|
76
|
+
def upgrade_v6_locks
|
77
|
+
log_info("Start - Converting v6 locks to v7")
|
78
|
+
conn.scan_each(match: "*:GRABBED", count: BATCH_SIZE) do |grabbed_key|
|
79
|
+
upgrade_v6_lock(grabbed_key)
|
80
|
+
@count += 1
|
81
|
+
end
|
82
|
+
log_info("Done - Converting v6 locks to v7")
|
83
|
+
end
|
84
|
+
|
85
|
+
def upgrade_v6_lock(grabbed_key)
|
86
|
+
locked_key = grabbed_key.gsub(":GRABBED", ":LOCKED")
|
87
|
+
digest = grabbed_key.gsub(":GRABBED", "")
|
88
|
+
locks = conn.hgetall(grabbed_key)
|
89
|
+
|
90
|
+
conn.pipelined do
|
91
|
+
conn.hmset(locked_key, *locks.to_a)
|
92
|
+
conn.zadd(DIGESTS, locks.values.first, digest)
|
93
|
+
end
|
94
|
+
end
|
95
|
+
|
96
|
+
def delete_unused_v6_keys
|
97
|
+
log_info("Start - Deleting v6 keys")
|
98
|
+
OLD_SUFFIXES.each do |suffix|
|
99
|
+
delete_suffix(suffix)
|
100
|
+
end
|
101
|
+
log_info("Done - Deleting v6 keys")
|
102
|
+
end
|
103
|
+
|
104
|
+
def delete_supporting_v6_keys
|
105
|
+
batch_delete("unique:keys")
|
106
|
+
end
|
107
|
+
|
108
|
+
def delete_suffix(suffix)
|
109
|
+
batch_scan(match: "*:#{suffix}", count: BATCH_SIZE) do |keys|
|
110
|
+
batch_delete(*keys)
|
111
|
+
end
|
112
|
+
end
|
113
|
+
|
114
|
+
def batch_delete(*keys)
|
115
|
+
return if keys.empty?
|
116
|
+
|
117
|
+
conn.pipelined do
|
118
|
+
if VersionCheck.satisfied?(redis_version, ">= 4.0.0")
|
119
|
+
conn.unlink(*keys)
|
120
|
+
else
|
121
|
+
conn.del(*keys)
|
122
|
+
end
|
123
|
+
end
|
124
|
+
end
|
125
|
+
|
126
|
+
def batch_scan(match:, count:)
|
127
|
+
cursor = "0"
|
128
|
+
loop do
|
129
|
+
cursor, values = conn.scan(cursor, match: match, count: count)
|
130
|
+
yield values
|
131
|
+
break if cursor == "0"
|
132
|
+
end
|
133
|
+
end
|
134
|
+
|
135
|
+
def version
|
136
|
+
SidekiqUniqueJobs.version
|
137
|
+
end
|
138
|
+
|
139
|
+
def now_f
|
140
|
+
SidekiqUniqueJobs.now_f
|
141
|
+
end
|
142
|
+
|
143
|
+
def redis_version
|
144
|
+
@redis_version ||= SidekiqUniqueJobs.config.redis_version
|
145
|
+
end
|
146
|
+
|
147
|
+
def logging_context
|
148
|
+
if logger_context_hash?
|
149
|
+
{ "uniquejobs" => :upgrade_locks }
|
150
|
+
else
|
151
|
+
"uniquejobs-upgrade_locks"
|
152
|
+
end
|
153
|
+
end
|
154
|
+
end
|
155
|
+
end
|