snapshot

type Body struct {
	SHA256  string `json:"sha256"` // public bodies; empty for a private body with a ref
	Ref     string `json:"ref,omitempty"`
	Storage string `json:"storage"`
	Size    int64  `json:"size"`
}

type Concurrency struct {
	Service string `json:"service,omitempty"` // empty: the only service
	Value   int    `json:"value"`
	Reason  string `json:"reason"`
	// Probe is how long the first read-only requests took at each setting
	// tried.
	Probe []Probe `json:"probe,omitempty"`
	// Tried is the setting compared with a sequential capture of the same
	// state; SequentialMS and ParallelMS are the two captures' times.
	Tried        int   `json:"tried,omitempty"`
	SequentialMS int64 `json:"sequential_ms,omitempty"`
	ParallelMS   int64 `json:"parallel_ms,omitempty"`
	// Differed lists, sorted, the requests or state items that differed
	// from the sequential capture, the reason for one at a time.
	Differed []string `json:"differed,omitempty"`
}

type Meta struct {
	Version int    `json:"version"`
	Tag     string `json:"tag"`
	Source  string `json:"source"`
	Created string `json:"created"`
	// State is the fingerprint of the state the capture started from, per
	// component; a capture of another state cannot be compared with it.
	State map[string]map[string]string `json:"state,omitempty"`
	// StateFormat is the state.FingerprintFormat of State; 0 before v1.3.
	StateFormat int `json:"state_format,omitempty"`
	// Unreliable marks a capture made with --skip-fingerprint-check.
	Unreliable bool `json:"unreliable,omitempty"`
	// Incomplete marks a capture that has not finished: it is written
	// first and replaced at the end, so an interrupted capture is not
	// taken for one whose requests are missing.
	Incomplete bool `json:"incomplete,omitempty"`
	// Concurrency is what concurrency: auto decided for each service, in
	// name order; later captures use it without measuring again.
	Concurrency []Concurrency `json:"concurrency,omitempty"`
	// Origins are the origins (scheme://host[:port]) the requests were sent
	// to, per service (the empty name: the only one). Responses that write
	// absolute URLs are compared with another origin's through them.
	Origins map[string]string `json:"origins,omitempty"`
}

type PrivateStore struct {
	Dir string
	Ext string // ".enc" in the local store; none in the private/ folder of an older baseline
	Key func() (secret.Key, error)
	// KeyHint, when set, says where the key came from, for a body it
	// cannot open.
	KeyHint func() string
}

type Probe struct {
	Concurrency int   `json:"concurrency"`
	Requests    int   `json:"requests"`
	MS          int64 `json:"ms"`
}

type Record struct {
	Version int         `json:"version"`
	ID      string      `json:"id"`
	Status  int         `json:"status"`
	Headers [][2]string `json:"headers"` // names lower-case, sorted by name; values in received order
	Body    Body        `json:"body"`
	Error   string      `json:"error,omitempty"` // the request failed; no status or body
	// SideEffects is set when the capture tracked the state: what the request
	// changed in the data (an empty list when nothing).
	SideEffects *SideEffects `json:"side_effects,omitempty"`
	// Repeat lists the statuses of a request sent several times, in order
	// ("200×60, 429×1"); the record is the last response.
	Repeat string `json:"repeat,omitempty"`
	// Exit is the exit code of a command step; its body is the output, when
	// the step compares it.
	Exit *int `json:"exit,omitempty"`
}

type RowChange struct {
	Item    string   `json:"item"` // <component>/table:<table>
	Key     string   `json:"key"`  // primary key as column=value pairs
	Change  string   `json:"change"`
	Columns []string `json:"columns,omitempty"` // for an update: the columns that changed
}

type Set struct {
	Dir     string
	Private *PrivateStore
	// contains filtered or unexported fields
}

type SideEffects struct {
	Items []string    `json:"items"`          // <component>/<item>, e.g. db/table:faq
	Rows  []RowChange `json:"rows,omitempty"` // rows of tables under row_tracking
}