Add GET workflows/runs/run_id endpoint #973
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
<!-- ELLIPSIS_HIDDEN -->
> [!IMPORTANT]
> Add `GET /workflows/runs/{workflow_run_id}` endpoint to retrieve workflow run status by `workflow_run_id`, with error handling for not found cases.
>
> - **Endpoints**:
> - Add `GET /workflows/runs/{workflow_run_id}` endpoint in `agent_protocol.py` to retrieve workflow run status by `workflow_run_id`.
> - Includes a variant with a trailing slash, not included in schema.
> - **Service Logic**:
> - Add `build_workflow_run_status_response_by_workflow_id()` in `service.py` to construct response using `workflow_run_id`.
> - Handles case where workflow run is not found by logging an error and raising `WorkflowRunNotFound`.
>
> <sup>This description was created by </sup>[<img alt="Ellipsis" src="https://img.shields.io/badge/Ellipsis-blue?color=175173">](https://www.ellipsis.dev?ref=Skyvern-AI%2Fskyvern-cloud&utm_source=github&utm_medium=referral)<sup> for ec0c2ddda325736be86fbc872563d727bb71b146. It will automatically update as commits are pushed.</sup>
<!-- ELLIPSIS_HIDDEN -->
![ellipsis-dev[bot]](https://avatars.githubusercontent.com/in/64358?s=60&v=4){kind=small}
There was a problem hiding this comment.
👍 Looks good to me! Reviewed everything up to 5084fdf in 19 seconds
More details
- Looked at
59lines of code in2files - Skipped
0files when reviewing. - Skipped posting
1drafted comments based on config settings.
1. skyvern/forge/sdk/routes/agent_protocol.py:653
- Draft comment:
The function nameget_workflow_run_by_run_idis misleading as it suggests it retrieves a workflow run byworkflow_id, but it actually usesworkflow_run_id. Consider renaming it toget_workflow_run_by_workflow_run_idfor clarity. This also applies to the functionbuild_workflow_run_status_response_by_workflow_idinservice.py. - Reason this comment was not posted:
Confidence changes required:50%
The functionget_workflow_run_by_run_idinagent_protocol.pyandbuild_workflow_run_status_response_by_workflow_idinservice.pyare using the termworkflow_idin their names, which is misleading since they are actually dealing withworkflow_run_id. This can cause confusion for future developers.
Workflow ID: wflow_Nlh79wXnVgylUioT
You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.
There was a problem hiding this comment.
❌ Changes requested. Incremental review on 5084fdf in 43 seconds
More details
- Looked at
59lines of code in2files - Skipped
0files when reviewing. - Skipped posting
0drafted comments based on config settings.
Workflow ID: wflow_Uex4ycs5wxwdwqnY
Want Ellipsis to fix these issues? Tag @ellipsis-dev in a comment. You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.
| @@ -612,6 +612,22 @@ async def get_last_task_for_workflow_run(self, workflow_run_id: str) -> Task | N | |||
| async def get_tasks_by_workflow_run_id(self, workflow_run_id: str) -> list[Task]: | |||
| return await app.DATABASE.get_tasks_by_workflow_run_id(workflow_run_id=workflow_run_id) | |||
|
|
|||
| async def build_workflow_run_status_response_by_workflow_id( | |||
There was a problem hiding this comment.
The function name build_workflow_run_status_response_by_workflow_id is misleading. Consider renaming it to build_workflow_run_status_response_by_run_id to better reflect its purpose.
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.
Important
Add
GET /workflows/runs/{workflow_run_id}endpoint to retrieve workflow run status with error handling for not found cases.GET /workflows/runs/{workflow_run_id}endpoint inagent_protocol.pyto retrieve workflow run status byworkflow_run_id.build_workflow_run_status_response_by_workflow_id()inservice.pyto construct response usingworkflow_run_id.WorkflowRunNotFound.This description was created by
for 5084fdf. It will automatically update as commits are pushed.