Fix a race condition in a multithreaded test #1798
Merged
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
|
@flongford An easy one for you ... |
flongford
reviewed
May 21, 2024
| background_thread = threading.Thread(target=self.modify_obj) | ||
| background_thread.start() | ||
| self.addCleanup(background_thread.join) | ||
| background_thread.join() |
There was a problem hiding this comment.
We're invoking the same self.addCleanup command in test_notification_from_separate_thread (line 184) - is it appropriate for this test case or should it be changed also?
There was a problem hiding this comment.
I think it's fine for that test case, because we're explicitly waiting for the notification to arrive with an await.
There was a problem hiding this comment.
Ah yes, I see the difference between the two test cases - thanks for clarifying
|
Thanks for review! Merging. |
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.
This PR fixes an obvious race condition in a test - we're firing off an action in a background thread, but not waiting for that background thread to complete before checking for the side-effects that we're expecting.
This caused a CI failure in a recent Windows run: https://github.com/enthought/traits/actions/runs/9164818354/job/25196928783?pr=1797