feat: browser notifications for scenario runs
- add RunEventsService and emit run.started / run.finished from the scheduler - stream run events over SSE at GET /api/v1/scenarios/runs/events with a heartbeat - add useRunNotifications hook and NotificationToggle (opt-in bell in the side panel footer) - refresh runs lists when a run finishes - document the events stream and notifications Closes #12
This commit is contained in:
18 files changed
+503
-6
No files matched your search
@@ -128,6 +128,20 @@ Traces are off by default because they often reach ~10 MB per run.
|
||||
|
||||
Traces are run artifacts, so they expire after `FILE_RUN_EXPIRATION_DAYS` like other run files.
|
||||
|
||||
## Run events and browser notifications
|
||||
|
||||
The server publishes run lifecycle events on a server-sent events (SSE) stream, `GET /api/v1/scenarios/runs/events`, regardless of how the run was started (UI, REST API, MCP or the scheduler). Each message is named after its `type` and carries a JSON body:
|
||||
|
||||
```json
|
||||
{ "type": "run.finished", "runId": "...", "scenarioId": "...", "scenarioName": "Login", "status": "pass", "at": "2026-01-01T12:00:00.000Z" }
|
||||
```
|
||||
|
||||
- `run.started` is sent when a run becomes `in_progress` (`status` is `in_progress`).
|
||||
- `run.finished` is sent exactly once per run, with the final `status` (`pass` or `fail`), including runs that fail during setup, time out, or are failed on server restart.
|
||||
- A `ping` event is sent every 25 s to keep idle connections open through proxies.
|
||||
|
||||
The UI uses this stream for opt-in browser notifications: the bell button in the side panel footer asks for the notification permission and then shows "Run started / passed / failed: <scenario>" notifications while the UI is open in a tab; clicking one opens the run. The choice is stored in the browser's `localStorage`. Browsers only offer notifications in a secure context (HTTPS or `localhost`), so over plain HTTP on another host the bell has no effect. When the permission is blocked, the button is disabled; re-allow it in the browser's site settings. Finished runs also refresh the runs lists immediately.
|
||||
|
||||
## Statuses
|
||||
|
||||
Run status:
|
||||
|
||||
Reference in new issue
Block a user