Fix flaky TestSendCustomMessagePendingError#292
Merged
andykellr merged 1 commit intoAug 20, 2024
Conversation
Signed-off-by: Paschalis Tsilias <[email protected]>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #292 +/- ##
=======================================
Coverage 76.32% 76.32%
=======================================
Files 25 25
Lines 1681 1681
=======================================
Hits 1283 1283
Misses 291 291
Partials 107 107 ☔ View full report in Codecov by Sentry. |
Member
Author
|
Any feedback here? |
Member
Author
|
cc @andykellr hey there Andy👋 sorry for the ping, but do you have any feedback on this? |
andykellr
approved these changes
Aug 20, 2024
andykellr
left a comment
andykellr
left a comment
Contributor
There was a problem hiding this comment.
Looks great, thank you for the fix!
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
2 participants
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'm not entirely sure this is the correct way to test this, so any feedback is appreciated cc @andykellr
The flake is easy to reproduce currently with
go test -run=TestSendCustomMessagePendingError -count=1000 -race.After this fix, I've given it >25k runs and didn't manage to get any failures at all.
Background
The flakiness in
TestSendCustomMessagePendingErrorwas due to the fact that the second call toSendCustomMessagewas often not fast enough to trigger the condition, giving the first call to c.sender.ScheduleSend() enough time for a message to be sent and clearing the previous CustomMessage from the sender's first queued message in the process.Solution
Without going deeper to add explicit synchronization, I think that delaying the start to the server can guarantee that no messages are sent out at the beginning, and starting it up later is stil valid for the rest of the assertions
Fixes #278