Merge pull request rails#55295 from igorkasyanchuk/open_file_in_editor

Add support to open files in the source code editor from the crash page

Author: byroot

actionpack/CHANGELOG.md

@@ -1,3 +1,7 @@
+*   Allow to open source file with a crash from the browser.
+
+    *Igor Kasyanchuk*
+
 *   Always check query string keys for valid encoding just like values are checked.
 
     *Casper Smits*

actionpack/lib/action_dispatch/middleware/debug_view.rb

@@ -55,6 +55,17 @@ def render(*)
       end
     end
 
+    def editor_url(location, line: nil)
+      if editor = ActiveSupport::Editor.current
+        line ||= location&.lineno
+        absolute_path = location&.absolute_path
+
+        if absolute_path && line && File.exist?(absolute_path)
+          editor.url_for(absolute_path, line)
+        end
+      end
+    end
+
     def protect_against_forgery?
       false
     end

actionpack/lib/action_dispatch/middleware/exception_wrapper.rb

@@ -148,15 +148,20 @@ 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
+          trace: trace,
+          filtered_trace: filtered_trace,
         }
 
-        if application_trace.include?(trace)
+        if application_traces.include?(filtered_trace.to_s)
           application_trace_with_ids << trace_with_id
         else
           framework_trace_with_ids << trace_with_id
@@ -197,7 +202,7 @@ def rescue_response?
 
     def source_extracts
       backtrace.map do |trace|
-        extract_source(trace)
+        extract_source(trace).merge(trace: trace)
       end
     end
 

actionpack/lib/action_dispatch/middleware/templates/rescues/_source.html.erb

@@ -11,8 +11,9 @@
           <tr>
             <td>
               <pre class="line_numbers">
-                <% source_extract[:code].each_key do |line_number| %>
-<span><%= line_number -%></span>
+                <% source_extract[:code].each_key do |line| %>
+                  <% file_url = editor_url(source_extract[:trace], line: line) %>
+<span><%= link_to_if file_url, line, file_url -%></span>
                 <% end %>
               </pre>
             </td>

actionpack/lib/action_dispatch/middleware/templates/rescues/_trace.html.erb

@@ -13,13 +13,17 @@
   <% end %>
 
   <% traces.each do |name, trace| %>
-    <div id="<%= "#{name.gsub(/\s/, '-')}-#{error_index}" %>" style="display: <%= (name == trace_to_show) ? 'block' : 'none' %>;">
+    <div id="<%= "#{name.gsub(/\s/, '-')}-#{error_index}" %>" class="trace-container" style="display: <%= (name == trace_to_show) ? 'block' : 'none' %>;">
       <code class="traces">
         <% trace.each do |frame| %>
-          <a class="trace-frames trace-frames-<%= error_index %>" data-exception-object-id="<%= frame[:exception_object_id] %>" data-frame-id="<%= frame[:id] %>" href="#">
-            <%= frame[:trace] %>
-          </a>
-          <br>
+          <div class="trace">
+            <% file_url = editor_url(frame[:trace]) %>
+            <%= file_url && link_to("✏️", file_url, class: "edit-icon") %>
+            <a class="trace-frames trace-frames-<%= error_index %>" data-exception-object-id="<%= frame[:exception_object_id] %>" data-frame-id="<%= frame[:id] %>" href="#">
+              <%= frame[:trace] %>
+            </a>
+            <br>
+          </div>
         <% end %>
       </code>
     </div>

actionpack/lib/action_dispatch/middleware/templates/rescues/layout.erb

@@ -54,6 +54,30 @@
       font-size: 11px;
     }
 
+    .trace-container {
+      margin-top: 10px;
+    }
+
+    code.traces .trace {
+      display: flex;
+      align-items: center;
+      gap: 2px;
+    }
+
+    .edit-icon {
+      width: 16px;
+      height: 16px;
+      display: flex;
+      font-size: 13px;
+      align-items: center;
+      justify-content: center;
+      text-decoration: none;
+    }
+
+    .edit-icon:hover {
+      scale: 1.05;
+    }
+
     .response-heading, .request-heading {
       margin-top: 30px;
     }

actionpack/test/dispatch/debug_exceptions_test.rb

@@ -868,6 +868,16 @@ def self.build_app(app, *args)
     end
   end
 
+  test "shows the link to edit the file in the editor" do
+    @app = DevelopmentApp
+    ActiveSupport::Editor.stub(:current, ActiveSupport::Editor.find("atom")) do
+      get "/actionable_error"
+
+      assert_select "code a.edit-icon"
+      assert_includes body, "atom://core/open"
+    end
+  end
+
   test "shows a buttons for every action in an actionable error" do
     @app = DevelopmentApp
     Rails.stub :root, Pathname.new(".") do

actionpack/test/dispatch/exception_wrapper_test.rb

@@ -56,10 +56,12 @@ def translate_location(backtrace_location, spot)
 
     test "#source_extracts fetches source fragments for every backtrace entry" do
       exception = begin index; rescue TestError => ex; ex; end
+
       wrapper = ExceptionWrapper.new(nil, TopErrorProxy.new(exception, 1))
+      trace = wrapper.source_extracts.first[:trace]
 
       assert_called_with(wrapper, :source_fragment, ["lib/file.rb", 42], returns: "foo") do
-        assert_equal [ code: "foo", line_number: 42 ], wrapper.source_extracts
+        assert_equal [ code: "foo", line_number: 42, trace: trace ], wrapper.source_extracts
       end
     end
 
@@ -69,9 +71,10 @@ def translate_location(backtrace_location, spot)
       exc = begin ms_index; rescue TestError => ex; ex; end
 
       wrapper = ExceptionWrapper.new(nil, TopErrorProxy.new(exc, 1))
+      trace = wrapper.source_extracts.first[:trace]
 
       assert_called_with(wrapper, :source_fragment, ["c:/path/to/rails/app/controller.rb", 27], returns: "nothing") do
-        assert_equal [ code: "nothing", line_number: 27 ], wrapper.source_extracts
+        assert_equal [ code: "nothing", line_number: 27, trace: trace ], wrapper.source_extracts
       end
     end
 
@@ -81,9 +84,10 @@ def translate_location(backtrace_location, spot)
       exc = begin invalid_ex; rescue TestError => ex; ex; end
 
       wrapper = ExceptionWrapper.new(nil, TopErrorProxy.new(exc, 1))
+      trace = wrapper.source_extracts.first[:trace]
 
       assert_called_with(wrapper, :source_fragment, ["invalid", 0], returns: "nothing") do
-        assert_equal [ code: "nothing", line_number: 0 ], wrapper.source_extracts
+        assert_equal [ code: "nothing", line_number: 0, trace: trace ], wrapper.source_extracts
       end
     end
 
@@ -95,9 +99,10 @@ def translate_location(backtrace_location, spot)
       exception = begin throw_syntax_error; rescue SyntaxError => ex; ex; end
 
       wrapper = ExceptionWrapper.new(nil, TopErrorProxy.new(exception, 1))
+      trace = wrapper.source_extracts.first[:trace]
 
       assert_called_with(wrapper, :source_fragment, ["lib/file.rb", 42], returns: "foo") do
-        assert_equal [ code: "foo", line_number: 42 ], wrapper.source_extracts
+        assert_equal [ code: "foo", line_number: 42, trace: trace ], wrapper.source_extracts
       end
     end
 
@@ -123,7 +128,7 @@ def translate_location(backtrace_location, spot)
         code[lineno + i] = line
       end
       code[lineno + 2] = ["        1", ".time", "\n"]
-      assert_equal({ code: code, line_number: lineno + 2 }, wrapper.source_extracts.first)
+      assert_equal({ code: code, line_number: lineno + 2, trace: wrapper.source_extracts.first[:trace] }, wrapper.source_extracts.first)
     end
 
     class_eval "def _app_views_tests_show_html_erb;
@@ -142,7 +147,8 @@ def translate_location(backtrace_location, spot)
 
       assert_equal [{
         code: { 1 => "translated @ _app_views_tests_show_html_erb:3" },
-        line_number: 1
+        line_number: 1,
+        trace: wrapper.source_extracts.first[:trace]
       }], wrapper.source_extracts
     end
 
@@ -168,17 +174,20 @@ def translate_location(backtrace_location, spot)
       extracts = wrapper.source_extracts
       assert_equal({
         code: { 1 => "translated @ _app_views_tests_nested_html_erb:5" },
-        line_number: 1
+        line_number: 1,
+        trace: extracts[0][:trace]
       }, extracts[0])
       # extracts[1] is Array#each (unreliable backtrace across rubies)
       assert_equal({
         code: { 1 => "translated @ _app_views_tests_nested_html_erb:4" },
-        line_number: 1
+        line_number: 1,
+        trace: extracts[2][:trace]
       }, extracts[2])
       # extracts[3] is Array#each (unreliable backtrace across rubies)
       assert_equal({
         code: { 1 => "translated @ _app_views_tests_nested_html_erb:3" },
-        line_number: 1
+        line_number: 1,
+        trace: extracts[4][:trace]
       }, extracts[4])
     end
 
@@ -263,23 +272,27 @@ def translate_location(backtrace_location, spot)
           "Application Trace" => [
             exception_object_id: exception.object_id,
             id: 0,
-            trace: "lib/file.rb:42:in 'ActionDispatch::ExceptionWrapperTest#index'"
+            trace: wrapper.source_extracts.first[:trace],
+            filtered_trace: "lib/file.rb:42:in 'ActionDispatch::ExceptionWrapperTest#index'"
           ],
           "Framework Trace" => [
             exception_object_id: exception.object_id,
             id: 1,
-            trace: "/gems/rack.rb:43:in 'ActionDispatch::ExceptionWrapperTest#in_rack'"
+            trace: wrapper.source_extracts.second[:trace],
+            filtered_trace: "/gems/rack.rb:43:in 'ActionDispatch::ExceptionWrapperTest#in_rack'"
           ],
           "Full Trace" => [
             {
               exception_object_id: exception.object_id,
               id: 0,
-              trace: "lib/file.rb:42:in 'ActionDispatch::ExceptionWrapperTest#index'"
+              trace: wrapper.source_extracts.first[:trace],
+              filtered_trace: "lib/file.rb:42:in 'ActionDispatch::ExceptionWrapperTest#index'"
             },
             {
               exception_object_id: exception.object_id,
               id: 1,
-              trace: "/gems/rack.rb:43:in 'ActionDispatch::ExceptionWrapperTest#in_rack'"
+              trace: wrapper.source_extracts.second[:trace],
+              filtered_trace: "/gems/rack.rb:43:in 'ActionDispatch::ExceptionWrapperTest#in_rack'"
             }
           ]
         }.inspect, wrapper.traces.inspect)
@@ -288,23 +301,27 @@ def translate_location(backtrace_location, spot)
           "Application Trace" => [
             exception_object_id: exception.object_id,
             id: 0,
-            trace: "lib/file.rb:42:in `index'"
+            trace: wrapper.source_extracts.first[:trace],
+            filtered_trace: "lib/file.rb:42:in `index'"
           ],
           "Framework Trace" => [
             exception_object_id: exception.object_id,
             id: 1,
-            trace: "/gems/rack.rb:43:in `in_rack'"
+            trace: wrapper.source_extracts.last[:trace],
+            filtered_trace: "/gems/rack.rb:43:in `in_rack'"
           ],
           "Full Trace" => [
             {
               exception_object_id: exception.object_id,
               id: 0,
-              trace: "lib/file.rb:42:in `index'"
+              trace: wrapper.source_extracts.first[:trace],
+              filtered_trace: "lib/file.rb:42:in `index'"
             },
             {
               exception_object_id: exception.object_id,
               id: 1,
-              trace: "/gems/rack.rb:43:in `in_rack'"
+              trace: wrapper.source_extracts.last[:trace],
+              filtered_trace: "/gems/rack.rb:43:in `in_rack'"
             }
           ]
         }.inspect, wrapper.traces.inspect)

activesupport/lib/active_support.rb

@@ -44,6 +44,7 @@ module ActiveSupport
   autoload :CurrentAttributes
   autoload :Dependencies
   autoload :DescendantsTracker
+  autoload :Editor
   autoload :ExecutionWrapper
   autoload :Executor
   autoload :ErrorReporter

activesupport/lib/active_support/editor.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+# :markup: markdown
+
+module ActiveSupport
+  class Editor
+    @editors = {}
+    @current = false
+
+    class << self
+      # Registers a URL pattern for opening file in a given editor.
+      # This allows Rails to generate clickable links to control known editors.
+      #
+      # Example:
+      #
+      #  ActiveSupport::Editor.register("myeditor", "myeditor://%s:%d")
+      def register(name, url_pattern, aliases: [])
+        editor = new(url_pattern)
+        @editors[name] = editor
+        aliases.each do |a|
+          @editors[a] = editor
+        end
+      end
+
+      # Returns the current editor pattern if it is known.
+      # First check for the `RAILS_EDITOR` environment variable, and if it's
+      # missing, check for the `EDITOR` environment variable.
+      def current
+        if @current == false
+          @current = if editor_name = ENV["RAILS_EDITOR"] || ENV["EDITOR"]
+            @editors[editor_name]
+          end
+        end
+        @current
+      end
+
+      # :nodoc:
+
+      def find(name)
+        @editors[name]
+      end
+
+      def reset
+        @current = false
+      end
+    end
+
+    def initialize(url_pattern)
+      @url_pattern = url_pattern
+    end
+
+    def url_for(path, line)
+      sprintf(@url_pattern, path, line)
+    end
+
+    register "atom", "atom://core/open/file?filename=%s&line=%d"
+    register "cursor", "cursor://file/%s:%f"
+    register "emacs", "emacs://open?url=file://%s&line=%d", aliases: ["emacsclient"]
+    register "idea", "idea://open?file=%s&line=%d"
+    register "macvim", "mvim://open?url=file://%s&line=%d", aliases: ["mvim"]
+    register "nova", "nova://open?path=%s&line=%d"
+    register "rubymine", "x-mine://open?file=%s&line=%d"
+    register "sublime", "subl://open?url=file://%s&line=%d", aliases: ["subl"]
+    register "textmate", "txmt://open?url=file://%s&line=%d", aliases: ["mate"]
+    register "vscode", "vscode://file/%s:%d", aliases: ["code"]
+    register "vscodium", "vscodium://file/%s:%d", aliases: ["codium"]
+    register "windsurf", "windsurf://file/%s:%d"
+    register "zed", "zed://file/%s:%d"
+  end
+end