sidekiq-clutch 2.1.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a79d553989453b6f6bdb859e2c6a0484ed1d3fdc6992dfa0aa80b79810fa4c2
-  data.tar.gz: 06d6490367f6ed9ad7d1e616128f6a6498242637786e66d8724bea4735718f89
+  metadata.gz: b1aeadb1bf712264c64a2770ac20cfcf779af8ab29ed120b40dd1730e30b28d0
+  data.tar.gz: 3cda98c60d5bb023b220320ea11a15e941ede2bf44df4625677e7950286a2176
 SHA512:
-  metadata.gz: 7a80caa3060acfcdb7f5cb3c4497261030c4f07cc1d528bbe078e6c3bb434117ad031d342f3940eaab59de9afb3b39d117a516933d92d3dd17475bea3c56d10d
-  data.tar.gz: ad2c11c85514d5cace032bace89031d2994be6cad8533bffaf1d498d869bdea9eb1dbb4f157e93c393b9ec3b72e3bbfebdb06d3fdc099ea02d41a032d98ecb5d
+  metadata.gz: 2b2e5468e6162b849245fbdba40fda75e96de6ad91757aba4cdc537ef7d5188a5abdcd37163d38f0e3c1b44dc2610654e14145cf0cebebec17f0bbfd1f238ad2
+  data.tar.gz: 8e10d8416293f4ef95df375612b8dbd9b023fae01301e90e2c229f4522125b4ddd8cd50f281f4bcc15e6a6f2af8d6c7f47fe1eafc293024655320901b4ec8b16

data/.circleci/config.yml

@@ -3,8 +3,8 @@ jobs:
   build:
     parallelism: 1
     docker:
-    - image: circleci/ruby:2.5
-    - image: redis:3.2
+    - image: cimg/ruby:3.3
+    - image: redis:8.0-M03-alpine
     steps:
     - checkout
     - run: gem install bundler

data/.envrc

@@ -0,0 +1,6 @@
+# Automatically sets up your devbox environment whenever you cd into this
+# directory via our direnv integration:
+
+if command -v devbox 2>&1 >/dev/null && [[ -z "$DISABLE_DEVBOX_DIRENV" ]]; then
+  eval "$(devbox generate direnv --print-envrc)"
+fi

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+# 3.0.0 - Feb 19, 2025
+
+* CHORE: Remove old-style job handling code
+  This would only be breaking if you have ongoing batches
+  that haven't yet completed (unlikely).
+
+# 2.1.2 - Feb 18, 2025
+
+* FIX: Don't leave orphaned redis keys laying around
+* CHANGE: Prefix redis keys for easier identification
+
 # 2.1.1 - Sep 14, 2021
 
 * FIX: Call correct clean up method when legacy jobs are finished

data/devbox.json

@@ -0,0 +1,14 @@
+{
+  "$schema":  "https://raw.githubusercontent.com/jetify-com/devbox/0.14.0/.schema/devbox.schema.json",
+  "packages": ["ruby_3_3@latest"],
+  "shell": {
+    "init_hook": [
+      "echo 'Welcome to devbox!' > /dev/null"
+    ],
+    "scripts": {
+      "test": [
+        "echo \"Error: no test specified\" && exit 1"
+      ]
+    }
+  }
+}

data/devbox.lock

@@ -0,0 +1,73 @@
+{
+  "lockfile_version": "1",
+  "packages": {
+    "github:NixOS/nixpkgs/nixpkgs-unstable": {
+      "resolved": "github:NixOS/nixpkgs/632f04521e847173c54fa72973ec6c39a371211c?lastModified=1739863612&narHash=sha256-UbtgxplOhFcyjBcNbTVO8%2BHUHAl%2FWXFDOb6LvqShiZo%3D"
+    },
+    "ruby_3_3@latest": {
+      "last_modified": "2024-09-10T15:01:03Z",
+      "plugin_version": "0.0.2",
+      "resolved": "github:NixOS/nixpkgs/5ed627539ac84809c78b2dd6d26a5cebeb5ae269#ruby",
+      "source": "devbox-search",
+      "version": "3.3.4",
+      "systems": {
+        "aarch64-darwin": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/zsngi7cq7asxc6kb0lcmbyydasfrmai6-ruby-3.3.4",
+              "default": true
+            },
+            {
+              "name": "devdoc",
+              "path": "/nix/store/c0zmjmfw5pp00slwy842bd8zzy74pava-ruby-3.3.4-devdoc"
+            }
+          ],
+          "store_path": "/nix/store/zsngi7cq7asxc6kb0lcmbyydasfrmai6-ruby-3.3.4"
+        },
+        "aarch64-linux": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/8vri7d6b75gspvnfrdpqnagfi5bbvis9-ruby-3.3.4",
+              "default": true
+            },
+            {
+              "name": "devdoc",
+              "path": "/nix/store/bfrwr1n6pxd3hz31h589j317g290p0r5-ruby-3.3.4-devdoc"
+            }
+          ],
+          "store_path": "/nix/store/8vri7d6b75gspvnfrdpqnagfi5bbvis9-ruby-3.3.4"
+        },
+        "x86_64-darwin": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/hksac0axpx3savrgmy75rid3smv0d9nj-ruby-3.3.4",
+              "default": true
+            },
+            {
+              "name": "devdoc",
+              "path": "/nix/store/3564jxjgp9dk8vzjwb7i3fpzkpw74z3m-ruby-3.3.4-devdoc"
+            }
+          ],
+          "store_path": "/nix/store/hksac0axpx3savrgmy75rid3smv0d9nj-ruby-3.3.4"
+        },
+        "x86_64-linux": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/2vg3asd3rmhng3wqvp781a1q5dhrr4yn-ruby-3.3.4",
+              "default": true
+            },
+            {
+              "name": "devdoc",
+              "path": "/nix/store/2vgrf69lcz8ipawxipza3w7gsqdnbbnk-ruby-3.3.4-devdoc"
+            }
+          ],
+          "store_path": "/nix/store/2vg3asd3rmhng3wqvp781a1q5dhrr4yn-ruby-3.3.4"
+        }
+      }
+    }
+  }
+}

data/lib/sidekiq/clutch/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   class Clutch
-    VERSION = '2.1.1'.freeze
+    VERSION = '3.0.0'.freeze
   end
 end

data/lib/sidekiq/clutch.rb

@@ -14,8 +14,8 @@ module Sidekiq
     end
 
     attr_reader :batch, :queue, :parallel_key
-
     attr_accessor :current_result_key, :on_failure
+    attr_writer :key_base
 
     def parallel
       @parallel_key = SecureRandom.uuid
@@ -72,8 +72,6 @@ module Sidekiq
     end
 
     def on_success(status, options)
-      return on_success_legacy(status, options) if options['jobs']
-
       raise 'invariant: key_base is missing!' unless options['key_base']
       raise 'invariant: result_key_index is missing!' unless options['result_key_index']
 
@@ -87,8 +85,9 @@ module Sidekiq
       end
       parent_batch = Sidekiq::Batch.new(status.parent_bid)
       service = self.class.new(parent_batch)
+      service.key_base = @key_base
       service.jobs.raw = remaining_jobs
-      service.current_result_key = "#{key_base}-#{options['result_key_index']}"
+      service.current_result_key = "#{key_base}:result-#{options['result_key_index']}"
       service.engage
     end
 
@@ -100,26 +99,12 @@ module Sidekiq
 
     private
 
-    # accept old style of passing job data, will be removed in 3.0
-    def on_success_legacy(status, options)
-      @key_base = options['result_key'].sub(/-\d+$/, '')
-      if options['jobs'].empty?
-        clean_up_temporary_keys
-        return
-      end
-      parent_batch = Sidekiq::Batch.new(status.parent_bid)
-      service = self.class.new(parent_batch)
-      service.jobs.raw = options['jobs']
-      service.current_result_key = options['result_key']
-      service.engage
-    end
-
     def key_base
-      @key_base ||= SecureRandom.uuid
+      @key_base ||= "clutch:#{SecureRandom.uuid}"
     end
 
     def jobs_key
-      "#{key_base}-jobs"
+      "#{key_base}:jobs"
     end
 
     def set_jobs_data_in_redis(data)
@@ -145,8 +130,6 @@ module Sidekiq
     def result_key_index(step)
       if step['result_key_index']
         step['result_key_index']
-      elsif step['result_key'] # legacy style, will be removed in 3.0
-        step['result_key'].split('-').last.to_i
       else
         raise "invariant: expected result_key_index passed in step; got: #{step.inspect}"
       end
@@ -154,7 +137,7 @@ module Sidekiq
 
     def enqueue_job(klass, params, result_key_index)
       job_options = Object.const_get(klass).sidekiq_options
-      result_key = "#{key_base}-#{result_key_index}"
+      result_key = "#{key_base}:result-#{result_key_index}"
       options = {
         'class'     => JobWrapper,
         'queue'     => queue || job_options['queue'],
@@ -171,7 +154,7 @@ module Sidekiq
         redis.del(jobs_key)
         result_key_index = 1
         loop do
-          result = redis.del("#{key_base}-#{result_key_index}")
+          result = redis.del("#{key_base}:result-#{result_key_index}")
           result_key_index += 1
           break if result == 0
         end

data/sidekiq-clutch.gemspec

@@ -21,7 +21,6 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'sidekiq', '>= 5.0.0'
 
-  spec.add_development_dependency 'bundler', '~> 2.2.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: 2.1.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Tim Morgan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-14 00:00:00.000000000 Z
+date: 1980-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.0.0
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.2.4
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.2.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -75,6 +61,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
+- ".envrc"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -83,6 +70,8 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- devbox.json
+- devbox.lock
 - lib/sidekiq/clutch.rb
 - lib/sidekiq/clutch/job_wrapper.rb
 - lib/sidekiq/clutch/jobs_collection.rb
@@ -108,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: An ergonomic wrapper API for Sidekiq Batches