sidekiq-unique-jobs 7.0.0.beta25 → 7.0.0.beta26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 616316456566100190d005a5173bd3e9aa0f5558182d9e5e9965ecffde4aea65
-  data.tar.gz: bc35728df95960b932af55737c358df8d3a18a0d5c9798d944f0f386113a35d0
+  metadata.gz: b8af7c3fd6c11e4c8f0b1c5cb9978a044f85d1af36515913a645575031e89af2
+  data.tar.gz: b2347d8d8aad7e923777dedcfa8fcea51e78f3eeb07dada968da5d858b34dcc6
 SHA512:
-  metadata.gz: 9d3a8b690a6599d7ad0d4a9dc249aa32ab193efb41fcb4ab37825f2921376af863e8949f51341e1fccb97628213d4aa0dd215d6442c030771593b7ad9f99cc2e
-  data.tar.gz: 2a25c29067a417bdc244dfecfc9777d8c195edc98ede3367be7a93d364191f30cdd012056fe70570739e45122a9ba6d7b2a8247b5ea414b238aa7eaa1d561d33
+  metadata.gz: e879321a4c43dafc44de739bde2fa16b70d8c84d9062c99b99714b50068498619c4a82f87da53c9ccee809de1e9b61a318a04000d796090800633ce304b92135
+  data.tar.gz: c589a5c8dc2bcf304b52e21f44aff31c806a5941037e4db4dfc8f7041c114caac5ada9d898b3e245e4a870b2f585943ca4a4842dca4517ff867b2fa053273940

data/CHANGELOG.md

@@ -1,5 +1,43 @@
 # Changelog
 
+## [Unreleased](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/HEAD)
+
+[Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v6.0.25...HEAD)
+
+**Merged pull requests:**
+
+- Update sidekiq-unique-jobs.gemspec [\#542](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/542) ([sergey-alekseev](https://github.com/sergey-alekseev))
+
+## [v6.0.25](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v6.0.25) (2020-10-26)
+
+[Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v7.0.0.beta25...v6.0.25)
+
+**Implemented enhancements:**
+
+- Support apartment [\#541](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/541) ([mhenrixon](https://github.com/mhenrixon))
+- Support both instance method and class method [\#528](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/528) ([mhenrixon](https://github.com/mhenrixon))
+
+## [v7.0.0.beta25](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v7.0.0.beta25) (2020-10-26)
+
+[Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v7.0.0.beta24...v7.0.0.beta25)
+
+**Implemented enhancements:**
+
+- Bump rubocop [\#539](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/539) ([mhenrixon](https://github.com/mhenrixon))
+
+**Fixed bugs:**
+
+- Ruby reaper not working, active jobs queried incorrectly [\#537](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/537)
+- Fix RubyReaper active? [\#538](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/538) ([tanner-rutgers](https://github.com/tanner-rutgers))
+
+**Closed issues:**
+
+- ConnectionPool::TimeoutError and :until\_executed [\#535](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/535)
+
+**Merged pull requests:**
+
+- Support apartment [\#540](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/540) ([mhenrixon](https://github.com/mhenrixon))
+
 ## [v7.0.0.beta24](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v7.0.0.beta24) (2020-09-27)
 
 [Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v7.0.0.beta23...v7.0.0.beta24)
@@ -10,7 +48,6 @@
 
 **Closed issues:**
 
-- while\_executing + raise let non-unique jobs to be executed [\#534](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/534)
 - Leaked keys in version 5.0.10 [\#519](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/519)
 
 ## [v7.0.0.beta23](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v7.0.0.beta23) (2020-06-23)
@@ -662,6 +699,7 @@
 
 **Merged pull requests:**
 
+- Add more details about testing uniqueness [\#301](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/301) ([mhenrixon](https://github.com/mhenrixon))
 - Update README.md [\#300](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/300) ([pirj](https://github.com/pirj))
 
 ## [v6.0.0.rc7](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v6.0.0.rc7) (2018-07-23)
@@ -681,7 +719,6 @@
 
 **Merged pull requests:**
 
-- Add more details about testing uniqueness [\#301](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/301) ([mhenrixon](https://github.com/mhenrixon))
 - Adds changelog entry [\#299](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/299) ([mhenrixon](https://github.com/mhenrixon))
 - Fix README [\#298](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/298) ([mhenrixon](https://github.com/mhenrixon))
 

data/README.md

@@ -33,15 +33,27 @@
   - [While Executing](#while-executing)
   - [Custom Locks](#custom-locks)
 - [Conflict Strategy](#conflict-strategy)
-- [lib/strategies/my_custom_strategy.rb](#libstrategiesmy_custom_strategyrb)
-- [For rails application](#for-rails-application)
-- [config/initializers/sidekiq_unique_jobs.rb](#configinitializerssidekiq_unique_jobsrb)
-- [For other projects, whenever you prefer](#for-other-projects-whenever-you-prefer)
-- [this goes in your initializer](#this-goes-in-your-initializer)
-- [app/config/routes.rb](#appconfigroutesrb)
-- [app/workers/bad_worker.rb](#appworkersbad_workerrb)
-- [spec/workers/bad_worker_spec.rb](#specworkersbad_worker_specrb)
-- [OR](#or)
+  - [log](#log)
+  - [raise](#raise)
+  - [reject](#reject)
+  - [replace](#replace)
+  - [Reschedule](#reschedule)
+  - [Custom Strategies](#custom-strategies)
+- [Usage](#usage)
+  - [Finer Control over Uniqueness](#finer-control-over-uniqueness)
+  - [After Unlock Callback](#after-unlock-callback)
+  - [Logging](#logging)
+  - [Cleanup Dead Locks](#cleanup-dead-locks)
+  - [Other Sidekiq gems](#other-sidekiq-gems)
+    - [sidekiq-global_id](#sidekiq-global_id)
+- [Debugging](#debugging)
+  - [Sidekiq Web](#sidekiq-web)
+    - [Show Locks](#show-locks)
+    - [Show Lock](#show-lock)
+- [Communication](#communication)
+- [Testing](#testing)
+  - [Unique Sidekiq Configuration](#unique-sidekiq-configuration)
+  - [Uniqueness](#uniqueness)
 - [Contributing](#contributing)
 - [Contributors](#contributors)
 
@@ -106,6 +118,8 @@ See [Locking & Unlocking](https://github.com/mhenrixon/sidekiq-unique-jobs/wiki/
 
 The gem supports a few different configuration options that might be of interest if you run into some weird issues.
 
+Configure SidekiqUniqueJobs in an initializer or the sidekiq initializer on application startup.
+
 ```ruby
 SidekiqUniqueJobs.configure do |config|
   config.debug_lua       = true
@@ -189,6 +203,14 @@ On the other hand if I increase it to 10 000 orphaned locks per cleanup (`reaper
 
 > BUSY Redis is busy running a script. You can only call SCRIPT KILL or SHUTDOWN NOSAVE. (Redis::CommandError)
 
+If you want to disable the reaper set it to `:none`, `nil` or `false`. Actually, any value that isn't `:ruby` or `:lua` will disable the reaping.
+
+```ruby
+SidekiqUniqueJobs.config.reaper = :none
+SidekiqUniqueJobs.config.reaper = nil
+SidekiqUniqueJobs.config.reaper = false
+```
+
 ### reaper_count
 
 ```ruby
@@ -383,11 +405,9 @@ You can refer on all the locks defined in `lib/sidekiq_unique_jobs/lock/*.rb`.
 
 In order to make it available, you should call in your project startup:
 
-```ruby
-# For rails application
-# config/initializers/sidekiq_unique_jobs.rb
-# For other projects, whenever you prefer
+(For rails application config/initializers/sidekiq_unique_jobs.rb or other projects, wherever you prefer)
 
+```ruby
 SidekiqUniqueJobs.configure do |config|
   config.add_lock :my_custom_lock, Locks::MyCustomLock
 end
@@ -408,7 +428,9 @@ The last one is log which can be be used with the lock `UntilExecuted` and `Unti
 It is possible for locks to have different conflict strategy for the client and server. This is useful for `:until_and_while_executing`.
 
 ```ruby
-sidekiq_options lock: :until_and_while_executing, on_conflict: { client: :log, server: :reject }
+sidekiq_options lock: :until_and_while_executing, 
+                on_conflict: { client: :log, server: :reject }
+```
 
 ### log
 
@@ -474,11 +496,9 @@ You can refer to all the strategies defined in `lib/sidekiq_unique_jobs/on_confl
 
 In order to make it available, you should call in your project startup:
 
-```ruby
-# For rails application
-# config/initializers/sidekiq_unique_jobs.rb
-# For other projects, whenever you prefer
+(For rails application config/initializers/sidekiq_unique_jobs.rb for other projects, wherever you prefer)
 
+```ruby
 SidekiqUniqueJobs.configure do |config|
   config.add_strategy :my_custom_strategy, Strategies::MyCustomStrategy
 end
@@ -578,6 +598,7 @@ class UniqueJobWithFilterMethod
   end
   ...
 end.
+```
 
 ### Logging
 
@@ -610,7 +631,6 @@ end
 Starting in v5.1, Sidekiq can also fire a global callback when a job dies:
 
 ```ruby
-# this goes in your initializer
 Sidekiq.configure_server do |config|
   config.death_handlers << ->(job, _ex) do
     digest = job['unique_digest']
@@ -648,7 +668,7 @@ There are several ways of removing keys that are stuck. The prefered way is by u
 To use the web extension you need to require it in your routes.
 
 ```ruby
-# app/config/routes.rb
+#app/config/routes.rb
 require 'sidekiq_unique_jobs/web'
 mount Sidekiq::Web, at: '/sidekiq'
 ```
@@ -679,15 +699,15 @@ Since v7 it is possible to perform some simple validation against your workers s
 Let's take a _bad_ worker:
 
 ```ruby
-# app/workers/bad_worker.rb
+#app/workers/bad_worker.rb
 class BadWorker
   sidekiq_options lock: :while_executing, on_conflict: :replace
 end
 
-# spec/workers/bad_worker_spec.rb
+#spec/workers/bad_worker_spec.rb
 
 require "sidekiq_unique_jobs/testing"
-# OR
+#OR
 require "sidekiq_unique_jobs/rspec/matchers"
 
 RSpec.describe BadWorker do

data/lib/sidekiq_unique_jobs/batch_delete.rb

@@ -4,7 +4,7 @@ module SidekiqUniqueJobs
   #
   # Class BatchDelete provides batch deletion of digests
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   #
   class BatchDelete
     #

data/lib/sidekiq_unique_jobs/changelog.rb

@@ -4,7 +4,7 @@ module SidekiqUniqueJobs
   #
   # Class Changelogs provides access to the changelog entries
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   #
   class Changelog < Redis::SortedSet
     def initialize

data/lib/sidekiq_unique_jobs/cli.rb

@@ -6,7 +6,7 @@ module SidekiqUniqueJobs
   #
   # Command line interface for unique jobs
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   #
   class Cli < Thor
     # :nodoc:

data/lib/sidekiq_unique_jobs/connection.rb

@@ -3,7 +3,7 @@
 module SidekiqUniqueJobs
   # Shared module for dealing with redis connections
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   module Connection
     def self.included(base)
       base.send(:extend, self)

data/lib/sidekiq_unique_jobs/constants.rb

@@ -3,7 +3,7 @@
 #
 # Module with constants to avoid string duplication
 #
-# @author Mikael Henriksson <mikael@zoolutions.se>
+# @author Mikael Henriksson <mikael@mhenrixon.com>
 #
 module SidekiqUniqueJobs
   ARGS                  ||= "args"

data/lib/sidekiq_unique_jobs/digests.rb

@@ -4,7 +4,7 @@ module SidekiqUniqueJobs
   #
   # Class Changelogs provides access to the changelog entries
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   #
   class Digests < Redis::SortedSet
     #

data/lib/sidekiq_unique_jobs/exceptions.rb

@@ -4,14 +4,14 @@ module SidekiqUniqueJobs
   #
   # Base class for all exceptions raised from the gem
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   #
   class UniqueJobsError < ::RuntimeError
   end
 
   # Error raised when a Lua script fails to execute
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   class Conflict < UniqueJobsError
     def initialize(item)
       super("Item with the key: #{item[LOCK_DIGEST]} is already scheduled or processing")
@@ -21,7 +21,7 @@ module SidekiqUniqueJobs
   #
   # Error raised when trying to add a duplicate lock
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   #
   class DuplicateLock < UniqueJobsError
   end
@@ -29,7 +29,7 @@ module SidekiqUniqueJobs
   #
   # Error raised when trying to add a duplicate stragegy
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   #
   class DuplicateStrategy < UniqueJobsError
   end
@@ -37,7 +37,7 @@ module SidekiqUniqueJobs
   #
   # Error raised when an invalid argument is given
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   #
   class InvalidArgument < UniqueJobsError
   end
@@ -45,7 +45,7 @@ module SidekiqUniqueJobs
   #
   # Raised when a workers configuration is invalid
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   #
   class InvalidWorker < UniqueJobsError
     def initialize(lock_config)
@@ -58,7 +58,7 @@ module SidekiqUniqueJobs
 
   # Error raised when a Lua script fails to execute
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   class InvalidUniqueArguments < UniqueJobsError
     def initialize(options)
       given            = options[:given]
@@ -79,7 +79,7 @@ module SidekiqUniqueJobs
   #
   # Raised when a workers configuration is invalid
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   #
   class NotUniqueWorker < UniqueJobsError
     def initialize(options)
@@ -89,7 +89,7 @@ module SidekiqUniqueJobs
 
   # Error raised from {OptionsWithFallback#lock_class}
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   class UnknownLock < UniqueJobsError
   end
 end

data/lib/sidekiq_unique_jobs/job.rb

@@ -3,7 +3,7 @@
 module SidekiqUniqueJobs
   # Utility class to append uniqueness to the sidekiq job hash
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   module Job
     extend self
 

data/lib/sidekiq_unique_jobs/json.rb

@@ -3,7 +3,7 @@
 module SidekiqUniqueJobs
   # Handles loading and dumping of json
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   module JSON
     module_function
 

data/lib/sidekiq_unique_jobs/key.rb

@@ -3,7 +3,7 @@
 module SidekiqUniqueJobs
   # Key class wraps logic dealing with various lock keys
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   class Key
     #
     # @!attribute [r] digest

data/lib/sidekiq_unique_jobs/lock.rb

@@ -4,7 +4,7 @@ module SidekiqUniqueJobs
   #
   # Class Lock provides access to information about a lock
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   #
   class Lock # rubocop:disable Metrics/ClassLength
     # includes "SidekiqUniqueJobs::Connection"

data/lib/sidekiq_unique_jobs/lock/base_lock.rb

@@ -5,7 +5,7 @@ module SidekiqUniqueJobs
     # Abstract base class for locks
     #
     # @abstract
-    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
     class BaseLock
       include SidekiqUniqueJobs::Logging
 

data/lib/sidekiq_unique_jobs/lock/client_validator.rb

@@ -5,7 +5,7 @@ module SidekiqUniqueJobs
     #
     # Validates the sidekiq options for the Sidekiq client process
     #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
     #
     class ClientValidator
       #

data/lib/sidekiq_unique_jobs/lock/server_validator.rb

@@ -5,7 +5,7 @@ module SidekiqUniqueJobs
     #
     # Validates the sidekiq options for the Sidekiq server process
     #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
     #
     class ServerValidator
       #

data/lib/sidekiq_unique_jobs/lock/until_and_while_executing.rb

@@ -11,7 +11,7 @@ module SidekiqUniqueJobs
     # See {#lock} for more information about the client.
     # See {#execute} for more information about the server
     #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
     class UntilAndWhileExecuting < BaseLock
       # Executes in the Sidekiq server process
       # @yield to the worker class perform method

data/lib/sidekiq_unique_jobs/lock/until_executed.rb

@@ -6,7 +6,7 @@ module SidekiqUniqueJobs
     # - Locks on perform_in or perform_async
     # - Unlocks after yielding to the worker's perform method
     #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
     class UntilExecuted < BaseLock
       OK ||= "OK"
 

data/lib/sidekiq_unique_jobs/lock/until_executing.rb

@@ -6,7 +6,7 @@ module SidekiqUniqueJobs
     # - Locks on perform_in or perform_async
     # - Unlocks before yielding to the worker's perform method
     #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
     class UntilExecuting < BaseLock
       # Executes in the Sidekiq server process
       # @yield to the worker class perform method