sidekiq-unique-jobs 8.0.3 → 8.0.10

data/lib/sidekiq_unique_jobs/script/lua_error.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module SidekiqUniqueJobs
+  module Script
+    #
+    # Misconfiguration is raised when gem is misconfigured
+    #
+    # @author Mikael Henriksson <mikael@zoolutions.se>
+    #
+    class Misconfiguration < RuntimeError
+    end
+
+    # LuaError raised on errors in Lua scripts
+    #
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
+    class LuaError < RuntimeError
+      # Reformats errors raised by redis representing failures while executing
+      # a lua script. The default errors have confusing messages and backtraces,
+      # and a type of +RuntimeError+. This class improves the message and
+      # modifies the backtrace to include the lua script itself in a reasonable
+      # way.
+
+      PATTERN  = /ERR Error (compiling|running) script \(.*?\): .*?:(\d+): (.*)/.freeze
+      LIB_PATH = File.expand_path("..", __dir__).freeze
+      CONTEXT_LINE_NUMBER = 2
+
+      attr_reader :error, :file, :content
+
+      # Is this error one that should be reformatted?
+      #
+      # @param error [StandardError] the original error raised by redis
+      # @return [Boolean] is this an error that should be reformatted?
+      def self.intercepts?(error)
+        PATTERN.match?(error.message)
+      end
+
+      # Initialize a new {LuaError} from an existing redis error, adjusting
+      # the message and backtrace in the process.
+      #
+      # @param error [StandardError] the original error raised by redis
+      # @param script [Script] a DTO with information about the script
+      #
+      def initialize(error, script)
+        @error        = error
+        @file         = script.path
+        @content      = script.source
+        @backtrace    = @error.backtrace
+
+        @error.message.match(PATTERN) do |regexp_match|
+          line_number   = regexp_match[2].to_i
+          message       = regexp_match[3]
+          error_context = generate_error_context(content, line_number)
+
+          super("#{message}\n\n#{error_context}\n\n")
+          set_backtrace(generate_backtrace(file, line_number))
+        end
+      end
+
+      private
+
+      # :nocov:
+      def generate_error_context(content, line_number)
+        lines                 = content.lines.to_a
+        beginning_line_number = [1, line_number - CONTEXT_LINE_NUMBER].max
+        ending_line_number    = [lines.count, line_number + CONTEXT_LINE_NUMBER].min
+        line_number_width     = ending_line_number.to_s.length
+
+        (beginning_line_number..ending_line_number).map do |number|
+          indicator = (number == line_number) ? "=>" : "  "
+          formatted_number = format("%#{line_number_width}d", number)
+          " #{indicator} #{formatted_number}: #{lines[number - 1]}"
+        end.join.chomp
+      end
+
+      # :nocov:
+      def generate_backtrace(file, line_number)
+        pre_gem                 = backtrace_before_entering_gem(@backtrace)
+        index_of_first_gem_line = (@backtrace.size - pre_gem.size - 1)
+
+        pre_gem.unshift(@backtrace[index_of_first_gem_line])
+        pre_gem.unshift("#{file}:#{line_number}")
+        pre_gem
+      end
+
+      # :nocov:
+      def backtrace_before_entering_gem(backtrace)
+        backtrace.reverse.take_while { |line| !line_from_gem(line) }.reverse
+      end
+
+      # :nocov:
+      def line_from_gem(line)
+        line.split(":").first.include?(LIB_PATH)
+      end
+    end
+  end
+end

data/lib/sidekiq_unique_jobs/script/script.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module SidekiqUniqueJobs
+  module Script
+    # Interface to dealing with .lua files
+    #
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
+    class Script
+      def self.load(name, root_path, conn)
+        script = new(name: name, root_path: root_path)
+        script.load(conn)
+      end
+
+      #
+      # @!attribute [r] script_name
+      #   @return [Symbol, String] the name of the script without extension
+      attr_reader :name
+      #
+      # @!attribute [r] script_path
+      #   @return [String] the path to the script on disk
+      attr_reader :path
+      #
+      # @!attribute [r] root_path
+      #   @return [Pathname]
+      attr_reader :root_path
+      #
+      # @!attribute [r] source
+      #   @return [String] the source code of the lua script
+      attr_reader :source
+      #
+      # @!attribute [rw] sha
+      #   @return [String] the sha of the script
+      attr_reader :sha
+      #
+      # @!attribute [rw] call_count
+      #   @return [Integer] the number of times the script was called/executed
+      attr_reader :call_count
+
+      def initialize(name:, root_path:)
+        @name      = name
+        @root_path = root_path
+        @path      = root_path.join("#{name}.lua").to_s
+        @source    = render_file
+        @sha       = compiled_sha
+        @call_count = 0
+      end
+
+      def ==(other)
+        sha == compiled_sha && compiled_sha == other.sha
+      end
+
+      def increment_call_count
+        @call_count += 1
+      end
+
+      def changed?
+        compiled_sha != sha
+      end
+
+      def render_file
+        Template.new(root_path).render(path)
+      end
+
+      def compiled_sha
+        Digest::SHA1.hexdigest(source)
+      end
+
+      def load(conn)
+        @sha = conn.script(:load, source)
+
+        self
+      end
+    end
+  end
+end

data/lib/sidekiq_unique_jobs/script/scripts.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+module SidekiqUniqueJobs
+  module Script
+    # Interface to dealing with .lua files
+    #
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
+    class Scripts
+      #
+      # @return [Concurrent::Map] a map with configured script paths
+      SCRIPT_PATHS = Concurrent::Map.new
+
+      #
+      # Fetch 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
+      #
+      # @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
+      end
+
+      #
+      # @!attribute [r] scripts
+      #   @return [Concurrent::Map] a collection of loaded scripts
+      attr_reader :scripts
+
+      #
+      # @!attribute [r] root_path
+      #   @return [Pathname] the path to the directory with lua scripts
+      attr_reader :root_path
+
+      def initialize(path)
+        raise ArgumentError, "path needs to be a Pathname" unless path.is_a?(Pathname)
+
+        @scripts   = Concurrent::Map.new
+        @root_path = path
+      end
+
+      def fetch(name, conn)
+        if (script = scripts.get(name.to_sym))
+          return script
+        end
+
+        load(name, conn)
+      end
+
+      def load(name, conn)
+        script = Script.load(name, root_path, conn)
+        scripts.put(name.to_sym, script)
+
+        script
+      end
+
+      def delete(script)
+        if script.is_a?(Script)
+          scripts.delete(script.name)
+        else
+          scripts.delete(script.to_sym)
+        end
+      end
+
+      def kill(conn)
+        if conn.respond_to?(:namespace)
+          conn.redis.script(:kill)
+        else
+          conn.script(:kill)
+        end
+      end
+
+      #
+      # Execute a lua script with given name
+      #
+      # @note this method is recursive if we need to load a lua script
+      #   that wasn't previously loaded.
+      #
+      # @param [Symbol] 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
+      #
+      # @return value from script
+      #
+      def execute(name, conn, keys: [], argv: [])
+        script = fetch(name, conn)
+        conn.evalsha(script.sha, keys, argv)
+      end
+
+      def count
+        scripts.keys.size
+      end
+    end
+  end
+end

data/lib/sidekiq_unique_jobs/script/template.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module SidekiqUniqueJobs
+  # Interface to dealing with .lua files
+  #
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
+  module Script
+    #
+    # Class Template provides LUA script partial template rendering
+    #
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
+    #
+    class Template
+      def initialize(script_path)
+        @script_path = script_path
+      end
+
+      #
+      # Renders a Lua script and includes any partials in that file
+      #  all `<%= include_partial '' %>` replaced with the actual contents of the partial
+      #
+      # @param [Pathname] pathname the path to the
+      #
+      # @return [String] the rendered Luascript
+      #
+      def render(pathname)
+        @partial_templates ||= {}
+        ::ERB.new(File.read(pathname)).result(binding)
+      end
+
+      # helper method to include a lua partial within another lua script
+      #
+      def include_partial(relative_path)
+        return if @partial_templates.key?(relative_path)
+
+        @partial_templates[relative_path] = nil
+        render(Pathname.new("#{@script_path}/#{relative_path}"))
+      end
+    end
+  end
+end

data/lib/sidekiq_unique_jobs/script/timing.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module SidekiqUniqueJobs
+  module Script
+    # Handles timing> of things
+    #
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
+    module Timing
+      module_function
+
+      #
+      # Used for timing method calls
+      #
+      #
+      # @return [yield return, Float]
+      #
+      def timed
+        start_time = now
+
+        [yield, now - start_time]
+      end
+
+      #
+      # Returns a float representation of the current time.
+      #   Either from Process or Time
+      #
+      #
+      # @return [Float]
+      #
+      def now
+        (Process.clock_gettime(Process::CLOCK_MONOTONIC) * 1000).to_i
+      end
+    end
+  end
+end

data/lib/sidekiq_unique_jobs/script.rb

@@ -1,15 +1,46 @@
 # frozen_string_literal: true
 
+require "sidekiq_unique_jobs/script/template"
+require "sidekiq_unique_jobs/script/lua_error"
+require "sidekiq_unique_jobs/script/script"
+require "sidekiq_unique_jobs/script/scripts"
+require "sidekiq_unique_jobs/script/config"
+require "sidekiq_unique_jobs/script/timing"
+require "sidekiq_unique_jobs/script/logging"
+require "sidekiq_unique_jobs/script/dsl"
+require "sidekiq_unique_jobs/script/client"
+
 module SidekiqUniqueJobs
   # Interface to dealing with .lua files
   #
   # @author Mikael Henriksson <mikael@mhenrixon.com>
   module Script
-    include Brpoplpush::RedisScript::DSL
+    include SidekiqUniqueJobs::Script::DSL
 
     configure do |config|
       config.scripts_path = Pathname.new(__FILE__).dirname.join("lua")
       config.logger       = Sidekiq.logger # TODO: This becomes a little weird
     end
+
+    #
+    # The current logger
+    #
+    #
+    # @return [Logger] the configured logger
+    #
+    def self.logger
+      config.logger
+    end
+
+    #
+    # Set a new logger
+    #
+    # @param [Logger] other another logger
+    #
+    # @return [Logger] the new logger
+    #
+    def self.logger=(other)
+      config.logger = other
+    end
   end
 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

@@ -186,7 +186,7 @@ module SidekiqUniqueJobs # rubocop:disable Metrics/ModuleLength
       yield config
     else
       options.each do |key, val|
-        config.send("#{key}=", val)
+        config.send(:"#{key}=", val)
       end
     end
   end
@@ -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.3"
+  VERSION = "8.0.10"
 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 %>