123456789_123456789_123456789_123456789_123456789_

Class: ActionDispatch::ExceptionWrapper

Relationships & Source Files
Inherits: Object
Defined in: actionpack/lib/action_dispatch/middleware/exception_wrapper.rb

Class Attribute Summary

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(backtrace_cleaner, exception) ⇒ ExceptionWrapper

[ GitHub ]

  
# File 'actionpack/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

Class Attribute Details

.rescue_responses (rw) Also known as: #rescue_responses

[ GitHub ]

  
# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 10

cattr_accessor :rescue_responses, default: Hash.new(:internal_server_error).merge!(
  "ActionController::RoutingError"                     => :not_found,
  "AbstractController::ActionNotFound"                 => :not_found,
  "ActionController::MethodNotAllowed"                 => :method_not_allowed,
  "ActionController::UnknownHttpMethod"                => :method_not_allowed,
  "ActionController::NotImplemented"                   => :not_implemented,
  "ActionController::UnknownFormat"                    => :not_acceptable,
  "ActionDispatch::Http::MimeNegotiation::InvalidType" => :not_acceptable,
  "ActionController::MissingExactTemplate"             => :not_acceptable,
  "ActionController::InvalidAuthenticityToken"         => :unprocessable_entity,
  "ActionController::InvalidCrossOriginRequest"        => :unprocessable_entity,
  "ActionDispatch::Http::Parameters::ParseError"       => :bad_request,
  "ActionController::BadRequest"                       => :bad_request,
  "ActionController::ParameterMissing"                 => :bad_request,
  "Rack::QueryParser::ParameterTypeError"              => :bad_request,
  "Rack::QueryParser::InvalidParameterError"           => :bad_request
)

.rescue_templates (rw) Also known as: #rescue_templates

[ GitHub ]

  
# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 28

cattr_accessor :rescue_templates, default: Hash.new("diagnostics").merge!(
  "ActionView::MissingTemplate"            => "missing_template",
  "ActionController::RoutingError"         => "routing_error",
  "AbstractController::ActionNotFound"     => "unknown_action",
  "ActiveRecord::StatementInvalid"         => "invalid_statement",
  "ActionView::Template::Error"            => "template_error",
  "ActionController::MissingExactTemplate" => "missing_exact_template",
)

.silent_exceptions (rw) Also known as: #silent_exceptions

[ GitHub ]

  
# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 41

cattr_accessor :silent_exceptions, default: [
  "ActionController::RoutingError",
  "ActionDispatch::Http::MimeNegotiation::InvalidType"
]

.wrapper_exceptions (rw) Also known as: #wrapper_exceptions

[ GitHub ]

  
# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 37

cattr_accessor :wrapper_exceptions, default: [
  "ActionView::Template::Error"
]

Class Method Details

.status_code_for_exception(class_name)

[ GitHub ]

  
# File 'actionpack/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 Attribute Details

#backtrace (readonly)

[ GitHub ]

  
# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 263

attr_reader :backtrace

#backtrace_cleaner (readonly)

[ GitHub ]

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

attr_reader :backtrace_cleaner, :wrapped_causes, :exception_class_name, :exception

#error_highlight_available?Boolean (readonly)

[ GitHub ]

  
# File 'actionpack/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 (readonly)

[ GitHub ]

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

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 46

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 71

def has_cause?
  @exception.cause
end

#has_corrections?Boolean (readonly)

[ GitHub ]

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

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

#rescue_response?Boolean (readonly)

[ GitHub ]

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

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

#rescue_responses (rw)

[ GitHub ]

  
# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 10

cattr_accessor :rescue_responses, default: Hash.new(:internal_server_error).merge!(
  "ActionController::RoutingError"                     => :not_found,
  "AbstractController::ActionNotFound"                 => :not_found,
  "ActionController::MethodNotAllowed"                 => :method_not_allowed,
  "ActionController::UnknownHttpMethod"                => :method_not_allowed,
  "ActionController::NotImplemented"                   => :not_implemented,
  "ActionController::UnknownFormat"                    => :not_acceptable,
  "ActionDispatch::Http::MimeNegotiation::InvalidType" => :not_acceptable,
  "ActionController::MissingExactTemplate"             => :not_acceptable,
  "ActionController::InvalidAuthenticityToken"         => :unprocessable_entity,
  "ActionController::InvalidCrossOriginRequest"        => :unprocessable_entity,
  "ActionDispatch::Http::Parameters::ParseError"       => :bad_request,
  "ActionController::BadRequest"                       => :bad_request,
  "ActionController::ParameterMissing"                 => :bad_request,
  "Rack::QueryParser::ParameterTypeError"              => :bad_request,
  "Rack::QueryParser::InvalidParameterError"           => :bad_request
)

#rescue_templates (rw)

[ GitHub ]

  
# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 28

cattr_accessor :rescue_templates, default: Hash.new("diagnostics").merge!(
  "ActionView::MissingTemplate"            => "missing_template",
  "ActionController::RoutingError"         => "routing_error",
  "AbstractController::ActionNotFound"     => "unknown_action",
  "ActiveRecord::StatementInvalid"         => "invalid_statement",
  "ActionView::Template::Error"            => "template_error",
  "ActionController::MissingExactTemplate" => "missing_exact_template",
)

#routing_error?Boolean (readonly)

[ GitHub ]

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

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

#silent_exceptions (rw)

[ GitHub ]

  
# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 41

cattr_accessor :silent_exceptions, default: [
  "ActionController::RoutingError",
  "ActionDispatch::Http::MimeNegotiation::InvalidType"
]

#template_error?Boolean (readonly)

[ GitHub ]

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

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

#wrapped_causes (readonly)

[ GitHub ]

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

attr_reader :backtrace_cleaner, :wrapped_causes, :exception_class_name, :exception

#wrapper_exceptions (rw)

[ GitHub ]

  
# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 37

cattr_accessor :wrapper_exceptions, default: [
  "ActionView::Template::Error"
]

Instance Method Details

#actions

[ GitHub ]

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

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

#annotated_source_code

[ GitHub ]

  
# File 'actionpack/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

[ GitHub ]

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

def application_trace
  clean_backtrace(:silent)
end

#build_backtrace

[ GitHub ]

  
# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 265

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)

[ GitHub ]

  
# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 288

def causes_for(exception)
  return enum_for(__method__, exception) unless block_given?

  yield exception while exception = exception.cause
end

#clean_backtrace(*args)

[ GitHub ]

  
# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 298

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 87

def corrections
  @exception.corrections
end

#exception_id

[ GitHub ]

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

def exception_id
  exception.object_id
end

#exception_inspect

[ GitHub ]

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

def exception_inspect
  exception.inspect
end

#exception_name

[ GitHub ]

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

def exception_name
  exception.cause.class.to_s
end

#exception_trace

[ GitHub ]

  
# File 'actionpack/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

#extract_file_and_line_number(trace)

[ GitHub ]

  
# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 351

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 306

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 335

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 75

def failures
  @exception.failures
end

#file_name

[ GitHub ]

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

def file_name
  @exception.file_name
end

#framework_trace

[ GitHub ]

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

def framework_trace
  clean_backtrace(:noise)
end

#full_trace

[ GitHub ]

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

def full_trace
  clean_backtrace(:all)
end

#line_number

[ GitHub ]

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

def line_number
  @exception.line_number
end

#message

[ GitHub ]

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

def message
  exception.message
end

#original_message

[ GitHub ]

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

def original_message
  @exception.original_message
end

#rescue_template

[ GitHub ]

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

def rescue_template
  @@rescue_templates[@exception_class_name]
end

#show?(request) ⇒ Boolean

[ GitHub ]

  
# File 'actionpack/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

[ GitHub ]

  
# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 204

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

#source_fragment(path, line)

[ GitHub ]

  
# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 341

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

#source_to_show_id

[ GitHub ]

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

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 123

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 67

def sub_template_message
  @exception.sub_template_message
end

#trace_to_show

[ GitHub ]

  
# File 'actionpack/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

[ GitHub ]

  
# File 'actionpack/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

[ GitHub ]

  
# File 'actionpack/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

#wrapped_causes_for(exception, backtrace_cleaner)

[ GitHub ]

  
# File 'actionpack/lib/action_dispatch/middleware/exception_wrapper.rb', line 294

def wrapped_causes_for(exception, backtrace_cleaner)
  causes_for(exception).map { |cause| self.class.new(backtrace_cleaner, cause) }
end