From 1ed264bc60f3c76ba7fab339806fa1757702a46b Mon Sep 17 00:00:00 2001
From: Ryan Dao <daoduyducduong@gmail.com>
Date: Wed, 30 Jul 2014 15:35:47 +0700
Subject: Retrieve source code for the entire stack trace

Provide the ability to extract the source code of the entire exception stack
trace, not just the frame raising the error. This improves debugging
capability of the error page, especially for framework-related errors.
---
 .../middleware/templates/rescues/_source.erb       | 40 +++++++++++---------
 .../middleware/templates/rescues/_trace.html.erb   | 44 ++++++++++++++++++----
 .../middleware/templates/rescues/_trace.text.erb   | 10 +----
 .../middleware/templates/rescues/layout.erb        |  6 +++
 .../templates/rescues/template_error.html.erb      | 25 +-----------
 .../templates/rescues/template_error.text.erb      |  1 -
 6 files changed, 67 insertions(+), 59 deletions(-)

(limited to 'actionpack/lib/action_dispatch/middleware/templates')

diff --git a/actionpack/lib/action_dispatch/middleware/templates/rescues/_source.erb b/actionpack/lib/action_dispatch/middleware/templates/rescues/_source.erb
index 38429cb78e..51660a619b 100644
--- a/actionpack/lib/action_dispatch/middleware/templates/rescues/_source.erb
+++ b/actionpack/lib/action_dispatch/middleware/templates/rescues/_source.erb
@@ -1,25 +1,29 @@
 <% if @source_extract %>
-<div class="source">
-<div class="info">
-  Extracted source (around line <strong>#<%= @line_number %></strong>):
-</div>
-<div class="data">
-  <table cellpadding="0" cellspacing="0" class="lines">
-      <tr>
-        <td>
-          <pre class="line_numbers">
-            <% @source_extract.keys.each do |line_number| %>
+  <% @source_extract.each_with_index do |extract_source, index| %>
+    <% if extract_source[:code] %>
+      <div class="source <%="hidden" if index != 0%>" id="frame-source-<%=index%>">
+        <div class="info">
+          Extracted source (around line <strong>#<%= extract_source[:line_number] %></strong>):
+        </div>
+        <div class="data">
+          <table cellpadding="0" cellspacing="0" class="lines">
+            <tr>
+              <td>
+                <pre class="line_numbers">
+                  <% extract_source[:code].keys.each do |line_number| %>
 <span><%= line_number -%></span>
-            <% end %>
-          </pre>
-        </td>
+                  <% end %>
+                </pre>
+              </td>
 <td width="100%">
 <pre>
-<% @source_extract.each do |line, source| -%><div class="line<%= " active" if line == @line_number -%>"><%= source -%></div><% end -%>
+<% extract_source[:code].each do |line, source| -%><div class="line<%= " active" if line == extract_source[:line_number] -%>"><%= source -%></div><% end -%>
 </pre>
 </td>
-    </tr>
-  </table>
-</div>
-</div>
+            </tr>
+          </table>
+        </div>
+      </div>
+    <% end %>
+  <% end %>
 <% end %>
diff --git a/actionpack/lib/action_dispatch/middleware/templates/rescues/_trace.html.erb b/actionpack/lib/action_dispatch/middleware/templates/rescues/_trace.html.erb
index b181909bff..f62caf51d7 100644
--- a/actionpack/lib/action_dispatch/middleware/templates/rescues/_trace.html.erb
+++ b/actionpack/lib/action_dispatch/middleware/templates/rescues/_trace.html.erb
@@ -1,9 +1,4 @@
-<%
-   traces = { "Application Trace" => @application_trace,
-              "Framework Trace"   => @framework_trace,
-              "Full Trace"        => @full_trace }
-   names = traces.keys
-%>
+<% names = @traces.keys %>
 
 <p><code>Rails.root: <%= defined?(Rails) && Rails.respond_to?(:root) ? Rails.root : "unset" %></code></p>
 
@@ -16,9 +11,42 @@
     <a href="#" onclick="<%= hide.join %><%= show %>; return false;"><%= name %></a> <%= '|' unless names.last == name %>
   <% end %>
 
-  <% traces.each do |name, trace| %>
+  <% @traces.each do |name, trace| %>
     <div id="<%= name.gsub(/\s/, '-') %>" style="display: <%= (name == "Application Trace") ? 'block' : 'none' %>;">
-      <pre><code><%= trace.join "\n" %></code></pre>
+      <pre><code><% trace.each do |frame| %><a class="trace-frames" data-frame-id="<%= frame[:id] %>" href="#"><%= frame[:trace] %></a><br><% end %></code></pre>
     </div>
   <% end %>
+
+  <script type="text/javascript">
+    var traceFrames = document.getElementsByClassName('trace-frames');
+    var selectedFrame, currentSource = document.getElementById('frame-source-0');
+
+    // Add click listeners for all stack frames
+    for (var i = 0; i < traceFrames.length; i++) {
+      traceFrames[i].addEventListener('click', function(e) {
+        e.preventDefault();
+        var target = e.target;
+        var frame_id = target.dataset.frameId;
+
+        if (selectedFrame) {
+          selectedFrame.className = selectedFrame.className.replace("selected", "");
+        }
+
+        target.className += " selected";
+        selectedFrame = target;
+
+        // Change the extracted source code
+        changeSourceExtract(frame_id);
+      });
+
+      function changeSourceExtract(frame_id) {
+        var el = document.getElementById('frame-source-' + frame_id);
+        if (currentSource && el) {
+          currentSource.className += " hidden";
+          el.className = el.className.replace(" hidden", "");
+          currentSource = el;
+        }
+      }
+    }
+  </script>
 </div>
diff --git a/actionpack/lib/action_dispatch/middleware/templates/rescues/_trace.text.erb b/actionpack/lib/action_dispatch/middleware/templates/rescues/_trace.text.erb
index d4af5c9b06..36b01bf952 100644
--- a/actionpack/lib/action_dispatch/middleware/templates/rescues/_trace.text.erb
+++ b/actionpack/lib/action_dispatch/middleware/templates/rescues/_trace.text.erb
@@ -1,15 +1,9 @@
-<%
-  traces = { "Application Trace" => @application_trace,
-             "Framework Trace"   => @framework_trace,
-             "Full Trace"        => @full_trace }
-%>
-
 Rails.root: <%= defined?(Rails) && Rails.respond_to?(:root) ? Rails.root : "unset" %>
 
-<% traces.each do |name, trace| %>
+<% @traces.each do |name, trace| %>
 <% if trace.any? %>
 <%= name %>
-<%= trace.join("\n") %>
+<%= trace.map(&:trace).join("\n") %>
 
 <% end %>
 <% end %>
diff --git a/actionpack/lib/action_dispatch/middleware/templates/rescues/layout.erb b/actionpack/lib/action_dispatch/middleware/templates/rescues/layout.erb
index bc5d03dc10..e0509f56f4 100644
--- a/actionpack/lib/action_dispatch/middleware/templates/rescues/layout.erb
+++ b/actionpack/lib/action_dispatch/middleware/templates/rescues/layout.erb
@@ -116,9 +116,15 @@
       background-color: #FFCCCC;
     }
 
+    .hidden {
+      display: none;
+    }
+
     a { color: #980905; }
     a:visited { color: #666; }
+    a.trace-frames { color: #666; }
     a:hover { color: #C52F24; }
+    a.trace-frames.selected { color: #C52F24 }
 
     <%= yield :style %>
   </style>
diff --git a/actionpack/lib/action_dispatch/middleware/templates/rescues/template_error.html.erb b/actionpack/lib/action_dispatch/middleware/templates/rescues/template_error.html.erb
index 027a0f5b3e..c1e8b6cae3 100644
--- a/actionpack/lib/action_dispatch/middleware/templates/rescues/template_error.html.erb
+++ b/actionpack/lib/action_dispatch/middleware/templates/rescues/template_error.html.erb
@@ -1,4 +1,3 @@
-<% @source_extract = @exception.source_extract(0, :html) %>
 <header>
   <h1>
     <%= @exception.original_exception.class.to_s %> in
@@ -12,29 +11,7 @@
   </p>
   <pre><code><%= h @exception.message %></code></pre>
 
-  <div class="source">
-    <div class="info">
-      <p>Extracted source (around line <strong>#<%= @exception.line_number %></strong>):</p>
-    </div>
-    <div class="data">
-    <table cellpadding="0" cellspacing="0" class="lines">
-      <tr>
-        <td>
-          <pre class="line_numbers">
-            <% @source_extract.keys.each do |line_number| %>
-<span><%= line_number -%></span>
-            <% end %>
-          </pre>
-        </td>
-<td width="100%">
-<pre>
-<% @source_extract.each do |line, source| -%><div class="line<%= " active" if line == @exception.line_number -%>"><%= source -%></div><% end -%>
-</pre>
-</td>
-    </tr>
-  </table>
-</div>
-</div>
+  <%= render template: "rescues/_source" %>
 
   <p><%= @exception.sub_template_message %></p>
 
diff --git a/actionpack/lib/action_dispatch/middleware/templates/rescues/template_error.text.erb b/actionpack/lib/action_dispatch/middleware/templates/rescues/template_error.text.erb
index 5da21d9784..77bcd26726 100644
--- a/actionpack/lib/action_dispatch/middleware/templates/rescues/template_error.text.erb
+++ b/actionpack/lib/action_dispatch/middleware/templates/rescues/template_error.text.erb
@@ -1,4 +1,3 @@
-<% @source_extract = @exception.source_extract(0, :html) %>
 <%= @exception.original_exception.class.to_s %> in <%= @request.parameters["controller"].camelize if @request.parameters["controller"] %>#<%= @request.parameters["action"] %>
 
 Showing <%= @exception.file_name %> where line #<%= @exception.line_number %> raised:
-- 
cgit v1.2.3