sidekiq-unique-jobs 8.0.1 → 8.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18fddfafacb221ce072d4bdcb5c16b0b4e27547d5129eec69ed91ca981d8b66b
-  data.tar.gz: 05d851bde2e91b6ecea881fa1227d74037dd57dcb98e97961349391a26a6a755
+  metadata.gz: 2462acb2448a07c45eb8a1789239f859a09e079cff316fe61dc205d9ea8856a4
+  data.tar.gz: 57449a594cd034c79001815883806098e04a92869c41cbe6044c90ab6f1fa3ae
 SHA512:
-  metadata.gz: 444ff4c25066f950d49d5ebcf4223368418f7ae6594f3a23ca12e71a1077de46bbdb8498529af4ad29f4d28e128b079afdc2d1b67f28eeeac3118cec85bd287b
-  data.tar.gz: 69ff924fe4bf0b3a181afdc0c11b8bc97e592435ae7e44873356b9a90277d4c8a76c93f2916d0c8d6fef17075ff66de43997095218e872271cbb3012ba95aaf6
+  metadata.gz: b200d3544047b6080147b19b71ffd83a0ac42087ed29f1d84fb35b226b1418f50e37c94b309a946504c32d26b11b5fd173ade85e77c568931d33b948f1c656f9
+  data.tar.gz: 9d12cbf3317acd4e5bd6d934616622e5ac3336ecba4e51b2b29fbf6782deab2b1af291af1471e16da7271fef42b33804b7a3c7f3475016de88bd75e2d0668684

data/CHANGELOG.md

@@ -1,5 +1,35 @@
 # Changelog
 
+## [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)
+
+**Closed issues:**
+
+- TypeError: Unsupported command argument type: ActiveSupport::Duration [\#754](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/754)
+- Incompatibility with Sidekiq 7 [\#736](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/736)
+
+**Merged pull requests:**
+
+- Fix active worker detection by using correct keys [\#756](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/756) ([dodo121](https://github.com/dodo121))
+- Fix minor typo in drift\_reaper\_interval comment [\#755](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/755) ([lazyatom](https://github.com/lazyatom))
+
 ## [v8.0.0](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v8.0.0) (2023-01-30)
 
 [Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v7.1.29...v8.0.0)

data/README.md

@@ -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/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

@@ -46,8 +46,11 @@ module SidekiqUniqueJobs
     # @param [Timstamp, Float] time nil optional timestamp to initiate this lock with
     #
     def initialize(key, time: nil)
-      @key        = get_key(key)
-      @created_at = time.is_a?(Float) ? time : time.to_f
+      @key = get_key(key)
+      time = time.is_a?(Float) ? time : time.to_f
+      return unless time.nonzero?
+
+      @created_at = time
     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/lua/delete.lua

@@ -17,7 +17,7 @@ local limit        = tonumber(ARGV[4])
 
 --------  BEGIN injected arguments --------
 local current_time = tonumber(ARGV[5])
-local debug_lua    = tostring(ARGV[6]) == "true"
+local debug_lua    = tostring(ARGV[6]) == "1"
 local max_history  = tonumber(ARGV[7])
 local script_name  = tostring(ARGV[8]) .. ".lua"
 local redisversion = tostring(ARGV[9])

data/lib/sidekiq_unique_jobs/lua/delete_by_digest.lua

@@ -12,7 +12,7 @@ local digests    = KEYS[9]
 
 --------  BEGIN injected arguments --------
 local current_time = tonumber(ARGV[1])
-local debug_lua    = ARGV[2] == "true"
+local debug_lua    = tostring(ARGV[2]) == "1"
 local max_history  = tonumber(ARGV[3])
 local script_name  = tostring(ARGV[4]) .. ".lua"
 local redisversion = tostring(ARGV[5])

data/lib/sidekiq_unique_jobs/lua/delete_job_by_digest.lua

@@ -10,7 +10,7 @@ local digest       = ARGV[1]
 
 --------  BEGIN injected arguments --------
 local current_time = tonumber(ARGV[2])
-local debug_lua    = ARGV[3] == "true"
+local debug_lua    = tostring(ARGV[3]) == "1"
 local max_history  = tonumber(ARGV[4])
 local script_name  = tostring(ARGV[5]) .. ".lua"
 ---------  END injected arguments ---------

data/lib/sidekiq_unique_jobs/lua/find_digest_in_queues.lua

@@ -4,7 +4,7 @@ local digest = KEYS[1]
 
 --------  BEGIN injected arguments --------
 local current_time = tonumber(ARGV[2])
-local debug_lua    = ARGV[3] == "true"
+local debug_lua    = tostring(ARGV[3]) == "1"
 local max_history  = tonumber(ARGV[4])
 local script_name  = tostring(ARGV[5]) .. ".lua"
 ---------  END injected arguments ---------

data/lib/sidekiq_unique_jobs/lua/lock.lua

@@ -20,7 +20,7 @@ local limit        = tonumber(ARGV[4])
 
 --------  BEGIN injected arguments --------
 local current_time = tonumber(ARGV[5])
-local debug_lua    = ARGV[6] == "true"
+local debug_lua    = tostring(ARGV[6]) == "1"
 local max_history  = tonumber(ARGV[7])
 local script_name  = tostring(ARGV[8]) .. ".lua"
 local redisversion = ARGV[9]

data/lib/sidekiq_unique_jobs/lua/lock_until_expired.lua

@@ -20,7 +20,7 @@ local limit        = tonumber(ARGV[4])
 
 --------  BEGIN injected arguments --------
 local current_time = tonumber(ARGV[5])
-local debug_lua    = ARGV[6] == "true"
+local debug_lua    = tostring(ARGV[6]) == "1"
 local max_history  = tonumber(ARGV[7])
 local script_name  = tostring(ARGV[8]) .. ".lua"
 local redisversion = ARGV[9]

data/lib/sidekiq_unique_jobs/lua/locked.lua

@@ -14,7 +14,7 @@ local job_id = ARGV[1]
 
 --------  BEGIN injected arguments --------
 local current_time = tonumber(ARGV[2])
-local debug_lua    = ARGV[3] == "true"
+local debug_lua    = tostring(ARGV[3]) == "1"
 local max_history  = tonumber(ARGV[4])
 local script_name  = tostring(ARGV[5]) .. ".lua"
 ---------  END injected arguments ---------

data/lib/sidekiq_unique_jobs/lua/queue.lua

@@ -19,7 +19,7 @@ local limit     = tonumber(ARGV[4])
 
 --------  BEGIN injected arguments --------
 local current_time = tonumber(ARGV[5])
-local debug_lua    = ARGV[6] == "true"
+local debug_lua    = tostring(ARGV[6]) == "1"
 local max_history  = tonumber(ARGV[7])
 local script_name  = tostring(ARGV[8]) .. ".lua"
 ---------  END injected arguments ---------

data/lib/sidekiq_unique_jobs/lua/reap_orphans.lua

@@ -14,7 +14,7 @@ local threshold    = tonumber(ARGV[2])
 
 --------  BEGIN injected arguments --------
 local current_time = tonumber(ARGV[3])
-local debug_lua    = ARGV[4] == "true"
+local debug_lua    = tostring(ARGV[4]) == "1"
 local max_history  = tonumber(ARGV[5])
 local script_name  = ARGV[6] .. ".lua"
 local redisversion = ARGV[7]

data/lib/sidekiq_unique_jobs/lua/shared/_common.lua

@@ -9,11 +9,6 @@ local function toversion(version)
   }
 end
 
-local function toboolean(val)
-  val = tostring(val)
-  return val == "1" or val == "true"
-end
-
 local function log_debug( ... )
   if debug_lua ~= true then return end
 

data/lib/sidekiq_unique_jobs/lua/unlock.lua

@@ -19,7 +19,7 @@ local limit     = tonumber(ARGV[4])
 
 --------  BEGIN injected arguments --------
 local current_time = tonumber(ARGV[5])
-local debug_lua    = ARGV[6] == "true"
+local debug_lua    = tostring(ARGV[6]) == "1"
 local max_history  = tonumber(ARGV[7])
 local script_name  = tostring(ARGV[8]) .. ".lua"
 local redisversion = ARGV[9]

data/lib/sidekiq_unique_jobs/lua/update_version.lua

@@ -9,7 +9,7 @@ local version  = ARGV[1]
 
 --------  BEGIN injected arguments --------
 local current_time = tonumber(ARGV[2])
-local debug_lua    = ARGV[3] == "true"
+local debug_lua    = tostring(ARGV[3]) == "1"
 local max_history  = tonumber(ARGV[4])
 local script_name  = tostring(ARGV[5]) .. ".lua"
 ---------  END injected arguments ---------

data/lib/sidekiq_unique_jobs/lua/upgrade.lua

@@ -6,7 +6,7 @@ local dead_version = KEYS[2]
 
 --------  BEGIN injected arguments --------
 local current_time = tonumber(ARGV[5])
-local debug_lua    = ARGV[6] == "true"
+local debug_lua    = tostring(ARGV[6]) == "1"
 local max_history  = tonumber(ARGV[7])
 local script_name  = tostring(ARGV[8]) .. ".lua"
 local redisversion = ARGV[9]

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
 
       #

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.1"
+  VERSION = "8.0.3"
 end

data/lib/sidekiq_unique_jobs/web/helpers.rb

@@ -146,6 +146,8 @@ module SidekiqUniqueJobs
       # @return [String] a html safe string with relative time information
       #
       def safe_relative_time(time)
+        return unless time
+
         time = parse_time(time)
 
         relative_time(time)

data/lib/sidekiq_unique_jobs/web/views/changelogs.erb

@@ -42,7 +42,7 @@
       <tbody>
         <% @changelogs.each do |changelog| %>
           <tr  class="changelog-row">
-            <td><%= "bogus" %></td>
+            <td><%= safe_relative_time(changelog['time']) || "bogus" %></td>
             <td><%= changelog["digest"] %></td>
             <td><%= changelog["script"] %></td>
             <td><%= changelog["job_id"] %></td>

data/lib/sidekiq_unique_jobs/web/views/lock.erb

@@ -7,9 +7,11 @@
   <div class="col-sm-7 table-responsive">
     <% if @lock.info.none? %>
     <h3>No Lock Information Available</h3>
-    <p>To use it turn the following setting on:
-      <code>SidekiqUniqueJobs.config.lock_info = true</code>
-    </p>
+    <% unless SidekiqUniqueJobs.config.lock_info %>
+      <p>To use it turn the following setting on:
+        <code>SidekiqUniqueJobs.config.lock_info = true</code>
+      </p>
+    <% end %>
     <% else %>
     <table class="table table-striped table-bordered table-white table-hover">
       <caption>Information about lock</caption>

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.1
+  version: 8.0.3
 platform: ruby
 authors:
 - Mikael Henriksson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-14 00:00:00.000000000 Z
+date: 2023-07-10 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.6
+rubygems_version: 3.4.15
 signing_key:
 specification_version: 4
 summary: Sidekiq middleware that prevents duplicates jobs