sidekiq-clutch 1.0.0 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ec75202216558f8f183a76de69109178e67ba9bb
-  data.tar.gz: c49621ff95d0667e6d9b2394a1a783a740d240e0
+SHA256:
+  metadata.gz: 796b85ff9627cc5bc227521ee81c318f38fc979a7e963df54c762ee174320564
+  data.tar.gz: 9196201e96688775de3dca64d1322a8709b9641ed9fbbeb9ccdae187e4e7b3b9
 SHA512:
-  metadata.gz: 10eefa778032d53f29c65154057e7ac3f9a7d84c7dfd576da8cc788488f20a744953ea26fedfb2f93812b609b45a382380df77ce901591fc25001c7025219af5
-  data.tar.gz: f1d72de39d77bd3ebc10034620a009bc8982492faf3188917023dbbeead5252fc36d39e62e5d491cdb477f66f48157fd07544016d28d6d357494036d11c41ee9
+  metadata.gz: 15b262b976dff8c5fd3034ec4368d8e7058bfb4879234e9ad881893fb00f08aa81c48c9c6b44044b84321606a7ccf6901165c395146fc07cddb0e0bdbece1edd
+  data.tar.gz: de761b630c42ec9d78f82f9281f442c05fc88fb3161522f7190765603129852afbd1675fb2d93a1bd79ec8f46a979b062f29346e7e5406200ae962847babfa6f

data/.circleci/config.yml

@@ -0,0 +1,12 @@
+version: 2
+jobs:
+  build:
+    parallelism: 1
+    docker:
+    - image: circleci/ruby:2.5
+    - image: redis:3.2
+    steps:
+    - checkout
+    - run: gem install bundler
+    - run: bundle install
+    - run: bundle exec rspec

data/.gitignore

@@ -1,3 +1,4 @@
+/*.gem
 /.bundle/
 .rspec_status
 Gemfile.lock

data/.rubocop.yml

@@ -1,3 +1,6 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
 Metrics/LineLength:
   Max: 120
 

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+# 2.0.2 - Sep 24, 2020
+
+* PERF: Delete keys based on known values, instead of a glob
+* PERF: Don't bother enqueing a `:complete` callback if no `on_failure` is specified
+
+# 2.0.1 - Jun 1, 2020
+
+* CHORE: Bump development dependency versions
+* CHORE: Add .ruby-version file for easier development
+
+# 2.0.0 - Feb 5, 2020
+
+* BREAKING: Treat each parallel block as a distinct step
+
+# 1.1.0 - Feb 5, 2020
+
+* FEAT: use Sidekiq's wrapped option for improved logging
+
+# 1.0.1 - May 7, 2019
+
+* FIX: don't look up previous results in Redis if the key is nil
+
 # 1.0.0 - Nov 5, 2018
 
 Initial release.

data/lib/sidekiq/clutch.rb

@@ -10,18 +10,18 @@ module Sidekiq
       @batch = batch || Sidekiq::Batch.new
     end
 
-    attr_reader :batch, :queue
+    attr_reader :batch, :queue, :parallel_key
 
     attr_accessor :current_result_key, :on_failure
 
     def parallel
-      @parallel = true
+      @parallel_key = SecureRandom.uuid
       yield
-      @parallel = false
+      @parallel_key = nil
     end
 
     def parallel?
-      @parallel == true
+      !!@parallel_key
     end
 
     def jobs
@@ -54,7 +54,8 @@ module Sidekiq
       return if step.nil?
       batch.callback_queue = queue if queue
       batch.on(:success, Sidekiq::Clutch, 'jobs' => jobs_queue.dup, 'result_key' => step['result_key'])
-      batch.on(:complete, Sidekiq::Clutch, 'on_failure' => on_failure&.name)
+      on_failure_name = on_failure&.name
+      batch.on(:complete, Sidekiq::Clutch, 'on_failure' => on_failure_name) if on_failure_name
       batch.jobs do
         if step['series']
           series_step(step)
@@ -102,6 +103,7 @@ module Sidekiq
       options = {
         'class'     => JobWrapper,
         'queue'     => queue || job_options['queue'],
+        'wrapped'   => klass,
         'args'      => [batch.bid, klass, params, current_result_key, result_key],
         'retry'     => job_options['retry'],
         'backtrace' => job_options['backtrace']
@@ -111,8 +113,11 @@ module Sidekiq
 
     def clean_up_result_keys(key_base)
       Sidekiq.redis do |redis|
-        redis.keys(key_base + '*').each do |key|
-          redis.del(key)
+        result_key_index = 1
+        loop do
+          result = redis.del("#{key_base}-#{result_key_index}")
+          result_key_index += 1
+          break if result == 0
         end
       end
     end

data/lib/sidekiq/clutch/job_wrapper.rb

@@ -21,9 +21,16 @@ module Sidekiq
 
       private
 
+      def lookup_last_result(key)
+        Sidekiq.redis do |client|
+          client.lrange(key, 0, -1)
+        end
+      end
+
       def assign_previous_results(job, last_result_key)
         return unless job.respond_to?(:previous_results=)
-        job.previous_results = Sidekiq.redis { |c| c.lrange(last_result_key, 0, -1) }.map do |r|
+        return job.previous_results = [] if last_result_key.nil?
+        job.previous_results = lookup_last_result(last_result_key).map do |r|
           JSON.parse(r, quirks_mode: true) # quirks_mode allows a bare string or number
         end
       end

data/lib/sidekiq/clutch/jobs_collection.rb

@@ -22,7 +22,7 @@ module Sidekiq
 
       def <<((klass, *params))
         if @service.parallel?
-          @jobs << { 'parallel' => [], 'result_key' => next_result_key } unless @jobs.last && @jobs.last['parallel']
+          @jobs << new_parallel_step unless continue_existing_parallel_step?
           @jobs.last['parallel'] << [klass.name, params]
         else
           @jobs << { 'series' => [klass.name, params], 'result_key' => next_result_key }
@@ -33,6 +33,16 @@ module Sidekiq
         @result_key_index += 1
         "#{@result_key_prefix}-#{@result_key_index}"
       end
+
+      private
+
+      def new_parallel_step
+        { 'parallel' => [], 'result_key' => next_result_key, 'parallel_key' => @service.parallel_key }
+      end
+
+      def continue_existing_parallel_step?
+        @jobs.last && @jobs.last['parallel_key'] == @service.parallel_key
+      end
     end
   end
 end

data/lib/sidekiq/clutch/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   class Clutch
-    VERSION = "1.0.0"
+    VERSION = "2.0.2"
   end
 end

data/sidekiq-clutch.gemspec

@@ -15,14 +15,13 @@ Gem::Specification.new do |spec|
   spec.license       = 'MIT'
 
   spec.files         = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files`.split("\n").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files`.split("\n").reject { |f| f.match(%r{^(spec|\.ruby-version)}) }
   end
   spec.require_paths = ['lib']
 
   spec.add_dependency 'sidekiq', '>= 5.0.0'
 
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'bundler', '~> 1.16'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'bundler', '~> 2.1.4'
+  spec.add_development_dependency 'rake', '~> 13.0.1'
+  spec.add_development_dependency 'rspec', '~> 3.9.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-clutch
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.2
 platform: ruby
 authors:
 - Tim Morgan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-06 00:00:00.000000000 Z
+date: 2020-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -24,62 +24,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.0.0
-- !ruby/object:Gem::Dependency
-  name: pry
-  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: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.1.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 13.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 13.0.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.9.0
 description: Sidekiq::Clutch provides an ergonomic wrapper API for Sidekiq Batches
   so you can easily manage serial and parallel jobs.
 email:
@@ -88,6 +74,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -121,8 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: An ergonomic wrapper API for Sidekiq Batches