class ActionDispatch::ExceptionWrapper

Attributes

backtrace[R]
backtrace_cleaner[R]
exception[R]
exception_class_name[R]
wrapped_causes[R]

Public Class Methods

new(backtrace_cleaner, exception) click to toggle source
# 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
status_code_for_exception(class_name) click to toggle source
# 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

Public Instance Methods

actions() click to toggle source
# File lib/action_dispatch/middleware/exception_wrapper.rb, line 101
def actions
  ActiveSupport::ActionableError.actions(@exception)
end
annotated_source_code() click to toggle source
# 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() click to toggle source
# File lib/action_dispatch/middleware/exception_wrapper.rb, line 135
def application_trace
  clean_backtrace(:silent)
end
corrections() click to toggle source
# File lib/action_dispatch/middleware/exception_wrapper.rb, line 89
def corrections
  @exception.corrections
end
exception_id() click to toggle source
# File lib/action_dispatch/middleware/exception_wrapper.rb, line 228
def exception_id
  exception.object_id
end
exception_inspect() click to toggle source
# File lib/action_dispatch/middleware/exception_wrapper.rb, line 224
def exception_inspect
  exception.inspect
end
exception_name() click to toggle source
# File lib/action_dispatch/middleware/exception_wrapper.rb, line 216
def exception_name
  exception.cause.class.to_s
end
exception_trace() click to toggle source
# 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() click to toggle source
# File lib/action_dispatch/middleware/exception_wrapper.rb, line 77
def failures
  @exception.failures
end
file_name() click to toggle source
# File lib/action_dispatch/middleware/exception_wrapper.rb, line 93
def file_name
  @exception.file_name
end
framework_trace() click to toggle source
# File lib/action_dispatch/middleware/exception_wrapper.rb, line 139
def framework_trace
  clean_backtrace(:noise)
end
full_trace() click to toggle source
# File lib/action_dispatch/middleware/exception_wrapper.rb, line 143
def full_trace
  clean_backtrace(:all)
end
has_cause?() click to toggle source
# File lib/action_dispatch/middleware/exception_wrapper.rb, line 73
def has_cause?
  @exception.cause
end
has_corrections?() click to toggle source
# 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() click to toggle source
# File lib/action_dispatch/middleware/exception_wrapper.rb, line 97
def line_number
  @exception.line_number
end
message() click to toggle source
# File lib/action_dispatch/middleware/exception_wrapper.rb, line 220
def message
  exception.message
end
original_message() click to toggle source
# File lib/action_dispatch/middleware/exception_wrapper.rb, line 85
def original_message
  @exception.original_message
end
rescue_response?() click to toggle source
# File lib/action_dispatch/middleware/exception_wrapper.rb, line 194
def rescue_response?
  @@rescue_responses.key?(exception.class.name)
end
rescue_template() click to toggle source
# File lib/action_dispatch/middleware/exception_wrapper.rb, line 121
def rescue_template
  @@rescue_templates[@exception_class_name]
end
routing_error?() click to toggle source
# File lib/action_dispatch/middleware/exception_wrapper.rb, line 61
def routing_error?
  @exception.is_a?(ActionController::RoutingError)
end
show?(request) click to toggle source
# 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() click to toggle source
# 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() click to toggle source
# File lib/action_dispatch/middleware/exception_wrapper.rb, line 212
def source_to_show_id
  (traces[trace_to_show].first || {})[:id]
end
status_code() click to toggle source
# 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() click to toggle source
# File lib/action_dispatch/middleware/exception_wrapper.rb, line 69
def sub_template_message
  @exception.sub_template_message
end
template_error?() click to toggle source
# File lib/action_dispatch/middleware/exception_wrapper.rb, line 65
def template_error?
  @exception.is_a?(ActionView::Template::Error)
end
trace_to_show() click to toggle source
# File lib/action_dispatch/middleware/exception_wrapper.rb, line 204
def trace_to_show
  if traces["Application Trace"].empty? && rescue_template != "routing_error"
    "Full Trace"
  else
    "Application Trace"
  end
end
traces() click to toggle source
# 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() click to toggle source
# 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

Private Instance Methods

build_backtrace() click to toggle source
# File lib/action_dispatch/middleware/exception_wrapper.rb, line 254
def build_backtrace
  built_methods = {}

  ActionView::PathRegistry.all_resolvers.each do |resolver|
    resolver.built_templates.each do |template|
      built_methods[template.method_name] = template
    end
  end

  (@exception.backtrace_locations || []).map do |loc|
    if built_methods.key?(loc.label.to_s)
      thread_backtrace_location = if loc.respond_to?(:__getobj__)
        loc.__getobj__
      else
        loc
      end
      SourceMapLocation.new(thread_backtrace_location, built_methods[loc.label.to_s])
    else
      loc
    end
  end
end
causes_for(exception) { |exception while exception = cause| ... } click to toggle source
# File lib/action_dispatch/middleware/exception_wrapper.rb, line 277
def causes_for(exception)
  return enum_for(__method__, exception) unless block_given?

  yield exception while exception = exception.cause
end
clean_backtrace(*args) click to toggle source
# File lib/action_dispatch/middleware/exception_wrapper.rb, line 287
def clean_backtrace(*args)
  if backtrace_cleaner
    backtrace_cleaner.clean(backtrace, *args)
  else
    backtrace
  end
end
extract_file_and_line_number(trace) click to toggle source
# File lib/action_dispatch/middleware/exception_wrapper.rb, line 340
def extract_file_and_line_number(trace)
  [trace.path, trace.lineno]
end
extract_source(trace) click to toggle source
# File lib/action_dispatch/middleware/exception_wrapper.rb, line 295
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) click to toggle source
# File lib/action_dispatch/middleware/exception_wrapper.rb, line 324
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
source_fragment(path, line) click to toggle source
# File lib/action_dispatch/middleware/exception_wrapper.rb, line 330
def source_fragment(path, line)
  return unless Rails.respond_to?(:root) && Rails.root
  full_path = Rails.root.join(path)
  if File.exist?(full_path)
    File.open(full_path, "r") do |file|
      extract_source_fragment_lines(file.each_line, line)
    end
  end
end
wrapped_causes_for(exception, backtrace_cleaner) click to toggle source
# File lib/action_dispatch/middleware/exception_wrapper.rb, line 283
def wrapped_causes_for(exception, backtrace_cleaner)
  causes_for(exception).map { |cause| self.class.new(backtrace_cleaner, cause) }
end