webhook

type Consumer struct {
	Client *redis.Client
	Name   string        // the consumer name (the seat)
	Count  int64         // entries per read; 0 means 100
	Block  time.Duration // the first new-entry read's block; 0 means 1 s, negative never blocks
	// MinIdle is how long another consumer's pending entry waits before this
	// one reclaims it; 0 means DefaultMinIdle.
	MinIdle time.Duration
	// Now stamps the PR record writes; nil is time.Now.
	Now func() time.Time
}

type Counts struct {
	Applied, Kept, Skipped, Reclaimed int
	Records, Failed                   int
	LastFail                          string // the last failed entry: its id and why
}

type Job struct {
	Name   string
	Result string // success, failure, cancelled or skipped
}

type Receipt struct {
	Repo       string // owner/name
	SHA        string // the head the run tested: the PR head, the group head or the pushed commit
	RunID      string // decimal
	Event      string // pull_request, merge_group, push or workflow_dispatch
	HeadBranch string // github.head_ref (a ref prefix is stripped)
	BaseBranch string // github.base_ref
	PR         string // the pull request number, "" when the event names none
	Workflow   string // github.workflow
	Conclusion string // job.status of ci-ok: success, failure or cancelled
	At         string // RFC3339; "" means Now()
	Jobs       []Job
	// Now is the clock an empty At is stamped from; nil means time.Now.
	Now func() time.Time
}

type Record struct {
	Found bool
	Word  string // gh: green, red or pending
	Fail  string // gh_fail: the first red run as kind:name
	At    string // gh_at
	PR    string
	EvID  string // ev_id: the ev:github entry last applied
	// Source is who stamped the record: SourceRunner from the ci-ok job's own
	// receipt (runner.go); "" when only the consumer wrote it. Source() folds
	// it with EvID into runner, hook or none.
	Source string
	Runs   []Run // in field order (kind, then name)
}

type Run struct {
	Kind string // check or wf
	Name string
	Word string
	ID   string
	At   string
}

type Written struct {
	Key     string // ci:<repo>:<sha>:gh
	EntryID string // the ev:github row
	Word    string // gh after the write
	Fail    string // gh_fail after the write
	Runs    int    // fields written: the workflow and its jobs
	Applied int    // of them, how many the function applied (the rest were older than the hash held)
	// PR is the claim on the PR record (Key "" when the run is not a
	// pull_request run or was cancelled); Folded the PR numbers whose record
	// took the word at this head.
	PR     land.PRHeadResult
	Folded []string
}