grpc_kit 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7b605bf4f8cf8486b85fbb391296e0e9acb21ca00efc29850271e9890b6a386
-  data.tar.gz: cc8597e07c5e467c249dc78a4ad5f02fc811410039e7eadaecfe176ae9dc3b20
+  metadata.gz: c0f50bc31421b7a051756b64bc75d4622e1a66932e919fa2a10d7bc915716969
+  data.tar.gz: 1e881d306e7c88a6a91da602e2771659fe230c523aedaae96e461621091bec70
 SHA512:
-  metadata.gz: fb29d063711fa507ff5d85a6bd9ef7e7fac86ffb4502947ab144feea453a01901ee9fc14c05e0a10a2a10d0b73fbfc1ee4e0dcc58b1c4ccf5ef9b6b974295548
-  data.tar.gz: 9e98bb7709c5bdc49683e57d9134877d8ec558feff9d1081a1f49e76afc47969172843f5b4669b8d84f74a826bb58a58372840f8011f82bd7a1bca3b2ec76e58
+  metadata.gz: 878f6c4a966f9e7af45dc3c57dcb865c93324c21c382439a5b552f67e4dab1ee09f87795af661e39df9cadaf78a20975201fae6af94f2b0b770691369608de55
+  data.tar.gz: 2e7332f3177f51efdc4f625755dbd92a5f5cdea063635eea1d6a1a75bc499ea87af57633903e12e6aebf5da5ddef028ddecc818bb71623a85b1d995c59e065a6

data/examples/helloworld_client.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 
 $LOAD_PATH.unshift File.expand_path('./examples/helloworld')
 

data/examples/routeguide_client.rb

@@ -49,6 +49,8 @@ def list_features(stub)
 end
 
 def record_route(stub, size)
+  $logger.info('===== record_route =====')
+
   features = File.open(RESOURCE_PATH) do |f|
     JSON.parse(f.read)
   end
@@ -67,6 +69,36 @@ def record_route(stub, size)
   puts "summary: #{resp[0].inspect}"
 end
 
+ROUTE_CHAT_NOTES = [
+  Routeguide::RouteNote.new(message: 'First message', location: Routeguide::Point.new(latitude: 0, longitude: 1)),
+  Routeguide::RouteNote.new(message: 'Second message', location: Routeguide::Point.new(latitude: 0, longitude: 2)),
+  Routeguide::RouteNote.new(message: 'Third message', location: Routeguide::Point.new(latitude: 0, longitude: 3)),
+  Routeguide::RouteNote.new(message: 'Fourth message', location: Routeguide::Point.new(latitude: 0, longitude: 1)),
+  Routeguide::RouteNote.new(message: 'Fifth message', location: Routeguide::Point.new(latitude: 0, longitude: 2)),
+  Routeguide::RouteNote.new(message: 'Sixth message', location: Routeguide::Point.new(latitude: 0, longitude: 3)),
+].freeze
+
+def route_chat(stub)
+  $logger.info('===== route_chat =====')
+
+  call = stub.route_chat({})
+
+  t = Thread.new do
+    loop do
+      rn = call.recv
+      $logger.info("Got message #{rn.message} at point point(#{rn.location.latitude}, #{rn.location.longitude})")
+    end
+  end
+
+  ROUTE_CHAT_NOTES.each do |rcn|
+    call.send_msg(rcn)
+    sleep 1
+  end
+
+  call.close_and_send
+  t.join
+end
+
 opts = {}
 
 if ENV['GRPC_INTERCEPTOR']
@@ -82,5 +114,6 @@ stub = Routeguide::RouteGuide::Stub.new(sock, **opts)
 get_feature(stub)
 list_features(stub)
 record_route(stub, 10)
+route_chat(stub)
 
 # rubocop:enable Style/GlobalVars

data/examples/routeguide_server.rb

@@ -17,6 +17,8 @@ class Server < Routeguide::RouteGuide::Service
       features = JSON.parse(f.read)
       @features = Hash[features.map { |x| [x['location'], x['name']] }]
     end
+
+    @route_notes = Hash.new { |h, k| h[k] = [] }
   end
 
   def get_feature(point, ctx)
@@ -70,6 +72,21 @@ class Server < Routeguide::RouteGuide::Service
     )
   end
 
+  def route_chat(call)
+    loop do
+      rn = call.recv
+      @logger.info("route_note location=#{rn.location.inspect}, message=#{rn.message}")
+      key = "#{rn.location.latitude} #{rn.location.longitude}"
+      saved_msgs = @route_notes[key]
+      @route_notes[key] << rn.message
+
+      saved_msgs.each do |m|
+        n = Routeguide::RouteNote.new(location: rn.location, message: m)
+        call.send_msg(n)
+      end
+    end
+  end
+
   private
 
   COORD_FACTOR = 1e7

data/lib/grpc.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
-# Compat file for xx_services_pb.rb
+# Compatible file for xx_services_pb.rb and xx_pb.rb which are created by grpc-tools gem
 require 'grpc_kit'
 require 'grpc_kit/grpc/generic_service'
 require 'grpc_kit/grpc/interceptor'
+require 'grpc_kit/grpc/logger'
 
 GRPC = GrpcKit::GRPC

data/lib/grpc_kit.rb

@@ -8,13 +8,16 @@ require 'grpc_kit/client'
 
 module GrpcKit
   class << self
+    # @param value [Logger] Any logger
     attr_writer :logger
 
+    # @return [Logger]
     def logger
       @logger ||= Logger.new(STDOUT, level: ENV['GRPC_KIT_LOGLEVEL'] || :info)
     end
 
-    # @params level [String] :debug, :info, :warn, :error, :fatal or :unknown
+    # @param level [String] :debug, :info, :warn, :error, :fatal or :unknown
+    # @return [void]
     def self.loglevel=(level)
       logger.level = level
     end

data/lib/grpc_kit/calls.rb

@@ -6,11 +6,22 @@ module GrpcKit
       Name = Struct.new(:name, :receiver)
       Reciver = Struct.new(:class)
       Klass = Struct.new(:service_name)
+
+      # @return [GrpcKit::Calls::Call::Name] gRPC method object
       attr_reader :method
 
-      # @params stream [GrpcKit::Stream::ServerStream|GrpcKit::Stream::ClientStream]
-      # @params config [GrpcKit::MethodConfig]
-      # @params metadata [Hash]
+      # @return [Symbol] gRPC method name
+      attr_reader :method_name
+
+      # @return [String] gRPC service name
+      attr_reader :service_name
+
+      # @return [Hash<String, String>] gRPC metadata
+      attr_reader :metadata
+
+      # @param stream [GrpcKit::Stream::ServerStream|GrpcKit::Stream::ClientStream]
+      # @param config [GrpcKit::MethodConfig]
+      # @param metadata [Hash<String,String>]
       def initialize(stream:, config:, metadata:, timeout: nil)
         @config = config
         @metadata = metadata
@@ -26,14 +37,17 @@ module GrpcKit
         @restrict = false
       end
 
+      # @return [void]
       def restrict_mode
         @restrict = true
       end
 
+      # @return [void]
       def normal_mode
         @restrict = false
       end
 
+      # @return [Time] deadline of this rpc call
       def deadline
         @deadline ||= @timeout.to_absolute_time
       end

data/lib/grpc_kit/calls/client_bidi_streamer.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'grpc_kit/calls'
+
+module GrpcKit
+  module Calls::Client
+    class BidiStreamer < GrpcKit::Calls::Call
+      alias outgoing_metadata metadata
+
+      def initialize(*)
+        super
+        @mutex = Mutex.new
+        @send = false
+      end
+
+      # @param data [Object] request message
+      # @param last [Boolean]
+      # @return [void]
+      def send_msg(data, last: false)
+        raise 'No method error' if @restrict
+
+        if @reason
+          raise "Upstream returns an error status: #{@reason}"
+        end
+
+        @mutex.synchronize do
+          @stream.send_msg(data, last: last, metadata: outgoing_metadata)
+        end
+
+        @send = true
+      end
+
+      # This method not is expected to be call in the main thread where #send_msg is called
+      #
+      # @param last [Boolean]
+      # @return [Object] response object
+      def recv(last: false)
+        raise 'No method error' if @restrict
+
+        sleep 0.1 until @send
+
+        loop do
+          msg = @mutex.synchronize do
+            @stream.recv_msg(last: last, blocking: false)
+          end
+
+          unless msg == :wait_readable
+            return msg
+          end
+        end
+      rescue GrpcKit::Errors::BadStatus => e
+        @reason = e
+        raise e
+      end
+
+      def close_and_send
+        @mutex.synchronize do
+          @stream.close_and_send
+        end
+      end
+    end
+  end
+end

data/lib/grpc_kit/calls/client_client_streamer.rb

@@ -5,22 +5,26 @@ require 'grpc_kit/calls'
 module GrpcKit
   module Calls::Client
     class ClientStreamer < GrpcKit::Calls::Call
-      attr_reader :deadline, :service_name, :method_name
-      attr_reader :metadata
       alias outgoing_metadata metadata
 
-      def send_msg(data, timeout: nil, last: false)
+      # @param data [Object] request message
+      # @param last [Boolean]
+      # @return [void]
+      def send_msg(data, last: false)
         raise 'No method error' if @restrict
 
-        @stream.send_msg(data, last: last, timeout: timeout, metadata: outgoing_metadata)
+        @stream.send_msg(data, last: last, metadata: outgoing_metadata)
       end
 
+      # @param last [Boolean]
+      # @return [Object] response object
       def recv(last: false)
         raise 'No method error' if @restrict
 
         @stream.recv_msg(last: last)
       end
 
+      # @return [Array<Object>] response objects
       def close_and_recv
         @stream.close_and_recv
       end

data/lib/grpc_kit/calls/client_request_response.rb

@@ -5,16 +5,19 @@ require 'grpc_kit/calls'
 module GrpcKit
   module Calls::Client
     class RequestResponse < GrpcKit::Calls::Call
-      attr_reader :deadline, :service_name, :method_name
-      attr_reader :metadata
       alias outgoing_metadata metadata
 
-      def send_msg(data, timeout: nil, last: false)
+      # @param data [Object] request message
+      # @param last [Boolean]
+      # @return [void]
+      def send_msg(data, last: false)
         raise 'No method error' if @restrict
 
-        @stream.send_msg(data, last: last, timeout: timeout, metadata: outgoing_metadata)
+        @stream.send_msg(data, last: last, metadata: outgoing_metadata)
       end
 
+      # @param last [Boolean]
+      # @return [Object] response object
       def recv(last: false)
         raise 'No method error' if @restrict
 

data/lib/grpc_kit/calls/client_server_streamer.rb

@@ -5,16 +5,19 @@ require 'grpc_kit/calls'
 module GrpcKit
   module Calls::Client
     class ServerStreamer < GrpcKit::Calls::Call
-      attr_reader :deadline, :service_name, :method_name
-      attr_reader :metadata
       alias outgoing_metadata metadata
 
-      def send_msg(data, timeout: nil, last: false)
+      # @param data [Object] request message
+      # @param last [Boolean]
+      # @return [void]
+      def send_msg(data, last: false)
         raise 'No method error' if @restrict
 
-        @stream.send_msg(data, last: last, timeout: timeout, metadata: outgoing_metadata)
+        @stream.send_msg(data, last: last, metadata: outgoing_metadata)
       end
 
+      # @param last [Boolean]
+      # @return [Object] response object
       def recv(last: false)
         raise 'No method error' if @restrict
 

data/lib/grpc_kit/calls/server_bidi_streamer.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'grpc_kit/calls'
+
+module GrpcKit
+  module Calls::Server
+    class BidiStreamer < GrpcKit::Calls::Call
+      attr_reader :outgoing_initial_metadata, :outgoing_trailing_metadata
+      alias incoming_metadata metadata
+
+      def initialize(*)
+        super
+
+        @outgoing_initial_metadata = {}
+        @outgoing_trailing_metadata = {}
+      end
+
+      # @param data [Object] request message
+      # @param last [Boolean]
+      # @return [void]
+      def send_msg(data, last: false)
+        raise 'No method error' if @restrict
+
+        @stream.send_msg(
+          data,
+          @protobuf,
+          last: last,
+          initial_metadata: @outgoing_initial_metadata,
+          trailing_metadata: @outgoing_trailing_metadata,
+          limit_size: @config.max_send_message_size,
+        )
+      end
+
+      # @param last [Boolean]
+      # @return [Object] response object
+      def recv(last: false)
+        raise 'No method error' if @restrict
+
+        @stream.recv_msg(@protobuf, last: last, limit_size: @config.max_receive_message_size)
+      end
+    end
+  end
+end

data/lib/grpc_kit/calls/server_client_streamer.rb

@@ -5,7 +5,6 @@ require 'grpc_kit/calls'
 module GrpcKit
   module Calls::Server
     class ClientStreamer < GrpcKit::Calls::Call
-      attr_reader :deadline, :metadata
       attr_reader :outgoing_initial_metadata, :outgoing_trailing_metadata
       alias incoming_metadata metadata
 
@@ -16,6 +15,9 @@ module GrpcKit
         @outgoing_trailing_metadata = {}
       end
 
+      # @param data [Object] request message
+      # @param last [Boolean]
+      # @return [void]
       def send_msg(data, last: false)
         raise 'No method error' if @restrict
 
@@ -29,6 +31,8 @@ module GrpcKit
         )
       end
 
+      # @param last [Boolean]
+      # @return [Object] response object
       def recv(last: false)
         raise 'No method error' if @restrict
 

data/lib/grpc_kit/calls/server_request_response.rb

@@ -5,7 +5,6 @@ require 'grpc_kit/calls'
 module GrpcKit
   module Calls::Server
     class RequestResponse < GrpcKit::Calls::Call
-      attr_reader :deadline, :metadata
       attr_reader :outgoing_initial_metadata, :outgoing_trailing_metadata
       alias incoming_metadata metadata
 
@@ -16,6 +15,9 @@ module GrpcKit
         @outgoing_trailing_metadata = {}
       end
 
+      # @param data [Object] request message
+      # @param last [Boolean]
+      # @return [void]
       def send_msg(data, last: false)
         raise 'No method error' if @restrict
 
@@ -29,6 +31,8 @@ module GrpcKit
         )
       end
 
+      # @param last [Boolean]
+      # @return [Object] response object
       def recv(last: false)
         raise 'No method error' if @restrict
 

data/lib/grpc_kit/calls/server_server_streamer.rb

@@ -5,7 +5,6 @@ require 'grpc_kit/calls'
 module GrpcKit
   module Calls::Server
     class ServerStreamer < GrpcKit::Calls::Call
-      attr_reader :deadline, :metadata
       attr_reader :outgoing_initial_metadata, :outgoing_trailing_metadata
       alias incoming_metadata metadata
 
@@ -16,6 +15,9 @@ module GrpcKit
         @outgoing_trailing_metadata = {}
       end
 
+      # @param data [Object] request message
+      # @param last [Boolean]
+      # @return [void]
       def send_msg(data, last: false)
         raise 'No method error' if @restrict
 
@@ -29,6 +31,8 @@ module GrpcKit
         )
       end
 
+      # @param last [Boolean]
+      # @return [Object] response object
       def recv(last: false)
         raise 'No method error' if @restrict