Files
kandev/apps/backend/internal/profiles/profiles.yaml
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

148 lines
6.3 KiB
YAML

# profiles.yaml — runtime defaults for prod / dev / e2e environments.
# ─────────────────────────────────────────────────────────────────────
# This file is the ONE place to look for "what does dev mode set?" /
# "what does e2e mode set?" / "what ships off in production?". The
# backend embeds it (//go:embed in apps/backend/internal/profiles) and
# at startup applies the matching profile's values to its own env
# *unless the variable is already set*. That last point matters: any
# launcher, per-spec override, or self-hoster's shell still wins.
# profiles.yaml only fills in the gaps.
#
# ── How profile selection works ────────────────────────────────────
#
# Detection at backend startup, in order:
# • KANDEV_E2E_MOCK=true → e2e (set by playwright fixtures)
# • KANDEV_DEBUG_DEV_MODE=true → dev (set by `make dev`)
# • (neither) → prod (the safe default)
#
# Each leaf below lists the value for each profile. A missing profile
# inherits the prod value, so a knob that never changes only needs to
# declare `prod`. An empty string ("") means "leave the env var unset"
# — handy for prod when the var simply shouldn't exist.
#
# ── How to flip a feature on for every user ────────────────────────
#
# Set its `prod` value to `true`. Ship the next release. Once the
# feature has been on by default for a release or two and is
# permanent, rip the flag out of the codebase entirely.
#
# ── See also ───────────────────────────────────────────────────────
#
# docs/decisions/0007-runtime-feature-flags.md pattern + rationale
# apps/backend/internal/profiles/profiles.go loader + parser
# ── Feature flags ─────────────────────────────────────────────────
# Gate in-progress code that ships disabled to production. New flags
# go here as `KANDEV_FEATURES_<NAME>` — the backend's config package
# maps them to `features.<name>` Viper keys automatically.
features:
# Office (autonomous agent surface). Off in prod until the feature
# is user-ready; on in dev/e2e so contributors and tests exercise it.
KANDEV_FEATURES_OFFICE:
prod: "false"
dev: "true"
e2e: "true"
# Plugins (extensible plugin system). Off in prod until the feature
# is user-ready; on in dev/e2e so contributors and tests exercise it.
KANDEV_FEATURES_PLUGINS:
prod: "false"
dev: "true"
e2e: "true"
# ── Mock providers ────────────────────────────────────────────────
# Swap real third-party services for in-memory fakes. Production
# leaves all of these unset (real APIs). Dev opts into the mock agent
# CLI alongside real CLIs; e2e isolates to mocks only.
mocks:
# Mock agent CLI registration.
# "" real CLIs only (prod)
# "true" mock alongside real CLIs (dev — try the UI without installing every agent)
# "only" mock is the SOLE agent (e2e isolation)
KANDEV_MOCK_AGENT:
prod: ""
dev: "true"
e2e: "only"
# Mount the /api/v1/_test/* test-harness routes. Hard-gated off in
# production — never enable on a public backend.
KANDEV_E2E_MOCK:
prod: ""
dev: ""
e2e: "true"
# Replace the GitHub / Jira / Linear clients with in-memory fakes
# so e2e specs don't hit live APIs (and dev doesn't need tokens).
KANDEV_MOCK_GITHUB:
prod: ""
dev: ""
e2e: "true"
KANDEV_MOCK_JIRA:
prod: ""
dev: ""
e2e: "true"
KANDEV_MOCK_LINEAR:
prod: ""
dev: ""
e2e: "true"
KANDEV_MOCK_SENTRY:
prod: ""
dev: ""
e2e: "true"
# ── Debug / observability ─────────────────────────────────────────
# Production keeps these off so /debug/* endpoints and pprof aren't
# exposed publicly. Dev turns everything on.
debug:
# Enables /debug/vars (expvar), /debug/pprof/*, and dev-only routes.
KANDEV_DEBUG_DEV_MODE:
prod: ""
dev: "true"
e2e: ""
# Legacy alias for KANDEV_DEBUG_DEV_MODE — kept for compatibility
# with older deploy scripts that grep for "pprof".
KANDEV_DEBUG_PPROF_ENABLED:
prod: ""
dev: "true"
e2e: ""
# Dump every ACP protocol frame (raw + normalized) to per-session JSONL
# files for offline debugging of stuck/odd sessions. Always-on in dev:
# the agentctl janitor caps file size (rotation), prunes by age + total
# count, and flushes/closes writers on shutdown, so it can't grow disk
# without bound. Files default to ~/.kandev/logs/acp/ (override with
# KANDEV_DEBUG_LOG_DIR). PRIVACY: frames carry full prompt/file/tool
# content — strictly local-dev; never enable in prod. When agentctl runs
# inside a Docker executor the files land *inside the container*, so this
# is meant for standalone/dev. Retention knobs (all optional):
# KANDEV_DEBUG_ACP_MAX_FILES (default 200)
# KANDEV_DEBUG_ACP_RETENTION_HOURS (default 48)
# KANDEV_DEBUG_ACP_MAX_FILE_BYTES (default 8388608 = 8 MiB)
KANDEV_DEBUG_AGENT_MESSAGES:
prod: ""
dev: "true"
e2e: ""
# ── E2E test tuning ───────────────────────────────────────────────
# Behaviour knobs that only matter when running playwright. These
# don't belong in dev (would mask real interactions) and never in
# prod (would leak test-only behaviour).
e2eTuning:
# Auto-approve every permission request in agentctl so e2e specs
# don't have to script the approval UI. Read by the agentctl child
# process; the backend forwards its env to children, so setting it
# here lands in the right place.
AGENTCTL_AUTO_APPROVE_PERMISSIONS:
prod: ""
dev: ""
e2e: "true"
# Short plan-coalesce window so coalesce-boundary specs don't have
# to wait for the production-default delay. Read by the planning
# service at startup.
KANDEV_PLAN_COALESCE_WINDOW_MS:
prod: ""
dev: ""
e2e: "2000"