redis_locks 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9c5d583e881ddb03eb3a27a20ec98600b66d756d
-  data.tar.gz: c2553b07d1bc3e33918ec0084410f4adeffc666d
+  metadata.gz: 9d50bb61032babb4eb127f5f4cf8a4b8804d84c0
+  data.tar.gz: 658610bbd101c4bce5004415c08517a44b23dd35
 SHA512:
-  metadata.gz: 04ba8f31d89668b2c872de19c14ee8896288db1f14de23301fa2b74bd9a27ea2305055b6f9105f4e3cabb304c3739c39dcf8a430a96d8a1661f96820636b9531
-  data.tar.gz: 240bdc28a11410e5a894687e28910d37d14f872fbfc2d762b56b9b80f8235134554d58151c52eb6186c97d0ac5afba5c3c36d31d84ec88c8881aa06b86f9e1fc
+  metadata.gz: b512b7584dc46896361d1c622a1c183ba6efc3ec5c22144e1162e614f47bc0bbe0c7e9e93bcb8323a1103982ceb26cd97df538d0f375b92a1b66eef13f675a60
+  data.tar.gz: 461ba90c3336dc56296053475a24141a1f0454e6cbb96cfe2d16c590eee7b7080147559a369a5713020f2af334495b7c7bb522737358930bffcc90242cca7619

data/Gemfile.lock

@@ -1,13 +1,15 @@
 PATH
   remote: .
   specs:
-    redis_locks (0.0.3)
+    redis_locks (0.1.0)
+      connection_pool
       redis
 
 GEM
   remote: https://rubygems.org/
   specs:
     coderay (1.1.1)
+    connection_pool (2.2.0)
     diff-lcs (1.2.5)
     method_source (0.8.2)
     pry (0.10.3)

data/README.md

@@ -92,3 +92,13 @@ A [token-bucket](https://en.wikipedia.org/wiki/Token_bucket) rate limiter implem
 
   limiter.take # true
 ```
+
+# Configuration
+
+We use a connection pool, because a connection shared among multiple threads
+will result in contention when using blocking Redis operations.
+
+`RedisLocks.redis=` and the `redis:` option in the initializer for each utility
+can each be passed either a plain Redis object or an object responding to `with`
+(which will be expected to accept a block and yield a Redis connection, e.g.
+an instance of [ConnectionPool](https://github.com/mperham/connection_pool)).

data/lib/redis_locks.rb

@@ -4,11 +4,12 @@ require 'redis_locks/evalsha_or_eval'
 require 'redis_locks/mutex'
 require 'redis_locks/semaphore'
 require 'redis_locks/token_bucket'
+require 'redis_locks/connections'
 
 module RedisLocks
 
   def self.redis=(redis)
-    @redis = redis
+    @redis = Connections.ensure_pool(redis)
   end
 
   def self.redis

data/lib/redis_locks/connections.rb

@@ -0,0 +1,15 @@
+require 'connection_pool'
+
+module RedisLocks
+  module Connections
+
+    def self.ensure_pool(redis)
+      if redis.respond_to?(:with)
+        redis
+      else
+        ConnectionPool.new { redis.dup }
+      end
+    end
+
+  end
+end

data/lib/redis_locks/evalsha_or_eval.rb

@@ -2,11 +2,11 @@ module RedisLocks
 
   # This ensures that each Lua script is evaluated at most once; after it has
   # been evaluated, we will be able to call it just by passing its digest.
-  def self.evalsha_or_eval(redis:, script:, digest:, keys: [], args: [])
-    redis.evalsha digest, keys, args
+  def self.evalsha_or_eval(conn:, script:, digest:, keys: [], args: [])
+    conn.evalsha digest, keys, args
   rescue Redis::CommandError => e
     if e.message.start_with?('NOSCRIPT')
-      redis.eval script, keys, args
+      conn.eval script, keys, args
     else
       raise
     end

data/lib/redis_locks/mutex.rb

@@ -11,7 +11,7 @@ module RedisLocks
 
     def initialize(key, expires_in: 86400, redis: RedisLocks.redis)
       @key = "#{NAMESPACE}:#{key}"
-      @redis = redis
+      @redis = Connections.ensure_pool(redis)
       @expires_in = expires_in.to_i
 
       raise ArgumentError.new("Invalid expires_in: #{expires_in}") unless expires_in > 0
@@ -27,16 +27,18 @@ module RedisLocks
         expires_at = now + @expires_in
       end
 
-      if @redis.setnx(@key, expires_at)
-        @redis.expire(@key, expires_at - now)
-        @expires_at = expires_at
-        locked = true
-      else # it was locked
-        if (old_value = @redis.get(@key)).to_i <= now
-          # lock has expired
-          if @redis.getset(@key, expires_at) == old_value
-            @expires_at = expires_at
-            locked = true
+      @redis.with do |conn|
+        if conn.setnx(@key, expires_at)
+          conn.expire(@key, expires_at - now)
+          @expires_at = expires_at
+          locked = true
+        else # it was locked
+          if (old_value = conn.get(@key)).to_i <= now
+            # lock has expired
+            if conn.getset(@key, expires_at) == old_value
+              @expires_at = expires_at
+              locked = true
+            end
           end
         end
       end
@@ -58,7 +60,7 @@ module RedisLocks
       # To prevent deleting a lock acquired from another process, only delete
       # the key if it's still valid, and will be for another 2 seconds
       if Time.now.utc.to_i - 2 < @expires_at
-        @redis.del(@key)
+        @redis.with { |conn| conn.del(@key) }
       end
 
       @expires_at = nil

data/lib/redis_locks/semaphore.rb

@@ -66,7 +66,7 @@ module RedisLocks
       @key = key
       @resource_count = resources.to_i
       @stale_client_timeout = stale_client_timeout.to_f
-      @redis = redis
+      @redis = Connections.ensure_pool(redis)
       @tokens = []
 
       raise ArgumentError.new("Lock key is required") if @key.nil? || @key.empty?
@@ -76,8 +76,11 @@ module RedisLocks
 
     # Forcefully clear the lock. Be careful!
     def delete!
-      @redis.del(available_key)
-      @redis.del(grabbed_key)
+      @redis.with do |conn|
+        conn.del(available_key)
+        conn.del(grabbed_key)
+      end
+
       @tokens = []
     end
 
@@ -101,18 +104,21 @@ module RedisLocks
     def lock(timeout: nil, &block)
       ensure_exists_and_release_stale_locks!
 
-      success =
+      success = @redis.with do |conn|
         if timeout
-          !@redis.blpop(available_key, timeout.to_i).nil?
+          !conn.blpop(available_key, timeout.to_i).nil?
         else
-          !@redis.lpop(available_key).nil?
+          !conn.lpop(available_key).nil?
         end
+      end
 
       return false unless success
 
       token = SecureRandom.hex(16)
       @tokens.push(token)
-      @redis.zadd(grabbed_key, epoch_f, token)
+      @redis.with do |conn|
+        conn.zadd(grabbed_key, epoch_f(conn), token)
+      end
 
       return_or_yield(token, &block)
     end
@@ -141,9 +147,13 @@ module RedisLocks
     def unlock(token = @tokens.pop)
       return unless token
 
-      removed = @redis.zrem grabbed_key, token
-      if removed
-        @redis.lpush available_key, 1
+      removed = false
+
+      @redis.with do |conn|
+        removed = conn.zrem grabbed_key, token
+        if removed
+          conn.lpush available_key, 1
+        end
       end
 
       removed
@@ -165,13 +175,15 @@ module RedisLocks
     end
 
     def ensure_exists_and_release_stale_locks!
-      RedisLocks.evalsha_or_eval(
-        redis: @redis,
-        script: SETUP_SCRIPT,
-        digest: SETUP_DIGEST,
-        keys: [available_key, grabbed_key],
-        args: [@resource_count, stale_before]
-      )
+      @redis.with do |conn|
+        RedisLocks.evalsha_or_eval(
+          conn: conn,
+          script: SETUP_SCRIPT,
+          digest: SETUP_DIGEST,
+          keys: [available_key, grabbed_key],
+          args: [@resource_count, stale_before(conn)]
+        )
+      end
     end
 
     def namespaced_key(variable)
@@ -186,12 +198,12 @@ module RedisLocks
       @grabbed_key ||= namespaced_key('GRABBED')
     end
 
-    def stale_before
-      epoch_f - @stale_client_timeout
+    def stale_before(conn)
+      epoch_f(conn) - @stale_client_timeout
     end
 
-    def epoch_f
-      epoch_i, microseconds = @redis.time
+    def epoch_f(conn)
+      epoch_i, microseconds = conn.time
       epoch_i + microseconds.to_f / 1_000_000
     end
 

data/lib/redis_locks/token_bucket.rb

@@ -45,19 +45,20 @@ module RedisLocks
       @key = "#{NAMESPACE}:#{key}".freeze
       @rps = number.to_f / period.to_i
       @burst = number.to_i
-      @redis = redis
+      @redis = Connections.ensure_pool(redis)
     end
 
     def take
-      epoch_i, microseconds = @redis.time
-      epoch_f = epoch_i + (microseconds.to_f/1_000_000)
-      took = RedisLocks.evalsha_or_eval(
-        redis: @redis,
-        script: SCRIPT,
-        digest: DIGEST,
-        keys: [@key],
-        args: [epoch_f, @rps, @burst]
-      )
+      took = @redis.with do |conn|
+        RedisLocks.evalsha_or_eval(
+          conn: conn,
+          script: SCRIPT,
+          digest: DIGEST,
+          keys: [@key],
+          args: [epoch_f(conn), @rps, @burst]
+        )
+      end
+
       took == 1
     end
 
@@ -65,5 +66,12 @@ module RedisLocks
       raise RateLimitExceeded.new(@key, @rps) unless take
     end
 
+    private
+
+    def epoch_f(conn)
+      epoch_i, microseconds = conn.time
+      epoch_i + (microseconds.to_f/1_000_000)
+    end
+
   end
 end

data/lib/redis_locks/version.rb

@@ -1,3 +1,3 @@
 module RedisLocks
-  VERSION = '0.0.3'
+  VERSION = '0.1.0'
 end

data/redis_locks.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency "redis"
+  s.add_dependency "connection_pool"
 
   s.add_development_dependency "rspec"
   s.add_development_dependency "rake"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis_locks
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Academia.edu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-16 00:00:00.000000000 Z
+date: 2016-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -67,6 +81,7 @@ files:
 - README.md
 - Rakefile
 - lib/redis_locks.rb
+- lib/redis_locks/connections.rb
 - lib/redis_locks/evalsha_or_eval.rb
 - lib/redis_locks/mutex.rb
 - lib/redis_locks/resource_unavailable.rb