sidekiq-unique-jobs 6.0.0.rc6 → 6.0.0.rc7

data/lib/sidekiq_unique_jobs/util.rb

@@ -1,17 +1,23 @@
 # frozen_string_literal: true
 
 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>
   module Util
-    COUNT             = 'COUNT'
     DEFAULT_COUNT     = 1_000
-    EXPIRE_BATCH_SIZE = 100
-    SCAN_METHOD       = 'SCAN'
     SCAN_PATTERN      = '*'
 
     include SidekiqUniqueJobs::Logging
     include SidekiqUniqueJobs::Connection
     extend self # rubocop:disable Style/ModuleFunction
 
+    # Find unique keys in redis
+    #
+    # @param [String] pattern a pattern to scan for in redis
+    # @param [Integer] count the maximum number of keys to delete
+    # @return [Array<String>] an array with active unique keys
     def keys(pattern = SCAN_PATTERN, count = DEFAULT_COUNT)
       return redis(&:keys) if pattern.nil?
       redis { |conn| conn.scan_each(match: prefix(pattern), count: count).to_a }
@@ -19,10 +25,9 @@ module SidekiqUniqueJobs
 
     # Deletes unique keys from redis
     #
-    #
-    # @param pattern [String] a pattern to scan for in redis
-    # @param count [Integer] the maximum number of keys to delete
-    # @return [Boolean] report success
+    # @param [String] pattern a pattern to scan for in redis
+    # @param [Integer] count the maximum number of keys to delete
+    # @return [Integer] the number of keys deleted
     def del(pattern = SCAN_PATTERN, count = 0)
       raise ArgumentError, 'Please provide a number of keys to delete greater than zero' if count.zero?
       pattern = "#{pattern}:*" unless pattern.end_with?(':*')

data/lib/sidekiq_unique_jobs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SidekiqUniqueJobs
-  VERSION = '6.0.0.rc6'
+  VERSION = '6.0.0.rc7'
 end

data/lib/sidekiq_unique_jobs/web.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+begin
+  require 'sidekiq/web'
+rescue LoadError # rubocop:disable Lint/HandleExceptions
+  # 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>
+  module Web
+    def self.registered(app) # rubocop:disable Metrics/MethodLength
+      app.helpers do
+        include Web::Helpers
+      end
+
+      app.get '/unique_digests' do
+        @total_size     = Digests.count
+        @filter         = params[:filter] || '*'
+        @filter         = '*' if @filter == ''
+        @count          = (params[:count] || 100).to_i
+        @unique_digests = Digests.all(pattern: @filter, count: @count)
+
+        erb(unique_template(:unique_digests))
+      end
+
+      app.get '/unique_digests/:digest' do
+        @digest = params[:digest]
+        @unique_keys = Util.keys("#{@digest}*", 1000)
+
+        erb(unique_template(:unique_digest))
+      end
+
+      app.get '/unique_digests/:digest/delete' do
+        Digests.del(digest: params[:digest])
+        redirect_to :unique_digests
+      end
+    end
+  end
+end
+
+if defined?(Sidekiq::Web)
+  Sidekiq::Web.register SidekiqUniqueJobs::Web
+  Sidekiq::Web.tabs['Unique Digests'] = 'unique_digests'
+  # Sidekiq::Web.settings.locales << File.join(File.dirname(__FILE__), 'locales')
+end

data/lib/sidekiq_unique_jobs/web/helpers.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module SidekiqUniqueJobs
+  module Web
+    module Helpers
+      VIEW_PATH = File.expand_path('../web/views', __dir__)
+
+      def filtering(pattern, count)
+        SidekiqUniqueJobs::Util.keys(pattern, count)
+      end
+
+      def unique_template(name)
+        File.open(File.join(VIEW_PATH, "#{name}.erb")).read
+      end
+
+      def redirect_to(subpath)
+        if respond_to?(:to)
+          # Sinatra-based web UI
+          redirect to(subpath)
+        else
+          # Non-Sinatra based web UI (Sidekiq 4.2+)
+          redirect "#{root_path}#{subpath}"
+        end
+      end
+
+      def safe_relative_time(time)
+        time = if time.is_a?(Numeric)
+                 Time.at(time)
+               else
+                 Time.parse(time)
+               end
+
+        relative_time(time)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+<header class="row">
+  <div class="col-sm-5">
+    <h3><%= t('Unique Digest') %> - <a class="btn btn-default btn-xs" href="<%= root_path %>unique_digests"><%= t('GoBack') %></a></h3>
+  </div>
+</header>
+
+<% if @unique_keys.size.positive? %>
+  <div class="table_container">
+    <table class="table table-striped table-bordered table-hover">
+      <thead>
+        <tr>
+          <th>
+            <%= t('Keys') %>
+            <span class="small text-muted">for (<%= @digest %>)</span>
+          </th>
+        </tr>
+      </thead>
+        <% @unique_keys.each do |key| %>
+          <tr><td colspan="2"><%= key %></td></tr>
+        <% end %>
+    </table>
+  </div>
+  <form action="<%= root_path %>unique_digests/<%= @digest %>/delete" method="get">
+    <%= csrf_tag %>
+    <a class="btn btn-default btn-xs" href="<%= root_path %>unique_digests"><%= t('GoBack') %></a>
+    <input class="btn btn-danger btn-xs flip" type="submit" name="delete" value="<%= t('Delete') %>" data-confirm="<%= t('AreYouSure') %>" />
+  </form>
+<% end %>

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

@@ -0,0 +1,42 @@
+<header class="row">
+  <div class="col-sm-5">
+    <h3><%= t('Unique Digests') %></h3>
+  </div>
+  <form action="<%= root_path %>unique_digests" 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 @unique_digests.size > 0 && @total_size > @count.to_i %>
+    <div class="col-sm-4">
+      <%= erb :_paging, locals: { url: "#{root_path}unique_digests" } %>
+    </div>
+  <% end %>
+</header>
+
+<% if @unique_digests.size.positive? %>
+  <div class="table_container">
+    <table class="table table-striped table-bordered table-hover">
+      <thead>
+        <tr>
+          <th><%= t('Delete') %></th>
+          <th><%= t('Digest') %></th>
+        </tr>
+      </thead>
+      <% @unique_digests.each do |digest| %>
+        <tr>
+          <td>
+            <form action="<%= root_path %>unique_digests/<%= digest %>/delete" method="get">
+              <%= csrf_tag %>
+              <input name="digest" value="<%= h digest %>" type="hidden" />
+              <input class="btn btn-danger btn-xs" type="submit" name="delete" value="<%= t('Delete') %>" data-confirm="<%= t('AreYouSure') %>" />
+            </form>
+          </td>
+          <td>
+            <a href="<%= root_path %>unique_digests/<%= digest %>"><%= digest %></a>
+          </td>
+        </tr>
+      <% end %>
+    </table>
+  </div>
+<% end %>

data/redis/create.lua

@@ -4,7 +4,8 @@ local exists_key    = KEYS[1]
 local grabbed_key   = KEYS[2]
 local available_key = KEYS[3]
 local version_key   = KEYS[4]
-local unique_digest = KEYS[5]
+local unique_keys   = KEYS[5]
+local unique_digest = KEYS[6]
 
 local job_id        = ARGV[1]
 local expiration    = tonumber(ARGV[2])
@@ -29,7 +30,8 @@ if old_token then
 end
 ----------------------------------------------------------------
 
-redis.call('EXPIRE', exists_key, 10)
+redis.call('SADD', unique_keys, unique_digest)
+redis.call('EXPIRE', exists_key, 5)
 redis.call('DEL', grabbed_key)
 redis.call('DEL', available_key)
 

data/redis/delete.lua

@@ -2,9 +2,11 @@ local exists_key    = KEYS[1]
 local grabbed_key   = KEYS[2]
 local available_key = KEYS[3]
 local version_key   = KEYS[4]
-local unique_digest = KEYS[5]     -- TODO: Legacy support (Remove in v6.1)
+local unique_keys   = KEYS[5]
+local unique_digest = KEYS[6]     -- TODO: Legacy support (Remove in v6.1)
 
 redis.call('DEL', exists_key)
+redis.call('SREM', unique_keys, unique_digest)
 redis.call('DEL', grabbed_key)
 redis.call('DEL', available_key)
 redis.call('DEL', version_key)

data/redis/delete_by_digest.lua

@@ -0,0 +1,22 @@
+-- redis.replicate_commands();
+local unique_keys   = KEYS[1]
+local unique_digest = KEYS[2]
+
+local exists_key        = unique_digest .. ':EXISTS'
+local grabbed_key       = unique_digest .. ':GRABBED'
+local available_key     = unique_digest .. ':AVAILABLE'
+local version_key       = unique_digest .. ':VERSION'
+local run_exists_key    = unique_digest .. ':RUN:EXISTS'
+local run_grabbed_key   = unique_digest .. ':RUN:GRABBED'
+local run_available_key = unique_digest .. ':RUN:AVAILABLE'
+local run_version_key   = unique_digest .. ':RUN:VERSION'
+
+redis.call('SREM', unique_keys, unique_digest)
+redis.call('DEL', exists_key)
+redis.call('DEL', grabbed_key)
+redis.call('DEL', available_key)
+redis.call('DEL', version_key)
+redis.call('DEL', run_exists_key)
+redis.call('DEL', run_grabbed_key)
+redis.call('DEL', run_available_key)
+redis.call('DEL', run_version_key)

data/redis/signal.lua

@@ -2,12 +2,14 @@ local exists_key    = KEYS[1]
 local grabbed_key   = KEYS[2]
 local available_key = KEYS[3]
 local version_key   = KEYS[4]
-local unique_digest = KEYS[5] -- TODO: Legacy support (Remove in v6.1)
+local unique_keys   = KEYS[5]
+local unique_digest = KEYS[6] -- TODO: Legacy support (Remove in v6.1)
 
 local token      = ARGV[1]
 local expiration = tonumber(ARGV[2])
 
 redis.call('HDEL', grabbed_key, token)
+redis.call('SREM', unique_keys, token)
 local available_count = redis.call('LPUSH', available_key, token)
 
 if expiration then

data/sidekiq-unique-jobs.gemspec

@@ -37,4 +37,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'yard', '~> 0.9'
   spec.add_development_dependency 'gem-release', '~> 1.0'
   spec.add_development_dependency 'awesome_print', '~> 1.8'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'sinatra'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-unique-jobs
 version: !ruby/object:Gem::Version
-  version: 6.0.0.rc6
+  version: 6.0.0.rc7
 platform: ruby
 authors:
 - Mikael Henriksson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-15 00:00:00.000000000 Z
+date: 2018-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -162,6 +162,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Handles various types of unique jobs for Sidekiq
 email:
 - mikael@zoolutions.se
@@ -185,6 +213,7 @@ files:
 - ".rubocop.yml"
 - ".simplecov"
 - ".travis.yml"
+- ".yardopts"
 - Appraisals
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -194,6 +223,8 @@ files:
 - README.md
 - Rakefile
 - _config.yml
+- assets/unique_digests_1.png
+- assets/unique_digests_2.png
 - bin/bench
 - bin/uniquejobs
 - examples/another_unique_job.rb
@@ -215,6 +246,9 @@ files:
 - examples/spawn_simple_worker.rb
 - examples/test_class.rb
 - examples/unique_across_workers_job.rb
+- examples/unique_job_on_conflict_raise.rb
+- examples/unique_job_on_conflict_reject.rb
+- examples/unique_job_on_conflict_reschedule.rb
 - examples/unique_job_with_conditional_parameter.rb
 - examples/unique_job_with_filter_method.rb
 - examples/unique_job_with_nil_unique_args.rb
@@ -237,6 +271,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/digests.rb
 - lib/sidekiq_unique_jobs/exceptions.rb
 - lib/sidekiq_unique_jobs/lock/base_lock.rb
 - lib/sidekiq_unique_jobs/lock/until_and_while_executing.rb
@@ -245,11 +280,17 @@ files:
 - lib/sidekiq_unique_jobs/lock/until_expired.rb
 - lib/sidekiq_unique_jobs/lock/while_executing.rb
 - lib/sidekiq_unique_jobs/lock/while_executing_reject.rb
-- lib/sidekiq_unique_jobs/lock/while_executing_requeue.rb
 - lib/sidekiq_unique_jobs/locksmith.rb
 - lib/sidekiq_unique_jobs/logging.rb
 - lib/sidekiq_unique_jobs/middleware.rb
 - lib/sidekiq_unique_jobs/normalizer.rb
+- lib/sidekiq_unique_jobs/on_conflict.rb
+- lib/sidekiq_unique_jobs/on_conflict/log.rb
+- lib/sidekiq_unique_jobs/on_conflict/null_strategy.rb
+- lib/sidekiq_unique_jobs/on_conflict/raise.rb
+- lib/sidekiq_unique_jobs/on_conflict/reject.rb
+- lib/sidekiq_unique_jobs/on_conflict/reschedule.rb
+- lib/sidekiq_unique_jobs/on_conflict/strategy.rb
 - lib/sidekiq_unique_jobs/options_with_fallback.rb
 - lib/sidekiq_unique_jobs/scripts.rb
 - lib/sidekiq_unique_jobs/server/middleware.rb
@@ -262,9 +303,14 @@ files:
 - lib/sidekiq_unique_jobs/unlockable.rb
 - lib/sidekiq_unique_jobs/util.rb
 - lib/sidekiq_unique_jobs/version.rb
+- lib/sidekiq_unique_jobs/web.rb
+- lib/sidekiq_unique_jobs/web/helpers.rb
+- lib/sidekiq_unique_jobs/web/views/unique_digest.erb
+- lib/sidekiq_unique_jobs/web/views/unique_digests.erb
 - redis/acquire_lock.lua
 - redis/create.lua
 - redis/delete.lua
+- redis/delete_by_digest.lua
 - redis/release_lock.lua
 - redis/release_stale_locks.lua
 - redis/signal.lua

data/lib/sidekiq_unique_jobs/lock/while_executing_requeue.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module SidekiqUniqueJobs
-  class Lock
-    class WhileExecutingRequeue < WhileExecuting
-      def lock
-        true
-      end
-
-      def execute
-        locksmith.lock(item[LOCK_TIMEOUT_KEY], raise: true) do
-          yield if block_given?
-        end
-
-        unlock
-
-        Sidekiq::Client.push(item) unless locksmith.locked?
-      end
-    end
-  end
-end