Repository navigation
[Good First Issue] Implement WebSocket real-time run status updates #11
Description
Activity
- changed the title
[-][Help Wanted] Implement WebSocket real-time run status updates[/-][+][Good First Issue] Implement WebSocket real-time run status updates[/+]on Apr 25, 2026 Hello @Oshgig, I looked into this issue and traced it to
src/climatevision/api/main.py, and i saw that the predict endpoint already
tracks status ascompletedorfailedinternally.So, my approach would be to add a WebSocket endpoint that broadcasts
these status updates in real time, so the frontend doesn't need
to poll. I'll also handle case of client disconnection gracefully.Happy to open a PR if this looks right. Open to feedback on the
approach.I'd like to work on this.
Planned approach, so it can be corrected before I build:
Backend — add a
/ws/runs/{run_id}WebSocket. Since/api/predictruns inference inline, status changes happen in-process, so I plan a small in-process pub/sub hub that the predict paths publish to and the socket subscribes to. On connect the socket sends the current status straight from the DB (so a client attaching late to an already-finished run still gets a terminal event), then streams transitions untilcompleted/failed, including the result payload or error on the final event.Frontend — a
useRunWebSockethook thatuseRunPollingprefers, falling back to the existing 5s polling when the socket cannot connect or errors.One question: frontend tests need the Vitest runner from #125, which is green but not yet merged. I will write the frontend tests to that setup and keep this PR free of
package.jsonchanges, so they simply start running once #125 lands — no conflict either way.
Overview
The dashboard currently polls for run status. We need a WebSocket endpoint so the frontend can receive real-time push updates when a prediction job completes or fails.
Scope
/ws/runs/{run_id}WebSocket endpoint in FastAPIrunning→completed/failedcompleted/failedeventuseRunPollinghook to prefer WebSocket, falling back to pollingNewAnalysisandRunHistorypages to listen for WebSocket eventsAcceptance Criteria
/ws/runs/{run_id}receives status updates in real timeResources
src/climatevision/api/main.py— existing FastAPI appfrontend/src/— React dashboardteam_docs/PM_ROLE_UPDATES_FOR_GAPS.md— gap [Good First Issue] Add frontend unit tests with Vitest + React Testing Library #9 detailsDifficulty: Intermediate
Labels:
help wanted,backend,frontend,real-time