sidekiq-unique-jobs 6.0.1 → 6.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43b75e11e1343bf44faec8dec56f4c0356d6bec4549034b2197dd0624eef3fe5
-  data.tar.gz: 7e6cb6380f3c6544170d699fdd6296726e236761e916921b8a541e025b527e50
+  metadata.gz: bc7f82e3d04720a79501ea98300940be276d16484b840fcb29cbde5d9b02d4d0
+  data.tar.gz: 2c591c1695107e8afb57dc7ba67451ddcd28518251ce0515ec6fb032ae558975
 SHA512:
-  metadata.gz: 02fa7a131157f9aefc859a841571a942c0af8de90accc6fcfc38e9da39e2fa4f88a9cdf1fc0505d9f5869989c29dd5da8299282491c01b1a17302f59212e44ad
-  data.tar.gz: acca8c9d924c8158f8dba0748808b690106c5f212f2a899e7d4a2286bbf006d9f52880c33d6a89f9463287d172d0e61ccddb057bcfe3e3d18b3e4054554754fd
+  metadata.gz: 1b27618d4859b77a8960bc8779e9d62a39c856b58fc6d3cabf3b6650c2021f1288b41224a81fe4c5339a42fb7e20ec02b64f4455fdf2b3e250529aec436b4c51
+  data.tar.gz: 0aab133cbd5ae5ca3b16af1c5995a32cd455e2eef50ab896bbeaf494da6b222f7c198fca0ba1f2e523c449fcad5515d5ee98b63919d9600d6c6465e0b30084a4

data/README.md

@@ -361,7 +361,7 @@ For sidekiq versions before 5.1 a `sidekiq_retries_exhausted` block is required
 ```ruby
 class MyWorker
   sidekiq_retries_exhausted do |msg, _ex|
-    SidekiqUniqueJobs::Digests.delete_by(digest: msg['unique_digest']) if msg['unique_digest']
+    SidekiqUniqueJobs::Digests.del(digest: msg['unique_digest']) if msg['unique_digest']
   end
 end
 ```
@@ -372,7 +372,7 @@ Starting in v5.1, Sidekiq can also fire a global callback when a job dies:
 # this goes in your initializer
 Sidekiq.configure_server do |config|
   config.death_handlers << ->(job, _ex) do
-    SidekiqUniqueJobs::Digests.delete_by(digest: job['unique_digest']) if job['unique_digest']
+    SidekiqUniqueJobs::Digests.del(digest: job['unique_digest']) if job['unique_digest']
   end
 end
 ```

data/lib/sidekiq_unique_jobs/digests.rb

@@ -22,6 +22,23 @@ module SidekiqUniqueJobs
       redis { |conn| conn.sscan_each(UNIQUE_SET, match: pattern, count: count).to_a }
     end
 
+    # Paginate unique digests
+    #
+    # @param [String] pattern a pattern to match with
+    # @param [Integer] page the current cursor position
+    # @param [Integer] count the maximum number to match
+    # @return [Array<String>] with unique digests
+    def page(pattern: SCAN_PATTERN, cursor: 0, page_size: 100)
+      redis do |conn|
+        total_size, digests = conn.multi do
+          conn.scard(UNIQUE_SET)
+          conn.sscan(UNIQUE_SET, cursor, match: pattern, count: page_size)
+        end
+
+        [total_size, digests[0], digests[1]]
+      end
+    end
+
     # Get a total count of unique digests
     #
     # @return [Integer] number of digests

data/lib/sidekiq_unique_jobs/locksmith.rb

@@ -32,6 +32,16 @@ module SidekiqUniqueJobs
         keys: [exists_key, grabbed_key, available_key, version_key, UNIQUE_SET, unique_digest],
         argv: [jid, expiration, API_VERSION, concurrency],
       )
+      expire
+    end
+
+    def expire
+      Scripts.call(
+        :expire,
+        redis_pool,
+        keys: [exists_key, available_key, version_key],
+        argv: [expiration],
+      )
     end
 
     # Checks if the exists key is created in redis
@@ -86,7 +96,7 @@ module SidekiqUniqueJobs
       signal(jid)
     end
 
-    # Removes the lock keys from Redis
+    # Checks if this instance is considered locked
     # @param [String] token the unique token to check for a lock.
     #   nil will default to the jid provided in the initializer
     # @return [true, false]

data/lib/sidekiq_unique_jobs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SidekiqUniqueJobs
-  VERSION = '6.0.1'
+  VERSION = '6.0.2'
 end

data/lib/sidekiq_unique_jobs/web.rb

@@ -20,11 +20,13 @@ module SidekiqUniqueJobs
       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)
+        @current_cursor = params[:cursor]
+        @prev_cursor    = params[:prev_cursor]
+        @total_size, @next_cursor, @unique_digests =
+          Digests.page(pattern: @filter, cursor: @current_cursor, page_size: @count)
 
         erb(unique_template(:unique_digests))
       end

data/lib/sidekiq_unique_jobs/web/helpers.rb

@@ -9,6 +9,20 @@ module SidekiqUniqueJobs
         File.open(File.join(VIEW_PATH, "#{name}.erb")).read
       end
 
+      SAFE_CPARAMS = %w[cursor prev_cursor].freeze
+
+      def cparams(options)
+        # stringify
+        options.keys.each do |key|
+          options[key.to_s] = options.delete(key)
+        end
+
+        params.merge(options).map do |key, value|
+          next unless SAFE_CPARAMS.include?(key)
+          "#{key}=#{CGI.escape(value.to_s)}"
+        end.compact.join('&')
+      end
+
       def redirect_to(subpath)
         if respond_to?(:to)
           # Sinatra-based web UI

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

@@ -0,0 +1,10 @@
+<ul class="pagination pull-right flip">
+  <% if @prev_cursor %>
+    <li>
+      <a href="<%= url %>?<%= cparams(cursor: @prev_cursor, prev_cursor: @next_cursor) %>">Previous <%= @count %></a>
+    </li>
+  <% end %>
+  <li>
+    <a href="<%= url %>?<%= cparams(cursor: @next_cursor, prev_cursor: @current_cursor) %>">Next <%= @count %></a>
+  </li>
+</ul>

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

@@ -9,7 +9,7 @@
   </form>
   <% if @unique_digests.size > 0 && @total_size > @count.to_i %>
     <div class="col-sm-4">
-      <%= erb :_paging, locals: { url: "#{root_path}unique_digests" } %>
+      <%= erb unique_template(:_paging), locals: { url: "#{root_path}unique_digests" } %>
     </div>
   <% end %>
 </header>

data/redis/create.lua

@@ -45,10 +45,4 @@ end
 redis.call('GETSET', version_key, api_version)
 redis.call('PERSIST', exists_key)
 
-if expiration then
-  redis.call('EXPIRE', available_key, expiration)
-  redis.call('EXPIRE', exists_key, expiration)
-  redis.call('EXPIRE', version_key, expiration)
-end
-
 return job_id

data/redis/expire.lua

@@ -0,0 +1,14 @@
+-- redis.replicate_commands();
+
+local exists_key    = KEYS[1]
+local available_key = KEYS[2]
+local version_key   = KEYS[3]
+
+local expiration    = tonumber(ARGV[1])
+
+if expiration then
+  redis.log(redis.LOG_DEBUG, "create.lua - expiring locks because expiration: " .. tostring(expiration))
+  redis.call('EXPIRE', available_key, expiration)
+  redis.call('EXPIRE', exists_key, expiration)
+  redis.call('EXPIRE', version_key, expiration)
+end

data/redis/signal.lua

@@ -9,7 +9,7 @@ local token      = ARGV[1]
 local expiration = tonumber(ARGV[2])
 
 redis.call('HDEL', grabbed_key, token)
-redis.call('SREM', unique_keys, token)
+redis.call('SREM', unique_keys, unique_digest)
 local available_count = redis.call('LPUSH', available_key, token)
 
 if expiration then
@@ -21,3 +21,4 @@ if expiration then
 end
 
 return available_count
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-unique-jobs
 version: !ruby/object:Gem::Version
-  version: 6.0.1
+  version: 6.0.2
 platform: ruby
 authors:
 - Mikael Henriksson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-31 00:00:00.000000000 Z
+date: 2018-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -306,6 +306,7 @@ files:
 - 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/_paging.erb
 - lib/sidekiq_unique_jobs/web/views/unique_digest.erb
 - lib/sidekiq_unique_jobs/web/views/unique_digests.erb
 - redis/acquire_lock.lua
@@ -313,6 +314,7 @@ files:
 - redis/delete.lua
 - redis/delete_by_digest.lua
 - redis/delete_job_by_digest.lua
+- redis/expire.lua
 - redis/release_lock.lua
 - redis/release_stale_locks.lua
 - redis/signal.lua