thrift_client 0.3 → 0.3.1

data/CHANGELOG

@@ -1,4 +1,6 @@
 
+v0.3.1. Add ability to reset connection after N requests.
+
 v0.3. Change default timeout semantics; hash default was too sneaky. Fix bug.
 
 v0.2.2. Fix connect bug.

data/lib/thrift_client.rb

@@ -30,12 +30,13 @@ class ThriftClient
     :raise => true,
     :retries => nil,
     :server_retry_period => 1,
+    :server_max_requests => nil,
     :timeout => 1,
     :timeout_overrides => {},
     :defaults => {}
   }.freeze
 
-  attr_reader :client, :client_class, :server_list, :options
+  attr_reader :client, :client_class, :current_server, :server_list, :options
 
 =begin rdoc
 Create a new ThriftClient instance. Accepts an internal Thrift client class (such as CassandraRb::Client), a list of servers with ports, and optional parameters.
@@ -49,8 +50,9 @@ Valid optional parameters are:
 <tt>:raise</tt>:: Whether to reraise errors if no responsive servers are found. Defaults to <tt>true</tt>.
 <tt>:retries</tt>:: How many times to retry a request. Defaults to the number of servers defined.
 <tt>:server_retry_period</tt>:: How many seconds to wait before trying to reconnect after marking all servers as down. Defaults to <tt>1</tt>. Set to <tt>nil</tt> to retry endlessly.
-<tt>:timeout</tt>:: Specify the default timeout for every call. Defaults to <tt>.
-<tt>:timeout_overrides</tt>:: Specify timeouts on a per-method basis. Only work with <tt>Thrift::BufferedTransport</tt>.
+<tt>:server_max_requests</tt>:: How many requests to perform before moving on to the next server in the pool, regardless of error status. Defaults to <tt>nil</tt> (no limit).
+<tt>:timeout</tt>:: Specify the default timeout in seconds. Defaults to <tt>1</tt>.
+<tt>:timeout_overrides</tt>:: Specify additional timeouts on a per-method basis, in seconds. Only works with <tt>Thrift::BufferedTransport</tt>.
 <tt>:defaults</tt>:: Specify default values to return on a per-method basis, if <tt>:raise</tt> is set to false.
 
 =end rdoc
@@ -60,7 +62,6 @@ Valid optional parameters are:
     @client_class = client_class
     @server_list = Array(servers)
     @retries = options[:retries] || @server_list.size
-    @server_list = @server_list.sort_by { rand } if @options[:randomize_server_list]
 
     if @options[:timeout_overrides].any?
       if @options[:transport].instance_methods.include?("timeout=")
@@ -69,9 +70,11 @@ Valid optional parameters are:
         warn "ThriftClient: Timeout overrides have no effect with with transport type #{@options[:transport]}"
       end
     end
-    
-    @live_server_list = @server_list.dup
-    @last_retry = Time.now
+
+    @request_count = 0
+    @max_requests = @options[:server_max_requests]
+    @retry_period = @options[:server_retry_period]
+    rebuild_live_server_list!
 
     @client_class.instance_methods.each do |method_name|
       if method_name =~ /^recv_(.*)$/
@@ -82,37 +85,51 @@ Valid optional parameters are:
 
   # Force the client to connect to the server.
   def connect!
-    server = next_server.to_s.split(":")
-    raise ArgumentError, 'Servers must be in the form "host:port"' if server.size != 2
+    server = next_server
+    host, port = server.to_s.split(":")
+    raise ArgumentError, 'Servers must be in the form "host:port"' unless host and port
 
     @transport = @options[:transport].new(
-      Thrift::Socket.new(server.first, server.last.to_i, @options[:timeout]))
+      Thrift::Socket.new(host, port.to_i, @options[:timeout]))
     @transport.open
+    @current_server = server
     @client = @client_class.new(@options[:protocol].new(@transport, *@options[:protocol_extra_params]))
   rescue Thrift::TransportException
     retry
   end
 
   # Force the client to disconnect from the server.
-  def disconnect!
+  def disconnect!(keep = true)
     @transport.close rescue nil
+
+    # Keep live servers in the list if we have a retry period. Otherwise,
+    # always eject, because we will always re-add them.
+    if keep and @retry_period and @current_server
+      @live_server_list.unshift(@current_server)
+    end
+
+    @request_count = 0
     @client = nil
+    @current_server = nil
   end
 
   private
 
   def proxy(method_name, *args)
+    disconnect! if @max_requests and @request_count >= @max_requests
     connect! unless @client
+
     set_timeout!(method_name) if @set_timeout
+    @request_count += 1
     @client.send(method_name, *args)
   rescue NoServersAvailable => e
     handle_exception(e, method_name, args)
   rescue *@options[:exception_classes] => e
-    tries ||= @retries    
+    tries ||= @retries
     if (tries -= 1) == 0
       handle_exception(e, method_name, args)
     else
-      disconnect!
+      disconnect!(false)
       retry
     end
   end
@@ -127,13 +144,21 @@ Valid optional parameters are:
   end
 
   def next_server
-    if @live_server_list.empty?
-      if @options[:server_retry_period] and Time.now < @last_retry + @options[:server_retry_period]
-        raise NoServersAvailable, "No live servers in #{@server_list.inspect} since #{@last_retry.inspect}."
-      end
-      @last_retry = Time.now
-      @live_server_list = @server_list.dup
+    if @retry_period
+      rebuild_live_server_list! if Time.now > @last_rebuild + @retry_period
+      raise NoServersAvailable, "No live servers in #{@server_list.inspect} since #{@last_rebuild.inspect}." if @live_server_list.empty?
+    elsif @live_server_list.empty?
+      rebuild_live_server_list!
     end
     @live_server_list.pop
   end
+
+  def rebuild_live_server_list!
+    @last_rebuild = Time.now
+    if @options[:randomize_server_list]
+      @live_server_list = @server_list.sort_by { rand }
+    else
+      @live_server_list = @server_list.dup
+    end
+  end
 end

data/test/thrift_client_test.rb

@@ -26,23 +26,17 @@ class ThriftClientTest < Test::Unit::TestCase
       ThriftClient.new(ScribeThrift::Client, @servers.first, @options.merge(:raise => false)).Log(@entry)
     end
   end
-  
+
   def test_dont_raise_with_defaults
     client = ThriftClient.new(ScribeThrift::Client, @servers.first, @options.merge(:raise => false, :defaults => {:Log => 1}))
     assert_equal 1, client.Log(@entry)
   end
-  
+
   def test_defaults_dont_override_no_method_error
     client = ThriftClient.new(ScribeThrift::Client, @servers, @options.merge(:raise => false, :defaults => {:Missing => 2}))
-    assert_raises(NoMethodError) { client.Missing(@entry) }  
+    assert_raises(NoMethodError) { client.Missing(@entry) }
   end
 
-  def test_random_server_list
-    @lists = []
-    @lists << ThriftClient.new(ScribeThrift::Client, @servers, @options).server_list while @lists.size < 10
-    assert @lists.uniq.size > 1
-  end
-  
   def test_random_fall_through
     assert_nothing_raised do
       10.times { ThriftClient.new(ScribeThrift::Client, @servers, @options).Log(@entry) }
@@ -62,35 +56,35 @@ class ThriftClientTest < Test::Unit::TestCase
       client.disconnect!
     end
   end
-  
+
   def test_framed_transport_timeout
     stub_server(@socket) do |socket|
       measurement = Benchmark.measure do
         assert_raises(Thrift::TransportException) do
-          ThriftClient.new(ScribeThrift::Client, "127.0.0.1:#{@socket}", 
+          ThriftClient.new(ScribeThrift::Client, "127.0.0.1:#{@socket}",
             @options.merge(:timeout => @timeout)
-          ).Log(@entry) 
+          ).Log(@entry)
         end
       end
       assert((measurement.real > @timeout - 0.01), "#{measurement.real} < #{@timeout}")
       assert((measurement.real < @timeout + 0.01), "#{measurement.real} > #{@timeout}")
     end
   end
-  
+
   def test_buffered_transport_timeout
     stub_server(@socket) do |socket|
       measurement = Benchmark.measure do
         assert_raises(Thrift::TransportException) do
           ThriftClient.new(ScribeThrift::Client, "127.0.0.1:#{@socket}",
             @options.merge(:timeout => @timeout, :transport => Thrift::BufferedTransport)
-          ).Log(@entry) 
+          ).Log(@entry)
         end
       end
       assert((measurement.real > @timeout - 0.01), "#{measurement.real} < #{@timeout}")
       assert((measurement.real < @timeout + 0.01), "#{measurement.real} > #{@timeout}")
     end
-  end  
-  
+  end
+
   def test_buffered_transport_timeout_override
     # FIXME Large timeout values always are applied twice for some bizarre reason
     log_timeout = @timeout * 4
@@ -99,7 +93,7 @@ class ThriftClientTest < Test::Unit::TestCase
         assert_raises(Thrift::TransportException) do
           ThriftClient.new(ScribeThrift::Client, "127.0.0.1:#{@socket}",
             @options.merge(:timeout => @timeout, :timeout_overrides => {:Log => log_timeout}, :transport => Thrift::BufferedTransport)
-          ).Log(@entry) 
+          ).Log(@entry)
         end
       end
       assert((measurement.real > log_timeout - 0.01), "#{measurement.real} < #{log_timeout }")
@@ -114,13 +108,23 @@ class ThriftClientTest < Test::Unit::TestCase
     assert_raises(ThriftClient::NoServersAvailable) { client.Log(@entry) }
   end
   
+  def test_server_max_requests
+    client = ThriftClient.new(ScribeThrift::Client, @servers, @options.merge(:server_max_requests => 2))
+    client.Log(@entry)
+    internal_client = client.client
+    client.Log(@entry)
+    assert_equal internal_client, client.client
+    client.Log(@entry)  
+    assert_not_equal internal_client, client.client
+  end
+
   private
-  
+
   def stub_server(port)
     socket = TCPServer.new('127.0.0.1', port)
     Thread.new { socket.accept }
     yield socket
   ensure
     socket.close
-  end  
+  end
 end

data/thrift_client.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{thrift_client}
-  s.version = "0.3"
+  s.version = "0.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0.8") if s.respond_to? :required_rubygems_version=
   s.authors = ["Evan Weaver"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: thrift_client
 version: !ruby/object:Gem::Version 
-  version: "0.3"
+  version: 0.3.1
 platform: ruby
 authors: 
 - Evan Weaver