sidekiq-unique-jobs 3.0.11 → 8.0.10

Sign up to get free protection for your applications and to get access to all the features.
Files changed (158) hide show
  1. checksums.yaml +5 -5
  2. data/CHANGELOG.md +2163 -25
  3. data/LICENSE.txt +21 -0
  4. data/README.md +984 -47
  5. data/bin/uniquejobs +7 -0
  6. data/lib/sidekiq-unique-jobs.rb +2 -36
  7. data/lib/sidekiq_unique_jobs/batch_delete.rb +120 -0
  8. data/lib/sidekiq_unique_jobs/changelog.rb +68 -0
  9. data/lib/sidekiq_unique_jobs/cli.rb +95 -0
  10. data/lib/sidekiq_unique_jobs/config.rb +306 -33
  11. data/lib/sidekiq_unique_jobs/connection.rb +20 -0
  12. data/lib/sidekiq_unique_jobs/constants.rb +55 -0
  13. data/lib/sidekiq_unique_jobs/core_ext.rb +132 -0
  14. data/lib/sidekiq_unique_jobs/deprecation.rb +65 -0
  15. data/lib/sidekiq_unique_jobs/digests.rb +134 -0
  16. data/lib/sidekiq_unique_jobs/exceptions.rb +105 -0
  17. data/lib/sidekiq_unique_jobs/expiring_digests.rb +14 -0
  18. data/lib/sidekiq_unique_jobs/job.rb +63 -0
  19. data/lib/sidekiq_unique_jobs/json.rb +47 -0
  20. data/lib/sidekiq_unique_jobs/key.rb +98 -0
  21. data/lib/sidekiq_unique_jobs/lock/base_lock.rb +165 -0
  22. data/lib/sidekiq_unique_jobs/lock/client_validator.rb +28 -0
  23. data/lib/sidekiq_unique_jobs/lock/server_validator.rb +27 -0
  24. data/lib/sidekiq_unique_jobs/lock/until_and_while_executing.rb +71 -0
  25. data/lib/sidekiq_unique_jobs/lock/until_executed.rb +48 -0
  26. data/lib/sidekiq_unique_jobs/lock/until_executing.rb +43 -0
  27. data/lib/sidekiq_unique_jobs/lock/until_expired.rb +42 -0
  28. data/lib/sidekiq_unique_jobs/lock/validator.rb +96 -0
  29. data/lib/sidekiq_unique_jobs/lock/while_executing.rb +70 -0
  30. data/lib/sidekiq_unique_jobs/lock/while_executing_reject.rb +21 -0
  31. data/lib/sidekiq_unique_jobs/lock.rb +348 -0
  32. data/lib/sidekiq_unique_jobs/lock_args.rb +127 -0
  33. data/lib/sidekiq_unique_jobs/lock_config.rb +132 -0
  34. data/lib/sidekiq_unique_jobs/lock_digest.rb +79 -0
  35. data/lib/sidekiq_unique_jobs/lock_info.rb +68 -0
  36. data/lib/sidekiq_unique_jobs/lock_timeout.rb +62 -0
  37. data/lib/sidekiq_unique_jobs/lock_ttl.rb +77 -0
  38. data/lib/sidekiq_unique_jobs/lock_type.rb +37 -0
  39. data/lib/sidekiq_unique_jobs/locksmith.rb +390 -0
  40. data/lib/sidekiq_unique_jobs/logging/middleware_context.rb +44 -0
  41. data/lib/sidekiq_unique_jobs/logging.rb +236 -0
  42. data/lib/sidekiq_unique_jobs/lua/delete.lua +49 -0
  43. data/lib/sidekiq_unique_jobs/lua/delete_by_digest.lua +39 -0
  44. data/lib/sidekiq_unique_jobs/lua/delete_job_by_digest.lua +38 -0
  45. data/lib/sidekiq_unique_jobs/lua/find_digest_in_queues.lua +26 -0
  46. data/lib/sidekiq_unique_jobs/lua/lock.lua +108 -0
  47. data/lib/sidekiq_unique_jobs/lua/lock_until_expired.lua +92 -0
  48. data/lib/sidekiq_unique_jobs/lua/locked.lua +35 -0
  49. data/lib/sidekiq_unique_jobs/lua/queue.lua +88 -0
  50. data/lib/sidekiq_unique_jobs/lua/reap_orphans.lua +119 -0
  51. data/lib/sidekiq_unique_jobs/lua/shared/_common.lua +35 -0
  52. data/lib/sidekiq_unique_jobs/lua/shared/_current_time.lua +8 -0
  53. data/lib/sidekiq_unique_jobs/lua/shared/_delete_from_queue.lua +22 -0
  54. data/lib/sidekiq_unique_jobs/lua/shared/_delete_from_sorted_set.lua +29 -0
  55. data/lib/sidekiq_unique_jobs/lua/shared/_find_digest_in_process_set.lua +53 -0
  56. data/lib/sidekiq_unique_jobs/lua/shared/_find_digest_in_queues.lua +43 -0
  57. data/lib/sidekiq_unique_jobs/lua/shared/_find_digest_in_sorted_set.lua +24 -0
  58. data/lib/sidekiq_unique_jobs/lua/shared/_hgetall.lua +13 -0
  59. data/lib/sidekiq_unique_jobs/lua/shared/_upgrades.lua +3 -0
  60. data/lib/sidekiq_unique_jobs/lua/unlock.lua +112 -0
  61. data/lib/sidekiq_unique_jobs/lua/update_version.lua +40 -0
  62. data/lib/sidekiq_unique_jobs/lua/upgrade.lua +66 -0
  63. data/lib/sidekiq_unique_jobs/middleware/client.rb +42 -0
  64. data/lib/sidekiq_unique_jobs/middleware/server.rb +31 -0
  65. data/lib/sidekiq_unique_jobs/middleware.rb +41 -15
  66. data/lib/sidekiq_unique_jobs/normalizer.rb +17 -0
  67. data/lib/sidekiq_unique_jobs/on_conflict/log.rb +24 -0
  68. data/lib/sidekiq_unique_jobs/on_conflict/null_strategy.rb +16 -0
  69. data/lib/sidekiq_unique_jobs/on_conflict/raise.rb +17 -0
  70. data/lib/sidekiq_unique_jobs/on_conflict/reject.rb +75 -0
  71. data/lib/sidekiq_unique_jobs/on_conflict/replace.rb +82 -0
  72. data/lib/sidekiq_unique_jobs/on_conflict/reschedule.rb +39 -0
  73. data/lib/sidekiq_unique_jobs/on_conflict/strategy.rb +51 -0
  74. data/lib/sidekiq_unique_jobs/on_conflict.rb +44 -0
  75. data/lib/sidekiq_unique_jobs/options_with_fallback.rb +78 -0
  76. data/lib/sidekiq_unique_jobs/orphans/lua_reaper.rb +29 -0
  77. data/lib/sidekiq_unique_jobs/orphans/manager.rb +242 -0
  78. data/lib/sidekiq_unique_jobs/orphans/null_reaper.rb +24 -0
  79. data/lib/sidekiq_unique_jobs/orphans/observer.rb +42 -0
  80. data/lib/sidekiq_unique_jobs/orphans/reaper.rb +115 -0
  81. data/lib/sidekiq_unique_jobs/orphans/reaper_resurrector.rb +170 -0
  82. data/lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb +313 -0
  83. data/lib/sidekiq_unique_jobs/redis/entity.rb +112 -0
  84. data/lib/sidekiq_unique_jobs/redis/hash.rb +56 -0
  85. data/lib/sidekiq_unique_jobs/redis/list.rb +32 -0
  86. data/lib/sidekiq_unique_jobs/redis/set.rb +32 -0
  87. data/lib/sidekiq_unique_jobs/redis/sorted_set.rb +102 -0
  88. data/lib/sidekiq_unique_jobs/redis/string.rb +51 -0
  89. data/lib/sidekiq_unique_jobs/redis.rb +11 -0
  90. data/lib/sidekiq_unique_jobs/reflectable.rb +26 -0
  91. data/lib/sidekiq_unique_jobs/reflections.rb +79 -0
  92. data/lib/sidekiq_unique_jobs/rspec/matchers/have_valid_sidekiq_options.rb +51 -0
  93. data/lib/sidekiq_unique_jobs/rspec/matchers.rb +26 -0
  94. data/lib/sidekiq_unique_jobs/script/caller.rb +133 -0
  95. data/lib/sidekiq_unique_jobs/script/client.rb +94 -0
  96. data/lib/sidekiq_unique_jobs/script/config.rb +68 -0
  97. data/lib/sidekiq_unique_jobs/script/dsl.rb +60 -0
  98. data/lib/sidekiq_unique_jobs/script/logging.rb +95 -0
  99. data/lib/sidekiq_unique_jobs/script/lua_error.rb +96 -0
  100. data/lib/sidekiq_unique_jobs/script/script.rb +75 -0
  101. data/lib/sidekiq_unique_jobs/script/scripts.rb +123 -0
  102. data/lib/sidekiq_unique_jobs/script/template.rb +41 -0
  103. data/lib/sidekiq_unique_jobs/script/timing.rb +35 -0
  104. data/lib/sidekiq_unique_jobs/script.rb +46 -0
  105. data/lib/sidekiq_unique_jobs/server.rb +62 -0
  106. data/lib/sidekiq_unique_jobs/sidekiq_unique_ext.rb +110 -37
  107. data/lib/sidekiq_unique_jobs/sidekiq_unique_jobs.rb +304 -0
  108. data/lib/sidekiq_unique_jobs/sidekiq_worker_methods.rb +84 -0
  109. data/lib/sidekiq_unique_jobs/testing.rb +132 -9
  110. data/lib/sidekiq_unique_jobs/timer_task.rb +299 -0
  111. data/lib/sidekiq_unique_jobs/timing.rb +58 -0
  112. data/lib/sidekiq_unique_jobs/unlockable.rb +43 -0
  113. data/lib/sidekiq_unique_jobs/update_version.rb +25 -0
  114. data/lib/sidekiq_unique_jobs/upgrade_locks.rb +152 -0
  115. data/lib/sidekiq_unique_jobs/version.rb +5 -1
  116. data/lib/sidekiq_unique_jobs/version_check.rb +114 -0
  117. data/lib/sidekiq_unique_jobs/web/helpers.rb +175 -0
  118. data/lib/sidekiq_unique_jobs/web/views/_paging.erb +10 -0
  119. data/lib/sidekiq_unique_jobs/web/views/changelogs.erb +60 -0
  120. data/lib/sidekiq_unique_jobs/web/views/lock.erb +110 -0
  121. data/lib/sidekiq_unique_jobs/web/views/locks.erb +59 -0
  122. data/lib/sidekiq_unique_jobs/web.rb +109 -0
  123. data/lib/sidekiq_unique_jobs.rb +83 -0
  124. data/lib/tasks/changelog.rake +23 -0
  125. metadata +157 -126
  126. data/.gitignore +0 -10
  127. data/.rspec +0 -3
  128. data/.rubocop.yml +0 -36
  129. data/.travis.yml +0 -25
  130. data/Appraisals +0 -20
  131. data/Gemfile +0 -5
  132. data/LICENSE +0 -22
  133. data/Rakefile +0 -11
  134. data/gemfiles/sidekiq_2.15.gemfile +0 -9
  135. data/gemfiles/sidekiq_2.16.gemfile +0 -9
  136. data/gemfiles/sidekiq_2.17.gemfile +0 -9
  137. data/gemfiles/sidekiq_3.0.gemfile +0 -9
  138. data/gemfiles/sidekiq_develop.gemfile +0 -9
  139. data/lib/sidekiq_unique_jobs/connectors/redis_pool.rb +0 -11
  140. data/lib/sidekiq_unique_jobs/connectors/sidekiq_redis.rb +0 -9
  141. data/lib/sidekiq_unique_jobs/connectors/testing.rb +0 -11
  142. data/lib/sidekiq_unique_jobs/connectors.rb +0 -16
  143. data/lib/sidekiq_unique_jobs/middleware/client/strategies/testing_inline.rb +0 -25
  144. data/lib/sidekiq_unique_jobs/middleware/client/strategies/unique.rb +0 -76
  145. data/lib/sidekiq_unique_jobs/middleware/client/unique_jobs.rb +0 -39
  146. data/lib/sidekiq_unique_jobs/middleware/server/unique_jobs.rb +0 -69
  147. data/lib/sidekiq_unique_jobs/payload_helper.rb +0 -42
  148. data/sidekiq-unique-jobs.gemspec +0 -27
  149. data/spec/lib/.sidekiq_testing_enabled_spec.rb.swp +0 -0
  150. data/spec/lib/client_spec.rb +0 -173
  151. data/spec/lib/middleware/server/unique_jobs_spec.rb +0 -81
  152. data/spec/lib/sidekiq_testing_enabled_spec.rb +0 -123
  153. data/spec/lib/sidekiq_unique_ext_spec.rb +0 -70
  154. data/spec/lib/unlock_order_spec.rb +0 -64
  155. data/spec/spec_helper.rb +0 -37
  156. data/spec/support/my_worker.rb +0 -13
  157. data/spec/support/sidekiq_meta.rb +0 -17
  158. data/spec/support/unique_worker.rb +0 -13
@@ -0,0 +1,20 @@
1
+ # frozen_string_literal: true
2
+
3
+ module SidekiqUniqueJobs
4
+ # Shared module for dealing with redis connections
5
+ #
6
+ # @author Mikael Henriksson <mikael@mhenrixon.com>
7
+ module Connection
8
+ def self.included(base)
9
+ base.send(:extend, self)
10
+ end
11
+
12
+ # Creates a connection to redis
13
+ # @return [Sidekiq::RedisConnection] a connection to redis
14
+ def redis(_r_pool = nil, &block)
15
+ Sidekiq.redis do |conn|
16
+ conn.with(&block)
17
+ end
18
+ end
19
+ end
20
+ end
@@ -0,0 +1,55 @@
1
+ # frozen_string_literal: true
2
+
3
+ #
4
+ # Module with constants to avoid string duplication
5
+ #
6
+ # @author Mikael Henriksson <mikael@mhenrixon.com>
7
+ #
8
+ module SidekiqUniqueJobs
9
+ ARGS = "args"
10
+ APARTMENT = "apartment"
11
+ AT = "at"
12
+ CHANGELOGS = "uniquejobs:changelog"
13
+ CLASS = "class"
14
+ CREATED_AT = "created_at"
15
+ DEAD_VERSION = "uniquejobs:dead"
16
+ DIGESTS = "uniquejobs:digests"
17
+ EXPIRING_DIGESTS = "uniquejobs:expiring_digests"
18
+ ORPHANED_DIGESTS = "uniquejobs:orphaned_digests"
19
+ ERRORS = "errors"
20
+ JID = "jid"
21
+ LIMIT = "limit"
22
+ LIVE_VERSION = "uniquejobs:live"
23
+ LOCK = "lock"
24
+ LOCK_ARGS = "lock_args"
25
+ LOCK_ARGS_METHOD = "lock_args_method"
26
+ LOCK_DIGEST = "lock_digest"
27
+ LOCK_EXPIRATION = "lock_expiration"
28
+ LOCK_INFO = "lock_info"
29
+ LOCK_LIMIT = "lock_limit"
30
+ LOCK_PREFIX = "lock_prefix"
31
+ LOCK_TIMEOUT = "lock_timeout"
32
+ LOCK_TTL = "lock_ttl"
33
+ LOCK_TYPE = "lock_type"
34
+ ON_CLIENT_CONFLICT = "on_client_conflict"
35
+ ON_CONFLICT = "on_conflict"
36
+ ON_SERVER_CONFLICT = "on_server_conflict"
37
+ PAYLOAD = "payload"
38
+ PROCESSES = "processes"
39
+ QUEUE = "queue"
40
+ RETRY = "retry"
41
+ SCHEDULE = "schedule"
42
+ TIME = "time"
43
+ TIMEOUT = "timeout"
44
+ TTL = "ttl"
45
+ TYPE = "type"
46
+ UNIQUE = "unique"
47
+ UNIQUE_ACROSS_QUEUES = "unique_across_queues"
48
+ UNIQUE_ACROSS_WORKERS = "unique_across_workers"
49
+ UNIQUE_ARGS = "unique_args"
50
+ UNIQUE_ARGS_METHOD = "unique_args_method"
51
+ UNIQUE_DIGEST = "unique_digest"
52
+ UNIQUE_PREFIX = "unique_prefix"
53
+ UNIQUE_REAPER = "uniquejobs:reaper"
54
+ WORKER = "worker"
55
+ end
@@ -0,0 +1,132 @@
1
+ # frozen_string_literal: true
2
+
3
+ # :nocov:
4
+
5
+ #
6
+ # Monkey patches for the ruby Hash
7
+ #
8
+ class Hash
9
+ unless {}.respond_to?(:slice)
10
+ #
11
+ # Returns only the matching keys in a new hash
12
+ #
13
+ # @param [Array<String>, Array<Symbol>] keys the keys to match
14
+ #
15
+ # @return [Hash]
16
+ #
17
+ def slice(*keys)
18
+ keys.map! { |key| convert_key(key) } if respond_to?(:convert_key, true)
19
+ keys.each_with_object(self.class.new) { |k, hash| hash[k] = self[k] if key?(k) }
20
+ end
21
+ end
22
+
23
+ unless {}.respond_to?(:deep_stringify_keys)
24
+ #
25
+ # Depp converts all keys to string
26
+ #
27
+ #
28
+ # @return [Hash<String>]
29
+ #
30
+ def deep_stringify_keys
31
+ deep_transform_keys(&:to_s)
32
+ end
33
+ end
34
+
35
+ unless {}.respond_to?(:deep_transform_keys)
36
+ #
37
+ # Deep transfor all keys by yielding to the caller
38
+ #
39
+ #
40
+ # @return [Hash<String>]
41
+ #
42
+ def deep_transform_keys(&block)
43
+ _deep_transform_keys_in_object(self, &block)
44
+ end
45
+ end
46
+
47
+ unless {}.respond_to?(:stringify_keys)
48
+ #
49
+ # Converts all keys to string
50
+ #
51
+ #
52
+ # @return [Hash<String>]
53
+ #
54
+ def stringify_keys
55
+ transform_keys(&:to_s)
56
+ end
57
+ end
58
+
59
+ unless {}.respond_to?(:transform_keys)
60
+ #
61
+ # Transforms all keys by yielding to the caller
62
+ #
63
+ #
64
+ # @return [Hash]
65
+ #
66
+ def transform_keys
67
+ result = {}
68
+ each_key do |key|
69
+ result[yield(key)] = self[key]
70
+ end
71
+ result
72
+ end
73
+ end
74
+
75
+ unless {}.respond_to?(:slice!)
76
+ #
77
+ # Removes all keys not provided from the current hash and returns it
78
+ #
79
+ # @param [Array<String>, Array<Symbol>] keys the keys to match
80
+ #
81
+ # @return [Hash]
82
+ #
83
+ def slice!(*keys)
84
+ keys.map! { |key| convert_key(key) } if respond_to?(:convert_key, true)
85
+ omit = slice(*self.keys - keys)
86
+ hash = slice(*keys)
87
+ hash.default = default
88
+ hash.default_proc = default_proc if default_proc
89
+ replace(hash)
90
+ omit
91
+ end
92
+ end
93
+
94
+ private
95
+
96
+ unless {}.respond_to?(:_deep_transform_keys_in_object)
97
+ # support methods for deep transforming nested hashes and arrays
98
+ def _deep_transform_keys_in_object(object, &block)
99
+ case object
100
+ when Hash
101
+ object.each_with_object(self.class.new) do |(key, value), result|
102
+ result[yield(key)] = _deep_transform_keys_in_object(value, &block)
103
+ end
104
+ when Array
105
+ object.map { |element| _deep_transform_keys_in_object(element, &block) }
106
+ else
107
+ object
108
+ end
109
+ end
110
+ end
111
+ end
112
+
113
+ #
114
+ # Monkey patches for the ruby Array
115
+ #
116
+ class Array
117
+ unless [].respond_to?(:extract_options!)
118
+ #
119
+ # Extract the last argument if it is a hash
120
+ #
121
+ #
122
+ # @return [Hash]
123
+ #
124
+ def extract_options!
125
+ if last.is_a?(Hash) && last.instance_of?(Hash)
126
+ pop
127
+ else
128
+ {}
129
+ end
130
+ end
131
+ end
132
+ end
@@ -0,0 +1,65 @@
1
+ # frozen_string_literal: true
2
+
3
+ module SidekiqUniqueJobs
4
+ #
5
+ # Class Deprecation provides logging of deprecations
6
+ #
7
+ # @author Mikael Henriksson <mikael@mhenrixon.com>
8
+ #
9
+ class Deprecation
10
+ #
11
+ # Mute warnings from this gem in a threaded context
12
+ #
13
+ #
14
+ # @return [void] <description>
15
+ #
16
+ # @yieldreturn [void]
17
+ def self.muted
18
+ orig_val = Thread.current[:uniquejobs_mute_deprecations]
19
+ Thread.current[:uniquejobs_mute_deprecations] = true
20
+ yield
21
+ ensure
22
+ Thread.current[:uniquejobs_mute_deprecations] = orig_val
23
+ end
24
+
25
+ #
26
+ # Check if deprecation warnings have been muted
27
+ #
28
+ #
29
+ # @return [true,false]
30
+ #
31
+ def self.muted?
32
+ Thread.current[:uniquejobs_mute_deprecations] == true
33
+ end
34
+
35
+ #
36
+ # Warn about deprecation
37
+ #
38
+ # @param [String] msg a descriptive reason for why the deprecation
39
+ #
40
+ # @return [void]
41
+ #
42
+ def self.warn(msg)
43
+ return if SidekiqUniqueJobs::Deprecation.muted?
44
+
45
+ warn "DEPRECATION WARNING: #{msg}"
46
+ nil
47
+ end
48
+
49
+ #
50
+ # Warn about deprecation and provide a context
51
+ #
52
+ # @param [String] msg a descriptive reason for why the deprecation
53
+ #
54
+ # @return [void]
55
+ #
56
+ def self.warn_with_backtrace(msg)
57
+ return if SidekiqUniqueJobs::Deprecation.muted?
58
+
59
+ trace = "\n\nCALLED FROM:\n#{caller.join("\n")}"
60
+ warn(msg + trace)
61
+
62
+ nil
63
+ end
64
+ end
65
+ end
@@ -0,0 +1,134 @@
1
+ # frozen_string_literal: true
2
+
3
+ module SidekiqUniqueJobs
4
+ #
5
+ # Class Changelogs provides access to the changelog entries
6
+ #
7
+ # @author Mikael Henriksson <mikael@mhenrixon.com>
8
+ #
9
+ class Digests < Redis::SortedSet
10
+ #
11
+ # @return [Integer] the number of matches to return by default
12
+ DEFAULT_COUNT = 1_000
13
+ #
14
+ # @return [String] the default pattern to use for matching
15
+ SCAN_PATTERN = "*"
16
+ #
17
+ # @return [Array(String, String, String, String)] The empty runtime or queuetime keys.
18
+ EMPTY_KEYS_SEGMENT = ["", "", "", ""].freeze
19
+
20
+ def initialize(digests_key = DIGESTS)
21
+ super(digests_key)
22
+ end
23
+
24
+ #
25
+ # Adds a digest
26
+ #
27
+ # @param [String] digest the digest to add
28
+ #
29
+ def add(digest)
30
+ redis { |conn| conn.zadd(key, now_f, digest) }
31
+ end
32
+
33
+ # Deletes unique digests by pattern
34
+ #
35
+ # @param [String] pattern a key pattern to match with
36
+ # @param [Integer] count the maximum number
37
+ # @return [Hash<String,Float>] Hash mapping of digest matching the given pattern and score
38
+
39
+ def delete_by_pattern(pattern, count: DEFAULT_COUNT)
40
+ result, elapsed = timed do
41
+ digests = entries(pattern: pattern, count: count).keys
42
+ redis { |conn| BatchDelete.call(digests, conn) }
43
+ end
44
+
45
+ log_info("#{__method__}(#{pattern}, count: #{count}) completed in #{elapsed}ms")
46
+
47
+ result
48
+ end
49
+
50
+ # Delete unique digests by digest
51
+ # Also deletes the :AVAILABLE, :EXPIRED etc keys
52
+ #
53
+ # @param [String] digest a unique digest to delete
54
+ # @param queuetime [Boolean] Whether to delete queue locks.
55
+ # @param runtime [Boolean] Whether to delete run locks.
56
+ def delete_by_digest(digest, queuetime: true, runtime: true)
57
+ result, elapsed = timed do
58
+ call_script(
59
+ :delete_by_digest,
60
+ queuetime_keys(queuetime ? digest : nil) + runtime_keys(runtime ? digest : nil) + [key],
61
+ )
62
+ end
63
+
64
+ log_info("#{__method__}(#{digest}) completed in #{elapsed}ms")
65
+
66
+ result
67
+ end
68
+
69
+ #
70
+ # The entries in this sorted set
71
+ #
72
+ # @param [String] pattern SCAN_PATTERN the match pattern to search for
73
+ # @param [Integer] count DEFAULT_COUNT the number of entries to return
74
+ #
75
+ # @return [Array<String>] an array of digests matching the given pattern
76
+ #
77
+ def entries(pattern: SCAN_PATTERN, count: DEFAULT_COUNT)
78
+ redis { |conn| conn.zscan(key, match: pattern, count: count).to_a }.to_h
79
+ end
80
+
81
+ #
82
+ # Returns a paginated
83
+ #
84
+ # @param [Integer] cursor the cursor for this iteration
85
+ # @param [String] pattern SCAN_PATTERN the match pattern to search for
86
+ # @param [Integer] page_size 100 the size per page
87
+ #
88
+ # @return [Array<Integer, Integer, Array<Lock>>] total_size, next_cursor, locks
89
+ #
90
+ def page(cursor: 0, pattern: SCAN_PATTERN, page_size: 100)
91
+ redis do |conn|
92
+ total_size, digests = conn.multi do |pipeline|
93
+ pipeline.zcard(key)
94
+ pipeline.zscan(key, cursor, match: pattern, count: page_size)
95
+ end
96
+
97
+ # NOTE: When debugging, check the last item in the returned array.
98
+ [
99
+ total_size.to_i,
100
+ digests[0].to_i, # next_cursor
101
+ digests[1].each_slice(2).map { |digest, score| Lock.new(digest, time: score) }, # entries
102
+ ]
103
+ end
104
+ end
105
+
106
+ private
107
+
108
+ # @param digest [String, nil] The digest to form runtime keys from.
109
+ # @return [Array(String, String, String, String)] The list of runtime keys or empty strings if +digest+ was +nil+.
110
+ def runtime_keys(digest)
111
+ return EMPTY_KEYS_SEGMENT unless digest
112
+
113
+ [
114
+ "#{digest}:RUN",
115
+ "#{digest}:RUN:QUEUED",
116
+ "#{digest}:RUN:PRIMED",
117
+ "#{digest}:RUN:LOCKED",
118
+ ]
119
+ end
120
+
121
+ # @param digest [String, nil] The digest to form queuetime keys from.
122
+ # @return [Array(String, String, String, String)] The list of queuetime keys or empty strings if +digest+ was +nil+.
123
+ def queuetime_keys(digest)
124
+ return EMPTY_KEYS_SEGMENT unless digest
125
+
126
+ [
127
+ digest,
128
+ "#{digest}:QUEUED",
129
+ "#{digest}:PRIMED",
130
+ "#{digest}:LOCKED",
131
+ ]
132
+ end
133
+ end
134
+ end
@@ -0,0 +1,105 @@
1
+ # frozen_string_literal: true
2
+
3
+ module SidekiqUniqueJobs
4
+ #
5
+ # Base class for all exceptions raised from the gem
6
+ #
7
+ # @author Mikael Henriksson <mikael@mhenrixon.com>
8
+ #
9
+ class UniqueJobsError < ::RuntimeError
10
+ end
11
+
12
+ # Error raised when a Lua script fails to execute
13
+ #
14
+ # @author Mikael Henriksson <mikael@mhenrixon.com>
15
+ class Conflict < UniqueJobsError
16
+ def initialize(item)
17
+ super("Item with the key: #{item[LOCK_DIGEST]} is already scheduled or processing")
18
+ end
19
+ end
20
+
21
+ #
22
+ # Raised when no block was given
23
+ #
24
+ class NoBlockGiven < SidekiqUniqueJobs::UniqueJobsError; end
25
+
26
+ #
27
+ # Raised when a notification has been mistyped
28
+ #
29
+ class NoSuchNotificationError < UniqueJobsError; end
30
+
31
+ #
32
+ # Error raised when trying to add a duplicate lock
33
+ #
34
+ # @author Mikael Henriksson <mikael@mhenrixon.com>
35
+ #
36
+ class DuplicateLock < UniqueJobsError
37
+ end
38
+
39
+ #
40
+ # Error raised when trying to add a duplicate stragegy
41
+ #
42
+ # @author Mikael Henriksson <mikael@mhenrixon.com>
43
+ #
44
+ class DuplicateStrategy < UniqueJobsError
45
+ end
46
+
47
+ #
48
+ # Error raised when an invalid argument is given
49
+ #
50
+ # @author Mikael Henriksson <mikael@mhenrixon.com>
51
+ #
52
+ class InvalidArgument < UniqueJobsError
53
+ end
54
+
55
+ #
56
+ # Raised when a workers configuration is invalid
57
+ #
58
+ # @author Mikael Henriksson <mikael@mhenrixon.com>
59
+ #
60
+ class InvalidWorker < UniqueJobsError
61
+ def initialize(lock_config)
62
+ super(<<~FAILURE_MESSAGE)
63
+ Expected #{lock_config.worker} to have valid sidekiq options but found the following problems:
64
+ #{lock_config.errors_as_string}
65
+ FAILURE_MESSAGE
66
+ end
67
+ end
68
+
69
+ # Error raised when a Lua script fails to execute
70
+ #
71
+ # @author Mikael Henriksson <mikael@mhenrixon.com>
72
+ class InvalidUniqueArguments < UniqueJobsError
73
+ def initialize(options)
74
+ given = options[:given]
75
+ job_class = options[:job_class]
76
+ lock_args_method = options[:lock_args_method]
77
+ lock_args_meth = job_class.method(lock_args_method)
78
+ num_args = lock_args_meth.arity
79
+ source_location = lock_args_meth.source_location
80
+
81
+ super(
82
+ "#{job_class}##{lock_args_method} takes #{num_args} arguments, received #{given.inspect}" \
83
+ "\n\n" \
84
+ " #{source_location.join(':')}"
85
+ )
86
+ end
87
+ end
88
+
89
+ #
90
+ # Raised when a workers configuration is invalid
91
+ #
92
+ # @author Mikael Henriksson <mikael@mhenrixon.com>
93
+ #
94
+ class NotUniqueWorker < UniqueJobsError
95
+ def initialize(options)
96
+ super("#{options[:class]} is not configured for uniqueness. Missing the key `:lock` in #{options.inspect}")
97
+ end
98
+ end
99
+
100
+ # Error raised from {OptionsWithFallback#lock_class}
101
+ #
102
+ # @author Mikael Henriksson <mikael@mhenrixon.com>
103
+ class UnknownLock < UniqueJobsError
104
+ end
105
+ end
@@ -0,0 +1,14 @@
1
+ # frozen_string_literal: true
2
+
3
+ module SidekiqUniqueJobs
4
+ #
5
+ # Class ExpiringDigests provides access to the expiring digests used by until_expired locks
6
+ #
7
+ # @author Mikael Henriksson <mikael@mhenrixon.com>
8
+ #
9
+ class ExpiringDigests < Digests
10
+ def initialize
11
+ super(EXPIRING_DIGESTS)
12
+ end
13
+ end
14
+ end
@@ -0,0 +1,63 @@
1
+ # frozen_string_literal: true
2
+
3
+ module SidekiqUniqueJobs
4
+ # Utility class to append uniqueness to the sidekiq job hash
5
+ #
6
+ # @author Mikael Henriksson <mikael@mhenrixon.com>
7
+ module Job
8
+ extend self
9
+
10
+ # Adds lock, 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_type(item)
15
+ add_lock_timeout(item)
16
+ add_lock_ttl(item)
17
+ add_digest(item)
18
+ end
19
+
20
+ # Adds lock_args, lock_prefix and lock_digest to the sidekiq job hash
21
+ # @return [Hash] the job hash
22
+ def add_digest(item)
23
+ add_lock_prefix(item)
24
+ add_lock_args(item)
25
+ add_lock_digest(item)
26
+
27
+ item
28
+ end
29
+
30
+ private
31
+
32
+ def stringify_on_conflict_hash(item)
33
+ on_conflict = item[ON_CONFLICT]
34
+ return unless on_conflict.is_a?(Hash)
35
+
36
+ item[ON_CONFLICT] = on_conflict.deep_stringify_keys
37
+ end
38
+
39
+ def add_lock_ttl(item)
40
+ item[LOCK_TTL] = SidekiqUniqueJobs::LockTTL.calculate(item)
41
+ end
42
+
43
+ def add_lock_timeout(item)
44
+ item[LOCK_TIMEOUT] = SidekiqUniqueJobs::LockTimeout.calculate(item)
45
+ end
46
+
47
+ def add_lock_args(item)
48
+ item[LOCK_ARGS] = SidekiqUniqueJobs::LockArgs.call(item)
49
+ end
50
+
51
+ def add_lock_digest(item)
52
+ item[LOCK_DIGEST] = SidekiqUniqueJobs::LockDigest.call(item)
53
+ end
54
+
55
+ def add_lock_prefix(item)
56
+ item[LOCK_PREFIX] = SidekiqUniqueJobs.config.lock_prefix
57
+ end
58
+
59
+ def add_lock_type(item)
60
+ item[LOCK] ||= SidekiqUniqueJobs::LockType.call(item)
61
+ end
62
+ end
63
+ end
@@ -0,0 +1,47 @@
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
+ #
24
+ # Prevents trying JSON.load from raising errors given argument is a hash
25
+ #
26
+ # @param [String, Hash] string the JSON string to parse
27
+ #
28
+ # @return [Hash,Array]
29
+ #
30
+ def safe_load_json(string)
31
+ return string if string.is_a?(Hash)
32
+
33
+ load_json(string)
34
+ end
35
+
36
+ #
37
+ # Dumps an object into a JSON string
38
+ #
39
+ # @param [Object] object a JSON convertible object
40
+ #
41
+ # @return [String] a JSON string
42
+ #
43
+ def dump_json(object)
44
+ ::JSON.generate(object)
45
+ end
46
+ end
47
+ end