preflight

type AlertRule struct {
	Name   string
	Query  string
	Health string // "ok", "err" or "unknown"
}

type AlertRuleFindings struct {
	Found   []string // loaded, with the expected expression, evaluating
	Missing []string // not loaded at all
	Stale   []string // loaded, but the expression is not the fixed one
	Failing []string // loaded, but the last evaluation failed
}

type Founding struct {
	Accounts int // every account
	Demo     int // 1 when the demo account exists
	Eligible int // accounts created at or before launch, the demo excluded
	Already  int // of those, with a founding row
	ToGrant  int
	After    int // accounts created after the launch instant (not granted)
}

type Input struct {
	Getenv func(string) string
	// Founding reads the counts; nil: the database part is skipped and the report says so.
	Founding func(ctx context.Context, launch time.Time) (Founding, error)
	// Fetch returns the status of a GET of url; nil skips the URL checks.
	Fetch func(ctx context.Context, url string) (int, error)
	// Webhook returns the status of an UNSIGNED, empty POST to url (Stripe's webhook endpoint); nil skips it.
	Webhook func(ctx context.Context, url string) (int, error)
	// RedisTime runs TIME as the app's Redis user, which is what the shared rate-limit script needs; nil skips it. It reports a denial
	// (the ACL) apart from the other failures.
	RedisTime func(ctx context.Context) (denied bool, err error)
	// AlertRules lists the alerting rules Prometheus has loaded; nil skips the check. An error is a problem: the rules are unverified.
	AlertRules func(ctx context.Context) ([]AlertRule, error)
	// RequiredAlertRules overrides RequiredAlertRules (tests).
	RequiredAlertRules []RequiredRule
	// Stripe reads the Stripe API with the configured key; nil skips it.
	Stripe func(ctx context.Context) StripeFacts
	// BillingAddress is what our Checkout sessions ask for as the billing address (stripebill.BillingAddressCollection): "required" lets the
	// webhook check the country (Rivolt Pro is sold in the US only).
	BillingAddress string
	Launch         time.Time
}

type Report struct {
	Lines []string
	// Problems are what stops the flip; Warnings are worth a look but do not.
	Problems []string
	Warnings []string
}

type RequiredRule struct {
	Name     string
	QueryHas string
}

type StripeFacts struct {
	Err                 error
	Live                bool // the key and the prices are in live mode
	PricesActive        bool // both prices exist and are active
	PortalFound         bool
	TermsSet            bool // the Customer Portal's Terms of service URL
	PrivacySet          bool // and its Privacy policy URL
	PaymentMethodUpdate bool // customers can update their payment method in the portal
	// The payment method configuration our Checkout sessions use (RIVOLT_STRIPE_PAYMENT_METHOD_CONFIG): read at all, found and active, and the
	// payment method types it has on (sorted).
	PMCRead    bool
	PMCFound   bool
	PMCActive  bool
	PMCLive    bool // the configuration's livemode, to compare with the mode of the key (Live)
	PMCMethods []string
	// The account's DEFAULT configuration, which our sessions do not use but the Customer Portal's update-payment-method follows.
	CheckoutMethods []string
	CheckoutRead    bool
	// The Stripe API version the server pins on every call (stripebill.APIVersion) and the versions of the account's ENABLED webhook endpoints,
	// whose payloads the webhook structs read. A mismatch, no enabled endpoint, or an unreadable list is a problem.
	PinnedVersion   string
	WebhookRead     bool
	WebhookVersions []string
	TaxRead         bool // Stripe Tax's settings were read (only asked when automatic tax is on)
	TaxActive       bool // and Stripe Tax is active in this mode
}