simple_mutex 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 003ab1f3d7a72c1ed87d20272d4e7e84c8b486fd7dc3a34539ee8ce21688199d
-  data.tar.gz: e392b0b025b830ea18f062e402c1608562ad3992d3c8c100a266e77f7392dbb5
+  metadata.gz: f81fc4fca6f67910c3920de849bdce7e3e3317389a82fbf2f7ff9162b50e688e
+  data.tar.gz: ab559f0fea8d0ee4708e2135866d310577906ee643ee725564b38298a326d53d
 SHA512:
-  metadata.gz: 4385df59ccb07e0781ff83575d2137907ebc022e2971d2cb9e5f000c70075f7685585e5f93ac3b8dcf5d8798dbb28400441f1bf263c6d34167a22740f1661edd
-  data.tar.gz: 1c0bd82fce378dfe91f8d778792a325f14191547ce3e6d464cb1b472299480378299283a28340c4299ff5a1d4dd63ab49204e825d31ba85adcc7e7f0f8719784
+  metadata.gz: 36cf9cc634a114964b550c518cb15f3c01f959230e990d2a135c5aed911a36ce4b7802e4513cee59d3a6b86c2f8d908165c8e9c8f7176cd1fa2e026875aae167
+  data.tar.gz: d7f258c60572617fa5435825b1a23727b5763d44e5aa811c86676dc6f2146f21cfc95a1d9f78b263ec619bc8d93022033a265d341fdd0a2a4eb780cada5539ee

data/.github/workflows/main.yml

@@ -12,7 +12,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ["2.6", "2.7", "3.0"]
+        ruby: ["2.6", "2.7", "3.0", "3.1"]
 
     name: ${{ matrix.ruby }}
 
@@ -24,7 +24,7 @@ jobs:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
 
-      - run: bundle exec rake bundle:audit
+      - run: bundle exec bundle-audit check --update
       - run: bundle exec rubocop
       - run: bundle exec rspec
 

data/.rubocop.yml

@@ -1,6 +1,9 @@
 inherit_gem:
   rubocop-config-umbrellio: lib/rubocop.yml
 
+AllCops:
+  TargetRubyVersion: 2.6
+
 Layout/HashAlignment:
   EnforcedHashRocketStyle:
     - key
@@ -12,3 +15,6 @@ Layout/HashAlignment:
 Naming/VariableNumber:
   Exclude:
     - 'spec/**/*'
+
+Performance/StringIdentifierArgument:
+  Enabled: false

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to this project will be documented in this file.
 
+## [1.0.2]
+- Redis-namespace dependency now requires version 1.8.2 or more recent, because thread safety was broken in 1.8.1
+- Adds processing for case when `watch` fails in redis transactions (during unlocking).
+
 ## [1.0.1]
 
 - Bugfix with active job/batches memoization in `SimpleMutex::SidekiqSupport::JobCleaner` and

data/Gemfile.lock

@@ -1,91 +1,90 @@
 PATH
   remote: .
   specs:
-    simple_mutex (1.0.1)
+    simple_mutex (1.0.2)
       redis
-      redis-namespace
+      redis-namespace (>= 1.8.2)
       sidekiq
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.4.1)
+    activesupport (6.1.6)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
     ast (2.4.2)
-    bundler-audit (0.9.0.1)
+    bundler-audit (0.9.1)
       bundler (>= 1.2.0, < 3)
       thor (~> 1.0)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.1.10)
     connection_pool (2.2.5)
-    diff-lcs (1.4.4)
+    diff-lcs (1.5.0)
     docile (1.4.0)
-    i18n (1.8.10)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
-    minitest (5.14.4)
-    mock_redis (0.29.0)
+    minitest (5.16.2)
+    mock_redis (0.32.0)
       ruby2_keywords
-    parallel (1.21.0)
-    parser (3.0.2.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
-    rack (2.2.3)
-    rainbow (3.0.0)
-    redis (4.5.1)
-    redis-namespace (1.8.1)
+    rack (2.2.4)
+    rainbow (3.1.1)
+    redis (4.7.1)
+    redis-namespace (1.8.2)
       redis (>= 3.0.4)
-    regexp_parser (2.1.1)
+    regexp_parser (2.5.0)
     rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (1.17.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.30.1)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.7.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.18.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.12.0)
-      parser (>= 3.0.1.1)
-    rubocop-config-umbrellio (1.17.0.53)
-      rubocop (= 1.17.0)
-      rubocop-performance (= 1.10.0)
-      rubocop-rails (= 2.9.1)
-      rubocop-rake (= 0.5.1)
-      rubocop-rspec (= 2.2.0)
-      rubocop-sequel (= 0.2.0)
-    rubocop-performance (1.10.0)
-      rubocop (>= 0.90.0, < 2.0)
+    rubocop-ast (1.18.0)
+      parser (>= 3.1.1.0)
+    rubocop-config-umbrellio (1.30.0.65)
+      rubocop (~> 1.30.0)
+      rubocop-performance (~> 1.14.0)
+      rubocop-rails (~> 2.14.2)
+      rubocop-rake (~> 0.6.0)
+      rubocop-rspec (~> 2.11.1)
+      rubocop-sequel (~> 0.3.3)
+    rubocop-performance (1.14.2)
+      rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rails (2.9.1)
+    rubocop-rails (2.14.2)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
-      rubocop (>= 0.90.0, < 2.0)
-    rubocop-rake (0.5.1)
-      rubocop
-    rubocop-rspec (2.2.0)
+      rubocop (>= 1.7.0, < 2.0)
+    rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-      rubocop-ast (>= 1.1.0)
-    rubocop-sequel (0.2.0)
+    rubocop-rspec (2.11.1)
+      rubocop (~> 1.19)
+    rubocop-sequel (0.3.4)
       rubocop (~> 1.0)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
-    sidekiq (6.3.1)
+    sidekiq (6.5.1)
       connection_pool (>= 2.2.2)
       rack (~> 2.0)
       redis (>= 4.2.0)
@@ -95,16 +94,16 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov-lcov (0.8.0)
-    simplecov_json_formatter (0.1.3)
-    thor (1.1.0)
-    timecop (0.9.4)
+    simplecov_json_formatter (0.1.4)
+    thor (1.2.1)
+    timecop (0.9.5)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.1.0)
-    zeitwerk (2.5.1)
+    unicode-display_width (2.2.0)
+    zeitwerk (2.6.0)
 
 PLATFORMS
-  ruby
+  x86_64-linux
 
 DEPENDENCIES
   bundler
@@ -120,4 +119,4 @@ DEPENDENCIES
   timecop
 
 BUNDLED WITH
-   2.2.22
+   2.3.17

data/lib/simple_mutex/base_cleaner.rb

@@ -2,35 +2,54 @@
 
 module SimpleMutex
   class BaseCleaner
+    MAX_DEL_ATTEMPTS = 3
+
+    class SynchronizationAnomalyError < ::StandardError; end
+
+    # rubocop:disable Metrics/MethodLength
     def unlock
       ::SimpleMutex.redis_check!
 
       logger&.info(start_msg)
 
       redis.keys.select do |lock_key|
-        redis.watch(lock_key) do
-          raw_data = redis.get(lock_key)
+        attempt = 0
+
+        begin
+          redis.watch(lock_key) do
+            raw_data = redis.get(lock_key)
+            raw_data = raw_data.value if raw_data.is_a?(Redis::Future)
+
+            next if raw_data.nil?
+
+            parsed_data = safe_parse(raw_data)
 
-          next redis.unwatch if raw_data.nil?
+            next unless parsed_data&.dig("payload", "type") == type
 
-          parsed_data = safe_parse(raw_data)
+            entity_id = parsed_data&.dig(*path_to_entity_id)
 
-          next redis.unwatch unless parsed_data&.dig("payload", "type") == type
+            next if entity_id.nil? || active?(entity_id)
 
-          entity_id = parsed_data&.dig(*path_to_entity_id)
+            return_value = redis.multi { |multi| multi.del(lock_key) }
 
-          next redis.unwatch if entity_id.nil? || active?(entity_id)
+            log_iteration(lock_key, raw_data, return_value) unless logger.nil?
 
-          return_value = redis.multi { |multi| multi.del(lock_key) }
+            result = return_value&.first
 
-          log_iteration(lock_key, raw_data, return_value) unless logger.nil?
+            raise SynchronizationAnomalyError, "Sync anomaly." unless result.is_a?(Integer)
 
-          return_value&.first&.positive?
+            result.positive?
+          ensure
+            redis.unwatch
+          end
+        rescue SynchronizationAnomalyError
+          retry if (attempt += 1) < MAX_DEL_ATTEMPTS
         end
       end
 
       logger&.info(end_msg)
     end
+    # rubocop:enable Metrics/MethodLength
 
     private
 
@@ -75,8 +94,8 @@ module SimpleMutex
 
     def generate_log_msg(lock_key, raw_data, return_value)
       "Trying to delete row with key <#{lock_key.inspect}> "\
-      "and value <#{raw_data.inspect}>. "\
-      "MULTI returned value <#{return_value.inspect}>."
+        "and value <#{raw_data.inspect}>. "\
+        "MULTI returned value <#{return_value.inspect}>."
     end
 
     def redis

data/lib/simple_mutex/helper.rb

@@ -29,39 +29,37 @@ module SimpleMutex
       }
     end
 
-    # rubocop:disable Metrics/MethodLength, Style/HashEachMethods, Performance/CollectionLiteralInLoop
+    # rubocop:disable Style/HashEachMethods
     def list(mode: :default)
       check_mode(mode)
 
       result = []
+      job_types = %i[job default]
+      batch_types = %i[batch default]
 
       redis.keys.each do |lock_key|
-        redis.watch(lock_key) do
-          raw_data = redis.get(lock_key)
-
-          unless raw_data.nil?
-            parsed_data = safe_parse(raw_data)
-
-            if parsed_data.nil?
-              result << { key: lock_key, value: raw_data } if mode == :all
-            else
-              lock_type = parsed_data&.dig("payload", "type")
-
-              if (mode == :all) ||
-                 (lock_type == "Job" && %i[job default].include?(mode)) ||
-                 (lock_type == "Batch" && %i[batch default].include?(mode))
-                result << { key: lock_key, value: parsed_data }
-              end
-            end
-          end
+        raw_data = redis.get(lock_key)
+
+        next if raw_data.nil?
+
+        parsed_data = safe_parse(raw_data)
 
-          redis.unwatch
+        if parsed_data.nil?
+          result << { key: lock_key, value: raw_data } if mode == :all
+        else
+          lock_type = parsed_data&.dig("payload", "type")
+
+          if (mode == :all) ||
+             (lock_type == "Job" && job_types.include?(mode)) ||
+             (lock_type == "Batch" && batch_types.include?(mode))
+            result << { key: lock_key, value: parsed_data }
+          end
         end
       end
 
       result
     end
-    # rubocop:enable Metrics/MethodLength, Style/HashEachMethods, Performance/CollectionLiteralInLoop
+    # rubocop:enable Style/HashEachMethods
 
     private
 

data/lib/simple_mutex/mutex.rb

@@ -6,8 +6,9 @@ require "json"
 module SimpleMutex
   class Mutex
     DEFAULT_EXPIRES_IN = 60 * 60 # 1 hour
+    MAX_DEL_ATTEMPTS = 3
 
-    ERR_MSGS = {
+    ERROR_MESSAGES = {
       unlock: {
         unknown: lambda do |lock_key|
           "something when wrong when deleting lock key <#{lock_key}>."
@@ -18,6 +19,9 @@ module SimpleMutex
         signature_mismatch: lambda do |lock_key|
           "signature mismatch for lock key <#{lock_key}>."
         end,
+        repeated_synchronization_anomaly: lambda do |lock_key|
+          "repeated synchronization anomaly for <#{lock_key}>."
+        end,
       }.freeze,
       lock: {
         basic: lambda do |lock_key|
@@ -26,6 +30,8 @@ module SimpleMutex
       }.freeze,
     }.freeze
 
+    SynchronizationAnomalyError = Class.new(::StandardError)
+
     BaseError = Class.new(::StandardError) do
       attr_reader :lock_key
 
@@ -54,41 +60,62 @@ module SimpleMutex
 
         redis = ::SimpleMutex.redis
 
-        redis.watch(lock_key) do
-          raw_data = redis.get(lock_key)
+        attempt = 0
+
+        begin
+          redis.watch(lock_key) do
+            raw_data = redis.get(lock_key)
+            raw_data = raw_data.value if raw_data.is_a?(Redis::Future)
+
+            return false if raw_data.nil?
+            return false unless force || signature_valid?(raw_data, signature)
 
-          if raw_data && (force || signature_valid?(raw_data, signature))
-            redis.multi { |multi| multi.del(lock_key) }.first.positive?
-          else
+            result = redis.multi { |multi| multi.del(lock_key) }.first
+
+            raise SynchronizationAnomalyError, "Sync anomaly." unless result.is_a?(Integer)
+
+            result.positive?
+          ensure
             redis.unwatch
-            false
           end
+        rescue SynchronizationAnomalyError
+          retry if (attempt += 1) < MAX_DEL_ATTEMPTS
+          raise_error(UnlockError, :repeated_synchronization_anomaly, lock_key)
         end
       end
 
+      # rubocop:disable Metrics/MethodLength
       def unlock!(lock_key, signature: nil, force: false)
         ::SimpleMutex.redis_check!
 
         redis = ::SimpleMutex.redis
 
-        redis.watch(lock_key) do
-          raw_data = redis.get(lock_key)
+        attempt = 0
+
+        begin
+          redis.watch(lock_key) do
+            raw_data = redis.get(lock_key)
+            raw_data = raw_data.value if raw_data.is_a?(Redis::Future)
 
-          begin
-            raise_error(UnlockError, :key_not_found, lock_key) unless raw_data
+            raise_error(UnlockError, :key_not_found, lock_key) if raw_data.nil?
 
             unless force || signature_valid?(raw_data, signature)
               raise_error(UnlockError, :signature_mismatch, lock_key)
             end
 
-            success = redis.multi { |multi| multi.del(lock_key) }.first.positive?
+            result = redis.multi { |multi| multi.del(lock_key) }.first
 
-            raise_error(UnlockError, :unknown, lock_key) unless success
+            raise SynchronizationAnomalyError, "Sync anomaly." unless result.is_a?(Integer)
+            raise_error(UnlockError, :unknown, lock_key) unless result.positive?
           ensure
             redis.unwatch
           end
+        rescue SynchronizationAnomalyError
+          retry if (attempt += 1) < MAX_DEL_ATTEMPTS
+          raise_error(UnlockError, :repeated_synchronization_anomaly, lock_key)
         end
       end
+      # rubocop:enable Metrics/MethodLength
 
       def with_lock(lock_key, **options, &block)
         new(lock_key, **options).with_lock(&block)
@@ -96,7 +123,7 @@ module SimpleMutex
 
       def raise_error(error_class, msg_template, lock_key)
         template_base = error_class.name.split("::").last.gsub("Error", "").downcase.to_sym
-        error_msg     = ERR_MSGS[template_base][msg_template].call(lock_key)
+        error_msg     = ERROR_MESSAGES[template_base][msg_template].call(lock_key)
 
         raise(error_class.new(error_msg, lock_key))
       end

data/lib/simple_mutex/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SimpleMutex
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

data/simple_mutex.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/umbrellio/simple_mutex"
   spec.license       = "MIT"
 
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "redis"
-  spec.add_runtime_dependency "redis-namespace"
+  spec.add_runtime_dependency "redis-namespace", ">= 1.8.2"
   spec.add_runtime_dependency "sidekiq"
 
   spec.add_development_dependency "bundler"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_mutex
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - bob-umbr
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-19 00:00:00.000000000 Z
+date: 2022-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.8.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.8.2
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
@@ -235,14 +235,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.0.dev
 signing_key:
 specification_version: 4
 summary: Redis-based mutex library for using with sidekiq jobs and batches.