sidekiq-unique-jobs 7.0.0.beta22 → 7.0.0.beta27

data/lib/sidekiq_unique_jobs/middleware.rb

@@ -4,7 +4,7 @@ module SidekiqUniqueJobs
   #
   # Provides the sidekiq middleware that makes the gem work
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   #
   module Middleware
     include SidekiqUniqueJobs::Logging::Middleware
@@ -25,11 +25,19 @@ module SidekiqUniqueJobs
     def self.configure_server # rubocop:disable Metrics/MethodLength
       Sidekiq.configure_server do |config|
         config.client_middleware do |chain|
-          chain.add SidekiqUniqueJobs::Middleware::Client
+          if defined?(Apartment::Sidekiq::Middleware::Client)
+            chain.insert_after Apartment::Sidekiq::Middleware::Client, SidekiqUniqueJobs::Middleware::Client
+          else
+            chain.add SidekiqUniqueJobs::Middleware::Client
+          end
         end
 
         config.server_middleware do |chain|
-          chain.add SidekiqUniqueJobs::Middleware::Server
+          if defined?(Apartment::Sidekiq::Middleware::Server)
+            chain.insert_after Apartment::Sidekiq::Middleware::Server, SidekiqUniqueJobs::Middleware::Server
+          else
+            chain.add SidekiqUniqueJobs::Middleware::Server
+          end
         end
 
         config.on(:startup) do
@@ -51,7 +59,11 @@ module SidekiqUniqueJobs
     def self.configure_client
       Sidekiq.configure_client do |config|
         config.client_middleware do |chain|
-          chain.add SidekiqUniqueJobs::Middleware::Client
+          if defined?(Apartment::Sidekiq::Middleware::Client)
+            chain.insert_after Apartment::Sidekiq::Middleware::Client, SidekiqUniqueJobs::Middleware::Client
+          else
+            chain.add SidekiqUniqueJobs::Middleware::Client
+          end
         end
       end
     end

data/lib/sidekiq_unique_jobs/middleware/client.rb

@@ -4,7 +4,7 @@ module SidekiqUniqueJobs
   module Middleware
     # The unique sidekiq middleware for the client push
     #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
     class Client
       prepend SidekiqUniqueJobs::Middleware
 
@@ -18,15 +18,15 @@ module SidekiqUniqueJobs
       #
       # @yield when uniqueness is disable
       # @yield when the lock is successful
-      def call(*)
-        lock { yield }
+      def call(*, &block)
+        lock(&block)
       end
 
       private
 
       def lock
-        if (token = lock_instance.lock)
-          yield token
+        if (_token = lock_instance.lock)
+          yield
         else
           warn_about_duplicate
         end

data/lib/sidekiq_unique_jobs/middleware/server.rb

@@ -4,7 +4,7 @@ module SidekiqUniqueJobs
   module Middleware
     # The unique sidekiq middleware for the server processor
     #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
     class Server
       prepend SidekiqUniqueJobs::Middleware
 
@@ -19,8 +19,8 @@ module SidekiqUniqueJobs
       #
       # @yield when uniqueness is disabled
       # @yield when owning the lock
-      def call(*)
-        lock_instance.execute { yield }
+      def call(*, &block)
+        lock_instance.execute(&block)
       end
     end
   end

data/lib/sidekiq_unique_jobs/normalizer.rb

@@ -3,7 +3,7 @@
 module SidekiqUniqueJobs
   # Normalizes hashes by dumping them to json and loading them from json
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   module Normalizer
     extend SidekiqUniqueJobs::JSON
 

data/lib/sidekiq_unique_jobs/on_conflict.rb

@@ -12,7 +12,7 @@ module SidekiqUniqueJobs
   #
   # Provides lock conflict resolutions
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   #
   module OnConflict
     # A convenience method for using the configured strategies

data/lib/sidekiq_unique_jobs/on_conflict/log.rb

@@ -4,7 +4,7 @@ module SidekiqUniqueJobs
   module OnConflict
     # Strategy to log information about conflict
     #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
     class Log < OnConflict::Strategy
       include SidekiqUniqueJobs::Logging
 

data/lib/sidekiq_unique_jobs/on_conflict/null_strategy.rb

@@ -4,7 +4,7 @@ module SidekiqUniqueJobs
   module OnConflict
     # Default conflict strategy class that does nothing
     #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
     class NullStrategy < OnConflict::Strategy
       # Do nothing on conflict
       # @return [nil]

data/lib/sidekiq_unique_jobs/on_conflict/raise.rb

@@ -4,7 +4,7 @@ module SidekiqUniqueJobs
   module OnConflict
     # Strategy to raise an error on conflict
     #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
     class Raise < OnConflict::Strategy
       # Raise an error on conflict.
       #   This will cause Sidekiq to retry the job

data/lib/sidekiq_unique_jobs/on_conflict/reject.rb

@@ -4,7 +4,7 @@ module SidekiqUniqueJobs
   module OnConflict
     # Strategy to send jobs to dead queue
     #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
     class Reject < OnConflict::Strategy
       include SidekiqUniqueJobs::Timing
 

data/lib/sidekiq_unique_jobs/on_conflict/replace.rb

@@ -4,7 +4,7 @@ module SidekiqUniqueJobs
   module OnConflict
     # Strategy to replace the job on conflict
     #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
     class Replace < OnConflict::Strategy
       #
       # @!attribute [r] queue

data/lib/sidekiq_unique_jobs/on_conflict/reschedule.rb

@@ -4,7 +4,7 @@ module SidekiqUniqueJobs
   module OnConflict
     # Strategy to reschedule job on conflict
     #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
     class Reschedule < OnConflict::Strategy
       include SidekiqUniqueJobs::SidekiqWorkerMethods
       include SidekiqUniqueJobs::Logging

data/lib/sidekiq_unique_jobs/on_conflict/strategy.rb

@@ -5,7 +5,7 @@ module SidekiqUniqueJobs
     # Abstract conflict strategy class
     #
     # @abstract
-    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
     class Strategy
       include SidekiqUniqueJobs::JSON
       include SidekiqUniqueJobs::Logging

data/lib/sidekiq_unique_jobs/options_with_fallback.rb

@@ -7,7 +7,7 @@ module SidekiqUniqueJobs
   #   1. item (required)
   #   2. options (can be nil)
   #   3. worker_class (required, can be anything)
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   module OptionsWithFallback
     def self.included(base)
       base.send(:include, SidekiqUniqueJobs::SidekiqWorkerMethods)

data/lib/sidekiq_unique_jobs/orphans/lua_reaper.rb

@@ -7,7 +7,7 @@ module SidekiqUniqueJobs
     #
     # @note this is a much slower version of the lua script but does not crash redis
     #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
     #
     class LuaReaper < Reaper
       #

data/lib/sidekiq_unique_jobs/orphans/manager.rb

@@ -5,12 +5,13 @@ module SidekiqUniqueJobs
     #
     # Manages the orphan reaper
     #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
     #
     module Manager
       module_function
 
       DRIFT_FACTOR = 0.02
+      REAPERS      = [:ruby, :lua].freeze
 
       include SidekiqUniqueJobs::Connection
       include SidekiqUniqueJobs::Logging
@@ -22,8 +23,8 @@ module SidekiqUniqueJobs
       # @return [Concurrent::TimerTask] the task that was started
       #
       def start # rubocop:disable
-        return if registered?
         return if disabled?
+        return if registered?
 
         with_logging_context do
           register_reaper_process
@@ -41,6 +42,9 @@ module SidekiqUniqueJobs
       # @return [Boolean]
       #
       def stop
+        return if disabled?
+        return if unregistered?
+
         with_logging_context do
           log_info("Stopping Reaper")
           unregister_reaper_process
@@ -114,7 +118,7 @@ module SidekiqUniqueJobs
       end
 
       #
-      # Checks if a reaper is already registered
+      # Checks if a reaper is registered
       #
       #
       # @return [true, false]
@@ -125,8 +129,35 @@ module SidekiqUniqueJobs
         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?
-        reaper == :none
+        !enabled?
+      end
+
+      #
+      # Checks if reaping is enabled
+      #
+      # @return [true, false]
+      #
+      def enabled?
+        REAPERS.include?(reaper)
       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

@@ -6,13 +6,13 @@ module SidekiqUniqueJobs
   #
   # @note this is a much slower version of the lua script but does not crash redis
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   #
   module Orphans
     #
     # Observes the Orphan::Manager and provides information about each execution
     #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
     #
     class Observer
       include SidekiqUniqueJobs::Logging

data/lib/sidekiq_unique_jobs/orphans/reaper.rb

@@ -7,7 +7,7 @@ module SidekiqUniqueJobs
     #
     # @note this is a much slower version of the lua script but does not crash redis
     #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
     #
     class Reaper
       include SidekiqUniqueJobs::Connection
@@ -17,12 +17,16 @@ module SidekiqUniqueJobs
 
       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
 
       #

data/lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb

@@ -7,7 +7,7 @@ module SidekiqUniqueJobs
     #
     # @note this is a much slower version of the lua script but does not crash redis
     #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
     #
     class RubyReaper < Reaper
       #
@@ -135,6 +135,8 @@ module SidekiqUniqueJobs
               return true if load_json(job)[LOCK_DIGEST] == digest
             end
           end
+
+          false
         end
       end
 
@@ -151,7 +153,7 @@ module SidekiqUniqueJobs
         conn.sscan_each("queues", &block)
       end
 
-      def entries(conn, queue) # rubocop:disable Metrics/MethodLength
+      def entries(conn, queue, &block) # rubocop:disable Metrics/MethodLength
         queue_key    = "queue:#{queue}"
         initial_size = conn.llen(queue_key)
         deleted_size = 0
@@ -166,9 +168,7 @@ module SidekiqUniqueJobs
 
           break if entries.empty?
 
-          entries.each do |entry|
-            yield entry
-          end
+          entries.each(&block)
 
           deleted_size = initial_size - conn.llen(queue_key)
         end

data/lib/sidekiq_unique_jobs/profiler.rb

@@ -4,7 +4,7 @@ module SidekiqUniqueJobs
   #
   # Class MethodProfiler provides method level profiling
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   #
   class Profiler
     def self.patch(klass, methods, name) # rubocop:disable Metrics/MethodLength

data/lib/sidekiq_unique_jobs/redis.rb

@@ -4,7 +4,7 @@ module SidekiqUniqueJobs
   #
   # Augments and enhances redis with object oriented methods
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   #
   module Redis
   end

data/lib/sidekiq_unique_jobs/redis/entity.rb

@@ -5,7 +5,7 @@ module SidekiqUniqueJobs
     #
     # Class Entity functions as a base class for redis types
     #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
     #
     class Entity
       # includes "SidekiqUniqueJobs::Logging"

data/lib/sidekiq_unique_jobs/redis/hash.rb

@@ -5,7 +5,7 @@ module SidekiqUniqueJobs
     #
     # Class Hash provides convenient access to redis hashes
     #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
     #
     class Hash < Entity
       #

data/lib/sidekiq_unique_jobs/redis/list.rb

@@ -5,7 +5,7 @@ module SidekiqUniqueJobs
     #
     # Class List provides convenient access to redis hashes
     #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
     #
     class List < Entity
       #

data/lib/sidekiq_unique_jobs/redis/set.rb

@@ -5,7 +5,7 @@ module SidekiqUniqueJobs
     #
     # Class Set provides convenient access to redis sets
     #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
     #
     class Set < Entity
       #

data/lib/sidekiq_unique_jobs/redis/sorted_set.rb

@@ -5,7 +5,7 @@ module SidekiqUniqueJobs
     #
     # Class SortedSet provides convenient access to redis sorted sets
     #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
     #
     class SortedSet < Entity
       #