Files
João Salavisa e145d48f22 feat: add plugin system with grpc runtime and native ui plugins (#1742)
* 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>

* fix(plugins): hydrate base app context on plugin routes

Plugin-owned SPA routes classify as RouteUnknown, so the boot payload shipped
only feature flags — no workspaces, workflows, or kanban context. Native plugin
UI (e.g. host.ui.TaskCreateDialog) then had an empty store. Hydrate the same
base context as the Home route for unknown SPA routes.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* feat(plugins): expose TaskCreateDialog on host.ui

Lets a native plugin open kandev's real create-task modal (prefilled via
initialValues) instead of POSTing directly.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* fix(plugins): harden filesystem/URL sinks against CodeQL findings

Add sink-level guards on the plugin trust boundary: securejoin containment on
archive extraction (zip-slip), plugin-id validation before every fs_store path,
http/https scheme validation on install-from-URL, and non-interpolated ws-handler
error logging.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* fix(plugins): address review findings (races, resource caps, lifecycle)

- serialize per-plugin startup to close a TOCTOU double-spawn race, and let a
  plugin restart after exhausting attempts
- bound plugin startup with an explicit 30s timeout
- reject backslash paths and cap decompressed bytes by actual size in pkgtar;
  only mark a package Signed when a verifier actually ran and passed
- delete plugin_state on uninstall; validate webhook keys against the manifest
  and cap webhook body size; restart an active plugin when a new version installs

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* fix(plugins): sanitize plugin-id path sinks for CodeQL

Pin the plugin id to a single path segment with filepath.Base at recordPath/
configPath and pkgtar.Remove — a barrier the taint analysis recognizes.
Behaviour-identical for valid ids (already validated by safePluginID); clears
the go/path-injection alerts.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* fix(plugins): inline plugin-id validation at path sinks for CodeQL

filepath.Base does not strip '..', so it is not a path-injection barrier. Call
the recognized safePluginID / id-pattern guard inline in Delete/GetConfig/
SetConfig and pkgtar.Remove — the same barrier that already cleared the Get sink.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* fix(plugins): address code-review findings (backend)

- add capability-gating tests for the Host RPC service (was untested)
- close a stop-during-start orphan race so Disable/Uninstall can't leave a
  supervised subprocess behind
- on failed upgrade, remove only the new version dir (not all versions + data);
  restart the prior version
- validate manifest version and reject ids ending in .config (record-file alias)
- make Deliverer.Refresh non-blocking and cancel in-flight delivery on worker stop
- clamp out-of-range webhook status, skip-and-warn corrupt records in List,
  write records atomically, semver-aware sideload version pick

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* fix(plugins): address code-review findings (frontend)

- wrap plugin routes + settings routes in a shared PluginErrorBoundary so a
  throwing plugin page shows a fallback instead of white-screening the SPA
- fix disable/re-enable in one session: keep the cached registration and
  re-run initialize instead of relying on a cached ES-module re-import
- prefix root-relative bundle/style URLs with apiBaseUrl (split-origin/Tauri)
- surface partial-install warnings via toast.warning instead of a bare success
- dedupe/remove injected style links on unload; gate PluginNavItems on the flag

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* fix(plugins): serialize per-plugin lifecycle + guard config writes

- add a per-plugin keyed lock in Service so concurrent Enable/Disable/Install/
  Uninstall/UpdateConfig for one id are serialized (no status-machine race)
- take s.mu in SetConfig/GetConfig and write config atomically
- bound each plugin initialize() with a timeout so one hung bundle can't stall
  the rest of the boot load

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* test(plugins): split service_test.go to satisfy file-length lint

Move the install/URL test group into service_install_test.go; no logic change.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* ci: build and ship the e2e fixture plugin package to E2E shards

The plugin E2E specs' global-setup requires apps/backend/.build/kandev-plugin-e2e-1.0.0.tar.gz.
Build it in the E2E build job, upload it as an artifact, and download it in both
the regular and container shard jobs.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

---------

Co-authored-by: Kandev Agent <agent@kandev.dev>
Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
2026-07-17 12:00:26 +01:00

208 lines
7.2 KiB
Go

package plugins
import (
"context"
"testing"
"time"
"github.com/jmoiron/sqlx"
_ "github.com/mattn/go-sqlite3"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
"github.com/kandev/kandev/internal/db"
"github.com/kandev/kandev/internal/events/bus"
"github.com/kandev/kandev/internal/plugins/manifest"
"github.com/kandev/kandev/internal/plugins/state"
)
// newHostTestStateStore returns an in-memory-sqlite-backed *state.Store, for
// pluginHost tests exercising the state capability gate.
func newHostTestStateStore(t *testing.T) *state.Store {
t.Helper()
conn, err := sqlx.Open("sqlite3", ":memory:")
if err != nil {
t.Fatalf("open sqlite: %v", err)
}
conn.SetMaxOpenConns(1)
t.Cleanup(func() { _ = conn.Close() })
st, err := state.NewStore(db.NewPool(conn, conn))
if err != nil {
t.Fatalf("new state store: %v", err)
}
return st
}
// assertPermissionDenied asserts err is a gRPC PermissionDenied status whose
// message matches the frozen contract's wire-level format:
// "capability '<name>' not declared".
func assertPermissionDenied(t *testing.T, err error, capability string) {
t.Helper()
if err == nil {
t.Fatal("err = nil, want PermissionDenied")
}
st, ok := status.FromError(err)
if !ok {
t.Fatalf("err = %v, want a gRPC status error", err)
}
if st.Code() != codes.PermissionDenied {
t.Fatalf("code = %v, want %v", st.Code(), codes.PermissionDenied)
}
want := "capability '" + capability + "' not declared"
if st.Message() != want {
t.Fatalf("message = %q, want %q", st.Message(), want)
}
}
func TestPluginHost_GetState_DeniedWithoutStateCapability(t *testing.T) {
h := &pluginHost{pluginID: "p1", state: newHostTestStateStore(t)}
_, _, err := h.GetState(context.Background(), "instance", "", "k")
assertPermissionDenied(t, err, "state")
}
func TestPluginHost_SetState_DeniedWithoutStateCapability(t *testing.T) {
h := &pluginHost{pluginID: "p1", state: newHostTestStateStore(t)}
err := h.SetState(context.Background(), "instance", "", "k", map[string]any{"x": 1.0})
assertPermissionDenied(t, err, "state")
}
func TestPluginHost_DeleteState_DeniedWithoutStateCapability(t *testing.T) {
h := &pluginHost{pluginID: "p1", state: newHostTestStateStore(t)}
err := h.DeleteState(context.Background(), "instance", "", "k")
assertPermissionDenied(t, err, "state")
}
func TestPluginHost_ListState_DeniedWithoutStateCapability(t *testing.T) {
h := &pluginHost{pluginID: "p1", state: newHostTestStateStore(t)}
_, err := h.ListState(context.Background(), "instance", "")
assertPermissionDenied(t, err, "state")
}
func TestPluginHost_RevealSecret_DeniedWithoutSecretsCapability(t *testing.T) {
secrets := newFakeSecretRevealer()
secrets.set("ref", "shh")
h := &pluginHost{pluginID: "p1", secrets: secrets}
_, err := h.RevealSecret(context.Background(), "ref")
assertPermissionDenied(t, err, "secrets")
}
// TestPluginHost_StateMethods_SucceedWithStateCapability proves the state
// RPCs actually work end to end (through the real state.Store) once the
// capability is declared, and that state is scoped to this host's own
// pluginID: a second pluginHost for a different id never sees it.
func TestPluginHost_StateMethods_SucceedWithStateCapability(t *testing.T) {
st := newHostTestStateStore(t)
h := &pluginHost{pluginID: "p1", capabilities: manifest.Capabilities{State: true}, state: st}
ctx := context.Background()
if err := h.SetState(ctx, "instance", "", "k", map[string]any{"x": 1.0}); err != nil {
t.Fatalf("SetState() unexpected error: %v", err)
}
value, found, err := h.GetState(ctx, "instance", "", "k")
if err != nil {
t.Fatalf("GetState() unexpected error: %v", err)
}
if !found {
t.Fatal("GetState() found = false, want true after SetState")
}
if value["x"] != 1.0 {
t.Fatalf("GetState() value = %v, want {x: 1}", value)
}
entries, err := h.ListState(ctx, "instance", "")
if err != nil {
t.Fatalf("ListState() unexpected error: %v", err)
}
if len(entries) != 1 || entries[0].Key != "k" {
t.Fatalf("ListState() = %v, want one entry for key %q", entries, "k")
}
if err := h.DeleteState(ctx, "instance", "", "k"); err != nil {
t.Fatalf("DeleteState() unexpected error: %v", err)
}
if _, found, err := h.GetState(ctx, "instance", "", "k"); err != nil || found {
t.Fatalf("GetState() after DeleteState found=%v err=%v, want found=false", found, err)
}
// A different plugin id must never see p1's state.
other := &pluginHost{pluginID: "p2", capabilities: manifest.Capabilities{State: true}, state: st}
if err := h.SetState(ctx, "instance", "", "shared-key", map[string]any{"v": true}); err != nil {
t.Fatalf("SetState() unexpected error: %v", err)
}
if _, found, err := other.GetState(ctx, "instance", "", "shared-key"); err != nil || found {
t.Fatalf("plugin p2 saw p1's state: found=%v err=%v, want found=false", found, err)
}
}
// TestPluginHost_RevealSecret_SucceedsWithSecretsCapability proves
// RevealSecret reaches the wired SecretRevealer once the capability is
// declared.
func TestPluginHost_RevealSecret_SucceedsWithSecretsCapability(t *testing.T) {
secrets := newFakeSecretRevealer()
secrets.set("ref", "cleartext")
h := &pluginHost{
pluginID: "p1",
capabilities: manifest.Capabilities{Secrets: true},
secrets: secrets,
}
got, err := h.RevealSecret(context.Background(), "ref")
if err != nil {
t.Fatalf("RevealSecret() unexpected error: %v", err)
}
if got != "cleartext" {
t.Fatalf("RevealSecret() = %q, want %q", got, "cleartext")
}
}
// TestPluginHost_RevealSecret_ErrorsWithoutVaultWired proves the "vault not
// configured" branch is reachable even when the capability is declared, for
// a Service constructed without SetSecrets (e.g. some tests).
func TestPluginHost_RevealSecret_ErrorsWithoutVaultWired(t *testing.T) {
h := &pluginHost{pluginID: "p1", capabilities: manifest.Capabilities{Secrets: true}}
_, err := h.RevealSecret(context.Background(), "ref")
if err == nil {
t.Fatal("RevealSecret() with no vault wired unexpectedly succeeded")
}
}
func TestPluginHost_EmitEvent_PublishesOnPluginNamespacedSubject(t *testing.T) {
log := testLogger(t)
memBus := bus.NewMemoryEventBus(log)
t.Cleanup(memBus.Close)
received := make(chan *bus.Event, 1)
sub, err := memBus.Subscribe("plugin.p1.widget.created", func(_ context.Context, e *bus.Event) error {
received <- e
return nil
})
if err != nil {
t.Fatalf("Subscribe() unexpected error: %v", err)
}
t.Cleanup(func() { _ = sub.Unsubscribe() })
h := &pluginHost{pluginID: "p1", bus: memBus}
if err := h.EmitEvent(context.Background(), "widget.created", map[string]any{"id": "w1"}); err != nil {
t.Fatalf("EmitEvent() unexpected error: %v", err)
}
select {
case e := <-received:
if e.Type != "plugin.p1.widget.created" {
t.Fatalf("event.Type = %q, want %q", e.Type, "plugin.p1.widget.created")
}
case <-time.After(2 * time.Second):
t.Fatal("timed out waiting for EmitEvent's publish to reach the subscriber")
}
}
// TestPluginHost_EmitEvent_NilBusIsANoOp pins the documented "no event bus
// wired" no-op contract (early boot, or a test Service without one).
func TestPluginHost_EmitEvent_NilBusIsANoOp(t *testing.T) {
h := &pluginHost{pluginID: "p1"}
if err := h.EmitEvent(context.Background(), "widget.created", nil); err != nil {
t.Fatalf("EmitEvent() with nil bus unexpected error: %v", err)
}
}