sidekiq-unique-jobs 7.0.13 → 7.1.0

data/lib/sidekiq_unique_jobs/reflectable.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module SidekiqUniqueJobs
+  #
+  # Module Reflectable provides a method to notify subscribers
+  #
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
+  #
+  module Reflectable
+    def reflect(name, *args)
+      SidekiqUniqueJobs.reflections.dispatch(name, *args)
+      nil
+    rescue UniqueJobsError => ex
+      SidekiqUniqueJobs.logger.error(ex)
+    end
+  end
+end

data/lib/sidekiq_unique_jobs/reflections.rb

@@ -0,0 +1,68 @@
+# 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
+
+    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
+    end
+
+    def configured?(reflection)
+      REFLECTIONS.include?(reflection)
+    end
+
+    def misconfigured?(reflection)
+      !configured?(reflection)
+    end
+  end
+end

data/lib/sidekiq_unique_jobs/script/caller.rb

@@ -45,7 +45,9 @@ module SidekiqUniqueJobs
         pool = defined?(redis_pool) ? redis_pool : nil
 
         redis(pool) do |new_conn|
-          do_call(file_name, new_conn, keys, argv)
+          result = do_call(file_name, new_conn, keys, argv)
+          yield result if block_given?
+          result
         end
       end
 

data/lib/sidekiq_unique_jobs/server.rb

@@ -5,7 +5,7 @@ module SidekiqUniqueJobs
   #
   # @author Mikael Henriksson <mikael@mhenrixon.com>
   class Server
-    DEATH_HANDLER = (lambda do |job, _ex|
+    DEATH_HANDLER ||= (lambda do |job, _ex|
       return unless (digest = job["lock_digest"])
 
       SidekiqUniqueJobs::Digests.new.delete_by_digest(digest)
@@ -29,6 +29,7 @@ module SidekiqUniqueJobs
       SidekiqUniqueJobs::UpdateVersion.call
       SidekiqUniqueJobs::UpgradeLocks.call
       SidekiqUniqueJobs::Orphans::Manager.start
+      SidekiqUniqueJobs::Orphans::ReaperResurrector.start
     end
 
     def self.stop

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 Job
+    #
+    # 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

@@ -270,4 +270,25 @@ module SidekiqUniqueJobs # rubocop:disable Metrics/ModuleLength
       raise
     end
   end
+
+  #
+  # Collection with notifications
+  #
+  #
+  # @return [Reflections]
+  #
+  def reflections
+    @reflections ||= Reflections.new
+  end
+
+  #
+  # Yields notification stack for sidekiq unique jobs to configure notifications
+  #
+  #
+  # @return [void] <description>
+  #
+  # @yieldparam [Reflections] x used to configure notifications
+  def reflect
+    yield reflections if block_given?
+  end
 end

data/lib/sidekiq_unique_jobs/version.rb

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

data/lib/sidekiq_unique_jobs.rb

@@ -15,6 +15,9 @@ require "json"
 require "pathname"
 require "sidekiq"
 
+require "sidekiq_unique_jobs/deprecation"
+require "sidekiq_unique_jobs/reflections"
+require "sidekiq_unique_jobs/reflectable"
 require "sidekiq_unique_jobs/timer_task"
 require "sidekiq_unique_jobs/version"
 require "sidekiq_unique_jobs/version_check"
@@ -41,6 +44,7 @@ require "sidekiq_unique_jobs/batch_delete"
 require "sidekiq_unique_jobs/orphans/reaper"
 require "sidekiq_unique_jobs/orphans/observer"
 require "sidekiq_unique_jobs/orphans/manager"
+require "sidekiq_unique_jobs/orphans/reaper_resurrector"
 require "sidekiq_unique_jobs/cli"
 require "sidekiq_unique_jobs/core_ext"
 require "sidekiq_unique_jobs/lock_timeout"

data/lib/tasks/changelog.rake

@@ -1,21 +1,21 @@
 # frozen_string_literal: true
 
-# rubocop:disable Style/MutableConstant
-CHANGELOG_CMD = %w[
-  github_changelog_generator
-  --no-verbose
-  --user
-  mhenrixon
-  --project
-  sidekiq-unique-jobs
-  --token
-]
-ADD_CHANGELOG_CMD = "git add --all"
-COMMIT_CHANGELOG_CMD = "git commit -a -m 'Update changelog'"
-# rubocop:enable Style/MutableConstant
-
 desc "Generate a Changelog"
 task :changelog do
+  # rubocop:disable Style/MutableConstant
+  CHANGELOG_CMD ||= %w[
+    github_changelog_generator
+    --no-verbose
+    --user
+    mhenrixon
+    --project
+    sidekiq-unique-jobs
+    --token
+  ]
+  ADD_CHANGELOG_CMD ||= "git add --all"
+  COMMIT_CHANGELOG_CMD ||= "git commit -a -m 'Update changelog'"
+  # rubocop:enable Style/MutableConstant
+
   sh("git checkout master")
   sh(*CHANGELOG_CMD.push(ENV["CHANGELOG_GITHUB_TOKEN"]))
   sh(ADD_CHANGELOG_CMD)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-unique-jobs
 version: !ruby/object:Gem::Version
-  version: 7.0.13
+  version: 7.1.0
 platform: ruby
 authors:
 - Mikael Henriksson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-27 00:00:00.000000000 Z
+date: 2021-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: brpoplpush-redis_script
@@ -59,7 +59,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -69,7 +69,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -79,7 +79,7 @@ dependencies:
         version: '0.20'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -89,7 +89,7 @@ dependencies:
         version: '0.20'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.0'
 description: |
   Prevents simultaneous Sidekiq jobs with the same unique arguments to run.
   Highly configurable to suite your specific needs.
@@ -113,6 +113,7 @@ files:
 - lib/sidekiq_unique_jobs/connection.rb
 - lib/sidekiq_unique_jobs/constants.rb
 - lib/sidekiq_unique_jobs/core_ext.rb
+- lib/sidekiq_unique_jobs/deprecation.rb
 - lib/sidekiq_unique_jobs/digests.rb
 - lib/sidekiq_unique_jobs/exceptions.rb
 - lib/sidekiq_unique_jobs/job.rb
@@ -176,6 +177,7 @@ files:
 - lib/sidekiq_unique_jobs/orphans/null_reaper.rb
 - lib/sidekiq_unique_jobs/orphans/observer.rb
 - lib/sidekiq_unique_jobs/orphans/reaper.rb
+- lib/sidekiq_unique_jobs/orphans/reaper_resurrector.rb
 - lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb
 - lib/sidekiq_unique_jobs/redis.rb
 - lib/sidekiq_unique_jobs/redis/entity.rb
@@ -184,6 +186,8 @@ files:
 - lib/sidekiq_unique_jobs/redis/set.rb
 - lib/sidekiq_unique_jobs/redis/sorted_set.rb
 - lib/sidekiq_unique_jobs/redis/string.rb
+- lib/sidekiq_unique_jobs/reflectable.rb
+- lib/sidekiq_unique_jobs/reflections.rb
 - lib/sidekiq_unique_jobs/rspec/matchers.rb
 - lib/sidekiq_unique_jobs/rspec/matchers/have_valid_sidekiq_options.rb
 - lib/sidekiq_unique_jobs/script.rb
@@ -250,14 +254,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.28
+rubygems_version: 3.2.21
 signing_key:
 specification_version: 4
 summary: Sidekiq middleware that prevents duplicates jobs