Documentation
¶
Overview ¶
Package restore provides a reusable, interactive session.RestoreDecider that an application embedding tui wires into its harness Rig via rig.WithRestoreDecider.
The decider runs at application STARTUP, inside the app's blocking RestoreSession call, BEFORE tui's main Bubble Tea program starts. tui does not compose the Rig or call RestoreSession itself; the embedding app does, then hands the already-built session.SessionController to tui/sessionadapter. This decider is therefore a self-contained unit the app wires up front:
rig.WithRestoreDecider(restore.NewDecider(restore.NewTerminalUI()))
Behavior: informational drift (DriftInfo) is auto-accepted and surfaced without blocking; warn-level drift (DriftWarn) blocks for an interactive y/n confirmation. An accepting decision is always attributed to the user (DecisionSourceUser), and a ctx cancellation or timeout is treated as a fail-secure rejection carrying the cause.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Decider ¶
type Decider struct {
// contains filtered or unexported fields
}
Decider is an interactive session.RestoreDecider. It auto-accepts info-only drift (surfacing it via UI.Notify) and interactively confirms warn-level drift via UI.ConfirmDrift.
An ACCEPTING decision is always attributed to the user (event.DecisionSourceUser): info-only drift is accepted on the user's behalf at startup, and warn-level drift is accepted only after the user explicitly confirms. A ctx cancellation or timeout surfaces from ConfirmDrift as an error, which the Decider returns alongside a non-accepting decision — harness treats a decider error as a fail-secure rejection carrying the cause.
func (Decider) DecideRestore ¶
func (d Decider) DecideRestore(ctx context.Context, a event.DriftAssessment) (session.RestoreDecision, error)
DecideRestore partitions the assessment into warn and info changes, auto-accepts when there are no warns (notifying on any infos), and otherwise blocks on an interactive confirmation. See Decider for the Source and ctx-cancellation contract.
type UI ¶
type UI interface {
// ConfirmDrift renders the warn changes and blocks for a user answer, honoring
// ctx (a cancelled/expired ctx must return promptly). note is an optional
// user-authored message recorded on the resulting adoption.
ConfirmDrift(ctx context.Context, warns []event.DriftChange) (accept bool, note string, err error)
// Notify surfaces accepted informational drift without blocking.
Notify(infos []event.DriftChange)
}
UI is the narrow presentation seam the Decider depends on. It is defined here, at the consuming package, so the decision logic is unit-testable with a fake and never forces a caller to depend on Bubble Tea. Interface segregation: two methods, each with a single responsibility.
func NewTerminalUI ¶
func NewTerminalUI() UI
NewTerminalUI builds the production UI backing a Decider.
Source Files