fix(amber): avoids false negative on _check_heartbeat when connection is established but close raises exception#5027
Open
nathant27 wants to merge 7 commits into
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #5027 +/- ##
============================================
- Coverage 42.84% 42.78% -0.06%
+ Complexity 2204 2175 -29
============================================
Files 1045 1045
Lines 40144 39826 -318
Branches 4240 4199 -41
============================================
- Hits 17198 17038 -160
+ Misses 21879 21732 -147
+ Partials 1067 1056 -11
*This pull request uses carry forward flags. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Contributor
Author
|
/request-review @Yicong-Huang |
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.
What changes were proposed in this PR?
Old version of Heartbeat._check_heartbeat(self) wraps the socket connection and socket close in a single try except, and handles with the same try except. The issue is that if close raises after a successful connection, there is a false negative since it will handle it as if socket connection had failed. In Heartbeat.run(self), this could cause the server to shutdown on close raising exception since _check_heartbeat will return False in this case.
New version separates the connection handling and the close in two adjacent try except blocks, and returns true as long as connection is successfully established as well, getting rid of the false negative.
As per discussed in the issue, will keep the double check for _check_heartbeat in Heartbeat.run.
Old Version:
New Version:
Any related issues, documentation, discussions?
Closes #4726
How was this PR tested?
Changed old test to reflect new behavior(True on connection succeeds but socket close rasises)
OLD TEST(REMOVED):
NEW TEST:
Passes on existing old tests
Was this PR authored or co-authored using generative AI tooling?
No