workflow run streaming API #887
Conversation
<!-- ELLIPSIS_HIDDEN --> > [!IMPORTANT] > Adds a WebSocket endpoint for streaming workflow run data with authentication, streaming logic, and error handling in `streaming.py`. > > - **New Feature**: > - Adds `workflow_run_streaming` WebSocket endpoint in `streaming.py` for streaming workflow run data. > - **Authentication**: > - Validates `apikey` or `token` for organization access. > - Sends error message if credentials are invalid. > - **Streaming Logic**: > - Streams workflow run data if status is `running`. > - Sends base64-encoded screenshot if available. > - Closes connection if no activity for 5 minutes or if workflow run is in a final state. > - **Error Handling**: > - Handles `ValidationError`, `WebSocketDisconnect`, and `ConnectionClosedOK` exceptions with appropriate logging and messaging. > > <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 5998bf39c47d0e092a3245e6ef732209c44a2636. 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.
❌ Changes requested. Incremental review on d7b6cb4 in 18 seconds
More details
- Looked at
147lines of code in1files - Skipped
0files when reviewing. - Skipped posting
1drafted comments based on config settings.
1. skyvern/forge/sdk/routes/streaming.py:135
- Draft comment:
Typo in log message: "WofklowRun" should be "WorkflowRun". This typo appears in multiple log messages. - Reason this comment was not posted:
Confidence changes required:10%
The code has a typo in the log messages for 'WorkflowRun Streaming'.
Workflow ID: wflow_BGwfAg4tH7ngQ9oa
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.
| ) | ||
| return | ||
|
|
||
| if WorkflowRun.status == WorkflowRunStatus.running: |
There was a problem hiding this comment.
Incorrect status check. Use workflow_run.status instead of WorkflowRun.status. This issue appears in other parts of the code as well.
There was a problem hiding this comment.
❌ Changes requested. Reviewed everything up to d7b6cb4 in 20 seconds
More details
- Looked at
147lines of code in1files - Skipped
0files when reviewing. - Skipped posting
1drafted comments based on config settings.
1. skyvern/forge/sdk/routes/streaming.py:135
- Draft comment:
Typo in log message: "WofklowRun" should be "WorkflowRun". This typo appears in multiple log messages throughout the function. - Reason this comment was not posted:
Confidence changes required:50%
The code has a typo in the log messages for "WorkflowRun" which is consistently misspelled as "WofklowRun". This should be corrected for clarity and consistency.
Workflow ID: wflow_6OsaomyFEW3O1yDP
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.
| ) | ||
| return | ||
|
|
||
| if WorkflowRun.status == WorkflowRunStatus.running: |
There was a problem hiding this comment.
Logical error: Use workflow_run.status instead of WorkflowRun.status to check the status of the current workflow run instance.
There was a problem hiding this comment.
👍 Looks good to me! Incremental review on e932ccc in 16 seconds
More details
- Looked at
22lines of code in1files - Skipped
0files when reviewing. - Skipped posting
0drafted comments based on config settings.
Workflow ID: wflow_eFAsveiB84K7epAq
You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.
Important
Adds
workflow_run_streamingWebSocket endpoint instreaming.pyfor authenticated streaming of workflow run data with error handling.workflow_run_streamingWebSocket endpoint instreaming.pyfor streaming workflow run data.apikeyortokenfor organization access.running.ValidationError,WebSocketDisconnect, andConnectionClosedOKexceptions with appropriate logging and messaging.This description was created by
for e932ccc. It will automatically update as commits are pushed.