Documentation
¶
Index ¶
- Constants
- type Intermediate
- type Mock
- func (svc *Mock) MockSlow(handler func(ctx context.Context, flow *workflow.Flow) (done bool, err error)) *Mock
- func (svc *Mock) MockTaskA(...) *Mock
- func (svc *Mock) MockTimeBudget(handler func(ctx context.Context, flow *workflow.Flow) (done bool, err error)) *Mock
- func (svc *Mock) OnShutdown(ctx context.Context) (err error)
- func (svc *Mock) OnStartup(ctx context.Context) (err error)
- func (svc *Mock) Slow(ctx context.Context, flow *workflow.Flow) (done bool, err error)
- func (svc *Mock) TaskA(ctx context.Context, flow *workflow.Flow) (started bool, err error)
- func (svc *Mock) TimeBudget(ctx context.Context) (graph *workflow.Graph, err error)
- type Service
- func (svc *Service) Init(initializer func(svc *Service) (err error)) *Service
- func (svc *Service) OnShutdown(ctx context.Context) (err error)
- func (svc *Service) OnStartup(ctx context.Context) (err error)
- func (svc *Service) Slow(ctx context.Context, flow *workflow.Flow) (done bool, err error)
- func (svc *Service) TaskA(ctx context.Context, flow *workflow.Flow) (started bool, err error)
- func (svc *Service) TimeBudget(ctx context.Context) (graph *workflow.Graph, err error)
- type ToDo
Constants ¶
const ( Hostname = timebudgetflowapi.Hostname Version = 1 )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Intermediate ¶
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 (*Mock) MockSlow ¶
func (svc *Mock) MockSlow(handler func(ctx context.Context, flow *workflow.Flow) (done bool, err error)) *Mock
MockSlow sets up a mock handler for Slow.
func (*Mock) MockTaskA ¶
func (svc *Mock) MockTaskA(handler func(ctx context.Context, flow *workflow.Flow) (started bool, err error)) *Mock
MockTaskA sets up a mock handler for TaskA.
func (*Mock) MockTimeBudget ¶
func (svc *Mock) MockTimeBudget(handler func(ctx context.Context, flow *workflow.Flow) (done bool, err error)) *Mock
MockTimeBudget sets up a mock handler for the TimeBudget workflow. The handler receives typed inputs from the workflow's state and returns typed outputs. A nil handler clears the mock.
func (*Mock) OnShutdown ¶
OnShutdown is called when the microservice is shut down.
type Service ¶
type Service struct {
*Intermediate // IMPORTANT: Do not remove
}
Service implements timebudgetflow.verify, exercising per-task time budgets.
func (*Service) OnShutdown ¶
OnShutdown is called when the microservice is shut down.
func (*Service) Slow ¶
Slow sleeps for 500ms, well beyond the 50ms budget the Slow endpoint declares via sub.TimeBudget. The connector shortens the inbound context deadline to that budget; the task observes the cancellation and returns ctx.Err(), which the foreman surfaces as a step failure with status 408.
type ToDo ¶
type ToDo interface {
OnStartup(ctx context.Context) (err error)
OnShutdown(ctx context.Context) (err error)
TaskA(ctx context.Context, flow *workflow.Flow) (started bool, err error) // MARKER: TaskA
Slow(ctx context.Context, flow *workflow.Flow) (done bool, err error) // MARKER: Slow
TimeBudget(ctx context.Context) (graph *workflow.Graph, err error) // MARKER: TimeBudget
}
ToDo is implemented by the service or mock.
Source Files
Directories