Class: Gruf::Error

Inherits:
Object
  • Object
show all
Includes:
Loggable
Defined in:
lib/gruf/error.rb

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.

Returns:

  • (Hash<GRPC::BadStatus>) —

    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

Instance Method Summary collapse

Methods included from Loggable

#logger

Constructor Details

#initialize(args = {}) ⇒ Error

Initialize the error, setting default values

Parameters:

  • args (Hash) (defaults to: {}) —

    (Optional) An optional hash of arguments that will set fields on the error object



75
76
77
78
79
80
 
# File 'lib/gruf/error.rb', line 75

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.

Returns:

  • (Symbol) —

    An arbitrary application code that can be used for logical processing of the error by the client



57
58
59
 
# File 'lib/gruf/error.rb', line 57

def app_code
  @app_code
end

#code ⇒ Symbol

Returns The given internal gRPC code for the error.

Returns:

  • (Symbol) —

    The given internal gRPC code for the error



55
56
57
 
# File 'lib/gruf/error.rb', line 55

def code
  @code
end

#debug_info ⇒ Object

debug an given error response. This is sent by the server over the trailing metadata.

Returns:

  • (Object) —

    A hash of debugging information, such as a stack trace and exception name, that can be used to



64
65
66
 
# File 'lib/gruf/error.rb', line 64

def debug_info
  @debug_info
end

#field_errors ⇒ Array

Returns An array of field errors that can be returned by the server.

Returns:

  • (Array) —

    An array of field errors that can be returned by the server



61
62
63
 
# File 'lib/gruf/error.rb', line 61

def field_errors
  @field_errors
end

#grpc_error ⇒ GRPC::BadStatus

Return the appropriately mapped GRPC::BadStatus error object for this error

Returns:

  • (GRPC::BadStatus) 


66
67
68
 
# File 'lib/gruf/error.rb', line 66

def grpc_error
  @grpc_error
end

#message ⇒ String

Returns The error message returned by the server.

Returns:

  • (String) —

    The error message returned by the server



59
60
61
 
# File 'lib/gruf/error.rb', line 59

def message
  @message
end

#metadata ⇒ Hash

Returns The trailing metadata that was attached to the error.

Returns:

  • (Hash) —

    The trailing metadata that was attached to the error



68
69
70
 
# File 'lib/gruf/error.rb', line 68

def metadata
  @metadata
end

Instance Method Details

#add_field_error(field_name, error_code, message = '') ⇒ Object

Add a field error to this error package

Parameters:

  • field_name (Symbol) —

    The field name for the error

  • error_code (Symbol) —

    The application error code for the error; e.g. :job_not_found

  • message (String) (defaults to: '') —

    The application error message for the error; e.g. “Job not found with ID 123”



89
90
91
 
# File 'lib/gruf/error.rb', line 89

def add_field_error(field_name, error_code, message = '')
  @field_errors << Errors::Field.new(field_name, error_code, message)
end

#attach_to_call(active_call) ⇒ Error

Append any appropriate errors to the gRPC call and properly update the output metadata

Parameters:

  • active_call (GRPC::ActiveCall) —

    The marshalled gRPC call

Returns:

  • (Error) —

    Return the error itself with the GRPC::ActiveCall attached and error metadata appended



129
130
131
132
133
134
135
 
# File 'lib/gruf/error.rb', line 129

def attach_to_call(active_call)
  metadata[Gruf.error_metadata_key.to_sym] = serialize if Gruf.append_server_errors_to_trailing_metadata
  if !metadata.empty? && active_call && active_call.respond_to?(:output_metadata)
    active_call.output_metadata.update(metadata)
  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.

Parameters:

  • active_call (GRPC::ActiveCall) —

    The marshalled gRPC call

Returns:

  • (GRPC::BadStatus) —

    The gRPC BadStatus code this error is mapped to



144
145
146
 
# File 'lib/gruf/error.rb', line 144

def fail!(active_call)
  raise attach_to_call(active_call).grpc_error
end

#serialize ⇒ String

Serialize the error for transport

Returns:

  • (String) —

    The serialized error message



118
119
120
121
 
# File 'lib/gruf/error.rb', line 118

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

Parameters:

  • detail (String) —

    The detailed message generated by the exception

  • stack_trace (Array<String>) (defaults to: []) —

    An array of strings that represents the exception backtrace generated by the



100
101
102
 
# File 'lib/gruf/error.rb', line 100

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

Returns:

  • (Hash) —

    The error as a hash



153
154
155
156
157
158
159
160
161
 
# File 'lib/gruf/error.rb', line 153

def to_h
  {
    code: code,
    app_code: app_code,
    message: message,
    field_errors: field_errors.map(&:to_h),
    debug_info: debug_info.to_h
  }
end