Class: ActionDispatch::ExceptionWrapper

Inherits:
Object
  • Object
show all
Defined in:
lib/action_dispatch/middleware/exception_wrapper.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(backtrace_cleaner, exception) ⇒ ExceptionWrapper

Returns a new instance of ExceptionWrapper.



46
47
48
49
50
51
52
53
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 46

def initialize(backtrace_cleaner, exception)
  @backtrace_cleaner = backtrace_cleaner
  @exception = exception
  @exception_class_name = @exception.class.name
  @wrapped_causes = wrapped_causes_for(exception, backtrace_cleaner)

  expand_backtrace if exception.is_a?(SyntaxError) || exception.cause.is_a?(SyntaxError)
end

Instance Attribute Details

#backtrace_cleaner ⇒ Object (readonly)

Returns the value of attribute backtrace_cleaner.



44
45
46
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 44

def backtrace_cleaner
  @backtrace_cleaner
end

#exception ⇒ Object (readonly)

Returns the value of attribute exception.



44
45
46
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 44

def exception
  @exception
end

#file ⇒ Object (readonly)

Returns the value of attribute file.



44
45
46
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 44

def file
  @file
end

#line_number ⇒ Object (readonly)

Returns the value of attribute line_number.



44
45
46
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 44

def line_number
  @line_number
end

#wrapped_causes ⇒ Object (readonly)

Returns the value of attribute wrapped_causes.



44
45
46
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 44

def wrapped_causes
  @wrapped_causes
end

Class Method Details

.status_code_for_exception(class_name) ⇒ Object 



117
118
119
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 117

def self.status_code_for_exception(class_name)
  Rack::Utils.status_code(@@rescue_responses[class_name])
end

Instance Method Details

#application_trace ⇒ Object 



77
78
79
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 77

def application_trace
  clean_backtrace(:silent)
end

#exception_trace ⇒ Object 



71
72
73
74
75
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 71

def exception_trace
  trace = application_trace
  trace = framework_trace if trace.empty? && !silent_exceptions.include?(@exception_class_name)
  trace
end

#framework_trace ⇒ Object 



81
82
83
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 81

def framework_trace
  clean_backtrace(:noise)
end

#full_trace ⇒ Object 



85
86
87
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 85

def full_trace
  clean_backtrace(:all)
end

#rescue_response? ⇒ Boolean

Returns:

  • (Boolean) 


121
122
123
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 121

def rescue_response?
  @@rescue_responses.key?(exception.class.name)
end

#rescue_template ⇒ Object 



63
64
65
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 63

def rescue_template
  @@rescue_templates[@exception_class_name]
end

#source_extracts ⇒ Object 



125
126
127
128
129
130
131
132
133
134
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 125

def source_extracts
  backtrace.map do |trace|
    file, line_number = extract_file_and_line_number(trace)

    {
      code: source_fragment(file, line_number),
      line_number: line_number
    }
  end
end

#source_to_show_id ⇒ Object 



144
145
146
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 144

def source_to_show_id
  (traces[trace_to_show].first || {})[:id]
end

#status_code ⇒ Object 



67
68
69
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 67

def status_code
  self.class.status_code_for_exception(unwrapped_exception.class.name)
end

#trace_to_show ⇒ Object 



136
137
138
139
140
141
142
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 136

def trace_to_show
  if traces["Application Trace"].empty? && rescue_template != "routing_error"
    "Full Trace"
  else
    "Application Trace"
  end
end

#traces ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 89

def traces
  application_trace_with_ids = []
  framework_trace_with_ids = []
  full_trace_with_ids = []

  full_trace.each_with_index do |trace, idx|
    trace_with_id = {
      exception_object_id: @exception.object_id,
      id: idx,
      trace: trace
    }

    if application_trace.include?(trace)
      application_trace_with_ids << trace_with_id
    else
      framework_trace_with_ids << trace_with_id
    end

    full_trace_with_ids << trace_with_id
  end

  {
    "Application Trace" => application_trace_with_ids,
    "Framework Trace" => framework_trace_with_ids,
    "Full Trace" => full_trace_with_ids
  }
end

#unwrapped_exception ⇒ Object 



55
56
57
58
59
60
61
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 55

def unwrapped_exception
  if wrapper_exceptions.include?(@exception_class_name)
    exception.cause
  else
    exception
  end
end