cleanup

type AlertHistory interface {
	HistoryStats(ctx context.Context) (rows int64, oldest time.Time, bytes int64, err error)
	CountHistoryBefore(ctx context.Context, cutoff time.Time) (int64, error)
	PruneHistory(ctx context.Context, cutoff time.Time) (int64, error)
}

type AuditSaver interface {
	SaveAuditEntry(ctx context.Context, e store.AuditEntry) error
}

type BuiltinDeps struct {
	Store   SweepStore
	Alerts  AlertHistory
	Tokens  TokenSource
	Janitor JanitorSource
	// Retention enables the targets for history that had no sweeper before; nil skips them.
	Retention RetentionStore
	Settings  Settings
	Now       func() time.Time
}

type Category string

type Center struct {
	// contains filtered or unexported fields
}

type Config struct {
	Registry *Registry
	Store    RunStore
	Settings Settings
	Audit    AuditSaver
	// Emit hands an event to the event webhook queue; nil drops events.
	Emit func(eventType string, data map[string]any)
	// Notify sends a plain-text notice to the alert channels; nil skips notices.
	Notify func(ctx context.Context, text string) error
	Limits Limits
	Logger *slog.Logger
	Now    func() time.Time
}

type FloorError struct {
	Key   string
	Floor int
}

type Impact struct {
	Rows  int64 `json:"rows"`
	Bytes int64 `json:"bytes"`
}

type JanitorSource interface {
	janitor.PolicyStore
	ListJanitorRuns(ctx context.Context, limit int) ([]store.JanitorRun, error)
}

type Limits struct {
	// MaxRows caps the rows one run removes; the run reports more_remaining when it stops there.
	MaxRows int64
	// Slice is the time span of one delete batch, so no single DELETE covers an unbounded range.
	Slice time.Duration
	// Stagger spaces targets within one scheduler tick.
	Stagger time.Duration
	// StartupDelay keeps the scheduler quiet right after boot.
	StartupDelay time.Duration
	// HistoryDays is how long run history is kept.
	HistoryDays int
	// UsageTTL is how long a measured usage is reused by the list endpoint.
	UsageTTL time.Duration
}

type Managed interface {
	State(ctx context.Context) (ManagedState, error)
}

type ManagedState struct {
	Days   int
	Mode   Mode
	DryRun bool
}

type Meta struct {
	// ID is dotted, for example "audit.log".
	ID       string
	Category Category
	// Title and Description are English fallbacks for the i18n keys.
	TitleKey, Title      string
	DescKey, Description string
	// PolicySetting is the runtime setting holding the retention days.
	PolicySetting string
	// Floor is the shortest allowed retention in days, 0 for none.
	Floor       int
	Destructive bool
	Origin      Origin
	// Presets lists the day counts the dashboard offers; empty means the standard presets.
	Presets []int
	// ReadOnly marks a target whose policy and runs live elsewhere (the janitor); Link says where.
	ReadOnly bool
	Link     string
}

type Mode string

type Origin string

type Overview struct {
	Targets   []TargetView  `json:"targets"`
	Scheduler SchedulerView `json:"scheduler"`
}

type Registry struct {
	// contains filtered or unexported fields
}

type Request struct {
	// Days overrides the saved policy when set.
	Days   *int
	DryRun bool
	Opts   RunOptions
}

type Result struct {
	Rows  int64
	Bytes int64
	More  bool
	Err   error
}

type RetentionStore interface {
	RetentionStats(ctx context.Context, t store.RetentionTable) (store.CleanupTableStats, error)
	RetentionCountOlder(ctx context.Context, t store.RetentionTable, cutoff time.Time) (int64, error)
	RetentionDeleteOlder(ctx context.Context, t store.RetentionTable, cutoff time.Time, batch int) (int64, error)
}

type RunOptions struct {
	DryRun  bool
	Trigger Trigger
	Actor   string
	// ActorType, ActorID and RemoteAddr fill the audit row; empty means a system actor.
	ActorType  string
	ActorID    string
	RemoteAddr string
	// MaxRows caps one run; Slice is the time span of one delete batch. The center fills both from its limits.
	MaxRows int64
	Slice   time.Duration
}

type RunRecord struct {
	ID         int64     `json:"id"`
	Target     string    `json:"target"`
	StartedAt  time.Time `json:"started_at"`
	FinishedAt time.Time `json:"finished_at"`
	Days       int       `json:"days"`
	DryRun     bool      `json:"dry_run"`
	Rows       int64     `json:"rows"`
	Bytes      int64     `json:"bytes"`
	Trigger    string    `json:"trigger"`
	Actor      string    `json:"actor"`
	Error      string    `json:"error"`
}

type RunStore interface {
	InsertCleanupRun(ctx context.Context, r store.CleanupRun) (int64, error)
	ListCleanupRuns(ctx context.Context, f store.CleanupRunFilter) ([]store.CleanupRun, error)
	LatestCleanupRuns(ctx context.Context) ([]store.CleanupRun, error)
	CleanupFailedSince(ctx context.Context, target string, since time.Time) (bool, error)
	PruneCleanupRuns(ctx context.Context, before time.Time) (int64, error)
}

type RunsFilter struct {
	Target string
	Since  time.Time
	Until  time.Time
	DryRun *bool
	Status string
	Limit  int
	Cursor int64
}

type RunsPage struct {
	Runs       []RunRecord
	NextCursor int64
}

type SchedulerView struct {
	Enabled  bool   `json:"enabled"`
	Interval string `json:"interval"`
}

type Settings interface {
	Int(ctx context.Context, key string) int
	String(ctx context.Context, key string) string
	Bool(ctx context.Context, key string) bool
	Duration(ctx context.Context, key string) time.Duration
}

type SweepStore interface {
	CleanupStats(ctx context.Context, t store.CleanupTable) (store.CleanupTableStats, error)
	CleanupCountOlder(ctx context.Context, t store.CleanupTable, cutoff time.Time) (int64, error)
	CountAuditEntriesTiered(ctx context.Context, cutoff, securityCutoff time.Time) (int64, error)
	DeleteAuditEntriesTiered(ctx context.Context, cutoff, securityCutoff time.Time) (int64, error)
	PruneEmailDeliveries(ctx context.Context, before time.Time) (int64, error)
	DeleteWebhookDeliveriesOlderThan(ctx context.Context, cutoff time.Time) (int64, error)
	DeleteEventDeliveriesOlderThan(ctx context.Context, cutoff string) (int64, error)
}

type Target interface {
	Meta() Meta
	Measure(ctx context.Context) (Usage, error)
	Preview(ctx context.Context, days int) (Impact, error)
	// Run removes data older than days. With opts.DryRun it must not write.
	Run(ctx context.Context, days int, opts RunOptions) Result
}

type TargetView struct {
	ID             string     `json:"id"`
	Category       string     `json:"category"`
	Title          string     `json:"title"`
	TitleKey       string     `json:"title_key,omitempty"`
	Description    string     `json:"description"`
	DescriptionKey string     `json:"description_key,omitempty"`
	PolicyKey      string     `json:"policy_key"`
	Days           int        `json:"days"`
	Source         string     `json:"source"`
	Mode           string     `json:"mode"`
	Origin         string     `json:"origin"`
	Destructive    bool       `json:"destructive"`
	Floor          int        `json:"floor"`
	Presets        []int      `json:"presets"`
	Usage          UsageView  `json:"usage"`
	UsageError     string     `json:"usage_error,omitempty"`
	LastRun        *RunRecord `json:"last_run"`
	NextRun        *time.Time `json:"next_run"`
	ReadThrough    bool       `json:"read_through"`
	Link           string     `json:"link,omitempty"`
	DryRun         *bool      `json:"dry_run,omitempty"`
}

type TokenSource = janitor.TokenPurger

type Trigger string

type Usage struct {
	Rows    int64
	Bytes   int64
	Oldest  *time.Time
	NoBytes bool
}

type UsageView struct {
	Rows   int64      `json:"rows"`
	Bytes  *int64     `json:"bytes"`
	Oldest *time.Time `json:"oldest"`
}