sidekiq-lock 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7fb91d967eb073b2fb524357b936d473f3ab03450f3a1e7f45f9ae53895a210e
-  data.tar.gz: 10e5ac0b30ea212f675d9ce11ba63da4114b7ade9f1da89bbdcd209cfaa2f40e
+  metadata.gz: 94c0d6993d3e6f8c2acd6a63e2e78464ac974369138f6c20eeb91525d0b5ea13
+  data.tar.gz: 75437ca38c53bc825d0e6e77b8dc2ef64c5c42bb8802746f5fbacf1f91c9e4f5
 SHA512:
-  metadata.gz: 3181d04fc0b7fbb7f9807851abf37d69b09333b38fef0c8388671a750a4087a5a185fd57dce6469095fb26ee42728b2e856f623b2643a3c15a9ed244197e6d0f
-  data.tar.gz: b1d1bd1c051b60188853436fd62ecec774cac2e303134e12dac203d166159b51e141f4a1a626ed952b6aa4591352f11e283bd17d371174bfdd25a6c3cac9745b
+  metadata.gz: 463adf7d4dbf5d468a1c795105a716d94fd6f77141e7c7f3d77a84076e4e222cc2b6fb57f64d5286bca6fc8b9491c4de891190fb3d255f1766acd879253220d0
+  data.tar.gz: c215cce1d79e99aaa28a04a5238aac165a8e5d36271a372b39067a80040109e5f64117114fdbfae227c5cb406f86cd46e554cfa6820978573abd1f08b04ada6d

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 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
+- fix for ruby 3 (thanks to [@ak15](https://github.com/ak15))
+
 ## 0.4.0 (July 18, 2018)
 
 - make lock container configurable (non breaking change) - in case you would like to something else than `Thread.current` - now you easily can
@@ -10,7 +20,7 @@
 
 ## 0.3.0 (July 28, 2016)
 
-- ability to set custom lock value. Works just like setting timeout and name (handles procs as well).
+- ability to set custom lock value. Works just like setting timeout and name, handles procs as well (thanks to [@piokaczm](https://github.com/piokaczm))
 
 ``` ruby
 sidekiq_options lock: {

data/README.md

@@ -1,8 +1,10 @@
+<p align="center">
+  <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.org/emq/sidekiq-lock.png?branch=master)](https://travis-ci.org/emq/sidekiq-lock)
-[![Coverage Status](https://coveralls.io/repos/emq/sidekiq-lock/badge.png)](https://coveralls.io/r/emq/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.

data/lib/sidekiq/lock/redis_lock.rb

@@ -23,18 +23,17 @@ 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 })
+          r.set(name, value, nx: true, px: timeout)
         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 +52,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.4.0'
+    VERSION = '0.6.0'
   end
 end

data/test/lib/lock_test.rb

@@ -4,7 +4,7 @@ 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 = ''

data/test/lib/middleware_test.rb

@@ -4,7 +4,13 @@ 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

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/test_helper.rb

@@ -1,8 +1,3 @@
-require 'coveralls'
-Coveralls.wear! do
-  add_filter '/test/'
-end
-
 require 'minitest/autorun'
 require 'minitest/pride'
 require 'mocha/setup'
@@ -12,7 +7,8 @@ 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|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-lock
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Rafal Wojsznis
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-07-18 00:00:00.000000000 Z
+date: 2023-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -66,34 +66,6 @@ dependencies:
     - - ">="
       - !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: coveralls
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -143,18 +115,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
-- Appraisals
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- gemfiles/sidekiq_2.gemfile
-- gemfiles/sidekiq_3.gemfile
-- gemfiles/sidekiq_4.gemfile
-- gemfiles/sidekiq_5.gemfile
 - lib/sidekiq-lock.rb
 - lib/sidekiq/lock.rb
 - lib/sidekiq/lock/container.rb
@@ -163,7 +127,6 @@ files:
 - lib/sidekiq/lock/testing/inline.rb
 - lib/sidekiq/lock/version.rb
 - lib/sidekiq/lock/worker.rb
-- sidekiq-lock.gemspec
 - test/lib/container_test.rb
 - test/lib/lock_test.rb
 - test/lib/middleware_test.rb
@@ -176,7 +139,7 @@ homepage: https://github.com/emq/sidekiq-lock
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -191,9 +154,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Simple redis-based lock mechanism for your sidekiq workers
 test_files:

data/.gitignore

@@ -1,22 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-.rvmrc
-.ruby-version
-.ruby-gemset
-*.gemfile.lock
-.idea/

data/.travis.yml

@@ -1,20 +0,0 @@
-language: ruby
-cache: bundler
-
-services:
-  - redis-server
-
-gemfile:
-  - gemfiles/sidekiq_2.gemfile
-  - gemfiles/sidekiq_3.gemfile
-  - gemfiles/sidekiq_4.gemfile
-  - gemfiles/sidekiq_5.gemfile
-
-rvm:
-  - 2.2.10
-  - 2.3.7
-  - 2.4.4
-  - 2.5.1
-
-notifications:
-  email: false

data/Appraisals

@@ -1,15 +0,0 @@
-appraise 'sidekiq-2' do
-  gem 'sidekiq', '~> 2.17', '>= 2.17.8'
-end
-
-appraise 'sidekiq-3' do
-  gem 'sidekiq', '~> 3.5', '>= 3.5.4'
-end
-
-appraise 'sidekiq-4' do
-  gem 'sidekiq', '~> 4.2', '>= 4.2.10'
-end
-
-appraise 'sidekiq-5' do
-  gem 'sidekiq', '~> 5.1', '>= 5.1'
-end

data/Gemfile

@@ -1,2 +0,0 @@
-source "https://rubygems.org"
-gemspec

data/gemfiles/sidekiq_2.gemfile

@@ -1,7 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "sidekiq", "~> 2.17", ">= 2.17.8"
-
-gemspec path: "../"

data/gemfiles/sidekiq_3.gemfile

@@ -1,7 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "sidekiq", "~> 3.5", ">= 3.5.4"
-
-gemspec path: "../"

data/gemfiles/sidekiq_4.gemfile

@@ -1,7 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "sidekiq", "~> 4.2", ">= 4.2.10"
-
-gemspec path: "../"

data/gemfiles/sidekiq_5.gemfile

@@ -1,7 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "sidekiq", "~> 5.1", ">= 5.1"
-
-gemspec path: "../"

data/sidekiq-lock.gemspec

@@ -1,30 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'sidekiq/lock/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "sidekiq-lock"
-  spec.version       = Sidekiq::Lock::VERSION
-  spec.authors       = ["Rafal Wojsznis"]
-  spec.email         = ["rafal.wojsznis@gmail.com"]
-  spec.description   = spec.summary = "Simple redis-based lock mechanism for your sidekiq workers"
-  spec.homepage      = "https://github.com/emq/sidekiq-lock"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "sidekiq", ">= 2.14.0"
-  spec.add_dependency "redis",   ">= 3.0.5"
-
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rack-test"
-  spec.add_development_dependency "coveralls", "~> 0.8"
-  spec.add_development_dependency "mocha", "~> 0.14.0"
-  spec.add_development_dependency "minitest"
-  spec.add_development_dependency "appraisal"
-end