Class: Gruf::Error
Overview
Represents a error that can be transformed into a gRPC error and have metadata attached to the trailing headers. This layer acts as an middle layer that can have metadata injection, tracing support, and other functionality not present in the gRPC core.
Constant Summary collapse
- TYPES =
Returns A hash mapping of gRPC BadStatus codes to error symbols.
{ ok: GRPC::Ok, cancelled: GRPC::Cancelled, unknown: GRPC::Unknown, invalid_argument: GRPC::InvalidArgument, bad_request: GRPC::InvalidArgument, deadline_exceeded: GRPC::DeadlineExceeded, not_found: GRPC::NotFound, already_exists: GRPC::AlreadyExists, unauthorized: GRPC::PermissionDenied, permission_denied: GRPC::PermissionDenied, unauthenticated: GRPC::Unauthenticated, resource_exhausted: GRPC::ResourceExhausted, failed_precondition: GRPC::FailedPrecondition, aborted: GRPC::Aborted, out_of_range: GRPC::OutOfRange, unimplemented: GRPC::Unimplemented, internal: GRPC::Internal, unavailable: GRPC::Unavailable, data_loss: GRPC::DataLoss }.freeze
Instance Attribute Summary collapse
-
#app_code ⇒ Symbol
An arbitrary application code that can be used for logical processing of the error by the client.
-
#code ⇒ Symbol
The given internal gRPC code for the error.
-
#debug_info ⇒ Object
debug an given error response.
-
#field_errors ⇒ Array
An array of field errors that can be returned by the server.
-
#grpc_error ⇒ GRPC::BadStatus
Return the appropriately mapped GRPC::BadStatus error object for this error.
-
#message ⇒ String
The error message returned by the server.
-
#metadata ⇒ Hash
The trailing metadata that was attached to the error.
Instance Method Summary collapse
-
#add_field_error(field_name, error_code, message = '') ⇒ Object
Add a field error to this error package.
-
#attach_to_call(active_call) ⇒ Error
Append any appropriate errors to the gRPC call and properly update the output metadata.
-
#fail!(active_call) ⇒ GRPC::BadStatus
Fail the current gRPC call with the given error, properly attaching it to the call and raising the appropriate gRPC BadStatus code.
-
#has_field_errors? ⇒ Boolean
Return true if there are any present field errors.
-
#initialize(args = {}) ⇒ Error
constructor
Initialize the error, setting default values.
-
#serialize ⇒ String
Serialize the error for transport.
-
#set_debug_info(detail, stack_trace = []) ⇒ Object
Set the debugging information for the error message.
-
#to_h ⇒ Hash
Return the error represented in Hash form.
Methods included from Loggable
Constructor Details
#initialize(args = {}) ⇒ Error
Initialize the error, setting default values
74 75 76 77 78 79 |
# File 'lib/gruf/error.rb', line 74 def initialize(args = {}) args.each do |k, v| send("#{k}=", v) if respond_to?(k) end @field_errors = [] end |
Instance Attribute Details
#app_code ⇒ Symbol
Returns An arbitrary application code that can be used for logical processing of the error by the client.
56 57 58 |
# File 'lib/gruf/error.rb', line 56 def app_code @app_code end |
#code ⇒ Symbol
Returns The given internal gRPC code for the error.
54 55 56 |
# File 'lib/gruf/error.rb', line 54 def code @code end |
#debug_info ⇒ Object
debug an given error response. This is sent by the server over the trailing metadata.
63 64 65 |
# File 'lib/gruf/error.rb', line 63 def debug_info @debug_info end |
#field_errors ⇒ Array
Returns An array of field errors that can be returned by the server.
60 61 62 |
# File 'lib/gruf/error.rb', line 60 def field_errors @field_errors end |
#grpc_error ⇒ GRPC::BadStatus
Return the appropriately mapped GRPC::BadStatus error object for this error
177 178 179 |
# File 'lib/gruf/error.rb', line 177 def grpc_error @grpc_error = grpc_class.new(, **@metadata) end |
#message ⇒ String
Returns The error message returned by the server.
58 59 60 |
# File 'lib/gruf/error.rb', line 58 def @message end |
#metadata ⇒ Hash
Returns The trailing metadata that was attached to the error.
67 68 69 |
# File 'lib/gruf/error.rb', line 67 def @metadata end |
Instance Method Details
#add_field_error(field_name, error_code, message = '') ⇒ Object
Add a field error to this error package
88 89 90 |
# File 'lib/gruf/error.rb', line 88 def add_field_error(field_name, error_code, = '') @field_errors << Errors::Field.new(field_name, error_code, ) end |
#attach_to_call(active_call) ⇒ Error
Append any appropriate errors to the gRPC call and properly update the output metadata
138 139 140 141 142 143 144 |
# File 'lib/gruf/error.rb', line 138 def attach_to_call(active_call) [Gruf..to_sym] = serialize if Gruf. if !.empty? && active_call && active_call.respond_to?(:output_metadata) active_call..update() end self end |
#fail!(active_call) ⇒ GRPC::BadStatus
Fail the current gRPC call with the given error, properly attaching it to the call and raising the appropriate gRPC BadStatus code.
153 154 155 |
# File 'lib/gruf/error.rb', line 153 def fail!(active_call) raise attach_to_call(active_call).grpc_error end |
#has_field_errors? ⇒ Boolean
Return true if there are any present field errors
97 98 99 |
# File 'lib/gruf/error.rb', line 97 def has_field_errors? @field_errors.any? end |
#serialize ⇒ String
Serialize the error for transport
127 128 129 130 |
# File 'lib/gruf/error.rb', line 127 def serialize serializer = serializer_class.new(self) serializer.serialize.to_s end |
#set_debug_info(detail, stack_trace = []) ⇒ Object
Set the debugging information for the error message
service
108 109 110 |
# File 'lib/gruf/error.rb', line 108 def set_debug_info(detail, stack_trace = []) @debug_info = Errors::DebugInfo.new(detail, stack_trace) end |
#to_h ⇒ Hash
Return the error represented in Hash form
162 163 164 165 166 167 168 169 170 |
# File 'lib/gruf/error.rb', line 162 def to_h { code: code, app_code: app_code, message: , field_errors: field_errors.map(&:to_h), debug_info: debug_info.to_h } end |