fae2303db3
* feat(plugins): per-plugin settings pages driven by manifest config_schema Settings > Plugins rows now open /settings/plugins/:id — a detail page showing the manifest plus a settings form generated from the plugin author's config_schema. Secret fields (secret: true / format: password) are masked on the operator API and kept on masked re-submits; a running plugin restarts on save and reads its config (cleartext secrets included) through the new Host GetConfig gRPC RPC. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix(plugins): write plugin config file owner-only (0600) Operator config can now carry cleartext secret values (config_schema fields marked secret), so <id>.config.yml must not be world-readable — match the 0600 mode the record file already uses. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * feat(plugins): vault-backed plugin secrets — Get/Set/DeleteSecret RPCs and encrypted config secrets Plugins get vault-backed secret primitives on the Host API (GetSecret/SetSecret/DeleteSecret, capability-gated, namespaced to plugin:<id>㊙️<key> so a plugin can only touch its own entries; purged on uninstall). Secret config_schema fields now live in kandev's AES-256-GCM vault too — <id>.config.yml persists only a vault reference, and the Host GetConfig RPC resolves it back to cleartext for the plugin. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * chore(plugins): serve PR screenshots from the media/pr-1761-screenshots ref instead of the repo The PR body now points at raw URLs pinned to an unmerged media ref, so the binaries never land in main (PRs are squash-merged; only the branch tip tree merges). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix(plugins): address review feedback on settings validation and save flow - integer form fields reject non-integral input instead of parseInt-truncating - enum selections keep their schema-declared types (numeric enums round-trip) - backend enum validation normalizes int-vs-float64 before comparison - maskSecrets masks any non-zero secret value regardless of runtime type - save flow splits PATCH from refetch: a refetch failure no longer reports a successful save as an error, and typed secrets are masked on screen - optional enum fields gain a 'Not set' option so they can be cleared - resolveConfigSecrets copies before mutating; restart-failure SetStatus errors are logged; SDK test fake returns a non-nil empty config map - add missing tests: usePluginConfigForm hook, getPluginConfig client, integer/enum regression cases Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix(plugins): harden secret config invariants from review - reject non-string values on declared secret fields at validation time, closing the path where a numeric/boolean secret bypassed the vault and persisted cleartext in the config file - delete removed secret fields' vault entries only AFTER the config commit succeeds, so a failed SetConfig never leaves the still-current config referencing a deleted vault entry - uninstall fails closed: the plugin's vault namespace is purged before any destructive step, and a cleanup failure aborts the uninstall (retryable) instead of letting a reinstall inherit stale secrets Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix(plugins): failure-atomic config secrets, quiesced uninstall purge, ctx propagation - UpdateConfig is now failure-atomic for secret overwrites: storeConfigSecrets snapshots each vault entry before writing and returns a rollback that restores prior values (or deletes newly-created ones). A vault.Set failure mid-loop or a failed SetConfig commit rolls back, so a request reported as failed never changes the value a still-current config ref resolves to. - Uninstall stops the plugin process BEFORE purging its vault namespace, so the plugin can no longer race the cleanup with a SetSecret between ListIDs and the deletes; the purge stays fail-closed and retryable. - Thread the request context through Uninstall -> deletePluginSecrets instead of context.Background(), per the pass-context-through-chains convention. - Consolidate the 'secret not found:' prefix check into isSecretNotFound (host.go + service rollback share one definition). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix(plugins): detach rollback context, fail closed without a vault, reconcile uninstall status - vault rollback closures now run on context.WithoutCancel(ctx): a request cancelled mid-save (browser closed) can no longer abort the rollback and leave the vault holding new values while the unchanged config still points at them (Greptile P1). - storeConfigSecrets fails closed (errSecretVaultRequired) when a plugin declares secret config fields but no vault is wired, instead of silently persisting the secret in cleartext. - vaultRestoreFunc distinguishes not-found from a genuine Reveal error: a backend read failure aborts the update before writing rather than risk a rollback that deletes a real secret; rollback now returns errors, joined into UpdateConfig's failure so an inconsistent vault is surfaced, not just logged. - Uninstall reconciles lifecycle status when a secret-purge failure aborts after the process was stopped: a previously-running plugin transitions to error and notifies observers instead of being reported active with no process running. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix(plugins): detach removed-secret cleanup ctx and clear stale save dirty flag - cleanupRemovedConfigSecrets now runs on context.WithoutCancel(ctx), matching the rollback path, so a client disconnect right after the config commit can no longer cancel the delete and orphan now-unreferenced vault entries. - tests: assert GetConfig succeeds before treating an empty map as proof that nothing persisted (a swallowed read error would be a false pass). - web: on a post-save refetch failure, rebase initialValues onto the masked snapshot so the saved form no longer reads as dirty. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix(plugins): fail tests on discarded GetConfig errors, drop setState-in-updater - config_test: capture and fatal on GetConfig errors at the four remaining positive-assertion sites (a nil from a failed read would panic on the next map access instead of giving a clear failure), matching the earlier fix. - web hook: compute the masked post-save snapshot from the current values and apply it to setValues + setInitialValues directly, instead of calling setInitialValues inside a setValues functional updater (a React anti-pattern that runs twice under StrictMode). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix(plugins): skip validation of a secret field's own vault ref - validateConfigSchema takes the plugin id and skips a secret field whose value is that field's config vault ref (an internal storage marker, already validated when first set). Without this, a field declaring both secret: true and enum: [...] 400s on every save that keeps the mask, because the enum check saw the vault ref instead of a user value. Freshly entered secret values are still validated; a foreign plugin's ref is not skipped. Covered by unit + service-level regression tests. - surface mid-loop vault rollback failures in storeConfigSecrets via a warning instead of discarding them (double-fault observability). - web: integer inputs get step=1 so browsers flag non-integral input in place (serializeConfigValues remains the backstop). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * test(plugins): split config secret tests into config_secrets_test.go config_test.go had grown past the 800-line backend file-length limit (revive), failing CI lint. Move the vault-backed config and plugin-scoped secret tests (plus their fake-vault/store helpers) into a sibling file; no test logic changes. 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>
360 lines
12 KiB
TypeScript
360 lines
12 KiB
TypeScript
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
|
|
vi.mock("@/lib/config", () => ({
|
|
getBackendConfig: () => ({ apiBaseUrl: "http://api.test" }),
|
|
}));
|
|
|
|
import {
|
|
disablePlugin,
|
|
enablePlugin,
|
|
getPlugin,
|
|
getPluginConfig,
|
|
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" });
|
|
});
|
|
});
|
|
|
|
describe("getPluginConfig", () => {
|
|
it("fetches GET /api/plugins/:id/config and unwraps the config object", async () => {
|
|
fetchSpy.mockResolvedValueOnce(jsonResponse({ config: { default_channel: "#dev" } }));
|
|
|
|
const result = await getPluginConfig(PLUGIN_ID);
|
|
|
|
const [url] = fetchSpy.mock.calls.at(-1) ?? [];
|
|
expect(String(url)).toBe(`${PLUGIN_URL}/config`);
|
|
expect(result).toEqual({ default_channel: "#dev" });
|
|
});
|
|
|
|
it("returns an empty object when the backend omits config", async () => {
|
|
fetchSpy.mockResolvedValueOnce(jsonResponse({}));
|
|
expect(await getPluginConfig(PLUGIN_ID)).toEqual({});
|
|
});
|
|
|
|
it("URL-encodes the plugin id", async () => {
|
|
fetchSpy.mockResolvedValueOnce(jsonResponse({ config: {} }));
|
|
await getPluginConfig("my plugin");
|
|
const [url] = fetchSpy.mock.calls.at(-1) ?? [];
|
|
expect(String(url)).toContain("my%20plugin");
|
|
});
|
|
});
|