Files
kandev/apps/backend/internal/plugins/pkgtar/pkgtartest/pkgtartest.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

100 lines
2.9 KiB
Go

// Package pkgtartest builds valid kandev plugin tar.gz packages for tests
// and fixtures. It is a small, dependency-free builder deliberately kept
// separate from production pkgtar code so other packages (fixture
// generators, e2e helpers) can import it without pulling in *_test.go
// files.
package pkgtartest
import (
"archive/tar"
"bytes"
"compress/gzip"
"crypto/sha256"
"encoding/hex"
"fmt"
"io"
"sort"
"strings"
)
// checksumsFileName mirrors pkgtar.checksumsFileName; duplicated here to
// avoid an import cycle (pkgtar's own tests import this package).
const checksumsFileName = "checksums.txt"
// WritePackage writes a valid kandev plugin tar.gz package to w. files maps
// archive-relative path (e.g. "manifest.yaml", "server/plugin-linux-amd64")
// to its contents. WritePackage computes a checksums.txt covering every
// entry in files and appends it as the final archive entry; callers must
// not include "checksums.txt" in files themselves.
//
// Entries under "server/" are written with mode 0755 (executable); every
// other entry is written with mode 0644. This only affects the mode stored
// in the tar header — pkgtar.Install always chmods declared runtime
// executables to 0755 regardless of the archived mode.
func WritePackage(w io.Writer, files map[string][]byte) error {
if _, exists := files[checksumsFileName]; exists {
return fmt.Errorf("pkgtartest: files must not include %q; it is generated", checksumsFileName)
}
gz := gzip.NewWriter(w)
tw := tar.NewWriter(gz)
names := sortedNames(files)
for _, name := range names {
if err := writeEntry(tw, name, files[name]); err != nil {
return err
}
}
checksums := buildChecksums(names, files)
if err := writeEntry(tw, checksumsFileName, checksums); err != nil {
return err
}
if err := tw.Close(); err != nil {
return fmt.Errorf("pkgtartest: closing tar writer: %w", err)
}
if err := gz.Close(); err != nil {
return fmt.Errorf("pkgtartest: closing gzip writer: %w", err)
}
return nil
}
func sortedNames(files map[string][]byte) []string {
names := make([]string, 0, len(files))
for name := range files {
names = append(names, name)
}
sort.Strings(names)
return names
}
func buildChecksums(names []string, files map[string][]byte) []byte {
var buf bytes.Buffer
for _, name := range names {
sum := sha256.Sum256(files[name])
fmt.Fprintf(&buf, "%s %s\n", hex.EncodeToString(sum[:]), name)
}
return buf.Bytes()
}
func writeEntry(tw *tar.Writer, name string, data []byte) error {
mode := int64(0o644)
if strings.HasPrefix(name, "server/") {
mode = 0o755
}
hdr := &tar.Header{
Name: name,
Typeflag: tar.TypeReg,
Mode: mode,
Size: int64(len(data)),
}
if err := tw.WriteHeader(hdr); err != nil {
return fmt.Errorf("pkgtartest: writing header for %s: %w", name, err)
}
if _, err := tw.Write(data); err != nil {
return fmt.Errorf("pkgtartest: writing data for %s: %w", name, err)
}
return nil
}