Files
kandev/apps/web/lib/api/domains/plugins-api.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

162 lines
6.1 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);
}
// getPluginConfig fetches a plugin's stored operator config
// (GET /api/plugins/:id/config). Secret values (per the manifest's
// config_schema) arrive masked — the backend never returns them in
// cleartext on this surface.
export async function getPluginConfig(id: string, options?: ApiRequestOptions) {
const res = await fetchJson<{ config?: Record<string, unknown> }>(
`${BASE}/${encodeURIComponent(id)}/config`,
options,
);
return res.config ?? {};
}
// updatePluginConfig replaces a plugin's operator-editable config
// (PATCH /api/plugins/:id). Secret fields submitted as the mask placeholder
// keep their stored value server-side.
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" },
});
}