ione-rpc 1.0.0.pre1 → 1.0.0.pre2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 51144d6e83a35056bbefda51115605b74141c2a1
-  data.tar.gz: 0d983eee0b3c1810a6c8a3a1a311bf4d7e4b8941
+  metadata.gz: 5c7643bab20779d92db259349ee30689f27f00ca
+  data.tar.gz: ac4e876e133758cc94c5e52682685865225d7cdc
 SHA512:
-  metadata.gz: 652a513b927f5c485e960e2211e4a687ba64034285fa631dbcfee72a91ab19f4bcbbaa09b95875b8deeba3efe2b3b3f77bf8674de1536225f9d0d042b7e06f61
-  data.tar.gz: 500e33e208a693abf1ce8495d4c8e6250672eb16832bd17ca8e9195def804a41338d2484d431bd13c8bbf0263164bd1c3dca4f3a1f95a3df6a8dc1a41419cc90
+  metadata.gz: 54903ddee404d09c58056af6e1766d8d4c2323037cbfdfac42c66c82ad11f152425fc542eab87adf05ea4ef67afb32e351e011ff906b4329edc2f1ba0af4b49e
+  data.tar.gz: cfc8c07ab978079837a309b736505031ca422441c6c1083d81a23e55a82a0729528fb3c9874819ce5a9755bc4a6711d0946bdfcc64a1298db78fac5e167ae86a

data/lib/ione/rpc/client_peer.rb

@@ -13,6 +13,7 @@ module Ione
         @lock = Mutex.new
         @channels = [nil] * max_channels
         @queue = []
+        @encode_eagerly = @codec.recoding?
       end
 
       def send_message(request, timeout=nil)
@@ -21,10 +22,14 @@ module Ione
           take_channel(promise)
         end
         if channel
-          write_message(request, channel)
+          @connection.write(@codec.encode(request, channel))
         else
           @lock.synchronize do
-            @queue << [request, promise]
+            if @encode_eagerly
+              @queue << [@codec.encode(request, -1), promise]
+            else
+              @queue << [request, promise]
+            end
           end
         end
         if timeout
@@ -59,7 +64,11 @@ module Ione
           while count < max
             request, promise = @queue[count]
             if (channel = take_channel(promise))
-              write_message(request, channel)
+              if @encode_eagerly
+                @connection.write(@codec.recode(request, channel))
+              else
+                @connection.write(@codec.encode(request))
+              end
               count += 1
             else
               break

data/lib/ione/rpc/codec.rb

@@ -79,6 +79,27 @@ module Ione
         end
       end
 
+      # Whether or not this codec supports channel recoding, see {#recode}.
+      def recoding?
+        true
+      end
+
+      # Recode the channel of a frame.
+      #
+      # This is used primarily by the client when it needs to queue a request
+      # because all channels are occupied. When the codec supports recoding the
+      # client can encode the request when it is queued, instead of when it is
+      # dequeued. This means that in most cases the calling thread will do the
+      # encoding instead of the IO reactor thread.
+      #
+      # @param [String] bytes an encoded frame (the output from {#encode})
+      # @param [Integer] channel the channel to encode into the frame
+      # @return [String] the reencoded frame
+      def recode(bytes, channel)
+        bytes[2, 2] = [channel].pack(CHANNEL_FORMAT)
+        bytes
+      end
+
       # @!method encode_message(message)
       #
       # Encode an object to bytes that can be sent over the network.
@@ -131,6 +152,7 @@ module Ione
 
       FRAME_V1_FORMAT = 'ccNa*'.freeze
       FRAME_V2_FORMAT = 'ccnNa*'.freeze
+      CHANNEL_FORMAT = 'n'.freeze
     end
 
     # A codec that works with encoders like JSON, MessagePack, YAML and others

data/lib/ione/rpc/peer.rb

@@ -45,10 +45,6 @@ module Ione
       def handle_closed(cause=nil)
         @closed_promise.fulfill(cause)
       end
-
-      def write_message(message, channel)
-        @connection.write(@codec.encode(message, channel))
-      end
     end
   end
 end

data/lib/ione/rpc/server.rb

@@ -92,7 +92,7 @@ module Ione
         def handle_message(message, channel)
           f = @server.handle_request(message, self)
           f.on_value do |response|
-            write_message(response, channel)
+            @connection.write(@codec.encode(response, channel))
           end
         end
       end

data/lib/ione/rpc/version.rb

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

data/spec/ione/rpc/client_peer_spec.rb

@@ -16,7 +16,7 @@ module Ione
       end
 
       let :codec do
-        double(:codec)
+        double(:codec, recoding?: true)
       end
 
       let :scheduler do
@@ -29,7 +29,7 @@ module Ione
 
       before do
         codec.stub(:decode) do |buffer, current_frame|
-          message = buffer.to_s.scan(/[\w\d]+@\d+/).flatten.first
+          message = buffer.to_s.scan(/[\w\d]+@-?\d+/).flatten.first
           if message
             payload, channel = message.split('@')
             buffer.discard(message.bytesize)
@@ -41,6 +41,10 @@ module Ione
         codec.stub(:encode) do |message, channel|
           '%s@%03d' % [message, channel]
         end
+        codec.stub(:recode) do |message, channel|
+          payload, _ = message.split('@')
+          codec.encode(payload, channel)
+        end
       end
 
       before do
@@ -89,6 +93,11 @@ module Ione
           connection.written_bytes.bytesize.should == max_channels * 7
         end
 
+        it 'encodes messages when they are enqueued' do
+          (max_channels + 2).times { peer.send_message('foo') }
+          codec.should have_received(:encode).exactly(max_channels + 2).times
+        end
+
         it 'sends queued requests when channels become available' do
           (max_channels + 2).times { |i| peer.send_message("foo#{i.to_s.rjust(3, '0')}") }
           length_before = connection.written_bytes.bytesize
@@ -117,6 +126,17 @@ module Ione
           scheduler.timer_promises.first.fulfill
           expect { f.value }.to_not raise_error
         end
+
+        context 'with a non-recoding codec' do
+          let :codec do
+            double(:codec, recoding?: false)
+          end
+
+          it 'encodes messages when they are dequeued' do
+            (max_channels + 2).times { peer.send_message('foo') }
+            codec.should have_received(:encode).exactly(max_channels).times
+          end
+        end
       end
     end
   end

data/spec/ione/rpc/client_spec.rb

@@ -58,6 +58,7 @@ module Ione
       end
 
       before do
+        codec.stub(:recoding?).and_return(false)
         codec.stub(:encode) { |input, channel| input }
       end
 

data/spec/ione/rpc/codec_spec.rb

@@ -90,6 +90,19 @@ module Ione
         end
       end
 
+      describe '#recode' do
+        let :object do
+          {'foo' => 'bar', 'baz' => 42}
+        end
+
+        it 'changes the channel in the encoded bytes' do
+          encoded = codec.encode(object, 42)
+          recoded = codec.recode(encoded, 99)
+          _, channel, _ = codec.decode(Ione::ByteBuffer.new(recoded), nil)
+          channel.should == 99
+        end
+      end
+
       context 'when decoding and encoding' do
         let :message do
           {'foo' => 'bar', 'baz' => 42}

data/spec/ione/rpc/peer_common.rb

@@ -29,6 +29,7 @@ shared_examples 'peers' do
 
     before do
       channel = 9
+      codec.stub(:recoding?).and_return(false)
       codec.stub(:decode) do |buffer, previous_frame|
         if buffer.empty?
           [empty_frame, channel, false]

data/spec/ione/rpc/server_spec.rb

@@ -160,14 +160,18 @@ module Ione
         end
 
         it 'responds to the same peer and channel when the future returned by #handle_request is resolved' do
+          sent_pair = nil
+          codec.stub(:encode) do |response, channel|
+            sent_pair = [response, channel]
+            response
+          end
           promise = Promise.new
           server.override_handle_request { promise.future }
           peer = server.connections.first
-          peer.stub(:write_message)
           peer.handle_message('FOOBAZ', 42)
-          peer.should_not have_received(:write_message)
+          sent_pair.should be_nil
           promise.fulfill('BAZFOO')
-          peer.should have_received(:write_message).with('BAZFOO', 42)
+          sent_pair.should == ['BAZFOO', 42]
         end
 
         it 'uses the codec to encode the response' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ione-rpc
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre1
+  version: 1.0.0.pre2
 platform: ruby
 authors:
 - Theo Hultberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-09 00:00:00.000000000 Z
+date: 2014-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ione