[Feature Request] Ability to cancel workflow execution #16320
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
dosubot
bot
added
the
size:M
|
|
||
| ctx._tasks.add( | ||
| asyncio.create_task( | ||
| _cancel_workflow_task(), name="cancel_workflow_task" |
There was a problem hiding this comment.
Interesting method! Basically, this allows us to reuse all our existing logic for canceling tasks 💪🏻
There was a problem hiding this comment.
Yeah! And it also I think matches the current working relationship between Worfklow and WorkflowHandler.
logan-markewich
approved these changes
Oct 1, 2024
raspawar
pushed a commit
to raspawar/llama_index
that referenced
this pull request
Oct 7, 2024
* cancel * test run step raises error * WorkflowCancelledByUser * mypy
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
This PR provides the user the ability to cancel a workflow execution.
Under the hood,
cancel_run()sets theContext._cancel_flagand there is a dedicatedcancel_workflow_taskthat waits for this and raises the newly definedWorkflowCancelledByUserexception. Following that the rest of the workflow mechanics take care of the exception being raised and setting the exception on the handler.Type of Change
Please delete options that are not relevant.
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration