sidekiq-unique-jobs 7.0.0.beta25 → 7.0.0

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
 
       #
@@ -72,6 +76,16 @@ module SidekiqUniqueJobs
         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
       #

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
       #
@@ -117,7 +117,7 @@ module SidekiqUniqueJobs
         end
       end
 
-      def active?(digest) # rubocop:disable Metrics/MethodLength
+      def active?(digest) # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity
         Sidekiq.redis do |conn|
           procs = conn.sscan_each("processes").to_a
           return false if procs.empty?
@@ -132,7 +132,10 @@ module SidekiqUniqueJobs
             next unless workers.any?
 
             workers.each_pair do |_tid, job|
-              return true if load_json(job)[LOCK_DIGEST] == digest
+              item = load_json(job)
+
+              return true if item.dig(PAYLOAD, LOCK_DIGEST) == digest
+              return true if considered_active?(item[CREATED_AT])
             end
           end
 
@@ -140,6 +143,10 @@ module SidekiqUniqueJobs
         end
       end
 
+      def considered_active?(time_f)
+        (Time.now - reaper_timeout).to_f < time_f
+      end
+
       #
       # Loops through all the redis queues and yields them one by one
       #

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"
@@ -48,10 +48,10 @@ module SidekiqUniqueJobs
       def exist?
         redis do |conn|
           value = conn.exists(key)
-          return true if value.is_a?(TrueClass)
-          return false if value.is_a?(FalseClass)
 
-          value.positive?
+          return value if boolean?(value)
+
+          value.to_i.positive?
         end
       end
 
@@ -95,6 +95,12 @@ module SidekiqUniqueJobs
       def count
         0
       end
+
+      private
+
+      def boolean?(value)
+        [TrueClass, FalseClass].any? { |klazz| value.is_a?(klazz) }
+      end
     end
   end
 end

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
       #

data/lib/sidekiq_unique_jobs/redis/string.rb

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

data/lib/sidekiq_unique_jobs/rspec/matchers.rb

@@ -4,13 +4,13 @@ module SidekiqUniqueJobs
   #
   # We all know what the hell RSpec is no?
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   #
   module RSpec
     #
     # Module Matchers provides RSpec matcher for your workers
     #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
     #
     module Matchers
     end

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

@@ -5,13 +5,13 @@ module SidekiqUniqueJobs
     #
     # Module Matchers provides RSpec matcher for your workers
     #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
     #
     module Matchers
       #
       # Class HaveValidSidekiqOptions validates the unique/lock configuration for a worker.
       #
-      # @author Mikael Henriksson <mikael@zoolutions.se>
+      # @author Mikael Henriksson <mikael@mhenrixon.com>
       #
       class HaveValidSidekiqOptions
         attr_reader :worker, :lock_config, :sidekiq_options

data/lib/sidekiq_unique_jobs/script.rb

@@ -3,7 +3,7 @@
 module SidekiqUniqueJobs
   # Interface to dealing with .lua files
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   module Script
     include Brpoplpush::RedisScript::DSL
 

data/lib/sidekiq_unique_jobs/script/caller.rb

@@ -3,12 +3,12 @@
 module SidekiqUniqueJobs
   # Interface to dealing with .lua files
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   module Script
     #
     # Module Caller provides the convenience method #call_script
     #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
     #
     module Caller
       module_function

data/lib/sidekiq_unique_jobs/sidekiq_unique_ext.rb

@@ -11,7 +11,7 @@ module Sidekiq
     #
     # Provides extensions for unlocking jobs that are removed and deleted
     #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
     #
     module UniqueExtension
       #
@@ -48,7 +48,7 @@ module Sidekiq
     #
     # Provides extensions for unlocking jobs that are removed and deleted
     #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
     #
     module UniqueExtension
       #
@@ -73,7 +73,7 @@ module Sidekiq
     #
     # Provides extensions for unlocking jobs that are removed and deleted
     #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
     #
     module UniqueExtension
       #
@@ -93,7 +93,7 @@ module Sidekiq
     #
     # Provides extensions for unlocking jobs that are removed and deleted
     #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
     #
     module UniqueExtension
       #
@@ -113,7 +113,7 @@ module Sidekiq
     #
     # Provides extensions for unlocking jobs that are removed and deleted
     #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
     #
     module UniqueExtension
       #

data/lib/sidekiq_unique_jobs/sidekiq_unique_jobs.rb

@@ -3,7 +3,7 @@
 #
 # Contains configuration and utility methods that belongs top level
 #
-# @author Mikael Henriksson <mikael@zoolutions.se>
+# @author Mikael Henriksson <mikael@mhenrixon.com>
 module SidekiqUniqueJobs
   include SidekiqUniqueJobs::Connection
   extend SidekiqUniqueJobs::JSON
@@ -168,7 +168,7 @@ module SidekiqUniqueJobs
   # @option options [Integer] :lock_timeout (default is 0)
   # @option options [Integer] :lock_ttl (default is 0)
   # @option options [true,false] :enabled (default is true)
-  # @option options [String] :unique_prefix (default is 'uniquejobs')
+  # @option options [String] :lock_prefix (default is 'uniquejobs')
   # @option options [Logger] :logger (default is Sidekiq.logger)
   # @yield control to the caller when given block
   def configure(options = {})

data/lib/sidekiq_unique_jobs/sidekiq_worker_methods.rb

@@ -3,7 +3,7 @@
 module SidekiqUniqueJobs
   # Module with convenience methods for the Sidekiq::Worker class
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   module SidekiqWorkerMethods
     # Avoids duplicating worker_class.respond_to? in multiple places
     # @return [true, false]
@@ -50,7 +50,7 @@ module SidekiqUniqueJobs
     # @return [Sidekiq::Worker]
     def worker_class_constantize(klazz = @worker_class)
       return klazz.class if klazz.is_a?(Sidekiq::Worker) # sidekiq v6.x
-      return klazz       unless klazz.is_a?(String)
+      return klazz unless klazz.is_a?(String)
 
       Object.const_get(klazz)
     rescue NameError => ex

data/lib/sidekiq_unique_jobs/testing.rb

@@ -93,7 +93,8 @@ module Sidekiq
       #
       def clear_all
         super
-        SidekiqUniqueJobs::Digests.new.del(pattern: "*", count: 1_000)
+
+        SidekiqUniqueJobs::Digests.new.delete_by_pattern("*", count: 10_000)
       end
     end
 

data/lib/sidekiq_unique_jobs/timing.rb

@@ -3,7 +3,7 @@
 module SidekiqUniqueJobs
   # Handles timing of things
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   module Timing
     module_function
 

data/lib/sidekiq_unique_jobs/unlockable.rb

@@ -4,7 +4,7 @@ module SidekiqUniqueJobs
   # Utility module to help manage unique keys in redis.
   # Useful for deleting keys that for whatever reason wasn't deleted
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   module Unlockable
     module_function
 

data/lib/sidekiq_unique_jobs/update_version.rb

@@ -4,7 +4,7 @@ module SidekiqUniqueJobs
   #
   # Class UpdateVersion sets the right version in redis
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   #
   class UpdateVersion
     #

data/lib/sidekiq_unique_jobs/upgrade_locks.rb

@@ -4,7 +4,7 @@ module SidekiqUniqueJobs
   #
   # Upgrades locks between gem version upgrades
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   #
   class UpgradeLocks # rubocop:disable Metrics/ClassLength
     #

data/lib/sidekiq_unique_jobs/version.rb

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

data/lib/sidekiq_unique_jobs/version_check.rb

@@ -4,7 +4,7 @@ module SidekiqUniqueJobs
   #
   # Handles checking if a version is compliant with given constraint
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   #
   class VersionCheck
     PATTERN = /(?<operator1>[<>=]+)?\s?(?<version1>(\d+.?)+)(\s+&&\s+)?(?<operator2>[<>=]+)?\s?(?<version2>(\d+.?)+)?/m.freeze # rubocop:disable Layout/LineLength, Lint/MixedRegexpCaptureTypes

data/lib/sidekiq_unique_jobs/web.rb

@@ -1,18 +1,12 @@
 # frozen_string_literal: true
 
-begin
-  require "sidekiq/web"
-rescue LoadError
-  # client-only usage
-end
-
 require_relative "web/helpers"
 
 module SidekiqUniqueJobs
   # Utility module to help manage unique keys in redis.
   # Useful for deleting keys that for whatever reason wasn't deleted
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   module Web
     def self.registered(app) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
       app.helpers do
@@ -59,8 +53,13 @@ module SidekiqUniqueJobs
   end
 end
 
-if defined?(Sidekiq::Web)
-  Sidekiq::Web.register SidekiqUniqueJobs::Web
+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.settings.locales << File.join(File.dirname(__FILE__), "locales")
+rescue NameError, LoadError => ex
+  SidekiqUniqueJobs.logger.error(ex)
 end