Skip to Content Skip to Search
Methods
A
C
E
F
H
L
M
N
O
R
S
T
U

Attributes

[R] backtrace_cleaner
[R] exception
[R] exception_class_name
[RW] rescue_responses
[RW] rescue_templates
[RW] silent_exceptions
[R] wrapped_causes
[RW] wrapper_exceptions

Class Public methods

new(backtrace_cleaner, exception)

# File actionpack/lib/action_dispatch/middleware/exception_wrapper.rb, line 53
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 = nil
end

status_code_for_exception(class_name)

# File actionpack/lib/action_dispatch/middleware/exception_wrapper.rb, line 183
def self.status_code_for_exception(class_name)
  ActionDispatch::Response.rack_status_code(rescue_responses[class_name])
end

Instance Public methods

actions()

# File actionpack/lib/action_dispatch/middleware/exception_wrapper.rb, line 104
def actions
  ActiveSupport::ActionableError.actions(@exception)
end

annotated_source_code()

# File actionpack/lib/action_dispatch/middleware/exception_wrapper.rb, line 116
def annotated_source_code
  if exception.respond_to?(:annotated_source_code)
    exception.annotated_source_code
  else
    []
  end
end

application_trace()

# File actionpack/lib/action_dispatch/middleware/exception_wrapper.rb, line 138
def application_trace
  clean_backtrace(:silent)
end

corrections()

# File actionpack/lib/action_dispatch/middleware/exception_wrapper.rb, line 92
def corrections
  @exception.corrections
end

exception_id()

# File actionpack/lib/action_dispatch/middleware/exception_wrapper.rb, line 236
def exception_id
  exception.object_id
end

exception_inspect()

# File actionpack/lib/action_dispatch/middleware/exception_wrapper.rb, line 232
def exception_inspect
  exception.inspect
end

exception_name()

# File actionpack/lib/action_dispatch/middleware/exception_wrapper.rb, line 224
def exception_name
  exception.cause.class.to_s
end

exception_trace()

# File actionpack/lib/action_dispatch/middleware/exception_wrapper.rb, line 132
def exception_trace
  trace = application_trace
  trace = framework_trace if trace.empty? && !self.class.silent_exceptions.include?(@exception_class_name)
  trace
end

failures()

# File actionpack/lib/action_dispatch/middleware/exception_wrapper.rb, line 80
def failures
  @exception.failures
end

file_name()

# File actionpack/lib/action_dispatch/middleware/exception_wrapper.rb, line 96
def file_name
  @exception.file_name
end

framework_trace()

# File actionpack/lib/action_dispatch/middleware/exception_wrapper.rb, line 142
def framework_trace
  clean_backtrace(:noise)
end

full_trace()

# File actionpack/lib/action_dispatch/middleware/exception_wrapper.rb, line 146
def full_trace
  clean_backtrace(:all)
end

has_cause?()

# File actionpack/lib/action_dispatch/middleware/exception_wrapper.rb, line 76
def has_cause?
  @exception.cause
end

has_corrections?()

# File actionpack/lib/action_dispatch/middleware/exception_wrapper.rb, line 84
def has_corrections?
  @exception.respond_to?(:original_message) && @exception.respond_to?(:corrections)
end

line_number()

# File actionpack/lib/action_dispatch/middleware/exception_wrapper.rb, line 100
def line_number
  @exception.line_number
end

message()

# File actionpack/lib/action_dispatch/middleware/exception_wrapper.rb, line 228
def message
  exception.message
end

original_message()

# File actionpack/lib/action_dispatch/middleware/exception_wrapper.rb, line 88
def original_message
  @exception.original_message
end

rescue_response?()

# File actionpack/lib/action_dispatch/middleware/exception_wrapper.rb, line 202
def rescue_response?
  self.class.rescue_responses.key?(exception.class.name)
end

rescue_template()

# File actionpack/lib/action_dispatch/middleware/exception_wrapper.rb, line 124
def rescue_template
  self.class.rescue_templates[@exception_class_name]
end

routing_error?()

# File actionpack/lib/action_dispatch/middleware/exception_wrapper.rb, line 64
def routing_error?
  @exception.is_a?(ActionController::RoutingError)
end

show?(request)

# File actionpack/lib/action_dispatch/middleware/exception_wrapper.rb, line 187
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()

# File actionpack/lib/action_dispatch/middleware/exception_wrapper.rb, line 206
def source_extracts
  backtrace.map do |trace|
    extract_source(trace).merge(trace: trace)
  end
end

source_to_show_id()

# File actionpack/lib/action_dispatch/middleware/exception_wrapper.rb, line 220
def source_to_show_id
  (traces[trace_to_show].first || {})[:id]
end

status_code()

# File actionpack/lib/action_dispatch/middleware/exception_wrapper.rb, line 128
def status_code
  self.class.status_code_for_exception(unwrapped_exception.class.name)
end

sub_template_message()

# File actionpack/lib/action_dispatch/middleware/exception_wrapper.rb, line 72
def sub_template_message
  @exception.sub_template_message
end

template_error?()

# File actionpack/lib/action_dispatch/middleware/exception_wrapper.rb, line 68
def template_error?
  @exception.is_a?(ActionView::Template::Error)
end

trace_to_show()

# File actionpack/lib/action_dispatch/middleware/exception_wrapper.rb, line 212
def trace_to_show
  if traces["Application Trace"].empty? && rescue_template != "routing_error"
    "Full Trace"
  else
    "Application Trace"
  end
end

traces()

# File actionpack/lib/action_dispatch/middleware/exception_wrapper.rb, line 150
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()

# File actionpack/lib/action_dispatch/middleware/exception_wrapper.rb, line 108
def unwrapped_exception
  if self.class.wrapper_exceptions.include?(@exception_class_name)
    @exception.cause
  else
    @exception
  end
end