praroter 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a14e168451294700f7c71bed654256c51bcf6742f186f8201f9aebe7a1a6e3e5
-  data.tar.gz: 5d1995a758edad1c5f054bf665f101fa85ba00bb34eb729415eaf4a7a5f13c1e
+  metadata.gz: 45d402fb542e1179c77ef384e333750f8435f48f6ecc3fc0e9ac1a1e790184b4
+  data.tar.gz: '048682c2d4f5303e264f77ce31f2a8c0e519c829e4508ed308b0f4f7738ca71f'
 SHA512:
-  metadata.gz: bb3c8fb96ff6f5fdec4fe33eff582ba3db6be91caf2714e28f6ba3b4fb79dccc7dbece841a82de1c2becf507c65124cea12257bbebf7ef856cd4fdf261cef725
-  data.tar.gz: 4b242a9abeccf2844cdeba9a0c939f5846255db810f7cd14bafaf05eafebbf5e70f6b021d83683ca92be3e8205b796721ee1f2017990288c8a181c71e5cddfa8
+  metadata.gz: 29965045ee43c7c5f3c1c4e77d7d3c7e8f60acfa61ae441d705a83f1e41fc3523d41385de551fda9060d185a86e53f1f769e5cab82748eec6ccb8a344ee3988c
+  data.tar.gz: 4526e457a81f08204de5ba456e5b2295ae4ee30f9c5dcf77222c8c8b3c536616212c2a71d36aba58be6ff29a331946364f5baba95d5660a68096ca11045b33cf

data/lib/praroter/filly_bucket/bucket.rb

@@ -9,6 +9,10 @@ module Praroter
         @fill_rate = fill_rate
         @capacity = capacity
         @creator = creator
+
+        raise ArgumentError, "key must be a string" if @key.class != String
+        raise ArgumentError, "fill_rate must be an integer" if @fill_rate.class != Integer
+        raise ArgumentError, "capacity must be an integer" if @capacity.class != Integer
       end
 
       def state
@@ -33,7 +37,9 @@ module Praroter
       end
 
       def drain(amount)
-        raise ArgumentError, "drain amount must be positive" if amount < 0
+        raise ArgumentError, "drain amount must be an integer" if amount.class != Integer
+        raise ArgumentError, "drain amount must be a positive number" if amount < 0
+
         @creator.run_lua_bucket_script(self, amount)
       end
 

data/lib/praroter/filly_bucket/creator.rb

@@ -18,12 +18,12 @@ module Praroter
           begin
             # The script returns a tuple of "whole tokens, microtokens"
             # to be able to smuggle the float across (similar to Redis TIME command)
-            new_bucket_level, bucket_capacity, fill_rate = r.evalsha(
+            new_bucket_level, bucket_capacity, fill_rate, scoop = r.evalsha(
               LUA_SCRIPT_HASH,
               keys: [bucket.level_key, bucket.last_updated_key],
               argv: [bucket.capacity, bucket.fill_rate, amount]
             )
-            BucketState.new(new_bucket_level, bucket_capacity, fill_rate, amount)
+            BucketState.new(new_bucket_level, bucket_capacity, fill_rate, scoop)
           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/praroter/filly_bucket/filly_bucket.lua

@@ -33,19 +33,25 @@ local new_bucket_level = bucket_level + (fill_rate * dt) - scoop
 -- and _then_ and add the tokens we fillup with
 new_bucket_level = math.min(bucket_capacity, new_bucket_level)
 
--- Compute the key TTL for the bucket. We are interested in how long it takes the bucket
--- to leak all the way to bucket_capacity, as this is the time when the values stay relevant. We pad with 1 second
--- to have a little cushion.
-local key_lifetime = nil
-if new_bucket_level < 0 then -- if new_bucket_level is negative, then the TTL need to be longer
-  key_lifetime = math.ceil((math.abs(bucket_capacity - new_bucket_level) / fill_rate) + 1)
-else
-  key_lifetime = math.ceil((bucket_capacity / fill_rate) + 1)
-end
-
 if new_bucket_level == bucket_capacity then
-  return {new_bucket_level, bucket_capacity, fill_rate}
+  -- We subtract new_bucket_level with scoop to maintain expectations
+  -- there are cases where (bucket_level + (fill_rate * dt) - scoop) will be higher than
+  -- new_bucket_level, and in those cases consumers will expect to see:
+  -- {9995, 10000, 250, 5}
+  -- instead of:
+  -- {10000, 10000, 250, 5}
+  return {new_bucket_level - scoop, bucket_capacity, fill_rate, scoop}
 else
+  -- Compute the key TTL for the bucket. We are interested in how long it takes the bucket
+  -- to leak all the way to bucket_capacity, as this is the time when the values stay relevant. We pad with 1 second
+  -- to have a little cushion.
+  local key_lifetime = nil
+  if new_bucket_level < 0 then -- if new_bucket_level is negative, then the TTL need to be longer
+    key_lifetime = math.ceil((math.abs(bucket_capacity - new_bucket_level) / fill_rate) + 1)
+  else
+    key_lifetime = math.ceil((bucket_capacity / fill_rate) + 1)
+  end
+
   -- Save the new bucket level
   redis.call("SETEX", bucket_level_key, key_lifetime, new_bucket_level)
 
@@ -53,5 +59,5 @@ else
   -- can be correctly determined on the next invocation
   redis.call("SETEX", last_updated_key, key_lifetime, now)
 
-  return {new_bucket_level, bucket_capacity, fill_rate}
+  return {new_bucket_level, bucket_capacity, fill_rate, scoop}
 end

data/lib/praroter/version.rb

@@ -1,3 +1,3 @@
 module Praroter
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

data/scripts/test.sh

@@ -1,2 +1,2 @@
 #!/bin/bash
-redis-cli --ldb --eval lib/praroter/filly_bucket.lua filly_bucket.api.user:42.bucket_level filly_bucket.api.user:42.last_updated , 5000 100 1000
+redis-cli --ldb --eval lib/praroter/filly_bucket/filly_bucket.lua filly_bucket.api.user_42.bucket_level filly_bucket.api.user_42.last_updated , 10000 250 1000

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: praroter
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Kasper Grubbe
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-30 00:00:00.000000000 Z
+date: 2020-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis