sidekiq-unique-jobs 7.0.0.beta27 → 7.0.2

data/lib/sidekiq_unique_jobs/orphans/reaper.rb

@@ -76,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

@@ -52,11 +52,11 @@ module SidekiqUniqueJobs
       # @return [Array<String>] an array of orphaned digests
       #
       def orphans
-        conn.zrevrange(digests.key, 0, -1).each_with_object([]) do |digest, result|
+        conn.zrevrange(digests.key, 0, -1).each_with_object([]) do |digest, memo|
           next if belongs_to_job?(digest)
 
-          result << digest
-          break if result.size >= reaper_count
+          memo << digest
+          break if memo.size >= reaper_count
         end
       end
 
@@ -117,7 +117,7 @@ module SidekiqUniqueJobs
         end
       end
 
-      def active?(digest) # rubocop:disable Metrics/MethodLength
+      def active?(digest) # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
         Sidekiq.redis do |conn|
           procs = conn.sscan_each("processes").to_a
           return false if procs.empty?
@@ -132,7 +132,12 @@ module SidekiqUniqueJobs
             next unless workers.any?
 
             workers.each_pair do |_tid, job|
-              return true if load_json(job)[LOCK_DIGEST] == digest
+              next unless (item = safe_load_json(job))
+
+              payload = safe_load_json(item[PAYLOAD])
+
+              return true if payload[LOCK_DIGEST] == digest
+              return true if considered_active?(payload[CREATED_AT])
             end
           end
 
@@ -140,6 +145,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/entity.rb

@@ -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/sorted_set.rb

@@ -23,6 +23,23 @@ module SidekiqUniqueJobs
         entrys.each_with_object({}) { |pair, hash| hash[pair[0]] = pair[1] }
       end
 
+      #
+      # Adds a value to the sorted set
+      #
+      # @param [Array<Float, String>, String] 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
       #
@@ -45,6 +62,16 @@ module SidekiqUniqueJobs
         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
       #

data/lib/sidekiq_unique_jobs/server.rb

@@ -0,0 +1,48 @@
+# 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
+
+    def self.start
+      SidekiqUniqueJobs::UpdateVersion.call
+      SidekiqUniqueJobs::UpgradeLocks.call
+      SidekiqUniqueJobs::Orphans::Manager.start
+    end
+
+    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

data/lib/sidekiq_unique_jobs/sidekiq_unique_jobs.rb

@@ -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/version.rb

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

data/lib/sidekiq_unique_jobs/web.rb

@@ -1,11 +1,5 @@
 # frozen_string_literal: true
 
-begin
-  require "sidekiq/web"
-rescue LoadError
-  # client-only usage
-end
-
 require_relative "web/helpers"
 
 module SidekiqUniqueJobs
@@ -19,6 +13,23 @@ module SidekiqUniqueJobs
         include Web::Helpers
       end
 
+      app.get "/changelogs" do
+        @filter         = params[:filter] || "*"
+        @filter         = "*" if @filter == ""
+        @count          = (params[:count] || 100).to_i
+        @current_cursor = params[:cursor]
+        @prev_cursor    = params[:prev_cursor]
+        @pagination     = { pattern: @filter, cursor: @current_cursor, page_size: @count }
+        @total_size, @next_cursor, @changelogs = changelog.page(**@pagination)
+
+        erb(unique_template(:changelogs))
+      end
+
+      app.get "/changelogs/delete_all" do
+        changelog.clear
+        redirect_to :changelogs
+      end
+
       app.get "/locks" do
         @filter         = params[:filter] || "*"
         @filter         = "*" if @filter == ""
@@ -59,8 +70,14 @@ module SidekiqUniqueJobs
   end
 end
 
-if defined?(Sidekiq::Web)
-  Sidekiq::Web.register SidekiqUniqueJobs::Web
-  Sidekiq::Web.tabs["Locks"] = "locks"
+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.tabs["Changelogs"] = "changelogs"
   Sidekiq::Web.settings.locales << File.join(File.dirname(__FILE__), "locales")
+rescue NameError, LoadError => ex
+  SidekiqUniqueJobs.logger.error(ex)
 end

data/lib/sidekiq_unique_jobs/web/helpers.rb

@@ -10,12 +10,12 @@ module SidekiqUniqueJobs
     module Helpers
       #
       # @return [String] the path to gem specific views
-      VIEW_PATH    = File.expand_path("../web/views", __dir__)
+      VIEW_PATH    = File.expand_path("../web/views", __dir__).freeze
       #
       # @return [Array<String>] safe params
       SAFE_CPARAMS = %w[cursor prev_cursor].freeze
 
-      module_function
+      extend self
 
       #
       # Opens a template file contained within this gem
@@ -25,7 +25,18 @@ module SidekiqUniqueJobs
       # @return [String] the file contents of the template
       #
       def unique_template(name)
-        File.open(File.join(VIEW_PATH, "#{name}.erb")).read
+        File.open(unique_filename(name)).read
+      end
+
+      #
+      # Construct template file name
+      #
+      # @param [Symbol] name the name of the template
+      #
+      # @return [String] the full name of the file
+      #
+      def unique_filename(name)
+        File.join(VIEW_PATH, "#{name}.erb")
       end
 
       #
@@ -38,6 +49,16 @@ module SidekiqUniqueJobs
         @digests ||= SidekiqUniqueJobs::Digests.new
       end
 
+      #
+      # The collection of changelog entries
+      #
+      #
+      # @return [SidekiqUniqueJobs::Digests] the sorted set with digests
+      #
+      def changelog
+        @changelog ||= SidekiqUniqueJobs::Changelog.new
+      end
+
       #
       # Creates url safe parameters
       #

data/lib/sidekiq_unique_jobs/web/views/changelogs.erb

@@ -0,0 +1,54 @@
+<header class="row">
+  <div class="col-sm-5">
+    <h3>
+    <%= t('Changelog Entries') %>
+    </h3>
+  </div>
+  <form action="<%= root_path %>changelogs" class="form form-inline" method="get">
+    <%= csrf_tag %>
+    <input name="filter" class="form-control" type="text" value="<%= @filter %>" />
+    <button class="btn btn-default" type="submit">
+    <%= t('Filter') %>
+    </button>
+  </form>
+  <% if @changelogs.any? && @total_size > @count.to_i %>
+  <div class="col-sm-4">
+    <%= erb unique_template(:_paging), locals: { url: "#{root_path}changelogs" } %>
+  </div>
+  <% end %>
+</header>
+<% if @changelogs.any? %>
+<div class="table_container">
+  <form action="<%= root_path %>changelogs/delete_all" method="get">
+    <input class="btn btn-danger btn-xs" type="submit" name="delete_all" value="<%= t('DeleteAll') %>" data-confirm="<%= t('AreYouSure') %>" />
+  </form>
+  <br/>
+  <table class="table table-striped table-bordered table-hover">
+    <thead>
+      <tr>
+        <th><%= t('Time') %></th>
+        <th><%= t('Digest') %></th>
+        <th><%= t('Script') %></th>
+        <th><%= t('JID') %></th>
+        <th><%= t('Prev JID') %></th>
+        <th><%= t('Message') %></th>
+      </tr>
+    </thead>
+    <tbody>
+    <% @changelogs.each do |changelog| %>
+      <tr>
+        <td><%= safe_relative_time(changelog["time"]) %></td>
+        <td><%= changelog["digest"] %></td>
+        <td><%= changelog["script"] %></td>
+        <td><%= changelog["job_id"] %></td>
+        <td><%= changelog["prev_jid"] %></td>
+        <td><%= changelog["message"] %></th>
+      </tr>
+    <% end %>
+    </tbody>
+  </table>
+  <form action="<%= root_path %>changelogs/delete_all" method="get">
+    <input class="btn btn-danger btn-xs" type="submit" name="delete_all" value="<%= t('DeleteAll') %>" data-confirm="<%= t('AreYouSure') %>" />
+  </form>
+</div>
+<% end %>

data/lib/sidekiq_unique_jobs/web/views/locks.erb

@@ -32,7 +32,7 @@
     <% @locks.each do |lock| %>
     <tr>
       <td>
-        <form action="<%= root_path %>locks/<%= lock.key %>" method="get">
+        <form action="<%= root_path %>locks/<%= lock.key %>/delete" method="get">
           <%= csrf_tag %>
           <input name="lock" value="<%= h lock.key %>" type="hidden" />
           <input class="btn btn-danger btn-xs" type="submit" name="delete" value="<%= t('Delete') %>" data-confirm="<%= t('AreYouSure') %>" />

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-unique-jobs
 version: !ruby/object:Gem::Version
-  version: 7.0.0.beta27
+  version: 7.0.2
 platform: ruby
 authors:
 - Mikael Henriksson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-03 00:00:00.000000000 Z
+date: 2021-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: brpoplpush-redis_script
@@ -56,7 +56,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '7.0'
@@ -66,7 +66,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '7.0'
@@ -177,7 +177,6 @@ files:
 - lib/sidekiq_unique_jobs/orphans/observer.rb
 - lib/sidekiq_unique_jobs/orphans/reaper.rb
 - lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb
-- lib/sidekiq_unique_jobs/profiler.rb
 - lib/sidekiq_unique_jobs/redis.rb
 - lib/sidekiq_unique_jobs/redis/entity.rb
 - lib/sidekiq_unique_jobs/redis/hash.rb
@@ -189,6 +188,7 @@ files:
 - lib/sidekiq_unique_jobs/rspec/matchers/have_valid_sidekiq_options.rb
 - lib/sidekiq_unique_jobs/script.rb
 - lib/sidekiq_unique_jobs/script/caller.rb
+- lib/sidekiq_unique_jobs/server.rb
 - lib/sidekiq_unique_jobs/sidekiq_unique_ext.rb
 - lib/sidekiq_unique_jobs/sidekiq_unique_jobs.rb
 - lib/sidekiq_unique_jobs/sidekiq_worker_methods.rb
@@ -202,6 +202,7 @@ files:
 - lib/sidekiq_unique_jobs/web.rb
 - lib/sidekiq_unique_jobs/web/helpers.rb
 - lib/sidekiq_unique_jobs/web/views/_paging.erb
+- lib/sidekiq_unique_jobs/web/views/changelogs.erb
 - lib/sidekiq_unique_jobs/web/views/lock.erb
 - lib/sidekiq_unique_jobs/web/views/locks.erb
 - lib/tasks/changelog.rake
@@ -217,6 +218,9 @@ metadata:
 post_install_message: |
   IMPORTANT!
 
+  Automatic configuration of the sidekiq middelware is no longer done.
+  Please see: https://github.com/mhenrixon/sidekiq-unique-jobs/blob/master/README.md#add-the-middleware
+
   This version deprecated the following sidekiq_options
 
     - sidekiq_options lock_args: :method_name
@@ -248,11 +252,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.6
 signing_key:
 specification_version: 4
 summary: Sidekiq middleware that prevents duplicates jobs