scriptrec

type Answerer interface {
	Answer(tool string, args map[string]any) (out map[string]any, errText string, ok bool)
}

type Call struct {
	// Key is what a replay matches a call by: the tool and its arguments, or
	// the output's identity.
	Key  string         `json:"key"`
	Tool string         `json:"tool,omitempty"`
	Args map[string]any `json:"args,omitempty"`
	Out  map[string]any `json:"out,omitempty"`
	// Output is set for a written output: what the writer answered.
	Output *scriptrun.ExportResult `json:"output,omitempty"`
	// Error is the failure the call answered with instead, if it failed.
	Error string `json:"error,omitempty"`
}

type Header struct {
	V        int            `json:"v"`
	RunID    string         `json:"run_id"`
	FireTime time.Time      `json:"fire_time"`
	Params   map[string]any `json:"params"`
	State    map[string]any `json:"state"`
	RunURL   string         `json:"run_url,omitempty"`
	// MaxRows is the row cap the run's queries carried, which is part of each
	// query's arguments.
	MaxRows int `json:"max_rows"`
	// Preview is true when the run's outputs were previewed rather than
	// written: a draft. A replay of it previews them too.
	Preview bool `json:"preview"`
}

type Made struct {
	Tool     string
	Args     map[string]any
	Out      map[string]any
	Error    string
	Declared bool
}

type Meta struct {
	// RunID is the run's id, or the draft's, and is what a test names.
	RunID string `json:"run_id"`
	// ScriptID is the script recorded, empty for a draft of a script not yet
	// saved until a script naming the recording in a test is saved.
	ScriptID   string `json:"script_id,omitempty"`
	ScriptName string `json:"script_name"`
	Kind       string `json:"kind"`
	// RecordedBy is who the recorded run ran for: the draft's author, or the
	// owner of the script a run ran.
	RecordedBy string `json:"recorded_by"`
	// Version is the version a run executed, zero for a draft.
	Version      int    `json:"version,omitempty"`
	SourceSHA256 string `json:"source_sha256"`
	Succeeded    bool   `json:"succeeded"`
	// Reason says why there is no recording to replay, when there is none.
	Reason string `json:"reason,omitempty"`
	Bytes  int    `json:"bytes"`
	// Kept is true while a test in the script's latest version names the
	// recording, which keeps it past the run-retention sweep.
	Kept      bool      `json:"kept"`
	CreatedAt time.Time `json:"created_at"`
}

type MissingError struct {
	Call string
	// Held is how many answers the recording holds for the call, and so how
	// many times it could be made.
	Held int
}

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

type Recording struct {
	Header
	Calls []Call
}

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

type Store interface {
	// Save stores a recording, replacing one recorded under the same run id
	// (a run taken over from a worker that died records again).
	Save(ctx context.Context, rec Stored) error
	// Get returns one recording, or ErrNotFound.
	Get(ctx context.Context, runID string) (*Stored, error)
	// Recent returns the newest replayable recordings of the script's
	// successful runs, newest first.
	Recent(ctx context.Context, scriptID string, limit int) ([]Stored, error)
	// Keep marks the recordings runIDs names as kept, and every other
	// recording of the script as not, and attaches to the script the ones
	// among them author recorded as drafts of it before it was saved.
	Keep(ctx context.Context, scriptID, author string, runIDs []string) error
	// Purge deletes the recordings older than retention that are not kept.
	Purge(ctx context.Context, retention time.Duration) (int64, error)
}

type Stored struct {
	Meta
	Data []byte
}