aliasflow

package
v1.37.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 13, 2026 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Index

Constants

View Source
const (
	Hostname = aliasflowapi.Hostname
	Version  = 1
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Intermediate

type Intermediate struct {
	*connector.Connector
	ToDo
}

Intermediate extends and customizes the generic base connector.

func NewIntermediate

func NewIntermediate(impl ToDo) *Intermediate

NewIntermediate creates a new instance of the intermediate.

type Mock

type Mock struct {
	*Intermediate
	// contains filtered or unexported fields
}

Mock is a mockable version of the microservice, allowing functions, event sinks and web handlers to be mocked.

func NewMock

func NewMock() *Mock

NewMock creates a new mockable version of the microservice.

func (*Mock) Alias

func (svc *Mock) Alias(ctx context.Context) (graph *workflow.Graph, err error)

Alias returns the workflow graph, or a mocked graph if MockAlias was called.

func (*Mock) MockAlias

func (svc *Mock) MockAlias(handler func(ctx context.Context, flow *workflow.Flow, branch string) (path string, err error)) *Mock

MockAlias sets up a mock handler for the Alias workflow. The handler receives typed inputs from the workflow's state and returns typed outputs. A nil handler clears the mock.

func (*Mock) MockTaskA

func (svc *Mock) MockTaskA(handler func(ctx context.Context, flow *workflow.Flow, path string) (pathOut string, err error)) *Mock

MockTaskA sets up a mock handler for TaskA.

func (*Mock) MockTaskB

func (svc *Mock) MockTaskB(handler func(ctx context.Context, flow *workflow.Flow, path string) (pathOut string, err error)) *Mock

MockTaskB sets up a mock handler for TaskB.

func (*Mock) MockTaskC

func (svc *Mock) MockTaskC(handler func(ctx context.Context, flow *workflow.Flow, path string) (pathOut string, err error)) *Mock

MockTaskC sets up a mock handler for TaskC.

func (*Mock) MockTaskD

func (svc *Mock) MockTaskD(handler func(ctx context.Context, flow *workflow.Flow, path string) (pathOut string, err error)) *Mock

MockTaskD sets up a mock handler for TaskD.

func (*Mock) MockTaskS

func (svc *Mock) MockTaskS(handler func(ctx context.Context, flow *workflow.Flow, branch string) (branchOut string, err error)) *Mock

MockTaskS sets up a mock handler for TaskS.

func (*Mock) OnShutdown

func (svc *Mock) OnShutdown(ctx context.Context) (err error)

OnShutdown is called when the microservice is shut down.

func (*Mock) OnStartup

func (svc *Mock) OnStartup(ctx context.Context) (err error)

OnStartup is called when the microservice is started up.

func (*Mock) TaskA

func (svc *Mock) TaskA(ctx context.Context, flow *workflow.Flow, path string) (pathOut string, err error)

TaskA executes the mock handler.

func (*Mock) TaskB

func (svc *Mock) TaskB(ctx context.Context, flow *workflow.Flow, path string) (pathOut string, err error)

TaskB executes the mock handler.

func (*Mock) TaskC

func (svc *Mock) TaskC(ctx context.Context, flow *workflow.Flow, path string) (pathOut string, err error)

TaskC executes the mock handler.

func (*Mock) TaskD

func (svc *Mock) TaskD(ctx context.Context, flow *workflow.Flow, path string) (pathOut string, err error)

TaskD executes the mock handler.

func (*Mock) TaskS

func (svc *Mock) TaskS(ctx context.Context, flow *workflow.Flow, branch string) (branchOut string, err error)

TaskS executes the mock handler.

type Service

type Service struct {
	*Intermediate // IMPORTANT: Do not remove
}

Service implements aliasflow.verify, exercising a workflow graph in which the same task URL appears at two distinct positions under two distinct node names.

func NewService

func NewService() *Service

NewService creates a new instance of the microservice.

func (*Service) Alias

func (svc *Service) Alias(ctx context.Context) (graph *workflow.Graph, err error)

Alias defines the graph s -> a -> b -> c -> END with an alternate Goto-driven path s -> bPrime -> d -> END. The two nodes "b" and "bPrime" share the same task URL (TaskB.URL()) but are independently identified in the graph and in the step history.

func (*Service) Init

func (svc *Service) Init(initializer func(svc *Service) (err error)) *Service

Init enables a single-statement pattern for initializing the microservice.

func (*Service) OnShutdown

func (svc *Service) OnShutdown(ctx context.Context) (err error)

OnShutdown is called when the microservice is shut down.

func (*Service) OnStartup

func (svc *Service) OnStartup(ctx context.Context) (err error)

OnStartup is called when the microservice is started up.

func (*Service) TaskA

func (svc *Service) TaskA(ctx context.Context, flow *workflow.Flow, path string) (pathOut string, err error)

TaskA appends "A" to the path.

func (*Service) TaskB

func (svc *Service) TaskB(ctx context.Context, flow *workflow.Flow, path string) (pathOut string, err error)

TaskB appends "B" to the path. Reused at two graph positions under names "b" and "bPrime".

func (*Service) TaskC

func (svc *Service) TaskC(ctx context.Context, flow *workflow.Flow, path string) (pathOut string, err error)

TaskC appends "C" to the path.

func (*Service) TaskD

func (svc *Service) TaskD(ctx context.Context, flow *workflow.Flow, path string) (pathOut string, err error)

TaskD appends "D" to the path.

func (*Service) TaskS

func (svc *Service) TaskS(ctx context.Context, flow *workflow.Flow, branch string) (branchOut string, err error)

TaskS dispatches the flow. When branch=="alt" it calls flow.Goto("bPrime") to take the alternate path; otherwise the default normal transition s -> a fires.

type ToDo

type ToDo interface {
	OnStartup(ctx context.Context) (err error)
	OnShutdown(ctx context.Context) (err error)
	TaskS(ctx context.Context, flow *workflow.Flow, branch string) (branchOut string, err error) // MARKER: TaskS
	TaskA(ctx context.Context, flow *workflow.Flow, path string) (pathOut string, err error)     // MARKER: TaskA
	TaskB(ctx context.Context, flow *workflow.Flow, path string) (pathOut string, err error)     // MARKER: TaskB
	TaskC(ctx context.Context, flow *workflow.Flow, path string) (pathOut string, err error)     // MARKER: TaskC
	TaskD(ctx context.Context, flow *workflow.Flow, path string) (pathOut string, err error)     // MARKER: TaskD
	Alias(ctx context.Context) (graph *workflow.Graph, err error)                                // MARKER: Alias
}

ToDo is implemented by the service or mock. The intermediate delegates handling to this interface.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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