debug_exceptions.rb 3.4 KB
Newer Older
1 2
require 'action_dispatch/http/request'
require 'action_dispatch/middleware/exception_wrapper'
3
require 'action_dispatch/routing/inspector'
4

5 6 7 8
module ActionDispatch
  # This middleware is responsible for logging exceptions and
  # showing a debugging page in case the request is local.
  class DebugExceptions
9
    RESCUES_TEMPLATE_PATH = File.expand_path('../templates', __FILE__)
10

11 12 13
    def initialize(app, routes_app = nil)
      @app        = app
      @routes_app = routes_app
14 15 16
    end

    def call(env)
17
      _, headers, body = response = @app.call(env)
18

19 20 21
      if headers['X-Cascade'] == 'pass'
        body.close if body.respond_to?(:close)
        raise ActionController::RoutingError, "No route matches [#{env['REQUEST_METHOD']}] #{env['PATH_INFO'].inspect}"
22 23
      end

24 25 26 27
      response
    rescue Exception => exception
      raise exception if env['action_dispatch.show_exceptions'] == false
      render_exception(env, exception)
28 29 30 31 32 33 34 35 36
    end

    private

    def render_exception(env, exception)
      wrapper = ExceptionWrapper.new(env, exception)
      log_error(env, wrapper)

      if env['action_dispatch.show_detailed_exceptions']
37
        request = Request.new(env)
38
        traces = wrapper.traces
39 40 41 42 43 44 45 46 47 48

        trace_to_show = 'Application Trace'
        if traces[trace_to_show].empty?
          trace_to_show = 'Full Trace'
        end

        if source_to_show = traces[trace_to_show].first
          source_to_show_id = source_to_show[:id]
        end

49
        template = ActionView::Base.new([RESCUES_TEMPLATE_PATH],
50 51
          request: request,
          exception: wrapper.exception,
52 53 54
          traces: traces,
          show_source_idx: source_to_show_id,
          trace_to_show: trace_to_show,
55
          routes_inspector: routes_inspector(exception),
56
          source_extracts: wrapper.source_extracts,
57 58
          line_number: wrapper.line_number,
          file: wrapper.file
59 60
        )
        file = "rescues/#{wrapper.rescue_template}"
61 62 63 64 65 66 67 68 69

        if request.xhr?
          body = template.render(template: file, layout: false, formats: [:text])
          format = "text/plain"
        else
          body = template.render(template: file, layout: 'rescues/layout')
          format = "text/html"
        end
        render(wrapper.status_code, body, format)
70 71 72 73 74
      else
        raise exception
      end
    end

75 76
    def render(status, body, format)
      [status, {'Content-Type' => "#{format}; charset=#{Response.default_charset}", 'Content-Length' => body.bytesize.to_s}, [body]]
77 78 79 80 81 82 83 84
    end

    def log_error(env, wrapper)
      logger = logger(env)
      return unless logger

      exception = wrapper.exception

85 86 87
      trace = wrapper.application_trace
      trace = wrapper.framework_trace if trace.empty?

88 89 90
      ActiveSupport::Deprecation.silence do
        message = "\n#{exception.class} (#{exception.message}):\n"
        message << exception.annoted_source_code.to_s if exception.respond_to?(:annoted_source_code)
91
        message << "  " << trace.join("\n  ")
92 93 94 95 96 97 98 99 100
        logger.fatal("#{message}\n\n")
      end
    end

    def logger(env)
      env['action_dispatch.logger'] || stderr_logger
    end

    def stderr_logger
101
      @stderr_logger ||= ActiveSupport::Logger.new($stderr)
102
    end
103

104
    def routes_inspector(exception)
105
      if @routes_app.respond_to?(:routes) && (exception.is_a?(ActionController::RoutingError) || exception.is_a?(ActionView::Template::Error))
106 107 108
        ActionDispatch::Routing::RoutesInspector.new(@routes_app.routes.routes)
      end
    end
109 110
  end
end