flowprotocol

Documentation

Index

• type Context
• type LifecycleHooks
• type TaskStep
  • func (step TaskStep) GetStepLabel() string
• type TaskStepResult

Types

type Context

type Context interface {
	context.Context

	// extendable error delay
	GetErrorDelay() time.Duration

	TaskId() string
	FatalError(error)

	// wraps goroutine spawning so that recovery is handled and properly logged
	Go(func())

	Sleep(time.Duration)

	GetSteps() []TaskStep

	CurrentStepIndex() int
	CurrentStep() TaskStep

	ReturnBasicStepSuccess() TaskStepResult
	ReturnSmallErrorf(format string, args ...any) TaskStepResult
	ReturnFatalErrorf(format string, args ...any) TaskStepResult

	Fatalf(format string, args ...any) error
}

type LifecycleHooks

type LifecycleHooks interface {
	// BeforeStep is called before executing a step. The step parameter is guaranteed to be non-nil and can be modified.
	BeforeStep(step *TaskStep) error
	// AfterStep is called after executing a step. the result parameter is guaranteed to be non-nil and can be modified.
	AfterStep(step TaskStep, result *TaskStepResult) error
}

type TaskStep

type TaskStep struct {
	// optional, will be inferred from the runtime function name if not provided
	Label    string
	StepFunc func() TaskStepResult

	// optional, all previous steps that dont have a grouping will be grouped together until another step with a grouping is reached
	StepGrouping string
}

func (TaskStep) GetStepLabel

func (step TaskStep) GetStepLabel() string

type TaskStepResult

type TaskStepResult struct {
	// label of the next TaskStep to execute (or terminate to stop the task), nil goes to next step in the flow if success
	NextStepLabel string
	Err           error
}