sidekiq-unique-jobs 8.0.2 → 8.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 820d13b5365e9a4af437b1fecaebec61f4c07656b6aa77e49fff21186abc9088
-  data.tar.gz: 0b90028e6697ec459ff63094e063100878080ad4a18101a60b7682a554c9b5f6
+  metadata.gz: 35c1bacf5f3ad9218a2791aa90b38a9f76e98aa53891ebbfb764b948c00b21fe
+  data.tar.gz: 750b7b72457f8f58c50f3419eba36954a8a518dc77473861f8d18e5fd8542975
 SHA512:
-  metadata.gz: e1e24f2c8921566adc9339841d0ef4931f2768bf7acb207eb680cc84b11bb3671749325996c563e6a5aeb699cda33553597c6dec3451a5028c2bb83e292b82f5
-  data.tar.gz: ff870dba5ef353df17aa80ad82c58418daef5a7643d1ff6c9bece90e4d57acacdd1091fd2893e88c0e5459a14668344cfb05d9ef3640d5c25eda1650f87f2f4c
+  metadata.gz: ea41240b24e440d3042a59570665b54e8bc9ffe186e10cdf4259a7f196c86f689c149586db0a37d02f75308b91fc1aedb0641f10e4d8565a0d70c4684371ad19
+  data.tar.gz: d12af8379f1262f92fefde8ca4fe4fbf80ff7ff2cbab477c12b3440e7d0513488adc2a6b7dbbd059ea033c7688b89734af52521b39086bacd01271de66ed449c

data/CHANGELOG.md

@@ -1,5 +1,60 @@
 # Changelog
 
+## [Unreleased](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/HEAD)
+
+[Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v8.0.3...HEAD)
+
+**Closed issues:**
+
+- Redis has deprecated the `rpoplpush`command [\#793](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/793)
+- Deprecation Warning: Use of rpoplpush command in Redis [\#792](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/792)
+- Logging::Middleware.context can include empty string as key when lock is not set in job hash [\#785](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/785)
+
+## [v8.0.3](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v8.0.3) (2023-05-27)
+
+[Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v8.0.2...v8.0.3)
+
+**Implemented enhancements:**
+
+- chore\(ci\): improve matrix [\#775](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/775) ([mhenrixon](https://github.com/mhenrixon))
+- chore\(ci\): better ci job output [\#772](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/772) ([mhenrixon](https://github.com/mhenrixon))
+
+**Fixed bugs:**
+
+- Add unlocked reflect to locksmith unlock! [\#783](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/783) ([ttstarck](https://github.com/ttstarck))
+- fix\(locksmith\): replace deprecated rpoplpush w/lmove [\#781](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/781) ([GabrielaGuedes](https://github.com/GabrielaGuedes))
+- fix\(unlock\): ensure callback and unlock [\#771](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/771) ([mhenrixon](https://github.com/mhenrixon))
+
+**Closed issues:**
+
+- `unlocked` reflection is never called [\#782](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/782)
+- Migrate away from deprecated Redis commands [\#780](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/780)
+- `while_executing` with `on_conflict: :reschedule` reschedules job when unlock fails [\#770](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/770)
+- Redis server v6.0 compatibility [\#769](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/769)
+- Locks not removed after worker finishes [\#758](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/758)
+
+**Merged pull requests:**
+
+- Add lock to item when lock\_type is pulled from Job class sidekiq options [\#786](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/786) ([ttstarck](https://github.com/ttstarck))
+- Fix rubocop failure by expecting array to be empty [\#784](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/784) ([GabrielaGuedes](https://github.com/GabrielaGuedes))
+- fix\(doc\): improve information on unlock\_failed [\#776](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/776) ([mhenrixon](https://github.com/mhenrixon))
+
+## [v8.0.2](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v8.0.2) (2023-03-13)
+
+[Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v8.0.1...v8.0.2)
+
+**Closed issues:**
+
+- Missing v7.1 branch? [\#757](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/757)
+- Allow one running job but at most one job in the queue [\#748](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/748)
+
+**Merged pull requests:**
+
+- update debug\_lua check to match passed in arg type [\#765](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/765) ([JeremiahChurch](https://github.com/JeremiahChurch))
+- fix rubocop [\#764](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/764) ([JeremiahChurch](https://github.com/JeremiahChurch))
+- Hide lock info debug suggestion on lock page if it's already enabled. [\#763](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/763) ([JeremiahChurch](https://github.com/JeremiahChurch))
+- fix lock & changelog times on web interface [\#762](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/762) ([JeremiahChurch](https://github.com/JeremiahChurch))
+
 ## [v8.0.1](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v8.0.1) (2023-02-14)
 
 [Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v8.0.0...v8.0.1)

data/README.md

@@ -1,6 +1,6 @@
 # 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://github.com/mhenrixon/sidekiq-unique-jobs/actions/workflows/rspec.yml/badge.svg?branch=master) [![Code Climate](https://codeclimate.com/github/mhenrixon/sidekiq-unique-jobs.svg)](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)
+[![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://github.com/mhenrixon/sidekiq-unique-jobs/actions/workflows/rspec.yml/badge.svg?branch=main) [![Code Climate](https://codeclimate.com/github/mhenrixon/sidekiq-unique-jobs.svg)](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)
 
 ## Support Me
 
@@ -45,11 +45,11 @@ Want to show me some ❤️ for the hard work I do on this gem? You can use the
     - [reschedule_failed](#reschedule_failed)
     - [rescheduled](#rescheduled)
     - [timeout](#timeout)
-  - [unlock_failed](#unlock_failed)
-  - [unlocked](#unlocked)
-  - [unknown_sidekiq_worker](#unknown_sidekiq_worker)
-    - [Show Locks](#show-locks)
-    - [Show Lock](#show-lock)
+    - [unlock_failed](#unlock_failed)
+    - [unlocked](#unlocked)
+    - [unknown_sidekiq_worker](#unknown_sidekiq_worker)
+  - [Show Locks](#show-locks)
+  - [Show Lock](#show-lock)
 - [Testing](#testing)
   - [Validating Worker Configuration](#validating-worker-configuration)
   - [Uniqueness](#uniqueness)
@@ -545,23 +545,23 @@ For when a job was successfully rescheduled
 
 This is also mostly useful for reporting/metrics purposes. What this reflection does is signal that the job was configured to wait (`lock_timeout` was configured), but we couldn't retrieve a lock even though we waited for some time.
 
-### unlock_failed
+#### unlock_failed
 
-This is not got, this is worth
+This means that the server middleware could not unlock your job and the lock is kept (potentially preventing subsequent jobs from being pushed or processed).
 
-### unlocked
+#### unlocked
 
 Also mostly useful for reporting purposes. The job was successfully unlocked.
 
-### unknown_sidekiq_worker
+#### unknown_sidekiq_worker
 
 The reason this happens is that the server couldn't find a valid sidekiq worker class. Most likely, that worker isn't intended to be processed by this sidekiq server instance.
 
-#### Show Locks
+### Show Locks
 
 ![Locks](assets/unique_digests_1.png)
 
-#### Show Lock
+### Show Lock
 
 ![Lock](assets/unique_digests_2.png)
 

data/lib/sidekiq_unique_jobs/digests.rb

@@ -93,7 +93,7 @@ module SidekiqUniqueJobs
         [
           total_size.to_i,
           digests[0].to_i, # next_cursor
-          digests[1].map { |digest, score| Lock.new(digest, time: score) }, # entries
+          digests[1].each_slice(2).map { |digest, score| Lock.new(digest, time: score) }, # entries
         ]
       end
     end

data/lib/sidekiq_unique_jobs/job.rb

@@ -7,10 +7,11 @@ module SidekiqUniqueJobs
   module Job
     extend self
 
-    # Adds timeout, expiration, lock_args, lock_prefix and lock_digest to the sidekiq job hash
+    # Adds lock, timeout, expiration, lock_args, lock_prefix, and lock_digest to the sidekiq job hash
     # @return [Hash] the job hash
     def prepare(item)
       stringify_on_conflict_hash(item)
+      add_lock_type(item)
       add_lock_timeout(item)
       add_lock_ttl(item)
       add_digest(item)
@@ -54,5 +55,9 @@ module SidekiqUniqueJobs
     def add_lock_prefix(item)
       item[LOCK_PREFIX] ||= SidekiqUniqueJobs.config.lock_prefix
     end
+
+    def add_lock_type(item)
+      item[LOCK] ||= SidekiqUniqueJobs::LockType.call(item)
+    end
   end
 end

data/lib/sidekiq_unique_jobs/lock/until_executed.rb

@@ -35,6 +35,7 @@ module SidekiqUniqueJobs
       def execute
         executed = locksmith.execute do
           yield
+        ensure
           unlock_and_callback
         end
 

data/lib/sidekiq_unique_jobs/lock/while_executing.rb

@@ -42,9 +42,8 @@ module SidekiqUniqueJobs
         with_logging_context do
           executed = locksmith.execute do
             yield
-            callback_safely if locksmith.unlock
           ensure
-            locksmith.unlock
+            unlock_and_callback
           end
 
           unless executed

data/lib/sidekiq_unique_jobs/lock.rb

@@ -47,7 +47,7 @@ module SidekiqUniqueJobs
     #
     def initialize(key, time: nil)
       @key = get_key(key)
-      time = time.is_a?(Float) ? time : time.to_f
+      time = time.to_f unless time.is_a?(Float)
       return unless time.nonzero?
 
       @created_at = time

data/lib/sidekiq_unique_jobs/lock_config.rb

@@ -113,14 +113,20 @@ module SidekiqUniqueJobs
 
     # the strategy to use as conflict resolution from sidekiq client
     def on_client_conflict
-      @on_client_conflict ||= on_conflict["client"] || on_conflict[:client] if on_conflict.is_a?(Hash)
-      @on_client_conflict ||= on_conflict
+      @on_client_conflict ||= if on_conflict.is_a?(Hash)
+        on_conflict["client"] || on_conflict[:client]
+      else
+        on_conflict
+      end
     end
 
     # the strategy to use as conflict resolution from sidekiq server
     def on_server_conflict
-      @on_server_conflict ||= on_conflict["server"] || on_conflict[:server] if on_conflict.is_a?(Hash)
-      @on_server_conflict ||= on_conflict
+      @on_server_conflict ||= if on_conflict.is_a?(Hash)
+        on_conflict["server"] || on_conflict[:server]
+      else
+        on_conflict
+      end
     end
   end
 end

data/lib/sidekiq_unique_jobs/lock_type.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module SidekiqUniqueJobs
+  # Calculates the lock type
+  #
+  class LockType
+    # includes "SidekiqUniqueJobs::SidekiqWorkerMethods"
+    # @!parse include SidekiqUniqueJobs::SidekiqWorkerMethods
+    include SidekiqUniqueJobs::SidekiqWorkerMethods
+
+    #
+    # Computes lock type from job arguments, sidekiq_options.
+    #
+    # @return [Symbol] the lock type
+    # @return [NilClass] if no lock type is found.
+    #
+    def self.call(item)
+      new(item).call
+    end
+
+    # @!attribute [r] item
+    #   @return [Hash] the Sidekiq job hash
+    attr_reader :item
+
+    # @param [Hash] item the Sidekiq job hash
+    # @option item [Symbol, nil] :lock the type of lock to use.
+    # @option item [String] :class the class of the sidekiq worker
+    def initialize(item)
+      @item = item
+      self.job_class = item[CLASS]
+    end
+
+    def call
+      item[LOCK] || job_options[LOCK] || default_job_options[LOCK]
+    end
+  end
+end

data/lib/sidekiq_unique_jobs/locksmith.rb

@@ -127,7 +127,10 @@ module SidekiqUniqueJobs
     #
     def unlock!(conn = nil)
       call_script(:unlock, key.to_a, argv, conn) do |unlocked_jid|
-        reflect(:debug, :unlocked, item, unlocked_jid) if unlocked_jid == job_id
+        if unlocked_jid == job_id
+          reflect(:debug, :unlocked, item, unlocked_jid)
+          reflect(:unlocked, item)
+        end
 
         unlocked_jid
       end
@@ -312,7 +315,7 @@ module SidekiqUniqueJobs
     # @api private
     #
     def rpoplpush(conn)
-      conn.rpoplpush(key.queued, key.primed)
+      conn.lmove(key.queued, key.primed, "RIGHT", "LEFT")
     end
 
     #

data/lib/sidekiq_unique_jobs/on_conflict/reschedule.rb

@@ -21,7 +21,7 @@ module SidekiqUniqueJobs
       #   This will mess up sidekiq stats because a new job is created
       def call
         if sidekiq_job_class?
-          if job_class.set(queue: item["queue"].to_sym).perform_in(5, *item[ARGS])
+          if job_class.set(queue: item["queue"].to_sym).perform_in(schedule_in, *item[ARGS])
             reflect(:rescheduled, item)
           else
             reflect(:reschedule_failed, item)
@@ -30,6 +30,10 @@ module SidekiqUniqueJobs
           reflect(:unknown_sidekiq_worker, item)
         end
       end
+
+      def schedule_in
+        job_class.get_sidekiq_options["schedule_in"] || 5
+      end
     end
   end
 end

data/lib/sidekiq_unique_jobs/options_with_fallback.rb

@@ -55,7 +55,7 @@ module SidekiqUniqueJobs
     # The type of lock for this worker
     #
     #
-    # @return [Symbol]
+    # @return [Symbol, NilClass]
     #
     def lock_type
       @lock_type ||= options[LOCK] || item[LOCK]

data/lib/sidekiq_unique_jobs/orphans/manager.rb

@@ -72,7 +72,7 @@ module SidekiqUniqueJobs
       # @return [<type>] <description>
       #
       def task
-        @task ||= default_task
+        @task ||= default_task # rubocop:disable ThreadSafety/InstanceVariableInClassMethod
       end
 
       #
@@ -100,7 +100,7 @@ module SidekiqUniqueJobs
       # @return [void]
       #
       def task=(task)
-        @task = task
+        @task = task # rubocop:disable ThreadSafety/InstanceVariableInClassMethod
       end
 
       #
@@ -192,7 +192,7 @@ module SidekiqUniqueJobs
       # @return [void]
       #
       def register_reaper_process
-        redis { |conn| conn.set(UNIQUE_REAPER, current_timestamp, nx: true, ex: drift_reaper_interval) }
+        redis { |conn| conn.set(UNIQUE_REAPER, current_timestamp, "nx", "ex", drift_reaper_interval) }
       end
 
       #
@@ -202,7 +202,7 @@ module SidekiqUniqueJobs
       # @return [void]
       #
       def refresh_reaper_mutex
-        redis { |conn| conn.set(UNIQUE_REAPER, current_timestamp, ex: drift_reaper_interval) }
+        redis { |conn| conn.set(UNIQUE_REAPER, current_timestamp, "ex", drift_reaper_interval) }
       end
 
       #

data/lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb

@@ -79,7 +79,7 @@ module SidekiqUniqueJobs
       def expired_digests
         max_score = (start_time - reaper_timeout).to_f
 
-        conn.zrange(EXPIRING_DIGESTS, 0, max_score, byscore: true)
+        conn.zrange(EXPIRING_DIGESTS, 0, max_score, "byscore")
       end
 
       #

data/lib/sidekiq_unique_jobs/redis/sorted_set.rb

@@ -24,10 +24,11 @@ module SidekiqUniqueJobs
       # @return [Hash] when given with_scores: true
       #
       def entries(with_scores: true)
-        entrys = redis { |conn| conn.zrange(key, 0, -1, withscores: with_scores) }
-        return entrys unless with_scores
+        return redis { |conn| conn.zrange(key, 0, -1) } unless with_scores
 
-        entrys.each_with_object({}) { |pair, hash| hash[pair[0]] = pair[1] }
+        redis { |conn| conn.zrange(key, 0, -1, "withscores") }.each_with_object({}) do |pair, hash|
+          hash[pair[0]] = pair[1]
+        end
       end
 
       #

data/lib/sidekiq_unique_jobs/sidekiq_unique_jobs.rb

@@ -17,7 +17,7 @@ module SidekiqUniqueJobs # rubocop:disable Metrics/ModuleLength
   # @return [SidekiqUniqueJobs::Config] the gem configuration
   #
   def config
-    @config ||= reset!
+    @config ||= reset! # rubocop:disable ThreadSafety/InstanceVariableInClassMethod
   end
 
   #
@@ -108,7 +108,7 @@ module SidekiqUniqueJobs # rubocop:disable Metrics/ModuleLength
   # @return [SidekiqUniqueJobs::Config] a default gem configuration
   #
   def reset!
-    @config = SidekiqUniqueJobs::Config.default
+    @config = SidekiqUniqueJobs::Config.default # rubocop:disable ThreadSafety/InstanceVariableInClassMethod
   end
 
   #
@@ -288,7 +288,7 @@ module SidekiqUniqueJobs # rubocop:disable Metrics/ModuleLength
   # @return [Reflections]
   #
   def reflections
-    @reflections ||= Reflections.new
+    @reflections ||= Reflections.new # rubocop:disable ThreadSafety/InstanceVariableInClassMethod
   end
 
   #

data/lib/sidekiq_unique_jobs/version.rb

@@ -3,5 +3,5 @@
 module SidekiqUniqueJobs
   #
   # @return [String] the current SidekiqUniqueJobs version
-  VERSION = "8.0.2"
+  VERSION = "8.0.4"
 end

data/lib/sidekiq_unique_jobs.rb

@@ -49,6 +49,7 @@ require "sidekiq_unique_jobs/cli"
 require "sidekiq_unique_jobs/core_ext"
 require "sidekiq_unique_jobs/lock_timeout"
 require "sidekiq_unique_jobs/lock_ttl"
+require "sidekiq_unique_jobs/lock_type"
 require "sidekiq_unique_jobs/lock_args"
 require "sidekiq_unique_jobs/lock_digest"
 require "sidekiq_unique_jobs/unlockable"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-unique-jobs
 version: !ruby/object:Gem::Version
-  version: 8.0.2
+  version: 8.0.4
 platform: ruby
 authors:
 - Mikael Henriksson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-13 00:00:00.000000000 Z
+date: 2023-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: brpoplpush-redis_script
@@ -137,6 +137,7 @@ files:
 - lib/sidekiq_unique_jobs/lock_info.rb
 - lib/sidekiq_unique_jobs/lock_timeout.rb
 - lib/sidekiq_unique_jobs/lock_ttl.rb
+- lib/sidekiq_unique_jobs/lock_type.rb
 - lib/sidekiq_unique_jobs/locksmith.rb
 - lib/sidekiq_unique_jobs/logging.rb
 - lib/sidekiq_unique_jobs/logging/middleware_context.rb
@@ -233,7 +234,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.7
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
 summary: Sidekiq middleware that prevents duplicates jobs