fix: don't return videoFormat: null for async transport updates #32
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
Hyperdeck will only return settings that have changed value, through async notifications. Therefore, it is wrong to return null when the parameter is not present, and by returning null for videoFormat, the previous set value can be lost.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #32 +/- ##
==========================================
+ Coverage 51.79% 51.85% +0.06%
==========================================
Files 37 37
Lines 863 862 -1
Branches 146 145 -1
==========================================
Hits 447 447
+ Misses 416 362 -54
- Partials 0 53 +53 ☔ View full report in Codecov by Sentry. |
|
This is published in v2.0.1 |
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.
About the Contributor
One of the maintainers of the Hyperdeck Companion module.
Type of Contribution
This is a:
Bug fix
Current Behavior
The async transportStatus update will send a value of null for videoFormat if no other value is present. This is incorrect, because the Hyperdeck only sends parameters that have changed since the last transport status update, so if there is no videoFormat parameter present, one should not be passed upstream either.
New Behavior
Remove the fallback null value for videoFormat
Testing Instructions
Start and stop playback, and verify that there is no videoFormat parameter being passed to notify.transport handlers.
Other Information
Status