Files
kandev/apps/backend/internal/plugins/state/store_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

334 lines
11 KiB
Go

package state
import (
"context"
"encoding/json"
"testing"
"time"
"github.com/jmoiron/sqlx"
_ "github.com/mattn/go-sqlite3"
"github.com/kandev/kandev/internal/db"
)
func TestStoreSetThenGetReturnsStoredValue(t *testing.T) {
store := newTestStore(t)
ctx := context.Background()
value := json.RawMessage(`{"synced":true}`)
if err := store.Set(ctx, "kandev-plugin-jira", "task", "task_xyz", "sync_status", value); err != nil {
t.Fatalf("set: %v", err)
}
got, found, err := store.Get(ctx, "kandev-plugin-jira", "task", "task_xyz", "sync_status")
if err != nil {
t.Fatalf("get: %v", err)
}
if !found {
t.Fatalf("expected found = true")
}
if string(got) != string(value) {
t.Fatalf("got %q, want %q", got, value)
}
}
func TestStoreGetMissingReturnsNotFound(t *testing.T) {
store := newTestStore(t)
ctx := context.Background()
got, found, err := store.Get(ctx, "kandev-plugin-jira", "task", "task_xyz", "missing_key")
if err != nil {
t.Fatalf("get: %v", err)
}
if found || got != nil {
t.Fatalf("got (%q, %v), want (nil, false)", got, found)
}
}
// TestStoreSetUpsertsOnRepeatedWrite pins the UNIQUE(plugin_id, scope,
// scope_id, state_key) upsert contract: a second Set for the same tuple must
// update the existing row in place, not create a duplicate.
func TestStoreSetUpsertsOnRepeatedWrite(t *testing.T) {
store := newTestStore(t)
ctx := context.Background()
if err := store.Set(ctx, "kandev-plugin-jira", "task", "task_xyz", "sync_status", json.RawMessage(`"PROJ-1"`)); err != nil {
t.Fatalf("first set: %v", err)
}
if err := store.Set(ctx, "kandev-plugin-jira", "task", "task_xyz", "sync_status", json.RawMessage(`"PROJ-2"`)); err != nil {
t.Fatalf("second set: %v", err)
}
got, found, err := store.Get(ctx, "kandev-plugin-jira", "task", "task_xyz", "sync_status")
if err != nil {
t.Fatalf("get: %v", err)
}
if !found {
t.Fatalf("expected found = true")
}
if string(got) != `"PROJ-2"` {
t.Fatalf("got %q, want %q (upsert should overwrite)", got, `"PROJ-2"`)
}
entries, err := store.List(ctx, "kandev-plugin-jira", "task", "task_xyz")
if err != nil {
t.Fatalf("list: %v", err)
}
if len(entries) != 1 {
t.Fatalf("expected exactly 1 entry after repeated Set, got %d: %+v", len(entries), entries)
}
}
// TestStoreInstanceScopeUpsertsWithEmptyScopeID pins scope_id NULL handling
// for instance-scoped state (scope_id == ""). SQLite's UNIQUE index treats
// each NULL as distinct, so a naive INSERT ... ON CONFLICT with a literal
// NULL scope_id would silently insert a duplicate row on the second Set
// instead of updating. The store must normalize "" consistently so repeated
// writes at instance scope still upsert.
func TestStoreInstanceScopeUpsertsWithEmptyScopeID(t *testing.T) {
store := newTestStore(t)
ctx := context.Background()
if err := store.Set(ctx, "kandev-plugin-jira", "instance", "", "install_id", json.RawMessage(`"abc"`)); err != nil {
t.Fatalf("first set: %v", err)
}
if err := store.Set(ctx, "kandev-plugin-jira", "instance", "", "install_id", json.RawMessage(`"def"`)); err != nil {
t.Fatalf("second set: %v", err)
}
got, found, err := store.Get(ctx, "kandev-plugin-jira", "instance", "", "install_id")
if err != nil {
t.Fatalf("get: %v", err)
}
if !found || string(got) != `"def"` {
t.Fatalf("got (%q, %v), want (\"def\", true)", got, found)
}
entries, err := store.List(ctx, "kandev-plugin-jira", "instance", "")
if err != nil {
t.Fatalf("list: %v", err)
}
if len(entries) != 1 {
t.Fatalf("expected exactly 1 instance-scoped entry, got %d: %+v", len(entries), entries)
}
}
func TestStoreDeleteRemovesEntry(t *testing.T) {
store := newTestStore(t)
ctx := context.Background()
if err := store.Set(ctx, "kandev-plugin-jira", "task", "task_xyz", "sync_status", json.RawMessage(`"PROJ-1"`)); err != nil {
t.Fatalf("set: %v", err)
}
if err := store.Delete(ctx, "kandev-plugin-jira", "task", "task_xyz", "sync_status"); err != nil {
t.Fatalf("delete: %v", err)
}
_, found, err := store.Get(ctx, "kandev-plugin-jira", "task", "task_xyz", "sync_status")
if err != nil {
t.Fatalf("get after delete: %v", err)
}
if found {
t.Fatalf("expected not found after delete")
}
}
// TestStoreDeleteAllRemovesEveryRowForPlugin pins the Uninstall cleanup
// contract (docs/specs/plugins/spec.md "plugin_state"): a plugin's entire
// state footprint — across every scope and scope_id — must be removable in
// one call, so a reinstalled or id-reused plugin never inherits stale state.
func TestStoreDeleteAllRemovesEveryRowForPlugin(t *testing.T) {
store := newTestStore(t)
ctx := context.Background()
if err := store.Set(ctx, "kandev-plugin-jira", "instance", "", "install_id", json.RawMessage(`"abc"`)); err != nil {
t.Fatalf("set instance-scoped: %v", err)
}
if err := store.Set(ctx, "kandev-plugin-jira", "task", "task_1", "sync_status", json.RawMessage(`"PROJ-1"`)); err != nil {
t.Fatalf("set task_1-scoped: %v", err)
}
if err := store.Set(ctx, "kandev-plugin-jira", "task", "task_2", "sync_status", json.RawMessage(`"PROJ-2"`)); err != nil {
t.Fatalf("set task_2-scoped: %v", err)
}
if err := store.DeleteAll(ctx, "kandev-plugin-jira"); err != nil {
t.Fatalf("DeleteAll: %v", err)
}
if entries, err := store.List(ctx, "kandev-plugin-jira", "instance", ""); err != nil || len(entries) != 0 {
t.Fatalf("instance-scoped entries after DeleteAll = %v (err=%v), want none", entries, err)
}
if entries, err := store.List(ctx, "kandev-plugin-jira", "task", "task_1"); err != nil || len(entries) != 0 {
t.Fatalf("task_1-scoped entries after DeleteAll = %v (err=%v), want none", entries, err)
}
if entries, err := store.List(ctx, "kandev-plugin-jira", "task", "task_2"); err != nil || len(entries) != 0 {
t.Fatalf("task_2-scoped entries after DeleteAll = %v (err=%v), want none", entries, err)
}
}
// TestStoreDeleteAllDoesNotTouchOtherPlugins pins the plugin-isolation
// invariant: DeleteAll for one plugin must never remove another plugin's
// state.
func TestStoreDeleteAllDoesNotTouchOtherPlugins(t *testing.T) {
store := newTestStore(t)
ctx := context.Background()
if err := store.Set(ctx, "kandev-plugin-jira", "task", "task_1", "sync_status", json.RawMessage(`"PROJ-1"`)); err != nil {
t.Fatalf("set jira: %v", err)
}
if err := store.Set(ctx, "kandev-plugin-slack", "task", "task_1", "channel", json.RawMessage(`"#dev"`)); err != nil {
t.Fatalf("set slack: %v", err)
}
if err := store.DeleteAll(ctx, "kandev-plugin-jira"); err != nil {
t.Fatalf("DeleteAll: %v", err)
}
entries, err := store.List(ctx, "kandev-plugin-slack", "task", "task_1")
if err != nil {
t.Fatalf("list slack: %v", err)
}
if len(entries) != 1 {
t.Fatalf("kandev-plugin-slack entries after deleting kandev-plugin-jira = %d, want 1 (untouched)", len(entries))
}
}
// TestStoreDeleteAllMissingPluginIsNotAnError pins that DeleteAll on a
// plugin with no stored state is a safe no-op.
func TestStoreDeleteAllMissingPluginIsNotAnError(t *testing.T) {
store := newTestStore(t)
ctx := context.Background()
if err := store.DeleteAll(ctx, "kandev-plugin-never-had-state"); err != nil {
t.Fatalf("DeleteAll on a plugin with no state: %v", err)
}
}
func TestStoreDeleteMissingIsNotAnError(t *testing.T) {
store := newTestStore(t)
ctx := context.Background()
if err := store.Delete(ctx, "kandev-plugin-jira", "task", "task_xyz", "never_set"); err != nil {
t.Fatalf("delete missing: %v", err)
}
}
func TestStoreListReturnsOnlyMatchingScope(t *testing.T) {
store := newTestStore(t)
ctx := context.Background()
if err := store.Set(ctx, "kandev-plugin-jira", "task", "task_1", "a", json.RawMessage(`1`)); err != nil {
t.Fatalf("set task_1/a: %v", err)
}
if err := store.Set(ctx, "kandev-plugin-jira", "task", "task_1", "b", json.RawMessage(`2`)); err != nil {
t.Fatalf("set task_1/b: %v", err)
}
if err := store.Set(ctx, "kandev-plugin-jira", "task", "task_2", "a", json.RawMessage(`3`)); err != nil {
t.Fatalf("set task_2/a: %v", err)
}
entries, err := store.List(ctx, "kandev-plugin-jira", "task", "task_1")
if err != nil {
t.Fatalf("list: %v", err)
}
if len(entries) != 2 {
t.Fatalf("expected 2 entries for task_1, got %d: %+v", len(entries), entries)
}
keys := map[string]bool{}
for _, e := range entries {
keys[e.Key] = true
if e.UpdatedAt.IsZero() {
t.Errorf("entry %q has zero UpdatedAt", e.Key)
}
}
if !keys["a"] || !keys["b"] {
t.Fatalf("expected keys a and b, got %+v", entries)
}
}
// TestStorePluginsCannotReadEachOthersState pins the spec invariant that
// plugin state is always filtered by plugin_id (docs/specs/plugins/spec.md
// "Plugins cannot read others' state").
func TestStorePluginsCannotReadEachOthersState(t *testing.T) {
store := newTestStore(t)
ctx := context.Background()
if err := store.Set(ctx, "kandev-plugin-jira", "task", "task_xyz", "sync_status", json.RawMessage(`"PROJ-1"`)); err != nil {
t.Fatalf("set: %v", err)
}
_, found, err := store.Get(ctx, "kandev-plugin-slack", "task", "task_xyz", "sync_status")
if err != nil {
t.Fatalf("get from other plugin: %v", err)
}
if found {
t.Fatalf("expected another plugin's state to be invisible")
}
entries, err := store.List(ctx, "kandev-plugin-slack", "task", "task_xyz")
if err != nil {
t.Fatalf("list from other plugin: %v", err)
}
if len(entries) != 0 {
t.Fatalf("expected no entries visible to a different plugin, got %+v", entries)
}
}
func TestStoreSetStampsUpdatedAtAsRFC3339UTC(t *testing.T) {
store := newTestStore(t)
ctx := context.Background()
before := time.Now().UTC()
if err := store.Set(ctx, "kandev-plugin-jira", "task", "task_xyz", "sync_status", json.RawMessage(`"PROJ-1"`)); err != nil {
t.Fatalf("set: %v", err)
}
after := time.Now().UTC()
entries, err := store.List(ctx, "kandev-plugin-jira", "task", "task_xyz")
if err != nil {
t.Fatalf("list: %v", err)
}
if len(entries) != 1 {
t.Fatalf("expected 1 entry, got %d", len(entries))
}
got := entries[0].UpdatedAt
if got.Location() != time.UTC {
t.Errorf("expected UpdatedAt location UTC, got %v", got.Location())
}
if got.Before(before.Add(-time.Second)) || got.After(after.Add(time.Second)) {
t.Errorf("UpdatedAt %v not within expected window [%v, %v]", got, before, after)
}
}
func TestStoreInitSchemaIsIdempotent(t *testing.T) {
conn := newSQLite(t)
if _, err := NewStore(db.NewPool(conn, conn)); err != nil {
t.Fatalf("first NewStore: %v", err)
}
if _, err := NewStore(db.NewPool(conn, conn)); err != nil {
t.Fatalf("second NewStore (re-init on existing schema): %v", err)
}
}
func newTestStore(t *testing.T) *Store {
t.Helper()
conn := newSQLite(t)
store, err := NewStore(db.NewPool(conn, conn))
if err != nil {
t.Fatalf("new store: %v", err)
}
return store
}
func newSQLite(t *testing.T) *sqlx.DB {
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() })
return conn
}