cache_store_redis 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27eeddfa958f35d2bace14b86093d3dfab8c2a23
-  data.tar.gz: ac17f9dd859655f8493f8d4abc9e7f98223c91e1
+  metadata.gz: 60da65abdb34c0ff1c3f13be3c3adc90eb9749fc
+  data.tar.gz: 0777f322a72712b760cddd07ebe98406defcc739
 SHA512:
-  metadata.gz: 7f04c7cc83c4d9fa6a8b49b443029909a56d6fb2760f387aaafaae6af9745309ac7d5081e546d39edaa2a2329ab50a2387d4bde5c6e7c73cdb40eb27e6d27892
-  data.tar.gz: a78cda144717405ffe7987e781afadb76cc4d093af26f122851dadb99a0dcd93842e9f271161b5dfd13154ed61defeaba27c3082dc042e7003f23f061996d10a
+  metadata.gz: b7a2d59f6b7b32cdab7f2872386bdd30fe02b237895dcf4f6646d08348df7de3e5040441f12f701bdb94eefec19a003f33dfa3f5e7b7de89ae7bb1a402858b5e
+  data.tar.gz: b7ccfe96ee92fcc13c582c00956e0551906f74203311caec01326905483fc85a81b05d45dbdba1a56bd66643636e1f79dabd7be5543b7cbc6e63d5464a7393ee

data/lib/cache_store_redis.rb

@@ -5,5 +5,7 @@ require 'cache_store_redis/version'
 require 'redis'
 require 'securerandom'
 
+require_relative 'cache_store_redis/redis_connection'
+require_relative 'cache_store_redis/connection_pool'
 require_relative 'cache_store_redis/redis_cache_store'
 require_relative 'cache_store_redis/optional_redis_cache_store'

data/lib/cache_store_redis/connection_pool.rb

@@ -0,0 +1,84 @@
+# This class is used to define a pool of re-usable redis connections.
+class ConnectionPool
+  attr_accessor :config
+
+  def initialize(namespace = nil, config = nil)
+    @namespace = namespace
+    @config = config
+    @queue = Queue.new
+    @connections = []
+    @mutex = Mutex.new
+    @monitor_thread = Thread.new do
+      loop do
+        sleep(1)
+        @mutex.synchronize do
+          connections.select { |con| con.expired? }.each do |con|
+            con.close
+          end
+        end
+      end
+    end
+  end
+
+  # This method is called to get the namespace for redis keys.
+  def namespace
+    @namespace
+  end
+
+  # This method is called to get the idle connection queue for this pool.
+  def queue
+    @queue
+  end
+
+  # This method is called to fetch a connection from the queue or create a new connection if no idle connections
+  # are available.
+  def fetch_connection
+    queue.pop(true)
+  rescue
+    RedisConnection.new(config)
+  end
+
+  # This method is called to checkout a connection from the pool before use.
+  def check_out
+    connection = nil
+    @mutex.synchronize do
+      connection = fetch_connection
+      connections.delete(connection)
+      connection.open
+    end
+    connection
+  end
+
+  # This method is called to checkin a connection to the pool after use.
+  def check_in(connection)
+    if connection.expired?
+      connection.close
+    end
+    @mutex.synchronize do
+      connections.push(connection)
+      queue.push(connection)
+    end
+  end
+
+  # This method is called to use a connection from this pool.
+  def with_connection
+    connection = check_out
+    return yield connection.client
+  ensure
+    check_in(connection)
+  end
+
+  # This method is called to get an array of idle connections in this pool.
+  def connections
+    @connections
+  end
+
+  def shutdown
+    connections.each do |con|
+      con.client.close
+    end
+    @connections = []
+    @monitor_thread.kill
+    @queue = Queue.new
+  end
+end

data/lib/cache_store_redis/redis_cache_store.rb

@@ -1,13 +1,14 @@
 # This class is used to implement a redis cache store.
 class RedisCacheStore
   def initialize(namespace = nil, config = nil)
+    @connection_pool = ConnectionPool.new(config)
+
     unless RUBY_PLATFORM == 'java'
       require 'oj'
     end
 
     @namespace = namespace
     @config = config
-    @queue = Queue.new
 
     @connections_created = 0
     @connections_in_use = 0
@@ -15,26 +16,8 @@ class RedisCacheStore
     @enable_stats = false
   end
 
-  def enable_stats=(value)
-    @enable_stats = value
-  end
-
-  def increment_created_stat
-    @mutex.synchronize do
-      @connections_created += 1
-    end
-  end
-
-  def increment_using_stat
-    @mutex.synchronize do
-      @connections_in_use += 1
-    end
-  end
-
-  def decrement_using_stat
-    @mutex.synchronize do
-      @connections_in_use -= 1
-    end
+  def connection_pool
+    @connection_pool
   end
 
   # This method is called to configure the connection to the cache store.
@@ -61,43 +44,17 @@ class RedisCacheStore
     @config[:connect_timeout] = connect_timeout
     @config[:read_timeout] = read_timeout
     @config[:write_timeout] = write_timeout
-  end
-
-  def fetch_client
-    begin
-      @queue.pop(true)
-    rescue
-      increment_created_stat
-      Redis.new(@config)
-    end
+    connection_pool.config = @config
   end
 
   def clean
-    while @queue.length.positive?
-      client = @queue.pop(true)
-      client.close
-    end
-  end
-
-  def log_stats
-    return unless @enable_stats == true
-    S1Logging.logger.debug do
-      "[#{self.class}] - REDIS Connection Stats. Process: #{Process.pid} | " \
-"Created: #{@connections_created} | Pending: #{@queue.length} | In use: #{@connections_in_use}"
-    end
+    connection_pool.shutdown
   end
+  alias_method :shutdown, :clean
 
   def with_client
-    log_stats
-    begin
-      client = fetch_client
-      increment_using_stat
-      log_stats
-      yield client
-    ensure
-      @queue.push(client)
-      decrement_using_stat
-      log_stats
+    connection_pool.with_connection do |connection|
+      yield connection
     end
   end
 
@@ -106,7 +63,7 @@ class RedisCacheStore
   # @param key [String] This is the unique key to reference the value being set within this cache store.
   # @param value [Object] This is the value to set within this cache store.
   # @param expires_in [Integer] This is the number of seconds from the current time that this value should expire.
-  def set(key, value, expires_in = 0)
+  def set(key, value, expires_in = 3_600)
     k = build_key(key)
 
     v = if value.nil? || (value.is_a?(String) && value.strip.empty?)

data/lib/cache_store_redis/redis_connection.rb

@@ -0,0 +1,29 @@
+class RedisConnection
+  attr_accessor :created
+  attr_accessor :client
+
+  def initialize(config)
+    self.client = Redis.new(config)
+    self.created = Time.now
+  end
+
+  # This method is called to determine if this connection has been open for longer than the keep alive timeout or not.
+  def expired?
+    return false if self.created.nil?
+    Time.now >= (self.created + keep_alive_timeout)
+  end
+
+  def open
+    self.created = Time.now if self.created.nil?
+  end
+
+  def close
+    self.client.close
+    self.created = nil
+  end
+
+  # This method is called to get the keep alive timeout value to use for this connection.
+  def keep_alive_timeout
+    Float(ENV['REDIS_KEEP_ALIVE_TIMEOUT'] ||  30)
+  end
+end

data/lib/cache_store_redis/version.rb

@@ -1,3 +1,3 @@
 module CacheStoreRedis
-  VERSION = '0.6.0'
+  VERSION = '0.7.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cache_store_redis
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - vaughanbrittonsage
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-28 00:00:00.000000000 Z
+date: 2018-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -90,8 +90,10 @@ files:
 - bin/console
 - bin/setup
 - lib/cache_store_redis.rb
+- lib/cache_store_redis/connection_pool.rb
 - lib/cache_store_redis/optional_redis_cache_store.rb
 - lib/cache_store_redis/redis_cache_store.rb
+- lib/cache_store_redis/redis_connection.rb
 - lib/cache_store_redis/version.rb
 homepage: https://github.com/vaughanbrittonsage/cache_store
 licenses:
@@ -113,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: This is the redis cache_store implementation.