Files
kandev/apps/web/components/settings/inference-agent-status.test.tsx
João Salavisa 48a621a566 fix(utility): surface inference-agent probe status + add refresh endpoint (#1287)
* fix(utility): surface probe status in inference-agents endpoint

GET /api/v1/utility/inference-agents previously filtered out agents whose
host-utility probe didn't reach StatusOK, so a Claude entry with auth or
install issues vanished from the response. The frontend then defaulted
agent_id to "claude-acp", failed to match anything in the list, and
silently rendered an empty Model picker with no explanation.

Include every registered ACP-capable agent in the response with a new
`status` field (and sanitized `status_message`) so the UI can render an
inline note + Refresh button. Add a companion
POST /api/v1/utility/inference-agents/:id/refresh endpoint backed by the
existing hostutility.Manager.Refresh so users can re-probe after fixing
auth or installing the CLI without restarting kandev.

Credential-looking substrings ("api_key=...", "token=...") in probe
errors are stripped before reaching the wire.

Refs #1269, #1263.

* fix(web): show probe status note + Refresh on utility-agent model picker

Previously the Model picker rendered empty and disabled whenever the
selected inference agent was missing from /inference-agents (probe
hadn't reached StatusOK) or advertised no models, with no way for the
user to understand or recover.

Wire the new `status` field through the API client and render an inline
note ("Sign in to Claude to load models.", "Claude CLI is not installed
on this machine.", "Setting up Claude…") with a Refresh button that
calls the new POST /inference-agents/:id/refresh endpoint and merges the
updated agent back into local state — no full refetch, so a slow probe
on a different agent doesn't block the UI.

Both call sites — the create/edit dialog and the Default Model row in
the settings page — render the note. Component-level unit tests cover
the status-to-copy mapping, fallback ("no longer available") copy, and
the in-flight Refresh button disabled state. The e2e test asserts the
auth_required → click Refresh → status:ok state machine end to end.

Refs #1269.

* test(utility): add HTTP integration tests for inference-agents endpoints

End-to-end coverage of the new /api/v1/utility/inference-agents and
/api/v1/utility/inference-agents/:id/refresh routes against a real gin
router with a stateful in-memory host stub.

- ProbeStateMachine: GET (auth_required) → POST refresh → GET (ok+models)
- RefreshUnknownAgent: 404 without invoking the host probe
- RefreshPathFuzz: traversal, null byte, 512-char id — no 5xx, no probe
- ConcurrentRefresh: 50 parallel POSTs under -race, no panic
- StatusMessageSanitizationOnTheWire: 110KB payload + unicode probe
  errors — no secret material reaches the wire, unicode prose preserved

Caught the gap unit tests had: the multi-request GET→POST→GET sequence
on a shared cache, and the wire format (Content-Type, JSON shape)
through the real router.

* fix(utility): tighten credential regex + drop Go 1.22 loop-var shadow

Address two inline review comments from claude bot on PR #1287:

- Drop `ia := ia` shadow in httpRefreshInferenceAgent — pre-Go 1.22
  pointer-capture workaround, dead weight under Go 1.24+ (per
  apps/backend/AGENTS.md).
- Split the credential sanitizer into two patterns so prose without a
  real `=`/`:` separator is no longer mangled. The single regex
  previously turned "access token was revoked" into
  "access token=<redacted> revoked" by consuming the next word as the
  value. New shape:
    - credentialKVPattern — requires `[:=]` (api_key, token, secret,
      password)
    - credentialBearerPattern — allows bare whitespace, anchored to
      "bearer" only
  Existing redaction cases still pass; two new prose cases guard the
  regression.

* fix(utility): address cubic + greptile review findings on PR #1287

Round-2 review feedback:

- P0 (cubic): postEmpty called `t.Fatalf` from `go func()` in
  TestIntegration_ConcurrentRefresh. Go panics on t.Fatalf from non-test
  goroutines. Split into `postEmptyE` (error-returning, goroutine-safe)
  and `postEmpty` (main-goroutine wrapper). Concurrent test now
  forwards the error through the existing `errs` channel.
- P1 (cubic + greptile): tightened the credential sanitizer regex.
    * `api[ _-]?key` now also matches a literal space ("invalid api key=…")
    * separators are restricted to `[^\S\n]` so multi-line stderr like
      "invalid token\ncaused by network" no longer eats words across lines
  Test coverage added for both regressions (and for tab as a valid
  horizontal-whitespace separator).
- P2 (cubic): refresh-failure log now feeds `err.Error()` through
  sanitizeStatusMessage before zapping it — same wire-side guard, but
  applied to server logs too. Closes the "credentials in journalctl"
  hole.
- P2 (cubic): InferenceAgent.status is now optional in the TS type and
  the status note treats an undefined status with `models.length > 0`
  as healthy, so older API responses don't flash a spurious warning.

Deferred (acknowledged in PR replies, not changed here):

- cubic P2 useInferenceAgents drift — the hook is currently called in
  both the dialog and the parent section. Drift is bounded by the
  dialog's own `onSuccess` refetch and only visible inside an open
  dialog. Lifting state to the parent and prop-drilling is the right
  fix but touches multiple files; out of scope for this review round.

* docs(utility): fix stale comments flagged by claude review on PR #1287

Two doc-only items, no code change:

- handlers_integration_test.go: TestIntegration_ConcurrentRefresh
  comment said "we don't assert on call count" but the test DOES
  assert `host.refreshCalls != N` two lines later. Updated to match
  reality (singleflight lives in the real Manager, the stub has none
  → every call must reach the stub).
- utility-agents.spec.ts: the ACP-probe E2E said "backend filters out
  non-StatusOK agents", which is the exact behavior this PR removes.
  Updated to explain the real reason only Mock appears (KANDEV_MOCK_AGENT=only
  registers only `mock-agent`).

---------

Co-authored-by: Kandev Agent <agent@kandev.dev>
2026-06-07 12:38:28 +01:00

125 lines
3.9 KiB
TypeScript

import { afterEach, describe, expect, it, vi } from "vitest";
import { cleanup, fireEvent, render, screen, waitFor } from "@testing-library/react";
import { InferenceAgentStatusNote } from "./inference-agent-status";
import type { InferenceAgent, InferenceAgentStatus } from "@/lib/api/domains/utility-api";
afterEach(() => {
cleanup();
});
function makeAgent(overrides: Partial<InferenceAgent> = {}): InferenceAgent {
return {
id: "claude-acp",
name: "Claude ACP Agent",
display_name: "Claude",
models: [],
status: "ok",
...overrides,
};
}
describe("InferenceAgentStatusNote", () => {
it("renders nothing when agent is healthy with models", () => {
const { container } = render(
<InferenceAgentStatusNote
agent={makeAgent({
status: "ok",
models: [{ id: "sonnet", name: "Sonnet", description: "", is_default: true }],
})}
onRefresh={() => {}}
/>,
);
expect(container.firstChild).toBeNull();
});
it.each<[InferenceAgentStatus, string]>([
["probing", "Setting up Claude"],
["auth_required", "Sign in to Claude"],
["not_installed", "Claude CLI is not installed"],
["not_configured", "Claude is not configured"],
["failed", "Probe failed for Claude"],
])("maps status %s to the expected note copy", (status, expectedSubstring) => {
render(<InferenceAgentStatusNote agent={makeAgent({ status })} onRefresh={() => {}} />);
expect(screen.getByText(new RegExp(expectedSubstring))).toBeTruthy();
});
it("treats ok-with-no-models as an empty-advertised-models state", () => {
render(
<InferenceAgentStatusNote
agent={makeAgent({ status: "ok", models: [] })}
onRefresh={() => {}}
/>,
);
expect(screen.getByText(/Claude advertised no models/)).toBeTruthy();
});
it("renders fallback copy when agent is missing from the list", () => {
render(
<InferenceAgentStatusNote agent={null} fallbackName="claude-acp" onRefresh={() => {}} />,
);
expect(screen.getByText(/claude-acp is no longer available/)).toBeTruthy();
});
it("hides the Refresh button for non-refreshable statuses", () => {
render(
<InferenceAgentStatusNote
agent={makeAgent({ status: "not_configured" })}
onRefresh={() => {}}
/>,
);
expect(screen.queryByTestId("inference-agent-refresh")).toBeNull();
});
it("invokes onRefresh and disables the button while refreshing", async () => {
let resolve: (() => void) | undefined;
const onRefresh = vi.fn(
() =>
new Promise<void>((r) => {
resolve = r;
}),
);
render(
<InferenceAgentStatusNote
agent={makeAgent({ status: "auth_required" })}
onRefresh={onRefresh}
/>,
);
const button = screen.getByTestId("inference-agent-refresh") as HTMLButtonElement;
fireEvent.click(button);
expect(onRefresh).toHaveBeenCalledTimes(1);
await waitFor(() => {
expect(button.disabled).toBe(true);
});
resolve?.();
await waitFor(() => {
expect(button.disabled).toBe(false);
});
});
it("treats an agent with no status field as healthy when models are present", () => {
const { container } = render(
<InferenceAgentStatusNote
agent={makeAgent({
status: undefined as unknown as InferenceAgentStatus,
models: [{ id: "sonnet", name: "Sonnet", description: "", is_default: true }],
})}
onRefresh={() => {}}
/>,
);
expect(container.firstChild).toBeNull();
});
it("exposes the sanitized status_message detail line", () => {
render(
<InferenceAgentStatusNote
agent={makeAgent({
status: "failed",
status_message: "subprocess exited with code 1",
})}
onRefresh={() => {}}
/>,
);
expect(screen.getByText("subprocess exited with code 1")).toBeTruthy();
});
});