Documentation
¶
Overview ¶
Package setup wires every workflow subpkg together. Server code instantiates one Manager via New and calls Start to boot the engine, router, and all registered workflows.
Index ¶
- func Bootstrap(ctx context.Context, svc service.Service, router *trigger.Router, ...) error
- func CleanupRuns(layout config.Layout, opts CleanupOptions) (removed int, err error)
- func ConnectorsCredsAdapter(svc *connectorsvc.Service) func(module, row, accountID string) (map[string]string, error)
- func HotReload(ctx context.Context, svc service.Service, router *trigger.Router, ...) error
- func NewCLIProviders() ([]provider.Provider, error)
- func PublishAndReload(ctx context.Context, svc service.Service, router *trigger.Router, ...) (workflow.Workflow, error)
- func RegisterLiveChannels(wfReg *channel.Registry, base *agentchannels.Registry)
- func RegisterLiveConnectors(reg *connector.Registry)
- func RegisterSlackIntegration(intReg *integration.Registry, base *agentchannels.Registry, ...)
- func ToggleAndReload(ctx context.Context, svc service.Service, router *trigger.Router, ...) error
- func UserResolverAdapter(svc userLookup) connector.UserResolverFn
- func WatchWorkflows(ctx context.Context, workflowsDir string, svc service.Service, ...)
- type CleanupOptions
- type Manager
- func (m *Manager) Start(ctx context.Context) error
- func (m *Manager) Stop()
- func (m *Manager) WithAgentRuntime(p *pool.Pool, sub nodes.AgentSubscribeFn) *Manager
- func (m *Manager) WithChannels(chs ...channel.Channel) *Manager
- func (m *Manager) WithDB(db *gorm.DB) *Manager
- func (m *Manager) WithDataTablesDB(db *gorm.DB) *Manager
- func (m *Manager) WithGuardConfig(cfg guard.Config) *Manager
- func (m *Manager) WithProvider(p provider.Provider) *Manager
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Bootstrap ¶
func Bootstrap(ctx context.Context, svc service.Service, router *trigger.Router, cron *trigger.CronScheduler, schedAt *trigger.ScheduleAtScheduler) error
Bootstrap wires every workflow folder found at startup into the router + cron scheduler. Called once from server startup after Service + Router are constructed.
func CleanupRuns ¶
func CleanupRuns(layout config.Layout, opts CleanupOptions) (removed int, err error)
CleanupRuns walks runs/ and removes old ones per policy.
func ConnectorsCredsAdapter ¶
func ConnectorsCredsAdapter(svc *connectorsvc.Service) func(module, row, accountID string) (map[string]string, error)
ConnectorsCredsAdapter wraps the connectors service to expose a connector.RowCredsFn for the workflow registry. Lookup is by (module key, row label) — first matching label wins; empty row falls back to the first instance for that Key.
When accountID is set, the selected instance's connected SSO account token is injected as `user_token`, overriding the row's config — the same override the MCP tools/call path applies. Access is enforced at the instance (tag) level by the palette; here we only assert the account actually belongs to the resolved row (data integrity), not who may use it.
func HotReload ¶
func HotReload(ctx context.Context, svc service.Service, router *trigger.Router, cron *trigger.CronScheduler, schedAt *trigger.ScheduleAtScheduler, id string) error
HotReload reloads + re-registers (or unregisters) one id. Used by fsnotify watcher in production.
func NewCLIProviders ¶
NewCLIProviders returns one workflow.Provider per healthy CLI runtime declared by the agent provider package. Caller registers each into the workflow Manager.
func PublishAndReload ¶ added in v0.15.1
func RegisterLiveChannels ¶
func RegisterLiveChannels(wfReg *channel.Registry, base *agentchannels.Registry)
RegisterLiveChannels rewires the workflow channel registry to use the live agentchannels.Registry as its backing source. Channels become workflow-visible automatically once they implement agentchannels.WorkflowTriggerProvider or WorkflowActionProvider — channels without either (UI, API, REST one-shot) stay invisible to the workflow editor.
Call after the base channel registry has its channels added (after channels/setup constructs them in server.go) and before wfMgr.Start(ctx).
func RegisterLiveConnectors ¶
RegisterLiveConnectors keeps the workflow connector registry in sync with the global connector registry — every module already registered is copied immediately, and every future connectors.Register call also flows through. The previous one-shot snapshot variant depended on boot ordering: any connector registered after this call (wfconn, wickmanager, notifications — all late-bound because they need runtime Deps) silently went missing from /api/workflows/palette and /workflows/api/registry. The observer hook removes that footgun.
Safe to call once per workflow registry instance; subscriptions are not removable, so calling twice for the same registry would double- fire on future Register events. Today the call sites in api/server.go (HTTP) and api/server_mcp.go (stdio) each touch their own registry.
func RegisterSlackIntegration ¶
func RegisterSlackIntegration(intReg *integration.Registry, base *agentchannels.Registry, router *trigger.Router, pickers *wfmcp.PickerRegistry)
RegisterSlackIntegration wires the Slack channel into the workflow integration surface. Two pieces, both required for end-to-end:
ActionDescriptor / EventDescriptor registration — slackwf.RegisterAll pushes every per-event + per-action descriptor (send_message, open_modal, on_message, on_block_action, …) into intReg so the palette + the engine see them.
Inbound event sink — wires slack.Channel.SetWorkflowEventSink so every Slack callback (message, block_action, view_submission, slash command, …) fires router.Dispatch with a normalised workflow.Event.
No-op if Slack isn't registered or the channel isn't the expected type — callers can call this unconditionally regardless of which channels are configured.
func ToggleAndReload ¶ added in v0.15.1
func UserResolverAdapter ¶ added in v0.18.3
func UserResolverAdapter(svc userLookup) connector.UserResolverFn
UserResolverAdapter wraps the login service into a connector.UserResolverFn so the workflow connector executor can run identity-gated ops as the workflow owner (Workflow.CreatedBy). Unknown ids resolve to a nil user (no error) so the run proceeds unauthenticated and the op's own gate decides whether to reject.
func WatchWorkflows ¶
func WatchWorkflows(ctx context.Context, workflowsDir string, svc service.Service, router *trigger.Router, cron *trigger.CronScheduler, schedAt *trigger.ScheduleAtScheduler)
WatchWorkflows polls workflow files under workflowsDir every 3 seconds and calls HotReload on any id whose mtime changed since the last poll. New files trigger a load; removed files trigger an unregister. Blocks until ctx is cancelled — run in a goroutine. Used by the file-based (non-DB) mode.
Types ¶
type CleanupOptions ¶
type CleanupOptions struct {
SuccessTTL time.Duration
FailedTTL time.Duration
KeepMax int
Now func() time.Time
}
CleanupOptions tunes the daily run-retention pass.
type Manager ¶
type Manager struct {
Layout config.Layout
Service service.Service
// Repo is the DB-backed workflow repository. Nil when no DB is
// wired (test paths) — every consumer that touches it must
// nil-check first. Populated by WithDB.
Repo *repository.Repo
StateStore *state.FileStore
Engine *engine.Engine
Router *trigger.Router
Cron *trigger.CronScheduler
ScheduleAt *trigger.ScheduleAtScheduler
Canvas *canvas.Canvas
Channels *channel.Registry
Integration *integration.Registry
Connectors *connector.Registry
Providers *provider.Registry
DataTables datatable.Service
Guard *guard.Guard
Cost *cost.Tracker
MCP *mcp.Ops
// AgentPool + AgentSubscribe route the `agent` + `session_init`
// node types through the shared agent pool. Nil = engine still
// runs (codex/gemini via cliProvider), but claude path skips the
// queue/sidebar/session-reuse benefits. See workflow/pool.md.
AgentPool *pool.Pool
AgentSubscribe nodes.AgentSubscribeFn
}
Manager bundles every wired piece so server.go can hand one struct to consumers (UI handlers, MCP transport, jobs).
func New ¶
New constructs every dependency wired to a single Layout. Channels, connectors, providers, and guard start empty — caller plugs them in via With* before Start.
func (*Manager) Start ¶
Start ensures layout, bootstraps router with current workflows, and kicks off the cron scheduler. Idempotent — safe to call from main.go on every boot.
func (*Manager) WithAgentRuntime ¶
WithAgentRuntime wires the shared agent pool + a subscribe adapter into the workflow engine so `agent` and `session_init` nodes route through the queue/session machinery. The subscribe function is the thin adapter around tools/agents.Broadcaster (kept out of this package to avoid an import cycle).
Calling re-registers the agent + session_init executors so the dependency takes effect immediately. Idempotent; nil arguments disable the pool path (engine reverts to the cliProvider one-shot).
func (*Manager) WithChannels ¶
WithChannels registers one or more channels.
func (*Manager) WithDB ¶ added in v0.14.20
WithDB switches the workflow Service from the file-based store to the DB-primary one. Workflow body + draft + version history + test cases now live in SQL; runtime concerns (state.json, env.json, runs/) keep their on-disk paths via the embedded FileService.
Idempotent — call once at boot with the shared *gorm.DB. Passing nil leaves the file-based Service in place (test path).
func (*Manager) WithDataTablesDB ¶ added in v0.13.1
WithDataTablesDB swaps the in-memory data table store for the Postgres-backed PgService. Re-registers the datatable_* executors so downstream Engine.Run calls hit the new backend. Idempotent; pass nil to revert to the in-memory store (test path).
func (*Manager) WithGuardConfig ¶
WithGuardConfig replaces the guard configuration.
Source Files