Fix sending created broadcasts refreshes to channels where no one listens #521
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
test/dummy/app/models/board.rb
Outdated
Comment on lines
1
to
5
| class Board < ApplicationRecord | ||
| has_many :tasks | ||
|
|
||
| broadcasts_refreshes | ||
| end |
There was a problem hiding this comment.
Why is a new model necessary to test this?
There was a problem hiding this comment.
I added one that actually uses the broadcasts_refreshes. I'm not that versed in Rails, so pls let me know if there's another way to test this
There was a problem hiding this comment.
I think adding it to an existing model would work just as well.
jorgemanrubia
approved these changes
Nov 24, 2023
There was a problem hiding this comment.
Nice @tonysm, thanks for working on this one.
I like the additional model so that we can keep the other models isolated from these additional streams that will get triggered implicitly. I think that isolation is good for testing.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixed
broadcasts_refreshesmethod was added that sets up the model hooks to send broadcasts refreshes automatically. However, it repeats the same issue previously found in thebroadcastsmethod (Turbo::Broadcastable#broadcasts broadcasts creates to model_name.plural stream #295) where it sends the creation broadcasts to the current model's channel and defaults to, but no one will ever be listening on that. This PR allows passing astreamparam tobroadcasts_refreshesmethod, which will be used as the channel name when broadcasting refreshes on model creation and defaults to the model's plural name, similar to how thebroadcastsmethod works. It also sends the broadcast refresh right away instead of later when the model is deleted.