sidekiq-unique-jobs 6.0.16 → 6.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f068a7aab06c3cfd05f160b1c62075f5ad69d54e6f8868eec7724d402063b8d3
-  data.tar.gz: 816085f3c9e851d0666f1df0ce4b99f520fdfd7217d22bb3b0875859500bfc1e
+  metadata.gz: 5e7339c3de1638fdd81aa8d3b90d0d09a6a18caa35fc0452efb97464853b4d3f
+  data.tar.gz: 40a8a95a053e13b2bee8fc34ecd7d684d24e9b109f00412bc0f72952d71c6386
 SHA512:
-  metadata.gz: 28be9aadb717ba765bee3ac940571756da6b6acf08381cb4174a67b5b255715e60c25db310938adaa3879993ead802b693f89886d69aaaa45c2ba83d5bd9ad5c
-  data.tar.gz: 391913c288892d8753d9b3ebb8da9220e4a1cad981297c7a401eb57ce2439b0257a4ee9b0f4b015b2386d3e65bbb86dc6a3e351323e13e2cebc902306f11019d
+  metadata.gz: 2c2c01161c61bf276964c68d637352769e31d02c10bcc7ae378731797c5729ef6f72c9dcfc0eaebc670143e3355703aa2869e13bda222a0251e2149e614d27c6
+  data.tar.gz: ed733e7b12b9411ace00f2c5161e3c7c84ca039988dade9cff4900cdf01c45e42a99d565b4abcd76ce6302ba26e1818bf4fb954ec357f9d98229e4bb37098a48

data/README.md

@@ -32,6 +32,8 @@
   - [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 Unique Digests](#show-unique-digests)
@@ -376,7 +378,7 @@ For sidekiq versions before 5.1 a `sidekiq_retries_exhausted` block is required
 ```ruby
 class MyWorker
   sidekiq_retries_exhausted do |msg, _ex|
-    SidekiqUniqueJobs::Digests.del(digest: msg['unique_digest']) if msg['unique_digest']
+    SidekiqUniqueJobs::Digests.delete_by_digest(msg['unique_digest']) if msg['unique_digest']
   end
 end
 ```
@@ -387,11 +389,29 @@ Starting in v5.1, Sidekiq can also fire a global callback when a job dies:
 # this goes in your initializer
 Sidekiq.configure_server do |config|
   config.death_handlers << ->(job, _ex) do
-    SidekiqUniqueJobs::Digests.del(digest: job['unique_digest']) if job['unique_digest']
+    SidekiqUniqueJobs::Digests.delete_by_digest(job['unique_digest']) if job['unique_digest']
   end
 end
 ```
 
+### Other Sidekiq gems
+
+#### sidekiq-global_id
+
+It was reported in [#235](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/235) that the order of the Sidekiq middleware needs to be as follows.
+
+```ruby
+Sidekiq.client_middleware do |chain|
+  chain.add Sidekiq::GlobalId::ClientMiddleware
+  chain.add SidekiqUniqueJobs::Client::Middleware
+end
+
+Sidekiq.server_middleware do |chain|
+  chain.add SidekiqUniqueJobs::Server::Middleware
+  chain.add Sidekiq::GlobalId::ServerMiddleware
+end
+```
+
 ## Debugging
 
 There are several ways of removing keys that are stuck. The prefered way is by using the unique extension to `Sidekiq::Web`. The old console and command line versions still work but might be deprecated in the future. It is better to search for the digest itself and delete the keys matching that digest.

data/lib/sidekiq_unique_jobs/cli.rb

@@ -46,7 +46,10 @@ module SidekiqUniqueJobs
 
     no_commands do
       def console_class
-        return IRB if RUBY_PLATFORM == JAVA
+        if RUBY_PLATFORM == "JAVA"
+          require "irb"
+          return IRB
+        end
 
         require "pry"
         Pry

data/lib/sidekiq_unique_jobs/digests.rb

@@ -55,13 +55,39 @@ module SidekiqUniqueJobs
     # @raise [ArgumentError] when both pattern and digest are nil
     # @return [Array<String>] with unique digests
     def del(digest: nil, pattern: nil, count: DEFAULT_COUNT)
+      warn("#{self}.#{__method__} has been deprecated and will be removed in a future version")
+
       return delete_by_pattern(pattern, count: count) if pattern
       return delete_by_digest(digest) if digest
 
       raise ArgumentError, "either digest or pattern need to be provided"
     end
 
-    private
+    # Deletes unique digest either by a digest or pattern
+    #
+    # @param [String] digest the full digest to delete
+    def delete_by_digest(digest) # rubocop:disable Metrics/MethodLength
+      result, elapsed = timed do
+        Scripts.call(:delete_by_digest, nil, keys: [
+                       UNIQUE_SET,
+                       digest,
+                       "#{digest}:EXISTS",
+                       "#{digest}:GRABBED",
+                       "#{digest}:AVAILABLE",
+                       "#{digest}:VERSION",
+                       "#{digest}:RUN:EXISTS",
+                       "#{digest}:RUN:GRABBED",
+                       "#{digest}:RUN:AVAILABLE",
+                       "#{digest}:RUN:VERSION",
+                     ])
+
+        count
+      end
+
+      log_info("#{__method__}(#{digest}) completed in #{elapsed}ms")
+
+      result
+    end
 
     # Deletes unique digests by pattern
     #
@@ -80,19 +106,7 @@ module SidekiqUniqueJobs
       result
     end
 
-    # Get a total count of unique digests
-    #
-    # @param [String] digest a key pattern to match with
-    def delete_by_digest(digest)
-      result, elapsed = timed do
-        Scripts.call(:delete_by_digest, nil, keys: [UNIQUE_SET, digest])
-        count
-      end
-
-      log_info("#{__method__}(#{digest}) completed in #{elapsed}ms")
-
-      result
-    end
+    private
 
     def batch_delete(digests) # rubocop:disable Metrics/MethodLength
       redis do |conn|

data/lib/sidekiq_unique_jobs/lock/base_lock.rb

@@ -118,11 +118,11 @@ module SidekiqUniqueJobs
         return log_warn("might need to be unlocked manually") unless unlock
 
         callback_safely
-        item[JID_KEY]
       end
 
       def callback_safely
         callback&.call
+        item[JID_KEY]
       rescue StandardError
         log_warn("unlocked successfully but the #after_unlock callback failed!")
         raise

data/lib/sidekiq_unique_jobs/lock/while_executing.rb

@@ -33,14 +33,13 @@ module SidekiqUniqueJobs
       #   These jobs are locked in the server process not from the client
       # @yield to the worker class perform method
       def execute
-        return strategy.call unless locksmith.lock(item[LOCK_TIMEOUT_KEY])
+        return strategy&.call unless locksmith.lock(item[LOCK_TIMEOUT_KEY])
 
         yield
+        unlock_with_callback
       rescue Exception # rubocop:disable Lint/RescueException
         delete!
         raise
-      else
-        unlock_with_callback
       end
 
       private

data/lib/sidekiq_unique_jobs/locksmith.rb

@@ -18,7 +18,7 @@ module SidekiqUniqueJobs
       @ttl           = item[LOCK_EXPIRATION_KEY]
       @jid           = item[JID_KEY]
       @unique_digest = item[UNIQUE_DIGEST_KEY]
-      @lock_type     = item[LOCK_KEY]
+      @lock_type     = item[LOCK_KEY] || item[UNIQUE_KEY]
       @lock_type   &&= @lock_type.to_sym
       @redis_pool    = redis_pool
     end

data/lib/sidekiq_unique_jobs/on_conflict/replace.rb

@@ -35,7 +35,7 @@ module SidekiqUniqueJobs
 
       # Delete the keys belonging to the job
       def delete_lock
-        Scripts.call(:delete_by_digest, nil, keys: [UNIQUE_SET, unique_digest])
+        SidekiqUniqueJobs::Digests.delete_by_digest(unique_digest)
       end
     end
   end

data/lib/sidekiq_unique_jobs/sidekiq_worker_methods.rb

@@ -29,7 +29,7 @@ module SidekiqUniqueJobs
     # The Sidekiq::Worker implementation
     # @return [Sidekiq::Worker]
     def worker_class
-      @_worker_class ||= worker_class_constantize # rubocop:disable Naming/MemoizedInstanceVariableName
+      @_worker_class ||= worker_class_constantize(@worker_class) # rubocop:disable Naming/MemoizedInstanceVariableName
     end
 
     # The hook to call after a successful unlock
@@ -42,8 +42,9 @@ module SidekiqUniqueJobs
     # failing back to the original argument when the constant can't be found
     #
     # @return [Sidekiq::Worker]
-    def worker_class_constantize(klazz = @worker_class)
-      return klazz unless klazz.is_a?(String)
+    def worker_class_constantize(klazz)
+      return klazz.class if klazz.is_a?(Sidekiq::Worker) # sidekiq v6.x
+      return klazz       unless klazz.is_a?(String)
 
       Object.const_get(klazz)
     rescue NameError => ex

data/lib/sidekiq_unique_jobs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SidekiqUniqueJobs
-  VERSION = "6.0.16"
+  VERSION = "6.0.19"
 end

data/lib/sidekiq_unique_jobs/version_check.rb

@@ -7,7 +7,7 @@ module SidekiqUniqueJobs
   # @author Mikael Henriksson <mikael@zoolutions.se>
   #
   class VersionCheck
-    PATTERN = /(?<operator1>[<>=]+)?\s?(?<version1>(\d+.?)+)(\s+&&\s+)?(?<operator2>[<>=]+)?\s?(?<version2>(\d+.?)+)?/m.freeze # rubocop:disable Metrics/LineLength
+    PATTERN = /(?<operator1>[<>=]+)?\s?(?<version1>(\d+.?)+)(\s+&&\s+)?(?<operator2>[<>=]+)?\s?(?<version2>(\d+.?)+)?/m.freeze # rubocop:disable Layout/LineLength
 
     #
     # Checks if a version is consrtaint is satisfied

data/lib/sidekiq_unique_jobs/web.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
 begin
+  require "delegate"
+  require "rack"
   require "sidekiq/web"
-rescue LoadError # rubocop:disable Lint/HandleExceptions
+rescue LoadError # rubocop:disable Lint/SuppressedException
   # client-only usage
 end
 
@@ -32,7 +34,7 @@ module SidekiqUniqueJobs
       end
 
       app.get "/unique_digests/delete_all" do
-        SidekiqUniqueJobs::Digests.del(pattern: "*", count: SidekiqUniqueJobs::Digests.count)
+        SidekiqUniqueJobs::Digests.delete_by_pattern("*", count: SidekiqUniqueJobs::Digests.count)
         redirect_to :unique_digests
       end
 
@@ -44,7 +46,7 @@ module SidekiqUniqueJobs
       end
 
       app.get "/unique_digests/:digest/delete" do
-        SidekiqUniqueJobs::Digests.del(digest: params[:digest])
+        SidekiqUniqueJobs::Digests.delete_by_digest(params[:digest])
         redirect_to :unique_digests
       end
     end

data/redis/delete_by_digest.lua

@@ -1,15 +1,14 @@
 -- redis.replicate_commands();
-local unique_keys   = KEYS[1]
-local unique_digest = KEYS[2]
-
-local exists_key        = unique_digest .. ':EXISTS'
-local grabbed_key       = unique_digest .. ':GRABBED'
-local available_key     = unique_digest .. ':AVAILABLE'
-local version_key       = unique_digest .. ':VERSION'
-local run_exists_key    = unique_digest .. ':RUN:EXISTS'
-local run_grabbed_key   = unique_digest .. ':RUN:GRABBED'
-local run_available_key = unique_digest .. ':RUN:AVAILABLE'
-local run_version_key   = unique_digest .. ':RUN:VERSION'
+local unique_keys       = KEYS[1]
+local unique_digest     = KEYS[2]
+local exists_key        = KEYS[3]
+local grabbed_key       = KEYS[4]
+local available_key     = KEYS[5]
+local version_key       = KEYS[6]
+local run_exists_key    = KEYS[7]
+local run_grabbed_key   = KEYS[8]
+local run_available_key = KEYS[9]
+local run_version_key   = KEYS[10]
 
 local count = redis.call('SREM', unique_keys, unique_digest)
 redis.call('DEL', exists_key)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-unique-jobs
 version: !ruby/object:Gem::Version
-  version: 6.0.16
+  version: 6.0.19
 platform: ruby
 authors:
 - Mikael Henriksson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-22 00:00:00.000000000 Z
+date: 2020-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -296,13 +296,7 @@ metadata:
   documentation_uri: https://mhenrixon.github.io/sidekiq-unique-jobs
   source_code_uri: https://github.com/mhenrixon/sidekiq-unique-jobs
   changelog_uri: https://github.com/mhenrixon/sidekiq-unique-jobs/CHANGELOG.md
-post_install_message: |
-  Please either install v6.0.19 or change your `unique: :lock_type` to `lock: :lock_type`
-  This version will not unlock otherwise.
-
-  See: https://github.com/mhenrixon/sidekiq-unique-jobs/issues/471
-  And: https://github.com/mhenrixon/sidekiq-unique-jobs/pull/435
-  And: https://github.com/mhenrixon/sidekiq-unique-jobs/issues/471
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib