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>
135 lines
4.3 KiB
Go
135 lines
4.3 KiB
Go
package plugins
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"errors"
|
|
"fmt"
|
|
"time"
|
|
|
|
"google.golang.org/grpc/codes"
|
|
"google.golang.org/grpc/status"
|
|
|
|
"github.com/kandev/kandev/internal/events/bus"
|
|
"github.com/kandev/kandev/internal/plugins/manifest"
|
|
"github.com/kandev/kandev/internal/plugins/state"
|
|
"github.com/kandev/kandev/pkg/pluginsdk"
|
|
)
|
|
|
|
// pluginHost implements pluginsdk.Host (the kandev.plugin.v1 Host RPCs, §3
|
|
// of docs/plans/plugins/GRPC-CONTRACT.md) for exactly one plugin. Service
|
|
// hands runtime.Manager a fresh pluginHost per spawn/restart via
|
|
// hostForPlugin, bound to that plugin's id and its manifest-declared
|
|
// capabilities at spawn time. Every method is capability-gated: State
|
|
// methods (GetState/SetState/DeleteState/ListState) require
|
|
// capabilities.state, RevealSecret requires capabilities.secrets. EmitEvent
|
|
// is intentionally ungated — the frozen contract's capability-gating list
|
|
// (§5) only names state and secrets (api_read/api_write reserved for
|
|
// future); event emission has no boolean capability to gate on.
|
|
type pluginHost struct {
|
|
pluginID string
|
|
capabilities manifest.Capabilities
|
|
|
|
state *state.Store
|
|
secrets SecretRevealer
|
|
bus bus.EventBus
|
|
}
|
|
|
|
var _ pluginsdk.Host = (*pluginHost)(nil)
|
|
|
|
// permissionDenied builds the gRPC error RemotePlugin/Host RPCs return for
|
|
// an undeclared capability, matching the wire-level message from
|
|
// docs/specs/plugins/spec.md ("Permissions"): "capability '<name>' not
|
|
// declared".
|
|
func permissionDenied(capability string) error {
|
|
return status.Errorf(codes.PermissionDenied, "capability '%s' not declared", capability)
|
|
}
|
|
|
|
func (h *pluginHost) GetState(ctx context.Context, scope, scopeID, key string) (map[string]any, bool, error) {
|
|
if !h.capabilities.State {
|
|
return nil, false, permissionDenied("state")
|
|
}
|
|
raw, found, err := h.state.Get(ctx, h.pluginID, scope, scopeID, key)
|
|
if err != nil || !found {
|
|
return nil, found, err
|
|
}
|
|
value, err := unmarshalStateValue(raw)
|
|
if err != nil {
|
|
return nil, false, err
|
|
}
|
|
return value, true, nil
|
|
}
|
|
|
|
func (h *pluginHost) SetState(ctx context.Context, scope, scopeID, key string, value map[string]any) error {
|
|
if !h.capabilities.State {
|
|
return permissionDenied("state")
|
|
}
|
|
raw, err := json.Marshal(value)
|
|
if err != nil {
|
|
return fmt.Errorf("plugins: marshal state value: %w", err)
|
|
}
|
|
return h.state.Set(ctx, h.pluginID, scope, scopeID, key, raw)
|
|
}
|
|
|
|
func (h *pluginHost) DeleteState(ctx context.Context, scope, scopeID, key string) error {
|
|
if !h.capabilities.State {
|
|
return permissionDenied("state")
|
|
}
|
|
return h.state.Delete(ctx, h.pluginID, scope, scopeID, key)
|
|
}
|
|
|
|
func (h *pluginHost) ListState(ctx context.Context, scope, scopeID string) ([]pluginsdk.StateEntry, error) {
|
|
if !h.capabilities.State {
|
|
return nil, permissionDenied("state")
|
|
}
|
|
entries, err := h.state.List(ctx, h.pluginID, scope, scopeID)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
out := make([]pluginsdk.StateEntry, len(entries))
|
|
for i, e := range entries {
|
|
value, err := unmarshalStateValue(e.Value)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
out[i] = pluginsdk.StateEntry{
|
|
Key: e.Key,
|
|
Value: value,
|
|
UpdatedAt: e.UpdatedAt.UTC().Format(time.RFC3339),
|
|
}
|
|
}
|
|
return out, nil
|
|
}
|
|
|
|
func (h *pluginHost) RevealSecret(ctx context.Context, ref string) (string, error) {
|
|
if !h.capabilities.Secrets {
|
|
return "", permissionDenied("secrets")
|
|
}
|
|
if h.secrets == nil {
|
|
return "", errors.New("plugins: secret vault not configured")
|
|
}
|
|
return h.secrets.Reveal(ctx, ref)
|
|
}
|
|
|
|
// EmitEvent publishes a plugin-originated event onto the bus, subject
|
|
// "plugin.<id>.<name>" (per the task's build instructions). A no-op if no
|
|
// event bus was wired (e.g. early boot, or a test Service without one).
|
|
func (h *pluginHost) EmitEvent(ctx context.Context, name string, payload map[string]any) error {
|
|
if h.bus == nil {
|
|
return nil
|
|
}
|
|
subject := "plugin." + h.pluginID + "." + name
|
|
event := bus.NewEvent(subject, "plugin:"+h.pluginID, payload)
|
|
return h.bus.Publish(ctx, subject, event)
|
|
}
|
|
|
|
// unmarshalStateValue decodes a plugin_state row's JSON value into a
|
|
// Go-native map, matching pluginsdk's Struct<->map[string]any convention.
|
|
func unmarshalStateValue(raw json.RawMessage) (map[string]any, error) {
|
|
var value map[string]any
|
|
if err := json.Unmarshal(raw, &value); err != nil {
|
|
return nil, fmt.Errorf("plugins: unmarshal state value: %w", err)
|
|
}
|
|
return value, nil
|
|
}
|