sync

type BuggifyChecker interface {
	Check(site string, probability float64) bool
}

type CkinLockFail struct {
	HeldBy string
	Since  time.Time
}

type CkinLockReq struct {
	ParentUUID string
	ClientID   string
}

type CloneOpts struct {
	StoreCone *cone.Cone // nil is dense; local policy, never synchronized
	User      string     // Credentials for clone auth (also default admin user)
	Password  string
	Version   int            // Protocol version (default 3)
	Env       *simio.Env     // nil defaults to RealEnv
	Observer  Observer       // nil defaults to no-op
	Buggify   BuggifyChecker // fault injection for DST (nil = no faults)
	// PullPhantoms, when set, makes Clone fetch the artifacts the clone
	// rounds left missing with a follow-up pull session, and fail with a
	// *PhantomStallError if any are still missing after it. That pull
	// departs from Section 8.2 of the sync draft, which sends no clone,
	// pull or push card after clone_seqno 0, so it is off by default.
	PullPhantoms bool
	// SeedKey, when set, is the origin's public key: an SSH public key line
	// or an OpenPGP fingerprint. The clone keeps it as its horizon-seed-key
	// setting and verifies every structural seed against it
	// (draft-fossil-horizon-00 §5.2.4); empty accepts an unsigned seed.
	SeedKey string
	// Origin names the peer the clone addresses, keying the horizon cursor
	// a converged horizon clone records (draft-fossil-horizon-00 §6.2.6) as
	// SyncOpts.Origin keys a sync's. Empty keeps none.
	Origin string
	// Named, when set, asks for the store's horizon by name rather than by
	// hash (draft-fossil-horizon-00 §6.1, §6.2.7); StoreCone then gives the
	// path members alone and must carry no horizon. The store records only
	// the check-in the name resolves to.
	Named *NamedHorizon
}

type CloneResult struct {
	Elided        int // artifacts deliberately absent under the store cone
	ConeServed    int // replies acknowledging the store cone (sparse-cone §6.3); the rest were filtered locally
	HorizonServed int // replies serving the store's horizon at either level (horizon §6.2.5); the rest were classified locally
	// StructuralServed counts the replies that served the structural level,
	// and HorizonFallback reports a structural clone that kept the content
	// horizon instead: its origin did not serve the structural level with a
	// seed in the first reply, or the seed failed its provenance (§5.1,
	// §5.2.4, §6.3).
	StructuralServed int
	HorizonFallback  bool
	Rounds           int
	BlobsRecvd       int
	ArtifactsLinked  int // Manifests crosslinked into event table
	ProjectCode      string
	ServerCode       string
	Messages         []string // Informational messages from server, and a horizon-fallback: remedy (§6.3)
	// HorizonHistoryURL is the interface outside the protocol at which the
	// origin says history below a horizon can be queried (horizon-served
	// URL, §6.2.5), the last a reply named; "" when none did.
	HorizonHistoryURL string
	// HorizonResolved is the check-in a clone's Named horizon resolved to and
	// HorizonSteps the steps back it took, fewer than its Depth when
	// history ran out; HorizonResolvedLocally reports the clone resolved it
	// itself, its origin having answered no horizon-resolved (§6.3).
	HorizonResolved        string
	HorizonSteps           uint32
	HorizonResolvedLocally bool
}

type HTTPTransport struct {
	URL string // repo root, e.g. "http://localhost:8080"
	// contains filtered or unexported fields
}

type HandleEnd struct {
	CardsProcessed int
	FilesSent      int
	FilesReceived  int
	// SparseClassified counts the artifacts a cone request's keep-set
	// discovery read and classified (§6.2); zero for a dense request.
	SparseClassified int
	Err              error
}

type HandleFunc func(ctx context.Context, r *repo.Repo, req *xfer.Message) (*xfer.Message, error)

type HandleOpts struct {
	// PartialMirror permits clone requests beyond this store's cone, as the
	// SettingPartialMirror repository setting does for every caller.
	PartialMirror bool
	Buggify       BuggifyChecker // nil in production.
	Observer      Observer       // nil defaults to no-op.
	ContentCache  *content.Cache // nil = no caching; rid-keyed, so not across a rollback
	Clock         simio.Clock    // time for the reply's timestamp comment and receipt; nil = real time
	// RemoteAddr is the address the request came from, recorded with what it
	// pushes (fossil's REMOTE_ADDR). "" takes the one WithRemoteAddr put in
	// the context, if any.
	RemoteAddr string
	// MaxStoredBytes, when positive, is the most bytes one artifact this
	// request pushes may occupy in blob.content, as stored (compressed, and
	// as a delta when it arrives as one). A host whose storage caps a single
	// value sets it: an artifact over it refuses the request whole, naming
	// the artifact, instead of failing at the storage layer. 0 stores any
	// size. Clone and pull replies are not limited. The HandleSync a
	// ServeHTTP or XferHandler caller usually passes applies no budget.
	MaxStoredBytes int
}

type HandleStart struct {
	Operation   string // "sync" or "clone"
	ProjectCode string
	RemoteAddr  string
}

type MergeBaseQuery struct {
	Primary     string
	Secondaries []string
}

type MockTransport struct {
	Handler func(req *xfer.Message) *xfer.Message
}

type NamedHorizon struct {
	Name  string
	Depth uint32
	Rule  cone.HorizonRule
	Level cone.HorizonDepth
}

type Observer interface {
	// Client-side session lifecycle.
	Started(ctx context.Context, info SessionStart) context.Context
	RoundStarted(ctx context.Context, round int) context.Context
	RoundCompleted(ctx context.Context, round int, stats RoundStats)
	Completed(ctx context.Context, info SessionEnd, err error)

	// Per-error recording — called on individual protocol errors.
	Error(ctx context.Context, err error)

	// Server-side request lifecycle.
	HandleStarted(ctx context.Context, info HandleStart) context.Context
	HandleCompleted(ctx context.Context, info HandleEnd)

	// Table sync lifecycle.
	TableSyncStarted(ctx context.Context, info TableSyncStart)
	TableSyncCompleted(ctx context.Context, info TableSyncEnd)
}

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

type PhantomStallError struct {
	Count  int      // phantom UUIDs still outstanding when the clone stopped
	Sample []string // up to phantomStallSampleSize lexicographically-smallest of those UUIDs, for diagnosis
}

type RefusedError struct {
	Message string
}

type RoundStats struct {
	FilesSent     int
	FilesReceived int
	GimmesSent    int
	IgotsSent     int
	BytesSent     int64
	BytesReceived int64
}

type SeedMismatch struct {
	Checkin, Tag, Seeded, Derived string
}

type SeedReport struct {
	Checked    int
	Mismatches []SeedMismatch
}

type SessionEnd struct {
	Operation                 string
	Rounds                    int
	FilesSent, FilesRecvd     int
	UVFilesSent, UVFilesRecvd int
	UVGimmesSent              int
	BytesSent, BytesRecvd     int64
	ProjectCode               string
	Errors                    []string
}

type SessionStart struct {
	Operation   string // "sync" or "clone"
	Push, Pull  bool
	UV          bool
	ProjectCode string
	PeerID      string // identifies the leaf agent instance
}

type StatusError struct {
	Code   int    // HTTP status code
	Status string // HTTP status line, e.g. "503 Service Unavailable"
}

type SyncOpts struct {
	Push, Pull   bool           // enable push/pull directions (at least one must be true)
	ProjectCode  string         // repo's project-code — sent to identify the repository
	ServerCode   string         // server-code from a previous session (cookie-like, speeds up sync)
	User         string         // login user — empty means unauthenticated "nobody" sync
	Password     string         // login password
	PeerID       string         // identifies this leaf agent instance (for observability)
	MaxSend      int            // byte budget per round for file payloads (0 defaults to DefaultMaxSend)
	UV           bool           // enable unversioned file sync (wiki, forum, attachments)
	XTableSync   bool           // enable extension table sync (peer_registry, etc.) — only between EdgeSync peers
	Private      bool           // enable private artifact sync
	ShareLinks   bool           // share-links mode: request and keep links (§9.5); pull only
	Env          *simio.Env     // nil defaults to RealEnv
	Buggify      BuggifyChecker // nil in production — used by DST for fault injection
	Observer     Observer       // nil defaults to no-op
	CkinLock     *CkinLockReq   // nil = no lock requested
	ContentCache *content.Cache // nil = no caching; rid-keyed, so not across a rollback
	// Origin names the peer this session addresses, keying the horizon
	// cursor a horizon store keeps per origin (draft-fossil-horizon-00
	// §6.2.6). Empty keeps no cursor: every request announces in full.
	Origin string
	// MergeBaseOf, when set, asks the origin for the merge base it names
	// (draft-fossil-horizon-00 §6.2.4), once, in the first request; it needs
	// Pull, and one or two secondaries. The answer is in the result.
	MergeBaseOf MergeBaseQuery
}

type SyncResult struct {
	Elided int // artifacts deliberately absent under the store cone
	// ConeServed counts the replies whose peer acknowledged applying the
	// store cone (pragma cone-served, sparse-cone §6.3). The other rounds of
	// a sparse store were served densely and filtered locally.
	ConeServed int
	// HorizonServed counts the replies whose origin served the store's
	// horizon at either level (pragma horizon-served, horizon §6.2.5). The
	// other rounds were served densely and classified locally (§6.3).
	HorizonServed int
	// StructuralServed counts the replies that served the structural level.
	// HorizonFallback reports a structural store that fell back to the
	// content horizon for good: its origin did not serve the structural
	// level with a seed in the first reply, or the seed failed its
	// provenance (§5.1, §5.2.4, §6.3).
	StructuralServed              int
	HorizonFallback               bool
	Rounds, FilesSent, FilesRecvd int
	UVFilesSent, UVFilesRecvd     int
	UVGimmesSent                  int
	BytesSent, BytesRecvd         int64
	ArtifactsLinked               int
	Errors                        []string
	CkinLockFail                  *CkinLockFail // nil = no conflict
	// HorizonHistoryURL is the interface outside the protocol at which the
	// origin says history below a horizon can be queried (horizon-served
	// URL, §6.2.5), the last a reply named; "" when none did.
	HorizonHistoryURL string
	// AvoidSubmanifests reports that this exchange received pragma
	// avoid-submanifests (draft-fossil-submanifests-00 §7.2). Sync makes no
	// commit; this observation does not bind a later local commit.
	AvoidSubmanifests bool
	// MergeBaseAnswered reports that the origin answered MergeBaseOf, and
	// MergeBase is its answer: the base's hash, or "" when the two share no
	// ancestor.
	MergeBaseAnswered bool
	MergeBase         string
}

type SyncedTable struct {
	Info repo.TableInfo
	Def  repo.TableDef
}

type TableSyncEnd struct {
	Table    string
	Sent     int
	Received int
}

type TableSyncStart struct {
	Table     string
	LocalRows int
}

type Transport interface {
	Exchange(ctx context.Context, request *xfer.Message) (*xfer.Message, error)
}

type TransportFault interface {
	error
	// RetryableTransportFault reports whether sending the same request
	// again may succeed. It is true only when no reply was interpreted, so
	// a resend cannot mask a defect in one that was.
	RetryableTransportFault() bool
}