restrainer 1.1.3 → 1.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd2f59427326450c5159980282e4d463d275dac6fceaa2a31423a5433ff1502f
-  data.tar.gz: ddf65e8c8915e920a9689f78bce879d6feae920740890acc7c3df5f5c8ccb2d4
+  metadata.gz: c140a5c4d377fe5df87028599ec86c507d428657d1c44e8456c83fe4b046c815
+  data.tar.gz: 5229e54526f187a07266f15e7af265e91f3a5dc691ceaccb3c2628867b060ba8
 SHA512:
-  metadata.gz: 4166271f5f617a48286024f8e57ab7ebc662c0edfd357ced9e4e40d3998b975db1abcb4db6a1c8de2922ffc57ace7593e752798f39a6f552659877a146fff1b5
-  data.tar.gz: 032357eb1992399ba5d10681b7194e667d852ca000b51dcc6ac592f8d10b4734306225208c918d9c3f73faec11adf690a6d0a1ffccefab57deef09438854437a
+  metadata.gz: 77692da8fd5fd19ccea93bc3903e2322b00959ad32b20b37c7a84a9d37c4213c20d9b7ce1c541247d7f4c7f1ae8dbc870b3c71814c34a610806b968f4cff20cc
+  data.tar.gz: 2e21b607d587007bca24bae0602f7d108e447582510e053ee0fe547e635aa3e6d45224a57320776faac152aedba2cb88d8d7ddd490fc91f52a897230169383e5

data/CHANGELOG.md

@@ -4,6 +4,29 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 1.1.5
+
+### Fixed
+
+- Expired process cleanup now uses the Redis server clock instead of the client clock,
+  so clock skew between application hosts can no longer reap active locks or allow the
+  limit to be exceeded.
+- `release!` now always returns a boolean; previously it could return a truthy `0` with
+  Redis clients that return integer replies from `ZREM`.
+- The Lua script SHA1 is now precomputed as a constant. Previously each `Restrainer`
+  instance loaded the script on its first lock because the intended class level cache
+  was never populated.
+- The sorted set key is now passed to the Lua script via `KEYS` instead of `ARGV`,
+  making the script compatible with Redis Cluster slot routing.
+- The `NOSCRIPT` recovery path now retries only once instead of retrying indefinitely.
+- Fixed constructor examples in the README that raised `ArgumentError`.
+
+## 1.1.4
+
+### Removed
+
+- Removed unimplemented method stub.
+
 ## 1.1.3
 
 ### Added

data/README.md

@@ -1,5 +1,4 @@
 [![Continuous Integration](https://github.com/bdurand/restrainer/actions/workflows/continuous_integration.yml/badge.svg)](https://github.com/bdurand/restrainer/actions/workflows/continuous_integration.yml)
-[![Regression Test](https://github.com/bdurand/restrainer/actions/workflows/regression_test.yml/badge.svg)](https://github.com/bdurand/restrainer/actions/workflows/regression_test.yml)
 [![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
 [![Gem Version](https://badge.fury.io/rb/restrainer.svg)](https://badge.fury.io/rb/restrainer)
 
@@ -50,7 +49,7 @@ Restrainer.redis = redis_client
 You can also pass in a `Redis` instance in the constructor.
 
 ```ruby
-restrainer = Restrainer.new(limit: 5, redis: my_redis)
+restrainer = Restrainer.new(:my_service, limit: 5, redis: my_redis)
 ```
 
 ### Internals
@@ -60,7 +59,7 @@ To protect against situations where a process is killed without a chance to clea
 The timeout can be set by the timeout option on the constructor. If you have any timeouts set on the services being called in the block, you should set the Restrainer timeout to a slightly higher value.
 
 ```ruby
-restrainer = Restrainer.new(:my_service, 100, timeout: 10)
+restrainer = Restrainer.new(:my_service, limit: 100, timeout: 10)
 ```
 
 This gem does clean up after itself nicely, so that it won't ever leave unused data lying around in redis.

data/VERSION

@@ -1 +1 @@
-1.1.3
+1.1.5

data/lib/restrainer.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "digest"
 require "redis"
 require "securerandom"
 
@@ -17,12 +18,17 @@ class Restrainer
   attr_reader :name, :limit
 
   ADD_PROCESS_SCRIPT = <<-LUA
+    redis.replicate_commands()
+
     -- Parse arguments
-    local sorted_set = ARGV[1]
-    local process_id = ARGV[2]
-    local limit = tonumber(ARGV[3])
-    local ttl = tonumber(ARGV[4])
-    local now = tonumber(ARGV[5])
+    local sorted_set = KEYS[1]
+    local process_id = ARGV[1]
+    local limit = tonumber(ARGV[2])
+    local ttl = tonumber(ARGV[3])
+
+    -- Use the Redis server clock so all clients share a consistent view of time.
+    local time = redis.call('time')
+    local now = tonumber(time[1]) + (tonumber(time[2]) / 1000000)
 
     -- Get count of current processes. If more than the max, check if any of the processes have timed out
     -- and try again.
@@ -45,8 +51,9 @@ class Restrainer
     return process_count
   LUA
 
-  # This class level variable will be used to load the SHA1 of the script at runtime.
-  @add_process_sha1 = nil
+  # SHA1 digest of the script used to call it with EVALSHA. The script itself is
+  # only loaded to the server if it isn't already cached there.
+  ADD_PROCESS_SCRIPT_SHA1 = Digest::SHA1.hexdigest(ADD_PROCESS_SCRIPT).freeze
 
   # This error will be thrown when the throttle block can't be executed.
   class ThrottledError < StandardError
@@ -67,9 +74,9 @@ class Restrainer
       if block
         @redis = block
       else
-        unless @redis
+        @redis ||= begin
           client = Redis.new
-          @redis = lambda { client }
+          lambda { client }
         end
         @redis.call
       end
@@ -113,7 +120,7 @@ class Restrainer
   #
   # @param limit [Integer] The maximum number of processes that can be executing
   #   at any one time. Defaults to the value passed to the constructor.
-  # @return [void]
+  # @return [Object] The value returned by the block.
   # @raise [Restrainer::ThrottledError] If the throttle would be exceeded.
   def throttle(limit: nil)
     limit ||= self.limit
@@ -137,7 +144,8 @@ class Restrainer
   #   passed, a unique value will be generated.
   # @param limit [Integer] The maximum number of processes that can be executing
   #   at any one time. Defaults to the value passed to the constructor.
-  # @return [String] The process identifier.
+  # @return [String, nil] The process identifier, or nil if the limit is negative
+  #   (i.e. the throttle is wide open and there is nothing to release).
   # @raise [Restrainer::ThrottledError] If the throttle would be exceeded.
   def lock!(process_id = nil, limit: nil)
     process_id ||= SecureRandom.uuid
@@ -151,9 +159,6 @@ class Restrainer
     process_id
   end
 
-  def lock(process_id = nil, limit: nil)
-  end
-
   # Release one of the allowed processes. You must pass in a process id
   # returned by the lock method.
   #
@@ -199,28 +204,20 @@ class Restrainer
   # Remove a process to the currently run set. Returns true if the process was removed.
   def remove_process!(redis, process_id)
     result = redis.zrem(key, process_id)
-    result = true if result == 1
-    result
+    result == true || result == 1
   end
 
   # Evaluate and execute a Lua script on the redis server.
   def eval_script(redis, process_id, throttle_limit)
-    sha1 = @add_process_sha1
-    if sha1.nil?
-      sha1 = redis.script(:load, ADD_PROCESS_SCRIPT)
-      @add_process_sha1 = sha1
-    end
-
+    script_loaded = false
     begin
-      redis.evalsha(sha1, [], [key, process_id, throttle_limit, @timeout, Time.now.to_f])
+      redis.evalsha(ADD_PROCESS_SCRIPT_SHA1, [key], [process_id, throttle_limit, @timeout])
     rescue Redis::CommandError => e
-      if e.message.include?("NOSCRIPT")
-        sha1 = redis.script(:load, ADD_PROCESS_SCRIPT)
-        @add_process_sha1 = sha1
-        retry
-      else
-        raise e
-      end
+      raise if script_loaded || !e.message.include?("NOSCRIPT")
+
+      redis.script(:load, ADD_PROCESS_SCRIPT)
+      script_loaded = true
+      retry
     end
   end
 end

data/restrainer.gemspec

@@ -8,6 +8,12 @@ Gem::Specification.new do |spec|
   spec.homepage = "https://github.com/bdurand/restrainer"
   spec.license = "MIT"
 
+  spec.metadata = {
+    "homepage_uri" => spec.homepage,
+    "source_code_uri" => spec.homepage,
+    "changelog_uri" => "#{spec.homepage}/blob/main/CHANGELOG.md"
+  }
+
   # 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.
   ignore_files = %w[

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: restrainer
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.1.5
 platform: ruby
 authors:
 - Brian Durand
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-22 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -38,7 +37,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
 email:
 - bbdurand@gmail.com
 executables: []
@@ -54,8 +52,10 @@ files:
 homepage: https://github.com/bdurand/restrainer
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  homepage_uri: https://github.com/bdurand/restrainer
+  source_code_uri: https://github.com/bdurand/restrainer
+  changelog_uri: https://github.com/bdurand/restrainer/blob/main/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib
@@ -70,8 +70,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.20
-signing_key:
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Code for throttling workloads so as not to overwhelm external services
 test_files: []