sidekiq-unique-jobs 6.0.6 → 6.0.25

data/README.md

@@ -1,43 +1,49 @@
-# SidekiqUniqueJobs [![Join the chat at https://gitter.im/mhenrixon/sidekiq-unique-jobs](https://badges.gitter.im/mhenrixon/sidekiq-unique-jobs.svg)](https://gitter.im/mhenrixon/sidekiq-unique-jobs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Build Status](https://travis-ci.org/mhenrixon/sidekiq-unique-jobs.png?branch=master)](https://travis-ci.org/mhenrixon/sidekiq-unique-jobs) [![Code Climate](https://codeclimate.com/github/mhenrixon/sidekiq-unique-jobs.png)](https://codeclimate.com/github/mhenrixon/sidekiq-unique-jobs) [![Test Coverage](https://codeclimate.com/github/mhenrixon/sidekiq-unique-jobs/badges/coverage.svg)](https://codeclimate.com/github/mhenrixon/sidekiq-unique-jobs/coverage)
-
-## Table of contents
-
-* [Introduction](#introduction)
-* [Documentation](#documentation)
-* [Requirements](#requirements)
-* [Installation](#installation)
-* [Support Me](#support-me)
-* [General Information](#general-information)
-* [Options](#options)
-  * [Lock Expiration](#lock-expiration)
-  * [Lock Timeout](#lock-timeout)
-  * [Unique Across Queues](#unique-across-queues)
-  * [Unique Across Workers](#unique-across-workers)
-* [Locks](#locks)
-  * [Until Executing](#until-executing)
-  * [Until Executed](#until-executed)
-  * [Until Timeout](#until-timeout)
-  * [Unique Until And While Executing](#unique-until-and-while-executing)
-  * [While Executing](#while-executing)
-* [Conflict Strategy](#conflict-strategy)
-  * [Log](#log)
-  * [Raise](#raise)
-  * [Reject](#reject)
-  * [Replace](#replace)
-  * [Reschedule](#reschedule)
-* [Usage](#usage)
-  * [Finer Control over Uniqueness](#finer-control-over-uniqueness)
-  * [After Unlock Callback](#after-unlock-callback)
-  * [Logging](#logging)
-  * [Cleanup Dead Locks](#cleanup-dead-locks)
-* [Debugging](#debugging)
-  * [Sidekiq Web](#sidekiq-web)
-    * [Show Unique Digests](#show-unique-digests)
-    * [Show keys for digest](#show-keys-for-digest)
-* [Communication](#communication)
-* [Testing](#testing)
-* [Contributing](#contributing)
-* [Contributors](#contributors)
+# SidekiqUniqueJobs [![Join the chat at https://gitter.im/mhenrixon/sidekiq-unique-jobs](https://badges.gitter.im/mhenrixon/sidekiq-unique-jobs.svg)](https://gitter.im/mhenrixon/sidekiq-unique-jobs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Build Status](https://travis-ci.com/mhenrixon/sidekiq-unique-jobs.svg?branch=v6.x)](https://travis-ci.com/mhenrixon/sidekiq-unique-jobs) [![Code Climate](https://codeclimate.com/github/mhenrixon/sidekiq-unique-jobs.png)](https://codeclimate.com/github/mhenrixon/sidekiq-unique-jobs) [![Test Coverage](https://codeclimate.com/github/mhenrixon/sidekiq-unique-jobs/badges/coverage.svg)](https://codeclimate.com/github/mhenrixon/sidekiq-unique-jobs/coverage)
+
+<!-- MarkdownTOC -->
+
+- [Introduction](#introduction)
+- [Documentation](#documentation)
+- [Requirements](#requirements)
+  - [ActiveJob](#activejob)
+  - [redis-namespace](#redis-namespace)
+- [Installation](#installation)
+- [Support Me](#support-me)
+- [General Information](#general-information)
+- [Options](#options)
+  - [Lock Expiration](#lock-expiration)
+  - [Lock Timeout](#lock-timeout)
+  - [Unique Across Queues](#unique-across-queues)
+  - [Unique Across Workers](#unique-across-workers)
+- [Locks](#locks)
+  - [Until Executing](#until-executing)
+  - [Until Executed](#until-executed)
+  - [Until Timeout](#until-timeout)
+  - [Unique Until And While Executing](#unique-until-and-while-executing)
+  - [While Executing](#while-executing)
+- [Conflict Strategy](#conflict-strategy)
+  - [Log](#log)
+  - [Raise](#raise)
+  - [Reject](#reject)
+  - [Replace](#replace)
+  - [Reschedule](#reschedule)
+- [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 Unique Digests](#show-unique-digests)
+    - [Show keys for digest](#show-keys-for-digest)
+- [Communication](#communication)
+- [Testing](#testing)
+- [Contributing](#contributing)
+- [Contributors](#contributors)
+
+<!-- /MarkdownTOC -->
 
 ## Introduction
 
@@ -45,37 +51,50 @@ The goal of this gem is to ensure your Sidekiq jobs are unique. We do this by cr
 
 ## Documentation
 
-This is the documentation for the master branch. You can find the documentation for each release by navigating to its tag: https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v5.0.10.
+This is the documentation for the master branch. You can find the documentation for each release by navigating to its tag: [v5.0.10][]
 
 Below are links to the latest major versions (4 & 5):
 
-- [v5.0.10](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v5.0.10)
-- [v4.0.18](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v4.0.18)
+- [v5.0.10][]
+- [v4.0.18][]
 
 ## Requirements
 
-See https://github.com/mperham/sidekiq#requirements for what is required. Starting from 5.0.0 only sidekiq >= 4 is supported and support for MRI <= 2.1 is dropped. ActiveJob is not supported
+See [Sidekiq requirements][] for what is required. Starting from 5.0.0 only sidekiq >= 4 and MRI >= 2.2. ActiveJob is not supported
 
-Version 6 requires Redis >= 3 and pure Sidekiq, no ActiveJob supported anymore. See [About ActiveJob](https://github.com/mhenrixon/sidekiq-unique-jobs/wiki/About-ActiveJob) for why.
+### ActiveJob
+
+Version 6 requires Redis >= 3 and pure Sidekiq, no ActiveJob supported anymore. See [About ActiveJob](https://github.com/mhenrixon/sidekiq-unique-jobs/wiki/About-ActiveJob) for why. It simply is too complex and generates more issues than I can handle given how little timer I have to spend on this project.
+
+### redis-namespace
+
+Will not be officially supported anymore. Since Mike [won't support redis-namespace](https://github.com/mperham/sidekiq/issues/3366#issuecomment-284270120) neither will I.
+
+[Read this](http://www.mikeperham.com/2017/04/10/migrating-from-redis-namespace/) for how to migrate away from namespacing.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'sidekiq-unique-jobs'
+```
+gem 'sidekiq-unique-jobs'
+```
 
 And then execute:
 
-    $ bundle
+```
+bundle
+```
 
 Or install it yourself as:
 
-    $ gem install sidekiq-unique-jobs
-
+```
+gem install sidekiq-unique-jobs
+```
 
 ## Support Me
 
-Want to show me some ❤️ for the hard work I do on this gem? You can use the following PayPal link https://paypal.me/mhenrixon. Any amount is welcome and let me tell you it feels good to be appreciated. Even a dollar makes me super excited about all of this.
+Want to show me some ❤️ for the hard work I do on this gem? You can use the following [PayPal link][]. Any amount is welcome and let me tell you it feels good to be appreciated. Even a dollar makes me super excited about all of this.
 
 ## General Information
 
@@ -87,15 +106,13 @@ See [Locking & Unlocking](https://github.com/mhenrixon/sidekiq-unique-jobs/wiki/
 
 ### Lock Expiration
 
-This is probably not the configuration option you want...
-
-Since the client and the server are disconnected and not running inside the same process, setting a lock expiration is probably not what you want. Any keys that are used by this gem WILL be removed at the time of the expiration. For jobs that are scheduled in the future the key will expire when that job is scheduled + whatever expiration you have set.
+Lock expiration is used for two things. For the `UntilExpired` job releases the lock upon expiry. This is done from the client.
 
-In previous versions there was a default expiration of 30 minutes which didn't work for a lot of long running jobs. Since version 6 there will be no expiration of any jobs from the default configuration. Please don't use `lock_expiration` unless you really know what you are doing.
+Since v6.0.11 the other locks will expire after the server is done processing.
 
 ```ruby
 sidekiq_options lock_expiration: nil # default - don't expire keys
-sidekiq_options lock_expiration: 20.days # expire this lock in 20 days
+sidekiq_options lock_expiration: 20.days.to_i # expire this lock in 20 days
 ```
 
 ### Lock Timeout
@@ -115,7 +132,7 @@ This configuration option is slightly misleading. It doesn't disregard the queue
 ```ruby
 class Worker
   include Sidekiq::Worker
-  
+
   sidekiq_options unique_across_queues: true, queue: 'default'
 
   def perform(args); end
@@ -131,7 +148,7 @@ This configuration option is slightly misleading. It doesn't disregard the worke
 ```ruby
 class WorkerOne
   include Sidekiq::Worker
-  
+
   sidekiq_options unique_across_workers: true, queue: 'default'
 
   def perform(args); end
@@ -139,17 +156,17 @@ end
 
 class WorkerTwo
   include Sidekiq::Worker
-  
+
   sidekiq_options unique_across_workers: true, queue: 'default'
 
   def perform(args); end
 end
 
 
-WorkerOne.perform_async(1) 
+WorkerOne.perform_async(1)
 # => 'the jobs unique id'
 
-WorkerTwo.perform_async(1) 
+WorkerTwo.perform_async(1)
 # => nil because WorkerOne just stole the lock
 ```
 
@@ -220,7 +237,7 @@ In the console you should see something like:
 
 ## Conflict Strategy
 
-Decides how we handle conflict. We can either reject the job to the dead queue or reschedule it. Both are useful for jobs that absolutely need to run and have been configured to use the lock `WhileExecuting` that is used only by the sidekiq server process. 
+Decides how we handle conflict. We can either reject the job to the dead queue or reschedule it. Both are useful for jobs that absolutely need to run and have been configured to use the lock `WhileExecuting` that is used only by the sidekiq server process.
 
 The last one is log which can be be used with the lock `UntilExecuted` and `UntilExpired`. Now we write a log entry saying the job could not be pushed because it is a duplicate of another job with the same arguments
 
@@ -246,9 +263,9 @@ This strategy is intended to be used with `WhileExecuting` and will push the job
 
 This strategy is intended to be used with client locks like `UntilExecuted`.
 It will delete any existing job for these arguments from retry, schedule and
-queue and retry the lock again. 
+queue and retry the lock again.
 
-This is slightly dangerous and should probably only be used for jobs that are 
+This is slightly dangerous and should probably only be used for jobs that are
 always scheduled in the future. Currently only attempting to retry one time.
 
 `sidekiq_options lock: :until_executed, on_conflict: :replace`
@@ -322,16 +339,22 @@ end
 
 ### After Unlock Callback
 
-If you need to perform any additional work after the lock has been released you can provide an `#after_unlock` instance method. The method will be called when the lock has been unlocked. Most times this means after yield but there are two exceptions to that. 
+If you need to perform any additional work after the lock has been released you can provide an `#after_unlock` instance method. The method will be called when the lock has been unlocked. Most times this means after yield but there are two exceptions to that.
 
 **Exception 1:** UntilExecuting unlocks and calls back before yielding.
 **Exception 2:** UntilExpired expires eventually, no after_unlock hook is called.
 
+**NOTE:** _It is also possible to write this code as a class method._
+
 ```ruby
 class UniqueJobWithFilterMethod
   include Sidekiq::Worker
   sidekiq_options lock: :while_executing,
 
+  def self.after_unlock
+   # block has yielded and lock is released
+  end
+
   def after_unlock
    # block has yielded and lock is released
   end
@@ -356,12 +379,12 @@ end
 
 ### Cleanup Dead Locks
 
-For sidekiq versions before 5.1 a `sidekiq_retries_exhausted` block is required per worker class.
+For sidekiq versions before 5.1 a `sidekiq_retries_exhausted` block is required per worker class. This is deprecated in Sidekiq 6.0
 
 ```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
 ```
@@ -372,11 +395,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.
@@ -391,12 +432,11 @@ require 'sidekiq_unique_jobs/web'
 mount Sidekiq::Web, at: '/sidekiq'
 ```
 
-There is no need to `require 'sidekiq/web'` since `sidekiq_unique_jobs/web` 
+There is no need to `require 'sidekiq/web'` since `sidekiq_unique_jobs/web`
 already does this.
 
 To filter/search for keys we can use the wildcard `*`. If we have a unique digest `'uniquejobs:9e9b5ce5d423d3ea470977004b50ff84` we can search for it by enter `*ff84` and it should return all digests that end with `ff84`.
 
-
 #### Show Unique Digests
 
 ![Unique Digests](assets/unique_digests_1.png)
@@ -413,7 +453,7 @@ There is a [![Join the chat at https://gitter.im/mhenrixon/sidekiq-unique-jobs](
 
 This has been probably the most confusing part of this gem. People get really confused with how unreliable the unique jobs have been. I there for decided to do what Mike is doing for sidekiq enterprise. Read the section about unique jobs.
 
-https://www.dailydrip.com/topics/sidekiq/drips/sidekiq-enterprise-unique-jobs
+[Enterprise unique jobs][]
 
 ```ruby
 SidekiqUniqueJobs.configure do |config|
@@ -443,7 +483,7 @@ RSpec.describe Workers::CoolOne do
 
     it 'prevents duplicate jobs from being scheduled' do
       SidekiqUniqueJobs.use_config(enabled: true) do
-        expect(described_class.perform_async(1)).not_to eq(nil)
+        expect(described_class.perform_in(3600, 1)).not_to eq(nil)
         expect(described_class.perform_async(1)).to eq(nil)
       end
     end
@@ -462,12 +502,18 @@ I would strongly suggest you let this gem test uniqueness. If you care about how
 ## Contributing
 
 1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+1. Create your feature branch (`git checkout -b my-new-feature`)
+1. Commit your changes (`git commit -am 'Add some feature'`)
+1. Push to the branch (`git push origin my-new-feature`)
+1. Create new Pull Request
 
+## Contributors
 
-## Contributors 
+You can find a list of contributors over on [Contributors][]
 
-You can find a list of contributors over on https://github.com/mhenrixon/sidekiq-unique-jobs/graphs/contributors
+[v5.0.10]: https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v5.0.10.
+[v4.0.18]: https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v4.0.18
+[Sidekiq requirements]: https://github.com/mperham/sidekiq#requirements
+[Enterprise unique jobs]: https://www.dailydrip.com/topics/sidekiq/drips/sidekiq-enterprise-unique-jobs
+[Contributors]: https://github.com/mhenrixon/sidekiq-unique-jobs/graphs/contributors
+[Paypal link https://paypal.me/mhenrixon]: https://paypal.me/mhenrixon

data/bin/uniquejobs

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'bundler/setup'
-require 'sidekiq_unique_jobs'
+require "bundler/setup"
+require "sidekiq_unique_jobs"
 
 SidekiqUniqueJobs::Cli.start(ARGV)

data/lib/sidekiq-unique-jobs.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-require 'sidekiq_unique_jobs'
+require "sidekiq_unique_jobs"

data/lib/sidekiq_unique_jobs/cli.rb

@@ -1,24 +1,29 @@
 # frozen_string_literal: true
 
-require 'thor'
+require "thor"
 
 module SidekiqUniqueJobs
+  #
+  # Command line interface for unique jobs
+  #
+  # @author Mikael Henriksson <mikael@zoolutions.se>
+  #
   class Cli < Thor
     def self.banner(command, _namespace = nil, _subcommand = false)
       "jobs #{@package_name} #{command.usage}"
     end
 
-    desc 'keys PATTERN', 'list all unique keys and their expiry time'
-    option :count, aliases: :c, type: :numeric, default: 1000, desc: 'The max number of keys to return'
-    def keys(pattern = '*')
+    desc "keys PATTERN", "list all unique keys and their expiry time"
+    option :count, aliases: :c, type: :numeric, default: 1000, desc: "The max number of keys to return"
+    def keys(pattern = "*")
       keys = Util.keys(pattern, options[:count])
       say "Found #{keys.size} keys matching '#{pattern}':"
       print_in_columns(keys.sort) if keys.any?
     end
 
-    desc 'del PATTERN', 'deletes unique keys from redis by pattern'
-    option :dry_run, aliases: :d, type: :boolean, desc: 'set to false to perform deletion'
-    option :count, aliases: :c, type: :numeric, default: 1000, desc: 'The max number of keys to return'
+    desc "del PATTERN", "deletes unique keys from redis by pattern"
+    option :dry_run, aliases: :d, type: :boolean, desc: "set to false to perform deletion"
+    option :count, aliases: :c, type: :numeric, default: 1000, desc: "The max number of keys to return"
     def del(pattern)
       max_count = options[:count]
       if options[:dry_run]
@@ -30,7 +35,7 @@ module SidekiqUniqueJobs
       end
     end
 
-    desc 'console', 'drop into a console with easy access to helper methods'
+    desc "console", "drop into a console with easy access to helper methods"
     def console
       say "Use `keys '*', 1000 to display the first 1000 unique keys matching '*'"
       say "Use `del '*', 1000, true (default) to see how many keys would be deleted for the pattern '*'"
@@ -41,12 +46,22 @@ module SidekiqUniqueJobs
 
     no_commands do
       def console_class
-        require 'pry'
-        Pry
-      rescue LoadError
-        require 'irb'
+        return irb if RUBY_PLATFORM == "JAVA"
+
+        pry
+      end
+
+      def irb
+        require "irb"
         IRB
       end
+
+      def pry
+        require "pry"
+        Pry
+      rescue LoadError, NameError
+        irb
+      end
     end
   end
 end

data/lib/sidekiq_unique_jobs/client/middleware.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'sidekiq_unique_jobs/server/middleware'
+require "sidekiq_unique_jobs/server/middleware"
 
 module SidekiqUniqueJobs
   module Client
@@ -38,13 +38,17 @@ module SidekiqUniqueJobs
       end
 
       def locked?
-        locked = lock.lock
-        warn_about_duplicate unless locked
-        locked
+        SidekiqUniqueJobs::Job.add_uniqueness(item)
+        SidekiqUniqueJobs.with_context(logging_context(self.class, item)) do
+          locked = lock.lock
+          warn_about_duplicate unless locked
+          locked
+        end
       end
 
       def warn_about_duplicate
         return unless log_duplicate_payload?
+
         log_warn "payload is not unique #{item}"
       end
     end

data/lib/sidekiq_unique_jobs/constants.rb

@@ -1,22 +1,33 @@
 # frozen_string_literal: true
 
+#
+# Module with constants to avoid string duplication
+#
+# @author Mikael Henriksson <mikael@zoolutions.se>
+#
 module SidekiqUniqueJobs
-  ARGS_KEY                  ||= 'args'
-  AT_KEY                    ||= 'at'
-  CLASS_KEY                 ||= 'class'
-  JID_KEY                   ||= 'jid'
-  LOCK_EXPIRATION_KEY       ||= 'lock_expiration'
-  LOCK_TIMEOUT_KEY          ||= 'lock_timeout'
-  LOG_DUPLICATE_KEY         ||= 'log_duplicate_payload'
-  QUEUE_KEY                 ||= 'queue'
-  UNIQUE_ACROSS_QUEUES_KEY  ||= 'unique_across_queues'
-  UNIQUE_ACROSS_WORKERS_KEY ||= 'unique_across_workers'
-  UNIQUE_ARGS_KEY           ||= 'unique_args'
-  UNIQUE_DIGEST_KEY         ||= 'unique_digest'
-  UNIQUE_KEY                ||= 'unique'
-  UNIQUE_SET                ||= 'unique:keys'
-  LOCK_KEY                  ||= 'lock'
-  ON_CONFLICT_KEY           ||= 'on_conflict'
-  UNIQUE_ON_ALL_QUEUES_KEY  ||= 'unique_on_all_queues' # TODO: Remove in v6.1
-  UNIQUE_PREFIX_KEY         ||= 'unique_prefix'
+  ARGS_KEY                  ||= "args"
+  APARTMENT                 ||= "apartment"
+  AT_KEY                    ||= "at"
+  CLASS_KEY                 ||= "class"
+  JAVA                      ||= "java"
+  JID_KEY                   ||= "jid"
+  LOCK_DIGEST_KEY           ||= "lock_digest"
+  LOCK_EXPIRATION_KEY       ||= "lock_expiration"
+  LOCK_TIMEOUT_KEY          ||= "lock_timeout"
+  LOCK_TTL_KEY              ||= "lock_ttl"
+  LOG_DUPLICATE_KEY         ||= "log_duplicate_payload"
+  QUEUE_KEY                 ||= "queue"
+  UNIQUE_ACROSS_QUEUES_KEY  ||= "unique_across_queues"
+  UNIQUE_ACROSS_WORKERS_KEY ||= "unique_across_workers"
+  UNIQUE_ARGS_KEY           ||= "unique_args"
+  UNIQUE_DIGEST_KEY         ||= "unique_digest"
+  UNIQUE_KEY                ||= "unique"
+  UNIQUE_SET                ||= "unique:keys"
+  LOCK_KEY                  ||= "lock"
+  ON_CONFLICT_KEY           ||= "on_conflict"
+  UNIQUE_ON_ALL_QUEUES_KEY  ||= "unique_on_all_queues" # TODO: Remove in v6.1
+  UNIQUE_PREFIX_KEY         ||= "unique_prefix"
+  RETRY_SET                 ||= "retry"
+  SCHEDULE_SET              ||= "schedule"
 end

data/lib/sidekiq_unique_jobs/digests.rb

@@ -6,12 +6,12 @@ module SidekiqUniqueJobs
   # @author Mikael Henriksson <mikael@zoolutions.se>
   module Digests
     DEFAULT_COUNT = 1_000
-    SCAN_PATTERN  = '*'
+    SCAN_PATTERN  = "*"
     CHUNK_SIZE    = 100
 
     include SidekiqUniqueJobs::Logging
     include SidekiqUniqueJobs::Connection
-    extend self # rubocop:disable Style/ModuleFunction
+    extend self
 
     # Return unique digests matching pattern
     #
@@ -25,8 +25,9 @@ module SidekiqUniqueJobs
     # Paginate unique digests
     #
     # @param [String] pattern a pattern to match with
-    # @param [Integer] page the current cursor position
-    # @param [Integer] count the maximum number to match
+    # @param [Integer] cursor the maximum number to match
+    # @param [Integer] page_size the current cursor position
+    #
     # @return [Array<String>] with unique digests
     def page(pattern: SCAN_PATTERN, cursor: 0, page_size: 100)
       redis do |conn|
@@ -54,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'
+      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
     #
@@ -79,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/job.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module SidekiqUniqueJobs
+  # Utility class to append uniqueness to the sidekiq job hash
+  #
+  # @author Mikael Henriksson <mikael@zoolutions.se>
+  module Job
+    extend self
+
+    # Adds timeout, expiration, unique_args, unique_prefix and unique_digest to the sidekiq job hash
+    # @return [void] nothing returned here matters
+    def add_uniqueness(item)
+      add_timeout_and_expiration(item)
+      add_unique_args_and_digest(item)
+    end
+
+    private
+
+    def add_timeout_and_expiration(item)
+      calculator                = SidekiqUniqueJobs::Timeout::Calculator.new(item)
+      item[LOCK_TIMEOUT_KEY]    = calculator.lock_timeout
+      item[LOCK_EXPIRATION_KEY] = calculator.lock_expiration
+    end
+
+    def add_unique_args_and_digest(item)
+      SidekiqUniqueJobs::UniqueArgs.digest(item)
+    end
+  end
+end