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.



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

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.



46
47
48
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 46

def backtrace_cleaner
  @backtrace_cleaner
end

#exception ⇒ Object (readonly)

Returns the value of attribute exception.



46
47
48
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 46

def exception
  @exception
end

#exception_class_name ⇒ Object (readonly)

Returns the value of attribute exception_class_name.



46
47
48
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 46

def exception_class_name
  @exception_class_name
end

#wrapped_causes ⇒ Object (readonly)

Returns the value of attribute wrapped_causes.



46
47
48
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 46

def wrapped_causes
  @wrapped_causes
end

Class Method Details

.status_code_for_exception(class_name) ⇒ Object 



173
174
175
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 173

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

Instance Method Details

#actions ⇒ Object 



99
100
101
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 99

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

#annotated_source_code ⇒ Object 



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

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

#application_trace ⇒ Object 



133
134
135
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 133

def application_trace
  clean_backtrace(:silent)
end

#corrections ⇒ Object 



87
88
89
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 87

def corrections
  @exception.corrections
end

#error_highlight_available? ⇒ Boolean

Returns:

  • (Boolean) 


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

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 



239
240
241
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 239

def exception_id
  exception.object_id
end

#exception_inspect ⇒ Object 



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

def exception_inspect
  exception.inspect
end

#exception_name ⇒ Object 



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

def exception_name
  exception.cause.class.to_s
end

#exception_trace ⇒ Object 



127
128
129
130
131
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 127

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

#failures ⇒ Object 



75
76
77
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 75

def failures
  @exception.failures
end

#file_name ⇒ Object 



91
92
93
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 91

def file_name
  @exception.file_name
end

#framework_trace ⇒ Object 



137
138
139
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 137

def framework_trace
  clean_backtrace(:noise)
end

#full_trace ⇒ Object 



141
142
143
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 141

def full_trace
  clean_backtrace(:all)
end

#has_cause? ⇒ Boolean

Returns:

  • (Boolean) 


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

def has_cause?
  @exception.cause
end

#has_corrections? ⇒ Boolean

Returns:

  • (Boolean) 


79
80
81
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 79

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

#line_number ⇒ Object 



95
96
97
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 95

def line_number
  @exception.line_number
end

#message ⇒ Object 



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

def message
  exception.message
end

#original_message ⇒ Object 



83
84
85
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 83

def original_message
  @exception.original_message
end

#rescue_response? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#rescue_template ⇒ Object 



119
120
121
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 119

def rescue_template
  @@rescue_templates[@exception_class_name]
end

#routing_error? ⇒ Boolean

Returns:

  • (Boolean) 


59
60
61
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 59

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

#show?(request) ⇒ Boolean

Returns:

  • (Boolean) 


177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 177

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")

  # Include true and false for backwards compatibility.
  case config
  when :none
    false
  when :rescuable
    rescue_response?
  when true
    ActionDispatch.deprecator.warn("Setting action_dispatch.show_exceptions to true is deprecated. Set to :all instead.")
    true
  when false
    ActionDispatch.deprecator.warn("Setting action_dispatch.show_exceptions to false is deprecated. Set to :none instead.")
    false
  else
    true
  end
end

#source_extracts ⇒ Object 



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

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

#source_to_show_id ⇒ Object 



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

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

#status_code ⇒ Object 



123
124
125
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 123

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

#sub_template_message ⇒ Object 



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

def sub_template_message
  @exception.sub_template_message
end

#template_error? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#trace_to_show ⇒ Object 



215
216
217
218
219
220
221
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 215

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

#traces ⇒ Object 



145
146
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
 
# File 'lib/action_dispatch/middleware/exception_wrapper.rb', line 145

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 



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

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