pipelinesteps

Documentation

Overview

Package pipelinesteps provides a plugin that registers generic pipeline step types: validate, transform, conditional, set, log, delegate, jq, publish, http_call, request_parse, db_query, db_exec, json_response, validate_path_param, validate_pagination, validate_request_body. It also provides the PipelineWorkflowHandler for composable pipelines.

Index

• Constants
• type Plugin
  • func New() *Plugin
  • func (p *Plugin) Capabilities() []capability.Contract
  • func (p *Plugin) SetLogger(logger *slog.Logger)
  • func (p *Plugin) SetStepRegistry(registry interfaces.StepRegistryProvider)
  • func (p *Plugin) StepFactories() map[string]plugin.StepFactory
  • func (p *Plugin) WiringHooks() []plugin.WiringHook
  • func (p *Plugin) WorkflowHandlers() map[string]plugin.WorkflowHandlerFactory

Constants

const PipelineHandlerServiceName = "pipeline-workflow-handler"

PipelineHandlerServiceName is the service name under which the PipelineWorkflowHandler is registered in the app's service registry. External components can look it up to call SetEventRecorder after startup.

Types

type Plugin

type Plugin struct {
	plugin.BaseEnginePlugin
	// contains filtered or unexported fields
}

Plugin registers generic pipeline step factories and the pipeline workflow handler.

func New

func New() *Plugin

New creates a new pipeline-steps plugin.

func (*Plugin) Capabilities

func (p *Plugin) Capabilities() []capability.Contract

Capabilities returns the capability contracts defined by this plugin.

func (*Plugin) SetLogger

func (p *Plugin) SetLogger(logger *slog.Logger)

SetLogger is called by the engine (via optional-interface detection in LoadPlugin) to inject the application logger.

func (*Plugin) SetStepRegistry

func (p *Plugin) SetStepRegistry(registry interfaces.StepRegistryProvider)

SetStepRegistry is called by the engine (via optional-interface detection in LoadPlugin) to inject the step registry after all step factories have been registered.

func (*Plugin) StepFactories

func (p *Plugin) StepFactories() map[string]plugin.StepFactory

StepFactories returns the step factories provided by this plugin.

func (*Plugin) WiringHooks

func (p *Plugin) WiringHooks() []plugin.WiringHook

WiringHooks returns a hook that wires the injected step registry and logger into the PipelineWorkflowHandler and registers the handler as a named service so that other components (e.g. the server) can look it up without reaching into the plugin.

func (*Plugin) WorkflowHandlers

func (p *Plugin) WorkflowHandlers() map[string]plugin.WorkflowHandlerFactory

WorkflowHandlers returns the pipeline workflow handler factory.