redis_dynamic 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 046e2753ce2319d2b8c1ab4972d677eeaa92b7c2d2e8696a7224edf222d49b1c
+  data.tar.gz: fcccc0a2969bb430df31ddcad70e4e715cd8bdd59fbc2fd1158c4838fa6ebea8
+SHA512:
+  metadata.gz: 0a4f85d887156bbd10ce067e5561cd213093f591b19ba1ecda9ddeb6853a8be6a124d0e597b9a10e631541866b353ab3fea4749c388b1f678224b0a1639fea92
+  data.tar.gz: 8e25c5daf8c85d0594ca7cf1b26d179f9e0cdb4c92bc9789f6d431cff97a583c9f1d52ee369f7695e35f21d49256c6e13f9cc7a0f9c13e234c14437cd42cf448

data/lib/redis_pool.rb

@@ -0,0 +1,88 @@
+require 'redis'
+require_relative './redis_pool/connection_queue'
+require_relative './redis_pool/reaper'
+
+class RedisPool
+  DEFAULT_REDIS_CONFIG = { host: 'localhost', port: 6379 }.freeze
+
+  attr_reader :max_size, :connection_timeout, :idle_timeout,
+              :reaping_frequency, :available
+
+  def initialize(max_size: 5, connection_timeout: 5, idle_timeout: 100, reaping_frequency: 300, redis_config: {})
+    @redis_config = DEFAULT_REDIS_CONFIG.merge(redis_config)
+
+    @max_size = max_size
+    @connection_timeout = connection_timeout
+    @idle_timeout = idle_timeout
+    @reaping_frequency = reaping_frequency
+
+    @available = ConnectionQueue.new(@max_size, &redis_creation_block)
+    @reaper = Reaper.new(self, @reaping_frequency, @idle_timeout)
+
+    @key = :"pool-#{@available.object_id}"
+    @key_count = :"pool-#{@available.object_id}-count"
+
+    @reaper.reap
+  end
+
+  def with(timeout = nil)
+    Thread.handle_interrupt(Exception => :never) do
+      conn = checkout(timeout)
+      begin
+        Thread.handle_interrupt(Exception => :immediate) do
+          yield conn.first
+        end
+      ensure
+        checkin
+      end
+    end
+  end
+  alias with_conn with
+  alias with_connection with
+
+  def checkout(timeout = nil)
+    if current_thread[@key]
+      current_thread[@key_count] += 1
+      current_thread[@key]
+    else
+      current_thread[@key_count] = 1
+      current_thread[@key] = @available.poll(timeout || @connection_timeout)
+    end
+  end
+
+  def checkin
+    raise 'no connections are checked out' unless current_thread[@key]
+
+    if current_thread[@key_count] == 1
+      @available.add current_thread[@key]
+      current_thread[@key] = nil
+      current_thread[@key_count] = nil
+    else
+      current_thread[@key_count] -= 1
+    end
+  end
+
+  def stats
+    conn_stats = @available.queue.map do |conn|
+      conn.last
+    end
+    pool_stats = {
+      available_to_create: @available.available_to_create,
+      total_available: @available.total_available,
+      connections_stats: conn_stats
+    }
+  end
+
+  private
+
+  def current_thread
+    Thread.current
+  end
+
+  def redis_creation_block
+    -> { Redis.new(@redis_config) }
+  end
+end
+
+require 'redis_pool/connection_queue'
+require 'redis_pool/reaper'

data/lib/redis_pool/connection_queue.rb

@@ -0,0 +1,115 @@
+require 'monitor'
+require 'concurrent'
+
+##
+# A thread-safe implementation of a connection queue.
+# Supports adding, removing, and polling a connection
+# synchronously, and doesn't create more than `max_size`
+# elements.
+# All connections are created lazily (only when needed).
+#
+class ConnectionQueue
+  attr_reader :max_size, :queue
+
+  def initialize(max_size = 0, &block)
+    @create_block = block
+    @created = 0
+    @queue = []
+    @max_size = max_size
+    @lock = Monitor.new
+    @lock_cond = @lock.new_cond
+  end
+
+  ##
+  # Adds (or returns) a connection to the available queue, synchronously.
+  #
+  def add(element)
+    synchronize do
+      @queue.push element
+      @lock_cond.signal
+    end
+  end
+  alias << add
+  alias push add
+
+  ##
+  # Fetches any available connection from the queue. If a connection
+  # is not available, waits for +timeout+ until a connection is
+  # available or raises a TimeoutError.
+  #
+  def poll(timeout = 5)
+    t0 = Concurrent.monotonic_time
+    elapsed = 0
+    synchronize do
+      loop do
+        return get_connection if connection_available?
+
+        connection = create_connection
+        return connection if connection
+
+        elapsed = Concurrent.monotonic_time - t0
+        raise TimeoutError, 'could not obtain connection' if elapsed >= timeout
+
+        @lock_cond.wait(timeout - elapsed)
+      end
+    end
+  end
+  alias pop poll
+
+  ##
+  # Removes an idle connection from the queue
+  # synchronously.
+  #
+  def delete(element)
+    synchronize do
+      @queue.delete element
+    end
+  end
+
+  ##
+  # Returns the total available connections to be used. This
+  # takes into account the number of connections that can be
+  # created as well. So it is all connections that can be used
+  # AND created.
+  #
+  def total_available
+    @max_size - @created + @queue.length
+  end
+
+  ##
+  # Returns the number of available connections to create.
+  #
+  def available_to_create
+    @max_size - @created
+  end
+
+  private
+
+  def synchronize(&block)
+    @lock.synchronize(&block)
+  end
+
+  def connection_available?
+    !@queue.empty?
+  end
+
+  def get_connection
+    conn = @queue.pop
+    conn.last[:last_used_at] = Time.now.utc
+    conn
+  end
+
+  def create_connection
+    return unless @created < @max_size
+
+    conn = @create_block.call
+    # TODO: add more stats.
+    stats = {
+      id: @created,
+      alive_since: Time.now.utc,
+      last_used_at: Time.now.utc
+    }
+    @created += 1
+    [conn, stats]
+  end
+end

data/lib/redis_pool/reaper.rb

@@ -0,0 +1,33 @@
+##
+# A reaper class that initializes a thread running in the
+# background, that kills all connections in `pool` that
+# has been idle for more than `idle_timeout`.
+#
+class Reaper
+  attr_reader :frequency, :idle_timeout
+
+  def initialize(pool, frequency, idle_timeout)
+    @frequency = frequency
+    @idle_timeout = idle_timeout
+    @pool = pool
+    @lock = Mutex.new
+  end
+
+  def reap
+    Thread.new do
+      loop do
+        @pool.available.queue.each do |conn|
+          idle_since = conn.last[:last_used_at] - Time.now.utc
+
+          next unless idle_since >= @idle_timeout
+
+          @lock.synchronize do
+            @pool.available.delete conn
+            conn.first.disconnect!
+          end
+        end
+        sleep @frequency
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: redis_dynamic
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mohammed Amarnah
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-01-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple dynamic-sized redis connection pool.
+email: m.amarnah@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/redis_pool.rb
+- lib/redis_pool/connection_queue.rb
+- lib/redis_pool/reaper.rb
+homepage: https://github.com/mohammedamarnah/redis-pool
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Redis Dynamic Pool
+test_files: []