sidekiq-lock 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 592d4bf95b4bbd2cba2444898c5f6843c0a9112c6c45e018999af361b8a5ca73
-  data.tar.gz: 7b0a5614796a292af28fc0880915a76ac85ecfb8c669b07d57d5019d8f246342
+  metadata.gz: b9c3099623c0436cfe8cbd6eb0d3f56168ac0fda088b7167a0211ca4cba6e530
+  data.tar.gz: b5105d14dd29c9374b43a46cba4cfd6c576f086808051949bf4729c9163be05e
 SHA512:
-  metadata.gz: ff115e3d009c6b6803e20326c2d84bf2286d9e4b652fe840b743596b8257919d7c54b3f1b9e1dcf2f9f1cba16af6541490464a77d55b52ff1b9407f28a7981f3
-  data.tar.gz: 0cf165b35136db26001b236837dcd7a831867fc81d8b81a3e14c2efe76edf41ade9cb5ba437b311b9ec1626af5aae176a3a09fde0c393ef5b949f2f5e5f8fa64
+  metadata.gz: 18898eaacf8fd60adeee2dce1e53e96bf517878856541220cbb472338dd7e4f531463917fb059b0767bb411834fe42f23aac535cb078f814de76de4bda8c3bfc
+  data.tar.gz: 07ee42bde63d54ef88ad56625167f781b259943967507fefe4769735377f12fd12dbf28985b3c0a4cf5d4a950a3162367bdcc78ce17f5ff346003c22ff38ecab

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 0.7.0 (Feb 7, 2024)
+
+- support for Sidekiq 7.2 (thanks for the issue report [9mm](https://github.com/9mm))
+- dropped support for Sidekiq 5 and older [as it reached EOL](https://github.com/sidekiq/sidekiq/wiki/Commercial-Support#version-policy)
+- removed `redis` as gem dependency (relying on sidekiq version you're using to choose the right one)
+
+## 0.6.0 (May 27, 2023)
+
+- support for Sidekiq 7 (thanks to [@stympy](https://github.com/stympy))
+- move CI pipelines to Github Actions - drop tests for everything below Sidekiq 5, run tests on redis 6.2 & 7.0 and ruby 2.6 - 3.1
+
 ## 0.5.0 (August 13, 2021)
 
 - maintenance - test on latest ruby versions (remove outdated rubies from build), add sidekiq 6 to build matrix, remove coveralls

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Rafal Wojsznis
+Copyright (c) 2024 Rafal Wojsznis
 
 MIT License
 

data/README.md

@@ -1,11 +1,10 @@
 <p align="center">
-  <img width="300" height="210" src="https://github.com/emq/sidekiq-lock/raw/master/logo.png">
+  <img width="300" height="210" src="https://github.com/rwojsznis/sidekiq-lock/raw/main/logo.png">
 </p>
 
 # Sidekiq::Lock
 
-[![Code Climate](https://codeclimate.com/github/emq/sidekiq-lock.png)](https://codeclimate.com/github/emq/sidekiq-lock)
-[![Build Status](https://travis-ci.com/rwojsznis/sidekiq-lock.svg?branch=master)](https://travis-ci.com/rwojsznis/sidekiq-lock)
+[![Code Climate](https://codeclimate.com/github/rwojsznis/sidekiq-lock.png)](https://codeclimate.com/github/rwojsznis/sidekiq-lock)
 [![Gem Version](https://badge.fury.io/rb/sidekiq-lock.png)](http://badge.fury.io/rb/sidekiq-lock)
 
 **Note:** This is a _complete_ piece of software, it should work across all future sidekiq & ruby versions.
@@ -19,7 +18,7 @@ time - it provides a `lock` method that you can use in whatever way you want.
 
 This gem requires at least:
 - redis 2.6.12
-- redis-rb 3.0.5 (support for extended SET method)
+- sidekiq 6
 
 Add this line to your application's Gemfile:
 

data/lib/sidekiq/lock/redis_lock.rb

@@ -23,18 +23,21 @@ module Sidekiq
       # this also requires redis-rb >= 3.0.5
       def acquire!
         @acquired ||= Sidekiq.redis do |r|
-          r.set(name, value, nx: true, px: timeout)
+          if Sidekiq::VERSION >= '7.2'
+            r.set(name, value, 'nx', 'px', timeout)
+          else
+            r.set(name, value, nx: true, px: timeout)
+          end
         end
       end
 
       def release!
-        Sidekiq.redis do |r|
-          begin
-            r.evalsha redis_lock_script_sha, keys: [name], argv: [value]
-          rescue Redis::CommandError
-            r.eval redis_lock_script, keys: [name], argv: [value]
-          end
-        end
+        # even if lock expired / was take over by another process
+        # it still means from our perspective that we released it
+        @acquired = false
+
+        # https://redis.io/commands/del/#return
+        release_lock == 1
       end
 
       def name
@@ -53,6 +56,27 @@ module Sidekiq
 
       attr_reader :options, :payload
 
+      def release_lock
+        # Sidekiq 7 uses redis-client gem, designed for redis 6+
+        if Sidekiq::VERSION >= '7'
+          Sidekiq.redis do |r|
+            begin
+              r.evalsha redis_lock_script_sha, [name], [value]
+            rescue RedisClient::CommandError
+              r.eval redis_lock_script, 1, [name], [value]
+            end
+          end
+        else
+          Sidekiq.redis do |r|
+            begin
+              r.evalsha redis_lock_script_sha, keys: [name], argv: [value]
+            rescue Redis::CommandError
+              r.eval redis_lock_script, keys: [name], argv: [value]
+            end
+          end
+        end
+      end
+
       def redis_lock_script_sha
         @lock_script_sha ||= Digest::SHA1.hexdigest redis_lock_script
       end

data/lib/sidekiq/lock/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module Lock
-    VERSION = '0.5.0'
+    VERSION = '0.7.0'
   end
 end

data/test/lib/lock_test.rb

@@ -4,26 +4,27 @@ require 'open3'
 module Sidekiq
   describe Lock do
     it 'automatically loads lock middleware for sidekiq server' do
-      skip 'Sidekiq 2 does not print out middleware information' if Sidekiq::VERSION < '3.0.0'
+      skip 'Sidekiq 7+ does not print out middleware information' if Sidekiq::VERSION >= '7'
 
       cmd = 'sidekiq -r ./test/test_workers.rb -v'
-      buffer = ''
+      buffer_out = ''
 
       # very not fancy (https://78.media.tumblr.com/tumblr_lzkpw7DAl21qhy6c9o2_400.gif)
       # solution, but should do the job
       Open3.popen3(cmd) do |stdin, stdout, stderr, thread|
         begin
-          Timeout.timeout(5) do
+          Timeout.timeout(3) do
             until stdout.eof? do
-              buffer << stdout.read_nonblock(16)
+              buffer_out << stdout.read_nonblock(16)
             end
           end
+
         rescue Timeout::Error
           Process.kill('KILL', thread.pid)
         end
       end
 
-      assert_match(/\s?Middleware:.*Sidekiq::Lock::Middleware/i, buffer)
+      assert_match(/\s?Middleware:.*Sidekiq::Lock::Middleware/i, buffer_out)
     end
   end
 end

data/test/lib/middleware_test.rb

@@ -4,14 +4,19 @@ module Sidekiq
   module Lock
     describe Middleware do
       before do
-        Sidekiq.redis = REDIS
+        if Sidekiq::VERSION >= '7'
+          Sidekiq.configure_server do |config|
+            config.redis = { url: REDIS_URL }
+          end
+        else
+          Sidekiq.redis = REDIS
+        end
         Sidekiq.redis { |c| c.flushdb }
         reset_lock_variable!
       end
 
-      let(:handler) { Sidekiq::Lock::Middleware.new }
-
       it 'sets lock variable with provided static lock options' do
+        handler = Sidekiq::Lock::Middleware.new
         handler.call(LockWorker.new, { 'class' => LockWorker, 'args' => [] }, 'default') do
           true
         end
@@ -20,6 +25,7 @@ module Sidekiq
       end
 
       it 'sets lock variable with provided dynamic options' do
+        handler = Sidekiq::Lock::Middleware.new
         handler.call(DynamicLockWorker.new, { 'class' => DynamicLockWorker, 'args' => [1234, 1000] }, 'default') do
           true
         end
@@ -29,6 +35,7 @@ module Sidekiq
       end
 
       it 'sets nothing for workers without lock options' do
+        handler = Sidekiq::Lock::Middleware.new
         handler.call(RegularWorker.new, { 'class' => RegularWorker, 'args' => [] }, 'default') do
           true
         end

data/test/lib/redis_lock_test.rb

@@ -4,12 +4,16 @@ module Sidekiq
   module Lock
     describe RedisLock do
       before do
-        Sidekiq.redis = REDIS
+        if Sidekiq::VERSION >= '7'
+          Sidekiq.configure_client do |config|
+            config.redis = { url: REDIS_URL }
+          end
+        else
+          Sidekiq.redis = REDIS
+        end
         Sidekiq.redis { |c| c.flushdb }
       end
 
-      let(:args) { [{'timeout' => 100, 'name' => 'test-lock'}, []] }
-
       it "raises an error on missing timeout&name values" do
         assert_raises ArgumentError do
           RedisLock.new({},[])
@@ -52,46 +56,59 @@ module Sidekiq
       end
 
       it "can acquire a lock" do
-        lock = RedisLock.new(*args)
+        lock = RedisLock.new({'timeout' => 100, 'name' => 'test-lock'}, [])
+        assert lock.acquire!
+      end
+
+      it "sets proper lock value on first and second acquire" do
+        lock = RedisLock.new({'timeout' => 1000, 'name' => 'test-lock', 'value' => 'lock value'}, [])
         assert lock.acquire!
+        assert_equal 'lock value', redis("get", lock.name)
+        assert lock.release!
+        # at this point script should be used from evalsha
+        assert lock.acquire!
+        assert_equal 'lock value', redis("get", lock.name)
+
+        redis("script", "flush")
+        assert lock.acquire!
+        assert_equal 'lock value', redis("get", lock.name)
       end
 
-      it "cannot aquire lock if it's already taken by other process/thread" do
-        faster_lock = RedisLock.new(*args)
+      it "cannot acquire lock if it's already taken by other process/thread" do
+        faster_lock = RedisLock.new({'timeout' => 100, 'name' => 'test-lock'}, [])
         assert faster_lock.acquire!
 
-        slower_lock = RedisLock.new(*args)
+        slower_lock = RedisLock.new({'timeout' => 100, 'name' => 'test-lock'}, [])
         refute slower_lock.acquire!
       end
 
       it "releases taken lock" do
-        lock = RedisLock.new(*args)
+        lock = RedisLock.new({'timeout' => 100, 'name' => 'test-lock'}, [])
         lock.acquire!
         assert redis("get", "test-lock")
 
-        lock.release!
+        assert lock.release!
         assert_nil redis("get", "test-lock")
       end
 
       it "releases lock taken by another process without deleting lock key" do
-        lock = RedisLock.new(*args)
+        lock = RedisLock.new({'timeout' => 100, 'name' => 'test-lock'}, [])
         lock.acquire!
         lock_value = redis("get", "test-lock")
         assert lock_value
         sleep 0.11 # timeout lock
 
-        new_lock = RedisLock.new(*args)
+        new_lock = RedisLock.new({'timeout' => 100, 'name' => 'test-lock'}, [])
         new_lock.acquire!
         new_lock_value = redis("get", "test-lock")
 
-        lock.release!
+        refute lock.release!
 
         assert_equal new_lock_value, redis("get", "test-lock")
       end
 
       it "releases taken lock" do
-        custom_args = [args.first.merge('value' => 'custom_value'), []]
-        lock = RedisLock.new(*custom_args)
+        lock = RedisLock.new({'timeout' => 100, 'name' => 'test-lock', 'value' => 'custom_value'}, [])
         lock.acquire!
         assert redis("get", "test-lock")
 

data/test/lib/worker_test.rb

@@ -3,8 +3,6 @@ require 'test_helper'
 module Sidekiq
   module Lock
     describe Worker do
-      # after {  }
-
       class CustomContainer
         def initialize
           @lock = nil
@@ -19,47 +17,38 @@ module Sidekiq
         end
       end
 
-      # it 'sets lock method that points to thread variable' do
-      #   set_lock_variable! "test"
-      #   assert_equal "test", LockWorker.new.lock
-      # end
-
       it 'allows method name configuration' do
-        begin
-          Sidekiq.lock_method = :custom_lock_name
+        Sidekiq.lock_method = :custom_lock_name
 
-          class WorkerWithCustomLockName
-            include Sidekiq::Worker
-            include Sidekiq::Lock::Worker
-          end
+        class WorkerWithCustomLockName
+          include Sidekiq::Worker
+          include Sidekiq::Lock::Worker
+        end
 
-          set_lock_variable! "custom_name"
+        set_lock_variable! "custom_name"
 
-          assert_equal "custom_name", WorkerWithCustomLockName.new.custom_lock_name
+        assert_equal "custom_name", WorkerWithCustomLockName.new.custom_lock_name
 
-          reset_lock_variable!
-        ensure
+        reset_lock_variable!
+      ensure
 
-          Sidekiq.lock_method = Sidekiq::Lock::METHOD_NAME
-        end
+        Sidekiq.lock_method = Sidekiq::Lock::METHOD_NAME
       end
 
       it 'allows container configuration' do
-        begin
-          container = CustomContainer.new
-          Sidekiq.lock_container = container
+        container = CustomContainer.new
+        Sidekiq.lock_container = container
 
-          class WorkerWithCustomContainer
-            include Sidekiq::Worker
-            include Sidekiq::Lock::Worker
-          end
+        class WorkerWithCustomContainer
+          include Sidekiq::Worker
+          include Sidekiq::Lock::Worker
+        end
 
-          container.store "lock-variable"
+        container.store "lock-variable"
 
-          assert_equal "lock-variable", WorkerWithCustomContainer.new.lock
-        ensure
-          Sidekiq.lock_container = Sidekiq::Lock::Container.new
-        end
+        assert_equal "lock-variable", WorkerWithCustomContainer.new.lock
+      ensure
+        Sidekiq.lock_container = Sidekiq::Lock::Container.new
       end
     end
   end

data/test/test_helper.rb

@@ -1,13 +1,12 @@
 require 'minitest/autorun'
-require 'minitest/pride'
-require 'mocha/setup'
-
+require 'mocha/minitest'
 require 'sidekiq'
 require 'test_workers'
 
 Sidekiq.logger.level = Logger::ERROR
 
-REDIS = Sidekiq::RedisConnection.create(url: 'redis://localhost/15')
+REDIS_URL = ENV['REDIS_URL'] || 'redis://localhost/15'
+REDIS = Sidekiq::RedisConnection.create(url: REDIS_URL)
 
 def redis(command, *args)
   Sidekiq.redis do |c|

data/test/test_workers.rb

@@ -1,3 +1,4 @@
+$LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
 require 'sidekiq-lock'
 
 class LockWorker

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-lock
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Rafal Wojsznis
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-13 00:00:00.000000000 Z
+date: 2024-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -16,112 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.14.0
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.14.0
-- !ruby/object:Gem::Dependency
-  name: redis
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.5
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.5
-- !ruby/object:Gem::Dependency
-  name: bundler
-  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: rake
-  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: 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: mocha
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.14.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.14.0
-- !ruby/object:Gem::Dependency
-  name: minitest
-  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: appraisal
-  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'
+        version: '6'
 description: Simple redis-based lock mechanism for your sidekiq workers
 email:
 - rafal.wojsznis@gmail.com
@@ -153,7 +55,7 @@ homepage: https://github.com/emq/sidekiq-lock
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -168,16 +70,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.5
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Simple redis-based lock mechanism for your sidekiq workers
 test_files:
-- test/test_workers.rb
-- test/lib/worker_test.rb
+- test/lib/container_test.rb
+- test/lib/lock_test.rb
+- test/lib/middleware_test.rb
 - test/lib/redis_lock_test.rb
 - test/lib/testing/inline_test.rb
-- test/lib/middleware_test.rb
-- test/lib/lock_test.rb
-- test/lib/container_test.rb
+- test/lib/worker_test.rb
 - test/test_helper.rb
+- test/test_workers.rb