wfengine

type CreateHookFunc func(wfRuntime *WfRuntime) (WfHook, error)

type CreateMementoStorageFunc func(resource statemachine.StateResource) (WfRuntimeMementoStorage, error)

type CreateMetaLoaderFunc func(resourceType string) (WfMetaLoader, error)

type FlowMeta struct {
	FlowName             string      `yaml:"flowName,omitempty"`
	RecoverFromFirstStep bool        `yaml:"recoverFromFirstStep,omitempty"`
	Steps                []*StepMeta `yaml:"steps,omitempty"`
}

type FlowStatusType string

type Recover interface {
	GetResourceRecoverInfo(resource statemachine.StateResource, conf map[define.WFConfKey]string) (recover bool, preStatus statemachine.State)
	CancelResourceRecover(resource statemachine.StateResource, conf map[define.WFConfKey]string) error
	SaveResourceInterruptInfo(resource statemachine.StateResource, conf map[define.WFConfKey]string, reason, message, prevState string) error
}

type ResourceWorkflow struct {
	Logger           logr.Logger
	Resource         statemachine.StateResource
	WfManager        *WfManager
	MementoCareTaker *WfRuntimeMementoCareTaker
}

type StepAction interface {
	Init(map[string]interface{}, logr.Logger) error
	DoStep(context.Context, logr.Logger) error
	Output(logr.Logger) map[string]interface{}
}

type StepGroupMeta struct {
	GroupName string      `yaml:"groupName,omitempty"`
	Steps     []*StepMeta `yaml:"steps,omitempty"`
}

type StepMeta struct {
	ClassName string `yaml:"className,omitempty"`
	StepName  string `yaml:"stepName,omitempty"`
}

type StepRuntime struct {
	StepName             string                 `json:"StepName,omitempty"`
	StepStatus           StepStatusType         `json:"stepStatus,omitempty"`
	StepStartTime        string                 `json:"stepStartTime,omitempty"`
	LastStepCompleteTime string                 `json:"lastStepCompleteTime,omitempty"`
	ContextOutput        map[string]interface{} `json:"contextOutput,omitempty"` // 会传递给下一个step的context.
	RetryTimes           int                    `json:"retryTimes,omitempty"`
}

type StepStatusType string

type WfHook interface {
	// 流程初始化钩子
	OnWfInit() error

	// 流程结束时执行
	OnWfCompleted() error

	// 流程中断时执行
	OnWfInterrupt(*define.InterruptError) error

	// 流程步骤执行前运行
	OnStepInit(step *StepRuntime) error

	// 步骤等待状态时执行
	OnStepWaiting(step *StepRuntime) error

	// 流程步骤执行后运行
	OnStepCompleted(step *StepRuntime) error
}

type WfManager struct {
	ResourceType string
	FlowMetaMap  map[string]*FlowMeta
	TypeRegistry map[string]reflect.Type

	Logger logr.Logger
	// contains filtered or unexported fields
}

type WfMetaLoader interface {
	GetAllFlowMeta(workFlowMetaDir string) (map[string]*FlowMeta, map[string]*StepGroupMeta, error)
}

type WfRuntime struct {
	FlowStatus       FlowStatusType         `json:"flowStatus,omitempty"`
	RetryTimes       int                    `json:"retryTimes,omitempty"`
	FlowName         string                 `json:"flowName,omitempty"`
	IgnoreError      bool                   `json:"ignoreError,omitempty"` // 是否忽略报警.
	StartTime        string                 `json:"startTime,omitempty"`
	CompleteTime     string                 `json:"completeTime,omitempty"`
	ErrorMessage     string                 `json:"errorMessage,omitempty"`
	InitContext      map[string]interface{} `json:"initContext,omitempty"` // 初始化context. 会传给第一个步骤
	RunningSteps     []*StepRuntime         `json:"runningSteps,omitempty"`
	FlowHookIns      WfHook                 `json:"-"` // hook 函数用于在步骤完成/失败后调用，在k8s场景下，在这个方法会去执行落库的动作.
	ResourceWorkflow *ResourceWorkflow      `json:"-"`
	Logger           logr.Logger            `json:"-"`
}

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

type WfRuntimeMementoCareTaker struct {
	Name              string
	MementoMap        map[string]string
	MementoStorage    WfRuntimeMementoStorage
	Namespace         string
	FlowApplyResource string
}

type WfRuntimeMementoStorage interface {
	Save(mementoKey, mementoContent string) error
	LoadMementoMap(careTakerName string) (map[string]string, error)
}