Merge pull request rails#54126 from larouxn/notif_assert_small_revamp

Update `NotificationAssertions`'s  `assert_notifcation` to match against payload subsets and return matched notification

Author: byroot

actionmailer/test/base_test.rb

@@ -973,14 +973,13 @@ def a_callback
   end
 
   test "notification for deliver" do
-    event = capture_notifications("deliver.action_mailer") do
-      assert_notifications_count("deliver.action_mailer", 1) do
+    assert_notifications_count("deliver.action_mailer", 1) do
+      notification = assert_notification("deliver.action_mailer") do
         BaseMailer.welcome(body: "Hello there").deliver_now
       end
-    end.first
 
-    assert_equal "deliver.action_mailer", event.name
-    assert_not_nil event.payload[:message_id]
+      assert_not_nil notification.payload[:message_id]
+    end
   end
 
   private

actionpack/test/controller/allow_browser_test.rb

@@ -84,13 +84,12 @@ class AllowBrowserTest < ActionController::TestCase
   end
 
   test "a blocked request instruments a browser_block.action_controller event" do
-    event, *rest = capture_notifications "browser_block.action_controller" do
+    notification = assert_notification("browser_block.action_controller") do
       get_with_agent :modern, CHROME_118
     end
 
-    assert_equal request, event.payload[:request]
-    assert_not_empty event.payload[:versions]
-    assert_empty rest
+    assert_equal request, notification.payload[:request]
+    assert_not_empty notification.payload[:versions]
   end
 
   private

actionpack/test/controller/caching_test.rb

@@ -255,12 +255,9 @@ def test_render_inline_before_fragment_caching
   end
 
   def test_fragment_cache_instrumentation
-    payload = capture_notifications("read_fragment.action_controller") do
+    assert_notification("read_fragment.action_controller", controller: "functional_caching", action: "inline_fragment_cached") do
       get :inline_fragment_cached
-    end.first.payload
-
-    assert_equal "functional_caching", payload[:controller]
-    assert_equal "inline_fragment_cached", payload[:action]
+    end
   end
 
   def test_html_formatted_fragment_caching

actionpack/test/controller/redirect_test.rb

@@ -608,13 +608,11 @@ def test_url_from_fallback
   end
 
   def test_redirect_to_instrumentation
-    payload = capture_notifications("redirect_to.action_controller") do
+    notification = assert_notification("redirect_to.action_controller", status: 302, location: "http://test.host/redirect/hello_world") do
       get :simple_redirect
-    end.first.payload
+    end
 
-    assert_equal request, payload[:request]
-    assert_equal 302, payload[:status]
-    assert_equal "http://test.host/redirect/hello_world", payload[:location]
+    assert_kind_of ActionDispatch::Request, notification.payload[:request]
   end
 
   def test_redirect_to_external_with_rescue

actionpack/test/dispatch/routing/instrumentation_test.rb

@@ -8,15 +8,11 @@ class RoutingInstrumentationTest < ActionDispatch::IntegrationTest
       get "redirect", to: redirect("/login")
     end
 
-    event = capture_notifications("redirect.action_dispatch") do
-      assert_notifications_count("redirect.action_dispatch", 1) do
-        get "/redirect"
-      end
-    end.first
+    notification = assert_notification("redirect.action_dispatch", status: 301, location: "http://www.example.com/login") do
+      get "/redirect"
+    end
 
-    assert_equal 301, event.payload[:status]
-    assert_equal "http://www.example.com/login", event.payload[:location]
-    assert_kind_of ActionDispatch::Request, event.payload[:request]
+    assert_kind_of ActionDispatch::Request, notification.payload[:request]
   end
 
   private

actionview/test/activerecord/partial_rendering_query_test.rb

@@ -10,13 +10,10 @@ def setup
   end
 
   def test_render_with_relation_collection
-    notifications = capture_notifications("sql.active_record") do
-      @view.render partial: "topics/topic", collection: Topic.all
+    assert_notifications_count("sql.active_record", 1) do
+      assert_notification("sql.active_record", sql: 'SELECT "topics".* FROM "topics"') do
+        @view.render partial: "topics/topic", collection: Topic.all
+      end
     end
-
-    queries = notifications.filter_map { _1.payload[:sql] unless %w[ SCHEMA TRANSACTION ].include?(_1.payload[:name]) }
-
-    assert_equal 1, queries.size
-    assert_equal 'SELECT "topics".* FROM "topics"', queries[0]
   end
 end

activejob/test/cases/queuing_test.rb

@@ -97,12 +97,10 @@ class QueuingTest < ActiveSupport::TestCase
   test "perform_all_later instrumentation" do
     jobs = HelloJob.new("Jamie"), HelloJob.new("John")
 
-    payload = capture_notifications("enqueue_all.active_job") do
+    notification = assert_notification("enqueue_all.active_job", jobs:, enqueued_count: 2) do
       ActiveJob.perform_all_later(jobs)
-    end.first.payload
+    end
 
-    assert payload[:adapter]
-    assert_equal jobs, payload[:jobs]
-    assert_equal 2, payload[:enqueued_count]
+    assert notification.payload[:adapter]
   end
 end

activerecord/test/activejob/job_runtime_test.rb

@@ -15,17 +15,14 @@ def perform(*)
   test "job notification payload includes db_runtime" do
     ActiveRecord::RuntimeRegistry.sql_runtime = 0.0
 
-    event = capture_notifications("perform.active_job") { TestJob.perform_now }.first
-
-    assert_equal 42, event.payload[:db_runtime]
+    assert_notification("perform.active_job", db_runtime: 42.0) { TestJob.perform_now }
   end
 
   test "db_runtime tracks database runtime for job only" do
     ActiveRecord::RuntimeRegistry.sql_runtime = 100.0
 
-    event = capture_notifications("perform.active_job") { TestJob.perform_now }.first
+    assert_notification("perform.active_job", db_runtime: 42.0) { TestJob.perform_now }
 
-    assert_equal 42.0, event.payload[:db_runtime]
     assert_equal 142.0, ActiveRecord::RuntimeRegistry.sql_runtime
   end
 end

activerecord/test/cases/associations/eager_test.rb

@@ -1136,14 +1136,14 @@ def test_count_with_include
   end
 
   def test_association_loading_notification
-    payload = capture_notifications("instantiation.active_record") do
+    notification = assert_notification("instantiation.active_record", class_name: Developer.name) do
       Developer.all.merge!(includes: "projects", where: { "developers_projects.access_level" => 1 }, limit: 5).to_a.size
-    end.first.payload
+    end
+
     count = Developer.all.merge!(includes: "projects", where: { "developers_projects.access_level" => 1 }, limit: 5).to_a.size
 
     # eagerloaded row count should be greater than just developer count
-    assert_operator payload[:record_count], :>, count
-    assert_equal Developer.name, payload[:class_name]
+    assert_operator notification.payload[:record_count], :>, count
   end
 
   def test_base_messages

activerecord/test/cases/instrumentation_test.rb

@@ -128,11 +128,7 @@ def test_payload_row_count_on_cache
     end
 
     def test_payload_connection_with_query_cache_disabled
-      connection = ClothingItem.lease_connection
-
-      payload = capture_notifications("sql.active_record") { Book.first }.first.payload
-
-      assert_equal connection, payload[:connection]
+      assert_notification("sql.active_record", connection: ClothingItem.lease_connection) { Book.first }
     end
 
     def test_payload_connection_with_query_cache_enabled