jodosha-redis-store 0.3.0 → 0.3.5

data/README.textile

@@ -1,8 +1,8 @@
-h1. Redis cache and session stores for Ruby web frameworks
+h1. Rack::Session, Rack::Cache and cache Redis stores for Ruby web frameworks
 
 h2. Installation
 
-Download and install Redis from http://code.google.com/p/redis/
+Download and install Redis from "http://code.google.com/p/redis/":http://code.google.com/p/redis/
 
   wget "http://redis.googlecode.com/files/redis-0.094.tar.gz":http://redis.googlecode.com/files/redis-0.094.tar.gz
   tar -zxvf redis-0.094.tar.gz
@@ -26,7 +26,7 @@ h3. How to use with Rails
 
 h3. How to use with Merb
 
-  dependency "jodosha-redis-store", "0.3.0"
+  dependency "jodosha-redis-store", "0.3.5"
   dependency("merb-cache", merb_gems_version) do
     Merb::Cache.setup do
       register(:redis, Merb::Cache::RedisStore, :servers => ["127.0.0.1:6379"])
@@ -65,7 +65,7 @@ h3. How to use with Rails
 
 h3. How to use with Merb
 
-  dependency "jodosha-redis-store", "0.3.0"
+  dependency "jodosha-redis-store", "0.3.5"
   Merb::Config.use do |c|
     c[:session_store] = 'redis'
   end

data/Rakefile

@@ -5,7 +5,7 @@ require 'rake/testtask'
 require 'rake/rdoctask'
 require 'spec/rake/spectask'
 
-REDIS_STORE_VERSION = "0.3.0"
+REDIS_STORE_VERSION = "0.3.5"
 
 task :default => :spec
 

data/lib/redis-store.rb

@@ -1,6 +1,7 @@
 require "redis"
 require "dist_redis"
 require "redis/redis"
+require "redis/server"
 require "redis/redis_factory"
 require "redis/marshaled_redis"
 require "redis/distributed_marshaled_redis"

data/lib/redis/server.rb

@@ -0,0 +1,225 @@
+require 'monitor'
+##
+# This class represents a redis server instance.
+
+class Server
+
+  ##
+  # The host the redis server is running on.
+
+  attr_reader :host
+
+  ##
+  # The port the redis server is listening on.
+
+  attr_reader :port
+  
+  ##
+  #
+  
+  attr_reader :replica
+
+  ##
+  # The time of next retry if the connection is dead.
+
+  attr_reader :retry
+
+  ##
+  # A text status string describing the state of the server.
+
+  attr_reader :status
+
+  ##
+  # Create a new Redis::Server object for the redis instance
+  # listening on the given host and port.
+
+  def initialize(host, port = DEFAULT_PORT, timeout = 10, size = 5)
+    raise ArgumentError, "No host specified" if host.nil? or host.empty?
+    raise ArgumentError, "No port specified" if port.nil? or port.to_i.zero?
+
+    @host   = host
+    @port   = port.to_i
+
+    @retry  = nil
+    @status = 'NOT CONNECTED'
+    @timeout = timeout
+    @size = size
+    
+    @reserved_sockets = {}
+
+    @mutex = Monitor.new
+    @queue = @mutex.new_cond
+
+    @sockets = []
+    @checked_out = []
+  end
+
+  ##
+  # Return a string representation of the server object.
+  def inspect
+    "<Redis::Server: %s:%d (%s)>" % [@host, @port, @status]
+  end
+
+  ##
+  # Try to connect to the redis server targeted by this object.
+  # Returns the connected socket object on success or nil on failure.
+
+  def socket
+    if socket = @reserved_sockets[current_connection_id]
+      socket
+    else
+      @reserved_sockets[current_connection_id] = checkout
+    end
+  end
+
+  def connect_to(host, port, timeout=nil)
+    addrs = Socket.getaddrinfo(host, nil)
+    addr = addrs.detect { |ad| ad[0] == 'AF_INET' }
+    sock = Socket.new(Socket::AF_INET, Socket::SOCK_STREAM, 0)
+    if timeout
+      secs = Integer(timeout)
+      usecs = Integer((timeout - secs) * 1_000_000)
+      optval = [secs, usecs].pack("l_2")
+      sock.setsockopt Socket::SOL_SOCKET, Socket::SO_RCVTIMEO, optval
+      sock.setsockopt Socket::SOL_SOCKET, Socket::SO_SNDTIMEO, optval
+    end
+    sock.connect(Socket.pack_sockaddr_in(port, addr[3]))
+    sock
+  end
+
+  ##
+  # Close the connection to the redis server targeted by this
+  # object.  The server is not considered dead.
+
+  def close
+    @reserved_sockets.each do |name,sock|
+      checkin sock
+    end
+    @reserved_sockets = {}
+    @sockets.each do |sock|
+      sock.close
+    end
+    @sockets = []
+    @status = "NOT CONNECTED"
+  end
+
+  ##
+  # Mark the server as dead and close its socket.
+  def mark_dead(sock, error)
+    sock.close if sock && !sock.closed?
+    sock   = nil
+
+    reason = "#{error.class.name}: #{error.message}"
+    @status = sprintf "%s:%s DEAD (%s)", @host, @port, reason
+    puts @status
+  end
+
+  protected
+    def new_socket
+      sock = nil
+      begin
+        sock = connect_to(@host, @port, @timeout)
+        sock.setsockopt Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1
+        @status = 'CONNECTED'
+      rescue Errno::EPIPE, Errno::ECONNREFUSED => e
+        if sock
+          puts "Socket died... socket: #{sock.inspect}\n" if $debug
+          sock.close
+        end
+      rescue SocketError, SystemCallError, IOError => err
+        puts "Unable to open socket: #{err.class.name}, #{err.message}" if $debug
+        mark_dead sock, err
+      end
+
+      return sock
+    end
+
+    def checkout
+      @mutex.synchronize do
+        loop do
+          socket = if @checked_out.size < @sockets.size
+                   checkout_existing_socket
+                 elsif @sockets.size < @size
+                   checkout_new_socket
+                 end
+          return socket if socket
+          # No sockets available; wait for one
+          if @queue.wait(@timeout)
+            next
+          else
+            # try looting dead threads
+            clear_stale_cached_sockets!
+            if @size == @checked_out.size
+              raise RedisError, "could not obtain a socket connection#{" within #{@timeout} seconds" if @timeout}.  The max pool size is currently #{@size}; consider increasing it."
+            end
+          end
+        end
+      end
+    end
+
+    def checkin(socket)
+      @mutex.synchronize do
+        @checked_out.delete socket
+        @queue.signal
+      end
+    end
+
+    def checkout_new_socket
+      s = new_socket
+      @sockets << s
+      checkout_and_verify(s)
+    end
+
+    def checkout_existing_socket
+      s = (@sockets - @checked_out).first
+      checkout_and_verify(s)
+    end
+
+    def clear_stale_cached_sockets!
+      remove_stale_cached_threads!(@reserved_sockets) do |name, socket|
+        checkin socket
+      end
+    end
+
+    def remove_stale_cached_threads!(cache, &block)
+      keys = Set.new(cache.keys)
+
+      Thread.list.each do |thread|
+        keys.delete(thread.object_id) if thread.alive?
+      end
+      keys.each do |key|
+        next unless cache.has_key?(key)
+        block.call(key, cache[key])
+        cache.delete(key)
+      end
+    end
+
+  private
+    def current_connection_id #:nodoc:
+      Thread.current.object_id
+    end
+
+    def checkout_and_verify(s)
+      s = verify!(s)
+      @checked_out << s
+      s
+    end
+
+    def verify!(s)
+      reconnect!(s) unless active?(s)
+    end
+
+    def reconnect!(s)
+      s.close
+      connect_to(@host, @port, @timeout)
+    end
+
+    def active?(s)
+      begin
+        s.write("\0")
+        Timeout.timeout(0.1){ s.read }
+      rescue Exception
+        false
+      end
+    end
+end

data/redis-store.gemspec

@@ -1,14 +1,14 @@
 Gem::Specification.new do |s|
   s.name               = "redis-store"
-  s.version            = "0.3.0"
-  s.date               = "2009-05-03"
+  s.version            = "0.3.5"
+  s.date               = "2009-05-07"
   s.summary            = "Rack::Session, Rack::Cache and cache Redis stores for Ruby web frameworks."
   s.author             = "Luca Guidi"
   s.email              = "guidi.luca@gmail.com"
   s.homepage           = "http://lucaguidi.com"
   s.description        = "Rack::Session, Rack::Cache and cache Redis stores for Ruby web frameworks."
   s.has_rdoc           = true
-  s.files              = ["MIT-LICENSE", "README.textile", "Rakefile", "lib/cache/merb/redis_store.rb", "lib/cache/rails/redis_store.rb", "lib/cache/sinatra/redis_store.rb", "lib/rack/cache/redis_entitystore.rb", "lib/rack/cache/redis_metastore.rb", "lib/rack/session/merb.rb", "lib/rack/session/redis.rb", "lib/redis-store.rb", "lib/redis/distributed_marshaled_redis.rb", "lib/redis/marshaled_redis.rb", "lib/redis/redis.rb", "lib/redis/redis_factory.rb", "redis-store.gemspec", "spec/cache/merb/redis_store_spec.rb", "spec/cache/rails/redis_store_spec.rb", "spec/cache/sinatra/redis_store_spec.rb", "spec/config/master.conf", "spec/config/single.conf", "spec/config/slave.conf", "spec/rack/cache/entitystore/pony.jpg", "spec/rack/cache/entitystore/redis_spec.rb", "spec/rack/cache/metastore/redis_spec.rb", "spec/rack/session/redis_spec.rb", "spec/redis/distributed_marshaled_redis_spec.rb", "spec/redis/marshaled_redis_spec.rb", "spec/redis/redis_factory_spec.rb", "spec/spec_helper.rb"]
-  s.test_files         = ["spec/cache/merb/redis_store_spec.rb", "spec/cache/rails/redis_store_spec.rb", "spec/cache/sinatra/redis_store_spec.rb", "spec/rack/cache/entitystore/redis_spec.rb", "spec/rack/cache/metastore/redis_spec.rb", "spec/rack/session/redis_spec.rb", "spec/redis/distributed_marshaled_redis_spec.rb", "spec/redis/marshaled_redis_spec.rb", "spec/redis/redis_factory_spec.rb"]
+  s.files              = ["MIT-LICENSE", "README.textile", "Rakefile", "lib/cache/merb/redis_store.rb", "lib/cache/rails/redis_store.rb", "lib/cache/sinatra/redis_store.rb", "lib/rack/cache/redis_entitystore.rb", "lib/rack/cache/redis_metastore.rb", "lib/rack/session/merb.rb", "lib/rack/session/redis.rb", "lib/redis-store.rb", "lib/redis/distributed_marshaled_redis.rb", "lib/redis/marshaled_redis.rb", "lib/redis/redis.rb", "lib/redis/redis_factory.rb", "lib/redis/server.rb", "redis-store.gemspec", "spec/cache/merb/redis_store_spec.rb", "spec/cache/rails/redis_store_spec.rb", "spec/cache/sinatra/redis_store_spec.rb", "spec/config/master.conf", "spec/config/single.conf", "spec/config/slave.conf", "spec/rack/cache/entitystore/pony.jpg", "spec/rack/cache/entitystore/redis_spec.rb", "spec/rack/cache/metastore/redis_spec.rb", "spec/rack/session/redis_spec.rb", "spec/redis/distributed_marshaled_redis_spec.rb", "spec/redis/marshaled_redis_spec.rb", "spec/redis/redis_factory_spec.rb", "spec/redis/server_spec.rb", "spec/spec_helper.rb"]
+  s.test_files         = ["spec/cache/merb/redis_store_spec.rb", "spec/cache/rails/redis_store_spec.rb", "spec/cache/sinatra/redis_store_spec.rb", "spec/rack/cache/entitystore/redis_spec.rb", "spec/rack/cache/metastore/redis_spec.rb", "spec/rack/session/redis_spec.rb", "spec/redis/distributed_marshaled_redis_spec.rb", "spec/redis/marshaled_redis_spec.rb", "spec/redis/redis_factory_spec.rb", "spec/redis/server_spec.rb"]
   s.extra_rdoc_files   = ["README.textile"]
 end

data/spec/config/single.conf

@@ -17,7 +17,7 @@ port 6379
 # bind 127.0.0.1
 
 # Close the connection after a client is idle for N seconds
-timeout 300
+timeout 5
 
 # Save the DB on disk:
 #

data/spec/redis/server_spec.rb

@@ -0,0 +1,25 @@
+require File.join(File.dirname(__FILE__), "/../spec_helper")
+
+describe "Redis::Server" do
+  before(:each) do
+    @server = Server.new 'localhost', '6379'
+  end
+
+  it "should have a connection pool" do
+    @server.instance_variable_get(:@sockets).should_not be_nil
+  end
+
+  it "should checkout active connections" do
+    threads = []
+    100.times do
+      threads << Thread.new do
+        lambda {
+          sleep 6 # redis will close idle connections in the meanwhile
+          socket = @server.socket
+          socket.write("INFO\r\n")
+          socket.read(1)
+        }.should_not raise_error(Exception)
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jodosha-redis-store
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.3.5
 platform: ruby
 authors: 
 - Luca Guidi
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-03 00:00:00 -07:00
+date: 2009-05-07 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -37,6 +37,7 @@ files:
 - lib/redis/marshaled_redis.rb
 - lib/redis/redis.rb
 - lib/redis/redis_factory.rb
+- lib/redis/server.rb
 - redis-store.gemspec
 - spec/cache/merb/redis_store_spec.rb
 - spec/cache/rails/redis_store_spec.rb
@@ -51,6 +52,7 @@ files:
 - spec/redis/distributed_marshaled_redis_spec.rb
 - spec/redis/marshaled_redis_spec.rb
 - spec/redis/redis_factory_spec.rb
+- spec/redis/server_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://lucaguidi.com
@@ -88,3 +90,4 @@ test_files:
 - spec/redis/distributed_marshaled_redis_spec.rb
 - spec/redis/marshaled_redis_spec.rb
 - spec/redis/redis_factory_spec.rb
+- spec/redis/server_spec.rb