Fix Eventually and EventuallyWithT to always run condition #1653
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.
Summary
If
Eventually
was called with atick
larger thanwaitFor
, or atick
very slightly smaller thanwaitFor
, or very smalltick
andwaitFor
values, then a timing race can occur where the select statement falls into thewaitFor
case first and thecondition
function is never run.Changes
tick
is very slightly smaller thanwaitFor
, then the timer will never yield before the ticker.condition
once before the loop and initialisetick
in the for loop to(<-chan time.Time)(nil)
so that we always runcondition
statically, then check its result, then runcondition
based on ticks.Motivation
Having a timing race where it is possible for condition to never be run causes our CI tests to flake, and is not how I think the user would expect Eventually can behave.
Related issues
Closes #1652