storagecommit

type AddPiecesStatusChecker interface {
	GetAddPiecesStatus(context.Context, synapse.AddPiecesStatusInput) (synapse.PDPStatusResult, error)
}

type AdvanceInput struct {
	Copy                model.StorageUploadCopy
	Binding             model.StorageDataSet
	Target              synapse.DataSetTarget
	Pieces              []storage.PieceInput
	RequireEligibleCopy bool
	OwnerTerminal       bool
}

type AdvanceResult struct {
	State         AdvanceState
	ReleaseReason ReleaseReason
	AttemptID     string
	Confirmation  *storage.CommitResult
	AttentionCode AttentionCode
	Continue      bool
	// Cause carries the provider error behind a release so the caller can record
	// why the data set failed instead of a generic sentinel. It is set only on
	// ReleaseDataSetUnavailable and is nil everywhere else.
	Cause error
	// AttentionHeld carries the reservation's flagged-attempt count so the caller
	// can say why capacity is unavailable. It is set only on
	// AdvanceWaitingCapacity and is zero everywhere else.
	AttentionHeld int
}

type AdvanceState string

type Advancer struct {
	Store          Store
	StatusChecker  AddPiecesStatusChecker
	RequestTimeout time.Duration
	AttentionAfter time.Duration
	Now            func() time.Time
}

type AttemptInput struct {
	Copy         CopyIdentity
	AttemptID    string
	ExtraDataHex string
	Now          time.Time
}

type AttemptResult struct {
	Entered bool
	Copy    model.StorageUploadCopy
}

type AttentionCode string

type AttentionInput struct {
	Copy      CopyIdentity
	AttemptID string
	Code      AttentionCode
	Now       time.Time
}

type AttentionRecord struct {
	CopyID        int64
	UploadID      int64
	CopyIndex     int
	DataSetRowID  int64
	ProviderID    string
	DataSetID     string
	PieceCID      string
	AttemptID     string
	TransactionID string
	Code          AttentionCode
	AttemptedAt   time.Time
	AttentionAt   time.Time
}

type CopyIdentity struct {
	StorageUploadCopyID int64
	UploadID            int64
	CopyIndex           int
	StorageDataSetID    int64
	RequireEligibleCopy bool
}

type EvidenceInput struct {
	Copy           CopyIdentity
	AttemptID      string
	TransactionID  string
	SubmissionJSON string
	Now            time.Time
}

type ManualReleaseInput struct {
	CopyID                       int64
	ExpectedAttemptID            string
	AcknowledgePossibleDuplicate bool
	Now                          time.Time
}

type ReleaseInput struct {
	Copy              CopyIdentity
	AttemptID         string
	KnownNotSubmitted bool
	ClearReadyAt      bool
	ClearExtraData    bool
	Now               time.Time
}

type ReleaseReason string

type ReservationReleaseInput struct {
	Copy           CopyIdentity
	ClearReadyAt   bool
	ClearExtraData bool
	Now            time.Time
}

type ReservationState string

type ReserveInput struct {
	Copy      CopyIdentity
	AttemptID string
	Now       time.Time
}

type ReserveResult struct {
	State ReservationState
	Copy  model.StorageUploadCopy
	// AttentionHeld counts the data set's active attempts already flagged for
	// operator attention. It is set only when capacity turned the reservation
	// away, so a waiting result with zero here is queued behind work that is
	// still moving.
	AttentionHeld int
}

type ResetInput struct {
	Copy      CopyIdentity
	AttemptID string
	LastError string
	Now       time.Time
}

type Store interface {
	ReserveCommitAttempt(context.Context, ReserveInput) (ReserveResult, error)
	MarkCommitAttempted(context.Context, AttemptInput) (AttemptResult, error)
	RecordCommitTransaction(context.Context, EvidenceInput) error
	RecordCommitSubmission(context.Context, EvidenceInput) error
	MarkCommitAttention(context.Context, AttentionInput) error
	ResetCommitAttempt(context.Context, ResetInput) error
	ReleaseCommitAttempt(context.Context, ReleaseInput) error
	ReleaseCommitReservation(context.Context, ReservationReleaseInput) error
}