Add new undocumented option ReportUnreadMessageData to emit a diagnostic warning if data is left unread - #970
Merged
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #970 +/- ##
==========================================
+ Coverage 99.19% 99.20% +0.01%
==========================================
Files 189 189
Lines 6707 6829 +122
Branches 1026 1085 +59
==========================================
+ Hits 6653 6775 +122
Misses 41 41
Partials 13 13 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
|
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
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.



I discovered through #968 that a message had the potential to contain additional data, but the code wasn't reading it. I've run into this before and it has been in the back of my mind that I might be discarding data from incoming messages unknowingly.
This PR adds an undocumented
ReportUnreadMessageDatapublic static property toSoulseekClientthat when set to true will cause every message to check whether there is unread data after parsing and if so, emit a diagnostic warning. This setting can be turned on or off at any time after theSoulseekClientclass has been instantiated.