Merge pull request rails#55296 from rails/fxn/da-notifications

Pass the user-facing reflection when notifying deprecated HABTMs

Author: fxn

activerecord/lib/active_record/associations/deprecation.rb

@@ -37,6 +37,8 @@ def guard(reflection)
     end
 
     def report(reflection, context:)
+      reflection = user_facing_reflection(reflection)
+
       message = +"The association #{reflection.active_record}##{reflection.name} is deprecated, #{context}"
       message << " (#{backtrace_cleaner.first_clean_frame})"
 
@@ -75,6 +77,15 @@ def clean_locations
       def set_backtrace_supports_array_of_locations?
         @backtrace_supports_array_of_locations ||= Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("3.4.0")
       end
+
+      def user_facing_reflection(reflection)
+        case reflection.parent_reflection
+        when ActiveRecord::Reflection::HasAndBelongsToManyReflection
+          reflection.parent_reflection
+        else
+          reflection
+        end
+      end
   end
 
   self.mode = :warn

activerecord/test/cases/associations/deprecation_test.rb

@@ -212,6 +212,18 @@ def teardown
       ActiveRecord::LogSubscriber.backtrace_cleaner = @original_backtrace_cleaner
     end
 
+    def assert_user_facing_reflection(model, association)
+      payloads = []
+      callback = ->(event) { payloads << event.payload }
+
+      ActiveSupport::Notifications.subscribed(callback, "deprecated_association.active_record") do
+        model.new.send(association)
+      end
+
+      assert_equal 1, payloads.size
+      assert_equal model.reflect_on_association(association), payloads[0][:reflection]
+    end
+
     test "report publishes an Active Support notification in :notify mode" do
       payloads = []
       callback = ->(event) { payloads << event.payload }
@@ -234,5 +246,29 @@ def teardown
       assert_equal __FILE__, payload[:backtrace][-2].path
       assert_equal line, payload[:backtrace][-2].lineno
     end
+
+    test "has_many receives the user-facing reflection in the payload" do
+      assert_user_facing_reflection(DATS::Author, :deprecated_posts)
+    end
+
+    test "has_one receives the user-facing reflection in the payload" do
+      assert_user_facing_reflection(DATS::Author, :deprecated_post)
+    end
+
+    test "belongs_to receives the user-facing reflection in the payload" do
+      assert_user_facing_reflection(DATS::Bulb, :deprecated_car)
+    end
+
+    test "has_many :through receives the user-facing reflection in the payload" do
+      assert_user_facing_reflection(DATS::Author, :deprecated_has_many_through)
+    end
+
+    test "has_one :through receives the user-facing reflection in the payload" do
+      assert_user_facing_reflection(DATS::Author, :deprecated_has_one_through)
+    end
+
+    test "HABTM receives the user-facing reflection in the payload" do
+      assert_user_facing_reflection(DATS::Category, :deprecated_posts)
+    end
   end
 end