fix(shutdown): is_triggered returns up-to-date value without first polling #5997
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
ghpbot-tari-project
added
P-acks_required
sdbondi
force-pushed
the
shutdown-fix-is-trigger
branch
from
3e9dfaf to
788ad13
Compare
SWvheerden
approved these changes
Nov 30, 2023
ghpbot-tari-project
removed
the
P-reviews_required
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.
Description
fix: always return correct value from is_triggered without first requiring the signal to be polled
Motivation and Context
OneshotSignal uses the
futures::Shared<Fut>combinator to allow a single future to be cloned and awaited on in multiple places. Previously we used FuseFuture::is_terminated to determine if the signal is triggered. However the semantics of is_terminated and is_triggered are subtly different. is_terminated indicates whether a future should be polled again, which is true even if the trigger has fired.This PR uses an AtomicBool that is set to true at the time the trigger is fired so that polling first is not required.
Thanks to @hansieodendaal for discovering this issue
How Has This Been Tested?
Updated existing test to check is_triggered, previously failed and now passes.
What process can a PR reviewer use to test or verify this change?
N/A
Breaking Changes