rapidity 0.0.5.88265 → 0.0.6.88566

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6faa9172962dc6c7004e59dc8e827f16572b99c41b586c7221539d2bf253dda5
-  data.tar.gz: fb698e043084b6ad4491c2c85b785f9678aba9996f333e3df6bae45d6f76a76a
+  metadata.gz: f035f3525eab3c929a835208cd275212935d1052df051234b46a5240517d3c25
+  data.tar.gz: 129798e61b0e40d402d18d1d5d80d2e2f1f05e99c53de2c0bec240774d0fda07
 SHA512:
-  metadata.gz: d76e69e666ae0ab3a541f8ce725b2aae485ac9c7218163bd23bcaf4023f33db748da42f5dab7b978699f3f0ac3c0cfce9b49e2933127b81613d7df4533bc7496
-  data.tar.gz: 7434ad4f51dc20142d28f5df0bd004f79e8674dec8ac317683d18921626469525f81956ce4c3b7a8260c11cdb3cd7f281bb3f7f7aac5123e532899a9446d1587
+  metadata.gz: eb39b54f19ee6d1bc89592aa9a03012c2e274452a72ff4e6bafdb629b614aa8401e5fbc1626f108b30d98f46e6b9a7bc498f2612cfa9cd0fd593d9c710e8e750
+  data.tar.gz: 0043036ac0b0451f1a694f565b2149ecf88b9219a7997beb6a7ec9aa3e4b14be800c1e7e676747a4a3ec93ef21ce69fbba8110ea8f8a6ccedd28a61ce3374c7e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rapidity (0.0.5.88265)
+    rapidity (0.0.6.88566)
       activesupport
       connection_pool
       redis

data/README.md

@@ -12,10 +12,12 @@
 Simple but fast Redis-backed distributed rate limiter. Allows you to specify time interval and count within to limit distributed operations.
 
 Features:
- 
- - extremly simple
- - safe
- - fast
+
+- extremly simple
+- free from race condition through LUA scripting
+- fast
+
+[Article(russian) about gem.](https://blog.rnds.pro/029-rapidity/?utm_source=github&utm_medium=repo&utm_campaign=rnds)
 
 ## Usage
 
@@ -75,18 +77,22 @@ loop do
     sleep 1
   end
 end
-
 ```
 
 ## Installation
 
 It's a gem:
+
 ```bash
   gem install rapidity
 ```
+
 There's also the wonders of [the Gemfile](http://bundler.io):
+
 ```ruby
   gem 'rapidity'
 ```
 
+## Special Thanks
 
+- [WeTransfer/prorate](https://github.com/WeTransfer/prorate) for LUA-examples

data/lib/rapidity/limiter.lua

@@ -0,0 +1,37 @@
+-- args: key, treshold, interval, count
+-- returns: obtained count.
+
+-- make some nicer looking variable names:
+local retval = nil
+
+-- 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 key = KEYS[1]
+local treshold = tonumber(ARGV[1])
+local interval = tonumber(ARGV[2])
+local count = tonumber(ARGV[3])
+
+local current = 0
+local to_return = 0
+
+redis.call("SET", key, treshold, "EX", interval, "NX")
+current = redis.call("DECRBY", key, count)
+
+-- If we became below zero we must return some value back
+if current < 0 then
+  to_return = math.min(count, math.abs(current))
+
+  -- set 0 to current counter value
+  redis.call("SET", key, 0, 'KEEPTTL')
+
+  -- return obtained part of requested count
+  retval = count - to_return
+else
+  -- return full of requested count
+  retval = count
+end
+
+return retval

data/lib/rapidity/limiter.rb

@@ -6,6 +6,7 @@ module Rapidity
 
     attr_reader :pool, :name, :interval, :threshold, :namespace
 
+    LUA_SCRIPT_CODE = File.read(File.join(__dir__, 'limiter.lua'))
 
     # Convert message to given class
     # @params pool - inititalized Redis pool
@@ -30,12 +31,12 @@ module Rapidity
     # @return remaining counter value
     def remains
       results = @pool.with do |conn|
-        conn.multi do
-          conn.set(key('remains'), threshold, ex: interval, nx: true)
-          conn.get(key('remains'))
+        conn.multi do |pipeline|
+          pipeline.set(key('remains'), threshold, ex: interval, nx: true)
+          pipeline.get(key('remains'))
         end
       end
-      results[1].to_i #=> conn.get(key('remains'))
+      results[1].to_i #=> pipeline.get(key('remains'))
     end
 
     # Obtain values from counter
@@ -43,38 +44,41 @@ module Rapidity
     def obtain(count = 5)
       count = count.abs
 
-      results = @pool.with do |conn|
-        conn.multi do
-          conn.set(key('remains'), threshold, ex: interval, nx: true)
-          conn.decrby(key('remains'), count)
+      result = begin
+        @pool.with do |conn|
+          conn.evalsha(@script, keys: [key('remains')], argv: [threshold, interval, count])
+        end
+      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
+          # of the Redis server, until the script changes - in which case it will be loaded under a different SHA
+          ensure_script_loaded
+          retry
+        else
+          raise e
         end
       end
 
-      taken = results[1].to_i #=> conn.decrby(key('remains'), count)
+      taken = result.to_i
 
-      if taken < 0
-        overflow = taken.abs
-        to_return = [count, overflow].min
-
-        results = @pool.with do |conn|
-          conn.multi do
-            conn.set(key('remains'), threshold - to_return, ex: interval, nx: true)
-            conn.incrby(key('remains'), to_return)
-            conn.ttl(key('remains'))
-          end
+      if taken == 0
+        ttl = @pool.with do |conn|
+          conn.ttl(key('remains'))
         end
 
-        ttl = results[2].to_i #=> conn.ttl(key('remains'))
-
-        # reset if no ttl present
-        if ttl == -1 
+        # UNKNOWN BUG? reset if no ttl present. Many years ago once upon time we meet our key without TTL
+        if ttl == -1
           STDERR.puts "ERROR[#{Time.now}]: TTL for key #{key('remains').inspect} disappeared!"
-          @pool.with {|c| c.expire(key('remains'), interval) } 
+          @pool.with {|c| c.expire(key('remains'), interval) }
         end
+      end
+
+      taken
+    end
 
-        count - to_return
-      else
-        count
+    def ensure_script_loaded
+      @script = @pool.with do |conn|
+        conn.script(:load, LUA_SCRIPT_CODE)
       end
     end
 

data/lib/rapidity/version.rb

@@ -1,6 +1,6 @@
 module Rapidity
 
-  VERSION = '0.0.5'.freeze
+  VERSION = '0.0.6'.freeze
 
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rapidity
 version: !ruby/object:Gem::Version
-  version: 0.0.5.88265
+  version: 0.0.6.88566
 platform: ruby
 authors:
 - Yurusov Vlad
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-25 00:00:00.000000000 Z
+date: 2022-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -235,6 +235,7 @@ files:
 - README.md
 - lib/rapidity.rb
 - lib/rapidity/composer.rb
+- lib/rapidity/limiter.lua
 - lib/rapidity/limiter.rb
 - lib/rapidity/version.rb
 homepage: