ione-rpc 1.0.0.pre4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2219fec79fa845ec467d80462b2b25b521649afe
-  data.tar.gz: 0a505a71f3c16bba88a160925c9f4d6d511b51cf
+  metadata.gz: 518c9857895955f9c26c4be3d3be5d21773c7525
+  data.tar.gz: 6b6c39ffa664e4b290bb5c0ebaeab462dd8fbb23
 SHA512:
-  metadata.gz: 2e7f795882099bbc4753f0295085962ddb6c05af8cfd4ae67dc4cdcabb854e5a16816acaf147a7ba43860ea37249e61f06270de638cd47bb2c2cc64bc4930709
-  data.tar.gz: 89b9886afc1ff2b7fda147ed7fda063489a60052204b5a2ab9a5e334571aefc51520f432ece8aa6e1d2266814f9c944d2cf1403add28bf7623a32442227ed526
+  metadata.gz: d3e6c4d47dda87d60ac7034243d0c946af0117bd8fed3b043d23ecbbbc6cb6817253e3b5199bb5967d38b077d51ed40a4991d04de29e93cd7adbb0e12098427e
+  data.tar.gz: 9f60335dcdb60a2353fcf07684fdd9e9f17715c679253badb1f6415e4e276de67759bfe427392e48266db2216d7a7be3a816dbb2543e6eeb9152e53c702926bb

data/lib/ione/rpc/client.rb

@@ -179,31 +179,34 @@ module Ione
       #   error response – that is protocol specific and up to the implementation
       #   to handle), or when there was no connection open.
       def send_request(request, connection=nil, timeout=nil)
-        unless connection
+        if connection
+          chosen_connection = connection
+        else
           @lock.lock
           begin
-            connection = choose_connection(@connections, request)
+            chosen_connection = choose_connection(@connections, request)
           ensure
             @lock.unlock
           end
         end
-        if connection
-          f = connection.send_message(request, timeout)
+        if chosen_connection && !chosen_connection.closed?
+          f = chosen_connection.send_message(request, timeout)
           f = f.fallback do |error|
-            if error.is_a?(Io::ConnectionClosedError)
+            if error.is_a?(Rpc::ConnectionClosedError)
               @logger.warn('Request failed because the connection closed, retrying') if @logger
-              send_request(request)
+              send_request(request, connection, timeout)
             else
-              raise error
+              Ione::Future.failed(error)
             end
           end
           f.on_failure do |error|
             @logger.warn('Request failed: %s' % error.message) if @logger
           end
           f
+        elsif chosen_connection
+          Future.failed(Rpc::RequestNotSentError.new('Not connected'))
         else
-          @logger.warn('Could not send request: not connected') if @logger
-          Future.failed(Io::ConnectionError.new('Not connected'))
+          Future.failed(Rpc::NoConnectionError.new('No connection'))
         end
       rescue => e
         Future.failed(e)
@@ -252,6 +255,19 @@ module Ione
         connections.sample
       end
 
+      # Override this method to control if, and how many times, the client should
+      # attempt to reconnect on connection failures.
+      #
+      # You can, for example, stop reconnecting after a certain number of attempts.
+      #
+      # @param [String] host the host to connect to
+      # @param [Integer] port the port to connect to
+      # @param [Integer] attempts the number of attempts that have been made so
+      #   far – when 1 or above a connection attempt has just failed, when 0
+      #   an open connection was abruptly closed and the question is whether or
+      #   not to attempt to connect again.
+      # @return [Boolean] `true` if a connection attempt should be made, `false`
+      #   otherwise.
       def reconnect?(host, port, attempts)
         true
       end
@@ -288,7 +304,7 @@ module Ione
             else
               @logger.info('Not reconnecting to %s:%d' % [host, port]) if @logger
               remove_host(host, port)
-              raise e
+              Ione::Future.failed(e)
             end
           end
           f.flat_map do |connection|
@@ -326,7 +342,11 @@ module Ione
           @logger.info(message) if @logger
         end
         @lock.synchronize { @connections.delete(connection) }
-        connect(connection.host, connection.port) if error
+        if error && reconnect?(connection.host, connection.port, 0)
+          connect(connection.host, connection.port)
+        else
+          remove_host(connection.host, connection.port)
+        end
       end
 
       def normalize_address(host, port)

data/lib/ione/rpc/client_peer.rb

@@ -36,6 +36,9 @@ module Ione
       end
 
       def send_message(request, timeout=nil)
+        if closed?
+          return Ione::Future.failed(Rpc::RequestNotSentError.new('Connection closed'))
+        end
         promise = Ione::Promise.new
         channel = nil
         @lock.lock
@@ -117,9 +120,23 @@ module Ione
       end
 
       def handle_closed(cause=nil)
-        error = Io::ConnectionClosedError.new('Connection closed')
-        promises_to_fail = @lock.synchronize { @channels.reject(&:nil?) }
-        promises_to_fail.each { |p| p.fail(error) }
+        in_flight_promises = nil
+        queued_promises = nil
+        @lock.lock
+        begin
+          in_flight_promises = @channels.reject(&:nil?)
+          @channels = [nil] * @channels.size
+          queued_promises = @queue.map(&:last)
+          @queue = []
+        ensure
+          @lock.unlock
+        end
+        message = 'Connection closed'
+        message << ": #{cause.message}" if cause
+        error = Io::ConnectionClosedError.new(message)
+        in_flight_promises.each { |p| p.fail(error) }
+        error = RequestNotSentError.new(message)
+        queued_promises.each { |p| p.fail(error) }
         super
       end
     end

data/lib/ione/rpc/peer.rb

@@ -19,6 +19,10 @@ module Ione
         @current_message = nil
       end
 
+      def closed?
+        @connection.closed?
+      end
+
       def on_closed(&listener)
         @closed_promise.future.on_value(&listener)
       end

data/lib/ione/rpc/server.rb

@@ -107,8 +107,9 @@ module Ione
 
       def setup_server
         @io_reactor.bind(@bind_address, @port, @queue_length) do |acceptor|
+          @acceptor = acceptor
           @logger.info('Server listening for connections on %s:%d' % [@bind_address, @port]) if @logger
-          acceptor.on_accept do |connection|
+          @acceptor.on_accept do |connection|
             @logger.info('Connection from %s:%d accepted' % [connection.host, connection.port]) if @logger
             peer = ServerPeer.new(connection, @codec, self, @logger)
             peer.on_closed do

data/lib/ione/rpc/version.rb

@@ -2,6 +2,6 @@
 
 module Ione
   module Rpc
-    VERSION = '1.0.0.pre4'.freeze
+    VERSION = '1.0.0'.freeze
   end
 end

data/lib/ione/rpc.rb

@@ -6,6 +6,9 @@ require 'ione'
 module Ione
   module Rpc
     TimeoutError = Class.new(StandardError)
+    NoConnectionError = Class.new(StandardError)
+    ConnectionClosedError = Io::ConnectionClosedError
+    RequestNotSentError = Class.new(ConnectionClosedError)
   end
 end
 

data/spec/ione/rpc/client_peer_spec.rb

@@ -59,12 +59,31 @@ module Ione
       include_examples 'peers'
 
       context 'when the connection closes' do
-        it 'fails all outstanding requests when closing' do
+        it 'fails all in-flight requests' do
           f1 = peer.send_message('hello')
           f2 = peer.send_message('world')
           connection.closed_listener.call
-          expect { f1.value }.to raise_error(Io::ConnectionClosedError)
-          expect { f2.value }.to raise_error(Io::ConnectionClosedError)
+          expect { f1.value }.to raise_error(Io::ConnectionClosedError, /connection closed/i)
+          expect { f2.value }.to raise_error(Io::ConnectionClosedError, /connection closed/i)
+        end
+
+        it 'includes the error message from the cause when there is one' do
+          f = peer.send_message('hello')
+          connection.closed_listener.call(StandardError.new('foo'))
+          expect { f.value }.to raise_error(Io::ConnectionClosedError, /connection closed: foo/i)
+        end
+
+        it 'fails queued requests' do
+          fs = Array.new(max_channels + 2) { peer.send_message('foo') }
+          connection.closed_listener.call
+          expect { fs[0].value }.to raise_error(Io::ConnectionClosedError)
+          expect { fs[max_channels].value }.to raise_error(Io::ConnectionClosedError)
+        end
+
+        it 'fails queued messages with an error that shows that the request was never sent' do
+          fs = Array.new(max_channels + 2) { peer.send_message('foo') }
+          connection.closed_listener.call
+          expect { fs[max_channels].value }.to raise_error(Rpc::RequestNotSentError)
         end
       end
 
@@ -127,6 +146,12 @@ module Ione
           expect { f.value }.to_not raise_error
         end
 
+        it 'fails the request when the connection is closed' do
+          connection.stub(:closed?).and_return(true)
+          f = peer.send_message('foo', 2)
+          expect { f.value }.to raise_error(Rpc::RequestNotSentError)
+        end
+
         context 'with a non-recoding codec' do
           let :codec do
             double(:codec, recoding?: false)

data/spec/ione/rpc/client_spec.rb

@@ -53,7 +53,8 @@ module Ione
         connection.stub(:on_data)
         connection.stub(:on_closed)
         connection.stub(:write)
-        connection.stub(:close)
+        connection.stub(:close) { connection.stub(:closed?).and_return(true) }
+        connection.stub(:closed?).and_return(false)
         connection
       end
 
@@ -214,7 +215,7 @@ module Ione
 
           it 'returns a failed future when called when not connected' do
             client.stop.value
-            expect { client.send_request('PING').value }.to raise_error(Io::ConnectionError)
+            expect { client.send_request('PING').value }.to raise_error(Rpc::NoConnectionError)
           end
         end
 
@@ -274,13 +275,24 @@ module Ione
             expect { f.value }.to raise_error('Bork')
           end
 
+          it 'fails the request when #choose_connection returns a closed connection' do
+            client.override_choose_connection do |connections, request|
+              c = connections.first
+              c.close
+              c
+            end
+            client.start.value
+            f = client.send_request('PING')
+            expect { f.value }.to raise_error(Rpc::RequestNotSentError)
+          end
+
           it 'fails the request when #choose_connection returns nil' do
             client.override_choose_connection do |connections, request|
               nil
             end
             client.start.value
             f = client.send_request('PING')
-            expect { f.value }.to raise_error(Io::ConnectionError)
+            expect { f.value }.to raise_error(Rpc::NoConnectionError)
           end
         end
       end
@@ -510,6 +522,14 @@ module Ione
           connection_attempts_by_host['node1.example.com'].should == 10
           connection_attempts_by_host['node2.example.com'].should == 1
         end
+
+        it 'allows the connection to be manually reconnected' do
+          client.start.value
+          c1 = client.created_connections.find { |c| c.host == 'node1.example.com' }
+          c1.closed_listener.call
+          client.add_host(c1.host, c1.port).value
+          io_reactor.should have_received(:connect).with('node1.example.com', anything, anything).twice
+        end
       end
 
       context 'with multiple connections' do

data/spec/ione/rpc/peer_common.rb

@@ -120,6 +120,15 @@ shared_examples 'peers' do
       connection.should have_received(:close)
     end
   end
+
+  describe '#closed?' do
+    it 'reflects the underlying connection\'s state' do
+      connection.stub(:closed?).and_return(true)
+      peer.should be_closed
+      connection.stub(:closed?).and_return(false)
+      peer.should_not be_closed
+    end
+  end
 end
 
 module RpcSpec
@@ -130,10 +139,16 @@ module RpcSpec
       @host = 'example.com'
       @port = 9999
       @written_bytes = ''
+      @closed = false
+    end
+
+    def closed?
+      @closed
     end
 
     def close(cause=nil)
       @closed_listener.call(cause) if @closed_listener
+      @closed = true
     end
 
     def write(bytes)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ione-rpc
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre4
+  version: 1.0.0
 platform: ruby
 authors:
 - Theo Hultberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-26 00:00:00.000000000 Z
+date: 2014-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ione
@@ -61,9 +61,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>'
+  - - '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.1