prorate 0.7.0 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb2c78403fd3d37fd073ccf736618673e532c6fc53efd7e1c342c7edebc4037f
-  data.tar.gz: 497b74b1d07d1590e44f338f7150b6b75fe5ed154af82d052381915a2b174c69
+  metadata.gz: 941127ba358ced7518e1c69224680aadb4beceac96127013f77f26dd8013619d
+  data.tar.gz: 9e517111477fc854e1404bedbd89126d0002f3d98386091180e757d9dcfdf992
 SHA512:
-  metadata.gz: d2a262971d745073dfd385088d92bf40667fa8108e6c3b71982b17fad41d6ee94472e40f8189badfa6131ac853a0dfe381e9bfbef93a0b7bbd24c3f39339251f
-  data.tar.gz: 33f4f60558e7cee9fd671ebe48f4e35fc67e58c2ea5ad5cde5e40368b8b486e941eabb71ddf3dfaa87a9380689d31c059d56ea81cfa8860a955409d075840824
+  metadata.gz: 6478f0fb8c2df29254cae40e47ba5ffaa6bf09fce03543907edce681056e342eed6fdca57b4025449081c7c768f435ecb9e33cb2a76cc727500dd34b63c7b65c
+  data.tar.gz: 0e2a1376cd72013f9511b87a01143003c8ffe7a093004b9dbe13130008fef006e65452d1000e6998d997599f11120b883bca5f09eaeab5462b3eb6297f5e3cf7

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.7.1
+
+* Fix use of a ConnectionPool as `redis:` argument which was broken in 0.7.0
+* Use the Lua KEYS argument in `rate_limit.lua` for future-proof clustering support
+  instead of computing the touched keys inside the Lua script.
+
 # 0.7.0
 
 * Add a naked `LeakyBucket` object which allows one to build sophisticated rate limiting relying

data/Rakefile

@@ -9,6 +9,10 @@ YARD::Rake::YardocTask.new(:doc) do |t|
   t.files = ['lib/**/*.rb', '-', 'LICENSE.txt', 'CHANGELOG.md']
 end
 
-RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.rspec_opts = ["-c", "--order=rand"]
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
 RuboCop::RakeTask.new(:rubocop)
 task default: [:spec, :rubocop]

data/lib/prorate/leaky_bucket.rb

@@ -60,7 +60,7 @@ module Prorate
     #   If your bucket is specific to a user, a browser or an IP address you need to mix in
     #   those values into the key prefix as appropriate.
     # @param leak_rate[Float] the leak rate of the bucket, in tokens per second
-    # @param redis[Redis,#with] a Redis connection or a ConnectonPool instance
+    # @param redis[Redis,#with] a Redis connection or a ConnectionPool instance
     #   if you are using the connection_pool gem. With a connection pool Prorate will
     #   checkout a connection using `#with` and check it in when it's done.
     # @param bucket_capacity[Numeric] how many tokens is the bucket capped at.
@@ -70,7 +70,7 @@ module Prorate
     #   of 12, and will then immediately start leaking again.
     def initialize(redis_key_prefix:, leak_rate:, redis:, bucket_capacity:)
       @redis_key_prefix = redis_key_prefix
-      @redis = NullPool.new(redis) unless redis.respond_to?(:with)
+      @redis = redis.respond_to?(:with) ? redis : NullPool.new(redis)
       @leak_rate = leak_rate.to_f
       @capacity = bucket_capacity.to_f
     end

data/lib/prorate/rate_limit.lua

@@ -8,13 +8,21 @@
 redis.replicate_commands()
 -- make some nicer looking variable names:
 local retval = nil
-local bucket_level_key = ARGV[1] .. ".bucket_level"
-local last_updated_key = ARGV[1] .. ".last_updated"
-local block_key = ARGV[1] .. ".block"
-local max_bucket_capacity = tonumber(ARGV[2])
-local leak_rate = tonumber(ARGV[3])
-local block_duration = tonumber(ARGV[4])
-local n_tokens = tonumber(ARGV[5]) -- How many tokens this call adds to the bucket. Defaults to 1
+
+-- Redis documentation recommends passing the keys separately so that Redis
+-- can - in the future - verify that they live on the same shard of a cluster, and
+-- raise an error if they are not. As far as can be understood this functionality is not
+-- yet present, but if we can make a little effort to make ourselves more future proof
+-- we should.
+local bucket_level_key = KEYS[1]
+local last_updated_key = KEYS[2]
+local block_key = KEYS[3]
+
+-- and the config variables
+local max_bucket_capacity = tonumber(ARGV[1])
+local leak_rate = tonumber(ARGV[2])
+local block_duration = tonumber(ARGV[3])
+local n_tokens = tonumber(ARGV[4]) -- How many tokens this call adds to the bucket. Defaults to 1
 
 -- Take the Redis timestamp
 local redis_time = redis.call("TIME") -- Array of [seconds, microseconds]
@@ -23,7 +31,8 @@ local key_lifetime = math.ceil(max_bucket_capacity / leak_rate)
 
 local blocked_until = redis.call("GET", block_key)
 if blocked_until then
-  return {(tonumber(blocked_until) - now), 0}
+  -- see https://redis.io/docs/manual/programmability/lua-api/ : floats should be returned as strings or they will be cast into integers
+  return {(tostring(tonumber(blocked_until) - now)), -1}
 end
 
 -- get current bucket level. The throttle key might not exist yet in which
@@ -41,7 +50,7 @@ if (new_bucket_level + n_tokens) <= max_bucket_capacity then
   retval = {0, math.ceil(new_bucket_level)}
 else
   redis.call("SETEX", block_key, block_duration, now + block_duration)
-  retval = {block_duration, 0}
+  retval = {tostring(block_duration), -1}
 end
 
 -- Save the new bucket level

data/lib/prorate/throttle.rb

@@ -13,7 +13,7 @@ module Prorate
     def initialize(name:, limit:, period:, block_for:, redis:, logger: Prorate::NullLogger)
       @name = name.to_s
       @discriminators = [name.to_s]
-      @redis = NullPool.new(redis) unless redis.respond_to?(:with)
+      @redis = redis.respond_to?(:with) ? redis : NullPool.new(redis)
       @logger = logger
       @block_for = block_for
 
@@ -95,7 +95,7 @@ module Prorate
         block_for: @block_for,
         n_tokens: n_tokens)
 
-      if remaining_block_time > 0
+      if bucket_level == -1
         @logger.warn do
           "Throttle %s exceeded limit of %d in %d seconds and is blocked for the next %d seconds" % [@name, @limit, @period, remaining_block_time]
         end
@@ -135,9 +135,15 @@ module Prorate
     end
 
     def run_lua_throttler(identifier:, bucket_capacity:, leak_rate:, block_for:, n_tokens:)
+      # Computing the identifier is somewhat involved so we should avoid doing it too often
+      id = identifier
+      bucket_level_key = "#{id}.bucket_level"
+      last_updated_key = "#{id}.last_updated"
+      block_key = "#{id}.block"
+
       @redis.with do |redis|
         begin
-          redis.evalsha(LUA_SCRIPT_HASH, [], [identifier, bucket_capacity, leak_rate, block_for, n_tokens])
+          redis.evalsha(LUA_SCRIPT_HASH, keys: [bucket_level_key, last_updated_key, block_key], argv: [bucket_capacity, leak_rate, block_for, n_tokens])
         rescue Redis::CommandError => e
           if e.message.include? "NOSCRIPT"
             # The Redis server has never seen this script before. Needs to run only once in the entire lifetime

data/lib/prorate/version.rb

@@ -1,3 +1,3 @@
 module Prorate
-  VERSION = "0.7.0"
+  VERSION = "0.7.2"
 end

data/prorate.gemspec

@@ -34,5 +34,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency 'wetransfer_style', '0.6.5'
   spec.add_development_dependency 'yard', '~> 0.9'
-  spec.add_development_dependency 'pry', '~> 0.13.1'
+  spec.add_development_dependency 'pry', '~> 0.14.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prorate
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.2
 platform: ruby
 authors:
 - Julik Tarkhanov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-17 00:00:00.000000000 Z
+date: 2023-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.1
+        version: 0.14.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.1
+        version: 0.14.2
 description: Can be used to implement all kinds of throttles
 email:
 - me@julik.nl
@@ -173,7 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Time-restricted rate limiter using Redis