Merge pull request rails#53819 from larouxn/notification_assertions_actionpack

Migrate applicable `actionpack` tests to use `NotificationAssertions`

Author: eileencodes

actionpack/test/controller/allow_browser_test.rb

@@ -84,7 +84,7 @@ class AllowBrowserTest < ActionController::TestCase
   end
 
   test "a blocked request instruments a browser_block.action_controller event" do
-    event, *rest = capture_instrumentation_events "browser_block.action_controller" do
+    event, *rest = capture_notifications "browser_block.action_controller" do
       get_with_agent :modern, CHROME_118
     end
 
@@ -98,10 +98,4 @@ def get_with_agent(action, agent)
       @request.headers["User-Agent"] = agent
       get action
     end
-
-    def capture_instrumentation_events(pattern, &block)
-      events = []
-      ActiveSupport::Notifications.subscribed(->(e) { events << e }, pattern, &block)
-      events
-    end
 end

actionpack/test/controller/caching_test.rb

@@ -255,15 +255,9 @@ def test_render_inline_before_fragment_caching
   end
 
   def test_fragment_cache_instrumentation
-    payload = nil
-
-    subscriber = proc do |event|
-      payload = event.payload
-    end
-
-    ActiveSupport::Notifications.subscribed(subscriber, "read_fragment.action_controller") do
+    payload = capture_notifications("read_fragment.action_controller") do
       get :inline_fragment_cached
-    end
+    end.first.payload
 
     assert_equal "functional_caching", payload[:controller]
     assert_equal "inline_fragment_cached", payload[:action]

actionpack/test/controller/live_stream_test.rb

@@ -388,16 +388,15 @@ def test_send_stream
     end
 
     def test_send_stream_instrumentation
-      payload = nil
-      subscriber = proc { |event| payload = event.payload }
+      expected_payload = {
+        filename: "sample.csv",
+        disposition: "attachment",
+        type: "text/csv"
+      }
 
-      ActiveSupport::Notifications.subscribed(subscriber, "send_stream.action_controller") do
+      assert_notification("send_stream.action_controller", expected_payload) do
         get :send_stream_with_explicit_content_type
       end
-
-      assert_equal "sample.csv", payload[:filename]
-      assert_equal "attachment", payload[:disposition]
-      assert_equal "text/csv", payload[:type]
     end
 
     def test_send_stream_with_options

actionpack/test/controller/redirect_test.rb

@@ -608,15 +608,9 @@ def test_url_from_fallback
   end
 
   def test_redirect_to_instrumentation
-    payload = nil
-
-    subscriber = proc do |event|
-      payload = event.payload
-    end
-
-    ActiveSupport::Notifications.subscribed(subscriber, "redirect_to.action_controller") do
+    payload = capture_notifications("redirect_to.action_controller") do
       get :simple_redirect
-    end
+    end.first.payload
 
     assert_equal request, payload[:request]
     assert_equal 302, payload[:status]

actionpack/test/controller/send_file_test.rb

@@ -209,33 +209,18 @@ def test_send_file_from_before_action
 
   def test_send_file_instrumentation
     @controller.options = { disposition: :inline }
-    payload = nil
 
-    subscriber = proc do |event|
-      payload = event.payload
-    end
-
-    ActiveSupport::Notifications.subscribed(subscriber, "send_file.action_controller") do
+    assert_notification("send_file.action_controller", path: __FILE__, disposition: :inline) do
       process("file")
     end
-
-    assert_equal __FILE__, payload[:path]
-    assert_equal :inline, payload[:disposition]
   end
 
   def test_send_data_instrumentation
     @controller.options = { content_type: "application/x-ruby" }
-    payload = nil
 
-    subscriber = proc do |event|
-      payload = event.payload
-    end
-
-    ActiveSupport::Notifications.subscribed(subscriber, "send_data.action_controller") do
+    assert_notification("send_data.action_controller", content_type: "application/x-ruby") do
       process("data")
     end
-
-    assert_equal("application/x-ruby", payload[:content_type])
   end
 
   %w(file data).each do |method|

actionpack/test/dispatch/middleware_stack_test.rb

@@ -193,23 +193,22 @@ def test_delete_works
   end
 
   test "instruments the execution of middlewares" do
-    events = []
-
-    subscriber = proc { |event| events << event }
-
-    ActiveSupport::Notifications.subscribed(subscriber, "process_middleware.action_dispatch") do
-      app = Rack::Lint.new(
-        @stack.build(Rack::Lint.new(proc { |env| [200, {}, []] }))
-      )
-
-      env = Rack::MockRequest.env_for("", {})
-      assert_nothing_raised do
-        app.call(env)
+    notification_name = "process_middleware.action_dispatch"
+
+    assert_notifications_count(notification_name, 2) do
+      assert_notification(notification_name, { middleware: "MiddlewareStackTest::BarMiddleware" }) do
+        assert_notification(notification_name, { middleware: "MiddlewareStackTest::FooMiddleware" }) do
+          app = Rack::Lint.new(
+            @stack.build(Rack::Lint.new(proc { |env| [200, {}, []] }))
+          )
+
+          env = Rack::MockRequest.env_for("", {})
+          assert_nothing_raised do
+            app.call(env)
+          end
+        end
       end
     end
-
-    assert_equal 2, events.count
-    assert_equal ["MiddlewareStackTest::BarMiddleware", "MiddlewareStackTest::FooMiddleware"], events.map { |e| e.payload[:middleware] }
   end
 
   test "includes a middleware" do

actionpack/test/dispatch/routing/instrumentation_test.rb

@@ -8,7 +8,11 @@ class RoutingInstrumentationTest < ActionDispatch::IntegrationTest
       get "redirect", to: redirect("/login")
     end
 
-    event = subscribed("redirect.action_dispatch") { get "/redirect" }
+    event = capture_notifications("redirect.action_dispatch") do
+      assert_notifications_count("redirect.action_dispatch", 1) do
+        get "/redirect"
+      end
+    end.first
 
     assert_equal 301, event.payload[:status]
     assert_equal "http://www.example.com/login", event.payload[:location]
@@ -23,11 +27,4 @@ def draw(&block)
         @app = RoutedRackApp.new routes
       end
     end
-
-    def subscribed(event_pattern, &block)
-      event = nil
-      subscriber = -> (_event) { event = _event }
-      ActiveSupport::Notifications.subscribed(subscriber, event_pattern, &block)
-      event
-    end
 end