botworkspace

type Action int

type Backend interface {
	// Provision brings the bot's workspace to running: image, container,
	// start, bridge readiness, template bootstrap. An empty image means "the
	// backend's default for this bot". Failures are *StepError.
	Provision(ctx context.Context, botID, image string, progress func(ProgressEvent)) error
	// Teardown removes the workspace; a missing workspace is success. With
	// preserve the data is exported before deletion and a failed export aborts
	// the teardown.
	Teardown(ctx context.Context, botID string, preserve bool) error
	// Inspect reports the backend's view of the workspace.
	Inspect(ctx context.Context, botID string) (Inspection, error)
	// HasPreservedData reports whether an exported data archive exists.
	HasPreservedData(botID string) bool
}

type BotStatusWriter interface {
	SetBotStatusFromWorkspace(ctx context.Context, botID, status string) error
}

type Inspection struct {
	Exists  bool
	Running bool
	// Image is the container's image reference when it exists.
	Image string
}

type ObservedWrite struct {
	BotID              string
	Owner              string
	ExpectedVersion    int64
	Observed           string
	ObservedGeneration int64
	MarkReady          bool
	LastError          string
	LastErrorCode      string
	LastErrorPhase     string
	Attempts           int32
	NextAttemptAt      time.Time
	ReleaseLease       bool
}

type Options struct {
	Owner             string
	Interval          time.Duration
	Lease             time.Duration
	DriftInterval     time.Duration
	BackoffBase       time.Duration
	BackoffCap        time.Duration
	MaxAttempts       int32
	SlowRetryInterval time.Duration
	Concurrency       int
	// TeardownConcurrency gives removals (rows whose desired state is absent)
	// slots of their own beside Concurrency's, so a removal never waits
	// behind provisionings. Zero, the default, keeps one pool of Concurrency
	// slots for both: a removal that exports data competes with image pulls
	// for the same host.
	TeardownConcurrency int
	ProvisionTimeout    time.Duration
	TeardownTimeout     time.Duration
	WriteTimeout        time.Duration
}

type ProgressEvent struct {
	Type             string
	Image            string
	Message          string
	Layers           []ctr.LayerStatus
	ContainerID      string
	WorkspaceBackend string
	RuntimeBackend   string
	ContainerPath    string
	CDIDevices       []string
	Snapshotter      string
	Started          bool
	DataRestored     bool
	HasPreservedData bool
	// Terminal fields, set by the reconciler on "ready" / "error".
	Phase     string
	Err       error
	Workspace *Workspace
}

type Repository interface {
	Upsert(ctx context.Context, botID, desired, image string, preserveData bool) (Workspace, error)
	// CancelRemoval returns ErrNotFound when the bot has no failed removal.
	CancelRemoval(ctx context.Context, botID, observed string) (Workspace, error)
	Get(ctx context.Context, botID string) (Workspace, error)
	// Claim leases up to limit due rows. A non-empty desired state claims only
	// the rows that want it.
	Claim(ctx context.Context, owner string, lease time.Duration, desired string, limit int32) ([]Workspace, error)
	ClaimOne(ctx context.Context, botID, owner string, lease time.Duration) (Workspace, error)
	Renew(ctx context.Context, botID, owner string, lease time.Duration) error
	WriteObserved(ctx context.Context, w ObservedWrite) (Workspace, error)
	Release(ctx context.Context, botID, owner string) error
	ListByObserved(ctx context.Context, observed string, limit int32) ([]Workspace, error)
}

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

type StepError struct {
	Phase     string
	Retryable bool
	Err       error
}

type Workspace struct {
	BotID              string
	TeamID             string
	Desired            string
	DesiredGeneration  int64
	Image              string
	PreserveData       bool
	Observed           string
	ObservedGeneration int64
	EverReady          bool
	// LastError is the text an earlier server stored; new failures set
	// LastErrorCode and leave it empty.
	LastError      string
	LastErrorCode  string
	LastErrorPhase string
	Attempts       int32
	NextAttemptAt  time.Time
	LeaseOwner     string
	LeaseUntil     time.Time
	Version        int64
	UpdatedAt      time.Time
}