fix: Add default max_retries to Job.wait_until_complete to avoid infinite waiting #134
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
…nite waiting Signed-off-by: Yutong Li <[email protected]>
|
AlexTranAmz
approved these changes
Aug 7, 2024
ddneilson
approved these changes
Aug 7, 2024
Merged
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 was the problem/requirement? (What/Why)
Job.wait_until_complete() has a default
max_retriesof infinite retries, which is problematic if something unforeseen happens and the tests that use the function will just retry forever.We should add a default for the function so that will not happen.
What was the solution? (How)
Add a default to the
wait_until_complete()function for itsmax_retriesparameter, so that the default behaviour would be to retry up to the default number of times, waiting for the job to complete.What is the impact of this change?
More robust tests, and less possibility of an infinite loop happening in the off chance,.
How was this change tested?
hatch buildhatch run fmthatch run testWas this change documented?
No
Is this a breaking change?
No
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.