Class: PactBroker::Api::Resources::ErrorHandler

Inherits:
Object
  • Object
show all
Includes:
Logging
Defined in:
lib/pact_broker/api/resources/error_handler.rb

Class Method Summary collapse

Methods included from Logging

included, #log_error

Class Method Details

.call(e, request, response) ⇒ Object 



13
14
15
16
17
18
19
 
# File 'lib/pact_broker/api/resources/error_handler.rb', line 13

def self.call e, request, response
  error_reference = SecureRandom.urlsafe_base64.gsub(/[^a-z]/i, '')[0,10]
  logger.error "#{e.message} - error reference #{error_reference}"
  logger.error e.backtrace
  response.body = response_body_hash(e, error_reference).to_json
  report(e, error_reference, request) if reportable?(e)
end

.display_message(e, error_reference) ⇒ Object 



25
26
27
28
29
30
31
 
# File 'lib/pact_broker/api/resources/error_handler.rb', line 25

def self.display_message(e, error_reference)
  if PactBroker.configuration.show_backtrace_in_error_response?
    e.message
  else
   reportable?(e) ? obfuscated_error_message(error_reference) : e.message
  end
end

.obfuscated_error_message(error_reference) ⇒ Object 



33
34
35
 
# File 'lib/pact_broker/api/resources/error_handler.rb', line 33

def self.obfuscated_error_message error_reference
  "An error has occurred. The details have been logged with the reference #{error_reference}"
end

.report(e, error_reference, request) ⇒ Object 



50
51
52
53
54
55
56
57
58
 
# File 'lib/pact_broker/api/resources/error_handler.rb', line 50

def self.report e, error_reference, request
  PactBroker.configuration.api_error_reporters.each do | error_notifier |
    begin
      error_notifier.call(e, env: Webmachine::ConvertRequestToRackEnv.call(request), error_reference: error_reference)
    rescue StandardError => e
      log_error(e, "Error executing api_error_reporter")
    end
  end
end

.reportable?(e) ⇒ Boolean

Returns:

  • (Boolean) 


21
22
23
 
# File 'lib/pact_broker/api/resources/error_handler.rb', line 21

def self.reportable? e
  !e.is_a?(PactBroker::Error)
end

.response_body_hash(e, error_reference) ⇒ Object 



37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/pact_broker/api/resources/error_handler.rb', line 37

def self.response_body_hash e, error_reference
  response_body = {
    error: {
      message: display_message(e, error_reference),
      reference: error_reference
    }
  }
  if PactBroker.configuration.show_backtrace_in_error_response?
    response_body[:error][:backtrace] = e.backtrace
  end
  response_body
end