thrift_client 0.8.1 → 0.8.2

data/CHANGELOG

@@ -1,3 +1,6 @@
+v0.8.2 Connect errors now mark servers down for _server_retry_period_.
+Added support for cached connections to amortize connection costs.
+
 v0.8.1 Fixed permissions?
 
 v0.8.0 Update to thrift 0.8.0

data/Manifest

@@ -11,6 +11,7 @@ lib/thrift_client/connection/factory.rb
 lib/thrift_client/connection/http.rb
 lib/thrift_client/connection/socket.rb
 lib/thrift_client/event_machine.rb
+lib/thrift_client/server.rb
 lib/thrift_client/simple.rb
 lib/thrift_client/thrift.rb
 test/greeter/greeter.rb

data/lib/thrift_client/abstract_thrift_client.rb

@@ -1,17 +1,5 @@
 class AbstractThriftClient
-
-  class Server
-    attr_reader :connection_string, :marked_down_at
-
-    def initialize(connection_string)
-      @connection_string = connection_string
-    end
-    alias to_s connection_string
-
-    def mark_down!
-      @marked_down_at = Time.now
-    end
-  end
+  include ThriftHelpers
 
   DISCONNECT_ERRORS = [
     IOError,
@@ -41,7 +29,8 @@ class AbstractThriftClient
     :wrapped_exception_classes => DEFAULT_WRAPPED_ERRORS,
     :connect_timeout => 0.1,
     :timeout => 1,
-    :timeout_overrides => {}
+    :timeout_overrides => {},
+    :cached_connections => false
   }
 
   attr_reader :client, :client_class, :current_server, :server_list, :options, :client_methods
@@ -50,7 +39,9 @@ class AbstractThriftClient
     @options = DEFAULTS.merge(options)
     @options[:server_retry_period] ||= 0
     @client_class = client_class
-    @server_list = Array(servers).collect{|s| Server.new(s)}.sort_by { rand }
+    @server_list = Array(servers).collect do |s|
+      Server.new(s, @options[:cached_connections])
+    end.sort_by { rand }
     @current_server = @server_list.first
 
     @callbacks = {}
@@ -101,16 +92,23 @@ class AbstractThriftClient
   # call.
   def connect!
     @current_server = next_live_server
-    @connection = Connection::Factory.create(@options[:transport], @options[:transport_wrapper], @current_server.connection_string, @options[:connect_timeout])
-    @connection.connect!
-    transport = @connection.transport
-    transport.timeout = @options[:timeout] if transport_can_timeout?
-    @client = @client_class.new(@options[:protocol].new(transport, *@options[:protocol_extra_params]))
+    @current_server.open(@options[:transport],
+                         @options[:transport_wrapper],
+                         @options[:connect_timeout],
+                         @options[:timeout])
+    @client = @client_class.new(@options[:protocol].new(@current_server, *@options[:protocol_extra_params]))
     do_callbacks(:post_connect, self)
+  rescue IOError, Thrift::TransportException
+    disconnect!(true)
+    retry
   end
 
-  def disconnect!
-    @connection.close rescue nil #TODO
+  def disconnect!(error = false)
+    if @current_server
+      @current_server.mark_down!(@options[:server_retry_period]) if error
+      @current_server.close
+    end
+
     @client = nil
     @current_server = nil
     @request_count = 0
@@ -130,16 +128,16 @@ class AbstractThriftClient
     @server_index ||= 0
     @server_list.length.times do |i|
       cur = (1 + @server_index + i) % @server_list.length
-      if !@server_list[cur].marked_down_at || (@server_list[cur].marked_down_at + @options[:server_retry_period] <= Time.now)
+      if @server_list[cur].up?
         @server_index = cur
         return @server_list[cur]
       end
     end
-    raise ThriftClient::NoServersAvailable, "No live servers in #{@server_list.inspect} since #{@last_rebuild.inspect}."
+    raise ThriftClient::NoServersAvailable, "No live servers in #{@server_list.inspect}."
   end
 
   def handled_proxy(method_name, *args)
-    disconnect_on_max! if @options[:server_max_requests] && @request_count >= @options[:server_max_requests]
+    disconnect! if @options[:server_max_requests] && @request_count >= @options[:server_max_requests]
     begin
       connect! unless @client
       if has_timeouts?
@@ -151,7 +149,7 @@ class AbstractThriftClient
     rescue *@options[:exception_class_overrides] => e
       raise_or_default(e, method_name)
     rescue *@options[:exception_classes] => e
-      disconnect_on_error!
+      disconnect!(true)
       tries ||= (@options[:retry_overrides][method_name.to_sym] || @options[:retries]) + 1
       tries -= 1
       if tries > 0
@@ -181,15 +179,6 @@ class AbstractThriftClient
     end
   end
 
-  def disconnect_on_max!
-    disconnect!
-  end
-
-  def disconnect_on_error!
-    @current_server.mark_down! if @current_server
-    disconnect!
-  end
-
   def has_timeouts?
     @has_timeouts ||= @options[:timeout_overrides].any? && transport_can_timeout?
   end

data/lib/thrift_client/connection/base.rb

@@ -1,19 +1,25 @@
-module Connection
-  class Base
-    attr_accessor :transport, :server
+module ThriftHelpers
+  module Connection
+    class Base
+      attr_accessor :transport, :server
 
-    def initialize(transport, transport_wrapper, server, timeout)
-      @transport = transport
-      @transport_wrapper = transport_wrapper
-      @server = server
-      @timeout = timeout
-    end
+      def initialize(transport, transport_wrapper, server, timeout)
+        @transport = transport
+        @transport_wrapper = transport_wrapper
+        @server = server
+        @timeout = timeout
+      end
 
-    def connect!
-      raise NotImplementedError
-    end
+      def connect!
+        raise NotImplementedError
+      end
+
+      def open?
+        @transport.open?
+      end
 
-    def close
+      def close
+      end
     end
   end
 end

data/lib/thrift_client/connection/factory.rb

@@ -1,10 +1,12 @@
-module Connection
-  class Factory
-    def self.create(transport, transport_wrapper, server, timeout)
-      if transport == Thrift::HTTPClientTransport
-        Connection::HTTP.new(transport, transport_wrapper, server, timeout)
-      else
-        Connection::Socket.new(transport, transport_wrapper, server, timeout)
+module ThriftHelpers
+  module Connection
+    class Factory
+      def self.create(transport, transport_wrapper, server, timeout)
+        if transport == Thrift::HTTPClientTransport
+          Connection::HTTP.new(transport, transport_wrapper, server, timeout)
+        else
+          Connection::Socket.new(transport, transport_wrapper, server, timeout)
+        end
       end
     end
   end

data/lib/thrift_client/connection/http.rb

@@ -1,18 +1,20 @@
-module Connection
-  class HTTP < Base
-    def connect!
-      uri = parse_server(@server)
-      @transport = Thrift::HTTPClientTransport.new(@server)
-      http = Net::HTTP.new(uri.host, uri.port)
-      http.use_ssl = uri.scheme == "https"
-      http.get(uri.path)
-    end
+module ThriftHelpers
+  module Connection
+    class HTTP < Base
+      def connect!
+        uri = parse_server(@server)
+        @transport = Thrift::HTTPClientTransport.new(@server)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = uri.scheme == "https"
+        http.get(uri.path)
+      end
 
-  private
-    def parse_server(server)
-      uri = URI.parse(server)
-      raise ArgumentError, 'Servers must start with http' unless uri.scheme =~ /^http/
-      uri
+      private
+      def parse_server(server)
+        uri = URI.parse(server)
+        raise ArgumentError, 'Servers must start with http' unless uri.scheme =~ /^http/
+        uri
+      end
     end
   end
-end
+end

data/lib/thrift_client/connection/socket.rb

@@ -1,22 +1,24 @@
-module Connection
-  class Socket < Base
-    def close
-      @transport.close
-    end
+module ThriftHelpers
+  module Connection
+    class Socket < Base
+      def close
+        @transport.close
+      end
 
-    def connect!
-      host, port = parse_server(@server)
-      @transport = @transport.new(*[host, port.to_i, @timeout])
-      @transport = @transport_wrapper.new(@transport) if @transport_wrapper
-      @transport.open
-    end
+      def connect!
+        host, port = parse_server(@server)
+        @transport = @transport.new(*[host, port.to_i, @timeout])
+        @transport = @transport_wrapper.new(@transport) if @transport_wrapper
+        @transport.open
+      end
 
-  private
+      private
 
-    def parse_server(server)
-      host, port = server.to_s.split(":")
-      raise ArgumentError, 'Servers must be in the form "host:port"' unless host and port
-      [host, port]
+      def parse_server(server)
+        host, port = server.to_s.split(":")
+        raise ArgumentError, 'Servers must be in the form "host:port"' unless host and port
+        [host, port]
+      end
     end
   end
 end

data/lib/thrift_client/server.rb

@@ -0,0 +1,100 @@
+require 'thrift_client/connection'
+
+module ThriftHelpers
+  class Server
+    class ServerMarkedDown < StandardError; end
+
+    def initialize(connection_string, cached = true)
+      @connection_string = connection_string
+      @connection = nil
+      @cached = cached
+      @marked_down_til = nil
+    end
+
+    def mark_down!(til)
+      close(true)
+      @marked_down_til = Time.now + til
+    end
+
+    def up?
+      !down?
+    end
+
+    def down?
+      @marked_down_til && @marked_down_til > Time.now
+    end
+
+    def to_s
+      @connection_string
+    end
+
+    def open(trans, wrap, conn_timeout, trans_timeout)
+      if down?
+        raise ServerMarkedDown, "marked down until #{@marked_down_til}"
+      end
+
+      if @connection.nil? || (@cached && !@connection.open?)
+        @connection = Connection::Factory.create(trans, wrap, @connection_string, conn_timeout)
+        @connection.connect!
+      end
+
+      if wrap || trans.respond_to?(:timeout=)
+        timeout = trans_timeout
+      end
+
+      self
+    end
+
+    def open?
+      @connection && @connection.open?
+    end
+
+    def close(teardown = false)
+      if teardown || !@cached
+        @connection.close rescue nil #TODO
+        @connection = nil
+      end
+    end
+
+    def transport
+      return nil unless @connection
+      @connection.transport
+    end
+
+    module TransportInterface
+      def read(sz)
+        transport.read(sz)
+      end
+
+      def read_byte
+        transport.read_byte
+      end
+
+      def read_into_buffer(buffer, size)
+        transport.read_into_buffer(buffer, size)
+      end
+
+      def read_all(sz)
+        transport.read_all(sz)
+      end
+
+      def write(buf)
+        transport.write(buf)
+      end
+      alias_method :<<, :write
+
+      def flush
+        transport.flush
+      end
+
+      def timeout=(timeout)
+        transport.timeout = timeout
+      end
+
+      def timeout
+        transport.timeout
+      end
+    end
+    include TransportInterface
+  end
+end

data/lib/thrift_client.rb

@@ -1,6 +1,6 @@
 require 'thrift'
 require 'thrift_client/thrift'
-require 'thrift_client/connection'
+require 'thrift_client/server'
 require 'thrift_client/abstract_thrift_client'
 
 class ThriftClient < AbstractThriftClient

data/test/thrift_client_test.rb

@@ -48,8 +48,8 @@ class ThriftClientTest < Test::Unit::TestCase
 
       # disconnect_on_error! is called every time a server related
       # connection error happens. it will be called every try (so, retries + 1)
-      singleton_class.send :define_method, :disconnect_on_error! do |*args|
-        times_called += 1; super *args
+      singleton_class.send :define_method, :disconnect! do |*args|
+        times_called += 1 if args[0]; super *args
       end
 
       assert_raises(Greeter::Client::TransportException) { client.greeting("someone") }

data/thrift_client.gemspec

@@ -2,22 +2,22 @@
 
 Gem::Specification.new do |s|
   s.name = "thrift_client"
-  s.version = "0.8.1"
+  s.version = "0.8.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0.8") if s.respond_to? :required_rubygems_version=
   s.authors = ["Evan Weaver, Ryan King, Jeff Hodges"]
-  s.date = "2012-01-19"
+  s.date = "2012-09-11"
   s.description = "A Thrift client wrapper that encapsulates some common failover behavior."
   s.email = ""
-  s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README.rdoc", "lib/thrift_client.rb", "lib/thrift_client/abstract_thrift_client.rb", "lib/thrift_client/connection.rb", "lib/thrift_client/connection/base.rb", "lib/thrift_client/connection/factory.rb", "lib/thrift_client/connection/http.rb", "lib/thrift_client/connection/socket.rb", "lib/thrift_client/event_machine.rb", "lib/thrift_client/simple.rb", "lib/thrift_client/thrift.rb"]
-  s.files = ["CHANGELOG", "LICENSE", "Manifest", "README.rdoc", "Rakefile", "lib/thrift_client.rb", "lib/thrift_client/abstract_thrift_client.rb", "lib/thrift_client/connection.rb", "lib/thrift_client/connection/base.rb", "lib/thrift_client/connection/factory.rb", "lib/thrift_client/connection/http.rb", "lib/thrift_client/connection/socket.rb", "lib/thrift_client/event_machine.rb", "lib/thrift_client/simple.rb", "lib/thrift_client/thrift.rb", "test/greeter/greeter.rb", "test/greeter/greeter.thrift", "test/greeter/server.rb", "test/multiple_working_servers_test.rb", "test/simple_test.rb", "test/test_helper.rb", "test/thrift_client_http_test.rb", "test/thrift_client_test.rb", "thrift_client.gemspec"]
+  s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README.rdoc", "lib/thrift_client.rb", "lib/thrift_client/abstract_thrift_client.rb", "lib/thrift_client/connection.rb", "lib/thrift_client/connection/base.rb", "lib/thrift_client/connection/factory.rb", "lib/thrift_client/connection/http.rb", "lib/thrift_client/connection/socket.rb", "lib/thrift_client/event_machine.rb", "lib/thrift_client/server.rb", "lib/thrift_client/simple.rb", "lib/thrift_client/thrift.rb"]
+  s.files = ["CHANGELOG", "LICENSE", "Manifest", "README.rdoc", "Rakefile", "lib/thrift_client.rb", "lib/thrift_client/abstract_thrift_client.rb", "lib/thrift_client/connection.rb", "lib/thrift_client/connection/base.rb", "lib/thrift_client/connection/factory.rb", "lib/thrift_client/connection/http.rb", "lib/thrift_client/connection/socket.rb", "lib/thrift_client/event_machine.rb", "lib/thrift_client/server.rb", "lib/thrift_client/simple.rb", "lib/thrift_client/thrift.rb", "test/greeter/greeter.rb", "test/greeter/greeter.thrift", "test/greeter/server.rb", "test/multiple_working_servers_test.rb", "test/simple_test.rb", "test/test_helper.rb", "test/thrift_client_http_test.rb", "test/thrift_client_test.rb", "thrift_client.gemspec"]
   s.homepage = "http://fauna.github.com/fauna/thrift_client/"
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Thrift_client", "--main", "README.rdoc"]
   s.require_paths = ["lib"]
   s.rubyforge_project = "fauna"
-  s.rubygems_version = "1.8.15"
+  s.rubygems_version = "1.8.23"
   s.summary = "A Thrift client wrapper that encapsulates some common failover behavior."
-  s.test_files = ["test/multiple_working_servers_test.rb", "test/simple_test.rb", "test/test_helper.rb", "test/thrift_client_http_test.rb", "test/thrift_client_test.rb"]
+  s.test_files = ["test/thrift_client_http_test.rb", "test/thrift_client_test.rb", "test/test_helper.rb", "test/multiple_working_servers_test.rb", "test/simple_test.rb"]
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

metadata

@@ -1,45 +1,37 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: thrift_client
-version: !ruby/object:Gem::Version 
-  hash: 61
+version: !ruby/object:Gem::Version
+  version: 0.8.2
   prerelease: 
-  segments: 
-  - 0
-  - 8
-  - 1
-  version: 0.8.1
 platform: ruby
-authors: 
+authors:
 - Evan Weaver, Ryan King, Jeff Hodges
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-01-19 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-09-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: thrift
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 63
-        segments: 
-        - 0
-        - 8
-        - 0
+      - !ruby/object:Gem::Version
         version: 0.8.0
   type: :runtime
-  version_requirements: *id001
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
 description: A Thrift client wrapper that encapsulates some common failover behavior.
-email: ""
+email: ''
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - CHANGELOG
 - LICENSE
 - README.rdoc
@@ -51,9 +43,10 @@ extra_rdoc_files:
 - lib/thrift_client/connection/http.rb
 - lib/thrift_client/connection/socket.rb
 - lib/thrift_client/event_machine.rb
+- lib/thrift_client/server.rb
 - lib/thrift_client/simple.rb
 - lib/thrift_client/thrift.rb
-files: 
+files:
 - CHANGELOG
 - LICENSE
 - Manifest
@@ -67,6 +60,7 @@ files:
 - lib/thrift_client/connection/http.rb
 - lib/thrift_client/connection/socket.rb
 - lib/thrift_client/event_machine.rb
+- lib/thrift_client/server.rb
 - lib/thrift_client/simple.rb
 - lib/thrift_client/thrift.rb
 - test/greeter/greeter.rb
@@ -80,46 +74,37 @@ files:
 - thrift_client.gemspec
 homepage: http://fauna.github.com/fauna/thrift_client/
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --line-numbers
 - --inline-source
 - --title
 - Thrift_client
 - --main
 - README.rdoc
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 27
-      segments: 
-      - 0
-      - 8
-      version: "0.8"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0.8'
 requirements: []
-
 rubyforge_project: fauna
-rubygems_version: 1.8.15
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A Thrift client wrapper that encapsulates some common failover behavior.
-test_files: 
-- test/multiple_working_servers_test.rb
-- test/simple_test.rb
-- test/test_helper.rb
+test_files:
 - test/thrift_client_http_test.rb
 - test/thrift_client_test.rb
+- test/test_helper.rb
+- test/multiple_working_servers_test.rb
+- test/simple_test.rb