Files
kandev/docs/plans/plugins/task-09-api.md
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.0 KiB

id, title, status, wave, depends_on, plan
id title status wave depends_on plan
task-09 HTTP API + auth middleware + capability checks + backendapp wiring pending 2
task-05
task-06
task-07
task-08
docs/plans/plugins/plan.md

HTTP API + auth middleware + capability checks + backendapp wiring

Title

Expose /api/plugins/* (gin), the plugin-facing auth middleware + capability gating, state/secrets APIs, webhook/UI proxy routes, tool-listing, and wire the whole package into backendapp.

Inputs

  • Spec docs/specs/plugins/spec.md → "API surface" (all endpoints), "Permissions", "Security".
  • Routing precedent: internal/jira/handlers.go RegisterRoutes(router, dispatcher, svc, log) → router.Group("/api/..."). Wiring precedent: internal/backendapp/services.go initJiraService + provideServices, and internal/backendapp/helpers.go routeParams (add a pluginsSvc *plugins.Service field) + registerRoutes (call plugins.RegisterRoutes(...)), gated on p.features.Plugins (task-10 adds the flag).

Acceptance

  1. internal/plugins/handlers.go RegisterRoutes(router, svc, log):
    • Management (operator): POST /api/plugins/register, GET /api/plugins, GET /api/plugins/:id, PATCH /api/plugins/:id, DELETE /api/plugins/:id, POST /api/plugins/:id/enable, POST /api/plugins/:id/disable. Register returns cleartext creds once. List/Get never expose creds.
    • GET /api/plugins/tools → aggregate declared tools across active plugins (id, name, display_name, description, input_schema). (Listing only — not wired into agent sessions.)
    • GET /api/plugins/:id/ui/*path and POST → UIProxy (task-08). Public to the browser session (operator UI); no plugin api-key required.
    • POST /api/plugins/:id/webhooks/:key → WebhookProxy (task-08). External; validates plugin active + key declared.
  2. internal/plugins/middleware.go: PluginAuth(svc) gin middleware — parses Authorization: Bearer <api_key>, resolves plugin via svc.AuthenticatePlugin, sets plugin in context. RequireCapability(kind, resource) returns 403 {"error":"capability '<kind>:<resource>' not declared"} when the plugin's manifest lacks it. Apply to plugin-facing routes:
    • State API: GET/POST/DELETE /api/plugins/:id/state, GET .../state/list (requires capabilities.state), backed by task-03 store, always scoped to the authenticated plugin id (a plugin cannot touch another's id → 403 if mismatch).
    • Secrets API: GET /api/plugins/:id/secrets/:ref (requires capabilities.secrets) → resolve via secretadapter.
    • Office write-back used by plugins is OUT OF SCOPE here (api_read/api_write office endpoints deferred) — implement state + secrets only; leave a comment noting office data endpoints are follow-up.
  3. internal/backendapp wiring: initPluginsService(...) in services.go calling plugins.Provide(...); field on Services + routeParams; registerRoutes calls plugins.RegisterRoutes and starts health monitor + delivery via the returned service (respect addCleanup). Gate registration on features.Plugins.

Files

  • apps/backend/internal/plugins/handlers.go + handlers_test.go
  • apps/backend/internal/plugins/middleware.go + middleware_test.go
  • apps/backend/internal/plugins/dto.go (request/response DTOs)
  • edits: apps/backend/internal/backendapp/services.go, apps/backend/internal/backendapp/helpers.go

Verification

  • go test ./internal/plugins/... ./internal/backendapp/... from apps/backend
  • make -C apps/backend build and make -C apps/backend lint

Output contract

Report: full route table, middleware/capability behavior, wiring points touched in backendapp, and confirmation the feature gate is respected. This is the last backend task — ensure make -C apps/backend build test lint pass for the package.

Dependencies

task-05, task-06, task-07, task-08. (Feature flag field from task-10 — if task-10 hasn't landed, add the Plugins bool field to FeaturesConfig yourself and note it.)