Uh oh!
There was an error while loading. Please reload this page.
feat: wait for actions using ActionsClient.wait_for - #508
Conversation
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@## main #508 +/- ##
==========================================
- Coverage 97.07% 96.95% -0.13%
==========================================
Files 76 77 +1 Lines 4036 4105 +69 ==========================================
+ Hits 3918 3980 +62 - Misses 118 125 +7 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
ActionsClient.wait_for and ActionsClient.wait_for_funcActionsClient.{wait_for,wait_for_function}ActionsClient.{wait_for,wait_for_function}ActionsClient.wait_for34685b8 to
4639148CompareUh oh!
There was an error while loading. Please reload this page.
| raise ActionGroupException( | ||
| [ActionTimeoutException(action=action) for action in running] | ||
| ) |
There was a problem hiding this comment.
This hides/ignores any errors for actions that already completed. Should they be included in the Exception or should users that want this behavior pass their own handle_update callable and track these action errors themselves?
There was a problem hiding this comment.
Not entirely sure about this one.
I doubt there is a use case for having the actions that succeeded, we are more focused on the actions that timeout.
I think usage will tell, so I'll start using this in the ansible collection and see how this works out.
There was a problem hiding this comment.
Sorry, I was not clear enough. Besides the actions that time out, maybe the user is also interested in the actions that errored, to show a full picture of the issues.
There was a problem hiding this comment.
If an action failed, we raise ActionFailedException and won't run into the ActionTimeoutException or ActionGroupException. So timeout only happens when everything is still running, hence why we do not handle it here.
There was a problem hiding this comment.
And to actually answer your question: if the users uses the wait_for_function, they might have to managed the errors themselves.
There was a problem hiding this comment.
Python 3.10 EOL is in 3 months (~31 Oct 2026), so I think we can wait until them to:
- Drop support for python 3.10
- Use the new python >= 3.11 Exception Groups: https://peps.python.org/pep-0654/
So we don't have to use this weird ActionGroupException, which is once of the reason why this PR has stalled for some time now.
Uh oh!
There was an error while loading. Please reload this page.
8064421 to
0a0046aCompareThis PR has been marked as stale because it has not had recent activity. The bot will close the PR if no further action occurs. |
This function allows the users to wait for multiple actions in an efficient way. All actions are queried using a single call, which reduce the potential for running into rate limits. In addition, users may also configure a duration based timeout when waiting for actions using: action.wait_until_finished(timeout=10) # 10 seconds # or client.actions.wait_for(..., timeout=10)
This function allows the users to wait for multiple actions in an efficient way. All actions are queried using a single call, which reduce the potential for running into rate limits.