Files

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

4.2 KiB

Raw Blame History

id, title, status, wave, depends_on, plan

title

status

wave

depends_on

plan

task-17

Backend HTTP API + proxies + bundle + boot payload + health + wiring

done

task-05

task-06

task-16

task-10

docs/plans/plugins/plan.md

Backend HTTP API + proxies + bundle + boot payload + health + wiring

Title

The full backend surface for native-UI plugins: management + plugin-facing API, auth/capability middleware, state + secrets, webhook proxy, JS bundle proxy, boot-payload active-plugin list, health monitor, and backendapp wiring.

Inputs

Spec docs/specs/plugins/spec.md (API surface, permissions, security).
PLUGIN-API.md: boot payload plugins: [{id,name,bundleUrl,styleUrls?}], bundleUrl=/api/plugins/{id}/bundle; bundle proxied to plugin's ui.bundle.
Reuse: task-05 Service (Provide, Registry(), Get, List, Enable/Disable, AuthenticatePlugin, RevealWebhookSecret, StateStore(), SetDeliverer, SetStatus/UpdateLastHealthCheck), task-06 delivery.Deliverer, task-16 manifest ui.bundle.
Routing precedent: internal/jira/handlers.go RegisterRoutes(router, dispatcher, svc, log). Reverse-proxy + header stripping precedent: internal/agentctl/server/api/ (read its AGENTS.md).
Wiring precedent: internal/backendapp/services.go initJiraService + provideServices; helpers.go routeParams + registerRoutes. Boot payload producer: internal/webapp/payload.go (BootPayload) — add active plugins.

Acceptance

internal/plugins/handlers.go RegisterRoutes(router, svc, deliverer, log):
- Management: POST /api/plugins/register, GET /api/plugins, GET/:id, PATCH/:id, DELETE/:id, POST/:id/enable, POST/:id/disable. Register returns cleartext creds once.
- GET /api/plugins/tools (aggregate declared tools; listing only).
- GET /api/plugins/:id/bundle + GET /api/plugins/:id/ui/* → reverse proxy to plugin base_url (bundle → ui.bundle path). Strip iframe-blocking headers on ui/*; bundle served with Content-Type: text/javascript. Only for active plugins.
- POST /api/plugins/:id/webhooks/:key → webhook reverse proxy (active + key declared).
internal/plugins/client.go: InvokeTool(ctx, record, tool, input, callCtx) (30s) + Health(ctx, record); internal/plugins/proxy.go: the reverse proxies.
internal/plugins/middleware.go: PluginAuth(svc) (Bearer api_key → plugin identity) + RequireCapability(kind, resource) (403 with capability name). Plugin-facing: state API (/api/plugins/:id/state*, needs state cap, always scoped to authed plugin id), secrets API (/api/plugins/:id/secrets/:ref, needs secrets cap → secretadapter). Office read/write endpoints deferred (comment).
internal/plugins/health.go: HealthMonitor 30s/5s, 3 fails → error + emit plugin.health.degraded bus event, recovery → active + deliverer.Flush(id), updates last_health_check.
Boot payload: internal/webapp/payload.go gains Plugins []ActivePluginPayload ({ID,Name,BundleURL,StyleURLs}) populated from active plugins that have ui.bundle. Gate on features.plugins. Add the mapping wherever office data is mapped into the payload; add a getter on the plugins Service like ActiveUIPlugins() []Record.
Wiring: initPluginsService in services.go calling plugins.Provide(...) with secretadapter.New(secretsStore) as the vault; construct delivery.Deliverer, svc.SetDeliverer(d), start HealthMonitor and deliverer via addCleanup; fields on Services + routeParams; registerRoutes calls plugins.RegisterRoutes(...) gated on p.features.Plugins.

Files

apps/backend/internal/plugins/handlers.go, middleware.go, client.go, proxy.go, health.go, dto.go (+ _test.go each)
edits: internal/backendapp/services.go, internal/backendapp/helpers.go, internal/webapp/payload.go

Verification

go test ./internal/plugins/... ./internal/backendapp/... ./internal/webapp/... (apps/backend)
make -C apps/backend build lint

Output contract

Full route table, proxy header behavior, boot-payload shape (so task-18/19 match), wiring points. Ensure make -C apps/backend build test lint pass. This closes the backend.

Dependencies

task-05 (done), task-06, task-16, task-10.

4.2 KiB Raw Blame History

Backend HTTP API + proxies + bundle + boot payload + health + wiring

Title

Inputs

Acceptance

Files

Verification

Output contract

Dependencies

4.2 KiB

Raw Blame History