sidekiq-unique-jobs 6.0.7 → 7.1.33

data/lib/sidekiq_unique_jobs/options_with_fallback.rb

@@ -6,27 +6,22 @@ module SidekiqUniqueJobs
   # Requires the following methods to be defined in the including class
   #   1. item (required)
   #   2. options (can be nil)
-  #   3. worker_class (required, can be anything)
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  #   3. job_class (required, can be anything)
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   module OptionsWithFallback
-    LOCKS = {
-      until_and_while_executing: SidekiqUniqueJobs::Lock::UntilAndWhileExecuting,
-      until_executed: SidekiqUniqueJobs::Lock::UntilExecuted,
-      until_executing: SidekiqUniqueJobs::Lock::UntilExecuting,
-      until_expired: SidekiqUniqueJobs::Lock::UntilExpired,
-      until_timeout: SidekiqUniqueJobs::Lock::UntilExpired,
-      while_executing: SidekiqUniqueJobs::Lock::WhileExecuting,
-      while_executing_reject: SidekiqUniqueJobs::Lock::WhileExecutingReject,
-    }.freeze
-
     def self.included(base)
       base.send(:include, SidekiqUniqueJobs::SidekiqWorkerMethods)
     end
 
+    # A convenience method for using the configured locks
+    def locks
+      SidekiqUniqueJobs.locks
+    end
+
     # Check if unique has been enabled
     # @return [true, false] indicate if the gem has been enabled
     def unique_enabled?
-      SidekiqUniqueJobs.config.enabled && lock_type
+      SidekiqUniqueJobs.enabled? && lock_type
     end
 
     # Check if unique has been disabled
@@ -34,40 +29,48 @@ module SidekiqUniqueJobs
       !unique_enabled?
     end
 
-    # Check if we should log duplicate payloads
-    def log_duplicate_payload?
-      options[LOG_DUPLICATE_KEY] || item[LOG_DUPLICATE_KEY]
+    #
+    # A new lock for this Sidekiq Job
+    #
+    #
+    # @return [Lock::BaseLock] an instance of a lock implementation
+    #
+    def lock_instance
+      @lock_instance ||= lock_class.new(item, after_unlock_hook, @redis_pool)
     end
 
-    # Check if we should log duplicate payloads
-    # @return [SidekiqUniqueJobs::Lock::BaseLock] an instance of a child class
-    def lock
-      @lock ||= lock_class.new(item, after_unlock_hook, @redis_pool)
-    end
-
-    # Check if we should log duplicate payloads
-    # @return [SidekiqUniqueJobs::Lock::BaseLock] an instance of a child class
+    #
+    # Returns the corresponding class for the lock_type
+    #
+    #
+    # @return [Class]
+    #
     def lock_class
-      @lock_class ||= begin
-        LOCKS.fetch(lock_type.to_sym) do
-          fail UnknownLock, "No implementation for `lock: :#{lock_type}`"
-        end
+      @lock_class ||= locks.fetch(lock_type.to_sym) do
+        raise UnknownLock, "No implementation for `lock: :#{lock_type}`"
       end
     end
 
-    # @return [Symbol]
+    #
+    # The type of lock for this worker
+    #
+    #
+    # @return [Symbol, NilClass]
+    #
     def lock_type
-      @lock_type ||= options[LOCK_KEY] || item[LOCK_KEY] || unique_type
-    end
-
-    def unique_type
-      options[UNIQUE_KEY] || item[UNIQUE_KEY]
+      @lock_type ||= options[LOCK] || item[LOCK]
     end
 
+    #
+    # The default options with any matching keys overridden from worker options
+    #
+    #
+    # @return [Hash<String, Object>]
+    #
     def options
       @options ||= begin
-        opts = default_worker_options.dup
-        opts.merge!(worker_options) if sidekiq_worker_class?
+        opts = default_job_options.dup
+        opts.merge!(job_options) if sidekiq_job_class?
         (opts || {}).stringify_keys
       end
     end

data/lib/sidekiq_unique_jobs/orphans/lua_reaper.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module SidekiqUniqueJobs
+  module Orphans
+    #
+    # Class DeleteOrphans provides deletion of orphaned digests
+    #
+    # @note this is a much slower version of the lua script but does not crash redis
+    #
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
+    #
+    class LuaReaper < Reaper
+      #
+      # Delete orphaned digests
+      #
+      #
+      # @return [Integer] the number of reaped locks
+      #
+      def call
+        call_script(
+          :reap_orphans,
+          conn,
+          keys: [DIGESTS, EXPIRING_DIGESTS, SCHEDULE, RETRY, PROCESSES],
+          argv: [reaper_count, (Time.now - reaper_timeout).to_f],
+        )
+      end
+    end
+  end
+end

data/lib/sidekiq_unique_jobs/orphans/manager.rb

@@ -0,0 +1,241 @@
+# frozen_string_literal: true
+
+require "concurrent/version"
+
+module SidekiqUniqueJobs
+  module Orphans
+    #
+    # Manages the orphan reaper
+    #
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
+    #
+    module Manager
+      module_function
+
+      #
+      # @return [Float] the amount to add to the reaper interval
+      DRIFT_FACTOR = 0.02
+      #
+      # @return [Symbol] allowed reapers (:ruby or :lua)
+      REAPERS      = [:ruby, :lua].freeze
+
+      # includes "SidekiqUniqueJobs::Connection"
+      # @!parse include SidekiqUniqueJobs::Connection
+      include SidekiqUniqueJobs::Connection
+      # includes "SidekiqUniqueJobs::Logging"
+      # @!parse include SidekiqUniqueJobs::Logging
+      include SidekiqUniqueJobs::Logging
+
+      #
+      # Starts a separate thread that periodically reaps orphans
+      #
+      #
+      # @return [SidekiqUniqueJobs::TimerTask] the task that was started
+      #
+      def start(test_task = nil) # rubocop:disable
+        return if disabled?
+        return if registered?
+
+        self.task = test_task || default_task
+
+        with_logging_context do
+          register_reaper_process
+          log_info("Starting Reaper")
+
+          task.add_observer(Observer.new)
+          task.execute
+          task
+        end
+      end
+
+      #
+      # Stops the thread that reaps orphans
+      #
+      #
+      # @return [Boolean]
+      #
+      def stop
+        return if disabled?
+        return if unregistered?
+
+        with_logging_context do
+          log_info("Stopping Reaper")
+          unregister_reaper_process
+          task.shutdown
+        end
+      end
+
+      #
+      # The task that runs the reaper
+      #
+      #
+      # @return [<type>] <description>
+      #
+      def task
+        @task ||= default_task # rubocop:disable ThreadSafety/InstanceVariableInClassMethod
+      end
+
+      #
+      # A properly configured timer task
+      #
+      #
+      # @return [SidekiqUniqueJobs::TimerTask]
+      #
+      def default_task
+        SidekiqUniqueJobs::TimerTask.new(timer_task_options) do
+          with_logging_context do
+            redis do |conn|
+              refresh_reaper_mutex
+              Orphans::Reaper.call(conn)
+            end
+          end
+        end
+      end
+
+      #
+      # Store a task to use for scheduled execution
+      #
+      # @param [SidekiqUniqueJobs::TimerTask] task the task to use
+      #
+      # @return [void]
+      #
+      def task=(task)
+        @task = task # rubocop:disable ThreadSafety/InstanceVariableInClassMethod
+      end
+
+      #
+      # Arguments passed on to the timer task
+      #
+      #
+      # @return [Hash]
+      #
+      def timer_task_options
+        { run_now: true, execution_interval: reaper_interval }
+      end
+
+      #
+      # @see SidekiqUniqueJobs::Config#reaper
+      #
+      def reaper
+        SidekiqUniqueJobs.config.reaper
+      end
+
+      #
+      # @see SidekiqUniqueJobs::Config#reaper_interval
+      #
+      def reaper_interval
+        SidekiqUniqueJobs.config.reaper_interval
+      end
+
+      #
+      # A context to use for all log entries
+      #
+      #
+      # @return [Hash] when logger responds to `:with_context`
+      # @return [String] when logger does not responds to `:with_context`
+      #
+      def logging_context
+        if logger_context_hash?
+          { "uniquejobs" => "reaper" }
+        else
+          "uniquejobs=orphan-reaper"
+        end
+      end
+
+      #
+      # Checks if a reaper is registered
+      #
+      #
+      # @return [true, false]
+      #
+      def registered?
+        redis do |conn|
+          conn.get(UNIQUE_REAPER).to_i + drift_reaper_interval > current_timestamp
+        end
+      end
+
+      #
+      # Checks if that reapers are not registerd
+      #
+      # @see registered?
+      #
+      # @return [true, false]
+      #
+      def unregistered?
+        !registered?
+      end
+
+      #
+      # Checks if reaping is disabled
+      #
+      # @see enabled?
+      #
+      # @return [true, false]
+      #
+      def disabled?
+        !enabled?
+      end
+
+      #
+      # Checks if reaping is enabled
+      #
+      # @return [true, false]
+      #
+      def enabled?
+        REAPERS.include?(reaper)
+      end
+
+      #
+      # Writes a mutex key to redis
+      #
+      #
+      # @return [void]
+      #
+      def register_reaper_process
+        redis { |conn| conn.set(UNIQUE_REAPER, current_timestamp, nx: true, ex: drift_reaper_interval) }
+      end
+
+      #
+      # Updates mutex key
+      #
+      #
+      # @return [void]
+      #
+      def refresh_reaper_mutex
+        redis { |conn| conn.set(UNIQUE_REAPER, current_timestamp, ex: drift_reaper_interval) }
+      end
+
+      #
+      # Removes mutex key from redis
+      #
+      #
+      # @return [void]
+      #
+      def unregister_reaper_process
+        redis { |conn| conn.del(UNIQUE_REAPER) }
+      end
+
+      #
+      # Reaper interval with a little drift
+      #   Redis isn't exact enough so to give a little bufffer,
+      #   we add a tiny value to the reaper interval.
+      #
+      #
+      # @return [Integer] <description>
+      #
+      def drift_reaper_interval
+        reaper_interval + (reaper_interval * DRIFT_FACTOR).to_i
+      end
+
+      #
+      # Current time (as integer value)
+      #
+      #
+      # @return [Integer]
+      #
+      def current_timestamp
+        Time.now.to_i
+      end
+    end
+  end
+end

data/lib/sidekiq_unique_jobs/orphans/null_reaper.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module SidekiqUniqueJobs
+  module Orphans
+    #
+    # Class DeleteOrphans provides deletion of orphaned digests
+    #
+    # @note this is a much slower version of the lua script but does not crash redis
+    #
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
+    #
+    class NullReaper < Reaper
+      #
+      # Delete orphaned digests
+      #
+      #
+      # @return [Integer] the number of reaped locks
+      #
+      def call
+        # NO OP
+      end
+    end
+  end
+end

data/lib/sidekiq_unique_jobs/orphans/observer.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module SidekiqUniqueJobs
+  #
+  # Class DeleteOrphans provides deletion of orphaned digests
+  #
+  # @note this is a much slower version of the lua script but does not crash redis
+  #
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
+  #
+  module Orphans
+    #
+    # Observes the Orphan::Manager and provides information about each execution
+    #
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
+    #
+    class Observer
+      include SidekiqUniqueJobs::Logging
+
+      #
+      # Runs every time the {Manager} executes the TimerTask
+      #   used for logging information about the reaping
+      #
+      # @param [Time] time the time of the execution
+      # @param [Object] result the result of the execution
+      # @param [Exception] ex any error raised from the TimerTask
+      #
+      # @return [<type>] <description>
+      #
+      def update(time, result, ex)
+        if result
+          log_info("(#{time}) Execution successfully returned #{result}")
+        elsif ex.is_a?(Concurrent::TimeoutError)
+          log_warn("(#{time}) Execution timed out")
+        else
+          log_info("(#{time}) Cleanup failed with error #{ex.message}")
+          log_error(ex)
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq_unique_jobs/orphans/reaper.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+module SidekiqUniqueJobs
+  module Orphans
+    #
+    # Class DeleteOrphans provides deletion of orphaned digests
+    #
+    # @note this is a much slower version of the lua script but does not crash redis
+    #
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
+    #
+    class Reaper
+      include SidekiqUniqueJobs::Connection
+      include SidekiqUniqueJobs::Script::Caller
+      include SidekiqUniqueJobs::Logging
+      include SidekiqUniqueJobs::JSON
+
+      require_relative "lua_reaper"
+      require_relative "ruby_reaper"
+      require_relative "null_reaper"
+
+      #
+      # @return [Hash<Symbol, SidekiqUniqueJobs::Orphans::Reaper] the current implementation of reapers
+      REAPERS = {
+        lua: SidekiqUniqueJobs::Orphans::LuaReaper,
+        ruby: SidekiqUniqueJobs::Orphans::RubyReaper,
+        none: SidekiqUniqueJobs::Orphans::NullReaper,
+        nil => SidekiqUniqueJobs::Orphans::NullReaper,
+        false => SidekiqUniqueJobs::Orphans::NullReaper,
+      }.freeze
+
+      #
+      # Execute deletion of orphaned digests
+      #
+      # @param [Redis] conn nil a connection to redis
+      #
+      # @return [void]
+      #
+      def self.call(conn = nil)
+        return new(conn).call if conn
+
+        redis { |rcon| new(rcon).call }
+      end
+
+      #
+      # @!attribute [r] conn
+      #   @return [Redis] a redis connection
+      attr_reader :conn
+
+      #
+      # Initialize a new instance of DeleteOrphans
+      #
+      # @param [Redis] conn a connection to redis
+      #
+      def initialize(conn)
+        @conn = conn
+      end
+
+      #
+      # Convenient access to the global configuration
+      #
+      #
+      # @return [SidekiqUniqueJobs::Config]
+      #
+      def config
+        SidekiqUniqueJobs.config
+      end
+
+      #
+      # The reaper that was configured
+      #
+      #
+      # @return [Symbol]
+      #
+      def reaper
+        config.reaper
+      end
+
+      #
+      # The configured timeout for the reaper
+      #
+      #
+      # @return [Integer] timeout in seconds
+      #
+      def reaper_timeout
+        config.reaper_timeout
+      end
+
+      #
+      # The number of locks to reap at a time
+      #
+      #
+      # @return [Integer]
+      #
+      def reaper_count
+        config.reaper_count
+      end
+
+      #
+      # Delete orphaned digests
+      #
+      #
+      # @return [Integer] the number of reaped locks
+      #
+      def call
+        if (implementation = REAPERS[reaper])
+          implementation.new(conn).call
+        else
+          log_fatal(":#{reaper} is invalid for `SidekiqUnqiueJobs.config.reaper`")
+        end
+      end
+    end
+  end
+end