sidekiq-unique-jobs 8.0.6 → 8.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f2baa17d73480d2a3af58b1202e5145935944abebfddbd94a199248df87e729
-  data.tar.gz: 11037fd5c6ed9a61452026541c874928ec0d465def211c7f34e91d7d1bb23bb2
+  metadata.gz: 3e0587400a796faf2d96ad2882bb2da1d39378d188ce9b257f845f1234acc4bf
+  data.tar.gz: 7bbd398cc60c7b99bd491b352804f1b3d57e6c02318ad82d40855739dcb30582
 SHA512:
-  metadata.gz: 927072c34b1b7131352dbfe5ccd269bace168d601977dfcb63199183033202b6ec04824612620375b336de9e06501a2b39237370357494af66a376385260faa3
-  data.tar.gz: cb615cce8db1b353f0b12790ee35019c709586f94b497d5543ef43a50a782b1e09c47371ddd28b810243b15e7d983030c5a56999ef7535745f4596890fc983dd
+  metadata.gz: 2efce8d2064bd4b572c4a1db8533514eff3ada446f939b68d437d3d72c7244169594a84c3ecd400a5aa90f9e0666ee88ef849590aea37c3471bb9b32631816dc
+  data.tar.gz: 01af8820641cf873f01379da41279db5a81b90d23465dde4a1eff81b21ce60b70688e6e28c59deadfba3088e1ad148d3987c4fbb8f9fdaf11cbb3e4da6331a25

data/CHANGELOG.md

@@ -1,5 +1,46 @@
 # Changelog
 
+## [v8.0.7](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v8.0.7) (2024-02-05)
+
+[Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v8.0.6...v8.0.7)
+
+**Implemented enhancements:**
+
+- chore\(ci\): add test coverage from bropoplpush [\#828](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/828) ([mhenrixon](https://github.com/mhenrixon))
+
+**Fixed bugs:**
+
+- fix\(xss\): sanitize parameters [\#829](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/829) ([mhenrixon](https://github.com/mhenrixon))
+
+**Closed issues:**
+
+- No 'Changelog' link is being displayed on https://rubygems.org/gems/sidekiq-unique-jobs [\#825](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/825)
+- Using rspec matcher and getting: `NameError:        uninitialized constant SidekiqUniqueJobs::Lock::BaseLock::Validator` [\#741](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/741)
+
+**Merged pull requests:**
+
+- Fix Testing Instructions [\#827](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/827) ([jherdman](https://github.com/jherdman))
+
+## [v8.0.6](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v8.0.6) (2024-01-24)
+
+[Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v8.0.5...v8.0.6)
+
+**Implemented enhancements:**
+
+- Returning same job id [\#814](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/814)
+- fix: various minor issues [\#826](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/826) ([mhenrixon](https://github.com/mhenrixon))
+
+**Closed issues:**
+
+- should respond to `has_valid_sidekiq_options?` [\#822](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/822)
+- Reaper manager registration is subject to race conditions [\#801](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/801)
+- `while_executing` with `on_conflict: :reschedule` Reschedule job after job execution  [\#800](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/800)
+- Large retry queue causes reaper to run too slow [\#759](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/759)
+
+**Merged pull requests:**
+
+- fix: skip unless reaper was registered [\#820](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/820) ([mhenrixon](https://github.com/mhenrixon))
+
 ## [v8.0.5](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v8.0.5) (2023-11-11)
 
 [Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v8.0.4...v8.0.5)
@@ -15,7 +56,7 @@
 
 ## [v8.0.4](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v8.0.4) (2023-11-11)
 
-[Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v7.1.30...v8.0.4)
+[Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v7.1.31...v8.0.4)
 
 **Implemented enhancements:**
 
@@ -31,9 +72,6 @@
 **Closed issues:**
 
 - register\_reaper\_process nx: true crash Sidekiq on startup [\#817](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/817)
-- Should client middleware also be added to the Sidekiq server config? [\#803](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/803)
-- 8.0.1 Time on locks & changelog UI is incorrect/wrong [\#761](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/761)
-- Job executed twice when reaper runs [\#738](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/738)
 
 **Merged pull requests:**
 
@@ -42,6 +80,16 @@
 - Handle strategy fallbacks properly [\#809](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/809) ([matejrisek](https://github.com/matejrisek))
 - Fix CI status badge [\#802](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/802) ([tagliala](https://github.com/tagliala))
 
+## [v7.1.31](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v7.1.31) (2023-08-28)
+
+[Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v7.1.30...v7.1.31)
+
+**Closed issues:**
+
+- Should client middleware also be added to the Sidekiq server config? [\#803](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/803)
+- 8.0.1 Time on locks & changelog UI is incorrect/wrong [\#761](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/761)
+- Job executed twice when reaper runs [\#738](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/738)
+
 ## [v7.1.30](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v7.1.30) (2023-07-17)
 
 [Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v8.0.3...v7.1.30)

data/README.md

@@ -582,8 +582,6 @@ end
 #spec/workers/bad_worker_spec.rb
 
 require "sidekiq_unique_jobs/testing"
-#OR
-require "sidekiq_unique_jobs/rspec/matchers"
 
 RSpec.describe BadWorker do
   specify { expect(described_class).to have_valid_sidekiq_options }
@@ -816,7 +814,7 @@ In my benchmarks deleting 1000 orphaned locks with lua performs around 65% faste
 
 On the other hand if I increase it to 10 000 orphaned locks per cleanup (`reaper_count: 10_0000`) then redis starts throwing:
 
-> BUSY Redis is busy running a script. You can only call SCRIPT KILL or SHUTDOWN NOSAVE. (Redis::CommandError)
+> BUSY Redis is busy running a script. You can only call SCRIPT KILL or SHUTDOWN NOSAVE. (RedisClient::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.
 

data/lib/sidekiq_unique_jobs/batch_delete.rb

@@ -9,7 +9,7 @@ module SidekiqUniqueJobs
   class BatchDelete
     #
     # @return [Integer] the default batch size
-    BATCH_SIZE = 100
+    BATCH_SIZE = 500
 
     #
     # @return [Array<String>] Supported key suffixes

data/lib/sidekiq_unique_jobs/config.rb

@@ -67,10 +67,10 @@ module SidekiqUniqueJobs
     # @return [Hash<Symbol, SidekiqUniqueJobs::Lock::BaseLock] all available default locks
     LOCKS =
       LOCKS_WHEN_BUSY.dup
-                     .merge(LOCKS_WHILE_ENQUEUED.dup)
-                     .merge(LOCKS_WITHOUT_UNLOCK.dup)
-                     .merge(LOCKS_FROM_PUSH_TO_PROCESSED.dup)
-                     .freeze
+        .merge(LOCKS_WHILE_ENQUEUED.dup)
+        .merge(LOCKS_WITHOUT_UNLOCK.dup)
+        .merge(LOCKS_FROM_PUSH_TO_PROCESSED.dup)
+        .freeze
 
     #
     # @return [Hash<Symbol, SidekiqUniqueJobs::OnConflict::Strategy] all available default strategies

data/lib/sidekiq_unique_jobs/constants.rb

@@ -15,6 +15,7 @@ module SidekiqUniqueJobs
   DEAD_VERSION          = "uniquejobs:dead"
   DIGESTS               = "uniquejobs:digests"
   EXPIRING_DIGESTS      = "uniquejobs:expiring_digests"
+  ORPHANED_DIGESTS      = "uniquejobs:orphaned_digests"
   ERRORS                = "errors"
   JID                   = "jid"
   LIMIT                 = "limit"

data/lib/sidekiq_unique_jobs/job.rb

@@ -41,19 +41,19 @@ module SidekiqUniqueJobs
     end
 
     def add_lock_timeout(item)
-      item[LOCK_TIMEOUT] ||= SidekiqUniqueJobs::LockTimeout.calculate(item)
+      item[LOCK_TIMEOUT] = SidekiqUniqueJobs::LockTimeout.calculate(item)
     end
 
     def add_lock_args(item)
-      item[LOCK_ARGS] ||= SidekiqUniqueJobs::LockArgs.call(item)
+      item[LOCK_ARGS] = SidekiqUniqueJobs::LockArgs.call(item)
     end
 
     def add_lock_digest(item)
-      item[LOCK_DIGEST] ||= SidekiqUniqueJobs::LockDigest.call(item)
+      item[LOCK_DIGEST] = SidekiqUniqueJobs::LockDigest.call(item)
     end
 
     def add_lock_prefix(item)
-      item[LOCK_PREFIX] ||= SidekiqUniqueJobs.config.lock_prefix
+      item[LOCK_PREFIX] = SidekiqUniqueJobs.config.lock_prefix
     end
 
     def add_lock_type(item)

data/lib/sidekiq_unique_jobs/lock/base_lock.rb

@@ -109,7 +109,7 @@ module SidekiqUniqueJobs
       #
       # Call whatever strategry that has been configured
       #
-      # @param [Symbol] origin: the origin `:client` or `:server`
+      # @param [Symbol] origin the origin `:client` or `:server`
       #
       # @return [void] the return value is irrelevant
       #

data/lib/sidekiq_unique_jobs/lock/while_executing.rb

@@ -11,6 +11,8 @@ module SidekiqUniqueJobs
     #
     # @author Mikael Henriksson <mikael@mhenrixon.com>
     class WhileExecuting < BaseLock
+      #
+      # @return [String] returns :RUN
       RUN_SUFFIX = ":RUN"
 
       include SidekiqUniqueJobs::OptionsWithFallback

data/lib/sidekiq_unique_jobs/lock.rb

@@ -33,9 +33,9 @@ module SidekiqUniqueJobs
     #
     # @return [Lock] a newly lock that has been locked
     #
-    def self.create(digest, job_id, lock_info = {})
-      lock = new(digest, time: Timing.now_f)
-      lock.lock(job_id, lock_info)
+    def self.create(digest, job_id, lock_info: {}, time: Timing.now_f, score: nil)
+      lock = new(digest, time: time)
+      lock.lock(job_id, lock_info, score)
       lock
     end
 
@@ -63,15 +63,16 @@ module SidekiqUniqueJobs
     #
     # @return [void]
     #
-    def lock(job_id, lock_info = {})
+    def lock(job_id, lock_info = {}, score = nil)
+      score ||= now_f
       redis do |conn|
         conn.multi do |pipeline|
           pipeline.set(key.digest, job_id)
           pipeline.hset(key.locked, job_id, now_f)
           info.set(lock_info, pipeline)
-          add_digest_to_set(pipeline, lock_info)
-          pipeline.zadd(key.changelog, now_f, changelog_json(job_id, "queue.lua", "Queued"))
-          pipeline.zadd(key.changelog, now_f, changelog_json(job_id, "lock.lua", "Locked"))
+          add_digest_to_set(pipeline, lock_info, score)
+          pipeline.zadd(key.changelog, score, changelog_json(job_id, "queue.lua", "Queued"))
+          pipeline.zadd(key.changelog, score, changelog_json(job_id, "lock.lua", "Locked"))
         end
       end
     end
@@ -333,12 +334,14 @@ module SidekiqUniqueJobs
     #
     # @return [nil]
     #
-    def add_digest_to_set(pipeline, lock_info)
+    def add_digest_to_set(pipeline, lock_info, score = nil)
+      score ||= now_f
       digest_string = key.digest
+
       if lock_info["lock"] == :until_expired
-        pipeline.zadd(key.expiring_digests, now_f + lock_info["ttl"], digest_string)
+        pipeline.zadd(key.expiring_digests, score + lock_info["ttl"], digest_string)
       else
-        pipeline.zadd(key.digests, now_f, digest_string)
+        pipeline.zadd(key.digests, score, digest_string)
       end
     end
   end

data/lib/sidekiq_unique_jobs/locksmith.rb

@@ -188,7 +188,7 @@ module SidekiqUniqueJobs
     #
     # @param [Sidekiq::RedisConnection, ConnectionPool] conn the redis connection
     # @param [Method] primed_method reference to the method to use for getting a primed token
-    # @param [nil, Integer, Float] time to wait before timeout
+    # @param [nil, Integer, Float] wait time to wait before timeout
     #
     # @yieldparam [string] job_id the sidekiq JID
     # @yieldreturn [void] whatever the calling block returns
@@ -258,8 +258,8 @@ module SidekiqUniqueJobs
 
       # NOTE: When debugging, change .value to .value!
       primed_jid = Concurrent::Promises
-                   .future(conn) { |red_con| pop_queued(red_con, timeout) }
-                   .value
+        .future(conn) { |red_con| pop_queued(red_con, timeout) }
+        .value
 
       handle_primed(primed_jid, &block)
     end

data/lib/sidekiq_unique_jobs/lua/unlock.lua

@@ -75,21 +75,28 @@ if lock_type ~= "until_expired" then
   redis.call("HDEL", locked, job_id)
 end
 
+if redis.call("LLEN", primed) == 0 then
+  log_debug("UNLINK", primed)
+  redis.call("UNLINK", primed)
+end
+
 local locked_count = redis.call("HLEN", locked)
 
-if locked_count and locked_count < 1 then
+if locked_count < 1 then
   log_debug("UNLINK", locked)
   redis.call("UNLINK", locked)
 end
 
-if redis.call("LLEN", primed) == 0 then
-  log_debug("UNLINK", primed)
-  redis.call("UNLINK", primed)
-end
-
-if limit and limit <= 1 and locked_count and locked_count <= 1 then
-  log_debug("ZREM", digests, digest)
-  redis.call("ZREM", digests, digest)
+if limit then
+  if limit <= 1 and locked_count <= 1 then
+    log_debug("ZREM", digests, digest)
+    redis.call("ZREM", digests, digest)
+  end
+else
+  if locked_count <= 1 then
+    log_debug("ZREM", digests, digest)
+    redis.call("ZREM", digests, digest)
+  end
 end
 
 log_debug("LPUSH", queued, "1")

data/lib/sidekiq_unique_jobs/middleware/client.rb

@@ -6,7 +6,7 @@ module SidekiqUniqueJobs
     #
     # @author Mikael Henriksson <mikael@mhenrixon.com>
     class Client
-      include Sidekiq::ClientMiddleware if defined?(Sidekiq::ClientMiddleware)
+      include Sidekiq::ClientMiddleware
 
       # prepend "SidekiqUniqueJobs::Middleware"
       # @!parse prepends SidekiqUniqueJobs::Middleware

data/lib/sidekiq_unique_jobs/middleware/server.rb

@@ -6,7 +6,7 @@ module SidekiqUniqueJobs
     #
     # @author Mikael Henriksson <mikael@mhenrixon.com>
     class Server
-      include Sidekiq::ServerMiddleware if defined?(Sidekiq::ServerMiddleware)
+      include Sidekiq::ServerMiddleware
 
       # prepend "SidekiqUniqueJobs::Middleware"
       # @!parse prepends SidekiqUniqueJobs::Middleware

data/lib/sidekiq_unique_jobs/middleware.rb

@@ -19,15 +19,15 @@ module SidekiqUniqueJobs
     # This method runs before (prepended) the actual middleware implementation.
     #   This is done to reduce duplication
     #
-    # @param [Sidekiq::Worker] worker_class
+    # @param [Sidekiq::Job] worker_class
     # @param [Hash] item a sidekiq job hash
     # @param [String] queue name of the queue
     # @param [ConnectionPool] redis_pool only used for compatility reasons
     #
-    # @return [yield<super>] <description>
+    # @return [yield<super>] call the rest of the middleware stack
     #
-    # @yieldparam [<type>] if <description>
-    # @yieldreturn [<type>] <describe what yield should return>
+    # @yieldparam [void] if uniquejobs is disable
+    # @yieldreturn [void] delegate back to other sidekiq middleware
     def call(worker_class, item, queue, redis_pool = nil)
       @item       = item
       @queue      = queue
@@ -35,7 +35,7 @@ module SidekiqUniqueJobs
       self.job_class = worker_class
       return yield if unique_disabled?
 
-      SidekiqUniqueJobs::Job.prepare(item) unless item[LOCK_DIGEST]
+      SidekiqUniqueJobs::Job.prepare(item)
 
       with_logging_context do
         super

data/lib/sidekiq_unique_jobs/orphans/reaper.rb

@@ -22,11 +22,12 @@ module SidekiqUniqueJobs
       #
       # @return [Hash<Symbol, SidekiqUniqueJobs::Orphans::Reaper] the current implementation of reapers
       REAPERS = {
-        lua: SidekiqUniqueJobs::Orphans::LuaReaper,
+        lua: SidekiqUniqueJobs::Orphans::RubyReaper,
         ruby: SidekiqUniqueJobs::Orphans::RubyReaper,
         none: SidekiqUniqueJobs::Orphans::NullReaper,
         nil => SidekiqUniqueJobs::Orphans::NullReaper,
         false => SidekiqUniqueJobs::Orphans::NullReaper,
+        true => SidekiqUniqueJobs::Orphans::RubyReaper,
       }.freeze
 
       #

data/lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb

@@ -13,6 +13,9 @@ module SidekiqUniqueJobs
     class RubyReaper < Reaper
       include SidekiqUniqueJobs::Timing
 
+      #
+      # @return [Integer] a best guess of Sidekiq::Launcher::BEAT_PAUSE
+      SIDEKIQ_BEAT_PAUSE = 10
       #
       # @return [String] the suffix for :RUN locks
       RUN_SUFFIX = ":RUN"
@@ -74,14 +77,30 @@ module SidekiqUniqueJobs
 
         BatchDelete.call(expired_digests, conn)
         BatchDelete.call(orphans, conn)
+
+        # orphans.each_slice(500) do |chunk|
+        #   conn.pipelined do |pipeline|
+        #     chunk.each do |digest|
+        #       next if belongs_to_job?(digest)
+
+        #       pipeline.zadd(ORPHANED_DIGESTS, now_f, digest)
+        #     end
+        #   end
+        # end
       end
 
       def expired_digests
-        max_score = (start_time - reaper_timeout).to_f
-
         conn.zrange(EXPIRING_DIGESTS, 0, max_score, "byscore")
       end
 
+      def orphaned_digests
+        conn.zrange(ORPHANED_DIGESTS, 0, max_score, "byscore")
+      end
+
+      def max_score
+        (start_time - reaper_timeout - SIDEKIQ_BEAT_PAUSE).to_f
+      end
+
       #
       # Find orphaned digests
       #
@@ -89,10 +108,10 @@ module SidekiqUniqueJobs
       # @return [Array<String>] an array of orphaned digests
       #
       def orphans # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity
-        page = 0
-        per = reaper_count * 2
         orphans = []
-        results = conn.zrange(digests.key, page * per, (page + 1) * per)
+        page    = 0
+        per     = reaper_count * 2
+        results = digests.byscore(0, max_score, offset: page * per, count: (page + 1) * per)
 
         while results.size.positive?
           results.each do |digest|
@@ -107,7 +126,7 @@ module SidekiqUniqueJobs
           break if orphans.size >= reaper_count
 
           page += 1
-          results = conn.zrange(digests.key, page * per, (page + 1) * per)
+          results = digests.byscore(0, max_score, offset: page * per, count: (page + 1) * per)
         end
 
         orphans
@@ -218,7 +237,7 @@ module SidekiqUniqueJobs
       end
 
       def considered_active?(time_f)
-        (Time.now - reaper_timeout).to_f < time_f
+        max_score < time_f
       end
 
       #

data/lib/sidekiq_unique_jobs/redis/sorted_set.rb

@@ -48,6 +48,14 @@ module SidekiqUniqueJobs
         end
       end
 
+      def byscore(min, max, offset: nil, count: nil)
+        redis do |conn|
+          return conn.zrange(key, min, max, "byscore") unless offset && count
+
+          conn.zrange(key, min, max, "byscore", "limit", offset, count)
+        end
+      end
+
       #
       # Return the zrak of the member
       #

data/lib/sidekiq_unique_jobs/script/script.rb

@@ -66,12 +66,7 @@ module SidekiqUniqueJobs
       end
 
       def load(conn)
-        @sha =
-          if conn.respond_to?(:namespace)
-            conn.redis.script(:load, source)
-          else
-            conn.script(:load, source)
-          end
+        @sha = conn.script(:load, source)
 
         self
       end

data/lib/sidekiq_unique_jobs/server.rb

@@ -5,6 +5,8 @@ module SidekiqUniqueJobs
   #
   # @author Mikael Henriksson <mikael@mhenrixon.com>
   class Server
+    #
+    # @return [Proc] returns a default death handler for the gem to cleanup dead locks
     DEATH_HANDLER = (lambda do |job, _ex|
       return unless (digest = job["lock_digest"])
 

data/lib/sidekiq_unique_jobs/sidekiq_unique_ext.rb

@@ -68,46 +68,24 @@ module Sidekiq
     prepend UniqueExtension
   end
 
-  if Sidekiq.const_defined?(:JobRecord)
-    # See Sidekiq::Api
-    class JobRecord
-      #
-      # Provides extensions for unlocking jobs that are removed and deleted
+  # See Sidekiq::Api
+  class JobRecord
+    #
+    # Provides extensions for unlocking jobs that are removed and deleted
+    #
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
+    #
+    module UniqueExtension
       #
-      # @author Mikael Henriksson <mikael@mhenrixon.com>
+      # Wraps the original method to ensure locks for the job are deleted
       #
-      module UniqueExtension
-        #
-        # Wraps the original method to ensure locks for the job are deleted
-        #
-        def delete
-          SidekiqUniqueJobs::Unlockable.delete!(item)
-          super
-        end
+      def delete
+        SidekiqUniqueJobs::Unlockable.delete!(item)
+        super
       end
-
-      prepend UniqueExtension
     end
-  else
-    # See Sidekiq::Api
-    class Job
-      #
-      # Provides extensions for unlocking jobs that are removed and deleted
-      #
-      # @author Mikael Henriksson <mikael@mhenrixon.com>
-      #
-      module UniqueExtension
-        #
-        # Wraps the original method to ensure locks for the job are deleted
-        #
-        def delete
-          SidekiqUniqueJobs::Unlockable.delete!(item)
-          super
-        end
-      end
 
-      prepend UniqueExtension
-    end
+    prepend UniqueExtension
   end
 
   # See Sidekiq::Api

data/lib/sidekiq_unique_jobs/sidekiq_unique_jobs.rb

@@ -250,9 +250,9 @@ module SidekiqUniqueJobs # rubocop:disable Metrics/ModuleLength
   # Attempt to constantize a string worker_class argument, always
   # failing back to the original argument when the constant can't be found
   #
-  # @return [Sidekiq::Worker]
+  # @return [Sidekiq::Job]
   def constantize(str)
-    return str.class             if str.is_a?(Sidekiq::Worker) # sidekiq v6.x
+    return str.class             if str.is_a?(Sidekiq::Job) # sidekiq v6.x
     return str                   unless str.is_a?(String)
     return Object.const_get(str) unless str.include?("::")
 
@@ -269,7 +269,7 @@ module SidekiqUniqueJobs # rubocop:disable Metrics/ModuleLength
   # Attempt to constantize a string worker_class argument, always
   # failing back to the original argument when the constant can't be found
   #
-  # @return [Sidekiq::Worker, String]
+  # @return [Sidekiq::Job, String]
   def safe_constantize(str)
     constantize(str)
   rescue NameError => ex

data/lib/sidekiq_unique_jobs/sidekiq_worker_methods.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
 module SidekiqUniqueJobs
-  # Module with convenience methods for the Sidekiq::Worker class
+  # Module with convenience methods for the Sidekiq::Job class
   #
   # @author Mikael Henriksson <mikael@mhenrixon.com>
   module SidekiqWorkerMethods
     #
     # @!attribute [r] job_class
-    #   @return [Sidekiq::Worker] The Sidekiq::Worker implementation
+    #   @return [Sidekiq::Job] The Sidekiq::Job implementation
     attr_reader :job_class
 
     # Avoids duplicating worker_class.respond_to? in multiple places
@@ -62,7 +62,7 @@ module SidekiqUniqueJobs
     # Attempt to constantize a string worker_class argument, always
     # failing back to the original argument when the constant can't be found
     #
-    # @return [Sidekiq::Worker]
+    # @return [Sidekiq::Job]
     def job_class_constantize(klazz = @job_class)
       SidekiqUniqueJobs.safe_constantize(klazz)
     end

data/lib/sidekiq_unique_jobs/testing.rb

@@ -42,11 +42,11 @@ module Sidekiq
   end
 
   #
-  # See Sidekiq::Worker in Sidekiq gem for more details
+  # See Sidekiq::Job in Sidekiq gem for more details
   #
   module Worker
     #
-    # Adds class methods to Sidekiq::Worker
+    # Adds class methods to Sidekiq::Job
     #
     module ClassMethods
       #
@@ -110,14 +110,14 @@ module Sidekiq
     prepend Overrides
 
     #
-    # Prepends methods to Sidekiq::Worker
+    # Prepends methods to Sidekiq::Job
     #
     module ClassMethods
       prepend Overrides::ClassMethods
     end
 
     #
-    # Prepends singleton methods to Sidekiq::Worker
+    # Prepends singleton methods to Sidekiq::Job
     #
     module SignletonOverrides
       #

data/lib/sidekiq_unique_jobs/version.rb

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

data/lib/sidekiq_unique_jobs/web/helpers.rb

@@ -133,7 +133,7 @@ module SidekiqUniqueJobs
       #
       # @return [String] a html safe string with relative time information
       #
-      def relative_time(time)
+      def _relative_time(time)
         stamp = time.getutc.iso8601
         %(<time class="ltr" dir="ltr" title="#{stamp}" datetime="#{stamp}">#{time}</time>)
       end
@@ -145,12 +145,12 @@ module SidekiqUniqueJobs
       #
       # @return [String] a html safe string with relative time information
       #
-      def safe_relative_time(time)
+      def _safe_relative_time(time)
         return unless time
 
         time = parse_time(time)
 
-        relative_time(time)
+        _relative_time(time)
       end
 
       #

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

@@ -42,7 +42,7 @@
       <tbody>
         <% @changelogs.each do |changelog| %>
           <tr  class="changelog-row">
-            <td><%= safe_relative_time(changelog['time']) || "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

@@ -65,7 +65,7 @@
         <% @lock.locked_jids(with_values: true).each do |job_id, time| %>
         <tr>
           <td><%= job_id %></td>
-          <td><%= safe_relative_time(time.to_f) %></td>
+          <td><%= _safe_relative_time(time.to_f) %></td>
           <td>
             <form action="<%= root_path %>locks/<%= @lock.key %>/jobs/<%= job_id %>/delete" method="get">
               <%= csrf_tag %>
@@ -92,7 +92,7 @@
       <tbody>
         <% @lock.changelogs.each do |entry| %>
         <tr>
-          <td scope="row"><%= safe_relative_time(entry["time"].to_f) %></td>
+          <td scope="row"><%= _safe_relative_time(entry["time"].to_f) %></td>
           <td><%= entry["job_id"] %></td>
           <td><%= entry["message"] %></td>
           <td><%= entry["script"] %></td>

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

@@ -46,7 +46,7 @@
             <td><a href="<%= root_path %>locks/<%= lock.key %>"><%= lock.key %></a></td>
             <td><%= lock.info["lock"] %></td>
             <td><%= lock.locked.count %></td>
-            <td><%= safe_relative_time(lock.created_at) %></td>
+            <td><%= _safe_relative_time(lock.created_at) %></td>
           </tr>
         </tbody>
       <% end %>

data/lib/sidekiq_unique_jobs/web.rb

@@ -13,11 +13,11 @@ module SidekiqUniqueJobs
       end
 
       app.get "/changelogs" do
-        @filter         = params[:filter] || "*"
+        @filter         = h(params[:filter] || "*")
         @filter         = "*" if @filter == ""
-        @count          = (params[:count] || 100).to_i
-        @current_cursor = params[:cursor].to_i
-        @prev_cursor    = params[:prev_cursor].to_i
+        @count          = h(params[:count] || 100).to_i
+        @current_cursor = h(params[:cursor]).to_i
+        @prev_cursor    = h(params[:prev_cursor]).to_i
         @total_size, @next_cursor, @changelogs = changelog.page(
           cursor: @current_cursor,
           pattern: @filter,
@@ -33,11 +33,11 @@ module SidekiqUniqueJobs
       end
 
       app.get "/locks" do
-        @filter         = params[:filter] || "*"
+        @filter         = h(params[:filter]) || "*"
         @filter         = "*" if @filter == ""
-        @count          = (params[:count] || 100).to_i
-        @current_cursor = params[:cursor].to_i
-        @prev_cursor    = params[:prev_cursor].to_i
+        @count          = h(params[:count] || 100).to_i
+        @current_cursor = h(params[:cursor]).to_i
+        @prev_cursor    = h(params[:prev_cursor]).to_i
 
         @total_size, @next_cursor, @locks = digests.page(
           cursor: @current_cursor,
@@ -49,11 +49,11 @@ module SidekiqUniqueJobs
       end
 
       app.get "/expiring_locks" do
-        @filter         = params[:filter] || "*"
+        @filter         = h(params[:filter]) || "*"
         @filter         = "*" if @filter == ""
-        @count          = (params[:count] || 100).to_i
-        @current_cursor = params[:cursor].to_i
-        @prev_cursor    = params[:prev_cursor].to_i
+        @count          = h(params[:count] || 100).to_i
+        @current_cursor = h(params[:cursor]).to_i
+        @prev_cursor    = h(params[:prev_cursor]).to_i
 
         @total_size, @next_cursor, @locks = expiring_digests.page(
           cursor: @current_cursor,
@@ -71,20 +71,20 @@ module SidekiqUniqueJobs
       end
 
       app.get "/locks/:digest" do
-        @digest = params[:digest]
+        @digest = h(params[:digest])
         @lock   = SidekiqUniqueJobs::Lock.new(@digest)
 
         erb(unique_template(:lock))
       end
 
       app.get "/locks/:digest/delete" do
-        digests.delete_by_digest(params[:digest])
-        expiring_digests.delete_by_digest(params[:digest])
+        digests.delete_by_digest(h(params[:digest]))
+        expiring_digests.delete_by_digest(h(params[:digest]))
         redirect_to :locks
       end
 
       app.get "/locks/:digest/jobs/:job_id/delete" do
-        @digest = params[:digest]
+        @digest = h(params[:digest])
         @lock   = SidekiqUniqueJobs::Lock.new(@digest)
         @lock.unlock(params[:job_id])
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-unique-jobs
 version: !ruby/object:Gem::Version
-  version: 8.0.6
+  version: 8.0.8
 platform: ruby
 authors:
 - Mikael Henriksson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-24 00:00:00.000000000 Z
+date: 2024-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -223,7 +223,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.5
+rubygems_version: 3.5.6
 signing_key:
 specification_version: 4
 summary: Sidekiq middleware that prevents duplicates jobs