sidekiq-unique-jobs 7.0.0.beta25 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 616316456566100190d005a5173bd3e9aa0f5558182d9e5e9965ecffde4aea65
-  data.tar.gz: bc35728df95960b932af55737c358df8d3a18a0d5c9798d944f0f386113a35d0
+  metadata.gz: 3a0ef0c8257f0c79b137bab502492428dcbd9060b44d1b1fa754e5c591ef9185
+  data.tar.gz: '03380b590a1e077f429e2b9bce284716b6f6d891cf35a1eeb7c01e82b2b23782'
 SHA512:
-  metadata.gz: 9d3a8b690a6599d7ad0d4a9dc249aa32ab193efb41fcb4ab37825f2921376af863e8949f51341e1fccb97628213d4aa0dd215d6442c030771593b7ad9f99cc2e
-  data.tar.gz: 2a25c29067a417bdc244dfecfc9777d8c195edc98ede3367be7a93d364191f30cdd012056fe70570739e45122a9ba6d7b2a8247b5ea414b238aa7eaa1d561d33
+  metadata.gz: b7c5881985fd2b2d96a2af3ad29e39e56a1df353b888e0a10720d4bee03cebeafee05e327b5fe54f809b0a1e567f0466e5754bee4e5e0179d14ce232a39a1e8b
+  data.tar.gz: 4fa3667cb51c5b44791b10f3672dbebd5f3733adae80b512775629a29d3feed4e67c5df8ce20993fa89d4810a6ca9aef7c0922e1f03bd305e0421679316ba3f9

data/CHANGELOG.md

@@ -1,5 +1,90 @@
 # Changelog
 
+## [v7.0.0.beta29](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v7.0.0.beta29) (2021-01-16)
+
+[Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v7.0.0.beta28...v7.0.0.beta29)
+
+**Fixed bugs:**
+
+- Ruby Reaper active check incorrect [\#557](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/557)
+- Routes with authentication should work with web [\#562](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/562) ([mhenrixon](https://github.com/mhenrixon))
+
+**Closed issues:**
+
+- Can't add the lock tab o nthe website when there is authentication through devise [\#561](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/561)
+
+## [v7.0.0.beta28](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v7.0.0.beta28) (2021-01-07)
+
+[Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v7.0.0.beta27...v7.0.0.beta28)
+
+**Fixed bugs:**
+
+- lock\_args does not work when you define the lock\_args argument and default lock\_args function at the same time. [\#548](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/548)
+- incorrect `:while\_executing` behavior [\#432](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/432)
+- Fix active check for the worker hash [\#558](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/558) ([mhenrixon](https://github.com/mhenrixon))
+- Prefer lock\_prefix not unique\_prefix [\#554](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/554) ([mhenrixon](https://github.com/mhenrixon))
+- Fix issue 432 [\#552](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/552) ([mhenrixon](https://github.com/mhenrixon))
+
+## [v7.0.0.beta27](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v7.0.0.beta27) (2020-11-03)
+
+[Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v7.0.0.beta26...v7.0.0.beta27)
+
+**Implemented enhancements:**
+
+- Adds coverage for regression purposes [\#550](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/550) ([mhenrixon](https://github.com/mhenrixon))
+
+**Fixed bugs:**
+
+- Rename lock\_args to lock\_args\_method [\#551](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/551) ([mhenrixon](https://github.com/mhenrixon))
+
+**Closed issues:**
+
+- Documentation incorrect for `delete\_by\_digest` [\#547](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/547)
+- Locked jobs after kill -9 with while\_executing lock [\#546](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/546)
+
+## [v7.0.0.beta26](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v7.0.0.beta26) (2020-10-28)
+
+[Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v6.0.25...v7.0.0.beta26)
+
+**Implemented enhancements:**
+
+- How to disable Reaper [\#543](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/543)
+- Allow disabling of reaper [\#544](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/544) ([mhenrixon](https://github.com/mhenrixon))
+
+**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 +95,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)
@@ -190,10 +274,6 @@
 
 [Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v7.0.0.beta10...v7.0.0.beta11)
 
-**Fixed bugs:**
-
-- Only configure RSpec when constant is defined [\#477](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/477) ([mhenrixon](https://github.com/mhenrixon))
-
 ## [v7.0.0.beta10](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v7.0.0.beta10) (2020-03-21)
 
 [Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v6.0.19...v7.0.0.beta10)
@@ -208,6 +288,7 @@
 **Fixed bugs:**
 
 - With v6.0.18, Sidekiq doesn't run at all [\#471](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/471)
+- Only configure RSpec when constant is defined [\#477](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/477) ([mhenrixon](https://github.com/mhenrixon))
 - Fix errors\_as\_string on lock\_config.rb [\#469](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/469) ([donaldpiret](https://github.com/donaldpiret))
 
 **Merged pull requests:**
@@ -347,7 +428,6 @@
 **Fixed bugs:**
 
 - Redis is busy running script and script never terminates [\#441](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/441)
-- Make the ruby reaper plain ruby [\#443](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/443) ([mhenrixon](https://github.com/mhenrixon))
 
 **Closed issues:**
 
@@ -363,6 +443,7 @@
 
 **Fixed bugs:**
 
+- Make the ruby reaper plain ruby [\#443](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/443) ([mhenrixon](https://github.com/mhenrixon))
 - Pass redis\_version into scripts [\#431](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/431) ([mhenrixon](https://github.com/mhenrixon))
 
 **Closed issues:**
@@ -505,10 +586,6 @@
 
 [Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v6.0.7...v6.0.8)
 
-**Fixed bugs:**
-
-- Close \#359 [\#364](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/364) ([mhenrixon](https://github.com/mhenrixon))
-
 **Closed issues:**
 
 - Automatic unlock of jobs [\#362](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/362)
@@ -531,6 +608,7 @@
 **Fixed bugs:**
 
 - Version 5: Job ID Hash Entries Not Removed if Unique Key Expires [\#346](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/346)
+- Close \#359 [\#364](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/364) ([mhenrixon](https://github.com/mhenrixon))
 - Move the lpush last [\#354](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/354) ([mhenrixon](https://github.com/mhenrixon))
 - Convert expiration time to integer [\#330](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/330) ([dareddov](https://github.com/dareddov))
 
@@ -545,7 +623,6 @@
 - fix CHANGELOG syntax [\#344](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/344) ([timoschilling](https://github.com/timoschilling))
 - Define Config class inside SidekiqUniqueJobs module [\#343](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/343) ([Slike9](https://github.com/Slike9))
 - fix readme testing section [\#333](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/333) ([edmartins](https://github.com/edmartins))
-- Fix typo in documentation \[ci-skip\] [\#327](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/327) ([mhenrixon](https://github.com/mhenrixon))
 
 ## [v5.0.11](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v5.0.11) (2018-11-19)
 
@@ -590,6 +667,10 @@
 
 - Why is lock\_timeout: nil VERY DANGEROUS? [\#313](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/313)
 
+**Merged pull requests:**
+
+- Fix typo in documentation \[ci-skip\] [\#327](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/327) ([mhenrixon](https://github.com/mhenrixon))
+
 ## [v6.0.4](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v6.0.4) (2018-08-02)
 
 [Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v6.0.3...v6.0.4)
@@ -662,6 +743,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 +763,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))
 
@@ -716,13 +797,16 @@
 
 **Implemented enhancements:**
 
-- Prepare for v6 [\#286](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/286) ([mhenrixon](https://github.com/mhenrixon))
 - Only unlock not delete [\#285](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/285) ([mhenrixon](https://github.com/mhenrixon))
 
 ## [v6.0.0.rc3](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v6.0.0.rc3) (2018-06-29)
 
 [Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v6.0.0.rc2...v6.0.0.rc3)
 
+**Implemented enhancements:**
+
+- Prepare for v6 [\#286](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/286) ([mhenrixon](https://github.com/mhenrixon))
+
 **Fixed bugs:**
 
 - Fix waiting for locks [\#284](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/284) ([mhenrixon](https://github.com/mhenrixon))
@@ -735,6 +819,7 @@
 
 - Within tests: workers enqueued in the future don't clear their unique locks after being drained/executed [\#254](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/254)
 - Unexpected behavior with until\_executed [\#250](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/250)
+- Fix UntilExpired [\#278](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/278) ([mhenrixon](https://github.com/mhenrixon))
 
 **Fixed bugs:**
 
@@ -764,7 +849,6 @@
 - Legacy support [\#280](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/280)
 - Adds legacy support [\#281](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/281) ([mhenrixon](https://github.com/mhenrixon))
 - Adds guard-reek [\#279](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/279) ([mhenrixon](https://github.com/mhenrixon))
-- Fix UntilExpired [\#278](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/278) ([mhenrixon](https://github.com/mhenrixon))
 
 ## [v6.0.0.beta2](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v6.0.0.beta2) (2018-06-25)
 
@@ -1204,7 +1288,6 @@
 - Add after unlock hook [\#92](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/92) ([HParker](https://github.com/HParker))
 - Do not unlock on sidekiq shutdown [\#87](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/87) ([deltaroe](https://github.com/deltaroe))
 - Remove no-op code, protect global space from test code [\#86](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/86) ([stevenjonescgm](https://github.com/stevenjonescgm))
-- Remove unique lock when executing and clearing jobs in sidekiq fake mode [\#83](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/83) ([crberube](https://github.com/crberube))
 - Fix tests. Tests with latest sidekiq versions and ruby versions [\#82](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/82) ([simonoff](https://github.com/simonoff))
 - Duplicate Payload logging configuration [\#81](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/81) ([jprincipe](https://github.com/jprincipe))
 - output log if not unique [\#79](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/79) ([sonots](https://github.com/sonots))
@@ -1251,6 +1334,7 @@
 
 **Merged pull requests:**
 
+- Remove unique lock when executing and clearing jobs in sidekiq fake mode [\#83](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/83) ([crberube](https://github.com/crberube))
 - Refactoring connectors to use them in client and server [\#56](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/56) ([salrepe](https://github.com/salrepe))
 - Fix dependency error in inline testing connector [\#54](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/54) ([salrepe](https://github.com/salrepe))
 - Add extension to Sidekiq API that is uniqueness-aware [\#52](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/52) ([rickenharp](https://github.com/rickenharp))

data/README.md

@@ -3,9 +3,12 @@
 <!-- MarkdownTOC -->
 
 - [Introduction](#introduction)
-- [Requirements](#requirements)
-- [Installation](#installation)
+- [Usage](#usage)
+  - [Installation](#installation)
+  - [Add the middleware](#add-the-middleware)
+  - [Your first worker](#your-first-worker)
 - [Support Me](#support-me)
+- [Requirements](#requirements)
 - [General Information](#general-information)
 - [Global Configuration](#global-configuration)
   - [debug_lua](#debug_lua)
@@ -18,9 +21,11 @@
   - [reaper_count](#reaper_count)
   - [reaper_interval](#reaper_interval)
   - [reaper_timeout](#reaper_timeout)
-  - [unique_prefix](#unique_prefix)
+  - [lock_prefix](#lock_prefix)
   - [lock_info](#lock_info)
 - [Worker Configuration](#worker-configuration)
+  - [lock_info](#lock_info-1)
+  - [lock_prefix](#lock_prefix-1)
   - [lock_ttl](#lock_ttl-1)
   - [lock_timeout](#lock_timeout-1)
   - [unique_across_queues](#unique_across_queues)
@@ -33,15 +38,29 @@
   - [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-1)
+  - [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)
+    - [apartment-sidekiq](#apartment-sidekiq)
+    - [sidekiq-global_id](#sidekiq-global_id)
+    - [sidekiq-status](#sidekiq-status)
+- [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)
 
@@ -49,30 +68,19 @@
 
 ## Introduction
 
-The goal of this gem is to ensure your Sidekiq jobs are unique. We do this by creating unique keys in Redis based on how you configure uniqueness.
+This gem adds unique constraints to the sidekiq queues. The uniqueness is achieved by acquiring locks for a hash of a queue name, a worker class, and job's arguments. By default, only one lock for a given hash can be acquired. What happens when a lock can't be acquired is governed by a chosen `on_conflict`strategy.
 
 This is the documentation for the master branch. You can find the documentation for each release by navigating to its tag.
 
 Here are links to some of the old versions
 
-- [v6.0.13](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v6.0.13)
+- [v6.0.25](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v6.0.25)
 - [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)
 
-## Requirements
-
-- Sidekiq `>= 4.0` (`>= 5.2` recommended)
-- Ruby:
-  - MRI `>= 2.3` (`>= 2.5` recommended)
-  - JRuby `>= 9.0` (`>= 9.2` recommended)
-  - Truffleruby
-- Redis Server `>= 3.0.2` (`>= 3.2` recommended)
-- [ActiveJob officially not supported][48]
-- [redis-namespace officially not supported][49]
-
-See [Sidekiq requirements][24] for detailed requirements of Sidekiq itself (be sure to check the right sidekiq version).
+## Usage
 
-## Installation
+### Installation
 
 Add this line to your application's Gemfile:
 
@@ -86,16 +94,81 @@ And then execute:
 bundle
 ```
 
-Or install it yourself as:
+### Add the middleware
+
+Before v7, the middleware was configured automatically. Since some people reported issues with other gems (see [Other Sidekiq Gems](#other-sidekiq-gems)) it was decided to give full control over to the user.
+
+[A full and hopefully working example](https://github.com/mhenrixon/sidekiq-unique-jobs/blob/master/myapp/config/sidekiq.rb#L12)
+
+```ruby
+Sidekiq.configure_server do |config|
+  config.redis = { url: ENV["REDIS_URL"], driver: :hiredis }
+
+  config.server_middleware do |chain|
+    chain.add SidekiqUniqueJobs::Middleware::Server
+  end
+
+  config.error_handlers << ->(ex, ctx_hash) { p ex, ctx_hash }
+  config.death_handlers << lambda do |job, _ex|
+    digest = job["lock_digest"]
+    SidekiqUniqueJobs::Digests.delete_by_digest(digest) if digest
+  end
+end
+
+Sidekiq.configure_client do |config|
+  config.redis = { url: ENV["REDIS_URL"], driver: :hiredis }
+
+  config.client_middleware do |chain|
+    chain.add SidekiqUniqueJobs::Middleware::Client
+  end
+end
+```
+
+### Your first worker
+
+```ruby
+# frozen_string_literal: true
+
+class UntilExecutedWorker
+  include Sidekiq::Worker
+
+  sidekiq_options queue: :special,
+                  retry: false,
+                  lock: :until_executed,
+                  lock_info: true,
+                  lock_timeout: 0,
+                  lock_prefix: "special",
+                  lock_ttl: 0,
+                  lock_limit: 5
+
+  def perform
+    logger.info("cowboy")
+    sleep(1) # hardcore processing
+    logger.info("beebop")
+  end
+end
 
-```bash
-gem install sidekiq-unique-jobs
 ```
 
+You can read more about the worker configuration in [Worker Configuration](#worker-configuration) below.
+
 ## 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/mhenrixon1](https://paypal.me/mhenrixon1). 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.
 
+## Requirements
+
+- Sidekiq `>= 4.0` (`>= 5.2` recommended)
+- Ruby:
+  - MRI `>= 2.5` (`>= 2.6` recommended)
+  - JRuby `>= 9.0` (`>= 9.2` recommended)
+  - Truffleruby
+- Redis Server `>= 3.0.2` (`>= 3.2` recommended)
+- [ActiveJob officially not supported][48]
+- [redis-namespace officially not supported][49]
+
+See [Sidekiq requirements][24] for detailed requirements of Sidekiq itself (be sure to check the right sidekiq version).
+
 ## General Information
 
 See [Interaction w/ Sidekiq](https://github.com/mhenrixon/sidekiq-unique-jobs/wiki/How-this-gem-interacts-with-Sidekiq) on how the gem interacts with Sidekiq.
@@ -106,6 +179,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 +264,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
@@ -213,10 +296,10 @@ SidekiqUniqueJobs.config.reaper_timeout #=> 10
 
 The number of seconds to wait for the reaper to finish before raising a TimeoutError. This is done to ensure that the next time we reap isn't getting stuck due to the previous process already running.
 
-### unique_prefix
+### lock_prefix
 
 ```ruby
-SidekiqUniqueJobs.config.unique_prefix #=> "uniquejobs"
+SidekiqUniqueJobs.config.lock_prefix #=> "uniquejobs"
 ```
 
 Use if you want a different key prefix for the keys in redis.
@@ -231,11 +314,27 @@ Using lock info will create an additional key for the lock with a json object co
 
 ## Worker Configuration
 
+### lock_info
+
+Lock info gathers information about a specific lock. It collects things like which `lock_args` where used to compute the `lock_digest` that is used for maintaining uniqueness.
+
+```ruby
+sidekiq_options lock_info: false # this is the default, set to true to turn on
+```
+
+### lock_prefix
+
+Use if you want a different key prefix for the keys in redis.
+
+```ruby
+sidekiq_options lock_prefix: "uniquejobs" # this is the default value
+```
+
 ### lock_ttl
 
 Lock TTL decides how long to wait after the job has been successfully processed before making it possible to reuse that lock.
 
-Since `v6.0.11` the other locks will expire after the server is done processing.
+Starting from `v7` the expiration will take place when the job is pushed to the queue.
 
 ```ruby
 sidekiq_options lock_ttl: nil # default - don't expire keys
@@ -256,6 +355,8 @@ sidekiq_options lock_timeout: nil # lock indefinitely, this process won't contin
 
 This configuration option is slightly misleading. It doesn't disregard the queue on other jobs. Just on itself, this means that a worker that might schedule jobs into multiple queues will be able to have uniqueness enforced on all queues it is pushed to.
 
+This is mainly intended for `Worker.set(queue: :another).perform_async`.
+
 ```ruby
 class Worker
   include Sidekiq::Worker
@@ -383,11 +484,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 +507,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 +575,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
@@ -516,7 +615,7 @@ The method or the proc can return a modified version of args without the transie
 class UniqueJobWithFilterMethod
   include Sidekiq::Worker
   sidekiq_options lock: :until_and_while_executing,
-                  lock_args: :lock_args # this is default and will be used if such a method is defined
+                  lock_args_method: :lock_args # this is default and will be used if such a method is defined
 
   def self.lock_args(args)
     [ args[0], args[2][:type] ]
@@ -529,7 +628,7 @@ end
 class UniqueJobWithFilterProc
   include Sidekiq::Worker
   sidekiq_options lock: :until_executed,
-                  lock_args: ->(args) { [ args.first ] }
+                  lock_args_method: ->(args) { [ args.first ] }
 
   ...
 
@@ -541,7 +640,7 @@ It is possible to ensure different types of unique args based on context. I can'
 ```ruby
 class UniqueJobWithFilterMethod
   include Sidekiq::Worker
-  sidekiq_options lock: :until_and_while_executing, lock_args: :lock_args
+  sidekiq_options lock: :until_and_while_executing, lock_args_method: :lock_args
 
   def self.lock_args(args)
     if Sidekiq::ProcessSet.new.size > 1
@@ -578,6 +677,7 @@ class UniqueJobWithFilterMethod
   end
   ...
 end.
+```
 
 ### Logging
 
@@ -601,8 +701,8 @@ For sidekiq versions before 5.1 a `sidekiq_retries_exhausted` block is required
 ```ruby
 class MyWorker
   sidekiq_retries_exhausted do |msg, _ex|
-    digest = msg['unique_digest']
-    SidekiqUniqueJobs::Digests.delete_by_digest(digest) if digest
+    digest = msg['lock_digest']
+    SidekiqUniqueJobs::Digests.new.delete_by_digest(digest) if digest
   end
 end
 ```
@@ -610,21 +710,40 @@ 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']
-    SidekiqUniqueJobs::Digests.delete_by_digest(digest) if digest
+    digest = job['lock_digest']
+    SidekiqUniqueJobs::Digests.new.delete_by_digest(digest) if digest
   end
 end
 ```
 
 ### Other Sidekiq gems
 
+#### apartment-sidekiq
+
+It was reported in [#536](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/536) that the order of the Sidekiq middleware needs to be as follows.
+
+```ruby
+Sidekiq.client_middleware do |chain|
+  chain.add Apartment::Sidekiq::Middleware::Client
+  chain.add SidekiqUniqueJobs::Middleware::Client
+end
+
+Sidekiq.server_middleware do |chain|
+  chain.add Apartment::Sidekiq::Middleware::Server
+  chain.add SidekiqUniqueJobs::Middleware::Server
+end
+```
+
+The reason being that this gem needs to be configured AFTER the apartment gem or the apartment will not be able to be considered for uniqueness
+
 #### 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.
 
+For a working setup check the following [file](https://github.com/mhenrixon/sidekiq-unique-jobs/blob/master/myapp/config/sidekiq.rb#L12).
+
 ```ruby
 Sidekiq.client_middleware do |chain|
   chain.add Sidekiq::GlobalId::ClientMiddleware
@@ -637,7 +756,25 @@ Sidekiq.server_middleware do |chain|
 end
 ```
 
-For a working setup check the following [file](https://github.com/mhenrixon/sidekiq-unique-jobs/blob/945c4c4c517168d49e3f8ee952fcc9c430865635/myapp/config/initializers/sidekiq.rb#L8)
+The reason for this is that the global id needs to be set before the unique jobs middleware runs. Otherwise that won't be available for uniqueness.
+
+#### sidekiq-status
+
+It was reported in [#564](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/564) that the order of the middleware needs to be as follows.
+
+```ruby
+Sidekiq.client_middleware do |chain|
+  chain.add Sidekiq::Status::ClientMiddleware, expiration: 10.minutes
+  chain.add Sidekiq::Status::ServerMiddleware
+end
+
+Sidekiq.server_middleware do |chain|
+  chain.add Sidekiq::Status::ServerMiddleware, expiration: 10.minutes
+  chain.add SidekiqUniqueJobs::Middleware::Server
+end
+```
+
+The reason for this is that if a job is duplicated it shouldn't end up with the status middleware at all. Status is just a monitor so to prevent clashes, leftovers and ensure cleanup. The status middleware should run after uniqueness on client and before on server. This will lead to less surprises.
 
 ## Debugging
 
@@ -648,7 +785,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 +816,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