saga

package

v0.0.0-...-e360745 Latest Latest Go to latest Published: Sep 26, 2022 License: Apache-2.0 Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/illyasch/saga-service

Links

Open Source Insights

Documentation ¶

Overview ¶

Package saga implements saga orchestration logic.

Index ¶

Constants
Variables
type Saga
- func New(workflow Workflow, storage Storer) Saga
- func (s Saga) ProcessMessage(ctx context.Context, inp any) error
- func (s Saga) Start(ctx context.Context, sagaID uuid.UUID) error
type Sender
type Service
type Storer
type Workflow
- func NewWorkflowWithSQS(services []Service, awsSQS *sqs.SQS) (Workflow, error)

Constants ¶

View Source

const (
	CommandStart    = "start"
	QueueName       = "responses"
	StatusStarted   = "started"
	StatusError     = "error"
	StatusWorkDone  = "done"
	StatusCompleted = "completed"
)

Variables ¶

View Source

var (
	ErrEndOfWorkflow   = fmt.Errorf("end of workflow")
	ErrServiceNotFound = fmt.Errorf("service not found")
)

View Source

var SampleWorkflow = []Service{
	{
		"service1", "commands1", nil,
	},
	{
		"service2", "commands2", nil,
	},
	{
		"service3", "commands3", nil,
	},
}

Functions ¶

This section is empty.

Types ¶

type Saga ¶

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

Saga contains the database for storing URLs.

func New ¶

func New(workflow Workflow, storage Storer) Saga

New constructs a new Saga.

func (Saga) ProcessMessage ¶

func (s Saga) ProcessMessage(ctx context.Context, inp any) error

ProcessMessage receives a message with a response from a service and decides which service has to be called next according to the saga workflow.

func (Saga) Start ¶

func (s Saga) Start(ctx context.Context, sagaID uuid.UUID) error

Start starts a new saga with a given ID. The method can be called by HTTP handler.

type Sender ¶

type Sender interface {
	Send(any) error
}

Sender interface abstracts sending a message to queue.

type Service ¶

type Service struct {
	Name   string
	Topic  string
	Sender Sender
}

Service type has data for a service which is orchestrated by a saga.

type Storer ¶

type Storer interface {
	InsertSaga(context.Context, uuid.UUID, string, string) error
	UpdateStatus(context.Context, uuid.UUID, string) error
	UpdateService(context.Context, uuid.UUID, string, string) error
}

Storer interface abstracts data access operations for persisting a saga.

type Workflow ¶

type Workflow struct {
	Services []Service
}

Workflow represents a saga workflow with a list of services in order of their sequential execution.

func NewWorkflowWithSQS ¶

func NewWorkflowWithSQS(services []Service, awsSQS *sqs.SQS) (Workflow, error)

NewWorkflowWithSQS initializes a new workflow with a SQS queues for each service.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL