8f3036bd3b
Add a server-pushed run_event frame so a client no longer has to poll once a second to notice run changes. - protocol: RunEventFrame/RunStepDelta compact delta (run id, workspace, status, outcome, current stage, completed-step count, timestamps and an optional single step delta), plus subscribe/unsubscribe/run_event types and the optional RunEvent/RunIDs message fields. All fields optional so older peers ignore them. - server: runEventHub with per-connection subscriptions scoped to a workspace (and optional explicit run ids), one bounded writer goroutine per subscription, slow-subscriber drop, per-client subscription cap and a ~220ms per-run coalescer that flushes pending deltas before a terminal frame. - runner: emit deltas on created/queued, queued->running and step start, human waiting, step finish (outcome, target, diagnostic, artifacts and completed count), terminal finish, cancel of a waiting run and decide/resume; emitRun is a no-op without a hub. - websocket: subscribe seeds current state before the ack, unsubscribe and connection teardown drop subscriptions, and pushed frames reuse the connection write closure. - tests: protocol golden-JSON wire shape plus websocket coverage for the started-run frame sequence, subscribe current-state snapshot, silent unsubscribed/never-subscribed clients, workspace isolation and a bounded coalescing frame count. - docs: note subscribe/unsubscribe/run_event in docs/cli.md; TUI and Android still poll in this release.
49 lines
2.2 KiB
Go
49 lines
2.2 KiB
Go
package protocol
|
|
|
|
// Server-pushed run state. A client sends subscribe (scoped to the workspace and
|
|
// optionally to explicit run ids) to ask for the runs it displays: the server
|
|
// first returns the current state of those runs so a reconnecting client
|
|
// re-syncs, then pushes a compact run_event delta on every meaningful
|
|
// transition. It sends unsubscribe to stop. Like chat_event, run_event is a
|
|
// server-pushed frame with no matching request, so both fields are optional and
|
|
// older peers ignore them.
|
|
const (
|
|
Subscribe = "subscribe"
|
|
Unsubscribe = "unsubscribe"
|
|
RunEvent = "run_event"
|
|
)
|
|
|
|
// RunEventFrame is the server-pushed run_event delta. It carries only the values
|
|
// that changed, never the whole run: the run's identity, status, outcome, current
|
|
// stage, completed-step count and timestamps, plus at most one changed step.
|
|
// Every field is optional so an older peer ignores what it does not know and a
|
|
// client can fold the frame into its cached run.
|
|
type RunEventFrame struct {
|
|
RunID int64 `json:"run_id"`
|
|
Workspace string `json:"workspace,omitempty"`
|
|
Status string `json:"status,omitempty"`
|
|
Outcome string `json:"outcome,omitempty"`
|
|
CurrentStage string `json:"current_stage,omitempty"`
|
|
CompletedSteps int `json:"completed_steps,omitempty"`
|
|
CreatedAt string `json:"created_at,omitempty"`
|
|
FinishedAt string `json:"finished_at,omitempty"`
|
|
// Artifacts is the number of files recorded for the referenced step, so a
|
|
// client can surface artifact capture without reading the step.
|
|
Artifacts int `json:"artifacts,omitempty"`
|
|
// Step is present when a single step changed (started, finished or waiting).
|
|
Step *RunStepDelta `json:"step,omitempty"`
|
|
}
|
|
|
|
// RunStepDelta is the compact change of one step within a RunEventFrame. It is a
|
|
// delta, not a RunStep: it omits the input/output, transcript, file changes and
|
|
// artifact bytes a full step carries.
|
|
type RunStepDelta struct {
|
|
Sequence int `json:"sequence"`
|
|
Stage string `json:"stage,omitempty"`
|
|
Status string `json:"status,omitempty"`
|
|
Outcome string `json:"outcome,omitempty"`
|
|
Target string `json:"target,omitempty"`
|
|
Diagnostic string `json:"diagnostic,omitempty"`
|
|
Artifacts int `json:"artifacts,omitempty"`
|
|
}
|