saga

type AddHistoryEvent struct {
	TraceUID string
	Origin   string
}

type BaseSaga struct {
	message.ObjectMeta
	// contains filtered or unexported fields
}

type Delivery struct {
	Payload message.Object
	Options []endpoint.DeliveryOption
}

type Executor func(execCtx SagaContext) error

type FilterOption func(opts *filterOptions)

type HistoryEvent struct {
	UID          string         `json:"uid"`
	CreatedAt    time.Time      `json:"created_at"`
	Payload      message.Object `json:"payload"`
	OriginSource string         `json:"origin"`
	SagaStatus   string         `json:"saga_status"` //saga status at the moment
	TraceUID     string         `json:"trace_uid"`   //uid of received message, could be empty
}

type Instance interface {
	UID() string
	Saga() Saga
	Status() Status

	Start(sagaCtx SagaContext) error
	Compensate(sagaCtx SagaContext) error
	Recover(sagaCtx SagaContext) error
	Complete()
	Fail(ev message.Object)

	HistoryEvents() []HistoryEvent
	AddHistoryEvent(ev message.Object, ahv *AddHistoryEvent)

	StartedAt() *time.Time
	UpdatedAt() *time.Time
	ParentID() string
}

type InstancesBatch struct {
	Total int
	Items []Instance
}

type SQLDriver string

type Saga interface {
	// include Object interface as any message type in MessageBus a saga should have metadata
	message.Object
	// Init function assigns a contract type to a handler
	Init()
	// Start will be triggered when StartSagaCommand received
	Start(sagaCtx SagaContext) error
	// Compensate will be triggered when CompensateSagaCommand received
	Compensate(sagaCtx SagaContext) error
	// Recover will be triggered when RecoverSagaCommand received
	Recover(sagaCtx SagaContext) error
	// EventHandlers returns a list of assigned executors per type in Init()
	EventHandlers() map[scheme.GroupKind]Executor
	// SetSchema allows to set schema instance during the saga runtime
	SetSchema(scheme scheme.KnownTypesRegistry)
}

type SagaContext interface {
	//execution.MessageExecutionCtx
	Message() *message.ReceivedMessage
	Context() context.Context
	// Valid Deprecated
	Valid() bool
	Dispatch(payload message.Object, options ...endpoint.DeliveryOption)
	Deliveries() []*Delivery
	Return(options ...endpoint.DeliveryOption) error
	Logger() log.Logger
	SagaInstance() Instance
}

type SagaUIDService interface {
	ExtractSagaUID(headers message.Headers) (string, error)
	AddSagaId(headers message.Headers, sagaUID string)
}

type Status interface {
	InProgress() bool
	Failed() bool
	FailedOnEvent() message.Object
	Recovering() bool
	Compensating() bool
	Completed() bool
	String() string
}

type Store interface {
	Create(ctx context.Context, saga Instance) error
	GetById(ctx context.Context, sagaId string) (Instance, error)
	GetByFilter(ctx context.Context, filters ...FilterOption) (*InstancesBatch, error)
	Update(ctx context.Context, saga Instance) error
	Delete(ctx context.Context, sagaId string) error
}