sidekiq-unique-jobs 8.0.10 → 8.0.12

data/lib/sidekiq_unique_jobs/script/client.rb

@@ -27,20 +27,26 @@ module SidekiqUniqueJobs
         @scripts = Scripts.fetch(config.scripts_path)
       end
 
+      #
+      # Maximum number of retries for script execution errors
+      #
+      MAX_RETRIES = 3
+
       #
       # Execute a lua script with the provided script_name
       #
       # @note this method is recursive if we need to load a lua script
-      #   that wasn't previously loaded.
+      #   that wasn't previously loaded. Limited to MAX_RETRIES to prevent stack overflow.
       #
       # @param [Symbol] script_name the name of the script to execute
       # @param [Redis] conn the redis connection to use for execution
       # @param [Array<String>] keys script keys
       # @param [Array<Object>] argv script arguments
+      # @param [Integer] retries number of retries remaining (internal use)
       #
       # @return value from script
       #
-      def execute(script_name, conn, keys: [], argv: [])
+      def execute(script_name, conn, keys: [], argv: [], retries: MAX_RETRIES)
         result, elapsed = timed do
           scripts.execute(script_name, conn, keys: keys, argv: argv)
         end
@@ -48,8 +54,10 @@ module SidekiqUniqueJobs
         logger.debug("Executed #{script_name}.lua in #{elapsed}ms")
         result
       rescue ::RedisClient::CommandError => ex
+        raise if retries <= 0
+
         handle_error(script_name, conn, ex) do
-          execute(script_name, conn, keys: keys, argv: argv)
+          execute(script_name, conn, keys: keys, argv: argv, retries: retries - 1)
         end
       end
 

data/lib/sidekiq_unique_jobs/script/lua_error.rb

@@ -88,9 +88,11 @@ module SidekiqUniqueJobs
       end
 
       # :nocov:
+      # rubocop:disable Naming/PredicateMethod
       def line_from_gem(line)
         line.split(":").first.include?(LIB_PATH)
       end
+      # rubocop:enable Naming/PredicateMethod
     end
   end
 end

data/lib/sidekiq_unique_jobs/script/scripts.rb

@@ -11,42 +11,16 @@ module SidekiqUniqueJobs
       SCRIPT_PATHS = Concurrent::Map.new
 
       #
-      # Fetch a scripts configuration for path
+      # Fetch or create a scripts configuration for path
       #
-      # @param [Pathname] root_path the path to scripts
-      #
-      # @return [Scripts] a collection of scripts
-      #
-      def self.fetch(root_path)
-        if (scripts = SCRIPT_PATHS.get(root_path))
-          return scripts
-        end
-
-        create(root_path)
-      end
-
-      #
-      # Create a new scripts collection based on path
+      # Uses Concurrent::Map#fetch_or_store for thread-safe lazy initialization
       #
       # @param [Pathname] root_path the path to scripts
       #
       # @return [Scripts] a collection of scripts
       #
-      def self.create(root_path)
-        scripts = new(root_path)
-        store(scripts)
-      end
-
-      #
-      # Store the scripts collection in memory
-      #
-      # @param [Scripts] scripts the path to scripts
-      #
-      # @return [Scripts] the scripts instance that was stored
-      #
-      def self.store(scripts)
-        SCRIPT_PATHS.put(scripts.root_path, scripts)
-        scripts
+      def self.fetch(root_path)
+        SCRIPT_PATHS.fetch_or_store(root_path) { new(root_path) }
       end
 
       #
@@ -66,35 +40,57 @@ module SidekiqUniqueJobs
         @root_path = path
       end
 
+      #
+      # Fetch or load a script by name
+      #
+      # Uses Concurrent::Map#fetch_or_store for thread-safe lazy loading
+      #
+      # @param [Symbol, String] name the script name
+      # @param [Redis] conn the redis connection
+      #
+      # @return [Script] the loaded script
+      #
       def fetch(name, conn)
-        if (script = scripts.get(name.to_sym))
-          return script
-        end
-
-        load(name, conn)
+        scripts.fetch_or_store(name.to_sym) { load(name, conn) }
       end
 
+      #
+      # Load a script from disk, store in Redis, and cache in memory
+      #
+      # @param [Symbol, String] name the script name
+      # @param [Redis] conn the redis connection
+      #
+      # @return [Script] the loaded script
+      #
       def load(name, conn)
         script = Script.load(name, root_path, conn)
         scripts.put(name.to_sym, script)
-
         script
       end
 
+      #
+      # Delete a script from the collection
+      #
+      # @param [Script, Symbol, String] script the script or script name to delete
+      #
+      # @return [Script, nil] the deleted script
+      #
       def delete(script)
-        if script.is_a?(Script)
-          scripts.delete(script.name)
-        else
-          scripts.delete(script.to_sym)
-        end
+        key = script.is_a?(Script) ? script.name : script.to_sym
+        scripts.delete(key)
       end
 
+      #
+      # Kill a running Redis script
+      #
+      # @param [Redis] conn the redis connection
+      #
+      # @return [String] Redis response
+      #
       def kill(conn)
-        if conn.respond_to?(:namespace)
-          conn.redis.script(:kill)
-        else
-          conn.script(:kill)
-        end
+        # Handle both namespaced and non-namespaced Redis connections
+        redis = conn.respond_to?(:namespace) ? conn.redis : conn
+        redis.script(:kill)
       end
 
       #

data/lib/sidekiq_unique_jobs/sidekiq_unique_ext.rb

@@ -60,7 +60,7 @@ module Sidekiq
       #
       def delete(score, job_id)
         entry = find_job(job_id)
-        SidekiqUniqueJobs::Unlockable.delete!(entry.item) if super(score, job_id)
+        SidekiqUniqueJobs::Unlockable.delete!(entry.item) if super
         entry
       end
     end
@@ -132,7 +132,7 @@ module Sidekiq
       # @param [String] value a sidekiq job hash
       #
       def delete_by_value(name, value)
-        SidekiqUniqueJobs::Unlockable.delete!(Sidekiq.load_json(value)) if super(name, value)
+        SidekiqUniqueJobs::Unlockable.delete!(Sidekiq.load_json(value)) if super
       end
     end
 

data/lib/sidekiq_unique_jobs/sidekiq_unique_jobs.rb

@@ -4,7 +4,7 @@
 # Contains configuration and utility methods that belongs top level
 #
 # @author Mikael Henriksson <mikael@mhenrixon.com>
-module SidekiqUniqueJobs # rubocop:disable Metrics/ModuleLength
+module SidekiqUniqueJobs
   include SidekiqUniqueJobs::Connection
   extend SidekiqUniqueJobs::JSON
 
@@ -17,7 +17,7 @@ module SidekiqUniqueJobs # rubocop:disable Metrics/ModuleLength
   # @return [SidekiqUniqueJobs::Config] the gem configuration
   #
   def config
-    @config ||= reset! # rubocop:disable ThreadSafety/InstanceVariableInClassMethod
+    @config ||= reset! # rubocop:disable ThreadSafety/ClassInstanceVariable
   end
 
   #
@@ -108,7 +108,7 @@ module SidekiqUniqueJobs # rubocop:disable Metrics/ModuleLength
   # @return [SidekiqUniqueJobs::Config] a default gem configuration
   #
   def reset!
-    @config = SidekiqUniqueJobs::Config.default # rubocop:disable ThreadSafety/InstanceVariableInClassMethod
+    @config = SidekiqUniqueJobs::Config.default # rubocop:disable ThreadSafety/ClassInstanceVariable
   end
 
   #
@@ -288,7 +288,7 @@ module SidekiqUniqueJobs # rubocop:disable Metrics/ModuleLength
   # @return [Reflections]
   #
   def reflections
-    @reflections ||= Reflections.new # rubocop:disable ThreadSafety/InstanceVariableInClassMethod
+    @reflections ||= Reflections.new # rubocop:disable ThreadSafety/ClassInstanceVariable
   end
 
   #

data/lib/sidekiq_unique_jobs/sidekiq_worker_methods.rb

@@ -39,7 +39,7 @@ module SidekiqUniqueJobs
 
     # The hook to call after a successful unlock
     # @return [Proc]
-    def after_unlock_hook # rubocop:disable Metrics/MethodLength
+    def after_unlock_hook
       lambda do
         if @original_job_class.respond_to?(:after_unlock)
           # instance method in sidekiq v6

data/lib/sidekiq_unique_jobs/testing.rb

@@ -21,7 +21,7 @@ module Sidekiq
   #
   # @param [Hash<Symbol, Object>] tmp_config the temporary config to use
   #
-  def self.use_options(tmp_config = {}) # rubocop:disable Metrics/MethodLength
+  def self.use_options(tmp_config = {})
     if respond_to?(:default_job_options)
       default_job_options.clear
       self.default_job_options = tmp_config
@@ -87,7 +87,7 @@ module Sidekiq
       def sidekiq_options(options = {})
         SidekiqUniqueJobs.validate_worker!(options) if SidekiqUniqueJobs.config.raise_on_config_error
 
-        super(options)
+        super
       end
 
       #

data/lib/sidekiq_unique_jobs/version.rb

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

data/lib/sidekiq_unique_jobs/web/helpers.rb

@@ -116,7 +116,7 @@ module SidekiqUniqueJobs
       #
       # @return a redirect to the new subpath
       #
-      def redirect_to(subpath)
+      def safe_redirect_to(subpath)
         if respond_to?(:to)
           # Sinatra-based web UI
           redirect to(subpath)
@@ -170,6 +170,34 @@ module SidekiqUniqueJobs
           Time.parse(time.to_s)
         end
       end
+
+      # Copied from sidekiq for compatibility with older versions
+
+      # stuff after ? or form input
+      # uses String keys, no Symbols!
+      def safe_url_params(key)
+        return url_params(key) if Sidekiq::MAJOR >= 8
+
+        if key.is_a?(Symbol)
+          warn do
+            "URL parameter `#{key}` should be accessed via String, not Symbol (at #{caller(3..3).first})"
+          end
+        end
+        request.params[key.to_s]
+      end
+
+      # variables embedded in path, `/metrics/:name`
+      # uses Symbol keys, no Strings!
+      def safe_route_params(key)
+        return route_params(key) if Sidekiq::MAJOR >= 8
+
+        if key.is_a?(String)
+          warn do
+            "Route parameter `#{key}` should be accessed via Symbol, not String (at #{caller(3..3).first})"
+          end
+        end
+        env["rack.route_params"][key.to_sym]
+      end
     end
   end
 end

data/lib/sidekiq_unique_jobs/web.rb

@@ -7,17 +7,15 @@ module SidekiqUniqueJobs
   # Useful for deleting keys that for whatever reason wasn't deleted
   # @author Mikael Henriksson <mikael@mhenrixon.com>
   module Web
-    def self.registered(app) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-      app.helpers do
-        include Web::Helpers
-      end
+    def self.registered(app)
+      app.helpers Web::Helpers
 
       app.get "/changelogs" do
-        @filter         = h(params[:filter] || "*")
+        @filter         = h(safe_url_params("filter") || "*")
         @filter         = "*" if @filter == ""
-        @count          = h(params[:count] || 100).to_i
-        @current_cursor = h(params[:cursor]).to_i
-        @prev_cursor    = h(params[:prev_cursor]).to_i
+        @count          = h(safe_url_params("count") || 100).to_i
+        @current_cursor = h(safe_url_params("cursor")).to_i
+        @prev_cursor    = h(safe_url_params("prev_cursor")).to_i
         @total_size, @next_cursor, @changelogs = changelog.page(
           cursor: @current_cursor,
           pattern: @filter,
@@ -29,15 +27,15 @@ module SidekiqUniqueJobs
 
       app.get "/changelogs/delete_all" do
         changelog.clear
-        redirect_to :changelogs
+        safe_redirect_to :changelogs
       end
 
       app.get "/locks" do
-        @filter         = h(params[:filter]) || "*"
+        @filter         = h(safe_url_params("filter") || "*")
         @filter         = "*" if @filter == ""
-        @count          = h(params[:count] || 100).to_i
-        @current_cursor = h(params[:cursor]).to_i
-        @prev_cursor    = h(params[:prev_cursor]).to_i
+        @count          = h(safe_url_params("count") || 100).to_i
+        @current_cursor = h(safe_url_params("cursor")).to_i
+        @prev_cursor    = h(safe_url_params("prev_cursor")).to_i
 
         @total_size, @next_cursor, @locks = digests.page(
           cursor: @current_cursor,
@@ -49,11 +47,11 @@ module SidekiqUniqueJobs
       end
 
       app.get "/expiring_locks" do
-        @filter         = h(params[:filter]) || "*"
+        @filter         = h(safe_url_params("filter") || "*")
         @filter         = "*" if @filter == ""
-        @count          = h(params[:count] || 100).to_i
-        @current_cursor = h(params[:cursor]).to_i
-        @prev_cursor    = h(params[:prev_cursor]).to_i
+        @count          = h(safe_url_params("count") || 100).to_i
+        @current_cursor = h(safe_url_params("cursor")).to_i
+        @prev_cursor    = h(safe_url_params("prev_cursor")).to_i
 
         @total_size, @next_cursor, @locks = expiring_digests.page(
           cursor: @current_cursor,
@@ -67,29 +65,29 @@ module SidekiqUniqueJobs
       app.get "/locks/delete_all" do
         digests.delete_by_pattern("*", count: digests.count)
         expiring_digests.delete_by_pattern("*", count: digests.count)
-        redirect_to :locks
+        safe_redirect_to :locks
       end
 
       app.get "/locks/:digest" do
-        @digest = h(params[:digest])
+        @digest = h(safe_route_params(:digest))
         @lock   = SidekiqUniqueJobs::Lock.new(@digest)
 
         erb(unique_template(:lock))
       end
 
       app.get "/locks/:digest/delete" do
-        digests.delete_by_digest(h(params[:digest]))
-        expiring_digests.delete_by_digest(h(params[:digest]))
-        redirect_to :locks
+        digests.delete_by_digest(h(safe_route_params(:digest)))
+        expiring_digests.delete_by_digest(h(safe_route_params(:digest)))
+        safe_redirect_to :locks
       end
 
       app.get "/locks/:digest/jobs/:job_id/delete" do
-        @digest = h(params[:digest])
-        @job_id = h(params[:job_id])
+        @digest = h(safe_route_params(:digest))
+        @job_id = h(safe_route_params(:job_id))
         @lock   = SidekiqUniqueJobs::Lock.new(@digest)
         @lock.unlock(@job_id)
 
-        redirect_to "locks/#{@lock.key}"
+        safe_redirect_to "locks/#{@lock.key}"
       end
     end
   end
@@ -99,11 +97,21 @@ begin
   require "delegate" unless defined?(DelegateClass)
   require "sidekiq/web" unless defined?(Sidekiq::Web)
 
-  Sidekiq::Web.register(SidekiqUniqueJobs::Web)
-  Sidekiq::Web.tabs["Locks"]          = "locks"
-  Sidekiq::Web.tabs["Expiring Locks"] = "expiring_locks"
-  Sidekiq::Web.tabs["Changelogs"]     = "changelogs"
-  Sidekiq::Web.settings.locales << File.join(File.dirname(__FILE__), "locales")
+  if Sidekiq::MAJOR >= 8
+    Sidekiq::Web.configure do |config|
+      config.register_extension(
+        SidekiqUniqueJobs::Web,
+        name: "unique_jobs",
+        tab: ["Locks", "Expiring Locks", "Changelogs"],
+        index: %w[locks/ expiring_locks/ changelogs/],
+      )
+    end
+  else
+    Sidekiq::Web.register(SidekiqUniqueJobs::Web)
+    Sidekiq::Web.tabs["Locks"]          = "locks"
+    Sidekiq::Web.tabs["Expiring Locks"] = "expiring_locks"
+    Sidekiq::Web.tabs["Changelogs"]     = "changelogs"
+  end
 rescue NameError, LoadError => ex
   SidekiqUniqueJobs.logger.error(ex)
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-unique-jobs
 version: !ruby/object:Gem::Version
-  version: 8.0.10
+  version: 8.0.12
 platform: ruby
 authors:
 - Mikael Henriksson
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-22 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -39,7 +38,7 @@ dependencies:
         version: 7.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 8.0.0
+        version: 9.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -49,7 +48,7 @@ dependencies:
         version: 7.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 8.0.0
+        version: 9.0.0
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -208,7 +207,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -223,8 +221,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
-signing_key:
+rubygems_version: 3.7.2
 specification_version: 4
 summary: Sidekiq middleware that prevents duplicates jobs
 test_files: []