Files
kandev/apps/web/components/settings/plugins/use-plugin-config-form.test.ts
T
João Salavisa fae2303db3 feat(plugins): per-plugin settings pages driven by manifest config_schema (#1761)
* 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>
2026-07-17 22:13:58 +01:00

155 lines
5.8 KiB
TypeScript

// @vitest-environment happy-dom
import { act, renderHook, waitFor } from "@testing-library/react";
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
const getPluginConfig = vi.fn();
const updatePluginConfig = vi.fn();
vi.mock("@/lib/api/domains/plugins-api", () => ({
getPluginConfig: (...args: unknown[]) => getPluginConfig(...args),
updatePluginConfig: (...args: unknown[]) => updatePluginConfig(...args),
}));
const toastError = vi.fn();
const toastSuccess = vi.fn();
const toastWarning = vi.fn();
vi.mock("sonner", () => ({
toast: {
error: (...args: unknown[]) => toastError(...args),
success: (...args: unknown[]) => toastSuccess(...args),
warning: (...args: unknown[]) => toastWarning(...args),
},
}));
import { SECRET_MASK } from "@/lib/plugins/config-schema";
import { usePluginConfigForm } from "./use-plugin-config-form";
import type { PluginRecord } from "@/lib/types/plugins";
function testPlugin(): PluginRecord {
return {
id: "kandev-plugin-github",
api_version: 1,
version: "1.0.0",
display_name: "GitHub",
description: "",
author: "kandev",
categories: [],
capabilities: {},
status: "active",
install_path: "/tmp/x",
signed: true,
installed_at: "2026-01-01T00:00:00Z",
restart_count: 0,
config_schema: {
type: "object",
required: ["github_token"],
properties: {
github_token: { type: "string", secret: true },
org: { type: "string" },
},
},
};
}
beforeEach(() => {
vi.clearAllMocks();
getPluginConfig.mockResolvedValue({});
});
afterEach(() => {
vi.restoreAllMocks();
});
describe("usePluginConfigForm", () => {
it("loads the stored config into initial values", async () => {
getPluginConfig.mockResolvedValue({ github_token: SECRET_MASK, org: "kdlbs" });
const { result } = renderHook(() => usePluginConfigForm(testPlugin()));
await waitFor(() => expect(result.current.configLoading).toBe(false));
expect(getPluginConfig).toHaveBeenCalledWith("kandev-plugin-github", { cache: "no-store" });
expect(result.current.values.github_token).toBe(SECRET_MASK);
expect(result.current.values.org).toBe("kdlbs");
expect(result.current.isDirty).toBe(false);
});
it("does not fetch for a null plugin or an empty schema", () => {
renderHook(() => usePluginConfigForm(null));
renderHook(() => usePluginConfigForm({ ...testPlugin(), config_schema: undefined }));
expect(getPluginConfig).not.toHaveBeenCalled();
});
it("tracks dirtiness across change and save", async () => {
getPluginConfig.mockResolvedValue({});
updatePluginConfig.mockResolvedValue({ updated: true });
const { result } = renderHook(() => usePluginConfigForm(testPlugin()));
await waitFor(() => expect(result.current.configLoading).toBe(false));
act(() => result.current.handleChange("github_token", "ghp_x"));
expect(result.current.isDirty).toBe(true);
getPluginConfig.mockResolvedValue({ github_token: SECRET_MASK });
await act(() => result.current.handleSave());
expect(result.current.isDirty).toBe(false);
expect(result.current.saveStatus).toBe("success");
});
it("rejects a save with missing required fields without calling the API", async () => {
const { result } = renderHook(() => usePluginConfigForm(testPlugin()));
await waitFor(() => expect(result.current.configLoading).toBe(false));
await act(() => result.current.handleSave());
expect(updatePluginConfig).not.toHaveBeenCalled();
expect(toastError).toHaveBeenCalledWith(expect.stringContaining("Required"));
});
it("saves, refetches the masked config, and reports success", async () => {
updatePluginConfig.mockResolvedValue({ updated: true });
const { result } = renderHook(() => usePluginConfigForm(testPlugin()));
await waitFor(() => expect(result.current.configLoading).toBe(false));
act(() => result.current.handleChange("github_token", "ghp_cleartext"));
getPluginConfig.mockResolvedValue({ github_token: SECRET_MASK });
await act(() => result.current.handleSave());
expect(updatePluginConfig).toHaveBeenCalledWith("kandev-plugin-github", {
github_token: "ghp_cleartext",
});
expect(result.current.values.github_token).toBe(SECRET_MASK);
expect(result.current.saveStatus).toBe("success");
expect(toastSuccess).toHaveBeenCalled();
});
it("reports a PATCH failure as an error and keeps saveStatus=error", async () => {
updatePluginConfig.mockRejectedValue(new Error("boom"));
const { result } = renderHook(() => usePluginConfigForm(testPlugin()));
await waitFor(() => expect(result.current.configLoading).toBe(false));
act(() => result.current.handleChange("github_token", "ghp_x"));
await act(() => result.current.handleSave());
expect(result.current.saveStatus).toBe("error");
expect(toastError).toHaveBeenCalledWith("boom");
});
it("treats a refetch failure after a successful PATCH as saved — and masks typed secrets", async () => {
updatePluginConfig.mockResolvedValue({ updated: true });
const { result } = renderHook(() => usePluginConfigForm(testPlugin()));
await waitFor(() => expect(result.current.configLoading).toBe(false));
act(() => result.current.handleChange("github_token", "ghp_cleartext"));
getPluginConfig.mockRejectedValue(new Error("plugin restarting"));
await act(() => result.current.handleSave());
// The save succeeded: never report it as a failure...
expect(result.current.saveStatus).toBe("success");
expect(toastWarning).toHaveBeenCalled();
expect(toastError).not.toHaveBeenCalled();
// ...and the cleartext secret must not linger in the form.
expect(result.current.values.github_token).toBe(SECRET_MASK);
// ...and the masked form is the new baseline, so it does not read dirty.
expect(result.current.isDirty).toBe(false);
});
});