lifecycle

package

v0.1.11 Latest Latest Go to latest Published: Mar 11, 2026 License: Apache-2.0 Imports: 2 Imported by: 0

Details

Package lifecycle implements a job status state machine with validated transitions and optional hooks.

This section is empty.

View Source

var ErrInvalidTransition = fmt.Errorf("invalid status transition")

ErrInvalidTransition is returned when a status transition is not allowed.

func AllowedTransitions(from types.JobStatus) []types.JobStatus

AllowedTransitions returns the set of statuses a job can move to from its current state.

func CanTransition(from, to types.JobStatus) bool

CanTransition returns true if the transition from → to is valid.

func Validate(from, to types.JobStatus) error

Validate returns an error if the transition from → to is not allowed.

type Hook func(jobID string, from, to types.JobStatus)

Hook is called when a job transitions between states.

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

Machine enforces valid transitions and fires hooks.

func New() *Machine

New creates a new lifecycle state machine.

func (m *Machine) OnTransition(h Hook)

OnTransition registers a hook that fires on every valid transition.

func (m *Machine) Transition(job *types.Job, to types.JobStatus) error

Transition validates the state change and fires hooks if valid. Returns ErrInvalidTransition if the transition is not allowed.