grpc_kit 0.1.2 → 0.1.3

data/lib/grpc_kit/session/io.rb

@@ -27,23 +27,14 @@ module GrpcKit
       end
 
       def send_event(data)
-        remain = data.bytesize
-        size = remain
-        while remain > 0
-          begin
-            remain -= @io.syswrite(data)
-          rescue Errno::EAGAIN, Errno::EWOULDBLOCK
-            unless IO.select(nil, [io], nil, 1)
-              raise 'timeout writing data'
-            end
-          rescue IOError => e
-            raise IOError, e # TODO
-          end
-
-          data = data.byteslice(remain..-1)
-        end
+        return 0 if data.empty?
 
-        size
+        bytes = @io.write_nonblock(data, exception: false)
+        if bytes == :wait_writable
+          DS9::ERR_WOULDBLOCK
+        else
+          bytes
+        end
       end
 
       def wait_readable

data/lib/grpc_kit/session/server.rb

@@ -36,7 +36,8 @@ module GrpcKit
 
           run_once
         end
-      rescue Errno::ECONNRESET, IOError
+      rescue Errno::ECONNRESET, IOError => e
+        GrpcKit.logger.debug(e.message)
         finish
       end
 
@@ -92,10 +93,9 @@ module GrpcKit
         stream = @streams[stream_id]
         data = @streams[stream_id].pending_send_data.read(length)
         if data.empty? && stream.end_write?
-          # TODO
-          submit_trailer(stream_id, 'grpc-status' => '0')
-
-          false # means EOF and END_STREAM
+          submit_trailer(stream_id, stream.trailer_data)
+          # trailer header
+          false
         else
           data
         end
@@ -107,11 +107,10 @@ module GrpcKit
 
         case frame
         when DS9::Frames::Data
-
           stream = @streams[frame.stream_id]
 
           if frame.end_stream?
-            stream.remote_end_stream = true
+            stream.close_remote
           end
 
           unless stream.inflight
@@ -122,7 +121,7 @@ module GrpcKit
           stream = @streams[frame.stream_id]
 
           if frame.end_stream?
-            stream.remote_end_stream = true
+            stream.close_remote
           end
 
           # when DS9::Frames::Goaway
@@ -139,7 +138,7 @@ module GrpcKit
         when DS9::Frames::Data, DS9::Frames::Headers
           stream = @streams[frame.stream_id]
           if frame.end_stream?
-            stream.local_end_stream = true
+            stream.close_local
           end
         end
 
@@ -166,6 +165,7 @@ module GrpcKit
 
       # nghttp2_session_callbacks_set_on_header_callback
       def on_header(name, value, frame, _flags)
+        GrpcKit.logger.debug("#{name} => #{value}")
         stream = @streams[frame.stream_id]
         stream.add_header(name, value)
       end
@@ -181,7 +181,7 @@ module GrpcKit
         stream = @streams.delete(stream_id)
         return unless stream
 
-        stream.end_stream
+        stream.close
       end
 
       # nghttp2_session_callbacks_set_on_data_chunk_recv_callback

data/lib/grpc_kit/session/stream.rb

@@ -3,28 +3,34 @@
 require 'forwardable'
 require 'grpc_kit/session/buffer'
 require 'grpc_kit/session/headers'
+require 'grpc_kit/session/stream_status'
 
 module GrpcKit
   module Session
     class Stream
       extend Forwardable
 
-      delegate end_write: :@pending_send_data
-      delegate end_read: :@pending_recv_data
+      delegate %i[end_write end_write?] => :@pending_send_data
+      delegate %i[end_read end_read?] => :@pending_recv_data
+      delegate %i[close close_remote close_local close? close_remote? close_local?] => :@status
 
-      attr_reader :headers, :pending_send_data, :pending_recv_data
-      attr_accessor :local_end_stream, :remote_end_stream, :inflight, :stream_id
+      attr_reader :headers, :pending_send_data, :pending_recv_data, :trailer_data, :status
+      attr_accessor :inflight, :stream_id
 
-      def initialize(stream_id:, send_data: GrpcKit::Session::Buffer.new)
+      def initialize(stream_id:, send_data: nil, recv_data: nil)
         @stream_id = stream_id
         @end_read_stream = false
         @headers = GrpcKit::Session::Headers.new
-        @pending_send_data = send_data
-        @pending_recv_data = GrpcKit::Session::Buffer.new
+        @pending_send_data = send_data || GrpcKit::Session::Buffer.new
+        @pending_recv_data = recv_data || GrpcKit::Session::Buffer.new
 
-        @local_end_stream = false
-        @remote_end_stream = false
         @inflight = false
+        @trailer_data = {}
+        @status = GrpcKit::Session::StreamStatus.new
+      end
+
+      def write_trailers_data(tariler)
+        @trailer_data = tariler
       end
 
       def write_send_data(data, last: false)
@@ -35,23 +41,6 @@ module GrpcKit
         @pending_recv_data.read(last: last)
       end
 
-      def end_write?
-        @local_end_stream || @pending_send_data.end_write?
-      end
-
-      def end_read?
-        @remote_end_stream || @pending_recv_data.end_read?
-      end
-
-      def end_stream?
-        end_read? && end_write?
-      end
-
-      def end_stream
-        end_read
-        end_write
-      end
-
       def add_header(name, value)
         @headers.add(name, value)
       end

data/lib/grpc_kit/session/stream_status.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: false
+
+module GrpcKit
+  module Session
+    class StreamStatus
+      OPEN              = 0
+      CLOSE             = 1
+      HALF_CLOSE_REMOTE = 2
+      HALF_CLOSE_LOCAL  = 3
+
+      def initialize
+        @status = OPEN
+      end
+
+      def close_local
+        if @status == OPEN
+          @status = HALF_CLOSE_LOCAL
+        elsif @status == HALF_CLOSE_REMOTE
+          @status = CLOSE
+        elsif @status == HALF_CLOSE_LOCAL
+        # nothing
+        else
+          raise 'stream is already closed'
+        end
+      end
+
+      def close_remote
+        if @status == OPEN
+          @status = HALF_CLOSE_REMOTE
+        elsif @status == HALF_CLOSE_LOCAL
+          @status = CLOSE
+        elsif @status == HALF_CLOSE_REMOTE
+        # nothing
+        else
+          raise 'stream is already closed'
+        end
+      end
+
+      def close
+        @status = CLOSE
+      end
+
+      def close_local?
+        (@status == HALF_CLOSE_LOCAL) || close?
+      end
+
+      def close_remote?
+        (@status == HALF_CLOSE_REMOTE) || close?
+      end
+
+      def close?
+        @status == CLOSE
+      end
+    end
+  end
+end

data/lib/grpc_kit/status_codes.rb

@@ -2,23 +2,44 @@
 
 module GrpcKit
   module StatusCodes
-    OK                  = 0
-    CANCELLED           = 1
-    UNKNOWN             = 2
-    INVALID_ARGUMENT    = 3
-    DEADLINE_EXCEEDED   = 4
-    NOT_FOUND           = 5
-    ALREADY_EXISTS      = 6
-    PERMISSION_DENIED   = 7
-    RESOURCE_EXHAUSTED  = 8
-    FAILED_PRECONDITION = 9
-    ABORTED             = 10
-    OUT_OF_RANGE        = 11
-    UNIMPLEMENTED       = 12
-    INTERNAL            = 13
-    UNAVAILABLE         = 14
-    DATA_LOSS           = 15
-    UNAUTHENTICATED     = 16
-    DO_NOT_USE          = -1
+    OK                  = '0'
+    CANCELLED           = '1'
+    UNKNOWN             = '2'
+    INVALID_ARGUMENT    = '3'
+    DEADLINE_EXCEEDED   = '4'
+    NOT_FOUND           = '5'
+    ALREADY_EXISTS      = '6'
+    PERMISSION_DENIED   = '7'
+    RESOURCE_EXHAUSTED  = '8'
+    FAILED_PRECONDITION = '9'
+    ABORTED             = '10'
+    OUT_OF_RANGE        = '11'
+    UNIMPLEMENTED       = '12'
+    INTERNAL            = '13'
+    UNAVAILABLE         = '14'
+    DATA_LOSS           = '15'
+    UNAUTHENTICATED     = '16'
+    DO_NOT_USE          = '-1'
+
+    CODE_NAME = {
+      OK                  => 'OK',
+      CANCELLED           => 'CANCELLED',
+      UNKNOWN             => 'UNKNOWN',
+      INVALID_ARGUMENT    => 'INVALID_ARGUMENT',
+      DEADLINE_EXCEEDED   => 'DEADLINE_EXCEEDED',
+      NOT_FOUND           => 'NOT_FOUND',
+      ALREADY_EXISTS      => 'ALREADY_EXISTS',
+      PERMISSION_DENIED   => 'PERMISSION_DENIED',
+      RESOURCE_EXHAUSTED  => 'RESOURCE_EXHAUSTED',
+      FAILED_PRECONDITION => 'FAILED_PRECONDITION',
+      ABORTED             => 'ABORTED',
+      OUT_OF_RANGE        => 'OUT_OF_RANGE',
+      UNIMPLEMENTED       => 'UNIMPLEMENTED',
+      INTERNAL            => 'INTERNAL',
+      UNAVAILABLE         => 'UNAVAILABLE',
+      DATA_LOSS           => 'DATA_LOSS',
+      UNAUTHENTICATED     => 'UNAUTHENTICATED',
+      DO_NOT_USE          => 'DO_NOT_USE',
+    }.freeze
   end
 end

data/lib/grpc_kit/stream.rb

@@ -9,7 +9,7 @@ module GrpcKit
 
     extend Forwardable
 
-    delegate %i[stream_id end_write end_read end_write? end_read?] => :@stream
+    delegate %i[stream_id end_write end_read end_write? end_read? close_remote? headers] => :@stream
 
     # @params protobuf [GrpcKit::Protobuffer]
     # @params session [GrpcKit::Session::Server|GrpcKit::Session::Client]
@@ -21,20 +21,34 @@ module GrpcKit
     end
 
     def each
-      loop { yield(recv) }
+      loop do
+        data = recv
+        return if data.nil?
+
+        yield(data)
+      end
     end
 
-    def send(data, last: false)
-      req = @protobuf.encode(data)
-      @stream.write_send_data(pack(req), last: last)
+    def send(data, last: false, limit_size: nil)
+      b =
+        begin
+          @protobuf.encode(data)
+        rescue ArgumentError => e
+          raise GrpcKit::Errors::Internal, "Error while encoding: #{e}"
+        end
+
+      req = pack(b)
+      if limit_size && req.bytesize > limit_size
+        raise GrpcKit::Errors::ResourceExhausted, "Sending message is too large: send=#{req.bytesize}, max=#{limit_size}"
+      end
+
+      @stream.write_send_data(req, last: last)
     end
 
-    def recv(last: false)
+    def recv(last: false, limit_size: nil)
       data = unpack(read(last: last))
 
-      unless data
-        raise StopIteration
-      end
+      return nil unless data
 
       compressed, size, buf = *data
 
@@ -42,11 +56,45 @@ module GrpcKit
         raise "inconsistent data: #{buf}"
       end
 
+      if limit_size && size > limit_size
+        raise GrpcKit::Errors::ResourceExhausted, "Receving message is too large: recevied=#{size}, max=#{limit_size}"
+      end
+
       if compressed
         raise 'compress option is unsupported'
       end
 
-      @protobuf.decode(buf)
+      begin
+        @protobuf.decode(buf)
+      rescue ArgumentError => e
+        raise GrpcKit::Errors::Internal, "Error while decoding #{e}"
+      end
+    end
+
+    def send_trailer(status: GrpcKit::StatusCodes::OK, msg: nil, metadata: {})
+      trailer = metadata.dup
+      trailer['grpc-status'] = status.to_s
+      if msg
+        trailer['grpc-message'] = msg
+      end
+
+      @stream.write_trailers_data(trailer)
+      @stream.end_write
+    end
+
+    # TODO: use actual data
+    def submit_response(_header = nil, piggyback_trailer: false)
+      headers = { ':status' => '200', 'content-type' => 'application/grpc' }
+
+      # ds9 does not support nthttp2_submit_{response|request} without body
+      # if piggyback_trailer
+      #   headers.merge!(@stream.trailer_data)
+      #   @stream.need_trailer = false
+      # else
+      headers['accept-encoding'] = 'identity'
+      # end
+
+      @session.submit_response(@stream.stream_id, headers)
     end
 
     private
@@ -54,17 +102,18 @@ module GrpcKit
     def read(last: false)
       loop do
         data = @stream.read_recv_data(last: last)
-        if data.empty?
-          # Consider `end_read` is set in this invocation
-          if @stream.end_read? && !last
+        return data unless data.empty?
+
+        if @stream.close_remote?
+          # it do not receive data which we need, it may receive invalid grpc-status
+          unless @stream.end_read?
             return nil
           end
 
-          @session.run_once
-          redo
+          return nil
         end
 
-        return data
+        @session.run_once
       end
     end
   end

data/lib/grpc_kit/streams/client.rb

@@ -2,30 +2,34 @@
 
 require 'grpc_kit/stream'
 require 'grpc_kit/streams/send_buffer'
+require 'grpc_kit/status_codes'
 
 module GrpcKit
   module Streams
     class Client
-      def initialize(path:, protobuf:, session:, authority:)
-        @path = path
+      def initialize(session:, config:, authority:)
+        @config = config
         @session = session
-        @protobuf = protobuf
         @stream = nil
         @authority = authority
       end
 
       def send_msg(data, metadata: {}, timeout: nil, last: false)
         if @stream
+          # unless metadata.empty?
+          #   raise 'You can attach metadata at first send_msg' # XXX
+          # end
+
           unless @stream.end_write?
             @session.resume_data(@stream.stream_id)
           end
         else
           headers = build_headers(metadata: metadata, timeout: timeout)
           stream = @session.start_request(GrpcKit::Streams::SendBuffer.new, headers)
-          @stream = GrpcKit::Stream.new(protobuf: @protobuf, session: @session, stream: stream)
+          @stream = GrpcKit::Stream.new(protobuf: @config.protobuf, session: @session, stream: stream)
         end
 
-        @stream.send(data, last: last)
+        @stream.send(data, last: last, limit_size: @config.max_send_message_size)
         @session.run_once
       end
 
@@ -42,7 +46,14 @@ module GrpcKit
           raise 'You should call `send` method to send data'
         end
 
-        @stream.recv(last: last)
+        data = @stream.recv(last: last, limit_size: @config.max_receive_message_size)
+
+        if data.nil?
+          check_status!
+          raise StopIteration
+        end
+
+        data
       end
 
       def close_and_recv
@@ -58,6 +69,8 @@ module GrpcKit
         @session.start(@stream.stream_id)
         @stream.end_read
 
+        check_status!
+
         data = []
         @stream.each { |d| data.push(d) }
         data
@@ -65,11 +78,24 @@ module GrpcKit
 
       private
 
+      def check_status!
+        # XXX: wait until half close (remote) to get grpc-status
+        until @stream.close_remote?
+          @session.run_once
+        end
+
+        if @stream.headers.grpc_status != GrpcKit::StatusCodes::OK
+          raise GrpcKit::Errors.from_status_code(@stream.headers.grpc_status, @stream.headers.status_message)
+        else
+          GrpcKit.logger.debug('request is success')
+        end
+      end
+
       def build_headers(metadata: {}, timeout: nil, **headers)
         hdrs = metadata.merge(headers).merge(
           ':method' => 'POST',
           ':scheme' => 'http',
-          ':path' => @path,
+          ':path' => @config.path,
           ':authority' => @authority,
           'te' => 'trailers',
           'content-type' => 'application/grpc',

data/lib/grpc_kit/streams/packable.rb

@@ -7,7 +7,7 @@ module GrpcKit
       # @params compress [Boolean]
       def pack(data, compress = false)
         c = compress ? 1 : 0
-        [c, data.size, data].pack('CNa*')
+        [c, data.bytesize, data].pack('CNa*')
       end
 
       # @params data [String]
@@ -51,6 +51,7 @@ module GrpcKit
         def read
           metadata = @data.slice!(0, METADATA_SIZE)
           c, size = metadata.unpack('CN')
+          # TODO: more efficient code
           data = @data.slice!(0, size)
           [c != 0, size, data]
         end

data/lib/grpc_kit/streams/server.rb

@@ -3,6 +3,7 @@
 require 'forwardable'
 
 require 'grpc_kit/stream'
+require 'grpc_kit/status_codes'
 
 module GrpcKit
   module Streams
@@ -11,24 +12,41 @@ module GrpcKit
 
       delegate %i[each recv] => :@stream
 
-      def initialize(protobuf:, session:, stream:)
-        @protobuf = protobuf
-        @session = session
-        @stream = GrpcKit::Stream.new(protobuf: @protobuf, session: @session, stream: stream)
+      def initialize(stream:, session:, config:)
+        @stream = GrpcKit::Stream.new(protobuf: config.protobuf, session: session, stream: stream)
+        @config = config
         @sent_first_msg = false
       end
 
       def send_msg(data, last: false)
-        @stream.send(data, last: last)
+        if last
+          @stream.send_trailer # TODO: pass trailer metadata
+        end
 
+        @stream.send(data, last: last, limit_size: @config.max_send_message_size)
         return if @sent_first_msg
 
-        @session.submit_response(
-          @stream.stream_id,
-          ':status' => '200',
-          'content-type' => 'application/grpc',
-          'accept-encoding' => 'identity',
-        )
+        @stream.submit_response
+        @sent_first_msg = true
+      end
+
+      def recv(last: false)
+        data = @stream.recv(last: last, limit_size: @config.max_receive_message_size)
+        raise StopIteration if data.nil?
+
+        data
+      end
+
+      def send_trailer
+        @stream.send_trailer # TODO: pass trailer metadata
+        @stream.end_write
+      end
+
+      def send_status(status: GrpcKit::StatusCodes::INTERNAL, msg: nil, metadata: {})
+        @stream.send_trailer(status: status, msg: msg, metadata: metadata)
+        return if @sent_first_msg
+
+        @stream.submit_response(piggyback_trailer: true)
         @sent_first_msg = true
       end
     end

data/lib/grpc_kit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GrpcKit
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grpc_kit
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - ganmacs
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-19 00:00:00.000000000 Z
+date: 2018-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ds9
@@ -70,16 +70,16 @@ dependencies:
   name: grpc-tools
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.15.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.15.0
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -152,7 +152,9 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- TODO.md
 - bin/console
+- bin/nghttp2
 - bin/setup
 - examples/helloworld/helloworld.proto
 - examples/helloworld/helloworld_pb.rb
@@ -190,6 +192,7 @@ files:
 - lib/grpc_kit/rpcs/bidi_streamer.rb
 - lib/grpc_kit/rpcs/call.rb
 - lib/grpc_kit/rpcs/client_streamer.rb
+- lib/grpc_kit/rpcs/error.rb
 - lib/grpc_kit/rpcs/request_response.rb
 - lib/grpc_kit/rpcs/server_streamer.rb
 - lib/grpc_kit/server.rb
@@ -200,13 +203,13 @@ files:
 - lib/grpc_kit/session/io.rb
 - lib/grpc_kit/session/server.rb
 - lib/grpc_kit/session/stream.rb
+- lib/grpc_kit/session/stream_status.rb
 - lib/grpc_kit/status_codes.rb
 - lib/grpc_kit/stream.rb
 - lib/grpc_kit/streams/client.rb
 - lib/grpc_kit/streams/packable.rb
 - lib/grpc_kit/streams/send_buffer.rb
 - lib/grpc_kit/streams/server.rb
-- lib/grpc_kit/streams/stream.rb
 - lib/grpc_kit/version.rb
 homepage: https://github.com/ganmacs/grpc_kit
 licenses: