recovery.go RawHistoryFolder

1package ports
2
3import (
4	"context"
5
6	"github.com/bnema/vev/internal/domain"
7)
8
9type CheckpointRef = domain.CheckpointRef
10
11type SnapshotPublication struct {
12	IncarnationID    domain.IncarnationID
13	Name             string
14	Generation       uint64
15	ParentCheckpoint *domain.CheckpointRef
16	Manifest         []byte
17	Objects          []SnapshotObject
18}
19
20type SnapshotGeneration struct {
21	IncarnationID    domain.IncarnationID
22	Name             string
23	Generation       uint64
24	ParentCheckpoint *domain.CheckpointRef
25	Manifest         []byte
26	// Objects maps each object digest to its bytes. Implementations must only
27	// return objects whose SHA-256 equals their key; consumers rely on this and
28	// do not rehash.
29	Objects map[SnapshotDigest][]byte
30}
31
32type Catalogue interface {
33	Records() ([]domain.CatalogueRecord, error)
34	Record(string) (domain.CatalogueRecord, bool, error)
35	Create(domain.CatalogueRecord) error
36	UpdateMetadata(domain.CatalogueMetadataUpdate) error
37	Replace(string, domain.CatalogueRecord) error
38	Rename(string, domain.CatalogueRecord) error
39	Delete(string) error
40	// Sync makes buffered metadata durable. Identity operations sync internally.
41	Sync() error
42	Close() error
43}
44
45type SnapshotRepository interface {
46	Publish(context.Context, SnapshotPublication) error
47	// LoadCheckpoint returns a generation whose manifest matches the reference
48	// digest and whose objects each match their digest key, or an error.
49	LoadCheckpoint(context.Context, domain.IncarnationID, string, CheckpointRef) (SnapshotGeneration, error)
50	ReconcileCheckpoint(context.Context, domain.IncarnationID, CheckpointRef) error
51	DeleteIncarnation(context.Context, domain.IncarnationID) error
52	// SnapshotIncarnations lists the incarnations present in the repository.
53	SnapshotIncarnations(context.Context) ([]domain.IncarnationID, error)
54	// CollectIncarnationGarbage applies retention to one incarnation. A nil
55	// keep marks an orphan absent from a validated catalogue and removes it
56	// whole; otherwise *keep is the committed checkpoint (zero when none).
57	CollectIncarnationGarbage(ctx context.Context, id domain.IncarnationID, keep *domain.CheckpointRef) error
58}