cookpad / grpc_kit

A kit for creating gRPC server/client in Ruby.

GrpcKit

A kit for creating gRPC server/client in Ruby.

Installation

Add this line to your application's Gemfile:

gem 'grpc_kit'

And then execute:

$ bundle

Or install it yourself as:

$ gem install grpc_kit

Usage

More Details in examples directory.

Server

sock = TCPServer.new(50051)
server = GrpcKit::Server.new
server.handle(GreeterServer.new)

loop do
  conn = sock.accept
  server.run(conn)
end

Client

sock = TCPSocket.new('localhost', 50051)
stub = Helloworld::Greeter::Stub.new(sock)
message = stub.say_hello(Helloworld::HelloRequest.new(name: 'your name')).message
puts message

Development

$ bundle install

Projects using grpc_kit

• griffin Multi process gRPC server in Ruby

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/cookpad/grpc_kit.

License

The gem is available as open source under the terms of the MIT License.

grpc_kit's Issues

Unbounded Client Streaming Bug (with repro)

Hi grpc_kit,

I've got a bug I can't debug myself. I ended up within the are of DS9 and couldn't figure out what was going on so I couldn't fix it myself.

Basically the issue I ran into was when client is streaming from an unending source it would just stop yielding messages at some point. It LOOKED like the socket stopped receiving data from what I could tell.

I've reproduced the problem (or similar) in the following git repo which has more notes. This is just a slightly hacked up routeguide so that it is unending. I'd expect it to never end, but the client starts missing messages and eventually it stops receiving all messages. This is over the course of minutes, not immediately.

https://github.com/brocktimus/grpc-kit-stream-repro

The server in this case also continue to stream, even when the client has disconnected. But I'm not as concerned about that one in my exact use case since I'm only streaming as a client and not a server.

Thanks, I really like the project. The forking server model for griffin looks fantastic.

How to get Peer IP Address by Call instance

I want to log Peer IP Address, how can i get it via Call instance? 🤔

Token-based authentication

Hi,
trying to replace grpc with grpc_kit to call regular grpc endpoint, I can call using grpc but after changing grpc_kit it has 'EOFError (EOF):' error. I thought that remote server closed connection because of applying credentials.

I coundn't find GRPC::Core::ChannelCredentials or related in grpc_kit, could you please advice ?

old code grpc , it works ;

creds = GRPC::Core::ChannelCredentials.new(nil, nil, nil)
stub = Com::VService::Speech::V1::Speech::Stub.new(SERVER, creds)
metadata = { authorization: "Bearer TokenX" , trackingid: '123'}
stub.get_recognize(req, metadata: metadata)

new with grpc_kit ( if I don't stringify_keys it raises cannot convert symbol to string error )

sock = TCPSocket.new('host.co', 443)
stub = Com::VService::Speech::V1::Speech::Stub.new(sock)
metadata = { authorization: "Bearer TokenX", trackingid: '123'}
stub.get_recognize(req, metadata: metadata.stringify_keys)

Advantages over the "official" GRPC gem

Not really an issue, but it would be nice to know what are the advantages of using this gem over the "official" one.

Exception handling?

Thank you for this light-weight alternative to grpc. I hope to be able to use it in production soon.

But first I need to ask you about exception handling. I don’t see anything mentioned in the Readme, and I find no uses of rescue in the examples/ folder. But when trying this gem out, I ended up getting a lot of GrpcKit::Session::ClientSession::ConnectionClosing exceptions. I am not sure if they are caused by the client session becoming “too old”, or if the client has gotten itself into a bad state, or something else.

Any help (and/or documentation) would be appreciated.