Files
kandev/apps/backend/pkg/pluginsdk/host_test.go
T
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

162 lines
5.0 KiB
Go

package pluginsdk
import (
"context"
"errors"
"net"
"testing"
"github.com/stretchr/testify/require"
"google.golang.org/grpc"
"google.golang.org/grpc/credentials/insecure"
"google.golang.org/grpc/test/bufconn"
)
// recordingHost is a fake Go-native Host implementation used to drive the
// grpcHostServer adapter without a real state store.
type recordingHost struct {
getStateFn func(ctx context.Context, scope, scopeID, key string) (map[string]any, bool, error)
setState struct {
scope, scopeID, key string
value map[string]any
}
listStateEntries []StateEntry
revealSecretFn func(ctx context.Context, ref string) (string, error)
emitEvent struct {
name string
payload map[string]any
}
deleteStateCalled bool
}
func (h *recordingHost) GetState(ctx context.Context, scope, scopeID, key string) (map[string]any, bool, error) {
return h.getStateFn(ctx, scope, scopeID, key)
}
func (h *recordingHost) SetState(_ context.Context, scope, scopeID, key string, value map[string]any) error {
h.setState.scope, h.setState.scopeID, h.setState.key, h.setState.value = scope, scopeID, key, value
return nil
}
func (h *recordingHost) DeleteState(context.Context, string, string, string) error {
h.deleteStateCalled = true
return nil
}
func (h *recordingHost) ListState(context.Context, string, string) ([]StateEntry, error) {
return h.listStateEntries, nil
}
func (h *recordingHost) RevealSecret(ctx context.Context, ref string) (string, error) {
return h.revealSecretFn(ctx, ref)
}
func (h *recordingHost) EmitEvent(_ context.Context, name string, payload map[string]any) error {
h.emitEvent.name, h.emitEvent.payload = name, payload
return nil
}
// dialHostOverBufconn wires a grpcHostServer (wrapping impl) to a
// grpcHostClient over an in-memory bufconn listener, bypassing go-plugin's
// broker entirely. The broker handshake itself is covered by the real
// end-to-end test in serve_test.go.
func dialHostOverBufconn(t *testing.T, impl Host) Host {
t.Helper()
lis := bufconn.Listen(1024 * 1024)
srv := grpc.NewServer()
registerHostServer(srv, impl)
go func() { _ = srv.Serve(lis) }()
t.Cleanup(srv.Stop)
conn, err := grpc.NewClient("passthrough:///bufconn",
grpc.WithContextDialer(func(ctx context.Context, _ string) (net.Conn, error) {
return lis.DialContext(ctx)
}),
grpc.WithTransportCredentials(insecure.NewCredentials()),
)
require.NoError(t, err)
t.Cleanup(func() { _ = conn.Close() })
return newHostClient(conn)
}
func TestHost_GetState_FoundAndNotFound(t *testing.T) {
impl := &recordingHost{
getStateFn: func(_ context.Context, scope, scopeID, key string) (map[string]any, bool, error) {
if scope == "task" && scopeID == "t1" && key == "k1" {
return map[string]any{"v": float64(1)}, true, nil
}
return nil, false, nil
},
}
host := dialHostOverBufconn(t, impl)
value, found, err := host.GetState(context.Background(), "task", "t1", "k1")
require.NoError(t, err)
require.True(t, found)
require.Equal(t, map[string]any{"v": float64(1)}, value)
_, found, err = host.GetState(context.Background(), "task", "t1", "missing")
require.NoError(t, err)
require.False(t, found)
}
func TestHost_SetState(t *testing.T) {
impl := &recordingHost{}
host := dialHostOverBufconn(t, impl)
err := host.SetState(context.Background(), "workspace", "ws1", "cfg", map[string]any{"enabled": true})
require.NoError(t, err)
require.Equal(t, "workspace", impl.setState.scope)
require.Equal(t, "ws1", impl.setState.scopeID)
require.Equal(t, "cfg", impl.setState.key)
require.Equal(t, map[string]any{"enabled": true}, impl.setState.value)
}
func TestHost_DeleteState(t *testing.T) {
impl := &recordingHost{}
host := dialHostOverBufconn(t, impl)
require.NoError(t, host.DeleteState(context.Background(), "task", "t1", "k1"))
require.True(t, impl.deleteStateCalled)
}
func TestHost_ListState(t *testing.T) {
impl := &recordingHost{listStateEntries: []StateEntry{
{Key: "a", Value: map[string]any{"x": float64(1)}, UpdatedAt: "2026-07-15T00:00:00Z"},
{Key: "b", Value: nil, UpdatedAt: "2026-07-15T00:00:01Z"},
}}
host := dialHostOverBufconn(t, impl)
entries, err := host.ListState(context.Background(), "instance", "")
require.NoError(t, err)
require.Equal(t, impl.listStateEntries, entries)
}
func TestHost_RevealSecret(t *testing.T) {
impl := &recordingHost{revealSecretFn: func(_ context.Context, ref string) (string, error) {
if ref == "known" {
return "sh-secret", nil
}
return "", errors.New("not found")
}}
host := dialHostOverBufconn(t, impl)
value, err := host.RevealSecret(context.Background(), "known")
require.NoError(t, err)
require.Equal(t, "sh-secret", value)
_, err = host.RevealSecret(context.Background(), "unknown")
require.Error(t, err)
}
func TestHost_EmitEvent(t *testing.T) {
impl := &recordingHost{}
host := dialHostOverBufconn(t, impl)
require.NoError(t, host.EmitEvent(context.Background(), "custom.thing", map[string]any{"a": float64(1)}))
require.Equal(t, "custom.thing", impl.emitEvent.name)
require.Equal(t, map[string]any{"a": float64(1)}, impl.emitEvent.payload)
}