grpc_kit 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db6a319fa0f74330575752eb203e867d4882d869ec12f73643bf11bc3f147c8d
-  data.tar.gz: 376c711925c3f8534d7e286ed1bc7015ae711f7d4e2998b89fd8a2a2a2a0daac
+  metadata.gz: 287f67b56117d3821a209c4be0892d6a9b7327fae3f7db509427afd2b53ef01b
+  data.tar.gz: f2e75960649d6f0c76fa6aae4d6370e0a7d4285d7154ca5bd1a640b5a1d458f0
 SHA512:
-  metadata.gz: 6fa2789ac0febc6e8dfac1f57d59488d1ab4db39b32c0e529a3fb91240d890abe9021f65db6d539c0d8218dc89204ca284db3b1e302c02d5f2ff785e76d8e9a0
-  data.tar.gz: a8d7f9a5446308d2d31fcde7f4de762a262b58a6068ded6b8a60a0787d68001b7f2cd555a7910977ab9c8cf9e8d811cbbb2da76b55aa1d96b26961af3112be75
+  metadata.gz: ccf9c72baa32cdecfe2d1fe8e7b1126ebb9c7e6604eef084d59ec478b34ad565912f8ebf648dadecf2cd4208441abe9cdfc31781a3f7460d542de395ee98e596
+  data.tar.gz: 5dbd7080945c3d1d47f4b19c488eb36a2cf60e71a28803344fc8f81d4054d42fa0cbe93929260d2e1709dd7f213c015188b8d209e34763de63a36d49b93f3e18

data/.rubocop.yml

@@ -35,6 +35,9 @@ Style/TrailingCommaInArguments:
 Style/SafeNavigation:
   Enabled: false
 
+Style/WhileUntilModifier:
+  Enabled: false
+
 Naming/PredicateName:
   NamePrefixBlacklist:
     - "is_"

data/.travis.yml

@@ -1,5 +1,44 @@
-sudo: false
 language: ruby
+cache:
+ - bundler
+ - apt
+dist: trusty
+sudo: required
+compiler:
+  - clang
+addons:
+  apt:
+    sources:
+    - ubuntu-toolchain-r-test
+    packages:
+    - g++-7
+    - autoconf
+    - automake
+    - autotools-dev
+    - libtool
+    - pkg-config
+    - zlib1g-dev
+    - libcunit1-dev
+    - libssl-dev
+    - libxml2-dev
+    - libev-dev
+    - libevent-dev
+    - libjansson-dev
+    - libjemalloc-dev
+    - libc-ares-dev
+    - cmake
+    - cmake-data
 rvm:
-  - 2.4.3
-before_install: gem install bundler -v 1.16.0
+  - ruby-head
+  - 2.5.3
+  - 2.4.5
+  - 2.3.8
+before_install:
+  - bin/nghttp2
+  - export LD_LIBRARY_PATH=$HOME/lib:$LD_LIBRARY_PATH
+  - export PKG_CONFIG_PATH=$HOME/lib/pkgconfig:$PKG_CONFIG_PATH
+  - gem install bundler -v 1.16.0
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/README.md

@@ -1,8 +1,11 @@
 # GrpcKit
 
+[![Build Status](https://travis-ci.org/ganmacs/grpc_kit.svg?branch=master)](https://travis-ci.org/ganmacs/grpc_kit)
+[![Gem Version](https://badge.fury.io/rb/grpc_kit.svg)](https://badge.fury.io/rb/grpc_kit)
+
 __UNDER DEVELOPMENT__
 
-A kit for creating [gRPC](https://grpc.io/) server/client.
+A kit for creating [gRPC](https://grpc.io/) server/client in Ruby.
 
 ## Installation
 

data/TODO.md

@@ -0,0 +1,64 @@
+## Features
+
+### request response
+
+- [x] recv/send msg
+- [x] metadata (client)
+- [x] metadata (server)
+- [x] interceptor (client)
+- [x] interceptor (server)
+- [x] deadline (client)
+- [x] deadline (server)
+
+### server streamer
+
+- [x] recv/send msg
+- [ ] metadata (client)
+- [ ] metadata (server)
+- [x] interceptor (client)
+- [x] interceptor (server)
+- [ ] deadline (client)
+- [ ] deadline (server)
+
+### client streamer
+
+- [x] recv/send msg
+- [ ] metadata (client)
+- [ ] metadata (server)
+- [x] interceptor (client)
+- [x] interceptor (server)
+- [ ] deadline (client)
+- [ ] deadline (server)
+
+### bidi_streamer
+
+- [ ] recv/send msg
+- [ ] metadata (client)
+- [ ] metadata (server)
+- [ ] interceptor (client)
+- [ ] interceptor (server)
+- [ ] deadline (client)
+- [ ] deadline (server)
+
+## Error handling
+
+- [x] resouce exhausted (body size is to large)
+- [x] internal
+- [ ] resouce exhausted (worker is exhausted)
+- [ ] duration parse in header
+- [ ] send `grpc-status` along with header frame if possible
+   - need to support  https://nghttp2.org/documentation/nghttp2_submit_response.html, data_prd is not NULL
+- [x] unimplemented error
+- [ ] goaway
+- [ ] cancel
+- [ ] support h2's header continuation
+
+## Others
+
+- [x] multi thread (griffin)
+- [x] mutli process (griffin)
+- [ ] connection persistent (client, griffin)
+- [ ] send metadata in trailrs frame
+- [ ] add server request spec
+- [ ] add client request spec
+- [ ] handle RST FRAME

data/bin/nghttp2

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+set -e
+
+VERSION=1.33.0
+
+curl -sSfLO https://github.com/nghttp2/nghttp2/releases/download/v"$VERSION"/nghttp2-"$VERSION".tar.gz
+tar xf nghttp2-"$VERSION".tar.gz
+cd nghttp2-"$VERSION"
+./configure --prefix="$HOME" --enable-lib-only
+make && make install

data/grpc_kit.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'googleapis-common-protos-types', '~> 1.0.2'
 
   spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'grpc-tools'
+  spec.add_development_dependency 'grpc-tools', '~> 1.15.0'
   spec.add_development_dependency 'pry-byebug'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'

data/lib/grpc_kit/errors.rb

@@ -5,31 +5,70 @@ require 'grpc_kit/status_codes'
 module GrpcKit
   module Errors
     # https://github.com/grpc/grpc/blob/23b5b1a5a9c7084c5b64d4998ee15af0f77bd589/doc/statuscodes.md
+
+    def self.from_status_code(code, message)
+      CODES.fetch(code).new(message)
+    end
+
     class BadStatus < StandardError
-      def initialize(code, message)
-        super("#{code} #{message}")
+      attr_reader :code, :reason
+
+      def initialize(code, reason)
         @code = code
-        @message = message
+        @reason = reason
+        super("[#{GrpcKit::StatusCodes::CODE_NAME[code]}] #{reason}")
+      end
+    end
+
+    class Unknown < BadStatus
+      def initialize(mesage)
+        super(GrpcKit::StatusCodes::UNKNOWN, mesage)
       end
     end
 
-    class DeadlienExceeded < BadStatus
-      def initialize(msg)
-        super(
-          GrpcKit::StatusCodes::DEADLINE_EXCEEDED,
-          msg.to_s,
-          # "Deadline expires before server returns status: #{msg}"
-        )
+    class DeadlineExceeded < BadStatus
+      def initialize(mesage)
+        super(GrpcKit::StatusCodes::DEADLINE_EXCEEDED, mesage)
       end
     end
 
     class Unimplemented < BadStatus
-      def initialize(name)
-        super(
-          GrpcKit::StatusCodes::UNIMPLEMENTED,
-          "Method not found at server: #{name}"
-        )
+      def initialize(mesage)
+        super(GrpcKit::StatusCodes::UNIMPLEMENTED, mesage)
       end
     end
+
+    class ResourceExhausted < BadStatus
+      def initialize(mesage)
+        super(GrpcKit::StatusCodes::RESOURCE_EXHAUSTED, mesage)
+      end
+    end
+
+    class Internal < BadStatus
+      def initialize(mesage)
+        super(GrpcKit::StatusCodes::INTERNAL, mesage)
+      end
+    end
+
+    CODES = {
+      # GrpcKit::StatusCode::OK                  => 'OK',
+      # GrpcKit::StatusCode::CANCELLED           => 'CANCELLED',
+      GrpcKit::StatusCodes::UNKNOWN             => Unknown,
+      # GrpcKit::StatusCode::INVALID_ARGUMENT    => 'INVALID_ARGUMENT',
+      GrpcKit::StatusCodes::DEADLINE_EXCEEDED   => DeadlineExceeded,
+      # GrpcKit::StatusCode::NOT_FOUND           => 'NOT_FOUND',
+      # GrpcKit::StatusCode::ALREADY_EXISTS      => 'ALREADY_EXISTS',
+      # GrpcKit::StatusCode::PERMISSION_DENIED   => 'PERMISSION_DENIED',
+      GrpcKit::StatusCodes::RESOURCE_EXHAUSTED  => ResourceExhausted,
+      # GrpcKit::StatusCode::FAILED_PRECONDITION => 'FAILED_PRECONDITION',
+      # GrpcKit::StatusCode::ABORTED             => 'ABORTED',
+      # GrpcKit::StatusCode::OUT_OF_RANGE        => 'OUT_OF_RANGE',
+      GrpcKit::StatusCodes::UNIMPLEMENTED       => Unimplemented,
+      GrpcKit::StatusCodes::INTERNAL            => Internal,
+      # GrpcKit::StatusCode::UNAVAILABLE         => 'UNAVAILABLE',
+      # GrpcKit::StatusCode::DATA_LOSS           => 'DATA_LOSS',
+      # GrpcKit::StatusCode::UNAUTHENTICATED     => 'UNAUTHENTICATED',
+      # GrpcKit::StatusCode::DO_NOT_USE          => 'DO_NOT_USE',
+    }.freeze
   end
 end

data/lib/grpc_kit/grpc/dsl.rb

@@ -39,7 +39,7 @@ module GrpcKit
         rpc_descs[rpc_desc.path] = rpc_desc
 
         define_method(rpc_desc.ruby_style_name) do |_, _|
-          raise GrpcKit::Errors::Unimplemented, name.to_s
+          raise GrpcKit::Errors::Unimplemented, "Method not found: #{name}"
         end
       end
 

data/lib/grpc_kit/interceptors/client_streamer.rb

@@ -8,11 +8,11 @@ module GrpcKit
       class ClientStreamer < Streaming
         private
 
-        def invoke(interceptor, call)
+        def invoke(interceptor, call, metadata)
           # We don't need a `:requests` parameter but,
           # it shuoldn't remove from paramters due to having a compatibility of grpc gem.
-          interceptor.client_streamer(requests: nil, call: call, method: call.method, metadata: nil) do |s|
-            yield(s)
+          interceptor.client_streamer(requests: nil, call: call, method: call.method, metadata: metadata) do
+            yield(call, metadata)
           end
         end
       end
@@ -21,8 +21,8 @@ module GrpcKit
     module Server
       class ClientStreamer < Streaming
         def invoke(interceptor, call)
-          interceptor.client_streamer(call: call, method: call.method) do |s|
-            yield(s)
+          interceptor.client_streamer(call: call, method: call.method) do
+            yield(call)
           end
         end
       end

data/lib/grpc_kit/interceptors/server_streamer.rb

@@ -8,11 +8,11 @@ module GrpcKit
       class ServerStreamer < Streaming
         private
 
-        def invoke(interceptor, call)
+        def invoke(interceptor, call, metadata)
           # We don't need a `:request` parameter but,
           # it shuoldn't remove from paramters due to having a compatibility of grpc gem.
-          interceptor.server_streamer(request: nil, call: call, method: call.method, metadata: nil) do |s|
-            yield(s)
+          interceptor.server_streamer(request: nil, call: call, method: call.method, metadata: metadata) do
+            yield(call, metadata)
           end
         end
       end
@@ -23,8 +23,8 @@ module GrpcKit
         def invoke(interceptor, call)
           # We don't need a `:request` parameter but,
           # it shuoldn't remove from paramters due to having a compatibility of grpc gem.
-          interceptor.server_streamer(request: nil, call: call, method: call.method) do |s|
-            yield(s)
+          interceptor.server_streamer(request: nil, call: call, method: call.method) do
+            yield(call)
           end
         end
       end

data/lib/grpc_kit/interceptors/streaming.rb

@@ -11,25 +11,25 @@ module GrpcKit
           @interceptors = nil
         end
 
-        def intercept(call, &block)
+        def intercept(call, metadata, &block)
           if @interceptors && !@interceptors.empty?
-            do_intercept(@interceptors.dup, call, &block)
+            do_intercept(@interceptors.dup, call, metadata, &block)
           else
-            yield(call)
+            yield(call, metadata)
           end
         end
 
         private
 
-        def do_intercept(interceptors, call)
+        def do_intercept(interceptors, call, metadata)
           if interceptors.empty?
-            return yield(call)
+            return yield(call, metadata)
           end
 
           interceptor = interceptors.pop
-          invoke(interceptor, call) do |inter_call|
-            do_intercept(interceptors, inter_call) do |c|
-              yield(c)
+          invoke(interceptor, call, metadata) do |inter_call, meta|
+            do_intercept(interceptors, inter_call, meta) do |c, m|
+              yield(c, m)
             end
           end
         end

data/lib/grpc_kit/rpcs/client_streamer.rb

@@ -7,9 +7,9 @@ module GrpcKit
     module Client
       class ClientStreamer < Base
         def invoke(session, _request, authority:, metadata: {}, timeout: nil, **opts)
-          cs = GrpcKit::Streams::Client.new(path: @config.path, protobuf: @config.protobuf, session: session, authority: authority)
+          cs = GrpcKit::Streams::Client.new(config: @config, session: session, authority: authority)
           call = GrpcKit::Rpcs::Call.new(metadata, @config.method_name, @config.service_name, cs)
-          @config.interceptor.intercept(call) do |s|
+          @config.interceptor.intercept(call, metadata) do |s|
             s
           end
         end
@@ -19,7 +19,7 @@ module GrpcKit
     module Server
       class ClientStreamer < Base
         def invoke(stream, session)
-          ss = GrpcKit::Streams::Server.new(stream: stream, protobuf: @config.protobuf, session: session)
+          ss = GrpcKit::Streams::Server.new(stream: stream, session: session, config: @config)
           call = GrpcKit::Rpcs::Call.new(stream.headers.metadata, @config.method_name, @config.service_name, ss)
 
           if @config.interceptor

data/lib/grpc_kit/rpcs/error.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'grpc_kit/status_codes'
+
+module GrpcKit
+  module Rpcs
+    module Client
+      class Error
+        # def invoke(session, request, authority:, error)
+        # end
+      end
+    end
+
+    module Server
+      class Error
+        def send_bad_status(stream, session, bad_status)
+          ss = GrpcKit::Streams::Server.new(stream: stream, protobuf: nil, session: session)
+          ss.send_status(status: bad_status.code, msg: bad_status.grpc_message)
+        end
+      end
+    end
+  end
+end

data/lib/grpc_kit/rpcs/request_response.rb

@@ -1,19 +1,20 @@
 # frozen_string_literal: true
 
 require 'grpc_kit/rpcs/base'
+require 'grpc_kit/status_codes'
 
 module GrpcKit
   module Rpcs
     module Client
       class RequestResponse < Base
         def invoke(session, request, authority:, metadata: {}, timeout: nil, **opts)
-          cs = GrpcKit::Streams::Client.new(path: @config.path, protobuf: @config.protobuf, session: session, authority: authority)
+          cs = GrpcKit::Streams::Client.new(config: @config, session: session, authority: authority)
 
           call = GrpcKit::Rpcs::Call.new(metadata, @config.method_name, @config.service_name, cs)
           @config.interceptor.intercept(request, call, metadata) do |r, c, m|
             if timeout
               # XXX: when timeout.to_timeout is 0
-              Timeout.timeout(timeout.to_timeout, GrpcKit::Errors::DeadlienExceeded) do
+              Timeout.timeout(timeout.to_timeout, GrpcKit::Errors::DeadlineExceeded) do
                 c.send_msg(r, timeout: timeout.to_s, metadata: m, last: true)
                 c.recv(last: true)
               end
@@ -29,10 +30,23 @@ module GrpcKit
     module Server
       class RequestResponse < Base
         def invoke(stream, session)
-          ss = GrpcKit::Streams::Server.new(stream: stream, protobuf: @config.protobuf, session: session)
+          ss = GrpcKit::Streams::Server.new(stream: stream, session: session, config: @config)
           call = GrpcKit::Rpcs::Call.new(stream.headers.metadata, @config.method_name, @config.service_name, ss)
 
+          begin
+            do_invoke(ss, call)
+          rescue GrpcKit::Errors::BadStatus => e
+            ss.send_status(status: e.code, msg: e.reason, metadata: {}) # TODO: metadata should be set
+          rescue StandardError => e
+            ss.send_status(status: GrpcKit::StatusCodes::UNKNOWN, msg: e.message, metadata: {})
+          end
+        end
+
+        private
+
+        def do_invoke(ss, call)
           request = ss.recv(last: true)
+
           resp =
             if @config.interceptor
               @config.interceptor.intercept(request, call) do |req, c|

data/lib/grpc_kit/rpcs/server_streamer.rb

@@ -7,11 +7,11 @@ module GrpcKit
     module Client
       class ServerStreamer < Base
         def invoke(session, request, authority:, metadata: {}, timeout: nil, **opts)
-          cs = GrpcKit::Streams::Client.new(path: @config.path, protobuf: @config.protobuf, session: session, authority: authority)
+          cs = GrpcKit::Streams::Client.new(config: @config, session: session, authority: authority)
           call = GrpcKit::Rpcs::Call.new(metadata, @config.method_name, @config.service_name, cs)
 
-          @config.interceptor.intercept(call) do |c|
-            c.send_msg(request, last: true)
+          @config.interceptor.intercept(call, metadata) do |c, m|
+            c.send_msg(request, metadata: m, last: true)
             c
           end
         end
@@ -21,7 +21,7 @@ module GrpcKit
     module Server
       class ServerStreamer < Base
         def invoke(stream, session)
-          ss = GrpcKit::Streams::Server.new(stream: stream, protobuf: @config.protobuf, session: session)
+          ss = GrpcKit::Streams::Server.new(stream: stream, session: session, config: @config)
           call = GrpcKit::Rpcs::Call.new(stream.headers.metadata, @config.method_name, @config.service_name, ss)
 
           if @config.interceptor
@@ -34,7 +34,7 @@ module GrpcKit
             @handler.send(@config.ruby_style_method_name, request, call)
           end
 
-          stream.end_write
+          ss.send_trailer
         end
       end
     end

data/lib/grpc_kit/rpcs.rb

@@ -4,6 +4,7 @@ require 'grpc_kit/rpcs/request_response'
 require 'grpc_kit/rpcs/client_streamer'
 require 'grpc_kit/rpcs/server_streamer'
 require 'grpc_kit/rpcs/bidi_streamer'
+require 'grpc_kit/rpcs/error'
 
 module GrpcKit
   module Rpcs

data/lib/grpc_kit/server.rb

@@ -8,8 +8,11 @@ module GrpcKit
     def initialize(interceptors: [])
       @sessions = []
       @rpc_descs = {}
+      @error_rpc = GrpcKit::Rpcs::Server::Error.new
       @interceptors = interceptors
       @mutex = Mutex.new
+
+      GrpcKit.logger.debug("Launched grpc_kit(v#{GrpcKit::VERSION})")
     end
 
     # @params handler [object]
@@ -24,7 +27,6 @@ module GrpcKit
     end
 
     def run(conn)
-      GrpcKit.logger.debug("Run grpc_kit(v#{GrpcKit::VERSION})")
       establish_session(conn) do |s|
         s.submit_settings([])
         s.start
@@ -42,7 +44,7 @@ module GrpcKit
     def dispatch(stream, session)
       rpc = @rpc_descs[stream.headers.path]
       unless rpc
-        raise "Unkown path #{path}"
+        return @error_rpc.send_bad_status(stream, session, GrpcKit::Errors::Unimplemented.new(stream.headers.path))
       end
 
       rpc.invoke(stream, session)

data/lib/grpc_kit/session/buffer.rb

@@ -10,27 +10,30 @@ module GrpcKit
         @end_read = false
         @end_write = false
         @finish = false
-        @write_byte_size = 0
       end
 
       def write(data, last: false)
+        return 0 if data.empty?
+
         end_write if last
-        @write_byte_size += data.size
 
         if @buffer
           @buffer << data
         else
-          @buffer = data
+          @buffer = data.dup
         end
+
+        data.bytesize
       end
 
       def read(len = nil, last: false)
-        end_read if last
-
-        if @buffer.nil?
+        if @buffer.nil? || @buffer.empty?
           return ''
         end
 
+        end_read if last
+
+        # TODO: more efficient code
         if len
           @buffer.slice!(0...len)
         else

data/lib/grpc_kit/session/client.rb

@@ -33,7 +33,7 @@ module GrpcKit
         stream = @streams.fetch(stream_id)
 
         loop do
-          if (!want_read? && !want_write?) || stream.end_stream?
+          if (!want_read? && !want_write?) || stream.close?
             break
           end
 
@@ -81,7 +81,7 @@ module GrpcKit
           stream = @streams[frame.stream_id]
 
           if frame.end_stream?
-            stream.remote_end_stream = true
+            stream.close_remote
           end
 
           unless stream.inflight
@@ -92,7 +92,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
@@ -109,7 +109,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
 
@@ -122,7 +122,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
@@ -137,9 +137,12 @@ module GrpcKit
       # def on_frame_not_send(frame, reason)
       # end
 
-      # # for nghttp2_session_callbacks_set_on_header_callback
-      # def on_header(name, value, frame, flags)
-      # end
+      # for 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
 
       # # for nghttp2_session_callbacks_set_on_begin_headers_callback
       # def on_begin_header(name, value, frame, flags)

data/lib/grpc_kit/session/duration.rb

@@ -12,6 +12,7 @@ module GrpcKit
 
       # @params val [String]
       def self.decode(value)
+        value = value.dup
         size = value.size
         if size < 2
           raise "Invalid format: too short #{value}"

data/lib/grpc_kit/session/headers.rb

@@ -36,19 +36,18 @@ module GrpcKit
         when ':path'
           self.path = val
         when ':status'
-          self.http_status = val.to_i
+          self.http_status = Integer(val)
         when 'content-type'
           # TODO
           metadata[key] = val
         when 'grpc-encoding'
           self.grpc_encoding = val
         when 'grpc-status'
-          self.grpc_status = val.to_i
+          self.grpc_status = val
         when 'grpc-timeout'
           self.timeout = Duration.decode(val)
         when 'grpc-message'
-          # TODO
-          GrpcKit.logger.warn('grpc-message is unsupported header now')
+          self.status_message = val
         when 'grpc-status-details-bin'
           # TODO
           GrpcKit.logger.warn('grpc-status-details-bin is unsupported header now')