state

Documentation

Index

• Constants
• type AddRealtedTaskToEventReuqest
• type ElectTasksRequest
• type Event
• type EventMetadata
• type Options
• type ServiceState
• type State
  • func New(opt *Options) State
• type StateUpdateRequest
• type StateUpdateRequestMetadata
• type TaskState
• type UpdateStateMetadataRequest
• type UpdateTaskStateRequest

Constants

const (
	CmdStartEngine  = "engine:start"
	CmdFinishEngine = "engine:finish"
	CmdStartTask    = "task:start"
	CmdFinishTask   = "task:finish"
)

const (

	// EngineStateInProgress pipeline in execution progress
	EngineStateInProgress string = "in-progress"
	// EngineStateFinished pipeline is finished execution
	EngineStateFinished string = "finished"

	// EngineStatusSuccess marks the engine as finished successfully
	EngineStatusSuccess = "Success"

	// EngineStatusFailed marks the engine as finished with error
	EngineStatusFailed = "failed"

	// TaskStateElected task is in progress
	TaskStateElected string = "elected"

	// TaskStateInProgress task is in progress
	TaskStateInProgress string = EngineStateInProgress

	// TaskStateFinished task is finished
	TaskStateFinished string = EngineStateFinished

	// TaskStatusSuccess set on the task status in case task was finished successfully
	TaskStatusSuccess = "Success"

	// TaskStatusFailed set on the task status in case task was finished with error
	TaskStatusFailed = "failed"
)

const (
	EventEngineStarted  = "engine.started"
	EventEngineFinished = "engine.finished"
	EventTaskStarted    = "task.started"
	EventTaskFinished   = "task.finished"
	EventTaskElected    = "task.elected"
)

Types

type AddRealtedTaskToEventReuqest

type AddRealtedTaskToEventReuqest struct {
	EventID string
	Task    []string
}

type ElectTasksRequest

type ElectTasksRequest struct {
	Tasks []task.Task
}

type Event

type Event struct {
	Metadata     EventMetadata          `yaml:"metadata"`
	RelatedTasks []string               `yaml:"related-tasks"`
	Payload      map[string]interface{} `yaml:"payload"`
}

Event - means that something happen

type EventMetadata

type EventMetadata struct {
	Name      string
	ID        string
	CreatedAt time.Time
	Task      string
}

type Options

type Options struct {
	Name string
	// EventChan to write new event to the channel once a chance was applied
	EventChan chan *Event
	// CommandsChan to receive commands to create new change channel
	CommandsChan chan string
	// StateUpdateRequest to receive updated on the state in realtime
	StateUpdateRequest chan StateUpdateRequest
	Logger             logger.Logger
	WG                 *sync.WaitGroup
}

Options to pass to the state

type ServiceState

type ServiceState struct {
}

ServiceState is a representation of a state of one service

type State

type State interface {
	Copy() (State, error)
	Tasks() map[string]TaskState
	Events() []Event
	Services() []ServiceState
	StateBytes() ([]byte, error)
	EventBytes() ([]byte, error)
	StartProcess()
}

State holds all the data of the pipeline execution flow

func New

func New(opt *Options) State

New builds nnew State from options

type StateUpdateRequest

type StateUpdateRequest struct {
	Metadata                     StateUpdateRequestMetadata
	ElectTasksRequest            *ElectTasksRequest
	AddRealtedTaskToEventReuqest *AddRealtedTaskToEventReuqest
	UpdateTaskStateRequest       *UpdateTaskStateRequest
	UpdateStateMetadataRequest   *UpdateStateMetadataRequest
}

type StateUpdateRequestMetadata

type StateUpdateRequestMetadata struct {
	CreatedAt time.Time
}

type TaskState

type TaskState struct {
	State  string    `yaml:"state"`
	Status string    `yaml:"status"`
	Task   task.Task `yaml:"task"`
	Output string    `yaml:"output"`
	Error  error     `yaml:"error"`
	Logger string    `yaml:"logger"`
}

TaskState is a representation of a state of one task

type UpdateStateMetadataRequest

type UpdateStateMetadataRequest struct {
	State  string
	Status string
}

type UpdateTaskStateRequest

type UpdateTaskStateRequest struct {
	State TaskState
}