Merge pull request rails#51670 from Shopify/fix-backtrace-cleaner

Fix backtrace cleaner

Author: rafaelfranca

railties/lib/rails/application/bootstrap.rb

@@ -75,10 +75,6 @@ module Bootstrap
         end
       end
 
-      initializer :configure_backtrace_cleaner, group: :all do
-        Rails.backtrace_cleaner.remove_silencers! if ENV["BACKTRACE"]
-      end
-
       # Initialize cache early in the stack so railties can make use of it.
       initializer :initialize_cache, group: :all do
         cache_format_version = config.active_support.delete(:cache_format_version)

railties/lib/rails/backtrace_cleaner.rb

@@ -25,5 +25,18 @@ def initialize
       end
       add_silencer { |line| !APP_DIRS_PATTERN.match?(line) }
     end
+
+    def clean(backtrace, kind = :silent)
+      kind = nil if ENV["BACKTRACE"]
+
+      super(backtrace, kind)
+    end
+    alias_method :filter, :clean
+
+    def clean_frame(frame, kind = :silent)
+      kind = nil if ENV["BACKTRACE"]
+
+      super(frame, kind)
+    end
   end
 end

railties/test/application/backtrace_cleaner_test.rb

@@ -1,68 +1,55 @@
 # frozen_string_literal: true
 
-require "isolation/abstract_unit"
-require "rack/test"
 require "env_helpers"
 
 module ApplicationTests
   class BacktraceCleanerTest < ActiveSupport::TestCase
-    include ActiveSupport::Testing::Isolation
-    include Rack::Test::Methods
     include EnvHelpers
 
-    def teardown
-      teardown_app
+    setup do
+      @cleaner = Rails::BacktraceCleaner.new
     end
 
-    test "backtrace is cleaned" do
-      setup_app
+    test "#clean silences Rails code from backtrace" do
+      backtrace = [
+        "app/controllers/foo_controller.rb:4:in 'index'",
+        "rails/railties/lib/rails/engine.rb:536:in `call"
+      ]
 
-      app("development")
-      get "/"
-      if RUBY_VERSION >= "3.4"
-        assert_includes last_response.body, "app/app/controllers/foo_controller.rb:4:in 'FooController#index'"
-      else
-        assert_includes last_response.body, "app/app/controllers/foo_controller.rb:4:in `index'"
-      end
-      assert_not_includes last_response.body, "rails/railties/test/env_helpers.rb"
+      cleaned = @cleaner.clean(backtrace)
+
+      assert_equal ["app/controllers/foo_controller.rb:4:in 'index'"], cleaned
     end
 
-    test "backtrace is not cleaned" do
+    test "#clean does not silence when BACKTRACE is set" do
       switch_env("BACKTRACE", "1") do
-        setup_app
+        backtrace = [
+          "app/app/controllers/foo_controller.rb:4:in 'index'",
+          "/rails/railties/lib/rails/engine.rb:536:in `call"
+        ]
+
+        cleaned = @cleaner.clean(backtrace)
 
-        app("development")
-        get "/"
-        if RUBY_VERSION >= "3.4"
-          assert_includes last_response.body, "app/app/controllers/foo_controller.rb:4:in 'FooController#index'"
-        else
-          assert_includes last_response.body, "app/app/controllers/foo_controller.rb:4:in `index'"
-        end
-        assert_includes last_response.body, "rails/railties/test/env_helpers.rb"
+        assert_equal backtrace, cleaned
       end
     end
 
-    private
-      def setup_app
-        build_app
+    test "#clean_frame silences Rails code" do
+      frame = "rails/railties/lib/rails/engine.rb:536:in `call"
 
-        controller :foo, <<-RUBY
-          class FooController < ApplicationController
-            def index
-              begin
-                raise "ERROR"
-              rescue StandardError => e
-                render plain: e.backtrace.join("\n")
-              end
-            end
-          end
-        RUBY
+      cleaned = @cleaner.clean_frame(frame)
+
+      assert_equal nil, cleaned
+    end
 
-        app_file "config/routes.rb", <<-RUBY
-          Rails.application.routes.draw do
-            root to: "foo#index"
-          end
-        RUBY
+    test "#clean_frame does not silence when BACKTRACE is set" do
+      switch_env("BACKTRACE", "1") do
+        frame = "rails/railties/lib/rails/engine.rb:536:in `call"
+
+        cleaned = @cleaner.clean_frame(frame)
+
+        assert_equal frame, cleaned
       end
+    end
   end
 end