Class: Grape::Middleware::Error

Inherits:
Base
  • Object
show all
Defined in:
lib/grape/middleware/error.rb

Instance Attribute Summary

Attributes inherited from Base

#app, #env, #options

Instance Method Summary (collapse)

Methods inherited from Base

#after, #before, #call, #content_type, #content_type_for, #content_types, #initialize, #mime_types, #response

Constructor Details

This class inherits a constructor from Grape::Middleware::Base

Instance Method Details

- (Object) call!(env)



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
# File 'lib/grape/middleware/error.rb', line 21

def call!(env)
  @env = env

  begin
    error_response(catch(:error) do
      return @app.call(@env)
    end)
  rescue StandardError => e
    is_rescuable = rescuable?(e.class)
    if e.is_a?(Grape::Exceptions::Base) && !is_rescuable
      handler = lambda { |arg| error_response(arg) }
    else
      raise unless is_rescuable
      handler = find_handler(e.class)
    end

    handler.nil? ? handle_error(e) : exec_handler(e, &handler)
  end
end

- (Object) default_options



6
7
8
9
10
11
12
13
14
15
16
17
18
19
# File 'lib/grape/middleware/error.rb', line 6

def default_options
  {
    default_status: 500, # default status returned on error
    default_message: "",
    format: :txt,
    formatters: {},
    error_formatters: {},
    rescue_all: false, # true to rescue all exceptions
    rescue_subclasses: true, # rescue subclasses of exceptions listed
    rescue_options: { backtrace: false }, # true to display backtrace
    rescue_handlers: {}, # rescue handler blocks
    base_only_rescue_handlers: {} # rescue handler blocks rescuing only the base class
  }
end

- (Object) error_response(error = {})



63
64
65
66
67
68
69
70
# File 'lib/grape/middleware/error.rb', line 63

def error_response(error = {})
  status = error[:status] || options[:default_status]
  message = error[:message] || options[:default_message]
  headers = { 'Content-Type' => content_type }
  headers.merge!(error[:headers]) if error[:headers].is_a?(Hash)
  backtrace = error[:backtrace] || []
  rack_response(format_message(message, backtrace), status, headers)
end

- (Object) exec_handler(e, &handler)



51
52
53
54
55
56
57
# File 'lib/grape/middleware/error.rb', line 51

def exec_handler(e, &handler)
  if handler.lambda? && handler.arity == 0
    instance_exec(&handler)
  else
    instance_exec(e, &handler)
  end
end

- (Object) find_handler(klass)



41
42
43
44
45
# File 'lib/grape/middleware/error.rb', line 41

def find_handler(klass)
  handler = options[:rescue_handlers].find(-> { [] }) { |error, _| klass <= error }[1]
  handler = options[:base_only_rescue_handlers][klass] || options[:base_only_rescue_handlers][:all] unless handler
  handler
end

- (Object) format_message(message, backtrace)



76
77
78
79
80
81
# File 'lib/grape/middleware/error.rb', line 76

def format_message(message, backtrace)
  format = env['api.format'] || options[:format]
  formatter = Grape::ErrorFormatter::Base.formatter_for(format, options)
  throw :error, status: 406, message: "The requested format '#{format}' is not supported." unless formatter
  formatter.call(message, backtrace, options, env)
end

- (Object) handle_error(e)



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

def handle_error(e)
  error_response(message: e.message, backtrace: e.backtrace)
end

- (Object) rack_response(message, status = options[:default_status], headers = { 'Content-Type' => content_type })



72
73
74
# File 'lib/grape/middleware/error.rb', line 72

def rack_response(message, status = options[:default_status], headers = { 'Content-Type' => content_type })
  Rack::Response.new([message], status, headers).finish
end

- (Boolean) rescuable?(klass)



47
48
49
# File 'lib/grape/middleware/error.rb', line 47

def rescuable?(klass)
  options[:rescue_all] || (options[:rescue_handlers] || []).any? { |error, handler| klass <= error } || (options[:base_only_rescue_handlers] || []).include?(klass)
end