Refactor ActionCable::TestHelper block-wise assertions #53071
Conversation
This file contains hidden or 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
Implement `ActionCable::TestHelper` block-wise assertions in terms of `#capture_broadcasts`. This change inlines the private `#new_broadcasts_from` method contents into the `#capture_broadcasts` method, and uses `#capture_broadcasts` at all the previous `#new_broadcasts_from` call sites. This consolidation enables the removal of some JSON-parsing duplication across the other method implementations. The test file changes were necessary to account for JSON-encoded String values (for example, transforming `hello` into `"hello"`). Since the [broadcast][] documentation explicitly mentions that the `message` value <q>will later be JSON encoded</q>, this shouldn't be a backwards incompatible change. [broadcast]: https://edgeapi.rubyonrails.org/classes/ActiveRecord/AttributeMethods/BeforeTypeCast.html#method-i-read_attribute_before_type_cast
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
1 participant
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.
Motivation / Background
Implement
ActionCable::TestHelperblock-wise assertions in terms of#capture_broadcasts. This change inlines the private#new_broadcasts_frommethod contents into the#capture_broadcastsmethod, and uses#capture_broadcastsat all the previous#new_broadcasts_fromcall sites. This consolidation enables the removal of some JSON-parsing duplication across the other method implementations.Detail
The test file changes were necessary to account for JSON-encoded String values (for example, transforming
hellointo"hello"). Since the broadcast documentation explicitly mentions that themessagevalue , this might not be considered a backwards incompatible change, since it brings actual behavior in-line with documented behavior.Checklist
Before submitting the PR make sure the following are checked:
[Fix #issue-number]