9130ae8c7a
Add durable FIFO capacity-one resource leases for executable stages, including cleanup-confirmed release, conservative restart quarantine, queue state events, and CLI/TUI/Android waiting presentation. Add scheduler, cleanup, protocol, client, and Android coverage plus a proposed Android v3 resource draft. Checked packaged templates and authoring skill references: neither needs updating in this item. The per-item docs note records the shared documentation that docs-fold must update; no shared README or packaged reference was edited.
63 lines
3.1 KiB
Go
63 lines
3.1 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.
|
|
//
|
|
// PipelineID, Name, Title and Version are the pipeline identity and stored title
|
|
// a list row shows, so a client that has never held the run can insert its row
|
|
// from the frame instead of re-reading the whole list. They repeat on every
|
|
// frame (pipeline identity never changes mid-run).
|
|
type RunEventFrame struct {
|
|
// ResourceWaitSet makes a nil ResourceWait an explicit cache clear.
|
|
ResourceWaitSet bool `json:"resource_wait_set,omitempty"`
|
|
ResourceWait *ResourceWait `json:"resource_wait,omitempty"`
|
|
RunID int64 `json:"run_id"`
|
|
Workspace string `json:"workspace,omitempty"`
|
|
// PipelineID, Name, Title and Version identify the run's pipeline and its
|
|
// operator-facing title, so a new run's row can be built without a fetch.
|
|
PipelineID int64 `json:"pipeline_id,omitempty"`
|
|
Name string `json:"name,omitempty"`
|
|
Title string `json:"title,omitempty"`
|
|
Version int `json:"version,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"`
|
|
}
|