sidekiq-unique-jobs 7.0.0.beta26 → 7.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8af7c3fd6c11e4c8f0b1c5cb9978a044f85d1af36515913a645575031e89af2
-  data.tar.gz: b2347d8d8aad7e923777dedcfa8fcea51e78f3eeb07dada968da5d858b34dcc6
+  metadata.gz: 791ef31e7978f706fa00198280417ebb4f230d8bf5225f5e914cc8092b347b1e
+  data.tar.gz: b085a1ac1974d74a73248cd931eff8a387f5017e06e66a863844616e6ac29184
 SHA512:
-  metadata.gz: e879321a4c43dafc44de739bde2fa16b70d8c84d9062c99b99714b50068498619c4a82f87da53c9ccee809de1e9b61a318a04000d796090800633ce304b92135
-  data.tar.gz: c589a5c8dc2bcf304b52e21f44aff31c806a5941037e4db4dfc8f7041c114caac5ada9d898b3e245e4a870b2f585943ca4a4842dca4517ff867b2fa053273940
+  metadata.gz: 71cb338220b1d3bb77b9834f5c4fe42c48532b95bf794bbad286382f1a12297b8411276b1e802c921203a345fd25151feb22b63dd284d111eea2018f29ec4ea1
+  data.tar.gz: 7cca4aa29025359b33cd914b402c446a4e9b03cb98f3b0839732d2bae03b2503f5d3425d57cd2efbd4705a438c334b36f8dd2b60a279cf8e505b188c4a3003bc

data/CHANGELOG.md

@@ -2,7 +2,84 @@
 
 ## [Unreleased](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/HEAD)
 
-[Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v6.0.25...HEAD)
+[Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v7.0.0...HEAD)
+
+
+
+## [v7.0.0](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v7.0.0) (2021-01-20)
+
+[Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v6.0.25...v7.0.0)
+
+**Implemented enhancements:**
+
+- Give user full control over adding middleware [\#566](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/566) ([mhenrixon](https://github.com/mhenrixon))
+
+**Fixed bugs:**
+
+- Race condition in ruby reaper [\#559](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/559)
+- Fix until and while executed and improve documentation [\#397](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/397)
+- Fix 532 [\#549](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/549) ([mhenrixon](https://github.com/mhenrixon))
+
+**Closed issues:**
+
+- Rejected jobs are still displayed as 'Queued' with gem 'sidekiq-status' on /sidekiq/statuses [\#564](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/564)
+- Is it possible to have a :until\_executed lock with an expiration time? [\#524](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/524)
+
+## [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)
+
+**Implemented enhancements:**
+
+- Fix coverage reporting and add coverage [\#565](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/565) ([mhenrixon](https://github.com/mhenrixon))
+
+**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 race condition to avoid reaping active jobs [\#563](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/563) ([mhenrixon](https://github.com/mhenrixon))
+- 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:**
 
@@ -88,6 +165,7 @@
 **Fixed bugs:**
 
 - Prevent indefinitely looping entries [\#516](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/516) ([mhenrixon](https://github.com/mhenrixon))
+- Don't bypass lock\_args if arguments are empty [\#511](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/511) ([nhippenmeyer](https://github.com/nhippenmeyer))
 
 **Closed issues:**
 
@@ -169,7 +247,6 @@
 - Brpoplpush::RedisScript::LuaError: WRONGTYPE Operation against a key holding the wrong kind of value [\#491](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/491)
 - Lua script bug [\#489](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/489)
 - Reaper will delete locks for running jobs [\#488](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/488)
-- Fix access to hash members [\#496](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/496) ([mhenrixon](https://github.com/mhenrixon))
 - Fix cursor assignment [\#494](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/494) ([mhenrixon](https://github.com/mhenrixon))
 - Prevent reaping of active jobs [\#493](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/493) ([mhenrixon](https://github.com/mhenrixon))
 
@@ -187,6 +264,7 @@
 
 **Fixed bugs:**
 
+- Fix access to hash members [\#496](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/496) ([mhenrixon](https://github.com/mhenrixon))
 - Use thread-safe digest creation mechanism [\#484](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/484) ([mhenrixon](https://github.com/mhenrixon))
 
 ## [v7.0.0.beta13](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v7.0.0.beta13) (2020-03-26)
@@ -422,6 +500,7 @@
 
 **Fixed bugs:**
 
+- Include redis directory [\#430](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/430) ([mhenrixon](https://github.com/mhenrixon))
 - Allow Sidekiq::Context to be used for logging [\#429](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/429) ([mhenrixon](https://github.com/mhenrixon))
 - Fix sidekiq develop [\#426](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/426) ([mhenrixon](https://github.com/mhenrixon))
 - Reap as many orphans as advertised [\#403](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/403) ([mhenrixon](https://github.com/mhenrixon))
@@ -448,7 +527,6 @@
 
 - Duplicate job was pushed \( v6.0.13 \) [\#414](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/414)
 - Constant SidekiqUniqueJobs::Web::Digests not found [\#396](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/396)
-- Include redis directory [\#430](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/430) ([mhenrixon](https://github.com/mhenrixon))
 - Fix v6 [\#428](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/428) ([mhenrixon](https://github.com/mhenrixon))
 
 **Closed issues:**
@@ -569,7 +647,7 @@
 
 - Version 5: Job ID Hash Entries Not Removed if Unique Key Expires [\#346](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/346)
 - 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))
+- Fix the broken expiration [\#316](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/316) ([mhenrixon](https://github.com/mhenrixon))
 
 **Closed issues:**
 
@@ -591,6 +669,7 @@
 **Fixed bugs:**
 
 - Always Remove Job ID from uniquejobs Hash [\#347](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/347) ([chadrschroeder](https://github.com/chadrschroeder))
+- Convert expiration time to integer [\#330](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/330) ([dareddov](https://github.com/dareddov))
 
 **Closed issues:**
 
@@ -631,10 +710,6 @@
 
 [Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v6.0.3...v6.0.4)
 
-**Fixed bugs:**
-
-- Fix the broken expiration [\#316](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/316) ([mhenrixon](https://github.com/mhenrixon))
-
 **Closed issues:**
 
 - Question about until\_timeout with 6.0.0 [\#303](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/303)
@@ -682,6 +757,7 @@
 
 - Dead jobs [\#308](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/308) ([mhenrixon](https://github.com/mhenrixon))
 - Fix require path for sidekiq\_unique\_jobs/web [\#305](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/305) ([soundasleep](https://github.com/soundasleep))
+- Update README.md [\#300](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/300) ([pirj](https://github.com/pirj))
 
 ## [v6.0.0](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v6.0.0) (2018-07-27)
 
@@ -700,7 +776,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))
-- 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)
 
@@ -745,7 +820,6 @@
 **Fixed bugs:**
 
 - bundle exec jobs console does not work [\#253](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/253)
-- Rename command line binary [\#287](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/287) ([mhenrixon](https://github.com/mhenrixon))
 
 ## [v6.0.0.rc4](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v6.0.0.rc4) (2018-06-30)
 
@@ -756,6 +830,10 @@
 - 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))
 
+**Fixed bugs:**
+
+- Rename command line binary [\#287](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/287) ([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)
@@ -819,7 +897,6 @@
 **Implemented enhancements:**
 
 - Code smells [\#275](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/275) ([mhenrixon](https://github.com/mhenrixon))
-- Reject while scheduling [\#273](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/273) ([mhenrixon](https://github.com/mhenrixon))
 - Improve testing [\#272](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/272) ([mhenrixon](https://github.com/mhenrixon))
 
 ## [v6.0.0.beta](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v6.0.0.beta) (2018-06-17)
@@ -828,6 +905,7 @@
 
 **Implemented enhancements:**
 
+- Reject while scheduling [\#273](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/273) ([mhenrixon](https://github.com/mhenrixon))
 - Until and while executing [\#271](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/271) ([mhenrixon](https://github.com/mhenrixon))
 - Solidify master [\#270](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/270) ([mhenrixon](https://github.com/mhenrixon))
 - Minor adjustments [\#268](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/268) ([mhenrixon](https://github.com/mhenrixon))

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)
@@ -39,13 +44,15 @@
   - [replace](#replace)
   - [Reschedule](#reschedule)
   - [Custom Strategies](#custom-strategies)
-- [Usage](#usage)
+- [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)
@@ -61,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:
 
@@ -98,16 +94,83 @@ And then execute:
 bundle
 ```
 
-Or install it yourself as:
+### Add the middleware
 
-```bash
-gem install sidekiq-unique-jobs
+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.
+
+*NOTE* if you want to use the reaper you also need to configure the server middleware.
+
+[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.client_middleware do |chain|
+    chain.add SidekiqUniqueJobs::Middleware::Client
+  end
+
+  config.server_middleware do |chain|
+    chain.add SidekiqUniqueJobs::Middleware::Server
+  end
+
+  SidekiqUniqueJobs::Server.configure(config)
+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
+
+```
+
+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 `>= 5.0` (`>= 5.2` recommended)
+- Ruby:
+  - MRI `>= 2.5` (`>= 2.6` recommended)
+  - JRuby `>= 9.0` (`>= 9.2` recommended)
+  - Truffleruby
+- Redis Server `>= 3.2` (`>= 5.0` 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.
@@ -235,10 +298,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.
@@ -253,11 +316,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
@@ -278,6 +357,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
@@ -428,7 +509,7 @@ 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, 
+sidekiq_options lock: :until_and_while_executing,
                 on_conflict: { client: :log, server: :reject }
 ```
 
@@ -536,7 +617,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] ]
@@ -549,7 +630,7 @@ end
 class UniqueJobWithFilterProc
   include Sidekiq::Worker
   sidekiq_options lock: :until_executed,
-                  lock_args: ->(args) { [ args.first ] }
+                  lock_args_method: ->(args) { [ args.first ] }
 
   ...
 
@@ -561,7 +642,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
@@ -622,8 +703,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
 ```
@@ -633,18 +714,38 @@ Starting in v5.1, Sidekiq can also fire a global callback when a job dies:
 ```ruby
 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
@@ -652,12 +753,30 @@ Sidekiq.client_middleware do |chain|
 end
 
 Sidekiq.server_middleware do |chain|
-  chain.add SidekiqUniqueJobs::Middleware::Server
   chain.add Sidekiq::GlobalId::ServerMiddleware
+  chain.add SidekiqUniqueJobs::Middleware::Server
 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 SidekiqUniqueJobs::Middleware::Client
+end
+
+Sidekiq.server_middleware do |chain|
+  chain.add SidekiqUniqueJobs::Middleware::Server
+  chain.add Sidekiq::Status::ServerMiddleware, expiration: 10.minutes
+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
 
@@ -728,7 +847,6 @@ If you are not using RSpec (a lot of people prefer minitest or test unit) you ca
 assert SidekiqUniqueJobs.validate_worker!(BadWorker.get_sidekiq_options)
 ```
 
-
 ### Uniqueness
 
 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: [Enterprise unique jobs][]