workflow

type Condition ¶

type Condition uint8

Condition selects which upstream outcome triggers a Step.

const (
	OnSuccess  Condition = iota // upstream succeeded
	OnFailure                   // upstream failed
	OnSkipped                   // upstream was skipped
	OnComplete                  // any terminal state
)

type ConfigError ¶

type ConfigError struct {
	Err  error
	Step string
	Dep  string // ErrUnknownDep / ErrCycle only
}

func (e *ConfigError) Error() string

func (e *ConfigError) Unwrap() error

type Dep ¶

type Dep struct {
	Name string
	When Condition
}

Dep is one DAG edge.

func After(name string, when Condition) Dep

type Execution ¶

type Execution struct {
	ID        string
	StartedAt time.Time
	Duration  time.Duration
	Results   map[string]Result
	Errors    map[string]error
	Steps     map[string]StepReport
}

Execution is the result of one Workflow run.

func (e *Execution) Err() error

type Inputs ¶ added in v0.3.0

type Inputs map[string]any

Inputs holds dependency outputs keyed by step name. Plain-Job, failed, and skipped dependencies yield nil.

type Result ¶

type Result uint8

Result is a Step outcome.

const (
	ResultPending Result = iota // never appears in a finished Execution
	ResultSuccess
	ResultFailure // Job returned an error or panicked
	ResultSkipped // a dep didn't satisfy this step's Condition, or ctx was cancelled
)

func (r Result) String() string

type Step ¶

type Step struct {
	Name    string
	Job     cron.Job
	Fn      StepFunc // alternative to Job; receives dependency outputs
	Deps    []Dep
	Timeout time.Duration    // per-run cap; zero means none
	Retry   cron.RetryPolicy // per-run retry; zero means none
}

Step is one node in the DAG. Exactly one of Job or Fn must be set.

func NewStep(name string, job cron.Job, deps ...Dep) Step

func NewStepFunc(name string, fn StepFunc, deps ...Dep) Step

func (s Step) WithRetry(p cron.RetryPolicy) Step

func (s Step) WithTimeout(d time.Duration) Step

type StepFunc ¶ added in v0.3.0

type StepFunc func(ctx context.Context, in Inputs) (any, error)

StepFunc is a step body that consumes dependency outputs and produces its own, letting data flow through the DAG.

type StepReport ¶ added in v0.3.0

type StepReport struct {
	Result    Result
	Err       error
	Output    any       // StepFunc return value; nil for plain Jobs
	StartedAt time.Time // zero if the step never ran
	Duration  time.Duration
}

StepReport is one step's outcome with timing and output.

type Workflow ¶

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

Workflow is a DAG of Steps.

func MustNew(steps ...Step) *Workflow

func New(steps ...Step) (*Workflow, error)

func (w *Workflow) Run(ctx context.Context) error

func (w *Workflow) WithOnComplete(cb func(*Execution)) *Workflow