Class: ActionDispatch::ExceptionWrapper

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

Defined Under Namespace

Classes: SourceMapLocation

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.



50
51
52
53
54
55
56
57
58
59
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 50

def initialize(backtrace_cleaner, exception)
  @backtrace_cleaner = backtrace_cleaner
  @exception_class_name = exception.class.name
  @wrapped_causes = wrapped_causes_for(exception, backtrace_cleaner)
  @exception = exception
  if exception.is_a?(SyntaxError)
    @exception = ActiveSupport::SyntaxErrorProxy.new(exception)
  end
  @backtrace = build_backtrace
end

Instance Attribute Details

#backtrace_cleaner ⇒ Object (readonly)

Returns the value of attribute backtrace_cleaner.



48
49
50
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 48

def backtrace_cleaner
  @backtrace_cleaner
end

#exception ⇒ Object (readonly)

Returns the value of attribute exception.



48
49
50
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 48

def exception
  @exception
end

#exception_class_name ⇒ Object (readonly)

Returns the value of attribute exception_class_name.



48
49
50
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 48

def exception_class_name
  @exception_class_name
end

#wrapped_causes ⇒ Object (readonly)

Returns the value of attribute wrapped_causes.



48
49
50
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 48

def wrapped_causes
  @wrapped_causes
end

Class Method Details

.status_code_for_exception(class_name) ⇒ Object 



175
176
177
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 175

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

Instance Method Details

#actions ⇒ Object 



101
102
103
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 101

def actions
  ActiveSupport::ActionableError.actions(@exception)
end

#annotated_source_code ⇒ Object 



113
114
115
116
117
118
119
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 113

def annotated_source_code
  if exception.respond_to?(:annotated_source_code)
    exception.annotated_source_code
  else
    []
  end
end

#application_trace ⇒ Object 



135
136
137
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 135

def application_trace
  clean_backtrace(:silent)
end

#corrections ⇒ Object 



89
90
91
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 89

def corrections
  @exception.corrections
end

#error_highlight_available? ⇒ Boolean

Returns:

  • (Boolean) 


204
205
206
207
208
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 204

def error_highlight_available?
  # ErrorHighlight.spot with backtrace_location keyword is available since
  # error_highlight 0.4.0
  defined?(ErrorHighlight) && Gem::Version.new(ErrorHighlight::VERSION) >= Gem::Version.new("0.4.0")
end

#exception_id ⇒ Object 



234
235
236
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 234

def exception_id
  exception.object_id
end

#exception_inspect ⇒ Object 



230
231
232
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 230

def exception_inspect
  exception.inspect
end

#exception_name ⇒ Object 



222
223
224
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 222

def exception_name
  exception.cause.class.to_s
end

#exception_trace ⇒ Object 



129
130
131
132
133
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 129

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

#failures ⇒ Object 



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

def failures
  @exception.failures
end

#file_name ⇒ Object 



93
94
95
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 93

def file_name
  @exception.file_name
end

#framework_trace ⇒ Object 



139
140
141
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 139

def framework_trace
  clean_backtrace(:noise)
end

#full_trace ⇒ Object 



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

def full_trace
  clean_backtrace(:all)
end

#has_cause? ⇒ Boolean

Returns:

  • (Boolean) 


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

def has_cause?
  @exception.cause
end

#has_corrections? ⇒ Boolean

Returns:

  • (Boolean) 


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

def has_corrections?
  @exception.respond_to?(:original_message) && @exception.respond_to?(:corrections)
end

#line_number ⇒ Object 



97
98
99
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 97

def line_number
  @exception.line_number
end

#message ⇒ Object 



226
227
228
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 226

def message
  exception.message
end

#original_message ⇒ Object 



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

def original_message
  @exception.original_message
end

#rescue_response? ⇒ Boolean

Returns:

  • (Boolean) 


194
195
196
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 194

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

#rescue_template ⇒ Object 



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

def rescue_template
  @@rescue_templates[@exception_class_name]
end

#routing_error? ⇒ Boolean

Returns:

  • (Boolean) 


61
62
63
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 61

def routing_error?
  @exception.is_a?(ActionController::RoutingError)
end

#show?(request) ⇒ Boolean

Returns:

  • (Boolean) 


179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 179

def show?(request)
  # We're treating `nil` as "unset", and we want the default setting to be `:all`.
  # This logic should be extracted to `env_config` and calculated once.
  config = request.get_header("action_dispatch.show_exceptions")

  case config
  when :none
    false
  when :rescuable
    rescue_response?
  else
    true
  end
end

#source_extracts ⇒ Object 



198
199
200
201
202
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 198

def source_extracts
  backtrace.map do |trace|
    extract_source(trace)
  end
end

#source_to_show_id ⇒ Object 



218
219
220
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 218

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

#status_code ⇒ Object 



125
126
127
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 125

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

#sub_template_message ⇒ Object 



69
70
71
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 69

def sub_template_message
  @exception.sub_template_message
end

#template_error? ⇒ Boolean

Returns:

  • (Boolean) 


65
66
67
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 65

def template_error?
  @exception.is_a?(ActionView::Template::Error)
end

#trace_to_show ⇒ Object 



210
211
212
213
214
215
216
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 210

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

#traces ⇒ Object 



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 147

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 



105
106
107
108
109
110
111
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 105

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