Files
kandev/apps/backend/internal/plugins/provider.go
T
Kandev Agent c53f699714 feat: add plugin system with grpc runtime and native ui plugins
- go plugin backends ship as release tarballs (per-platform binaries, checksums) that
  kandev installs from url/upload or filesystem sideload+sync, then spawns and
  supervises via hashicorp/go-plugin (unix socket / loopback tcp+automtls)
- strict typed grpc contract (kandev.plugin.v1): DeliverEvent/InvokeTool/HandleWebhook
  plus a capability-gated host service (state, secrets, emit); author sdk in
  pkg/pluginsdk; packaging cli in cmd/plugin-pack
- native frontend bundles: window.registerKandevPlugin + registry/host loader with
  dynamic routes, nav items, slots and ws handlers; plugins settings page with
  install dialog, sync button and enable/disable/uninstall
- gated behind the plugins feature flag (prod off, dev/e2e on); covered by unit and
  integration tests plus playwright e2e against a real packaged fixture plugin

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-07-16 17:55:45 +01:00

74 lines
2.9 KiB
Go

package plugins
import (
"fmt"
"path/filepath"
"github.com/kandev/kandev/internal/common/config"
"github.com/kandev/kandev/internal/common/logger"
"github.com/kandev/kandev/internal/db"
"github.com/kandev/kandev/internal/events/bus"
"github.com/kandev/kandev/internal/plugins/runtime"
"github.com/kandev/kandev/internal/plugins/state"
"github.com/kandev/kandev/internal/plugins/store"
)
// pluginsSubdir is the directory name under the Kandev home dir plugins
// live under: records ("<id>.yml"/"<id>.config.yml"), extracted packages
// ("<id>/<version>/..."), and per-plugin writable data
// ("<id>/data", KANDEV_PLUGIN_DATA_DIR) all share this one root, per
// docs/plans/plugins/GRPC-CONTRACT.md §6.
const pluginsSubdir = "plugins"
// Provide builds the plugin Service, following the repo's provider pattern
// (see apps/backend/AGENTS.md "Provider Pattern" and internal/jira/provider.go):
//
// - An FS-backed installation store rooted at <cfg.ResolvedHomeDir()>/plugins.
// - The SQLite-backed plugin_state store (internal/plugins/state), built
// from dbPool and wired onto the Service (see StateStore()).
// - An in-memory Registry, loaded from the FS store so existing
// installations survive a backend restart.
// - A runtime.Manager rooted at the same plugins directory, wired with
// svc.handleStatusChange as its OnStatusChange callback so the
// supervision loop's health transitions drive Service's state machine.
//
// secrets is passed straight through to Service.RevealSecret — callers pass
// secretadapter.New(secretsStore) in production (see internal/backendapp
// initPluginsService for the equivalent pattern); tests can pass a fake.
//
// eventBus may be nil (tests, or during early boot before the bus is ready).
//
// Event delivery (internal/plugins/delivery) and spawning already-active
// plugins (Service.StartActivePlugins) are NOT started by Provide — see the
// "Extension points" doc comment on Service for how backendapp attaches
// them after calling Provide. cleanup stops the runtime manager (kills any
// spawned processes); callers should register it with addCleanup.
func Provide(cfg *config.Config, dbPool *db.Pool, secrets SecretRevealer, eventBus bus.EventBus, log *logger.Logger) (*Service, func() error, error) {
dir := filepath.Join(cfg.ResolvedHomeDir(), pluginsSubdir)
pluginStore := store.NewFSStore(dir)
stateStore, err := state.NewStore(dbPool)
if err != nil {
return nil, nil, fmt.Errorf("plugins: init state store: %w", err)
}
registry := NewRegistry()
if err := registry.Load(pluginStore); err != nil {
return nil, nil, fmt.Errorf("plugins: load registry: %w", err)
}
svc := NewService(pluginStore, registry, eventBus, log)
svc.SetState(stateStore)
svc.SetSecrets(secrets)
svc.SetPluginsDir(dir)
rt := runtime.NewManager(dir, svc.handleStatusChange, log)
svc.SetRuntime(rt)
cleanup := func() error {
rt.StopAll()
return nil
}
return svc, cleanup, nil
}