ciwait

type Display interface {
	Update(State)
	Retarget(Retarget)
	Note(string)
	// Close tears the display down, leaving the terminal usable.
	Close()
}

type ErrCancelled struct{ Target Target }

type ErrJobFailed struct {
	Job  string
	Step string
	URL  string
}

type ErrNoRun struct {
	Branch   string
	Workflow string
}

type ErrTimeout struct {
	Target  Target
	Elapsed time.Duration
	// Jobs is the last gating-job snapshot seen before the deadline. A timeout
	// used to discard it, which loses the view exactly when it matters most:
	// knowing *which* job was still running is the whole reason to look.
	Jobs []JobView
}

type Event struct {
	// State is a new progress snapshot.
	State *State
	// Retargeted reports that the watched run was replaced.
	Retargeted *Retarget
	// Note carries a one-off message, such as a rate-limit warning.
	Note string
	// Err is a terminal error.
	Err error
}

type JobView struct {
	Name string `json:"name"`
	// Description is never just a state: it names the step currently running,
	// or how the job finished.
	Description string           `json:"description"`
	Status      ghapi.RunStatus  `json:"status"`
	Conclusion  ghapi.Conclusion `json:"conclusion,omitempty"`
	Duration    time.Duration    `json:"-"`
	DurationStr string           `json:"duration,omitempty"`
	HTMLURL     string           `json:"html_url,omitempty"`
	// Gating reports whether this job is one the wait depends on.
	Gating bool `json:"gating"`
}

type Machine struct {
	// Targets are job-name prefixes that gate the wait. Empty means every job
	// in the run gates, which is the fallback when a repo configures none.
	Targets []string
	// IgnoreFailures keeps waiting when a gating job fails, for the case where
	// a non-essential matrix leg failed but the chart published anyway.
	IgnoreFailures bool
	// contains filtered or unexported fields
}

type Options struct {
	Owner        string
	Repo         string
	WorkflowFile string
	Branch       string
	// RunID pins the run to watch. Zero means "find the newest run".
	RunID int64
	// WaitForJobs are the gating job-name prefixes.
	WaitForJobs []string

	PollInterval time.Duration
	// PollIntervalSet reports that the user named PollInterval themselves. An
	// explicit value is a floor: the adaptive rate may still slow polling
	// down, but it must not speed it past what was asked for. Left false, the
	// default interval adapts freely in both directions.
	PollIntervalSet bool
	Timeout         time.Duration
	IgnoreFailures  bool
}

type Phase int

type Result struct {
	Target  Target        `json:"target"`
	Jobs    []JobView     `json:"jobs"`
	Elapsed time.Duration `json:"-"`
	Total   string        `json:"total_wait,omitempty"`
}

type Retarget struct {
	From Target
	To   Target
	// Reason explains the switch, for display.
	Reason string
}

type State struct {
	Phase Phase `json:"phase"`
	// Jobs holds the gating jobs, in the configured order.
	Jobs []JobView `json:"jobs"`
	// Percent is monotonic across a run: it never decreases except on a
	// deliberate retarget, which resets it to zero.
	Percent float64 `json:"percent"`

	// FailedJob, FailedStep and FailedURL are set when Phase is PhaseFailed.
	FailedJob  string `json:"failed_job,omitempty"`
	FailedStep string `json:"failed_step,omitempty"`
	FailedURL  string `json:"failed_url,omitempty"`

	// Matched reports how many jobs matched the gating patterns. Zero means CI
	// has not created them yet, which is a normal early state.
	Matched int `json:"matched"`
}

type Target struct {
	RunID   int64  `json:"run_id"`
	Attempt int    `json:"run_attempt,omitempty"`
	URL     string `json:"url,omitempty"`
	Name    string `json:"workflow,omitempty"`
	Branch  string `json:"branch,omitempty"`
}

type Waiter struct {
	API  ghapi.API
	Opts Options
	// contains filtered or unexported fields
}