Merge pull request rails#55255 from rails/fxn/clean_locations

Implement ActiveSupport::BacktraceCleaner#clean_locations

Author: fxn

activesupport/CHANGELOG.md

@@ -1,3 +1,17 @@
+*   Given an array of `Thread::Backtrace::Location` objects, the new method
+    `ActiveSupport::BacktraceCleaner#clean_locations` returns an array with the
+    clean ones:
+
+    ```ruby
+    clean_locations = backtrace_cleaner.clean_locations(caller_locations)
+    ```
+
+    Filters and silencers receive strings as usual. However, the `path`
+    attributes of the locations in the returned array are the original,
+    unfiltered ones, since locations are immutable.
+
+    *Xavier Noria*
+
 *   Improve `CurrentAttribute` and `ExecutionContext` state managment in test cases.
 
     Previously these two global state would be entirely cleared out whenever calling

activesupport/lib/active_support/backtrace_cleaner.rb

@@ -56,6 +56,18 @@ def clean(backtrace, kind = :silent)
     end
     alias :filter :clean
 
+    # Given an array of Thread::Backtrace::Location objects, returns an array
+    # with the clean ones:
+    #
+    #     clean_locations = backtrace_cleaner.clean_locations(caller_locations)
+    #
+    # Filters and silencers receive strings as usual. However, the +path+
+    # attributes of the locations in the returned array are the original,
+    # unfiltered ones, since locations are immutable.
+    def clean_locations(locations, kind = :silent)
+      locations.select { |location| clean_frame(location, kind) }
+    end
+
     # Returns the frame with all filters applied.
     # returns +nil+ if the frame was silenced.
     def clean_frame(frame, kind = :silent)

activesupport/test/backtrace_cleaner_test.rb

@@ -232,3 +232,48 @@ def invoke_first_clean_location(kind = :silent)
     assert_nil invoke_first_clean_location_defaults
   end
 end
+
+class BacktraceCleanerCleanLocationsTest < ActiveSupport::TestCase
+  def setup
+    @bc = ActiveSupport::BacktraceCleaner.new
+    @locations = indirect_caller_locations
+  end
+
+  # Adds a frame from this file to the call stack.
+  def indirect_caller_locations
+    caller_locations
+  end
+
+  test "returns all clean locations (defaults)" do
+    cleaned_locations = @bc.clean_locations(@locations)
+    assert_equal [__FILE__], cleaned_locations.map(&:path)
+  end
+
+  test "returns all clean locations (:silent)" do
+    cleaned_locations = @bc.clean_locations(@locations, :silent)
+    assert_equal [__FILE__], cleaned_locations.map(&:path)
+  end
+
+  test "returns all clean locations (:noise)" do
+    cleaned_locations = @bc.clean_locations(@locations, :noise)
+    assert_not_includes cleaned_locations.map(&:path), __FILE__
+  end
+
+  test "returns an empty array if there are no clean locations" do
+    @bc.add_silencer { true }
+    assert_equal [], @bc.clean_locations(@locations)
+  end
+
+  test "filters and silencers are applied" do
+    @bc.remove_filters!
+    @bc.remove_silencers!
+
+    # We filter all locations as "foo", then we silence filtered strings that
+    # are exactly "foo". If filters and silencers are correctly applied, we
+    # should get no locations back.
+    @bc.add_filter { "foo" }
+    @bc.add_silencer { "foo" == _1 }
+
+    assert_equal [], @bc.clean_locations(@locations)
+  end
+end