Files
kandev/docs/plans/plugins/task-10-feature-flag.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

60 lines
2.7 KiB
Markdown

---
id: task-10
title: plugins feature flag (backend + frontend plumbing)
status: done
wave: A
depends_on: []
plan: docs/plans/plugins/plan.md
---
# plugins feature flag
## Title
Add a `plugins` feature flag across profiles.yaml, backend config, the runtime
flag registry, and the frontend feature-flag types — default prod OFF, dev/e2e ON.
## Inputs
- Pattern reference (`office` flag): `docs/decisions/0007-runtime-feature-flags.md`.
Concrete touch points found in repo:
- `profiles.yaml` `features:` block (`KANDEV_FEATURES_OFFICE` with prod/dev/e2e).
- `apps/backend/internal/common/config/config.go:174` `FeaturesConfig` (add
`Plugins bool mapstructure:"plugins" json:"plugins"`) + defaults (~line 333).
- `apps/backend/internal/runtimeflags/config.go:31` (`"features.plugins": cfg.Features.Plugins`
map entry + the apply switch ~line 40).
- `apps/backend/internal/runtimeflags/registry.go` (add a registry entry mirroring
the `features.office` entry: Key `features.plugins`, Label, Description, Risk).
- Frontend: `apps/web/lib/state/slices/features/types.ts` (`FeatureFlags` add
`plugins: boolean`), `features-slice.ts` (default `plugins: false`),
`apps/web/app/actions/features.ts` / `lib/api/domains/features-api.ts` /
boot payload mapping if features are hydrated there (grep `office` to find every
site and add `plugins` alongside).
- Backend boot payload that ships features to the SPA (grep `Features.Office` in
`internal/webapp/`).
## Acceptance
1. `KANDEV_FEATURES_PLUGINS` in profiles.yaml: prod `"false"`, dev `"true"`, e2e `"true"`.
2. `FeaturesConfig.Plugins` parsed; default false.
3. Runtime flag registry entry present (togglable in Settings > System).
4. Frontend `FeatureFlags.plugins` typed + defaulted false + hydrated from backend
wherever `office` is.
5. Existing feature tests updated; add a slice test asserting default `plugins: false`.
## Files
- `profiles.yaml`
- `apps/backend/internal/common/config/config.go`
- `apps/backend/internal/runtimeflags/config.go`, `registry.go`
- `apps/backend/internal/webapp/payload.go` (+ wherever office feature is mapped)
- `apps/web/lib/state/slices/features/types.ts`, `features-slice.ts`, `features-slice.test.ts`
- `apps/web/app/actions/features.ts`, `apps/web/lib/api/domains/features-api.ts` (as grep reveals)
## Verification
- `go test ./internal/runtimeflags/... ./internal/common/config/... ./internal/webapp/...` (apps/backend)
- `cd apps/web && pnpm run typecheck && pnpm test -- features`
## Output contract
Report: every file touched, and confirm `office`-parallel sites all got a `plugins`
sibling (list them). Do not implement the settings page (task-12).
## Dependencies
None. (task-09 may add the `Plugins` config field first; if present, don't duplicate.)