Class: ActionDispatch::ExceptionWrapper
| Relationships & Source Files | |
| Namespace Children | |
|
Classes:
| |
| Inherits: | Object |
| Defined in: | actionpack/lib/action_dispatch/middleware/exception_wrapper.rb |
Class Method Summary
Instance Attribute Summary
- #backtrace_cleaner readonly
- #exception readonly
- #exception_class_name readonly
- #has_cause? ⇒ Boolean readonly
- #has_corrections? ⇒ Boolean readonly
- #rescue_response? ⇒ Boolean readonly
- #rescue_responses rw
- #rescue_templates rw
- #routing_error? ⇒ Boolean readonly
- #silent_exceptions rw
- #template_error? ⇒ Boolean readonly
- #wrapped_causes readonly
- #wrapper_exceptions rw
-
#outer_exception=(value)
writeonly
protected
The exception this wrapper's exception is a cause of, whose
Template::Error, if any, knows the templates of this backtrace.
Instance Method Summary
- #actions
- #annotated_source_code
- #application_trace
- #backtrace
- #build_backtrace
-
#built_methods_for(locations)
Maps the compiled template methods that can appear in
locationsto their templates. - #causes_for(exception)
- #clean_backtrace(*args)
- #corrections
- #exception_id
- #exception_inspect
- #exception_name
- #exception_trace
- #extract_file_and_line_number(trace)
- #extract_source(trace)
- #extract_source_fragment_lines(source_lines, line)
- #failures
- #file_name
- #framework_trace
- #full_trace
- #line_number
- #message
- #original_message
- #rescue_template
- #show?(request) ⇒ Boolean
- #source_extracts
- #source_fragment(path, line)
- #source_to_show_id
- #status_code
- #sub_template_message
- #trace_to_show
- #traces
- #unwrapped_exception
- #wrapped_causes_for(exception, backtrace_cleaner)
Constructor Details
.new(backtrace_cleaner, exception) ⇒ ExceptionWrapper
# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 51
def initialize(backtrace_cleaner, exception) @outer_exception = nil @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 = nil end
Class Method Details
.status_code_for_exception(class_name)
[ GitHub ]# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 182
def self.status_code_for_exception(class_name) ActionDispatch::Response.rack_status_code(rescue_responses[class_name]) end
Instance Attribute Details
#backtrace_cleaner (readonly)
[ GitHub ]# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 49
attr_reader :backtrace_cleaner, :wrapped_causes, :exception_class_name, :exception
#exception (readonly)
[ GitHub ]# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 49
attr_reader :backtrace_cleaner, :wrapped_causes, :exception_class_name, :exception
#exception_class_name (readonly)
[ GitHub ]# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 49
attr_reader :backtrace_cleaner, :wrapped_causes, :exception_class_name, :exception
#has_cause? ⇒ Boolean (readonly)
[ GitHub ]
# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 75
def has_cause? @exception.cause end
#has_corrections? ⇒ Boolean (readonly)
[ GitHub ]
# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 83
def has_corrections? @exception.respond_to?(:) && @exception.respond_to?(:corrections) end
#outer_exception=(value) (writeonly, protected)
The exception this wrapper's exception is a cause of, whose
Template::Error, if any, knows the templates of this backtrace.
# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 242
attr_writer :outer_exception
#rescue_response? ⇒ Boolean (readonly)
[ GitHub ]
# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 201
def rescue_response? self.class.rescue_responses.key?(exception.class.name) end
#rescue_responses (rw)
[ GitHub ]# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 10
singleton_class.attr_accessor :rescue_responses, :rescue_templates, :wrapper_exceptions, :silent_exceptions
#rescue_templates (rw)
[ GitHub ]# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 10
singleton_class.attr_accessor :rescue_responses, :rescue_templates, :wrapper_exceptions, :silent_exceptions
#routing_error? ⇒ Boolean (readonly)
[ GitHub ]
# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 63
def routing_error? @exception.is_a?(ActionController::RoutingError) end
#silent_exceptions (rw)
[ GitHub ]# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 10
singleton_class.attr_accessor :rescue_responses, :rescue_templates, :wrapper_exceptions, :silent_exceptions
#template_error? ⇒ Boolean (readonly)
[ GitHub ]
# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 67
def template_error? @exception.is_a?(ActionView::Template::Error) end
#wrapped_causes (readonly)
[ GitHub ]# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 49
attr_reader :backtrace_cleaner, :wrapped_causes, :exception_class_name, :exception
#wrapper_exceptions (rw)
[ GitHub ]# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 10
singleton_class.attr_accessor :rescue_responses, :rescue_templates, :wrapper_exceptions, :silent_exceptions
Instance Method Details
#actions
[ GitHub ]# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 103
def actions ActiveSupport::ActionableError.actions(@exception) end
#annotated_source_code
[ GitHub ]#application_trace
[ GitHub ]# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 137
def application_trace clean_backtrace(:silent) end
#backtrace
[ GitHub ]# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 264
def backtrace @backtrace ||= build_backtrace end
#build_backtrace
[ GitHub ]# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 268
def build_backtrace locations = @exception.backtrace_locations || [] built_methods = built_methods_for(locations) locations.map do |loc| if built_methods.key?(loc.base_label) thread_backtrace_location = if loc.respond_to?(:__getobj__) loc.__getobj__ else loc end SourceMapLocation.new(thread_backtrace_location, built_methods[loc.base_label]) else loc end end end
#built_methods_for(locations)
Maps the compiled template methods that can appear in locations to
their templates.
# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 288
def built_methods_for(locations) built_methods = {} # A template rescues what it raises and rethrows it as a # Template::Error, which records each template it goes through. Those # are the templates whose methods are in the backtrace. outermost = @outer_exception || @exception [outermost, *causes_for(outermost)].each do |exception| next unless exception.is_a?(ActionView::Template::Error) exception.templates.each do |template| built_methods[template.method_name] = template if template.respond_to?(:method_name) end end # Otherwise collect the templates of every resolver, which is costly, # so only when a template method is in the backtrace. if locations.any? { |loc| !built_methods.key?(loc.base_label) && ActionView::Template.method_name?(loc.base_label) } ActionView::PathRegistry.all_resolvers.each do |resolver| resolver.built_templates.each do |template| built_methods[template.method_name] = template end end end built_methods end
#causes_for(exception)
[ GitHub ]#clean_backtrace(*args)
[ GitHub ]# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 330
def clean_backtrace(*args) if backtrace_cleaner backtrace_cleaner.clean(backtrace, *args) else backtrace end end
#corrections
[ GitHub ]# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 91
def corrections @exception.corrections end
#exception_id
[ GitHub ]# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 235
def exception_id exception.object_id end
#exception_inspect
[ GitHub ]# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 231
def exception_inspect exception.inspect end
#exception_name
[ GitHub ]# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 223
def exception_name exception.cause.class.to_s end
#exception_trace
[ GitHub ]# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 131
def exception_trace trace = application_trace trace = framework_trace if trace.empty? && !self.class.silent_exceptions.include?(@exception_class_name) trace end
#extract_file_and_line_number(trace)
[ GitHub ]# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 383
def extract_file_and_line_number(trace) [trace.path, trace.lineno] end
#extract_source(trace)
[ GitHub ]# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 338
def extract_source(trace) spot = trace.spot(@exception) if spot line = spot[:first_lineno] code = extract_source_fragment_lines(spot[:script_lines], line) if line == spot[:last_lineno] code[line] = [ code[line][0, spot[:first_column]], code[line][spot[:first_column]...spot[:last_column]], code[line][spot[:last_column]..-1], ] end return { code: code, line_number: line } end file, line_number = extract_file_and_line_number(trace) { code: source_fragment(file, line_number), line_number: line_number } end
#extract_source_fragment_lines(source_lines, line)
[ GitHub ]# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 367
def extract_source_fragment_lines(source_lines, line) start = [line - 3, 0].max lines = source_lines.drop(start).take(6) Hash[*(start + 1..(lines.count + start)).zip(lines).flatten] end
#failures
[ GitHub ]# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 79
def failures @exception.failures end
#file_name
[ GitHub ]# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 95
def file_name @exception.file_name end
#framework_trace
[ GitHub ]# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 141
def framework_trace clean_backtrace(:noise) end
#full_trace
[ GitHub ]# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 145
def full_trace clean_backtrace(:all) end
#line_number
[ GitHub ]# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 99
def line_number @exception.line_number end
#message
[ GitHub ]# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 227
def exception. end
#original_message
[ GitHub ]# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 87
def @exception. end
#rescue_template
[ GitHub ]# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 123
def rescue_template self.class.rescue_templates[@exception_class_name] end
#show?(request) ⇒ Boolean
# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 186
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
[ GitHub ]# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 205
def source_extracts backtrace.map do |trace| extract_source(trace).merge(trace: trace) end end
#source_fragment(path, line)
[ GitHub ]# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 373
def source_fragment(path, line) return unless Rails.respond_to?(:root) && Rails.root full_path = Rails.root.join(path) if File.file?(full_path) File.open(full_path, "r") do |file| extract_source_fragment_lines(file.each_line, line) end end end
#source_to_show_id
[ GitHub ]# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 219
def source_to_show_id (traces[trace_to_show].first || {})[:id] end
#status_code
[ GitHub ]# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 127
def status_code self.class.status_code_for_exception(unwrapped_exception.class.name) end
#sub_template_message
[ GitHub ]# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 71
def @exception. end
#trace_to_show
[ GitHub ]# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 211
def trace_to_show if traces["Application Trace"].empty? && rescue_template != "routing_error" "Full Trace" else "Application Trace" end end
#traces
[ GitHub ]# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 149
def traces application_trace_with_ids = [] framework_trace_with_ids = [] full_trace_with_ids = [] application_traces = application_trace.map(&:to_s) full_trace = backtrace_cleaner&.clean_locations(backtrace, :all).presence || backtrace full_trace.each_with_index do |trace, idx| filtered_trace = backtrace_cleaner&.clean_frame(trace, :all) || trace trace_with_id = { exception_object_id: @exception.object_id, id: idx, trace: trace, filtered_trace: filtered_trace, } if application_traces.include?(filtered_trace.to_s) 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
[ GitHub ]# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 107
def unwrapped_exception if self.class.wrapper_exceptions.include?(@exception_class_name) @exception.cause else @exception end end
#wrapped_causes_for(exception, backtrace_cleaner)
[ GitHub ]# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 322
def wrapped_causes_for(exception, backtrace_cleaner) causes_for(exception).map do |cause| wrapper = self.class.new(backtrace_cleaner, cause) wrapper.outer_exception = exception wrapper end end