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>
149 lines
5.5 KiB
TypeScript
149 lines
5.5 KiB
TypeScript
import { ApiError, fetchJson, type ApiRequestOptions } from "../client";
|
|
import { getBackendConfig } from "@/lib/config";
|
|
import type { PluginRecord, PluginToolDTO, SyncResult } from "@/lib/types/plugins";
|
|
|
|
const BASE = "/api/plugins";
|
|
|
|
// listPlugins fetches every registered plugin (GET /api/plugins).
|
|
export async function listPlugins(options?: ApiRequestOptions) {
|
|
const res = await fetchJson<{ plugins?: PluginRecord[] }>(BASE, options);
|
|
return res.plugins ?? [];
|
|
}
|
|
|
|
// getPlugin fetches a single plugin record by id. Rejects with a 404
|
|
// ApiError when the id is unknown.
|
|
export async function getPlugin(id: string, options?: ApiRequestOptions) {
|
|
return fetchJson<PluginRecord>(`${BASE}/${encodeURIComponent(id)}`, options);
|
|
}
|
|
|
|
// InstallResult mirrors the backend's InstallResponse
|
|
// (internal/plugins/dto.go): the install endpoint always wraps the stored
|
|
// record under "plugin" (plus an optional "warning" when the package
|
|
// installed but its initial spawn/handshake failed — Plugin.Status is left
|
|
// as "error" in that case). Callers must surface `warning` — a plugin can
|
|
// install successfully yet still fail to come up.
|
|
export type InstallResult = {
|
|
plugin: PluginRecord;
|
|
warning?: string;
|
|
};
|
|
|
|
// installPluginFromUrl asks the backend to download, verify, and install a
|
|
// plugin package from a remote URL (POST /api/plugins/install, JSON body).
|
|
// Returns the stored plugin record plus an optional partial-install warning.
|
|
// Throws ApiError on 400 (invalid package/manifest — message names the
|
|
// problem, e.g. bad checksum or missing platform executable) or 409 (that
|
|
// version is already installed).
|
|
export async function installPluginFromUrl(
|
|
url: string,
|
|
options?: ApiRequestOptions,
|
|
): Promise<InstallResult> {
|
|
return fetchJson<InstallResult>(`${BASE}/install`, {
|
|
...options,
|
|
init: {
|
|
...(options?.init ?? {}),
|
|
method: "POST",
|
|
body: JSON.stringify({ url }),
|
|
},
|
|
});
|
|
}
|
|
|
|
// installPluginUpload uploads a plugin package (.tar.gz) directly as
|
|
// multipart/form-data under the "package" field (POST /api/plugins/install).
|
|
// Bypasses fetchJson, which always forces a JSON Content-Type header — that
|
|
// would stop the browser from setting the multipart boundary itself. Same
|
|
// return shape and error semantics as installPluginFromUrl.
|
|
export async function installPluginUpload(
|
|
file: File,
|
|
options?: ApiRequestOptions,
|
|
): Promise<InstallResult> {
|
|
const baseUrl = options?.baseUrl ?? getBackendConfig().apiBaseUrl;
|
|
const formData = new FormData();
|
|
formData.append("package", file);
|
|
|
|
// Spread caller init *first* so method/body always win, matching the
|
|
// convention in lib/api/domains/voice-api.ts.
|
|
const response = await fetch(`${baseUrl}${BASE}/install`, {
|
|
...options?.init,
|
|
method: "POST",
|
|
body: formData,
|
|
});
|
|
|
|
if (!response.ok) await throwInstallError(response);
|
|
return (await response.json()) as InstallResult;
|
|
}
|
|
|
|
async function throwInstallError(response: Response): Promise<never> {
|
|
let body: unknown = null;
|
|
let message = `Plugin install failed: ${response.status} ${response.statusText}`;
|
|
try {
|
|
body = await response.json();
|
|
} catch {
|
|
// body remains null
|
|
}
|
|
if (body && typeof body === "object" && "error" in body) {
|
|
const errVal = (body as { error?: unknown }).error;
|
|
if (typeof errVal === "string") message = errVal;
|
|
}
|
|
throw new ApiError(message, response.status, body);
|
|
}
|
|
|
|
// updatePluginConfig replaces a plugin's operator-editable config
|
|
// (PATCH /api/plugins/:id).
|
|
export async function updatePluginConfig(
|
|
id: string,
|
|
config: Record<string, unknown>,
|
|
options?: ApiRequestOptions,
|
|
) {
|
|
return fetchJson<{ updated: boolean }>(`${BASE}/${encodeURIComponent(id)}`, {
|
|
...options,
|
|
init: {
|
|
...(options?.init ?? {}),
|
|
method: "PATCH",
|
|
body: JSON.stringify({ config }),
|
|
},
|
|
});
|
|
}
|
|
|
|
// enablePlugin transitions a plugin to active (POST /api/plugins/:id/enable).
|
|
export async function enablePlugin(id: string, options?: ApiRequestOptions) {
|
|
return fetchJson<{ enabled: boolean }>(`${BASE}/${encodeURIComponent(id)}/enable`, {
|
|
...options,
|
|
init: { ...(options?.init ?? {}), method: "POST" },
|
|
});
|
|
}
|
|
|
|
// disablePlugin transitions a plugin to disabled (POST /api/plugins/:id/disable).
|
|
export async function disablePlugin(id: string, options?: ApiRequestOptions) {
|
|
return fetchJson<{ disabled: boolean }>(`${BASE}/${encodeURIComponent(id)}/disable`, {
|
|
...options,
|
|
init: { ...(options?.init ?? {}), method: "POST" },
|
|
});
|
|
}
|
|
|
|
// uninstallPlugin removes a plugin's registration (DELETE /api/plugins/:id).
|
|
export async function uninstallPlugin(id: string, options?: ApiRequestOptions) {
|
|
return fetchJson<{ deleted: boolean }>(`${BASE}/${encodeURIComponent(id)}`, {
|
|
...options,
|
|
init: { ...(options?.init ?? {}), method: "DELETE" },
|
|
});
|
|
}
|
|
|
|
// listPluginTools aggregates the declared tools of every active plugin
|
|
// (GET /api/plugins/tools).
|
|
export async function listPluginTools(options?: ApiRequestOptions) {
|
|
const res = await fetchJson<{ tools?: PluginToolDTO[] }>(`${BASE}/tools`, options);
|
|
return res.tools ?? [];
|
|
}
|
|
|
|
// syncPlugins reconciles the plugin registry with the plugins directory on
|
|
// disk (POST /api/plugins/sync): registers unrecorded directory sideloads
|
|
// as disabled, installs and deletes dropped *.tar.gz packages, and marks
|
|
// records with a missing install path as errored. Returns the SyncResult
|
|
// summarizing what changed this run.
|
|
export async function syncPlugins(options?: ApiRequestOptions): Promise<SyncResult> {
|
|
return fetchJson<SyncResult>(`${BASE}/sync`, {
|
|
...options,
|
|
init: { ...(options?.init ?? {}), method: "POST" },
|
|
});
|
|
}
|