sidekiq-unique-jobs 6.0.25 → 7.1.29

data/lib/sidekiq_unique_jobs/redis/sorted_set.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module SidekiqUniqueJobs
+  module Redis
+    #
+    # Class SortedSet provides convenient access to redis sorted sets
+    #
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
+    #
+    class SortedSet < Entity
+      #
+      # Return entries for this sorted set
+      #
+      # @param [true,false] with_scores true return
+      #
+      # @return [Array<Object>] when given with_scores: false
+      # @return [Hash] when given with_scores: true
+      #
+      def entries(with_scores: true)
+        entrys = redis { |conn| conn.zrange(key, 0, -1, with_scores: with_scores) }
+        return entrys unless with_scores
+
+        entrys.each_with_object({}) { |pair, hash| hash[pair[0]] = pair[1] }
+      end
+
+      #
+      # Adds a value to the sorted set
+      #
+      # @param [Array<Float, String>, String] values the values to add
+      #
+      # @return [Boolean, Integer] <description>
+      #
+      def add(values)
+        redis do |conn|
+          if values.is_a?(Array)
+            conn.zadd(key, values)
+          else
+            conn.zadd(key, now_f, values)
+          end
+        end
+      end
+
+      #
+      # Return the zrak of the member
+      #
+      # @param [String] member the member to pull rank on
+      #
+      # @return [Integer]
+      #
+      def rank(member)
+        redis { |conn| conn.zrank(key, member) }
+      end
+
+      #
+      # Return score for a member
+      #
+      # @param [String] member the member for which score
+      #
+      # @return [Integer, Float]
+      #
+      def score(member)
+        redis { |conn| conn.zscore(key, member) }
+      end
+
+      #
+      # Clears the sorted set from all entries
+      #
+      #
+      # @return [Integer] number of entries removed
+      #
+      def clear
+        redis { |conn| conn.zremrangebyrank(key, 0, count) }
+      end
+
+      #
+      # Returns the count for this sorted set
+      #
+      #
+      # @return [Integer] the number of entries
+      #
+      def count
+        redis { |conn| conn.zcard(key) }
+      end
+    end
+  end
+end

data/lib/sidekiq_unique_jobs/redis/string.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module SidekiqUniqueJobs
+  module Redis
+    #
+    # Class String provides convenient access to redis strings
+    #
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
+    #
+    class String < Entity
+      #
+      # Returns the value of the key
+      #
+      #
+      # @return [String]
+      #
+      def value
+        redis { |conn| conn.get(key) }
+      end
+
+      #
+      # Sets the value of the key to given object
+      #
+      # @param [String] obj the object to update the key with
+      #
+      # @return [true, false]
+      #
+      def set(obj, pipeline = nil)
+        return pipeline.set(key, obj) if pipeline
+
+        redis { |conn| conn.set(key, obj) }
+      end
+
+      #
+      # Removes the key from redis
+      #
+      def del(*)
+        redis { |conn| conn.del(key) }
+      end
+
+      #
+      # Used only for compatibility with other keys
+      #
+      # @return [1] when key exists
+      # @return [0] when key does not exists
+      def count
+        exist? ? 1 : 0
+      end
+    end
+  end
+end

data/lib/sidekiq_unique_jobs/redis.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module SidekiqUniqueJobs
+  #
+  # Augments and enhances redis with object oriented methods
+  #
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
+  #
+  module Redis
+  end
+end

data/lib/sidekiq_unique_jobs/reflectable.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module SidekiqUniqueJobs
+  #
+  # Module Reflectable provides a method to notify subscribers
+  #
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
+  #
+  module Reflectable
+    #
+    # Reflects on specific event
+    #
+    # @param [Symbol] reflection the reflected event
+    # @param [Array] args arguments to provide to reflector
+    #
+    # @return [void]
+    #
+    def reflect(reflection, *args)
+      SidekiqUniqueJobs.reflections.dispatch(reflection, *args)
+      nil
+    rescue UniqueJobsError => ex
+      SidekiqUniqueJobs.logger.error(ex)
+      nil
+    end
+  end
+end

data/lib/sidekiq_unique_jobs/reflections.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module SidekiqUniqueJobs
+  #
+  # Class NotificationCollection provides a collection with known notifications
+  #
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
+  #
+  class Reflections
+    #
+    # @return [Array<Symbol>] list of notifications
+    REFLECTIONS = [
+      :after_unlock_callback_failed,
+      :debug,
+      :duplicate,
+      :error,
+      :execution_failed,
+      :lock_failed,
+      :locked,
+      :reschedule_failed,
+      :rescheduled,
+      :timeout,
+      :unknown_sidekiq_worker,
+      :unlock_failed,
+      :unlocked,
+    ].freeze
+
+    #
+    # @return [Hash<Symbol, Array<Symbol, String>>] a hash with deprecated notifications
+    DEPRECATIONS = {}.freeze
+
+    REFLECTIONS.each do |reflection|
+      class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
+        def #{reflection}(*args, &block)                            # def unlock_failed(*args, &block)
+          raise NoBlockGiven, "block required" unless block_given?  #   raise NoBlockGiven, "block required" unless block_given?
+          @reflections[:#{reflection}] = block                      #   @notifications[:unlock_failed] = block
+        end                                                         # end
+      RUBY
+    end
+
+    def initialize
+      @reflections = {}
+    end
+
+    #
+    # Dispatch a reflected event
+    #
+    # @param [reflection] reflection the reflected event
+    # @param [Array] args the arguments to provide to the block
+    #
+    # @return [void] <description>
+    #
+    def dispatch(reflection, *args)
+      if (block = @reflections[reflection])
+        block.call(*args)
+
+        if DEPRECATIONS.key?(reflection)
+          replacement, removal_version = DEPRECATIONS[reflection]
+          SidekiqUniqueJobs::Deprecation.warn(
+            "#{reflection} is deprecated and will be removed in version #{removal_version}." \
+            " Use #{replacement} instead.",
+          )
+        end
+      elsif misconfigured?(reflection)
+        raise NoSuchNotificationError, reflection
+      end
+
+      nil
+    end
+
+    def configured?(reflection)
+      REFLECTIONS.include?(reflection)
+    end
+
+    def misconfigured?(reflection)
+      !configured?(reflection)
+    end
+  end
+end

data/lib/sidekiq_unique_jobs/rspec/matchers/have_valid_sidekiq_options.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module SidekiqUniqueJobs
+  module RSpec
+    #
+    # Module Matchers provides RSpec matcher for your workers
+    #
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
+    #
+    module Matchers
+      #
+      # Class HaveValidSidekiqOptions validates the unique/lock configuration for a worker.
+      #
+      # @author Mikael Henriksson <mikael@mhenrixon.com>
+      #
+      class HaveValidSidekiqOptions
+        attr_reader :worker, :lock_config, :sidekiq_options
+
+        def matches?(worker)
+          @worker          = worker
+          @sidekiq_options = worker.get_sidekiq_options
+          @lock_config     = SidekiqUniqueJobs.validate_worker(sidekiq_options)
+          lock_config.valid?
+        end
+
+        # :nodoc:
+        def failure_message
+          <<~FAILURE_MESSAGE
+            Expected #{worker} to have valid sidekiq options but found the following problems:
+            #{lock_config.errors_as_string}
+          FAILURE_MESSAGE
+        end
+
+        # :nodoc:
+        def description
+          "have valid sidekiq options"
+        end
+      end
+
+      #
+      # RSpec matcher method for validating that a sidekiq worker has valid unique/lock configuration
+      #
+      #
+      # @return [HaveValidSidekiqOptions] an RSpec matcher
+      #
+      def have_valid_sidekiq_options(*args) # rubocop:disable Naming/PredicateName
+        HaveValidSidekiqOptions.new(*args)
+      end
+    end
+  end
+end

data/lib/sidekiq_unique_jobs/rspec/matchers.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module SidekiqUniqueJobs
+  #
+  # We all know what the hell RSpec is no?
+  #
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
+  #
+  module RSpec
+    #
+    # Module Matchers provides RSpec matcher for your workers
+    #
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
+    #
+    module Matchers
+    end
+  end
+end
+
+if defined?(RSpec)
+  require_relative "matchers/have_valid_sidekiq_options"
+
+  RSpec.configure do |config|
+    config.include SidekiqUniqueJobs::RSpec::Matchers
+  end
+end

data/lib/sidekiq_unique_jobs/script/caller.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+module SidekiqUniqueJobs
+  # Interface to dealing with .lua files
+  #
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
+  module Script
+    #
+    # Module Caller provides the convenience method #call_script
+    #
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
+    #
+    module Caller
+      module_function
+
+      # includes "SidekiqUniqueJobs::Connection"
+      # @!parse include SidekiqUniqueJobs::Connection
+      include SidekiqUniqueJobs::Connection
+
+      #
+      # Convenience method to reduce typing,
+      #   calls redis lua scripts.
+      #
+      #
+      # @overload call_script(file_name, keys, argv, conn)
+      #   Call script without options hash
+      #   @param [Symbol] file_name the name of the file
+      #   @param [Array<String>] keys to pass to the the script
+      #   @param [Array<String>] argv arguments to pass to the script
+      #   @param [Redis] conn a redis connection
+      # @overload call_script(file_name, conn, keys:, argv:)
+      #   Call script with options hash
+      #   @param [Symbol] file_name the name of the file
+      #   @param [Redis] conn a redis connection
+      #   @param [Hash] options arguments to pass to the script file
+      #   @option options [Array] :keys to pass to the script
+      #   @option options [Array] :argv arguments to pass to the script
+      #
+      # @return [true,false,String,Integer,Float,nil] returns the return value of the lua script
+      #
+      def call_script(file_name, *args)
+        conn, keys, argv = extract_args(*args)
+        return do_call(file_name, conn, keys, argv) if conn
+
+        pool = defined?(redis_pool) ? redis_pool : nil
+
+        redis(pool) do |new_conn|
+          result = do_call(file_name, new_conn, keys, argv)
+          yield result if block_given?
+          result
+        end
+      end
+
+      # Only used to reduce a little bit of duplication
+      # @see call_script
+      def do_call(file_name, conn, keys, argv)
+        argv = argv.dup.concat([
+                                 now_f,
+                                 debug_lua,
+                                 max_history,
+                                 file_name,
+                                 redis_version,
+                               ])
+        Script.execute(file_name, conn, keys: keys, argv: argv)
+      end
+
+      #
+      # Utility method to allow both symbol keys and arguments
+      #
+      # @overload call_script(file_name, keys, argv, conn)
+      #   Call script without options hash
+      #   @param [Symbol] file_name the name of the file
+      #   @param [Array<String>] keys to pass to the the script
+      #   @param [Array<String>] argv arguments to pass to the script
+      #   @param [Redis] conn a redis connection
+      # @overload call_script(file_name, conn, keys:, argv:)
+      #   Call script with options hash
+      #   @param [Symbol] file_name the name of the file
+      #   @param [Redis] conn a redis connection
+      #   @param [Hash] options arguments to pass to the script file
+      #   @option options [Array] :keys to pass to the script
+      #   @option options [Array] :argv arguments to pass to the script
+      #
+      # @return [Array<Redis, Array, Array>] <description>
+      #
+      def extract_args(*args)
+        options = args.extract_options!
+        if options.length.positive?
+          [args.pop, options.fetch(:keys) { [] }, options.fetch(:argv) { [] }]
+        else
+          keys, argv = args.shift(2)
+          keys ||= []
+          argv ||= []
+          [args.pop, keys, argv]
+        end
+      end
+
+      #
+      # @see SidekiqUniqueJobs#now_f
+      #
+      def now_f
+        SidekiqUniqueJobs.now_f
+      end
+
+      #
+      # @see SidekiqUniqueJobs::Config#debug_lua
+      #
+      def debug_lua
+        SidekiqUniqueJobs.config.debug_lua
+      end
+
+      #
+      # @see SidekiqUniqueJobs::Config#max_history
+      #
+      def max_history
+        SidekiqUniqueJobs.config.max_history
+      end
+
+      #
+      # @see SidekiqUniqueJobs::Config#max_history
+      #
+      def redis_version
+        SidekiqUniqueJobs.config.redis_version
+      end
+    end
+  end
+end

data/lib/sidekiq_unique_jobs/script.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module SidekiqUniqueJobs
+  # Interface to dealing with .lua files
+  #
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
+  module Script
+    include Brpoplpush::RedisScript::DSL
+
+    configure do |config|
+      config.scripts_path = Pathname.new(__FILE__).dirname.join("lua")
+      config.logger       = Sidekiq.logger # TODO: This becomes a little weird
+    end
+  end
+end

data/lib/sidekiq_unique_jobs/server.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module SidekiqUniqueJobs
+  # The unique sidekiq middleware for the server processor
+  #
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
+  class Server
+    DEATH_HANDLER = (lambda do |job, _ex|
+      return unless (digest = job["lock_digest"])
+
+      SidekiqUniqueJobs::Digests.new.delete_by_digest(digest)
+    end).freeze
+    #
+    # Configure the server middleware
+    #
+    #
+    # @return [Sidekiq] the sidekiq configuration
+    #
+    def self.configure(config)
+      config.on(:startup)  { start }
+      config.on(:shutdown) { stop }
+
+      return unless config.respond_to?(:death_handlers)
+
+      config.death_handlers << death_handler
+    end
+
+    #
+    # Start the sidekiq unique jobs server process
+    #
+    #
+    # @return [void]
+    #
+    def self.start
+      SidekiqUniqueJobs::UpdateVersion.call
+      SidekiqUniqueJobs::UpgradeLocks.call
+      SidekiqUniqueJobs::Orphans::Manager.start
+      SidekiqUniqueJobs::Orphans::ReaperResurrector.start
+    end
+
+    #
+    # Stop the sidekiq unique jobs server process
+    #
+    #
+    # @return [void]
+    #
+    def self.stop
+      SidekiqUniqueJobs::Orphans::Manager.stop
+    end
+
+    #
+    # A death handler for dead jobs
+    #
+    #
+    # @return [lambda]
+    #
+    def self.death_handler
+      DEATH_HANDLER
+    end
+  end
+end