Merge pull request rails#55222 from rails/fxn/first_clean_frame

Implement ActiveSupport::BacktraceCleaner#first_clean_frame

Author: fxn

activejob/lib/active_job/log_subscriber.rb

@@ -256,11 +256,7 @@ def log_enqueue_source
       end
 
       def enqueue_source_location
-        Thread.each_caller_location do |location|
-          frame = backtrace_cleaner.clean_frame(location)
-          return frame if frame
-        end
-        nil
+        backtrace_cleaner.first_clean_frame
       end
 
       def enqueued_jobs_message(adapter, enqueued_jobs)

activerecord/lib/active_record/log_subscriber.rb

@@ -127,11 +127,7 @@ def log_query_source
       end
 
       def query_source_location
-        Thread.each_caller_location do |location|
-          frame = backtrace_cleaner.clean_frame(location)
-          return frame if frame
-        end
-        nil
+        backtrace_cleaner.first_clean_frame
       end
 
       def filter(name, value)

activerecord/lib/active_record/query_logs.rb

@@ -153,11 +153,7 @@ def clear_cache # :nodoc:
       end
 
       def query_source_location # :nodoc:
-        Thread.each_caller_location do |location|
-          frame = LogSubscriber.backtrace_cleaner.clean_frame(location)
-          return frame if frame
-        end
-        nil
+        LogSubscriber.backtrace_cleaner.first_clean_frame
       end
 
       ActiveSupport::ExecutionContext.after_change { ActiveRecord::QueryLogs.clear_cache }

activesupport/CHANGELOG.md

@@ -1,3 +1,9 @@
+*   The new method `ActiveSupport::BacktraceCleaner#first_clean_frame` returns
+    the first clean frame of the caller's backtrace, or `nil`. Useful when you
+    want to report the application-level location where something happened.
+
+    *Xavier Noria*
+
 *   Always clear `CurrentAttribute` instances.
 
     Previously `CurrentAttribute` instance would be reset at the end of requests.

activesupport/lib/active_support/backtrace_cleaner.rb

@@ -74,6 +74,32 @@ def clean_frame(frame, kind = :silent)
       end
     end
 
+    # Thread.each_caller_location does not accept a start in Ruby < 3.4.
+    if Thread.method(:each_caller_location).arity == 0
+      # Returns the first clean frame of the caller's backtrace, or +nil+.
+      def first_clean_frame(kind = :silent)
+        caller_location_skipped = false
+
+        Thread.each_caller_location do |location|
+          unless caller_location_skipped
+            caller_location_skipped = true
+            next
+          end
+
+          frame = clean_frame(location, kind)
+          return frame if frame
+        end
+      end
+    else
+      # Returns the first clean frame of the caller's backtrace, or +nil+.
+      def first_clean_frame(kind = :silent)
+        Thread.each_caller_location(2) do |location|
+          frame = clean_frame(location, kind)
+          return frame if frame
+        end
+      end
+    end
+
     # Adds a filter from the block provided. Each line in the backtrace will be
     # mapped against this filter.
     #

activesupport/test/backtrace_cleaner_test.rb

@@ -136,3 +136,47 @@ def setup
     assert_equal backtrace, @bc.clean(backtrace)
   end
 end
+
+class BacktraceCleanerFirstCleanFrame < ActiveSupport::TestCase
+  def setup
+    @bc = ActiveSupport::BacktraceCleaner.new
+  end
+
+  def invoke_first_clean_frame_defaults
+    -> do
+      @bc.first_clean_frame.tap { @line = __LINE__ + 1 }
+    end.call
+  end
+
+  def invoke_first_clean_frame(kind = :silent)
+    -> do
+      @bc.first_clean_frame(kind).tap { @line = __LINE__ + 1 }
+    end.call
+  end
+
+  test "returns the first clean frame (defaults)" do
+    result = invoke_first_clean_frame_defaults
+    assert_match(/\A#{__FILE__}:#@line:in [`'](#{self.class}#)?invoke_first_clean_frame_defaults[`']\z/, result)
+  end
+
+  test "returns the first clean frame (:silent)" do
+    result = invoke_first_clean_frame(:silent)
+    assert_match(/\A#{__FILE__}:#@line:in [`'](#{self.class}#)?invoke_first_clean_frame[`']\z/, result)
+  end
+
+  test "returns the first clean frame (:noise)" do
+    @bc.add_silencer { true }
+    result = invoke_first_clean_frame(:noise)
+    assert_match(/\A#{__FILE__}:#@line:in [`'](#{self.class}#)?invoke_first_clean_frame[`']\z/, result)
+  end
+
+  test "returns the first clean frame (:any)" do
+    result = invoke_first_clean_frame(:any) # fallback of the case statement
+    assert_match(/\A#{__FILE__}:#@line:in [`'](#{self.class}#)?invoke_first_clean_frame[`']\z/, result)
+  end
+
+  test "returns nil if there is no clean frame" do
+    @bc.add_silencer { true }
+    assert_nil invoke_first_clean_frame_defaults
+  end
+end