Respect broadcast suppressions on before/after actions (#770)

* Respect broadcast suppressions in before/after actions

* Correct typo in broadcast suppression test helper function

* Call correct method when testing _render_later_to suppression

* Pass name of explicit stream targets in broadcast suppression assertions

Broadcast methods ending with `_to` accept a target stream name as positional
arguments. Other methods target call `#to_gid_param` to choose a stream name.

The prior tests assumed that only those default stream names would be used.
As a result, tests on broadcasts with explicitly targeted streams were never
caught by the assertions. (broadcast_remove_to 'foobar' targets 'foobar', so
we would never find a broadcast on `@message.to_gid_param`)

The false positives caused missing suppression checks in `broadcast_before_to`
and `broadcast_after_to` to go unnoticed.

Author: stowersjoshua

app/models/concerns/turbo/broadcastable.rb

@@ -311,7 +311,7 @@ def broadcast_update(**rendering)
   def broadcast_before_to(*streamables, target: nil, targets: nil, **rendering)
     raise ArgumentError, "at least one of target or targets is required" unless target || targets
 
-    Turbo::StreamsChannel.broadcast_before_to(*streamables, **extract_options_and_add_target(rendering.merge(target: target, targets: targets)))
+    Turbo::StreamsChannel.broadcast_before_to(*streamables, **extract_options_and_add_target(rendering.merge(target: target, targets: targets))) unless suppressed_turbo_broadcasts?
   end
 
   # Insert a rendering of this broadcastable model after the target identified by it's dom id passed as <tt>target</tt>
@@ -329,7 +329,7 @@ def broadcast_before_to(*streamables, target: nil, targets: nil, **rendering)
   def broadcast_after_to(*streamables, target: nil, targets: nil, **rendering)
     raise ArgumentError, "at least one of target or targets is required" unless target || targets
 
-    Turbo::StreamsChannel.broadcast_after_to(*streamables, **extract_options_and_add_target(rendering.merge(target: target, targets: targets)))
+    Turbo::StreamsChannel.broadcast_after_to(*streamables, **extract_options_and_add_target(rendering.merge(target: target, targets: targets))) unless suppressed_turbo_broadcasts?
   end
 
   # Append a rendering of this broadcastable model to the target identified by it's dom id passed as <tt>target</tt>

test/streams/broadcastable_test.rb

@@ -525,7 +525,7 @@ class Turbo::SuppressingBroadcastsTest < ActionCable::Channel::TestCase
   setup { @message = Message.new(id: 1, content: "Hello!") }
 
   test "suppressing broadcasting remove to stream now" do
-    assert_no_broadcasts_when_suppressing do
+    assert_no_broadcasts_when_suppressing "stream" do
       @message.broadcast_remove_to "stream"
     end
   end
@@ -537,13 +537,13 @@ class Turbo::SuppressingBroadcastsTest < ActionCable::Channel::TestCase
   end
 
   test "suppressing broadcasting replace to stream now" do
-    assert_no_broadcasts_when_suppressing do
+    assert_no_broadcasts_when_suppressing "stream" do
       @message.broadcast_replace_to "stream"
     end
   end
 
   test "suppressing broadcasting replace to stream later" do
-    assert_no_broadcasts_later_when_supressing do
+    assert_no_broadcasts_later_when_suppressing "stream" do
       @message.broadcast_replace_later_to "stream"
     end
   end
@@ -555,19 +555,19 @@ class Turbo::SuppressingBroadcastsTest < ActionCable::Channel::TestCase
   end
 
   test "suppressing broadcasting replace later" do
-    assert_no_broadcasts_later_when_supressing do
+    assert_no_broadcasts_later_when_suppressing do
       @message.broadcast_replace_later
     end
   end
 
   test "suppressing broadcasting update to stream now" do
-    assert_no_broadcasts_when_suppressing do
+    assert_no_broadcasts_when_suppressing "stream" do
       @message.broadcast_update_to "stream"
     end
   end
 
   test "suppressing broadcasting update to stream later" do
-    assert_no_broadcasts_later_when_supressing do
+    assert_no_broadcasts_later_when_suppressing "stream" do
       @message.broadcast_update_later_to "stream"
     end
   end
@@ -579,31 +579,31 @@ class Turbo::SuppressingBroadcastsTest < ActionCable::Channel::TestCase
   end
 
   test "suppressing broadcasting update later" do
-    assert_no_broadcasts_later_when_supressing do
+    assert_no_broadcasts_later_when_suppressing do
       @message.broadcast_update_later
     end
   end
 
   test "suppressing broadcasting before to stream now" do
-    assert_no_broadcasts_when_suppressing do
+    assert_no_broadcasts_when_suppressing "stream" do
       @message.broadcast_before_to "stream", target: "message_1"
     end
   end
 
   test "suppressing broadcasting after to stream now" do
-    assert_no_broadcasts_when_suppressing do
+    assert_no_broadcasts_when_suppressing "stream" do
       @message.broadcast_after_to "stream", target: "message_1"
     end
   end
 
   test "suppressing broadcasting append to stream now" do
-    assert_no_broadcasts_when_suppressing do
+    assert_no_broadcasts_when_suppressing "stream" do
       @message.broadcast_append_to "stream"
     end
   end
 
   test "suppressing broadcasting append to stream later" do
-    assert_no_broadcasts_later_when_supressing do
+    assert_no_broadcasts_later_when_suppressing "stream" do
       @message.broadcast_append_later_to "stream"
     end
   end
@@ -615,31 +615,31 @@ class Turbo::SuppressingBroadcastsTest < ActionCable::Channel::TestCase
   end
 
   test "suppressing broadcasting append later" do
-    assert_no_broadcasts_later_when_supressing do
+    assert_no_broadcasts_later_when_suppressing do
       @message.broadcast_append_later
     end
   end
 
   test "suppressing broadcasting prepend to stream now" do
-    assert_no_broadcasts_when_suppressing do
+    assert_no_broadcasts_when_suppressing "stream" do
       @message.broadcast_prepend_to "stream"
     end
   end
 
   test "suppressing broadcasting prepend to stream later" do
-    assert_no_broadcasts_later_when_supressing do
+    assert_no_broadcasts_later_when_suppressing "stream" do
       @message.broadcast_prepend_later_to "stream"
     end
   end
 
   test "suppressing broadcasting refresh to stream now" do
-    assert_no_broadcasts_when_suppressing do
+    assert_no_broadcasts_when_suppressing "stream" do
       @message.broadcast_refresh_to "stream"
     end
   end
 
   test "suppressing broadcasting refresh to stream later" do
-    assert_no_broadcasts_later_when_supressing do
+    assert_no_broadcasts_later_when_suppressing "stream" do
       @message.broadcast_refresh_later_to "stream"
     end
   end
@@ -651,19 +651,19 @@ class Turbo::SuppressingBroadcastsTest < ActionCable::Channel::TestCase
   end
 
   test "suppressing broadcasting prepend later" do
-    assert_no_broadcasts_later_when_supressing do
+    assert_no_broadcasts_later_when_suppressing do
       @message.broadcast_prepend_later
     end
   end
 
   test "suppressing broadcasting action to stream now" do
-    assert_no_broadcasts_when_suppressing do
+    assert_no_broadcasts_when_suppressing "stream" do
       @message.broadcast_action_to "stream", action: "prepend"
     end
   end
 
   test "suppressing broadcasting action to stream later" do
-    assert_no_broadcasts_later_when_supressing do
+    assert_no_broadcasts_later_when_suppressing "stream" do
       @message.broadcast_action_later_to "stream", action: "prepend"
     end
   end
@@ -675,7 +675,7 @@ class Turbo::SuppressingBroadcastsTest < ActionCable::Channel::TestCase
   end
 
   test "suppressing broadcasting action later" do
-    assert_no_broadcasts_later_when_supressing do
+    assert_no_broadcasts_later_when_suppressing do
       @message.broadcast_action_later action: "prepend"
     end
   end
@@ -687,36 +687,34 @@ class Turbo::SuppressingBroadcastsTest < ActionCable::Channel::TestCase
   end
 
   test "suppressing broadcast render later" do
-    assert_no_broadcasts_later_when_supressing do
+    assert_no_broadcasts_later_when_suppressing do
       @message.broadcast_render_later
     end
   end
 
   test "suppressing broadcast render to stream now" do
-    @profile = Users::Profile.new(id: 1, name: "Ryan")
     assert_no_broadcasts_when_suppressing do
-      @message.broadcast_render_to @profile
+      @message.broadcast_render_to "stream"
     end
   end
 
   test "suppressing broadcast render to stream later" do
-    @profile = Users::Profile.new(id: 1, name: "Ryan")
-    assert_no_broadcasts_later_when_supressing do
-      @message.broadcast_render_to @profile
+    assert_no_broadcasts_later_when_suppressing do
+      @message.broadcast_render_later_to "stream"
     end
   end
 
   private
-    def assert_no_broadcasts_when_suppressing
-      assert_no_broadcasts @message.to_gid_param do
+    def assert_no_broadcasts_when_suppressing(stream = @message.to_gid_param)
+      assert_no_broadcasts stream do
         Message.suppressing_turbo_broadcasts do
           yield
         end
       end
     end
 
-    def assert_no_broadcasts_later_when_supressing
-      assert_no_broadcasts_when_suppressing do
+    def assert_no_broadcasts_later_when_suppressing(stream = @message.to_gid_param)
+      assert_no_broadcasts_when_suppressing stream do
         assert_no_enqueued_jobs do
           yield
         end