grpc_kit 0.1.8 → 0.1.9

data/lib/grpc_kit/protobuffer.rb

@@ -2,6 +2,10 @@
 
 module GrpcKit
   class ProtoBuffer
+    # @param encoder [Class, GrpcKit::GRPC::Stream]
+    # @param decoder [Class, GrpcKit::GRPC::Stream]
+    # @param encode_method [Symbol]
+    # @param decode_method [Symbol]
     def initialize(encoder:, decoder:, encode_method:, decode_method:)
       @encoder = encoder
       @decoder = decoder
@@ -9,10 +13,14 @@ module GrpcKit
       @decode_method = decode_method
     end
 
+    # @param data [String]
+    # @return [void]
     def encode(data)
       @encoder.send(@encode_method, data)
     end
 
+    # @param data [String]
+    # @return [void]
     def decode(data)
       @decoder.send(@decode_method, data)
     end

data/lib/grpc_kit/rpc_desc.rb

@@ -6,7 +6,7 @@ require 'grpc_kit/protobuffer'
 require 'grpc_kit/interceptors/client_request_response'
 require 'grpc_kit/interceptors/client_client_streamer'
 require 'grpc_kit/interceptors/client_server_streamer'
-# require 'grpc_kit/client_interceptors/bidi_streamer'
+require 'grpc_kit/interceptors/client_bidi_streamer'
 require 'grpc_kit/rpcs/client_request_response'
 require 'grpc_kit/rpcs/client_client_streamer'
 require 'grpc_kit/rpcs/client_server_streamer'
@@ -15,7 +15,7 @@ require 'grpc_kit/rpcs/client_bidi_streamer'
 require 'grpc_kit/interceptors/server_request_response'
 require 'grpc_kit/interceptors/server_client_streamer'
 require 'grpc_kit/interceptors/server_server_streamer'
-# require 'grpc_kit/server_interceptors/bidi_streamer'
+require 'grpc_kit/interceptors/server_bidi_streamer'
 require 'grpc_kit/rpcs/server_request_response'
 require 'grpc_kit/rpcs/server_client_streamer'
 require 'grpc_kit/rpcs/server_server_streamer'
@@ -23,6 +23,12 @@ require 'grpc_kit/rpcs/server_bidi_streamer'
 
 module GrpcKit
   class RpcDesc
+    # @param name [Symbol] path name
+    # @param marshal [Class, GrpcKit::GRPC::Stream] marshaling object
+    # @param unmarshal [Class, GrpcKit::GRPC::Stream] unmarshaling object
+    # @param marshal_method [Symbol] method name of marshaling which marshal is called this method
+    # @param unmarshal_method [Symbol] method name of unmarshaling which unmarshal is called this method
+    # @param service_name [String]
     def initialize(name:, marshal:, unmarshal:, marshal_method:, unmarshal_method:, service_name:)
       @name = name
       @marshal = marshal
@@ -32,6 +38,9 @@ module GrpcKit
       @service_name = service_name
     end
 
+    # @param handler [GrpcKit::GRPC::GenericService]
+    # @param interceptors [Array<GrpcKit::GRPC::ServerInterceptor>]
+    # @return [#invoke] Server version of rpc class
     def build_server(handler, interceptors: [])
       inter = interceptors.empty? ? nil : server_interceptor.new(interceptors)
 
@@ -46,6 +55,8 @@ module GrpcKit
       server.new(handler, config)
     end
 
+    # @param interceptors [Array<GrpcKit::GRPC::ClientInterceptor>]
+    # @return [#invoke] Client version of rpc class
     def build_client(interceptors: [])
       inter = interceptors.empty? ? nil : client_interceptor.new(interceptors)
 
@@ -60,26 +71,32 @@ module GrpcKit
       client.new(config)
     end
 
+    # @return [Symbol] Snake case name
     def ruby_style_name
       @ruby_style_name ||= to_underscore(@name).to_sym
     end
 
+    # @return [String] Full name of path name
     def path
       @path ||= "/#{@service_name}/#{@name}"
     end
 
+    # @return [Boolean]
     def request_response?
       !@marshal.is_a?(GrpcKit::GRPC::Stream) && !@unmarshal.is_a?(GrpcKit::GRPC::Stream)
     end
 
+    # @return [Boolean]
     def client_streamer?
       @marshal.is_a?(GrpcKit::GRPC::Stream) && !@unmarshal.is_a?(GrpcKit::GRPC::Stream)
     end
 
+    # @return [Boolean]
     def server_streamer?
       !@marshal.is_a?(GrpcKit::GRPC::Stream) && @unmarshal.is_a?(GrpcKit::GRPC::Stream)
     end
 
+    # @return [Boolean]
     def bidi_streamer?
       @marshal.is_a?(GrpcKit::GRPC::Stream) && @unmarshal.is_a?(GrpcKit::GRPC::Stream)
     end
@@ -138,7 +155,7 @@ module GrpcKit
       elsif server_streamer?
         GrpcKit::Interceptors::Server::ServerStreamer
       elsif bidi_streamer?
-        GrpcKit::Interceptors::Server::RequestResponse # TODO
+        GrpcKit::Interceptors::Server::BidiStreamer
       end
     end
 
@@ -150,7 +167,7 @@ module GrpcKit
       elsif server_streamer?
         GrpcKit::Interceptors::Client::ServerStreamer
       elsif bidi_streamer?
-        GrpcKit::Interceptors::Client::RequestResponse # TODO
+        GrpcKit::Interceptors::Client::BidiStreamer
       end
     end
 

data/lib/grpc_kit/rpcs.rb

@@ -7,8 +7,10 @@ require 'grpc_kit/status_codes'
 module GrpcKit
   module Rpcs
     class ClientRpc
+      # @return [GrpcKit::MethodConfig]
       attr_reader :config
 
+      # @param config [GrpcKit::MethodConfig]
       def initialize(config)
         @config = config
       end
@@ -17,6 +19,8 @@ module GrpcKit
     end
 
     class ServerRpc
+      # @param handler [GrpcKit::GRPC::GenericService]
+      # @param config [GrpcKit::MethodConfig]
       def initialize(handler, config)
         @handler = handler
         @config = config

data/lib/grpc_kit/rpcs/client_bidi_streamer.rb

@@ -1,11 +1,30 @@
 # frozen_string_literal: true
 
 require 'grpc_kit/rpcs'
+require 'grpc_kit/calls/client_bidi_streamer'
 
 module GrpcKit
   module Rpcs::Client
     class BidiStreamer < GrpcKit::Rpcs::ClientRpc
-      def invoke(session, data, opts = {}); end
+      # @param stream [GrpcKit::Stream::ClientStream]
+      # @param _requests [Object] it's for compatibility, no use
+      # @param metadata [Hash<String, String>]
+      # @param timeout [GrpcKit::GrpcTime]
+      # @return [GrpcKit::Calls::Client::BidiStreamer]
+      def invoke(stream, _requests, metadata: {}, timeout: nil)
+        call = GrpcKit::Calls::Client::BidiStreamer.new(
+          metadata: metadata,
+          config: @config,
+          timeout: timeout,
+          stream: stream,
+        )
+
+        if @config.interceptor
+          @config.interceptor.intercept(call, metadata) { |s| s }
+        else
+          call
+        end
+      end
     end
   end
 end

data/lib/grpc_kit/rpcs/client_client_streamer.rb

@@ -6,6 +6,11 @@ require 'grpc_kit/calls/client_client_streamer'
 module GrpcKit
   module Rpcs::Client
     class ClientStreamer < GrpcKit::Rpcs::ClientRpc
+      # @param stream [GrpcKit::Stream::ClientStream]
+      # @param _request [nil] No use
+      # @param metadata [Hash<String, String>]
+      # @param timeout [GrpcKit::GrpcTime]
+      # @return [GrpcKit::Calls::Client::ClientStreamer]
       def invoke(stream, _request, metadata: {}, timeout: nil)
         call = GrpcKit::Calls::Client::ClientStreamer.new(
           metadata: metadata,

data/lib/grpc_kit/rpcs/client_request_response.rb

@@ -6,7 +6,12 @@ require 'grpc_kit/calls/client_request_response'
 module GrpcKit
   module Rpcs::Client
     class RequestResponse < GrpcKit::Rpcs::ClientRpc
-      def invoke(stream, request, metadata: {}, timeout: nil)
+      # @param stream [GrpcKit::Stream::ClientStream]
+      # @param request [Object] request message
+      # @param metadata [Hash<String, String>]
+      # @param timeout [GrpcKit::GrpcTime]
+      # @return [Object] response message
+      def invoke(stream, request,  metadata: {}, timeout: nil)
         call = GrpcKit::Calls::Client::RequestResponse.new(
           metadata: metadata,
           config: @config,
@@ -14,27 +19,16 @@ module GrpcKit
           stream: stream,
         )
 
-        # TODO: DRY
-        if @config.interceptor && timeout
-          @config.interceptor.intercept(request, call, call.metadata) do |r, c, _|
-            Timeout.timeout(timeout.to_f, GrpcKit::Errors::DeadlineExceeded) do
-              call.send_msg(request, timeout: timeout.to_s, last: true)
+        Timeout.timeout(timeout&.to_f, GrpcKit::Errors::DeadlineExceeded) do
+          if @config.interceptor
+            @config.interceptor.intercept(request, call, call.metadata) do |r, c, _|
+              call.send_msg(request, last: true)
               call.recv(last: true)
             end
-          end
-        elsif @config.interceptor && !timeout
-          @config.interceptor.intercept(request, call, call.metadata) do |r, c, _|
+          else
             call.send_msg(request, last: true)
             call.recv(last: true)
           end
-        elsif !@config.interceptor && timeout
-          Timeout.timeout(timeout.to_f, GrpcKit::Errors::DeadlineExceeded) do
-            call.send_msg(request, timeout: timeout.to_s, last: true)
-            call.recv(last: true)
-          end
-        else
-          call.send_msg(request, last: true)
-          call.recv(last: true)
         end
       end
     end

data/lib/grpc_kit/rpcs/client_server_streamer.rb

@@ -6,6 +6,11 @@ require 'grpc_kit/calls/client_server_streamer'
 module GrpcKit
   module Rpcs::Client
     class ServerStreamer < GrpcKit::Rpcs::ClientRpc
+      # @param stream [GrpcKit::Stream::ClientStream]
+      # @param request [Object] reqeust message
+      # @param metadata [Hash<String, String>]
+      # @param timeout [GrpcKit::GrpcTime]
+      # @return [GrpcKit::Calls::Client::ServerStreamer]
       def invoke(stream, request, metadata: {}, timeout: nil)
         call = GrpcKit::Calls::Client::ServerStreamer.new(metadata: metadata, config: @config, timeout: timeout, stream: stream)
 

data/lib/grpc_kit/rpcs/server_bidi_streamer.rb

@@ -1,10 +1,27 @@
 # frozen_string_literal: true
 
 require 'grpc_kit/rpcs'
+require 'grpc_kit/calls/server_bidi_streamer'
 
 module GrpcKit
   module Rpcs::Server
     class BidiStreamer < GrpcKit::Rpcs::ServerRpc
+      # @param stream [GrpcKit::Stream::ServerStream]
+      # @param metadata [Hash<String, String>]
+      # @return [void]
+      def invoke(stream, metadata: {})
+        call = GrpcKit::Calls::Server::BidiStreamer.new(metadata: metadata, config: @config, stream: stream)
+
+        if @config.interceptor
+          @config.interceptor.intercept(call) do |c|
+            @handler.send(@config.ruby_style_method_name, c)
+          end
+        else
+          @handler.send(@config.ruby_style_method_name, call)
+        end
+
+        stream.send_status
+      end
     end
   end
 end

data/lib/grpc_kit/rpcs/server_client_streamer.rb

@@ -6,6 +6,9 @@ require 'grpc_kit/calls/server_client_streamer'
 module GrpcKit
   module Rpcs::Server
     class ClientStreamer < GrpcKit::Rpcs::ServerRpc
+      # @param stream [GrpcKit::Stream::ServerStream]
+      # @param metadata [Hash<String, String>]
+      # @return [void]
       def invoke(stream, metadata: {})
         call = GrpcKit::Calls::Server::ClientStreamer.new(metadata: metadata, config: @config, stream: stream)
 

data/lib/grpc_kit/rpcs/server_request_response.rb

@@ -6,6 +6,9 @@ require 'grpc_kit/calls/server_request_response'
 module GrpcKit
   module Rpcs::Server
     class RequestResponse < GrpcKit::Rpcs::ServerRpc
+      # @param stream [GrpcKit::Stream::ServerStream]
+      # @param metadata [Hash<String, String>]
+      # @return [void]
       def invoke(stream, metadata: {})
         call = GrpcKit::Calls::Server::RequestResponse.new(metadata: metadata, config: @config, stream: stream)
         request = call.recv(last: true)

data/lib/grpc_kit/rpcs/server_server_streamer.rb

@@ -6,6 +6,9 @@ require 'grpc_kit/calls/server_server_streamer'
 module GrpcKit
   module Rpcs::Server
     class ServerStreamer < GrpcKit::Rpcs::ServerRpc
+      # @param stream [GrpcKit::Stream::ServerStream]
+      # @param metadata [Hash<String, String>]
+      # @return [void]
       def invoke(stream, metadata: {})
         call = GrpcKit::Calls::Server::ServerStreamer.new(metadata: metadata, config: @config, stream: stream)
 

data/lib/grpc_kit/server.rb

@@ -5,6 +5,7 @@ require 'grpc_kit/session/server_session'
 
 module GrpcKit
   class Server
+    # @param interceptors [Array<GrpcKit::GRPC::ServerInterceptor>] list of interceptors
     def initialize(interceptors: [])
       @sessions = []
       @rpc_descs = {}
@@ -16,6 +17,8 @@ module GrpcKit
       GrpcKit.logger.debug("Launched grpc_kit(v#{GrpcKit::VERSION})")
     end
 
+    # @param handler [GrpcKit::GRPC::GenericService] gRPC handler object or class
+    # @return [void]
     def handle(handler)
       klass = handler.is_a?(Class) ? handler : handler.class
       unless klass.include?(GrpcKit::GRPC::GenericService)
@@ -32,6 +35,8 @@ module GrpcKit
       end
     end
 
+    # @param conn [TCPSocket]
+    # @return [void]
     def run(conn)
       raise 'Stopping server' if @stopping
 
@@ -41,8 +46,9 @@ module GrpcKit
       end
     end
 
+    # This method is expected to be called in trap context
+    # @return [void]
     def force_shutdown
-      # expected to be called in trap context
       Thread.new do
         @mutex.synchronize do
           GrpcKit.logger.debug('force shutdown')
@@ -52,8 +58,9 @@ module GrpcKit
       end
     end
 
+    # This method is expected to be called in trap context
+    # @return [void]
     def graceful_shutdown
-      # expected to be called in trap context
       Thread.new do
         GrpcKit.logger.debug('graceful shutdown')
         @mutex.synchronize { @sessions.each(&:drain) }
@@ -77,8 +84,9 @@ module GrpcKit
       @mutex.synchronize { @sessions.size }
     end
 
-    # @params path [String]
-    # @params stream [GrpcKit::Streams::ServerStream]
+    # @param path [String] gRPC method path
+    # @param stream [GrpcKit::Streams::ServerStream]
+    # @return [void]
     def dispatch(path, stream)
       rpc = @rpc_descs[path]
       unless rpc

data/lib/grpc_kit/session/client_session.rb

@@ -16,7 +16,8 @@ module GrpcKit
 
       delegate %i[send_event recv_event] => :@io
 
-      # @params io [GrpcKit::Session::IO]
+      # @param io [GrpcKit::Session::IO]
+      # @param opts [Hash]
       def initialize(io, opts = {})
         super() # initialize DS9::Session
 
@@ -27,6 +28,8 @@ module GrpcKit
         @stop = false
       end
 
+      # @param headers [Hash<String,String>]
+      # @return [void]
       def send_request(headers)
         if @draining
           raise ConnectionClosing, "You can't send new request. becuase this connection will shuting down"
@@ -40,7 +43,8 @@ module GrpcKit
         stream
       end
 
-      # @params stream_id [Integer]
+      # @param stream_id [Integer]
+      # @return [void]
       def start(stream_id)
         stream = @streams.fetch(stream_id)
 
@@ -56,6 +60,7 @@ module GrpcKit
         shutdown
       end
 
+      # @return [void]
       def run_once
         return if @stop
 

data/lib/grpc_kit/session/drain_controller.rb

@@ -12,10 +12,12 @@ module GrpcKit
         # @sent_ping = false
       end
 
+      # @return [void]
       def recv_ping_ack
         @after_one_rtt = true
       end
 
+      # @return [void]
       def call(session)
         if @goaway_sent
         # session.shutdown

data/lib/grpc_kit/session/headers.rb

@@ -20,6 +20,7 @@ module GrpcKit
         @metadata = {}
       end
 
+      # @return [Hash<String,String>]
       def metadata
         @metadata =
           if @metadata.empty?
@@ -31,34 +32,44 @@ module GrpcKit
           end
       end
 
+      # @return [String,nil]
       def path
         @opts[':path']
       end
 
+      # @return [String,nil]
       def grpc_status
         @opts['grpc-status']
       end
 
+      # @return [String,nil]
       def grpc_encoding
         @opts['grpc-encoding']
       end
 
+      # @return [String,nil]
       def content_type
         @opts['content-type']
       end
 
+      # @return [String,nil]
       def status_message
         @opts['grpc-message']
       end
 
+      # @return [Time,nil]
       def timeout
         @timeout ||= @opts['grpc-timeout'] && GrpcTime.new(@opts['grpc-timeout'])
       end
 
+      # @return [String,nil]
       def http_status
         @opts[':status']
       end
 
+      # @param key [String]
+      # @param val [String]
+      # @return [void]
       def add(key, val)
         @opts[key] = val
       end