datamigrate

type Check struct {
	ID     string `json:"id"`
	Status string `json:"status"`
	Detail string `json:"detail"`
	Fix    string `json:"fix,omitempty"`
}

type Copier struct {
	Runtime  docker.Runtime
	Restorer Restorer
	Logger   *slog.Logger
	// VerifyAttempts and VerifyInterval retry the target count while the
	// engine is still loading the restored data. Zero values use defaults.
	// HelperNetwork is a Docker network the helper joins instead of the
	// default bridge, so a source container on it is reachable.
	HelperNetwork  string
	VerifyAttempts int
	VerifyInterval time.Duration
}

type DNSResolver struct {
	Timeout time.Duration
}

type DatabaseInfo struct {
	Name       string   `json:"name"`
	SizeBytes  int64    `json:"size_bytes"`
	Tables     int      `json:"tables"`
	Extensions []string `json:"extensions,omitempty"`
}

type DomainPlan struct {
	App     string        `json:"app"`
	Domain  string        `json:"domain"`
	Verdict string        `json:"verdict"`
	Checks  []Check       `json:"checks"`
	DNS     DomainState   `json:"dns"`
	Change  *RecordChange `json:"change,omitempty"`
}

type DomainState struct {
	Addrs []string `json:"addrs,omitempty"`
	CNAME string   `json:"cname,omitempty"`
	// TTL is the TTL in seconds of the record the operator edits, 0 when unknown.
	TTL uint32 `json:"ttl"`
	// Authoritative is false when TTL came from a caching resolver, so the
	// real value may be higher than what it shows.
	Authoritative bool   `json:"authoritative"`
	Error         string `json:"error,omitempty"`
}

type EvalInput struct {
	App         string
	Domain      string
	Ready       bool
	ReadyDetail string
	DNS         DomainState
	TargetIPs   []string
	MaxTTL      uint32
}

type FailureInfo struct {
	Code      string `json:"code"`
	Summary   string `json:"summary"`
	Hint      string `json:"hint"`
	Technical string `json:"technical,omitempty"`
}

type HostedConfig struct {
	AllowInsecure bool
	MaxBytes      int64
}

type HostedPlan struct {
	// URL is the source connection URL. It prints and marshals redacted.
	URL SecretURL `json:"url"`
	// TargetName is the new managed database name; TargetVersion defaults to
	// the source's major (with the pgvector variant when needed).
	TargetName    string `json:"target_name"`
	TargetVersion string `json:"target_version,omitempty"`
	TargetExists  bool   `json:"target_exists,omitempty"`
	OwnTarget     bool   `json:"own_target,omitempty"`
	// WritesFrozen is the caller's acknowledgement that the old app is in
	// maintenance mode (Heroku: `heroku maintenance:on -a <app>`) and nothing
	// writes to the source. A dump taken while it changes is not a copy.
	WritesFrozen bool `json:"writes_frozen"`
	// AllowLarge overrides the size ceiling after reading the replication advice.
	AllowLarge bool `json:"allow_large,omitempty"`
	// CreateMissingRoles creates the roles named by row level security
	// policies on the target (NOLOGIN NOINHERIT) before the restore.
	CreateMissingRoles bool `json:"create_missing_roles,omitempty"`
}

type HostedPreflightInput struct {
	Plan   HostedPlan
	Source HostedSource
	Probe  HostedProbe
	// Target is what the managed database already holds.
	Target      TargetState
	Config      HostedConfig
	DiskMargin  float64
	MBPerSecond float64
}

type HostedProbe struct {
	Version    string   `json:"version"`
	VersionNum int      `json:"version_num"`
	Major      int      `json:"major"`
	SizeBytes  int64    `json:"size_bytes"`
	Tables     int      `json:"tables"`
	Extensions []string `json:"extensions,omitempty"`
	// PolicyRoles are roles named by row level security policies. Hosted
	// providers own them, so they will not exist on the target.
	PolicyRoles []string `json:"policy_roles,omitempty"`
	FreeBytes   int64    `json:"free_bytes"`
}

type HostedResult struct {
	Preflight PreflightResult `json:"preflight"`
	Probe     HostedProbe     `json:"probe"`
	// Restore holds what the restore changed to tolerate provider objects.
	Restore []PreflightCheck `json:"restore,omitempty"`
	// MissingRoles are the policy roles absent from the target at preflight time.
	MissingRoles []string     `json:"missing_roles,omitempty"`
	Verification Verification `json:"verification"`
	Redacted     string       `json:"source"`
}

type HostedSource struct {
	Source Source
	// Redacted is the URL with the password masked, safe to log and store.
	Redacted string
	// Private is true when the host is a loopback, private or internal name.
	Private bool
	// contains filtered or unexported fields
}

type Inspector struct {
	Runtime       docker.Runtime
	Logger        *slog.Logger
	HelperVersion string
	// HelperNetwork is the Docker network the helper joins, see Copier.
	HelperNetwork string
}

type Inventory struct {
	Version   string         `json:"version"`
	Major     int            `json:"major"`
	FreeBytes int64          `json:"free_bytes"`
	Databases []DatabaseInfo `json:"databases"`
}

type LocalSource struct {
	Container string `json:"container"`
	Image     string `json:"image"`
	Engine    string `json:"engine"`
	Running   bool   `json:"running"`
	Network   string `json:"network,omitempty"`
	Host      string `json:"host,omitempty"`
	Port      int    `json:"port,omitempty"`
	// Problem is why this container cannot be used, empty when it can.
	Problem string `json:"problem,omitempty"`
}

type ObjectCounts struct {
	Sequences  int `json:"sequences"`
	Views      int `json:"views"`
	Functions  int `json:"functions"`
	Extensions int `json:"extensions"`
}

type PreflightCheck struct {
	ID         string `json:"id"`
	Severity   string `json:"severity"`
	Message    string `json:"message"`
	NextAction string `json:"next_action,omitempty"`
}

type PreflightInput struct {
	Engine        string
	DB            DatabaseInfo
	SourceMajor   int
	TargetName    string
	TargetVersion string
	// TargetExists is true when a managed database already has TargetName,
	// OwnTarget when this migration created it earlier (so a retry is fine).
	TargetExists bool
	OwnTarget    bool
	// FreeBytes is the target node's free disk, negative when unknown.
	FreeBytes int64
	// DiskMargin multiplies the database size to get the space required.
	DiskMargin float64
	// MBPerSecond is the assumed copy throughput for the time estimate.
	MBPerSecond float64
}

type PreflightResult struct {
	Checks          []PreflightCheck `json:"checks"`
	TargetVersion   string           `json:"target_version"`
	RequiredBytes   int64            `json:"required_bytes"`
	EstimateSeconds int              `json:"estimate_seconds"`
	Blocked         bool             `json:"blocked"`
}

type Prober struct {
	Resolver Resolver
	// Dial opens a TCP connection, used to reach this node directly.
	Dial func(ctx context.Context, network, addr string) (net.Conn, error)
	// RootCAs overrides the system roots, for a private CA.
	RootCAs *x509.CertPool
	Timeout time.Duration
}

type RecordChange struct {
	Type     string `json:"type"`
	Name     string `json:"name"`
	Value    string `json:"value"`
	TTL      uint32 `json:"ttl"`
	Replaces string `json:"replaces,omitempty"`
}

type Resolver interface {
	Lookup(ctx context.Context, domain string) DomainState
}

type Restorer interface {
	Restore(ctx context.Context, engine, containerName string, dump io.Reader) error
}

type SecretURL string

type Source struct {
	Host     string `json:"host"`
	Port     int    `json:"port,omitempty"`
	User     string `json:"user,omitempty"`
	Password string `json:"password,omitempty"`
	Database string `json:"database,omitempty"`
	// AuthDatabase is MongoDB's authentication database, "admin" when empty.
	AuthDatabase string `json:"auth_database,omitempty"`
	TLS          bool   `json:"tls,omitempty"`
	// SSLMode is the libpq sslmode for Postgres when TLS is set, "require" when empty.
	SSLMode string `json:"ssl_mode,omitempty"`
}

type TableCount struct {
	Name   string `json:"name"`
	Source int64  `json:"source"`
	Target int64  `json:"target"`
	OK     bool   `json:"ok"`
}

type Target struct {
	Name    string
	Engine  string
	Version string
}

type TargetState struct {
	// Known is false when the target could not be queried.
	Known bool
	Roles []string
	// UserTables counts tables outside the system schemas: non-zero means an
	// earlier run (or other data) lives there.
	UserTables int
}

type Verification struct {
	Checked    int          `json:"checked"`
	Mismatched int          `json:"mismatched"`
	Tables     []TableCount `json:"tables,omitempty"`
	// Objects counts what else arrived (hosted Postgres moves only).
	Objects *ObjectCounts `json:"objects,omitempty"`
	// Findings are what the move changed or created on the way (hosted moves only).
	Findings []PreflightCheck `json:"findings,omitempty"`
}

type VolumeGuide struct {
	App           string `json:"app"`
	Kind          string `json:"kind"`
	Source        string `json:"source"`
	Target        string `json:"target"`
	ContainerPath string `json:"container_path"`
	Command       string `json:"command"`
}

type VolumeRef struct {
	// Name is the Docker volume name here, empty for a bind mount.
	Name          string
	ContainerPath string
	HostPath      string
	// SourceName is the volume's real name on the source host, when it is
	// not derivable from Name by trimming the app prefix.
	SourceName string
}