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>
335 lines
11 KiB
TypeScript
335 lines
11 KiB
TypeScript
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
|
|
vi.mock("@/lib/config", () => ({
|
|
getBackendConfig: () => ({ apiBaseUrl: "http://api.test" }),
|
|
}));
|
|
|
|
import {
|
|
disablePlugin,
|
|
enablePlugin,
|
|
getPlugin,
|
|
installPluginFromUrl,
|
|
installPluginUpload,
|
|
listPlugins,
|
|
listPluginTools,
|
|
syncPlugins,
|
|
uninstallPlugin,
|
|
updatePluginConfig,
|
|
} from "./plugins-api";
|
|
import { ApiError } from "../client";
|
|
|
|
type FetchInput = Parameters<typeof fetch>[0];
|
|
type FetchInit = Parameters<typeof fetch>[1];
|
|
|
|
const fetchSpy = vi.fn<(...args: [FetchInput, FetchInit?]) => Promise<Response>>();
|
|
|
|
beforeEach(() => {
|
|
fetchSpy.mockReset();
|
|
vi.stubGlobal("fetch", fetchSpy);
|
|
});
|
|
|
|
afterEach(() => {
|
|
vi.unstubAllGlobals();
|
|
});
|
|
|
|
const PLUGIN_ID = "acme-tools";
|
|
const PLUGIN_URL = "http://api.test/api/plugins/acme-tools";
|
|
const PARTIAL_INSTALL_WARNING = "plugin installed but failed to start: handshake timed out";
|
|
|
|
function jsonResponse(body: unknown, status = 200) {
|
|
return new Response(JSON.stringify(body), {
|
|
status,
|
|
headers: { "Content-Type": "application/json" },
|
|
});
|
|
}
|
|
|
|
function plugin(overrides: Partial<Record<string, unknown>> = {}) {
|
|
return {
|
|
id: PLUGIN_ID,
|
|
api_version: 1,
|
|
version: "1.0.0",
|
|
display_name: "Acme Tools",
|
|
description: "desc",
|
|
author: "acme",
|
|
categories: ["productivity"],
|
|
capabilities: {},
|
|
status: "registered",
|
|
install_path: "/home/user/.kandev/plugins/acme-tools/1.0.0",
|
|
signed: true,
|
|
installed_at: "2026-01-01T00:00:00Z",
|
|
restart_count: 0,
|
|
...overrides,
|
|
};
|
|
}
|
|
|
|
describe("listPlugins", () => {
|
|
it("fetches GET /api/plugins and unwraps the plugins array", async () => {
|
|
fetchSpy.mockResolvedValueOnce(jsonResponse({ plugins: [plugin()] }));
|
|
|
|
const result = await listPlugins();
|
|
|
|
const [url, init] = fetchSpy.mock.calls.at(-1) ?? [];
|
|
expect(String(url)).toBe("http://api.test/api/plugins");
|
|
expect(init?.method ?? "GET").toBe("GET");
|
|
expect(result).toEqual([plugin()]);
|
|
});
|
|
|
|
it("returns an empty array when the backend omits plugins", async () => {
|
|
fetchSpy.mockResolvedValueOnce(jsonResponse({}));
|
|
|
|
const result = await listPlugins();
|
|
|
|
expect(result).toEqual([]);
|
|
});
|
|
});
|
|
|
|
describe("getPlugin", () => {
|
|
it("fetches GET /api/plugins/:id", async () => {
|
|
fetchSpy.mockResolvedValueOnce(jsonResponse(plugin()));
|
|
|
|
const result = await getPlugin(PLUGIN_ID);
|
|
|
|
const [url] = fetchSpy.mock.calls.at(-1) ?? [];
|
|
expect(String(url)).toBe(PLUGIN_URL);
|
|
expect(result).toEqual(plugin());
|
|
});
|
|
|
|
it("propagates a 404 as an ApiError", async () => {
|
|
fetchSpy.mockResolvedValueOnce(jsonResponse({ error: "plugin not found" }, 404));
|
|
|
|
await expect(getPlugin("missing")).rejects.toBeInstanceOf(ApiError);
|
|
});
|
|
});
|
|
|
|
describe("installPluginFromUrl", () => {
|
|
it("POSTs {url} as JSON to /api/plugins/install and unwraps the plugin record", async () => {
|
|
// Backend wraps the record as {"plugin": {...}} (internal/plugins/dto.go
|
|
// InstallResponse) — not the bare record.
|
|
fetchSpy.mockResolvedValueOnce(jsonResponse({ plugin: plugin({ status: "active" }) }, 201));
|
|
|
|
const result = await installPluginFromUrl("https://example.test/acme-tools-1.0.0.tar.gz");
|
|
|
|
const [url, init] = fetchSpy.mock.calls.at(-1) ?? [];
|
|
expect(String(url)).toBe("http://api.test/api/plugins/install");
|
|
expect(init?.method).toBe("POST");
|
|
expect(JSON.parse(String(init?.body))).toEqual({
|
|
url: "https://example.test/acme-tools-1.0.0.tar.gz",
|
|
});
|
|
expect((init?.headers as Record<string, string>)?.["Content-Type"]).toBe("application/json");
|
|
expect(result.plugin.id).toBe(PLUGIN_ID);
|
|
expect(result.plugin.status).toBe("active");
|
|
expect(result.warning).toBeUndefined();
|
|
});
|
|
|
|
it("surfaces a partial-install warning alongside the stored plugin record", async () => {
|
|
// Package installed but its initial spawn/handshake failed — backend
|
|
// leaves Plugin.Status as "error" and adds a "warning" alongside "plugin".
|
|
fetchSpy.mockResolvedValueOnce(
|
|
jsonResponse(
|
|
{
|
|
plugin: plugin({ status: "error" }),
|
|
warning: PARTIAL_INSTALL_WARNING,
|
|
},
|
|
201,
|
|
),
|
|
);
|
|
|
|
const result = await installPluginFromUrl("https://example.test/acme-tools-1.0.0.tar.gz");
|
|
|
|
expect(result.plugin.status).toBe("error");
|
|
expect(result.warning).toBe(PARTIAL_INSTALL_WARNING);
|
|
});
|
|
|
|
it("propagates a 400 invalid-package error as an ApiError", async () => {
|
|
fetchSpy.mockResolvedValueOnce(
|
|
jsonResponse({ error: "bad checksum for server/plugin-linux-amd64" }, 400),
|
|
);
|
|
|
|
await expect(installPluginFromUrl("https://example.test/bad.tar.gz")).rejects.toMatchObject({
|
|
status: 400,
|
|
message: "bad checksum for server/plugin-linux-amd64",
|
|
});
|
|
});
|
|
|
|
it("propagates a 409 duplicate-version error as an ApiError", async () => {
|
|
fetchSpy.mockResolvedValueOnce(jsonResponse({ error: "version 1.0.0 already installed" }, 409));
|
|
|
|
await expect(installPluginFromUrl("https://example.test/dup.tar.gz")).rejects.toMatchObject({
|
|
status: 409,
|
|
message: "version 1.0.0 already installed",
|
|
});
|
|
});
|
|
});
|
|
|
|
describe("installPluginUpload", () => {
|
|
it("POSTs the file as multipart/form-data under the 'package' field and unwraps the plugin record", async () => {
|
|
let captured: { method?: string; isFormData: boolean; hasPackageField: boolean } = {
|
|
isFormData: false,
|
|
hasPackageField: false,
|
|
};
|
|
fetchSpy.mockImplementationOnce(async (_url, init) => {
|
|
const body = init?.body;
|
|
captured = {
|
|
method: init?.method,
|
|
isFormData: body instanceof FormData,
|
|
hasPackageField: body instanceof FormData && body.get("package") !== null,
|
|
};
|
|
// Backend wraps the record as {"plugin": {...}} — not the bare record.
|
|
return jsonResponse({ plugin: plugin({ status: "active" }) }, 201);
|
|
});
|
|
const file = new File([new Uint8Array([1, 2, 3])], "acme-tools-1.0.0.tar.gz", {
|
|
type: "application/gzip",
|
|
});
|
|
|
|
const result = await installPluginUpload(file);
|
|
|
|
expect(captured.method).toBe("POST");
|
|
expect(captured.isFormData).toBe(true);
|
|
expect(captured.hasPackageField).toBe(true);
|
|
expect(result.plugin.id).toBe(PLUGIN_ID);
|
|
expect(result.plugin.status).toBe("active");
|
|
expect(result.warning).toBeUndefined();
|
|
});
|
|
|
|
it("surfaces a partial-install warning alongside the stored plugin record", async () => {
|
|
fetchSpy.mockImplementationOnce(async () =>
|
|
jsonResponse(
|
|
{
|
|
plugin: plugin({ status: "error" }),
|
|
warning: PARTIAL_INSTALL_WARNING,
|
|
},
|
|
201,
|
|
),
|
|
);
|
|
const file = new File([new Uint8Array([1, 2, 3])], "acme-tools-1.0.0.tar.gz", {
|
|
type: "application/gzip",
|
|
});
|
|
|
|
const result = await installPluginUpload(file);
|
|
|
|
expect(result.plugin.status).toBe("error");
|
|
expect(result.warning).toBe(PARTIAL_INSTALL_WARNING);
|
|
});
|
|
|
|
it("does not set a Content-Type header, so the browser sets the multipart boundary", async () => {
|
|
let headers: HeadersInit | undefined;
|
|
fetchSpy.mockImplementationOnce(async (_url, init) => {
|
|
headers = init?.headers;
|
|
return jsonResponse({ plugin: plugin() }, 201);
|
|
});
|
|
const file = new File([new Uint8Array([1])], "plugin.tar.gz");
|
|
|
|
await installPluginUpload(file);
|
|
|
|
expect(headers).toBeUndefined();
|
|
});
|
|
|
|
it("propagates a 400 unsupported-platform error as an ApiError", async () => {
|
|
fetchSpy.mockResolvedValueOnce(
|
|
jsonResponse({ error: "no executable for platform linux-arm64" }, 400),
|
|
);
|
|
const file = new File([new Uint8Array([1])], "plugin.tar.gz");
|
|
|
|
await expect(installPluginUpload(file)).rejects.toMatchObject({
|
|
status: 400,
|
|
message: "no executable for platform linux-arm64",
|
|
});
|
|
});
|
|
|
|
it("propagates a 409 duplicate-version error as an ApiError", async () => {
|
|
fetchSpy.mockResolvedValueOnce(jsonResponse({ error: "version 1.0.0 already installed" }, 409));
|
|
const file = new File([new Uint8Array([1])], "plugin.tar.gz");
|
|
|
|
await expect(installPluginUpload(file)).rejects.toMatchObject({ status: 409 });
|
|
});
|
|
});
|
|
|
|
describe("updatePluginConfig", () => {
|
|
it("PATCHes /api/plugins/:id with a config body", async () => {
|
|
fetchSpy.mockResolvedValueOnce(jsonResponse({ updated: true }));
|
|
|
|
const result = await updatePluginConfig(PLUGIN_ID, { apiKey: "x" });
|
|
|
|
const [url, init] = fetchSpy.mock.calls.at(-1) ?? [];
|
|
expect(String(url)).toBe(PLUGIN_URL);
|
|
expect(init?.method).toBe("PATCH");
|
|
expect(JSON.parse(String(init?.body))).toEqual({ config: { apiKey: "x" } });
|
|
expect(result).toEqual({ updated: true });
|
|
});
|
|
});
|
|
|
|
describe("enablePlugin / disablePlugin / uninstallPlugin", () => {
|
|
it("POSTs /api/plugins/:id/enable", async () => {
|
|
fetchSpy.mockResolvedValueOnce(jsonResponse({ enabled: true }));
|
|
|
|
await enablePlugin(PLUGIN_ID);
|
|
|
|
const [url, init] = fetchSpy.mock.calls.at(-1) ?? [];
|
|
expect(String(url)).toBe(`${PLUGIN_URL}/enable`);
|
|
expect(init?.method).toBe("POST");
|
|
});
|
|
|
|
it("POSTs /api/plugins/:id/disable", async () => {
|
|
fetchSpy.mockResolvedValueOnce(jsonResponse({ disabled: true }));
|
|
|
|
await disablePlugin(PLUGIN_ID);
|
|
|
|
const [url, init] = fetchSpy.mock.calls.at(-1) ?? [];
|
|
expect(String(url)).toBe(`${PLUGIN_URL}/disable`);
|
|
expect(init?.method).toBe("POST");
|
|
});
|
|
|
|
it("DELETEs /api/plugins/:id", async () => {
|
|
fetchSpy.mockResolvedValueOnce(jsonResponse({ deleted: true }));
|
|
|
|
await uninstallPlugin(PLUGIN_ID);
|
|
|
|
const [url, init] = fetchSpy.mock.calls.at(-1) ?? [];
|
|
expect(String(url)).toBe(PLUGIN_URL);
|
|
expect(init?.method).toBe("DELETE");
|
|
});
|
|
});
|
|
|
|
describe("listPluginTools", () => {
|
|
it("fetches GET /api/plugins/tools and unwraps the tools array", async () => {
|
|
const tool = {
|
|
plugin_id: PLUGIN_ID,
|
|
name: "search",
|
|
display_name: "Search",
|
|
description: "desc",
|
|
};
|
|
fetchSpy.mockResolvedValueOnce(jsonResponse({ tools: [tool] }));
|
|
|
|
const result = await listPluginTools();
|
|
|
|
const [url] = fetchSpy.mock.calls.at(-1) ?? [];
|
|
expect(String(url)).toBe("http://api.test/api/plugins/tools");
|
|
expect(result).toEqual([tool]);
|
|
});
|
|
});
|
|
|
|
describe("syncPlugins", () => {
|
|
it("POSTs /api/plugins/sync and returns the SyncResult", async () => {
|
|
const body = {
|
|
added: ["kandev-plugin-side"],
|
|
installed: [],
|
|
missing: ["kandev-plugin-gone"],
|
|
errors: [{ path: "/plugins/junk.tar.gz", reason: "invalid gzip stream" }],
|
|
};
|
|
fetchSpy.mockResolvedValueOnce(jsonResponse(body));
|
|
|
|
const result = await syncPlugins();
|
|
|
|
const [url, init] = fetchSpy.mock.calls.at(-1) ?? [];
|
|
expect(String(url)).toBe("http://api.test/api/plugins/sync");
|
|
expect(init?.method).toBe("POST");
|
|
expect(result).toEqual(body);
|
|
});
|
|
|
|
it("propagates a backend error as an ApiError", async () => {
|
|
fetchSpy.mockResolvedValueOnce(jsonResponse({ error: "sync failed" }, 500));
|
|
|
|
await expect(syncPlugins()).rejects.toMatchObject({ status: 500, message: "sync failed" });
|
|
});
|
|
});
|