Files
archie/internal/domain/workflow/task/task.go
T
sam 2a066f6d4f feat(workflows): test-run unsaved drafts and browse workflow version history
A test run pins a validated draft, runs with forge and push writes
suppressed and recorded per step, and is excluded from workflow stats.
The History tab lists revisions that changed a workflow, diffs them as
YAML and on the canvas, restores into the editor, and ties runs to the
revision they used.
2026-10-13 12:27:40 +11:00

238 lines
10 KiB
Go

// Package task defines the Task record, its statuses and the Store contract
// workflow stages use.
package task
import (
"context"
"encoding/json"
"time"
"github.com/samcharles93/archie-core/internal/domain/org"
"github.com/samcharles93/archie-core/internal/domain/usage"
"github.com/samcharles93/archie-core/internal/events"
"github.com/samcharles93/archie-core/internal/taskstate"
)
// Task lifecycle statuses. Workflows move tasks between them; the
// daemon owns queued→running claims and crash recovery.
const (
// Defined in internal/taskstate so the dashboard, chat and the store
// share one vocabulary. These names are kept as the workflow domain's
// public spelling; the values live in one place.
StatusQueued = taskstate.Queued
StatusRunning = taskstate.Running
StatusWaitingHuman = taskstate.WaitingHuman
StatusPROpen = taskstate.PROpen
StatusMerged = taskstate.Merged
StatusParked = taskstate.Parked
StatusDead = taskstate.Dead
StatusRejected = taskstate.Rejected
StatusClosedWontDo = taskstate.Declined
StatusCompleted = taskstate.Completed
)
// Task is the task-execution record the workflow domain operates on.
// internal/infrastructure/postgres persists this type (persistence -> domain).
type Task struct {
ID int64 `json:"id"`
Owner string `json:"owner"`
Repo string `json:"repo"`
IssueNumber int `json:"issue_number"`
Title string `json:"title"`
Body string `json:"body"`
Labels string `json:"labels"` // comma-separated, as seen at enqueue time
Status string `json:"status"`
Workflow string `json:"workflow"`
// WorkflowDefinitionVersion and WorkflowDefinitionDigest pin the exact
// database definition selected for this execution. WorkflowDefinitionYAML
// is the immutable worker handoff; retries reuse it instead of re-reading
// the active control-plane resource.
WorkflowDefinitionVersion int64 `json:"workflow_definition_version"`
WorkflowDefinitionDigest string `json:"workflow_definition_digest"`
WorkflowDefinitionYAML string `json:"workflow_definition_yaml"`
Branch string `json:"branch"`
Plan string `json:"plan"`
Notes string `json:"notes"`
PRNumber int `json:"pr_number"`
TokensUsed int `json:"tokens_used"`
Iterations int `json:"iterations"`
Attempt int `json:"attempt"`
ParkReason string `json:"park_reason"`
// RetryCount tracks how many times a parked task has been retried
// (parking-to-queued transitions). When it reaches the configured
// max_retries the daemon moves the task to StatusDead.
RetryCount int `json:"retry_count"`
// RetryMode is the worktree mode for the next dispatch; empty means
// RefreshOntoBase.
RetryMode string `json:"retry_mode"`
// ResumeFrom is the stage this attempt starts at; empty runs every stage.
// ResumeResults are the step results (JSON, by step id) the attempt starts
// with, so steps it skips still answer their references.
ResumeFrom string `json:"resume_from,omitempty"`
ResumeResults json.RawMessage `json:"resume_results,omitempty"`
// WatchCommentID is the poll backstop's high-water mark over forge
// review-comment IDs for this task (pr-review-remediation.md decision
// 2's persisted per-task cursor; the comment-watch design it was
// created for never shipped, and the field carries the cursor now).
WatchCommentID int64 `json:"watch_comment_id"`
// ReviewCursor is the poll backstop's high-water mark over forge
// review IDs. It is deliberately separate from WatchCommentID: review
// and comment IDs are independent forge sequences, and one combined
// cursor would silently skip reviews once a larger comment ID landed.
ReviewCursor int64 `json:"review_cursor"`
// Source is "forge", "chat" or "test". Chat tasks have a synthetic IssueNumber and
// skip forge operations.
Source string `json:"source"`
// Identity is the identity that started this task: a chat user, a
// binding's or poller's identity, or a calling workflow's declared
// identity; empty is the root identity. Used to scope /approve and
// /cancel authorization so one identity cannot control another's
// chat-spawned tasks. While the daemon processes the task it holds the
// identity the workflow declares, which is never stored here.
Identity string `json:"identity"`
// Origin names the conversation that created the task, so its outcome and
// /stop find it; empty for a task no conversation started.
Origin string `json:"origin"`
// Org is the org the task belongs to. The State Store derives it from
// the task's identity when the row is written;
// a task
// of a single-operator install belongs to the default org.
Org org.OrgID `json:"org,omitempty"`
// Workspace is the workspace of Org the task belongs to; the store sets
// it.
Workspace org.WorkspaceID `json:"workspace,omitempty"`
// BindingID and BindingVersion are stamped when a task was created from a
// playbook binding dispatch. They record provenance: which binding fired
// this task and at what version, so later edits to the binding cannot
// silently rewrite history.
BindingID string `json:"binding_id"`
BindingVersion int `json:"binding_version"`
// Inputs are the workflow inputs the binding assigned, checked against
// the workflow's declared inputs at dispatch. They reach the agent as
// structured data, never as body text.
Inputs map[string]any `json:"inputs,omitempty"`
// Outputs are this attempt's declared outputs.
Outputs map[string]any `json:"outputs,omitempty"`
// ReviewPayload is the JSON review unit the remediate run must address.
ReviewPayload string `json:"review_payload"`
// ParkClass is the producer-recorded answer to "what kind of
// intervention does this park need?" (taskstate.ParkClass). Set at the
// park site, never inferred from reason text; needs_human is the
// default an unclassified park reads as.
ParkClass string `json:"park_class"`
// RemediationRounds counts review-triggered remediation rounds.
RemediationRounds int `json:"remediation_rounds"`
// ReviewGate is the encoded review gate document; empty if the task never
// reached the gate.
ReviewGate string `json:"review_gate"`
// RereviewRounds counts operator re-reviews, capped at
// prreview.MaxRereviewRounds.
RereviewRounds int `json:"rereview_rounds"`
// CallParentTaskID is the task whose workflow.call step started this
// one; 0 on a root run. A caller reads only the tasks it started,
// through WorkflowCallStatus.
CallParentTaskID int64 `json:"call_parent_task_id,omitempty"`
// CallDepth counts workflow.call hops from the root run. The engine
// refuses a call past workflow.MaxCallDepth, and the store re-checks on
// insert, so no enqueue path can pass the limit.
CallDepth int `json:"call_depth,omitempty"`
// CreatedAt and UpdatedAt are the SQLite row timestamps, exposed so
// callers can show a task's age and last activity. They are written by
// column defaults and the UPDATE statements, never by the caller.
CreatedAt time.Time `json:"created_at"`
UpdatedAt time.Time `json:"updated_at"`
}
// SourceForge, SourceChat and SourceTest are the valid values for Task.Source.
// A test run is a chat-shaped task that runs an unsaved draft definition and
// writes nothing to a forge.
// Legacy rows and forge-polled tasks have Source == SourceForge (the
// zero value defaults there via the SQLite column default).
const (
SourceForge = "forge"
SourceChat = "chat"
SourceTest = "test"
)
// IsForgeBacked reports whether t corresponds to a real forge issue.
// Chat-spawned and test tasks have a synthetic IssueNumber and must not be
// used in forge label/comment/reply calls.
func (t Task) IsForgeBacked() bool {
return t.Source != SourceChat && t.Source != SourceTest
}
// IsTestRun reports whether t runs an operator's draft with forge writes
// suppressed.
func (t Task) IsTestRun() bool {
return t.Source == SourceTest
}
// EffectivePRNumber returns PRNumber, else the pr_number input, else 0.
func (t Task) EffectivePRNumber() int {
if t.PRNumber != 0 {
return t.PRNumber
}
switch n := t.Inputs["pr_number"].(type) {
case json.Number:
i, err := n.Int64()
if err != nil {
return 0
}
return int(i)
case float64:
return int(n)
case int:
return n
default:
return 0
}
}
// Store is the narrow, consumer-owned subset of the State Store contract
// that workflow stages call mid-run. The PostgreSQL store and staterpc.Client
// satisfy it; this is the interface archie-agent uses over the gRPC State
// Store contract. It supersedes store.WorkflowStore.
type Store interface {
Update(ctx context.Context, t *Task) error
Transition(ctx context.Context, taskID int64, from, to, detail string) error
InsertEvent(ctx context.Context, e events.Event) (int64, error)
// StartStep records a step entering running and returns its id and the
// persisted event.
StartStep(ctx context.Context, s StepStart) (int64, events.Event, error)
// FinishStep moves one step to its outcome under the same table, writing
// the stage_finish event in the same transaction, and returns that event
// for the caller's post-commit publish.
FinishStep(ctx context.Context, s StepFinish) (events.Event, error)
// RecordUsage appends one model call's usage record.
RecordUsage(ctx context.Context, r usage.Record) error
}
// Definition is a workflow's id and stage order.
type Definition struct {
ID string `json:"id"`
Name string `json:"name"`
Origin string `json:"origin"`
Enabled bool `json:"enabled"`
// Inputs and Repository are what the workflow declares, so a binding
// editor can offer the inputs to assign and whether to name a repository.
Inputs map[string]InputSpec `json:"inputs,omitempty"`
Repository RepositoryMode `json:"repository,omitempty"`
}
// HasRepository reports whether the task works on a repository. A task a
// binding started for a workflow with repository none (or optional, with no
// repository named) has neither owner nor repo and runs in a scratch
// workspace.
func (t Task) HasRepository() bool {
return t.Owner != "" || t.Repo != ""
}
// OrgOrDefault is the task's org, or the default org for a task written
// before orgs existed.
func (t Task) OrgOrDefault() string {
if t.Org == "" {
return string(org.DefaultOrgID)
}
return string(t.Org)
}