gcra 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d9436b4bda7bf469a2a3cf08df00716039ba14ef
-  data.tar.gz: d3b31ffe07a84f62310acb0724ee7401be104ab1
+SHA256:
+  metadata.gz: b02bda1b59d67535c5f7e098f0553e7d79dab0baed8266668e4533eaf083fdd8
+  data.tar.gz: 12f92e851d067cc367180e9c4528f7564ffc487ddd62273fecd6450fbb8de894
 SHA512:
-  metadata.gz: f50866ecc292bb86a613e421b4c095a8e1a7afe452c292c63242e3e912b99744266e2f8621ca087cdb85619d6fc20772a66fbf3065082e440c4dd452540c210e
-  data.tar.gz: d820ff9d540b75d471392e3a56dcab43b700c21a05ca60ec317926b945a67ce45fa905159385431432d153692127063393169aed5d693f32fef4e9c3ef630d58
+  metadata.gz: 993dfc9876b0b5f92e7456a20f1e9da2875505f41457540d7e8a41ea59f2e0080880ad96bc6e7b1751dbea67c60b4b416a88099350a5435c60b467f90f42e1fa
+  data.tar.gz: cdc1e40167c88d8a3749a8176c2683520973e844063ed3035e4b9be8533c1c07af7d8119ed8eec6a24e3c918850f914a55394784e3db06d8d9c0e91e5bb3eed0

data/lib/gcra/rate_limiter.rb

@@ -23,6 +23,7 @@ module GCRA
     end
 
     def limit(key, quantity)
+      key = key.to_s unless key.is_a?(String)
       i = 0
 
       while i < MAX_ATTEMPTS
@@ -96,5 +97,30 @@ module GCRA
         "Failed to store updated rate limit data for key '#{key}' after #{MAX_ATTEMPTS} attempts"
       )
     end
+
+    # Overwrite the stored value for key to that of a bucket that has
+    # just overflowed, ignoring any existing stored data.
+    def mark_overflowed(key)
+      key = key.to_s unless key.is_a?(String)
+      i = 0
+      while i < MAX_ATTEMPTS
+        tat_from_store, now = @store.get_with_time(key)
+        new_value = now + @delay_variation_tolerance
+        ttl = @delay_variation_tolerance
+        updated = if tat_from_store.nil?
+                    @store.set_if_not_exists_with_ttl(key, new_value, ttl)
+                  else
+                    @store.compare_and_set_with_ttl(key, tat_from_store, new_value, ttl)
+                  end
+        if updated
+          return true
+        end
+        i += 1
+      end
+
+      raise StoreUpdateFailed.new(
+        "Failed to store updated rate limit data for key '#{key}' after #{MAX_ATTEMPTS} attempts"
+      )
+    end
   end
 end

data/lib/gcra/redis_store.rb

@@ -9,27 +9,33 @@ module GCRA
   if v ~= ARGV[1] then
     return 0
   end
-  if ARGV[3] ~= "0" then
-    redis.call('psetex', KEYS[1], ARGV[3], ARGV[2])
-  else
-    redis.call('set', KEYS[1], ARGV[2])
-  end
+  redis.call('psetex', KEYS[1], ARGV[3], ARGV[2])
   return 1
   EOF
+
+    # Digest::SHA1.hexdigest(CAS_SCRIPT)
+    CAS_SHA = "89118e702230c0d65969c5fc557a6e942a2f4d31".freeze
     CAS_SCRIPT_MISSING_KEY_RESPONSE = 'key does not exist'.freeze
+    SCRIPT_NOT_IN_CACHE_RESPONSE = 'NOSCRIPT No matching script. Please use EVAL.'.freeze
 
-    def initialize(redis, key_prefix)
+    CONNECTED_TO_READONLY = "READONLY You can't write against a read only slave.".freeze
+
+    def initialize(redis, key_prefix, options = {})
       @redis = redis
       @key_prefix = key_prefix
+
+      @reconnect_on_readonly = options[:reconnect_on_readonly] || false
     end
 
     # Returns the value of the key or nil, if it isn't in the store.
     # Also returns the time from the Redis server, with microsecond precision.
     def get_with_time(key)
-      time_response = @redis.time # returns tuple (seconds since epoch, microseconds)
+      time_response, value = @redis.pipelined do
+        @redis.time # returns tuple (seconds since epoch, microseconds)
+        @redis.get(@key_prefix + key)
+      end
       # Convert tuple to nanoseconds
       time = (time_response[0] * 1_000_000 + time_response[1]) * 1_000
-      value = @redis.get(@key_prefix + key)
       if value != nil
         value = value.to_i
       end
@@ -38,17 +44,21 @@ module GCRA
     end
 
     # Set the value of key only if it is not already set. Return whether the value was set.
-    # Also set the key's expiration (ttl, in seconds). The operations are not performed atomically.
+    # Also set the key's expiration (ttl, in seconds).
     def set_if_not_exists_with_ttl(key, value, ttl_nano)
       full_key = @key_prefix + key
-      did_set = @redis.setnx(full_key, value)
-
-      if did_set && ttl_nano > 0
-        ttl_milli = ttl_nano / 1_000_000
-        @redis.pexpire(full_key, ttl_milli)
+      retried = false
+      begin
+        ttl_milli = calculate_ttl_milli(ttl_nano)
+        @redis.set(full_key, value, nx: true, px: ttl_milli)
+      rescue Redis::CommandError => e
+        if e.message == CONNECTED_TO_READONLY && @reconnect_on_readonly && !retried
+          @redis.client.reconnect
+          retried = true
+          retry
+        end
+        raise
       end
-
-      return did_set
     end
 
     # Atomically compare the value at key to the old value. If it matches, set it to the new value
@@ -56,17 +66,38 @@ module GCRA
     # return false with no error. If the swap succeeds, update the ttl for the key atomically.
     def compare_and_set_with_ttl(key, old_value, new_value, ttl_nano)
       full_key = @key_prefix + key
+      retried = false
       begin
-        ttl_milli = ttl_nano / 1_000_000
-        swapped = @redis.eval(CAS_SCRIPT, keys: [full_key], argv: [old_value, new_value, ttl_milli])
+        ttl_milli = calculate_ttl_milli(ttl_nano)
+        swapped = @redis.evalsha(CAS_SHA, keys: [full_key], argv: [old_value, new_value, ttl_milli])
       rescue Redis::CommandError => e
         if e.message == CAS_SCRIPT_MISSING_KEY_RESPONSE
           return false
+        elsif e.message == SCRIPT_NOT_IN_CACHE_RESPONSE && !retried
+          @redis.script('load', CAS_SCRIPT)
+          retried = true
+          retry
+        elsif e.message == CONNECTED_TO_READONLY && @reconnect_on_readonly && !retried
+          @redis.client.reconnect
+          retried = true
+          retry
         end
         raise
       end
 
       return swapped == 1
     end
+
+    private
+
+    def calculate_ttl_milli(ttl_nano)
+      ttl_milli = ttl_nano / 1_000_000
+      # Setting 0 as expiration/ttl would result in an error.
+      # Therefore overwrite it and use 1
+      if ttl_milli == 0
+        return 1
+      end
+      return ttl_milli
+    end
   end
 end

data/lib/gcra/version.rb

@@ -1,3 +1,3 @@
 module GCRA
-  VERSION = '1.0.1'.freeze
+  VERSION = '1.2.0'.freeze
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: gcra
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Michael Frister
-autorequire: 
+- Tobias Schoknecht
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-02-08 00:00:00.000000000 Z
+date: 2020-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -40,7 +41,7 @@ dependencies:
         version: '3.3'
 description: GCRA implementation for rate limiting
 email:
-- michael.frister@barzahlen.de
+- tobias.schoknecht@barzahlen.de
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -48,11 +49,11 @@ files:
 - lib/gcra/rate_limiter.rb
 - lib/gcra/redis_store.rb
 - lib/gcra/version.rb
-homepage: https://github.com/Barzahlen/gcra
+homepage: https://github.com/Barzahlen/gcra-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -67,9 +68,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.0.6
+signing_key:
 specification_version: 4
 summary: Ruby implementation of a generic cell rate algorithm (GCRA), ported from
   the Go implementation throttled.