daemon

type ErrNotRunning struct{ Phrase string }

type Link struct {
	Contract  int    `json:"contract"`
	URL       string `json:"url"`
	Kind      string `json:"kind"`
	Running   bool   `json:"running"`
	UISupport string `json:"uiSupport"`
	// Warnings is always present ([] when empty) so the shape is stable.
	Warnings []string `json:"warnings"`
}

type LinkRequest struct {
	Project, Env, DB, Table, Schema string
	View                            bool
	Records                         bool
	Limit                           int
	Record                          string // primary key as a JSON object
	// Code is the one-time code of the agent (agentaccess.MintCode), put first in the fragment of
	// every link; "" when the agent has none to give.
	Code string
	// Metadata reads the scanned relations named Table (nil when the project holds none): the link is
	// checked against them, and carries a warning when there is nothing to check against. It runs
	// last, after every check of the request itself; a nil function is no metadata.
	Metadata func() *Metadata
}

type Manager struct {
	Dir   string
	Exe   func() (string, error)
	Probe func(port int) (version string, ok bool)
	// Dial says whether something accepts a TCP connection on 127.0.0.1:port. It sends no
	// HTTP request, so it never counts as activity for the server's idle timer.
	Dial     func(port int) bool
	PortFree func(port int) bool
	Alive    func(pid int) bool
	// Owns says whether pid is a `datatug serve` on port (guards against a reused pid).
	Owns      func(pid, port int) bool
	Terminate func(pid int) error
	// Spawn starts the detached server and returns its pid and a channel closed when it exits.
	Spawn func(exe string, args []string, logPath string) (pid int, exited <-chan struct{}, err error)
	Now   func() time.Time
	Sleep func(time.Duration)
	// PolicySetPresent says whether `serve` would find a policy set and so refuse to start
	// without a named principal; nil means no. It reads nothing beyond existence/validity.
	PolicySetPresent func() bool
	// StartWait bounds the readiness wait; Poll is its interval.
	StartWait time.Duration
	Poll      time.Duration
}

type Metadata struct{ Relations []Relation }

type NotFoundError struct{ Msg string }

type Record struct {
	PID         int       `json:"pid"`
	Port        int       `json:"port"`
	URL         string    `json:"url"`
	StartedAt   time.Time `json:"startedAt"`
	StartedBy   string    `json:"startedBy"`
	Version     string    `json:"version"`
	Binary      string    `json:"binary"`
	IdleTimeout string    `json:"idleTimeout"`
}

type Relation struct {
	Schema, Name string
	View         bool
	PrimaryKey   []string
}

type ResultLink struct {
	Contract     int    `json:"contract"`
	URL          string `json:"url,omitempty"`
	Kind         string `json:"kind"`
	Running      bool   `json:"running"`
	UISupport    string `json:"uiSupport"`
	ResultExists bool   `json:"resultExists"`
	// Warnings is always present ([] when empty), as on every daemon url link.
	Warnings []string `json:"warnings"`
}

type ResultLinkRequest struct {
	ID   string
	View string
	Row  int
	// Exists is whether the result's meta.json is there; no link is built
	// for a result that is not.
	Exists bool
	// Code is the one-time code put first in the fragment; "" for none.
	Code string
}

type Status struct {
	Running     bool   `json:"running"`
	URL         string `json:"url"`
	UIBase      string `json:"uiBase"`
	Port        int    `json:"port"`
	PID         int    `json:"pid"`
	StartedBy   string `json:"startedBy"`
	StartedAt   string `json:"startedAt,omitempty"`
	Version     string `json:"version"`
	LogFile     string `json:"logFile"`
	IdleTimeout string `json:"idleTimeout"`
	Error       string `json:"error,omitempty"`
	// StartError is the stable machine-readable reason a start failed, when one is named
	// (StartPolicyPrincipalRequired); omitted when empty.
	StartError string `json:"startError,omitempty"`
}

type UsageError struct{ Msg string }