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 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


  







Class Attribute Details



  

    .rescue_responses   (rw)
    Also known as: #rescue_responses
  

  [ GitHub ]


  

  


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



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 26



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 39



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 35



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 117



def self.status_code_for_exception(class_name)
  Rack::Utils.status_code(@@rescue_responses[class_name])
end


  







Instance Attribute Details



  

    #backtrace_cleaner   (readonly)
  

  [ GitHub ]


  

  


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



attr_reader :backtrace_cleaner, :exception, :wrapped_causes, :line_number, :file


  








  

    #exception   (readonly)
  

  [ GitHub ]


  

  


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



attr_reader :backtrace_cleaner, :exception, :wrapped_causes, :line_number, :file


  








  

    #file   (readonly)
  

  [ GitHub ]


  

  


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



attr_reader :backtrace_cleaner, :exception, :wrapped_causes, :line_number, :file


  








  

    #line_number   (readonly)
  

  [ GitHub ]


  

  


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



attr_reader :backtrace_cleaner, :exception, :wrapped_causes, :line_number, :file


  








  

    #rescue_responses   (rw)
  

  [ GitHub ]


  

  


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



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 26



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)
  

  [ GitHub ]


  

  


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



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


  








  

    #wrapped_causes   (readonly)
  

  [ GitHub ]


  

  


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



attr_reader :backtrace_cleaner, :exception, :wrapped_causes, :line_number, :file


  








  

    #wrapper_exceptions   (rw)
  

  [ GitHub ]


  

  


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



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


  







Instance Method Details



  

    #application_trace  
  

  [ GitHub ]


  

  


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



def application_trace
  clean_backtrace(:silent)
end


  








  

    #exception_trace  
  

  [ GitHub ]


  

  


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

  [ GitHub ]


  

  


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



def framework_trace
  clean_backtrace(:noise)
end


  








  

    #full_trace  
  

  [ GitHub ]


  

  


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



def full_trace
  clean_backtrace(:all)
end


  








  

    #rescue_template  
  

  [ GitHub ]


  

  


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



def rescue_template
  @@rescue_templates[@exception_class_name]
end


  








  

    #source_extracts  
  

  [ GitHub ]


  

  


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

  [ GitHub ]


  

  


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



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 67



def status_code
  self.class.status_code_for_exception(unwrapped_exception.class.name)
end


  








  

    #trace_to_show  
  

  [ GitHub ]


  

  


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

  [ GitHub ]


  

  


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

  [ GitHub ]


  

  


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