effort

type CorruptError ¶

type CorruptError struct {
	Path string
	Err  error
}

CorruptError identifies resident input that must be preserved byte-for-byte.

func (e *CorruptError) Diagnostic() (presentation.Diagnostic, error)

func (e *CorruptError) Error() string

func (e *CorruptError) Unwrap() error

type Dependencies ¶

type Dependencies struct {
	Clock                 func() time.Time
	UUID                  func() (string, error)
	Worktrees             func(context.Context) ([]awfgit.WorktreeRegistration, error)
	BranchExists          func(context.Context, string) (bool, error)
	ValidateRef           func(context.Context, string) (bool, error)
	ExpectedArchiveMarker func() ([]byte, error)
	// Fault is the durability-boundary hook the restartable-finish tests
	// interrupt the service at. It is the one optional member: a nil Fault
	// injects nothing, which is what production wants and what "no fault
	// injection configured" means.
	Fault func(stage string) error
}

Dependencies is everything the service reaches the outside world through: the clock, the identity allocator, the three Git questions it asks, and tree removal. Every one is supplied by the composition root, because a service that quietly substituted its own would make what a caller composed unverifiable from the call site.

The Git dependencies are stated as this package's own questions rather than as a repository object, so the service depends on what it asks and not on who answers. Each is bound to the checkout the service was opened against, so none of them names a root.

type FinishResidentState ¶ added in v0.33.0

type FinishResidentState string

FinishResidentState identifies the resident namespace proven at return.

const (
	FinishStateActive   FinishResidentState = "active"
	FinishStateReserved FinishResidentState = "reserved"
	FinishStateArchived FinishResidentState = "archived"
)

type FinishResult ¶

type FinishResult struct {
	State                    FinishResidentState
	Reserved                 bool
	Archived                 bool
	DestinationSyncAvailable bool
	SourceSyncAvailable      bool
	DestinationSynced        bool
	SourceSynced             bool
	ArchivePath              string
}

FinishResult reports each observable namespace and durability boundary.

func (r FinishResult) FinishMutation(slug string) (presentation.Mutation, error)

type NewInput ¶

type NewInput struct {
	Slug  string
	Title string
}

NewInput carries the caller-selected immutable identity and independent descriptive title for one effort creation.

type PartialFinishError ¶

type PartialFinishError struct {
	Result  FinishResult
	Cause   error
	Actions []RecoveryAction
}

PartialFinishError preserves a failed restartable finish's observed state, mechanism cause, and site-specific recovery actions.

func (e *PartialFinishError) Diagnostic() (presentation.Diagnostic, error)

func (e *PartialFinishError) Error() string

func (e *PartialFinishError) Unwrap() error

type Record ¶

type Record struct {
	SchemaVersion int       `json:"-"`
	ID            string    `json:"id"`
	Slug          string    `json:"slug"`
	Title         string    `json:"title"`
	CreatedAt     time.Time `json:"createdAt"`
	MemoryPath    string    `json:"memoryPath"`
}

Record is the public effort view. SchemaVersion belongs to the containing reply, while static state carries it directly.

func (r Record) Detail() (presentation.Detail, error)

func (r Record) NewEffortMutation(mutation presentation.Mutation) (presentation.Mutation, error)

type RecoveryAction ¶

type RecoveryAction struct{ Text string }

RecoveryAction is one independently executable ordered remedy for a failed effort operation. Its meaning remains model-owned until presentation maps it.

type RollbackResult ¶ added in v0.33.0

type RollbackResult struct {
	Reserved        bool
	Removed         bool
	ReservationPath string
	ResiduePath     string
}

RollbackResult reports the narrow failed-creation deletion transition.

type Service ¶

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

Service owns immutable effort residents and restartable finish.

func Open(roots awfgit.ControlRoots, deps Dependencies) (*Service, error)

func (s *Service) Finish(ctx context.Context, slug string) (FinishResult, error)

func (s *Service) List() ([]Record, error)

func (s *Service) New(ctx context.Context, input NewInput) (Record, error)

func (s *Service) RollbackCreation(ctx context.Context, identity Record) (RollbackResult, error)

func (s *Service) Show(slug string) (Record, error)