dreampiler/kandev
1
0
Fork 0
Code Issues 43 Pull Requests Actions 6 Packages Projects Releases Wiki Activity
Files
main
kandev/docs/plans/plugins/task-18-frontend-registry.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

3.2 KiB
Raw Permalink Blame History

id, title, status, wave, depends_on, plan
id title status wave depends_on plan
task-18 Frontend Plugin API — globals + registry + host/loader pending A
docs/plans/plugins/plan.md

Frontend Plugin API — globals + registry + host/loader

Title

Implement the native-JS-plugin runtime: the window.registerKandevPlugin global, the reactive PluginRegistry, the PluginHostApi, and the loader that imports plugin bundles from the boot payload.

Inputs

  • docs/plans/plugins/PLUGIN-API.md is the frozen contract — implement it exactly (types, method names, slot names, loading sequence, destroy/unregister).
  • Store access: createAppStore/useAppStoreApi in apps/web/components/state-provider.tsx (there is an existing window.__KANDEV_E2E_STORE__ global to mirror the pattern). The host needs the StoreApi<AppState> — expose it to plugins via host.store.
  • Boot payload: apps/web/src/boot-payload.ts BootPayload type — add plugins?: ActivePlugin[] ({id,name,bundleUrl,styleUrls?}).
  • React sharing: plugins use host.React (host instance). Provide host.jsx = React.createElement.
  • @kandev/ui (workspace pkg) — expose a curated subset on host.ui (Button, Card, Badge, and a couple layout primitives; import what exists).

Acceptance

  1. apps/web/lib/plugins/registry.ts: reactive singleton PluginRegistry implementing the contract (register* + get* selectors), tracking owner pluginId, with unregisterPlugin(id) bulk-revoke. Backed by a tiny store/emitter so React can subscribe (usePluginRegistry() hook returning a snapshot).
  2. apps/web/lib/plugins/host.ts: installPluginGlobal(hostFactory) defines window.registerKandevPlugin; loadPlugins(bootPlugins, hostApi) injects style links, dynamically import(/* @vite-ignore */ bundleUrl) each bundle, then calls the registered plugin's initialize(registry, host) inside try/catch (a failure is logged, never throws to boot). unloadPlugin(id) calls destroy?() + registry.unregisterPlugin(id).
  3. apps/web/lib/plugins/host-api.ts: builds PluginHostApi for a pluginId (React, jsx, store, api.fetch scoped to /api/plugins/{id}, ui subset, theme).
  4. apps/web/src/boot-payload.ts: ActivePlugin type + plugins field parsed.
  5. Unit tests (vitest): registry register/get/unregister + owner revoke; host loadPlugins with a fake bundle module that calls the global (mock import via injecting the module, or structure loadPlugins to accept an injectable importer so tests don't need real dynamic import); host-api fetch path scoping.

Files

  • apps/web/lib/plugins/registry.ts + registry.test.ts
  • apps/web/lib/plugins/host.ts + host.test.ts
  • apps/web/lib/plugins/host-api.ts + host-api.test.ts
  • apps/web/lib/plugins/types.ts (mirror PLUGIN-API.md TS types)
  • edit apps/web/src/boot-payload.ts

Verification

  • cd apps/web && pnpm run typecheck && pnpm test -- plugins && pnpm lint

Output contract

Report the exact exported API (so task-19/20/21 align), how dynamic import is made testable (injectable importer), and the boot-payload additions. Do NOT wire into routes/nav yet (task-19). Follow apps/web/AGENTS.md lint limits.

Dependencies

None (contract is fixed in PLUGIN-API.md).

Reference in New Issue View Git Blame Copy Permalink