mirror of https://github.com/grpc/grpc.git
Merge pull request #10340 from apolcyn/doc_ruby_errors_master
add examples for ruby error throwing and handlingpull/10349/head
commit
0ce1bb03e3
3 changed files with 218 additions and 0 deletions
@ -0,0 +1,25 @@ |
||||
#Errors and Cancelletion code samples for grpc-ruby |
||||
|
||||
The examples in this directory show use of grpc errors. |
||||
|
||||
On the server side, errors are returned from service |
||||
implementations by raising a certain `GRPC::BadStatus` exception. |
||||
|
||||
On the client side, GRPC errors get raised when either: |
||||
* the call completes (unary and client-streaming call types) |
||||
* the response `Enumerable` is iterated through (server-streaming and |
||||
bidi call types). |
||||
|
||||
## To run the examples here: |
||||
|
||||
Start the server: |
||||
|
||||
``` |
||||
> ruby error_examples_server.rb |
||||
``` |
||||
|
||||
Then run the client: |
||||
|
||||
``` |
||||
> ruby error_examples_client.rb |
||||
``` |
@ -0,0 +1,117 @@ |
||||
#!/usr/bin/env ruby |
||||
|
||||
# Copyright 2015, Google Inc. |
||||
# All rights reserved. |
||||
# |
||||
# Redistribution and use in source and binary forms, with or without |
||||
# modification, are permitted provided that the following conditions are |
||||
# met: |
||||
# |
||||
# * Redistributions of source code must retain the above copyright |
||||
# notice, this list of conditions and the following disclaimer. |
||||
# * Redistributions in binary form must reproduce the above |
||||
# copyright notice, this list of conditions and the following disclaimer |
||||
# in the documentation and/or other materials provided with the |
||||
# distribution. |
||||
# * Neither the name of Google Inc. nor the names of its |
||||
# contributors may be used to endorse or promote products derived from |
||||
# this software without specific prior written permission. |
||||
# |
||||
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
||||
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
||||
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
||||
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
||||
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
||||
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
||||
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
||||
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
||||
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
||||
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
||||
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
||||
|
||||
# Sample app that connects to an error-throwing implementation of |
||||
# Route Guide service. |
||||
# |
||||
# Usage: $ path/to/route_guide_client.rb |
||||
|
||||
this_dir = File.expand_path(File.dirname(__FILE__)) |
||||
lib_dir = File.join(File.dirname(this_dir), 'lib') |
||||
$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir) |
||||
|
||||
require 'grpc' |
||||
require 'route_guide_services_pb' |
||||
|
||||
include Routeguide |
||||
|
||||
def run_get_feature_expect_error(stub) |
||||
resp = stub.get_feature(Point.new) |
||||
end |
||||
|
||||
def run_list_features_expect_error(stub) |
||||
resps = stub.list_features(Rectangle.new) |
||||
|
||||
# NOOP iteration to pick up error |
||||
resps.each { } |
||||
end |
||||
|
||||
def run_record_route_expect_error(stub) |
||||
stub.record_route([]) |
||||
end |
||||
|
||||
def run_route_chat_expect_error(stub) |
||||
resps = stub.route_chat([]) |
||||
|
||||
# NOOP iteration to pick up error |
||||
resps.each { } |
||||
end |
||||
|
||||
def main |
||||
stub = RouteGuide::Stub.new('localhost:50051', :this_channel_is_insecure) |
||||
|
||||
begin |
||||
run_get_feature_expect_error(stub) |
||||
rescue GRPC::BadStatus => e |
||||
puts "===== GetFeature exception: =====" |
||||
puts e.inspect |
||||
puts "e.code: #{e.code}" |
||||
puts "e.details: #{e.details}" |
||||
puts "e.metadata: #{e.metadata}" |
||||
puts "=================================" |
||||
end |
||||
|
||||
begin |
||||
run_list_features_expect_error(stub) |
||||
rescue GRPC::BadStatus => e |
||||
error = true |
||||
puts "===== ListFeatures exception: =====" |
||||
puts e.inspect |
||||
puts "e.code: #{e.code}" |
||||
puts "e.details: #{e.details}" |
||||
puts "e.metadata: #{e.metadata}" |
||||
puts "=================================" |
||||
end |
||||
|
||||
begin |
||||
run_route_chat_expect_error(stub) |
||||
rescue GRPC::BadStatus => e |
||||
puts "==== RouteChat exception: ====" |
||||
puts e.inspect |
||||
puts "e.code: #{e.code}" |
||||
puts "e.details: #{e.details}" |
||||
puts "e.metadata: #{e.metadata}" |
||||
puts "=================================" |
||||
end |
||||
|
||||
begin |
||||
run_record_route_expect_error(stub) |
||||
rescue GRPC::BadStatus => e |
||||
puts "==== RecordRoute exception: ====" |
||||
puts e.inspect |
||||
puts "e.code: #{e.code}" |
||||
puts "e.details: #{e.details}" |
||||
puts "e.metadata: #{e.metadata}" |
||||
puts "=================================" |
||||
end |
||||
end |
||||
|
||||
main |
@ -0,0 +1,76 @@ |
||||
#!/usr/bin/env ruby |
||||
# -*- coding: utf-8 -*- |
||||
|
||||
# Copyright 2015, Google Inc. |
||||
# All rights reserved. |
||||
# |
||||
# Redistribution and use in source and binary forms, with or without |
||||
# modification, are permitted provided that the following conditions are |
||||
# met: |
||||
# |
||||
# * Redistributions of source code must retain the above copyright |
||||
# notice, this list of conditions and the following disclaimer. |
||||
# * Redistributions in binary form must reproduce the above |
||||
# copyright notice, this list of conditions and the following disclaimer |
||||
# in the documentation and/or other materials provided with the |
||||
# distribution. |
||||
# * Neither the name of Google Inc. nor the names of its |
||||
# contributors may be used to endorse or promote products derived from |
||||
# this software without specific prior written permission. |
||||
# |
||||
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
||||
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
||||
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
||||
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
||||
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
||||
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
||||
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
||||
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
||||
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
||||
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
||||
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
||||
|
||||
# Error-throwing implementation of Route Guide service. |
||||
# |
||||
# Usage: $ path/to/route_guide_server.rb |
||||
|
||||
this_dir = File.expand_path(File.dirname(__FILE__)) |
||||
lib_dir = File.join(File.dirname(this_dir), 'lib') |
||||
$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir) |
||||
|
||||
require 'grpc' |
||||
require 'route_guide_services_pb' |
||||
|
||||
include Routeguide |
||||
|
||||
include GRPC::Core::StatusCodes |
||||
|
||||
# CanellingandErrorReturningServiceImpl provides an implementation of the RouteGuide service. |
||||
class CancellingAndErrorReturningServerImpl < RouteGuide::Service |
||||
# def get_feature |
||||
# Note get_feature isn't implemented in this subclass, so the server |
||||
# will get a gRPC UNIMPLEMENTED error when it's called. |
||||
|
||||
def list_features(rectangle, _call) |
||||
raise "string appears on the client in the 'details' field of a 'GRPC::Unknown' exception" |
||||
end |
||||
|
||||
def record_route(call) |
||||
raise GRPC::BadStatus.new_status_exception(CANCELLED) |
||||
end |
||||
|
||||
def route_chat(notes) |
||||
raise GRPC::BadStatus.new_status_exception(ABORTED, details = 'arbitrary', metadata = {somekey: 'val'}) |
||||
end |
||||
end |
||||
|
||||
def main |
||||
port = '0.0.0.0:50051' |
||||
s = GRPC::RpcServer.new |
||||
s.add_http2_port(port, :this_port_is_insecure) |
||||
GRPC.logger.info("... running insecurely on #{port}") |
||||
s.handle(CancellingAndErrorReturningServerImpl.new) |
||||
s.run_till_terminated |
||||
end |
||||
|
||||
main |
Loading…
Reference in new issue