João Salavisa
e145d48f22
* 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>
61 lines
2.8 KiB
Markdown
61 lines
2.8 KiB
Markdown
---
|
|
id: task-06
|
|
title: Event delivery subscriber (HMAC, retries, ring buffer)
|
|
status: done
|
|
wave: A
|
|
depends_on: [task-05]
|
|
plan: docs/plans/plugins/plan.md
|
|
---
|
|
|
|
# Event delivery subscriber
|
|
|
|
## Title
|
|
Subscribe plugins to the event bus and deliver signed event webhooks with
|
|
at-least-once semantics, sequential per plugin, retries, and an error-state buffer.
|
|
|
|
## Inputs
|
|
- Spec `docs/specs/plugins/spec.md` → "Event webhook delivery" (headers,
|
|
envelope, HMAC-SHA256(webhook_secret, raw_body), at-least-once, 10s timeout,
|
|
3 retries backoff 5s/15s/45s, sequential per plugin, ring buffer 100 events /
|
|
5min TTL while plugin is in error).
|
|
- Bus API: `internal/events/bus.EventBus.Subscribe(subject, func(ctx, *bus.Event) error)`.
|
|
Model after `internal/gateway/websocket/task_notifications.go` `subscribe` helper.
|
|
Wildcard subjects supported (`task.*`).
|
|
- Event envelope JSON: `{event_id, event_type, occurred_at, workspace_id, payload}`.
|
|
`payload` = marshaled `event.Data`. `event_id` = generate (uuid). `occurred_at`
|
|
= now RFC3339. `workspace_id` from event data if present (`data["workspace_id"]`),
|
|
else omit.
|
|
|
|
## Acceptance
|
|
1. `internal/plugins/delivery/deliverer.go`: `Deliverer` subscribes each active
|
|
plugin to the union of its `capabilities.events` subjects on the bus. On event,
|
|
builds the envelope and signs `sha256=<hmac>` with the plugin's webhook secret.
|
|
The webhook secret is recoverable via `store.RevealWebhookSecret(ctx, id)`
|
|
(task-02 stores it in the encrypted secrets vault) — the Deliverer takes a
|
|
small `SecretRevealer` interface `{ RevealWebhookSecret(ctx, id) (string, error) }`
|
|
satisfied by the Service/store. This survives restarts (no in-memory-only cache).
|
|
2. Per-plugin worker goroutine + bounded queue → sequential delivery, no bus
|
|
blocking. HTTP POST to `base_url+endpoints.events`, 10s timeout, retries
|
|
5s/15s/45s on non-2xx/timeout.
|
|
3. When plugin status == error: buffer events in a ring buffer (cap 100, TTL 5min,
|
|
drop+log oldest on overflow). On recovery (task-07 flips to active) flush in order.
|
|
4. `Refresh()` re-subscribes when a plugin is registered/enabled/disabled.
|
|
|
|
## Files
|
|
- `apps/backend/internal/plugins/delivery/deliverer.go` + `deliverer_test.go`
|
|
- `apps/backend/internal/plugins/delivery/ringbuffer.go` + `ringbuffer_test.go`
|
|
- `apps/backend/internal/plugins/delivery/envelope.go` + `envelope_test.go`
|
|
|
|
## Verification
|
|
- `go test ./internal/plugins/delivery/...` from `apps/backend` (use httptest server
|
|
as the plugin; a fake bus or the real MemoryEventBus)
|
|
- `make -C apps/backend lint`
|
|
|
|
## Output contract
|
|
Report: how the webhook secret is held for signing, queue/worker model, buffer
|
|
behavior, and the Refresh trigger contract for task-05/09. Coordinate secret
|
|
handling with task-05 (may require a small addition there — note it in the report).
|
|
|
|
## Dependencies
|
|
task-05.
|