class ActionDispatch::ExceptionWrapper

Attributes

backtrace_cleaner[R]
exception[R]
file[R]
line_number[R]
wrapped_causes[R]

Public Class Methods

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

Public Instance Methods

application_trace() click to toggle source
# File lib/action_dispatch/middleware/exception_wrapper.rb, line 77
def application_trace
  clean_backtrace(:silent)
end
exception_trace() click to toggle source
# 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() click to toggle source
# File lib/action_dispatch/middleware/exception_wrapper.rb, line 81
def framework_trace
  clean_backtrace(:noise)
end
full_trace() click to toggle source
# File lib/action_dispatch/middleware/exception_wrapper.rb, line 85
def full_trace
  clean_backtrace(:all)
end
rescue_template() click to toggle source
# File lib/action_dispatch/middleware/exception_wrapper.rb, line 63
def rescue_template
  @@rescue_templates[@exception_class_name]
end
source_extracts() click to toggle source
# File lib/action_dispatch/middleware/exception_wrapper.rb, line 121
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() click to toggle source
# File lib/action_dispatch/middleware/exception_wrapper.rb, line 140
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 67
def status_code
  self.class.status_code_for_exception(unwrapped_exception.class.name)
end
trace_to_show() click to toggle source
# File lib/action_dispatch/middleware/exception_wrapper.rb, line 132
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 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() click to toggle source
# 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

Private Instance Methods

backtrace() click to toggle source
# File lib/action_dispatch/middleware/exception_wrapper.rb, line 145
def backtrace
  Array(@exception.backtrace)
end
causes_for(exception) { |exception while exception = cause| ... } click to toggle source
# File lib/action_dispatch/middleware/exception_wrapper.rb, line 149
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 159
def clean_backtrace(*args)
  if backtrace_cleaner
    backtrace_cleaner.clean(backtrace, *args)
  else
    backtrace
  end
end
expand_backtrace() click to toggle source
# File lib/action_dispatch/middleware/exception_wrapper.rb, line 186
def expand_backtrace
  @exception.backtrace.unshift(
    @exception.to_s.split("\n")
  ).flatten!
end
extract_file_and_line_number(trace) click to toggle source
# File lib/action_dispatch/middleware/exception_wrapper.rb, line 179
def extract_file_and_line_number(trace)
  # Split by the first colon followed by some digits, which works for both
  # Windows and Unix path styles.
  file, line = trace.match(/^(.+?):(\d+).*$/, &:captures) || trace
  [file, line.to_i]
end
source_fragment(path, line) click to toggle source
# File lib/action_dispatch/middleware/exception_wrapper.rb, line 167
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|
      start = [line - 3, 0].max
      lines = file.each_line.drop(start).take(6)
      Hash[*(start + 1..(lines.count + start)).zip(lines).flatten]
    end
  end
end
wrapped_causes_for(exception, backtrace_cleaner) click to toggle source
# File lib/action_dispatch/middleware/exception_wrapper.rb, line 155
def wrapped_causes_for(exception, backtrace_cleaner)
  causes_for(exception).map { |cause| self.class.new(backtrace_cleaner, cause) }
end