reviewalert

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

type Config struct {
	// Target names the queue being watched.
	Target Target
	// Settings holds the operator's threshold and recipients.
	Settings SettingsStore
	// State holds the re-alert marker.
	State StateStore
	// Source reports what is pending.
	Source Source
	// Enqueuer is the notification substrate's trigger-side entry point.
	Enqueuer *notification.Enqueuer
	// BaseURL is the portal's public base URL, for the alert's deep link.
	BaseURL string
	// Interval overrides DefaultInterval. Testing hook.
	Interval time.Duration
	// Now overrides time.Now. Testing hook.
	Now func() time.Time
}

type InsightSource struct {
	Insights knowledgekit.InsightStore
}

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

type Settings struct {
	// Enabled turns the scheduled check on. A check with no recipients or no
	// threshold delivers nothing regardless; SettingsView reports both as
	// warnings rather than refusing the save.
	Enabled bool `json:"enabled"`
	// PendingThreshold alerts when the pending count reaches it. Zero
	// disables the count condition.
	PendingThreshold int `json:"pending_threshold"`
	// OldestPendingDays alerts when the oldest pending item reaches this age
	// in days. Zero disables the age condition.
	OldestPendingDays int `json:"oldest_pending_days"`
	// CooldownHours is the minimum gap between two alerts while the queue
	// stays over threshold. A queue that drops back under and crosses again
	// alerts immediately: the cooldown suppresses repetition, not news.
	CooldownHours int `json:"cooldown_hours"`
	// Recipients are the addresses the alert is delivered to, in
	// notification.NormalizeAddress form.
	Recipients []string `json:"recipients"`
	// UpdatedBy and UpdatedAt describe the last admin write. They live in the
	// platform_settings audit columns, which are authoritative, so they are
	// excluded from the section value rather than written into it twice.
	UpdatedBy string    `json:"-"`
	UpdatedAt time.Time `json:"-"`
}

type SettingsInput struct {
	Enabled           bool     `json:"enabled" example:"true"`
	PendingThreshold  int      `json:"pending_threshold" example:"25"`
	OldestPendingDays int      `json:"oldest_pending_days" example:"30"`
	CooldownHours     int      `json:"cooldown_hours" example:"24"`
	Recipients        []string `json:"recipients" example:"data-admin@example.com"`
}

type SettingsStore interface {
	// Get returns the stored configuration, or ErrNotFound when the alert has
	// never been configured.
	Get(ctx context.Context) (*Settings, error)
	// Set upserts the configuration.
	Set(ctx context.Context, s Settings, author string) error
}

type SettingsView struct {
	Enabled           bool      `json:"enabled" example:"true"`
	PendingThreshold  int       `json:"pending_threshold" example:"25"`
	OldestPendingDays int       `json:"oldest_pending_days" example:"30"`
	CooldownHours     int       `json:"cooldown_hours" example:"24"`
	Recipients        []string  `json:"recipients"`
	UpdatedBy         string    `json:"updated_by,omitempty" example:"admin@example.com"`
	UpdatedAt         time.Time `json:"updated_at"`
	// Warnings describes a configuration that saves cleanly but delivers
	// nothing. They never block a save; they exist so the operator sees the
	// gap at the surface where the setting was chosen.
	Warnings []string `json:"warnings,omitempty"`
}

type Source interface {
	// Pending returns the queue's rollup as of now: how much is waiting and how
	// old the oldest of it is.
	Pending(ctx context.Context, now time.Time) (notification.ReviewQueue, error)
}

type StateStore interface {
	// ClaimAlert stamps a new alert at now and reports whether this caller
	// won it. It loses when an alert for the same continuously-over-threshold
	// stretch was stamped less than cooldown ago, which is what keeps a
	// stale queue from mailing on every check.
	ClaimAlert(ctx context.Context, cooldown time.Duration, now time.Time) (bool, error)
	// Clear drops the over-threshold marker. The next crossing then alerts
	// immediately instead of serving out a cooldown that belongs to a queue
	// which has since been worked.
	Clear(ctx context.Context) error
}

type Target struct {
	// Queue is the stable key of this queue: the primary key of its state row
	// and the identifier in logs. It is never derived from a display string,
	// because renaming a queue in the UI must not orphan its cooldown.
	Queue string
	// SettingsSection is the platform_settings section holding the operator's
	// configuration for this queue.
	SettingsSection string
	// Category and Kind are the notification category the alert is enqueued
	// under and the payload kind its renderer dispatches on.
	Category string
	Kind     string
	// Title labels the queue in the email.
	Title string
	// Route is the portal path the alert links to, relative to the portal base
	// URL.
	Route string
	// DefaultOldestDays is the age threshold applied before an operator has
	// configured one.
	DefaultOldestDays int
}