executor

Documentation

Index

• Variables
• type ExecutionMonitor
• type Executor
  • func New(logger logrus.FieldLogger, provider onchain.Provider, ...) Executor
• type Result
  • func (r *Result) AddStepResult(id string, result StepResult)
• type StepResult

Variables

var (
	// ErrEmptyWorkflow is the error when the given workflow is nil or does not have any steps.
	ErrEmptyWorkflow = errors.New("workflow is empty")

	// ErrMultipleInputs is the error when a workflow has multiple steps without parent dependencies
	ErrMultipleInputs = errors.New("workflow must have only one entrypoint step")
)

Types

type ExecutionMonitor

type ExecutionMonitor interface {
	// HandleResults handles the given workflow execution result.
	HandleResults(ctx context.Context, result *Result)
}

ExecutionMonitor represents a behavior of the workflow execution monitor that handles results during the execution. Should be implemented per business requirements.

type Executor

type Executor interface {
	// Execute executes the given workflow and returns a results.
	Execute(ctx context.Context, wf *workflow.Workflow, store cache.Cache) error

	// Serve started serving the given workflow.
	// Returns cancellation function or error
	Serve(ctx context.Context, wf *workflow.Workflow) (func(), error)
}

Executor describes a behavior of the workflow executor interface.

func New

func New(
	logger logrus.FieldLogger,
	provider onchain.Provider,
	keystore keystore.KeyStore,
	broadcaster broadcaster.Broadcaster,
	monitor ExecutionMonitor,
) Executor

New is the constructor of defaultExecutor

type Result

type Result struct {
	WorkflowID    string
	Store         cache.Cache
	StepsLock     sync.Mutex
	Steps         map[string]StepResult
	ExecutionTime time.Duration
	Error         error
}

Result is the workflow execution result.

func (*Result) AddStepResult

func (r *Result) AddStepResult(id string, result StepResult)

AddStepResult adds the given step execution result to the list

type StepResult

type StepResult struct {
	ExecutionTime time.Duration
	Store         cache.Cache
	Error         error
}