Class: RubyReactor::Failure

Inherits:
Object
  • Object
show all
Defined in:
lib/ruby_reactor.rb

Direct Known Subclasses

MaxRetriesExhaustedFailure

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(error, retryable: nil, step_name: nil, inputs: {}, backtrace: nil, redact_inputs: [], reactor_name: nil, step_arguments: {}, exception_class: nil, file_path: nil, line_number: nil, code_snippet: nil, invalid_payload: false, validation_errors: nil) ⇒ Failure

rubocop:disable Metrics/ParameterLists, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/ruby_reactor.rb', line 94

def initialize(error, retryable: nil, step_name: nil, inputs: {}, backtrace: nil, redact_inputs: [],
               reactor_name: nil, step_arguments: {}, exception_class: nil,
               file_path: nil, line_number: nil, code_snippet: nil, invalid_payload: false, validation_errors: nil)
  # rubocop:enable Metrics/ParameterLists, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
  @error = error

  # Handle case where error is a serialized hash (e.g. from async failure propagation)
  if @error.is_a?(Hash)
    attributes = extract_attributes_from_hash(@error)
    @error = attributes[:error]
    retryable = attributes[:retryable] if retryable.nil?
    step_name ||= attributes[:step_name]
    reactor_name ||= attributes[:reactor_name]
    inputs = attributes[:inputs] if inputs.empty?
    step_arguments = attributes[:step_arguments] if step_arguments.empty?
    raw_backtrace ||= attributes[:backtrace] || backtrace
    exception_class ||= attributes[:exception_class]
    file_path ||= attributes[:file_path]
    line_number ||= attributes[:line_number]
    code_snippet ||= attributes[:code_snippet]
    validation_errors ||= attributes[:validation_errors]
  end

  @retryable = if retryable.nil?
                 @error.respond_to?(:retryable?) ? @error.retryable? : true
               else
                 retryable
               end
  @step_name = step_name
  @reactor_name = reactor_name
  @inputs = inputs
  @step_arguments = step_arguments
  raw_backtrace ||= backtrace || (@error.respond_to?(:backtrace) ? @error.backtrace : caller)
  @backtrace = filter_backtrace(raw_backtrace)
  @redact_inputs = redact_inputs
  @exception_class = exception_class || (@error.is_a?(Exception) ? @error.class.name : nil)
  @file_path = file_path
  @line_number = line_number
  @code_snippet = code_snippet
  @invalid_payload = invalid_payload
  @validation_errors = validation_errors
end

Instance Attribute Details

#backtrace ⇒ Object (readonly)

Returns the value of attribute backtrace.



90
91
92
 
# File 'lib/ruby_reactor.rb', line 90

def backtrace
  @backtrace
end

#code_snippet ⇒ Object (readonly)

Returns the value of attribute code_snippet.



90
91
92
 
# File 'lib/ruby_reactor.rb', line 90

def code_snippet
  @code_snippet
end

#error ⇒ Object (readonly)

Returns the value of attribute error.



90
91
92
 
# File 'lib/ruby_reactor.rb', line 90

def error
  @error
end

#exception_class ⇒ Object (readonly)

Returns the value of attribute exception_class.



90
91
92
 
# File 'lib/ruby_reactor.rb', line 90

def exception_class
  @exception_class
end

#file_path ⇒ Object (readonly)

Returns the value of attribute file_path.



90
91
92
 
# File 'lib/ruby_reactor.rb', line 90

def file_path
  @file_path
end

#inputs ⇒ Object (readonly)

Returns the value of attribute inputs.



90
91
92
 
# File 'lib/ruby_reactor.rb', line 90

def inputs
  @inputs
end

#line_number ⇒ Object (readonly)

Returns the value of attribute line_number.



90
91
92
 
# File 'lib/ruby_reactor.rb', line 90

def line_number
  @line_number
end

#reactor_name ⇒ Object (readonly)

Returns the value of attribute reactor_name.



90
91
92
 
# File 'lib/ruby_reactor.rb', line 90

def reactor_name
  @reactor_name
end

#retryable ⇒ Object (readonly)

Returns the value of attribute retryable.



90
91
92
 
# File 'lib/ruby_reactor.rb', line 90

def retryable
  @retryable
end

#step_arguments ⇒ Object (readonly)

Returns the value of attribute step_arguments.



90
91
92
 
# File 'lib/ruby_reactor.rb', line 90

def step_arguments
  @step_arguments
end

#step_name ⇒ Object (readonly)

Returns the value of attribute step_name.



90
91
92
 
# File 'lib/ruby_reactor.rb', line 90

def step_name
  @step_name
end

#validation_errors ⇒ Object (readonly)

Returns the value of attribute validation_errors.



90
91
92
 
# File 'lib/ruby_reactor.rb', line 90

def validation_errors
  @validation_errors
end

Instance Method Details

#failure? ⇒ Boolean

Returns:

  • (Boolean) 


141
142
143
 
# File 'lib/ruby_reactor.rb', line 141

def failure?
  true
end

#invalid_payload? ⇒ Boolean

Returns:

  • (Boolean) 


153
154
155
 
# File 'lib/ruby_reactor.rb', line 153

def invalid_payload?
  @invalid_payload
end

#message ⇒ Object 



157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/ruby_reactor.rb', line 157

def message
  msg = [build_header]
  msg << "Location: #{file_path}:#{line_number}" if file_path && line_number

  append_code_snippet(msg)
  append_inputs(msg)
  append_step_arguments(msg)
  append_backtrace(msg)

  msg.join("\n")
end

#retryable? ⇒ Boolean

Returns:

  • (Boolean) 


145
146
147
 
# File 'lib/ruby_reactor.rb', line 145

def retryable?
  @retryable
end

#skipped? ⇒ Boolean

Returns:

  • (Boolean) 


149
150
151
 
# File 'lib/ruby_reactor.rb', line 149

def skipped?
  false
end

#success? ⇒ Boolean

Returns:

  • (Boolean) 


137
138
139
 
# File 'lib/ruby_reactor.rb', line 137

def success?
  false
end

#to_h ⇒ Object 



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/ruby_reactor.rb', line 173

def to_h
  {
    success: false,
    error: error_message,
    step_name: @step_name,
    inputs: @inputs,
    redact_inputs: @redact_inputs,
    reactor_name: @reactor_name,
    step_arguments: @step_arguments,
    exception_class: @exception_class,
    file_path: @file_path,
    line_number: @line_number,
    code_snippet: @code_snippet,
    validation_errors: @validation_errors,
    backtrace: @backtrace
  }
end

#to_s ⇒ Object 



169
170
171
 
# File 'lib/ruby_reactor.rb', line 169

def to_s
  message
end