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
- MAX_METADATA_SIZE =
Default limit on trailing metadata is 8KB. We need to be careful not to overflow this limit, or the response message will never be sent. Instead, resource_exhausted will be thrown.
7.5 * 1_024
- METADATA_SIZE_EXCEEDED_CODE =
'metadata_size_exceeded'
- METADATA_SIZE_EXCEEDED_MSG =
'Metadata too long, risks exceeding http2 trailing metadata limit.'
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 ⇒ Errors::DebugInfo
that can be used to 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
Update the trailing metadata on the given gRPC call, including the error payload if configured to do so.
-
#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
83 84 85 86 87 88 89 |
# File 'lib/gruf/error.rb', line 83 def initialize(args = {}) @field_errors = [] @metadata = {} args.each do |k, v| send("#{k}=", v) if respond_to?(k) end 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.
65 66 67 |
# File 'lib/gruf/error.rb', line 65 def app_code @app_code end |
#code ⇒ Symbol
Returns The given internal gRPC code for the error.
63 64 65 |
# File 'lib/gruf/error.rb', line 63 def code @code end |
#debug_info ⇒ Errors::DebugInfo
that can be used to debug an given error response. This is sent by the server over the trailing metadata.
72 73 74 |
# File 'lib/gruf/error.rb', line 72 def debug_info @debug_info end |
#field_errors ⇒ Array
Returns An array of field errors that can be returned by the server.
69 70 71 |
# File 'lib/gruf/error.rb', line 69 def field_errors @field_errors end |
#grpc_error ⇒ GRPC::BadStatus
Return the appropriately mapped GRPC::BadStatus error object for this error
201 202 203 204 |
# File 'lib/gruf/error.rb', line 201 def grpc_error md = @metadata || {} @grpc_error = grpc_class.new(, **md) end |
#message ⇒ String
Returns The error message returned by the server.
67 68 69 |
# File 'lib/gruf/error.rb', line 67 def @message end |
#metadata ⇒ Hash
Returns The trailing metadata that was attached to the error.
76 77 78 |
# File 'lib/gruf/error.rb', line 76 def @metadata end |
Instance Method Details
#add_field_error(field_name, error_code, message = '') ⇒ Object
Add a field error to this error package
98 99 100 |
# File 'lib/gruf/error.rb', line 98 def add_field_error(field_name, error_code, = '') @field_errors << Errors::Field.new(field_name, error_code, ) end |
#attach_to_call(active_call) ⇒ Error
Update the trailing metadata on the given gRPC call, including the error payload if configured to do so.
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 |
# File 'lib/gruf/error.rb', line 151 def attach_to_call(active_call) [Gruf..to_sym] = serialize if Gruf. return self if .empty? || !active_call || !active_call.respond_to?(:output_metadata) # Check if we've overflown the maximum size of output metadata. If so, # log a warning and replace the metadata with something smaller to avoid # resource exhausted errors. if .inspect.size > MAX_METADATA_SIZE code = METADATA_SIZE_EXCEEDED_CODE msg = METADATA_SIZE_EXCEEDED_MSG logger.warn "#{code}: #{msg} Original error: #{to_h.inspect}" err = Gruf::Error.new(code: :internal, app_code: code, message: msg) return err.attach_to_call(active_call) end active_call..update() 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.
177 178 179 |
# File 'lib/gruf/error.rb', line 177 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
107 108 109 |
# File 'lib/gruf/error.rb', line 107 def has_field_errors? @field_errors.any? end |
#serialize ⇒ String
Serialize the error for transport
137 138 139 140 |
# File 'lib/gruf/error.rb', line 137 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
118 119 120 |
# File 'lib/gruf/error.rb', line 118 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
186 187 188 189 190 191 192 193 194 |
# File 'lib/gruf/error.rb', line 186 def to_h { code: code, app_code: app_code, message: , field_errors: field_errors.map(&:to_h), debug_info: debug_info.to_h } end |