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.
66 lines
2.2 KiB
Go
66 lines
2.2 KiB
Go
package protocol
|
|
|
|
import (
|
|
"encoding/json"
|
|
"reflect"
|
|
"strings"
|
|
"testing"
|
|
)
|
|
|
|
// TestRunEventGoldenJSON pins the exact wire shape of the pushed run_event frame
|
|
// so a JSON tag change cannot silently alter what a client parses.
|
|
func TestRunEventGoldenJSON(t *testing.T) {
|
|
frame := RunEventFrame{
|
|
RunID: 7, Workspace: "/work", Status: RunStatusRunning, CurrentStage: "build",
|
|
CompletedSteps: 1, CreatedAt: "2026-01-02T03:04:05Z", Artifacts: 2,
|
|
Step: &RunStepDelta{Sequence: 2, Stage: "build", Status: "completed", Outcome: "success", Target: SuccessEnd, Artifacts: 2},
|
|
}
|
|
encoded, err := json.Marshal(frame)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
want := `{"run_id":7,"workspace":"/work","status":"running","current_stage":"build","completed_steps":1,"created_at":"2026-01-02T03:04:05Z","artifacts":2,"step":{"sequence":2,"stage":"build","status":"completed","outcome":"success","target":"#success","artifacts":2}}`
|
|
if string(encoded) != want {
|
|
t.Fatalf("golden mismatch\n got %s\nwant %s", encoded, want)
|
|
}
|
|
var decoded RunEventFrame
|
|
if err := json.Unmarshal([]byte(want), &decoded); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
if !reflect.DeepEqual(decoded, frame) {
|
|
t.Fatalf("golden did not decode back: %+v", decoded)
|
|
}
|
|
}
|
|
|
|
// TestRunEventEnvelopeRoundTrip proves the new optional fields survive the shared
|
|
// Message envelope and that an unused payload is omitted from the wire.
|
|
func TestRunEventEnvelopeRoundTrip(t *testing.T) {
|
|
message := Message{
|
|
Type: RunEvent,
|
|
ID: "r1",
|
|
RunEvent: &RunEventFrame{RunID: 3, Workspace: "/w", Status: RunStatusQueued, CreatedAt: "2026-01-02T03:04:05Z"},
|
|
RunIDs: []int64{3, 4},
|
|
}
|
|
encoded, err := json.Marshal(message)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
var decoded Message
|
|
if err := json.Unmarshal(encoded, &decoded); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
if !reflect.DeepEqual(decoded.RunEvent, message.RunEvent) || !reflect.DeepEqual(decoded.RunIDs, message.RunIDs) {
|
|
t.Fatalf("run event fields lost: %+v", decoded)
|
|
}
|
|
|
|
minimal, err := json.Marshal(Message{Type: Subscribe, ID: "s1", Workspace: "/w"})
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
for _, absent := range []string{"run_event", "run_ids"} {
|
|
if strings.Contains(string(minimal), absent) {
|
|
t.Fatalf("absent %q must be omitted: %s", absent, minimal)
|
|
}
|
|
}
|
|
}
|