forwardlegacy

type Archive struct {
	Schema         string         `json:"schema"`
	CreatedAt      time.Time      `json:"created_at"`
	ControlVersion string         `json:"control_version,omitempty"`
	DatabaseDriver string         `json:"database_driver"`
	Note           string         `json:"note"`
	Tables         []ArchiveTable `json:"tables"`
}

type ArchiveTable struct {
	Name string `json:"name"`
	// Dropped tells whether the upgrade's drop removes the table.
	Dropped bool `json:"dropped"`
	// Present is false when the table did not exist (a release that
	// already removed it): Rows is then empty.
	Present  bool `json:"present"`
	RowCount int  `json:"row_count"`
	// RedactedColumns are columns whose values were left out.
	RedactedColumns []string         `json:"redacted_columns,omitempty"`
	Rows            []map[string]any `json:"rows"`
}

type Backup struct {
	// Source is "backup_record" (Control's own backup service) or
	// "operator" (--backup-taken).
	Source     string    `json:"source"`
	Path       string    `json:"path"`
	SizeBytes  int64     `json:"size_bytes"`
	SHA256     string    `json:"sha256"`
	ModifiedAt time.Time `json:"modified_at"`
	RecordID   uint      `json:"record_id,omitempty"`
}

type CheckOptions struct {
	NodeX   Cleaner
	Ansible Cleaner
	// Nodes limits the check to these node names or references; empty
	// checks every forward node.
	Nodes []string
	Now   time.Time
}

type Cleaner interface {
	CleanNode(ctx context.Context, node NodeInfo) PathResult
}

type DropOptions struct {
	// Confirm must be ConfirmPhrase exactly.
	Confirm    string
	BackupPath string
	Actor      string
	// LockTimeout bounds the wait for a table lock on PostgreSQL;
	// DefaultLockTimeout when zero.
	LockTimeout time.Duration
	Now         time.Time
}

type DropResult struct {
	Record         model.ForwardLegacyDrop `json:"record"`
	Dropped        []string                `json:"dropped"`
	AlreadyMissing []string                `json:"already_missing"`
	Backup         *Backup                 `json:"backup"`
}

type NodeInfo struct {
	ID   uint   `json:"id"`
	Ref  string `json:"node_ref"`
	Name string `json:"name"`
	Host string `json:"host"`
}

type NodeStatus struct {
	NodeID uint   `json:"node_id"`
	Ref    string `json:"node_ref"`
	Name   string `json:"name"`
	// State is the node's standing: unchecked, clean, dirty, unreachable
	// or abandoned.
	State string `json:"state"`
	// CheckState is the latest check's own result.
	CheckState    string       `json:"check_state,omitempty"`
	Checks        []PathResult `json:"checks,omitempty"`
	Detail        string       `json:"detail,omitempty"`
	CheckedAt     *time.Time   `json:"checked_at,omitempty"`
	AbandonedAt   *time.Time   `json:"abandoned_at,omitempty"`
	AbandonedBy   string       `json:"abandoned_by,omitempty"`
	AbandonReason string       `json:"abandon_reason,omitempty"`
}

type PackageAdoption struct {
	PluginID string   `json:"plugin_id"`
	Target   string   `json:"target"`
	Version  string   `json:"version"`
	Tables   []string `json:"tables"`
}

type PathResult struct {
	Path string `json:"path"`
	// State is clean, dirty, unreachable or not_needed.
	State  string `json:"state"`
	Detail string `json:"detail,omitempty"`
	// Items counts the legacy resources the path removed or checked.
	Items int `json:"items,omitempty"`
}

type PreconditionOptions struct {
	// BackupPath is the operator's database backup (--backup-taken); empty
	// looks for a backup Control's backup service made.
	BackupPath string
	// SkipBackup leaves the backup check out (the status command, which
	// only reports).
	SkipBackup bool
	Now        time.Time
}

type Preconditions struct {
	Archive *model.ForwardLegacyArchive `json:"archive"`
	Nodes   []NodeStatus                `json:"nodes"`
	Backup  *Backup                     `json:"backup"`
	// Packages are installed package releases that still adopt a flux
	// table.
	Packages []PackageAdoption `json:"packages"`
	// Present and Missing split DropTables by whether they exist now.
	Present []string `json:"present"`
	Missing []string `json:"missing"`
	// Blockers lists every unmet precondition; the drop runs only when it
	// is empty.
	Blockers []string `json:"blockers"`
}

type RefusedError struct{ Reasons []string }

type WriteOptions struct {
	// Output is a file that must not exist yet, or an existing directory
	// that receives a timestamped file. Empty means Dir.
	Output string
	// Dir is the archive directory (created 0700 when missing).
	Dir            string
	Trigger        string
	Actor          string
	ControlVersion string
	Now            time.Time
}

type WriteResult struct {
	Record model.ForwardLegacyArchive `json:"record"`
	// Tables is each archived table's row count, -1 when it did not exist.
	Tables map[string]int64 `json:"tables"`
}