thrift_client 0.2.2 → 0.3

data/CHANGELOG

@@ -1,4 +1,6 @@
 
+v0.3. Change default timeout semantics; hash default was too sneaky. Fix bug.
+
 v0.2.2. Fix connect bug.
 
 v0.2.1. Don't turn off strict_read by default; allow override.

data/lib/thrift_client.rb

@@ -30,7 +30,8 @@ class ThriftClient
     :raise => true,
     :retries => nil,
     :server_retry_period => 1,
-    :timeouts => Hash.new(1),
+    :timeout => 1,
+    :timeout_overrides => {},
     :defaults => {}
   }.freeze
 
@@ -48,8 +49,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>:timeouts</tt>:: Specify timeouts on a per-method basis. Defaults to 1 second for everything. (Per-method values only work with <tt>Thrift::BufferedTransport</tt>.)
-<tt>:defaults</tt>:: Specify defaults to return on a per-method basis, if <tt>:raise</tt> is set to false.
+<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>: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,14 @@ Valid optional parameters are:
     @retries = options[:retries] || @server_list.size
     @server_list = @server_list.sort_by { rand } if @options[:randomize_server_list]
 
-    @set_timeout = @options[:transport].instance_methods.include?("timeout=")
+    if @options[:timeout_overrides].any?
+      if @options[:transport].instance_methods.include?("timeout=")
+        @set_timeout = true
+      else
+        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
 
@@ -77,7 +86,7 @@ Valid optional parameters are:
     raise ArgumentError, 'Servers must be in the form "host:port"' if server.size != 2
 
     @transport = @options[:transport].new(
-      Thrift::Socket.new(server.first, server.last.to_i, @options[:timeouts].default))
+      Thrift::Socket.new(server.first, server.last.to_i, @options[:timeout]))
     @transport.open
     @client = @client_class.new(@options[:protocol].new(@transport, *@options[:protocol_extra_params]))
   rescue Thrift::TransportException
@@ -109,7 +118,7 @@ Valid optional parameters are:
   end
 
   def set_timeout!(method_name)
-    @client.timeout = @options[:timeouts][:method_name.to_sym]
+    @client.timeout = @options[:timeout_overrides][method_name.to_sym] || @options[:timeout]
   end
 
   def handle_exception(e, method_name, args)

data/test/thrift_client_test.rb

@@ -64,29 +64,47 @@ class ThriftClientTest < Test::Unit::TestCase
   end
   
   def test_framed_transport_timeout
-    socket = stub_server(@socket)
-    measurement = Benchmark.measure do
-      assert_raises(Thrift::TransportException) do
-        ThriftClient.new(ScribeThrift::Client, "127.0.0.1:#{@socket}", 
-          @options.merge(:timeouts => Hash.new(@timeout))
-        ).Log(@entry) 
+    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)
+          ).Log(@entry) 
+        end
       end
+      assert((measurement.real > @timeout - 0.01), "#{measurement.real} < #{@timeout}")
+      assert((measurement.real < @timeout + 0.01), "#{measurement.real} > #{@timeout}")
     end
-    assert((measurement.real < @timeout + 0.01), "#{measurement.real} > #{@timeout}")
-    socket.close
   end
-
+  
   def test_buffered_transport_timeout
-    socket = stub_server(@socket)
-    measurement = Benchmark.measure do
-      assert_raises(Thrift::TransportException) do
-        ThriftClient.new(ScribeThrift::Client, "127.0.0.1:#{@socket}",
-          @options.merge(:timeouts => Hash.new(@timeout), :transport => Thrift::BufferedTransport)
-        ).Log(@entry) 
+    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) 
+        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_override
+    # FIXME Large timeout values always are applied twice for some bizarre reason
+    log_timeout = @timeout * 4
+    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, :timeout_overrides => {:Log => log_timeout}, :transport => Thrift::BufferedTransport)
+          ).Log(@entry) 
+        end
+      end
+      assert((measurement.real > log_timeout - 0.01), "#{measurement.real} < #{log_timeout }")
+      assert((measurement.real < log_timeout + 0.01), "#{measurement.real} > #{log_timeout}")
     end
-    assert((measurement.real < @timeout + 0.01), "#{measurement.real} > #{@timeout}")
-    socket.close
   end
 
   def test_retry_period
@@ -101,6 +119,8 @@ class ThriftClientTest < Test::Unit::TestCase
   def stub_server(port)
     socket = TCPServer.new('127.0.0.1', port)
     Thread.new { socket.accept }
-    socket
+    yield socket
+  ensure
+    socket.close
   end  
 end

data/thrift_client.gemspec

@@ -2,12 +2,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{thrift_client}
-  s.version = "0.2.2"
+  s.version = "0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0.8") if s.respond_to? :required_rubygems_version=
   s.authors = ["Evan Weaver"]
   s.cert_chain = ["/Users/eweaver/p/configuration/gem_certificates/evan_weaver-original-public_cert.pem"]
-  s.date = %q{2009-11-18}
+  s.date = %q{2009-11-30}
   s.description = %q{A Thrift client wrapper that encapsulates some common failover behavior.}
   s.email = %q{}
   s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README", "lib/thrift_client.rb", "lib/thrift_client/thrift.rb"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: thrift_client
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
+  version: "0.3"
 platform: ruby
 authors: 
 - Evan Weaver
@@ -30,7 +30,7 @@ cert_chain:
   yZ0=
   -----END CERTIFICATE-----
 
-date: 2009-11-18 00:00:00 -08:00
+date: 2009-11-30 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 

metadata.gz.sig

@@ -1,4 +1,2 @@
-�4�E�
�X����h.B�Z����J�q-�'����O6�O�X�̞�Mk)/6�–��eg���+�v�
-?&/��)��
- �ԪG�������=�h��FO��sD���8���ۮ�I� �S/w�
-w�/;Z��H��Tt��PS�J�����F!R\�rhJ�V��~���f�z�2S��.�a�T��1��^�˩~�T�ؿ
+b�6�#}����hO_R}���fs�/������Q�_{�e��k��������{4�����������f�H?��G/:��0ճ��͓L�.L�M�y�1�g�
�W� ����m���e��C�Ti�!E�����뿃_�߯�V�"k���P�%R�����V��:^赽�>$1��������2�T�b��u0��
+ϑz��,O�����[ژ��<�"��\��Tn�W�7�[Q�K�l/<