Merge pull request rails#50053 from Shopify/deprecator-source-templates

ActiveSupport::Deprecation handle blaming generated code

Author: byroot

activesupport/lib/active_support/deprecation/reporting.rb

@@ -142,15 +142,17 @@ def extract_callstack(callstack)
           return _extract_callstack(callstack) if callstack.first.is_a? String
 
           offending_line = callstack.find { |frame|
-            frame.absolute_path && !ignored_callstack(frame.absolute_path)
+            # Code generated with `eval` doesn't have an `absolute_path`, e.g. templates.
+            path = frame.absolute_path || frame.path
+            path && !ignored_callstack?(path)
           } || callstack.first
 
           [offending_line.path, offending_line.lineno, offending_line.label]
         end
 
         def _extract_callstack(callstack)
           warn "Please pass `caller_locations` to the deprecation API" if $VERBOSE
-          offending_line = callstack.find { |line| !ignored_callstack(line) } || callstack.first
+          offending_line = callstack.find { |line| !ignored_callstack?(line) } || callstack.first
 
           if offending_line
             if md = offending_line.match(/^(.+?):(\d+)(?::in `(.*?)')?/)
@@ -162,9 +164,10 @@ def _extract_callstack(callstack)
         end
 
         RAILS_GEM_ROOT = File.expand_path("../../../..", __dir__) + "/"
+        LIB_DIR = RbConfig::CONFIG["libdir"]
 
-        def ignored_callstack(path)
-          path.start_with?(RAILS_GEM_ROOT) || path.start_with?(RbConfig::CONFIG["rubylibdir"])
+        def ignored_callstack?(path)
+          path.start_with?(RAILS_GEM_ROOT, LIB_DIR)
         end
     end
   end

activesupport/test/deprecation_test.rb

@@ -951,6 +951,18 @@ def method
     assert_equal __LINE__ - 2, @callstack.first.lineno
   end
 
+  class_eval(<<~RUBY, "/path/to/template.html.erb", 1)
+    def generated_method_that_call_deprecation(deprecator)
+      deprecator.warn("Here", caller_locations(0, 10))
+    end
+  RUBY
+
+  test "warn deprecation can blame code generated with eval" do
+    @deprecator.behavior = ->(message, *) { @message = message }
+    generated_method_that_call_deprecation(@deprecator)
+    assert_equal "DEPRECATION WARNING: Here (called from generated_method_that_call_deprecation at /path/to/template.html.erb:2)", @message
+  end
+
   private
     def method_that_emits_deprecation(deprecator)
       deprecator.warn