grpc_kit 0.1.8 → 0.1.9

data/lib/grpc_kit/session/io.rb

@@ -13,6 +13,8 @@ module GrpcKit
         @io.close
       end
 
+      # @param length [Integer]
+      # @return [DS9::ERR_WOULDBLOCK, DS9::ERR_EOF, String]
       def recv_event(length)
         data = @io.read_nonblock(length, nil, exception: false)
 
@@ -26,6 +28,8 @@ module GrpcKit
         end
       end
 
+      # @param data [String]
+      # @return [DS9::ERR_WOULDBLOCK, Integer]
       def send_event(data)
         return 0 if data.empty?
 
@@ -37,6 +41,8 @@ module GrpcKit
         end
       end
 
+      # Blocking until io object is readable
+      # @return [void]
       def wait_readable
         ::IO.select([@io], [], [])
         true
@@ -44,10 +50,13 @@ module GrpcKit
         false
       end
 
+      # Blocking until io object is readable or writable
+      # @return [void]
       def select(timeout = 1)
         ::IO.select([@io], [@io], [], timeout)
       end
 
+      # @return [void]
       def flush
         @io.flush
       end

data/lib/grpc_kit/session/recv_buffer.rb

@@ -8,10 +8,15 @@ module GrpcKit
         @end = false
       end
 
+      # @param data [String]
+      # @return [void]
       def write(data)
         @buffer << data
       end
 
+      # @param size [Integer,nil]
+      # @param last [Boolean]
+      # @return [String,nil]
       def read(size = nil, last: false)
         return nil if @buffer.empty?
 
@@ -29,10 +34,12 @@ module GrpcKit
         end
       end
 
+      # @return [Boolean]
       def end_read?
         @end
       end
 
+      # @return [void]
       def end_read
         @end = true
       end

data/lib/grpc_kit/session/send_buffer.rb

@@ -9,23 +9,31 @@ module GrpcKit
         @deferred_read = false
       end
 
+      # @param data [String]
+      # @param last [Boolean]
+      # @return [void]
       def write(data, last: false)
         end_write if last
         @buffer << data
       end
 
+      # @return [Boolean]
       def need_resume?
         @deferred_read
       end
 
+      # @return [void]
       def end_write
         @end_write = true
       end
 
+      # @return [Boolean]
       def end_write?
         @end_write
       end
 
+      # @param size [Integer,nil]
+      # @return [nil,DS9::ERR_DEFERRED,String]
       def read(size = nil)
         if @buffer.empty?
           if end_write?

data/lib/grpc_kit/session/server_session.rb

@@ -15,8 +15,8 @@ module GrpcKit
 
       delegate %i[send_event recv_event] => :@io
 
-      # @params io [GrpcKit::Session::IO]
-      # @params dispatcher [GrpcKit::Server]
+      # @param io [GrpcKit::Session::IO]
+      # @param dispatcher [GrpcKit::Server]
       def initialize(io, dispatcher)
         super() # initialize DS9::Session
 
@@ -29,6 +29,7 @@ module GrpcKit
         @drain = nil
       end
 
+      # @return [void]
       def start
         loop do
           invoke
@@ -81,10 +82,12 @@ module GrpcKit
         false
       end
 
+      # @return [void]
       def drain
         @drain ||= GrpcKit::Session::DrainController.new
       end
 
+      # @return [void]
       def shutdown
         stop
         @io.close
@@ -136,7 +139,7 @@ module GrpcKit
 
       # nghttp2_session_callbacks_set_on_frame_recv_callback
       def on_frame_recv(frame)
-        # GrpcKit.logger.debug("on_frame_recv #{frame}") # Too many call
+        GrpcKit.logger.debug("on_frame_recv #{frame}") # Too many call
 
         case frame
         when DS9::Frames::Data
@@ -172,7 +175,7 @@ module GrpcKit
 
       # nghttp2_session_callbacks_set_on_frame_send_callback
       def on_frame_send(frame)
-        # GrpcKit.logger.debug("on_frame_send #{frame}") # Too many call
+        GrpcKit.logger.debug("on_frame_send #{frame}") # Too many call
         case frame
         when DS9::Frames::Data, DS9::Frames::Headers
           if frame.end_stream?
@@ -204,7 +207,7 @@ module GrpcKit
 
       # nghttp2_session_callbacks_set_on_header_callback
       def on_header(name, value, frame, _flags)
-        # GrpcKit.logger.debug("#{name} => #{value}") # Too many call
+        GrpcKit.logger.debug("#{name} => #{value}") # Too many call
         stream = @streams[frame.stream_id]
         stream.add_header(name, value)
       end

data/lib/grpc_kit/session/stream.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 
 require 'forwardable'
 require 'grpc_kit/session/headers'
@@ -18,6 +18,9 @@ module GrpcKit
       attr_reader :headers, :pending_send_data, :pending_recv_data, :trailer_data, :status
       attr_accessor :inflight, :stream_id
 
+      # @param stream_id [Integer]
+      # @param send_data [GrpcKit::Session::SendBuffer]
+      # @param recv_data [GrpcKit::Session::RecvBuffer]
       def initialize(stream_id:, send_data: nil, recv_data: nil)
         @stream_id = stream_id
         @end_read_stream = false
@@ -31,22 +34,33 @@ module GrpcKit
         @draining = false
       end
 
+      # @return [void]
       def drain
         @draining = true
       end
 
-      def write_trailers_data(tariler)
-        @trailer_data = tariler
+      # @param tarilers [Hash<String,String>]
+      # @return [void]
+      def write_trailers_data(tarilers)
+        @trailer_data = tarilers
       end
 
+      # @param data [String]
+      # @param last [Boolean]
+      # @return [void]
       def write_send_data(data, last: false)
         @pending_send_data.write(data, last: last)
       end
 
+      # @param last [Boolean]
+      # @return [void]
       def read_recv_data(last: false)
         @pending_recv_data.read(last: last)
       end
 
+      # @param name [String]
+      # @param value [String]
+      # @return [void]
       def add_header(name, value)
         @headers.add(name, value)
       end

data/lib/grpc_kit/session/stream_status.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 
 module GrpcKit
   module Session
@@ -12,6 +12,7 @@ module GrpcKit
         @status = OPEN
       end
 
+      # @return [void]
       def close_local
         if @status == OPEN
           @status = HALF_CLOSE_LOCAL
@@ -24,6 +25,7 @@ module GrpcKit
         end
       end
 
+      # @return [void]
       def close_remote
         if @status == OPEN
           @status = HALF_CLOSE_REMOTE
@@ -36,18 +38,22 @@ module GrpcKit
         end
       end
 
+      # @return [void]
       def close
         @status = CLOSE
       end
 
+      # @return [Boolean]
       def close_local?
         (@status == HALF_CLOSE_LOCAL) || close?
       end
 
+      # @return [Boolean]
       def close_remote?
         (@status == HALF_CLOSE_REMOTE) || close?
       end
 
+      # @return [Boolean]
       def close?
         @status == CLOSE
       end

data/lib/grpc_kit/stream/client_stream.rb

@@ -5,20 +5,25 @@ require 'grpc_kit/status_codes'
 module GrpcKit
   module Stream
     class ClientStream
-      # @params transport [GrpcKit::Transport::ClientTransport]
-      # @params config [GrpcKit::MethodConfig]
-      # @params authority [String]
+      # @param transport [GrpcKit::Transport::ClientTransport]
+      # @param config [GrpcKit::MethodConfig]
+      # @param authority [String]
       def initialize(transport, config, authority:, timeout: nil)
         @transport = transport
         @config = config
 
         @authority = authority
         @timeout = timeout
+        @deadline = timeout&.to_absolute_time
 
         @started = false
       end
 
-      def send_msg(data, metadata: {}, timeout: nil, last: false)
+      # @param data [Object]
+      # @param metadata [Hash<String,String>]
+      # @param last [Boolean]
+      # @return [void]
+      def send_msg(data, metadata: {}, last: false)
         buf =
           begin
             @config.protobuf.encode(data)
@@ -31,6 +36,10 @@ module GrpcKit
           raise GrpcKit::Errors::ResourceExhausted, "Sending message is too large: send=#{req.bytesize}, max=#{limit_size}"
         end
 
+        if @deadline && Time.now > @deadline
+          raise GrpcKit::Errors::DeadlineExceeded, @deadline
+        end
+
         if @started
           @transport.write_data(buf, last: last)
         else
@@ -44,12 +53,34 @@ module GrpcKit
         loop { yield(do_recv) }
       end
 
-      def recv_msg(last: false)
+      # @raise [StopIteration] when recving message finished
+      # @param last [Boolean]
+      # @param blocking [Boolean]
+      # @return [Object]
+      def recv_msg(last: false, blocking: true)
+        validate_if_request_start!
+
+        ret = do_recv(last: last, blocking: blocking)
+
+        if @deadline && Time.now > @deadline
+          raise GrpcKit::Errors::DeadlineExceeded, @deadline
+        end
+
+        ret
+      end
+
+      def close_and_send
         validate_if_request_start!
 
-        do_recv(last: last)
+        if @deadline && Time.now > @deadline
+          raise GrpcKit::Errors::DeadlineExceeded, @deadline
+        end
+
+        # send?
+        @transport.close_and_flush
       end
 
+      # @return [Array<Object>]
       def close_and_recv
         validate_if_request_start!
 
@@ -57,6 +88,11 @@ module GrpcKit
 
         data = []
         loop { data.push(do_recv) }
+
+        if @deadline && Time.now > @deadline
+          raise GrpcKit::Errors::DeadlineExceeded, @deadline
+        end
+
         data
       end
 
@@ -68,8 +104,18 @@ module GrpcKit
         end
       end
 
-      def do_recv(last: false)
-        data = @transport.read_data(last: last)
+      def do_recv(last: false, blocking: true)
+        data =
+          if blocking
+            @transport.read_data(last: last)
+          else
+            v = @transport.read_data_nonblock(last: last)
+            if v == :wait_readable
+              return v
+            end
+
+            v
+          end
 
         if data.nil?
           check_status!
@@ -126,7 +172,7 @@ module GrpcKit
           ':scheme' => 'http',
           ':path' => @config.path,
           ':authority' => authority,
-          'grpc-timeout' => timeout,
+          'grpc-timeout' => timeout&.to_s,
           'te' => 'trailers',
           'content-type' => 'application/grpc',
           'user-agent' => "grpc-ruby/#{GrpcKit::VERSION} (grpc_kit)",

data/lib/grpc_kit/stream/server_stream.rb

@@ -5,12 +5,13 @@ require 'grpc_kit/errors'
 module GrpcKit
   module Stream
     class ServerStream
-      # @params transport [GrpcKit::transports::ServerTransport]
+      # @param transport [GrpcKit::transports::ServerTransport]
       def initialize(transport)
         @transport = transport
         @started = false
       end
 
+      # @return [void]
       def invoke(rpc)
         rpc.invoke(self, metadata: @transport.recv_headers.metadata)
       rescue GrpcKit::Errors::BadStatus => e
@@ -21,6 +22,13 @@ module GrpcKit
         send_status(status: GrpcKit::StatusCodes::UNKNOWN, msg: e.message, metadata: {})
       end
 
+      # @param data [Object]
+      # @param protobuf [GrpcKit::ProtoBuffer]
+      # @param last [Boolean]
+      # @param limit_size [Integer]
+      # @param initial_metadata [Hash<String,String>]
+      # @param trailing_metadata [Hash<String,String>]
+      # @return [void]
       def send_msg(data, protobuf, last: false, limit_size: nil, initial_metadata: {}, trailing_metadata: {})
         buf =
           begin
@@ -42,6 +50,11 @@ module GrpcKit
         end
       end
 
+      # @raise [StopIteration] when recving message finished
+      # @param protobuf [GrpcKit::ProtoBuffer]
+      # @param last [Boolean]
+      # @param limit_size [Integer]
+      # @return [Object]
       def recv_msg(protobuf, last: false, limit_size: nil)
         data = @transport.read_data(last: last)
 
@@ -68,10 +81,15 @@ module GrpcKit
         end
       end
 
+      # @param protobuf [GrpcKit::ProtoBuffer]
       def each(protobuf)
         loop { yield(recv_msg(protobuf)) }
       end
 
+      # @param status [GrpcKit::StatusCodes::BadStatus, GrpcKit::StatusCodes::OK]
+      # @param msg [String,nil]
+      # @param metadata [Hash<String,String>]
+      # @return [void]
       def send_status(data: nil, status: GrpcKit::StatusCodes::OK, msg: nil, metadata: {})
         t = build_trailers(status, msg, metadata)
         @transport.write_data(data, last: true) if data

data/lib/grpc_kit/transport/client_transport.rb

@@ -7,17 +7,22 @@ module GrpcKit
     class ClientTransport
       include GrpcKit::Transport::Packable
 
-      # @params session [GrpcKit::Session::ClientSession]
+      # @param session [GrpcKit::Session::ClientSession]
       def initialize(session)
         @session = session
         @stream = nil # set later
       end
 
-      def start_request(data, header, last: false)
-        @stream = @session.send_request(header)
+      # @param data [String]
+      # @param headers [Hash<String, String>]
+      # @param last [Boolean]
+      # @return [void]
+      def start_request(data, headers, last: false)
+        @stream = @session.send_request(headers)
         write_data(data, last: last)
       end
 
+      # @return [void]
       def close_and_flush
         @stream.end_write
         send_data
@@ -27,15 +32,33 @@ module GrpcKit
         @deferred = false
       end
 
+      # @param buf [String]
+      # @param last [Boolean]
+      # @return [void]
       def write_data(buf, last: false)
         write(@stream.pending_send_data, pack(buf), last: last)
         send_data
       end
 
+      # @param last [Boolean]
+      # @return [nil,String]
       def read_data(last: false)
         unpack(recv_data(last: last))
       end
 
+      # @param last [Boolean]
+      # @return [nil,String]
+      def read_data_nonblock(last: false)
+        data = nonblock_recv_data(last: last)
+        if data == :wait_readable
+          unpack(nil) # nil is needed read buffered data
+          :wait_readable
+        else
+          unpack(data)
+        end
+      end
+
+      # @return [Hash<String,String>]
       def recv_headers
         wait_close
         @stream.headers
@@ -54,6 +77,19 @@ module GrpcKit
         stream.write(buf, last: last)
       end
 
+      def nonblock_recv_data(last: false)
+        data = @stream.read_recv_data(last: last)
+        return data unless data.nil?
+
+        if @stream.close_remote?
+          return nil
+        end
+
+        @session.run_once
+
+        :wait_readable
+      end
+
       def recv_data(last: false)
         loop do
           data = @stream.read_recv_data(last: last)