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,304 @@
1
+ # frozen_string_literal: true
2
+
3
+ #
4
+ # Contains configuration and utility methods that belongs top level
5
+ #
6
+ # @author Mikael Henriksson <mikael@mhenrixon.com>
7
+ module SidekiqUniqueJobs # rubocop:disable Metrics/ModuleLength
8
+ include SidekiqUniqueJobs::Connection
9
+ extend SidekiqUniqueJobs::JSON
10
+
11
+ module_function
12
+
13
+ #
14
+ # The current configuration (See: {.configure} on how to configure)
15
+ #
16
+ #
17
+ # @return [SidekiqUniqueJobs::Config] the gem configuration
18
+ #
19
+ def config
20
+ @config ||= reset! # rubocop:disable ThreadSafety/InstanceVariableInClassMethod
21
+ end
22
+
23
+ #
24
+ # The current strategies
25
+ #
26
+ #
27
+ # @return [Hash<Symbol, SidekiqUniqueJobs::Strategy>] the configured locks
28
+ #
29
+ def strategies
30
+ config.strategies
31
+ end
32
+
33
+ #
34
+ # The current locks
35
+ #
36
+ #
37
+ # @return [Hash<Symbol, SidekiqUniqueJobs::BaseLock>] the configured locks
38
+ #
39
+ def locks
40
+ config.locks
41
+ end
42
+
43
+ #
44
+ # The current logger
45
+ #
46
+ #
47
+ # @return [Logger] the configured logger
48
+ #
49
+ def logger
50
+ config.logger
51
+ end
52
+
53
+ #
54
+ # The current gem version
55
+ #
56
+ #
57
+ # @return [String] the current gem version
58
+ #
59
+ def version
60
+ VERSION
61
+ end
62
+
63
+ #
64
+ # Set a new logger
65
+ #
66
+ # @param [Logger] other another logger
67
+ #
68
+ # @return [Logger] the new logger
69
+ #
70
+ def logger=(other)
71
+ config.logger = other
72
+ end
73
+
74
+ #
75
+ # Check if logging is enabled
76
+ #
77
+ #
78
+ # @return [true, false]
79
+ #
80
+ def logging?
81
+ config.logger_enabled
82
+ end
83
+
84
+ #
85
+ # Temporarily use another configuration and reset to the old config after yielding
86
+ #
87
+ # @param [Hash] tmp_config the temporary configuration to use
88
+ #
89
+ # @return [void]
90
+ #
91
+ # @yield control to the caller
92
+ def use_config(tmp_config = {})
93
+ raise ::ArgumentError, "#{name}.#{__method__} needs a block" unless block_given?
94
+
95
+ old_config = config.to_h
96
+ reset!
97
+ configure(tmp_config)
98
+ yield
99
+ ensure
100
+ reset!
101
+ configure(old_config.to_h)
102
+ end
103
+
104
+ #
105
+ # Resets configuration to deafult
106
+ #
107
+ #
108
+ # @return [SidekiqUniqueJobs::Config] a default gem configuration
109
+ #
110
+ def reset!
111
+ @config = SidekiqUniqueJobs::Config.default # rubocop:disable ThreadSafety/InstanceVariableInClassMethod
112
+ end
113
+
114
+ #
115
+ # Enable SidekiqUniuqeJobs either temporarily in a block or for good
116
+ #
117
+ #
118
+ # @return [true] when not given a block
119
+ # @return [true, false] the previous value of enable when given a block
120
+ #
121
+ # @yieldreturn [void] temporarily enable sidekiq unique jobs while executing a block of code
122
+ def enable!(&block)
123
+ toggle(true, &block)
124
+ end
125
+
126
+ #
127
+ # Disable SidekiqUniuqeJobs either temporarily in a block or for good
128
+ #
129
+ #
130
+ # @return [false] when not given a block
131
+ # @return [true, false] the previous value of enable when given a block
132
+ #
133
+ # @yieldreturn [void] temporarily disable sidekiq unique jobs while executing a block of code
134
+ def disable!(&block)
135
+ toggle(false, &block)
136
+ end
137
+
138
+ #
139
+ # Checks if the gem has been disabled
140
+ #
141
+ # @return [true] when config.enabled is true
142
+ # @return [false] when config.enabled is false
143
+ #
144
+ def enabled?
145
+ config.enabled
146
+ end
147
+
148
+ #
149
+ # Checks if the gem has been disabled
150
+ #
151
+ # @return [true] when config.enabled is false
152
+ # @return [false] when config.enabled is true
153
+ #
154
+ def disabled?
155
+ !enabled?
156
+ end
157
+
158
+ #
159
+ # Toggles enabled on or off
160
+ #
161
+ # @api private
162
+ # :nodoc:
163
+ def toggle(enabled)
164
+ if block_given?
165
+ enabled_was = config.enabled
166
+ config.enabled = enabled
167
+ yield
168
+ config.enabled = enabled_was
169
+ else
170
+ config.enabled = enabled
171
+ end
172
+ end
173
+
174
+ # Configure the gem
175
+ #
176
+ # This is usually called once at startup of an application
177
+ # @param [Hash] options global gem options
178
+ # @option options [Integer] :lock_timeout (default is 0)
179
+ # @option options [Integer] :lock_ttl (default is 0)
180
+ # @option options [true,false] :enabled (default is true)
181
+ # @option options [String] :lock_prefix (default is 'uniquejobs')
182
+ # @option options [Logger] :logger (default is Sidekiq.logger)
183
+ # @yield control to the caller when given block
184
+ def configure(options = {})
185
+ if block_given?
186
+ yield config
187
+ else
188
+ options.each do |key, val|
189
+ config.send(:"#{key}=", val)
190
+ end
191
+ end
192
+ end
193
+
194
+ #
195
+ # Returns the current redis version
196
+ #
197
+ #
198
+ # @return [String] a string like `5.0.2`
199
+ #
200
+ def fetch_redis_version
201
+ Sidekiq.default_configuration.redis_info["redis_version"]
202
+ end
203
+
204
+ #
205
+ # Current time as float
206
+ #
207
+ #
208
+ # @return [Float]
209
+ #
210
+ def now_f
211
+ now.to_f
212
+ end
213
+
214
+ #
215
+ # Current time
216
+ #
217
+ #
218
+ # @return [Time]
219
+ #
220
+ def now
221
+ Time.now
222
+ end
223
+
224
+ #
225
+ # Checks that the worker is valid with the given options
226
+ #
227
+ # @param [Hash] options the `sidekiq_options` to validate
228
+ #
229
+ # @return [Boolean]
230
+ #
231
+ def validate_worker(options)
232
+ raise NotUniqueWorker, options unless (lock_type = options[LOCK])
233
+
234
+ lock_class = locks[lock_type]
235
+ lock_class.validate_options(options)
236
+ end
237
+
238
+ #
239
+ # Checks that the worker is valid with the given options
240
+ #
241
+ # @param [Hash] options the `sidekiq_options` to validate
242
+ #
243
+ # @raise [InvalidWorker] when {#validate_worker} returns false or nil
244
+ #
245
+ def validate_worker!(options)
246
+ lock_config = validate_worker(options)
247
+ raise InvalidWorker, lock_config unless lock_config.errors.empty?
248
+ end
249
+
250
+ # Attempt to constantize a string worker_class argument, always
251
+ # failing back to the original argument when the constant can't be found
252
+ #
253
+ # @return [Sidekiq::Job]
254
+ def constantize(str)
255
+ return str.class if str.is_a?(Sidekiq::Job) # sidekiq v6.x
256
+ return str unless str.is_a?(String)
257
+ return Object.const_get(str) unless str.include?("::")
258
+
259
+ names = str.split("::")
260
+ names.shift if names.empty? || names.first.empty?
261
+
262
+ names.inject(Object) do |constant, name|
263
+ # the false flag limits search for name to under the constant namespace
264
+ # which mimics Rails' behaviour
265
+ constant.const_get(name, false)
266
+ end
267
+ end
268
+
269
+ # Attempt to constantize a string worker_class argument, always
270
+ # failing back to the original argument when the constant can't be found
271
+ #
272
+ # @return [Sidekiq::Job, String]
273
+ def safe_constantize(str)
274
+ constantize(str)
275
+ rescue NameError => ex
276
+ case ex.message
277
+ when /uninitialized constant/
278
+ str
279
+ else
280
+ raise
281
+ end
282
+ end
283
+
284
+ #
285
+ # Collection with notifications
286
+ #
287
+ #
288
+ # @return [Reflections]
289
+ #
290
+ def reflections
291
+ @reflections ||= Reflections.new # rubocop:disable ThreadSafety/InstanceVariableInClassMethod
292
+ end
293
+
294
+ #
295
+ # Yields notification stack for sidekiq unique jobs to configure notifications
296
+ #
297
+ #
298
+ # @return [void] <description>
299
+ #
300
+ # @yieldparam [Reflections] x used to configure notifications
301
+ def reflect
302
+ yield reflections if block_given?
303
+ end
304
+ end
@@ -0,0 +1,84 @@
1
+ # frozen_string_literal: true
2
+
3
+ module SidekiqUniqueJobs
4
+ # Module with convenience methods for the Sidekiq::Job class
5
+ #
6
+ # @author Mikael Henriksson <mikael@mhenrixon.com>
7
+ module SidekiqWorkerMethods
8
+ #
9
+ # @!attribute [r] job_class
10
+ # @return [Sidekiq::Job] The Sidekiq::Job implementation
11
+ attr_reader :job_class
12
+
13
+ # Avoids duplicating worker_class.respond_to? in multiple places
14
+ # @return [true, false]
15
+ def job_method_defined?(method_sym)
16
+ job_class.respond_to?(method_sym)
17
+ end
18
+
19
+ # Wraps #get_sidekiq_options to always work with a hash
20
+ # @return [Hash] of the worker class sidekiq options
21
+ def job_options
22
+ return {} unless sidekiq_job_class?
23
+
24
+ job_class.get_sidekiq_options.deep_stringify_keys
25
+ end
26
+
27
+ # Tests that the
28
+ # @return [true] if job_class responds to get_sidekiq_options
29
+ # @return [false] if job_class does not respond to get_sidekiq_options
30
+ def sidekiq_job_class?
31
+ job_method_defined?(:get_sidekiq_options)
32
+ end
33
+
34
+ def job_class=(obj)
35
+ # this is what was originally passed in, it can be an instance or a class depending on sidekiq version
36
+ @original_job_class = obj
37
+ @job_class = job_class_constantize(obj)
38
+ end
39
+
40
+ # The hook to call after a successful unlock
41
+ # @return [Proc]
42
+ def after_unlock_hook # rubocop:disable Metrics/MethodLength
43
+ lambda do
44
+ if @original_job_class.respond_to?(:after_unlock)
45
+ # instance method in sidekiq v6
46
+ if @original_job_class.method(:after_unlock).arity.positive? # arity check to maintain backwards compatibility
47
+ @original_job_class.after_unlock(item)
48
+ else
49
+ @original_job_class.after_unlock
50
+ end
51
+ elsif job_class.respond_to?(:after_unlock)
52
+ # class method regardless of sidekiq version
53
+ if job_class.method(:after_unlock).arity.positive? # arity check to maintain backwards compatibility
54
+ job_class.after_unlock(item)
55
+ else
56
+ job_class.after_unlock
57
+ end
58
+ end
59
+ end
60
+ end
61
+
62
+ # Attempt to constantize a string worker_class argument, always
63
+ # failing back to the original argument when the constant can't be found
64
+ #
65
+ # @return [Sidekiq::Job]
66
+ def job_class_constantize(klazz = @job_class)
67
+ SidekiqUniqueJobs.safe_constantize(klazz)
68
+ end
69
+
70
+ #
71
+ # Returns the default worker options from Sidekiq
72
+ #
73
+ #
74
+ # @return [Hash<Symbol, Object>]
75
+ #
76
+ def default_job_options
77
+ if Sidekiq.respond_to?(:default_job_options)
78
+ Sidekiq.default_job_options
79
+ else
80
+ Sidekiq.default_worker_options
81
+ end
82
+ end
83
+ end
84
+ end
@@ -1,12 +1,135 @@
1
- begin
2
- require 'mock_redis'
3
- rescue LoadError
4
- raise 'To test using Sidekiq::Testing.inline!' \
5
- ' Please add `gem "mock_redis" to your gemfile.'
6
- end
1
+ # frozen_string_literal: true
2
+
3
+ # :nocov:
4
+ # :nodoc:
5
+
6
+ require "sidekiq"
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"
12
+
13
+ #
14
+ # See Sidekiq gem for more details
15
+ #
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
+ #
24
+ def self.use_options(tmp_config = {}) # rubocop:disable Metrics/MethodLength
25
+ if respond_to?(:default_job_options)
26
+ default_job_options.clear
27
+ self.default_job_options = tmp_config
28
+ else
29
+ default_worker_options.clear
30
+ self.default_worker_options = tmp_config
31
+ end
32
+
33
+ yield
34
+ ensure
35
+ if respond_to?(:default_job_options)
36
+ default_job_options.clear
37
+ self.default_job_options = default_job_options
38
+ else
39
+ default_worker_options.clear
40
+ self.default_worker_options = DEFAULT_WORKER_OPTIONS
41
+ end
42
+ end
43
+
44
+ #
45
+ # See Sidekiq::Job in Sidekiq gem for more details
46
+ #
47
+ module Worker
48
+ #
49
+ # Adds class methods to Sidekiq::Job
50
+ #
51
+ module ClassMethods
52
+ #
53
+ # Temporarily turn a workers sidekiq_options into something different
54
+ #
55
+ # @note this method will restore the original configuration after yielding
56
+ #
57
+ # @param [Hash<Symbol, Object>] tmp_config the temporary config to use
58
+ #
59
+ def use_options(tmp_config = {})
60
+ old_options = sidekiq_options_hash.dup
61
+ sidekiq_options(old_options.merge(tmp_config))
62
+
63
+ yield
64
+ ensure
65
+ self.sidekiq_options_hash =
66
+ if Sidekiq.respond_to?(:default_job_options)
67
+ Sidekiq.default_job_options
68
+ else
69
+ DEFAULT_WORKER_OPTIONS
70
+ end
71
+
72
+ sidekiq_options(old_options)
73
+ end
74
+ end
75
+
76
+ #
77
+ # Prepends deletion of locks to clear_all
78
+ #
79
+ module Overrides
80
+ #
81
+ # Overrides sidekiq_options on the worker class to prepend validation
82
+ #
83
+ # @param [Hash] options worker options
84
+ #
85
+ # @return [void]
86
+ #
87
+ def sidekiq_options(options = {})
88
+ SidekiqUniqueJobs.validate_worker!(options) if SidekiqUniqueJobs.config.raise_on_config_error
89
+
90
+ super(options)
91
+ end
92
+
93
+ #
94
+ # Prepends deletion of locks to clear
95
+ #
96
+ module ClassMethods
97
+ #
98
+ # Clears the jobs for this worker and removes all locks
99
+ #
100
+ def clear
101
+ jobs.each do |job|
102
+ SidekiqUniqueJobs::Unlockable.unlock(job)
103
+ end
104
+
105
+ super
106
+ end
107
+ end
108
+ end
109
+
110
+ prepend Overrides
111
+
112
+ #
113
+ # Prepends methods to Sidekiq::Job
114
+ #
115
+ module ClassMethods
116
+ prepend Overrides::ClassMethods
117
+ end
118
+
119
+ #
120
+ # Prepends singleton methods to Sidekiq::Job
121
+ #
122
+ module SignletonOverrides
123
+ #
124
+ # Clears all jobs for this worker and removes all locks
125
+ #
126
+ def clear_all
127
+ super
128
+
129
+ SidekiqUniqueJobs::Digests.new.delete_by_pattern("*", count: 10_000)
130
+ end
131
+ end
7
132
 
8
- module SidekiqUniqueJobs
9
- def self.redis_mock
10
- @redis_mock ||= MockRedis.new
133
+ singleton_class.prepend SignletonOverrides
11
134
  end
12
135
  end