e145d48f22
* 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>
253 lines
6.7 KiB
Go
253 lines
6.7 KiB
Go
package runtime
|
|
|
|
import (
|
|
"errors"
|
|
"sync"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/kandev/kandev/internal/common/logger"
|
|
"github.com/kandev/kandev/pkg/pluginsdk"
|
|
)
|
|
|
|
// fakeSpawnedProcess is a controllable spawnedProcess for unit-testing
|
|
// process's supervision decisions without a real subprocess.
|
|
type fakeSpawnedProcess struct {
|
|
mu sync.Mutex
|
|
pingErr error
|
|
exited bool
|
|
killed bool
|
|
}
|
|
|
|
func (f *fakeSpawnedProcess) Ping() error {
|
|
f.mu.Lock()
|
|
defer f.mu.Unlock()
|
|
return f.pingErr
|
|
}
|
|
|
|
func (f *fakeSpawnedProcess) Exited() bool {
|
|
f.mu.Lock()
|
|
defer f.mu.Unlock()
|
|
return f.exited
|
|
}
|
|
|
|
func (f *fakeSpawnedProcess) Kill() {
|
|
f.mu.Lock()
|
|
defer f.mu.Unlock()
|
|
f.killed = true
|
|
}
|
|
|
|
func (f *fakeSpawnedProcess) Remote() *pluginsdk.RemotePlugin { return nil }
|
|
|
|
func (f *fakeSpawnedProcess) isKilled() bool {
|
|
f.mu.Lock()
|
|
defer f.mu.Unlock()
|
|
return f.killed
|
|
}
|
|
|
|
// statusRecorder records every (id, healthy) pair passed to
|
|
// onStatusChange, for assertion.
|
|
type statusRecorder struct {
|
|
mu sync.Mutex
|
|
calls []bool
|
|
}
|
|
|
|
func (r *statusRecorder) record(_ string, healthy bool) {
|
|
r.mu.Lock()
|
|
defer r.mu.Unlock()
|
|
r.calls = append(r.calls, healthy)
|
|
}
|
|
|
|
func (r *statusRecorder) snapshot() []bool {
|
|
r.mu.Lock()
|
|
defer r.mu.Unlock()
|
|
out := make([]bool, len(r.calls))
|
|
copy(out, r.calls)
|
|
return out
|
|
}
|
|
|
|
// noSleep is a sleepFn that never actually blocks: it returns true
|
|
// immediately unless stopCh is already closed, in which case it returns
|
|
// false. Used by every test in this file so supervision-decision logic
|
|
// runs with zero real waiting.
|
|
func noSleep(stopCh <-chan struct{}, _ time.Duration) bool {
|
|
select {
|
|
case <-stopCh:
|
|
return false
|
|
default:
|
|
return true
|
|
}
|
|
}
|
|
|
|
func testLogger(t *testing.T) *logger.Logger {
|
|
t.Helper()
|
|
log, err := logger.NewLogger(logger.LoggingConfig{Level: "error", Format: "console"})
|
|
if err != nil {
|
|
t.Fatalf("new logger: %v", err)
|
|
}
|
|
return log
|
|
}
|
|
|
|
func newTestProcess(t *testing.T, spawnFn func() (spawnedProcess, error), rec *statusRecorder) *process {
|
|
t.Helper()
|
|
p := newProcess("test-plugin", testLogger(t), spawnFn, rec.record)
|
|
p.sleepFn = noSleep
|
|
p.maxConsecutiveFails = 3
|
|
p.restartBackoff = []time.Duration{0, 0, 0, 0, 0}
|
|
p.maxRestartAttempts = 5
|
|
return p
|
|
}
|
|
|
|
func TestProcess_Tick_HealthyPingIsANoOp(t *testing.T) {
|
|
rec := &statusRecorder{}
|
|
fake := &fakeSpawnedProcess{}
|
|
p := newTestProcess(t, nil, rec)
|
|
p.current = fake
|
|
|
|
if gaveUp := p.tick(); gaveUp {
|
|
t.Fatal("tick() = gave up, want false for a healthy ping")
|
|
}
|
|
if fake.isKilled() {
|
|
t.Fatal("tick() killed the process on a healthy ping")
|
|
}
|
|
if len(rec.snapshot()) != 0 {
|
|
t.Fatalf("onStatusChange calls = %v, want none for a healthy ping", rec.snapshot())
|
|
}
|
|
}
|
|
|
|
func TestProcess_Tick_FailureBelowThresholdDoesNotRestart(t *testing.T) {
|
|
rec := &statusRecorder{}
|
|
fake := &fakeSpawnedProcess{pingErr: errors.New("boom")}
|
|
p := newTestProcess(t, nil, rec)
|
|
p.current = fake
|
|
p.maxConsecutiveFails = 3
|
|
|
|
p.tick()
|
|
if gaveUp := p.tick(); gaveUp {
|
|
t.Fatal("tick() = gave up, want false before reaching the failure threshold")
|
|
}
|
|
|
|
if fake.isKilled() {
|
|
t.Fatal("tick() killed the process before reaching the failure threshold")
|
|
}
|
|
if len(rec.snapshot()) != 0 {
|
|
t.Fatalf("onStatusChange calls = %v, want none below the failure threshold", rec.snapshot())
|
|
}
|
|
if p.failures != 2 {
|
|
t.Fatalf("p.failures = %d, want 2", p.failures)
|
|
}
|
|
}
|
|
|
|
func TestProcess_Tick_ThresholdReachedRestartsAndNotifiesUnhealthyThenHealthy(t *testing.T) {
|
|
rec := &statusRecorder{}
|
|
failing := &fakeSpawnedProcess{pingErr: errors.New("boom")}
|
|
healthy := &fakeSpawnedProcess{}
|
|
spawnCalls := 0
|
|
spawnFn := func() (spawnedProcess, error) {
|
|
spawnCalls++
|
|
return healthy, nil
|
|
}
|
|
|
|
p := newTestProcess(t, spawnFn, rec)
|
|
p.current = failing
|
|
p.maxConsecutiveFails = 1
|
|
|
|
if gaveUp := p.tick(); gaveUp {
|
|
t.Fatal("tick() = gave up, want false: the restart should have succeeded")
|
|
}
|
|
|
|
if !failing.isKilled() {
|
|
t.Fatal("tick() did not kill the failing process before restarting")
|
|
}
|
|
if spawnCalls != 1 {
|
|
t.Fatalf("spawnFn called %d times, want 1", spawnCalls)
|
|
}
|
|
if _, ok := p.remote(); !ok {
|
|
t.Fatal("remote() ok = false after a successful restart, want true")
|
|
}
|
|
if p.restartCount() != 1 {
|
|
t.Fatalf("p.restartCount() = %d, want 1", p.restartCount())
|
|
}
|
|
if want := []bool{false, true}; !equalBoolSlices(rec.snapshot(), want) {
|
|
t.Fatalf("onStatusChange calls = %v, want %v", rec.snapshot(), want)
|
|
}
|
|
}
|
|
|
|
func TestProcess_Tick_ExitedTriggersImmediateRestartRegardlessOfFailureCount(t *testing.T) {
|
|
rec := &statusRecorder{}
|
|
exited := &fakeSpawnedProcess{exited: true}
|
|
healthy := &fakeSpawnedProcess{}
|
|
spawnFn := func() (spawnedProcess, error) { return healthy, nil }
|
|
|
|
p := newTestProcess(t, spawnFn, rec)
|
|
p.current = exited
|
|
p.maxConsecutiveFails = 3 // would not be reached by ping failures alone
|
|
|
|
if gaveUp := p.tick(); gaveUp {
|
|
t.Fatal("tick() = gave up, want false: the restart should have succeeded")
|
|
}
|
|
if want := []bool{false, true}; !equalBoolSlices(rec.snapshot(), want) {
|
|
t.Fatalf("onStatusChange calls = %v, want %v (immediate restart on exit)", rec.snapshot(), want)
|
|
}
|
|
}
|
|
|
|
func TestProcess_HandleFailureAndRestart_GivesUpAfterMaxAttempts(t *testing.T) {
|
|
rec := &statusRecorder{}
|
|
spawnCalls := 0
|
|
spawnFn := func() (spawnedProcess, error) {
|
|
spawnCalls++
|
|
return nil, errors.New("spawn failed")
|
|
}
|
|
|
|
p := newTestProcess(t, spawnFn, rec)
|
|
p.current = &fakeSpawnedProcess{}
|
|
p.maxRestartAttempts = 3
|
|
p.restartBackoff = []time.Duration{0, 0, 0}
|
|
|
|
if gaveUp := p.handleFailureAndRestart(); !gaveUp {
|
|
t.Fatal("handleFailureAndRestart() = false, want true after exhausting every attempt")
|
|
}
|
|
if spawnCalls != 3 {
|
|
t.Fatalf("spawnFn called %d times, want 3 (maxRestartAttempts)", spawnCalls)
|
|
}
|
|
if want := []bool{false}; !equalBoolSlices(rec.snapshot(), want) {
|
|
t.Fatalf("onStatusChange calls = %v, want %v (only the initial degradation, no false recovery)", rec.snapshot(), want)
|
|
}
|
|
if _, ok := p.remote(); ok {
|
|
t.Fatal("remote() ok = true after giving up, want false")
|
|
}
|
|
}
|
|
|
|
func TestProcess_HandleFailureAndRestart_StopDuringBackoffSkipsSpawn(t *testing.T) {
|
|
rec := &statusRecorder{}
|
|
spawnCalls := 0
|
|
spawnFn := func() (spawnedProcess, error) {
|
|
spawnCalls++
|
|
return &fakeSpawnedProcess{}, nil
|
|
}
|
|
|
|
p := newTestProcess(t, spawnFn, rec)
|
|
p.current = &fakeSpawnedProcess{}
|
|
close(p.stopCh) // simulate Stop() racing the backoff wait
|
|
p.sleepFn = sleepOrStop
|
|
|
|
if gaveUp := p.handleFailureAndRestart(); gaveUp {
|
|
t.Fatal("handleFailureAndRestart() = true, want false: stopping is not the same as giving up")
|
|
}
|
|
if spawnCalls != 0 {
|
|
t.Fatalf("spawnFn called %d times, want 0: stop should short-circuit before any spawn attempt", spawnCalls)
|
|
}
|
|
}
|
|
|
|
func equalBoolSlices(a, b []bool) bool {
|
|
if len(a) != len(b) {
|
|
return false
|
|
}
|
|
for i := range a {
|
|
if a[i] != b[i] {
|
|
return false
|
|
}
|
|
}
|
|
return true
|
|
}
|