mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-03 17:51:58 +01:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - Product E2E journeys verify saved application behavior across deployments. > - Task creation and questions need reusable smoke selections and exact run attribution. > - Operators also need to inspect the OpenCode execution behind a measured question. > - Company observability does not currently support native OpenCode. > - This change adds the journeys and a bounded projection of normalized OpenCode run events. > - The projection follows the configured capture policy and retains the current run identity across warm reuse. ## Linked Issues or Issue Description Related foundation: #17262. Related alternative: #17989 exports metadata from OpenCode's native OTLP stream. This change uses normalized run events to support the existing content switches and per-run linkage. It does not forward the native stream. The two PRs overlap in launch registration and must be reconciled before both land. **What existing behavior does this improve?** Reusable Product E2E smoke selections and company observability for native OpenCode. **Current behavior** The journey catalog lacks reusable task creation and attached-agent question checks. Native OpenCode is marked unsupported for company observability, so a successful destination connection test does not prove that agent traces will appear. **Proposed behavior** Add explicit task-create and ask-question selections. Verify saved state and exact company, issue, agent, model, environment and successful run attribution. Export normalized OpenCode turns, tools and usage to the configured OTLP destination. Honor each capture switch and redact known secrets. **Reason and benefit** CI can run a small measured smoke selection, retain its screenshots and checks, and link results to traces belonging to the same run. **Breaking changes** Existing selectors remain unchanged. OpenCode export is opt-in through existing company settings. Legacy OpenCode stays unsupported. ## What Changed - Add reusable task creation and question journeys, configured-agent capability, owned-fixture checkpoints and strict evidence validation. - Add an OpenCode-owned projection of normalized run events. No provider SDK or raw payload schema enters heartbeat coordination. - Extend the private launch union and reserved environment allowlist for native OpenCode. With export disabled, no receiver request runs. - Keep destination headers in the parent wrapper and out of the actual provider child environment and configuration. - Bound each turn to 64 tool and 64 usage entries, 8 KiB per text field and a 1 MiB request. Use a three-second request deadline, four concurrent exports, and no retries or idle worker. - Pass the rotated runner authority to each proxy turn. A retained process no longer attributes later turns to its original launch run. - Update settings copy, observability documentation and capability maps. ## Verification - `pnpm -r typecheck` and `pnpm build` passed after the implementation changes. - Adapter launch/redaction: 9 tests passed. Projection and actual proxy: 12 tests passed before the review fix; the expanded projection suite passed all 12 cases after the fix. The proxy test exercises two runs in one process against a real local HTTP receiver and a fake provider. - Full OpenCode driver/projection suite: 72 passed, one existing response_wake test timed out at five seconds. A focused check then passed both existing omitted-continuation cases and the new trace export case. The timeout cause remains unconfirmed. - Runner package TypeScript and Rust `cargo check` passed. Map and UI token checks passed. - Prior journey validation: 273 tests across 12 files and the journey TypeScript check passed. - Broad local `pnpm test:run` encountered native-runtime integration failures with repeated embedded PostgreSQL initialization failures and was stopped. All 16 failing cases passed in an isolated run outside the filesystem sandbox (961 unrelated cases unselected). The broad local run is not a clean acceptance result. A later focused database-backed chat/heartbeat run passed all six selected observability cases, including native OpenCode launch and successful allocation (1,809 unrelated cases were unselected). - All CI gates passed for `21085f880d8babc9efeb22d0623db99613d33093`, including packaged-runner, clean-install, browser and build checks: https://github.com/paperclipai/paperclip/actions/runs/40884658995 . Greptile reviewed the same commit at 5/5 with no unresolved findings. - Verified OTLP JSON acceptance and indexing with an explicitly synthetic transport marker. No live OpenCode model trace or deployed smoke acceptance is claimed yet. ## Risks Export is best effort. Abrupt termination, recovered in-flight turns without a new submitted event, limits or receiver failure can lose traces. Export failure does not change task success. The projection represents observed normalized events, not raw native model spans or hidden reasoning. Known-secret redaction is not an OS isolation boundary. UI changes can break journey locators. Deployment adapters retain credential, ownership and cleanup responsibility. Both the controller and native runner bundle must be updated before live qualification. ## Model Used OpenAI Codex, GPT-6, with reasoning, code execution and browser tools. The exact serving model ID and context size are not exposed to this session. ## Checklist - [x] I have included a thinking path that traces from project context to this change - [x] I have specified the model used (with version and capability details) - [x] I have checked ROADMAP.md and confirmed this PR does not duplicate planned core work - [x] I have searched GitHub for duplicate or related PRs and linked them above - [x] I have either (a) linked existing issues with `Fixes: #` / `Closes #` / `Refs #` OR (b) described the issue in-PR following the relevant issue template - [x] I have not referenced internal/instance-local Paperclip issues or links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip` URLs) - [x] My branch name describes the change (e.g. `docs/...`, `fix/...`) and contains no internal Paperclip ticket id or instance-derived details - [x] I have run tests locally and they pass (targeted suites; broad local limitation documented above) - [x] I have added or updated tests where applicable - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [x] All Paperclip CI gates are green - [x] Greptile is 5/5 with no open P2s, recommendations, or follow-ups - [x] I will address all Greptile and reviewer comments before requesting merge --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
194 lines
16 KiB
TypeScript
194 lines
16 KiB
TypeScript
import { useEffect, useRef, useState } from "react";
|
|
import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
|
|
import {
|
|
DEFAULT_AGENT_OBSERVABILITY_CAPTURE, updateAgentObservabilitySchema, isSameOtlpOrigin,
|
|
type AgentObservabilityCapture, type AgentObservabilitySettings, type AgentObservabilitySettingsResponse,
|
|
type AgentObservabilityTestReceipt, type UpdateAgentObservabilityRequest,
|
|
} from "@paperclipai/shared";
|
|
import { agentObservabilityApi } from "@/api/agent-observability";
|
|
import { ApiError } from "@/api/client";
|
|
import { Button } from "@/components/ui/button";
|
|
import { Input } from "@/components/ui/input";
|
|
import { Label } from "@/components/ui/label";
|
|
import { ToggleField } from "@/components/agent-config-primitives";
|
|
|
|
type HeaderDraft = { id: number; originalName: string | null; name: string; value: string };
|
|
const captureLabels: Array<{ key: keyof AgentObservabilityCapture; label: string }> = [
|
|
{ key: "userPrompts", label: "User prompts" },
|
|
{ key: "assistantResponses", label: "Assistant responses" },
|
|
{ key: "toolContent", label: "Tool output and content" },
|
|
{ key: "toolDetails", label: "Additional tool details (Claude Code)" },
|
|
];
|
|
export interface AgentObservabilitySettingsViewProps {
|
|
companyId: string;
|
|
settings: AgentObservabilitySettings | null;
|
|
canManage?: boolean;
|
|
saving?: boolean;
|
|
testing?: boolean;
|
|
removing?: boolean;
|
|
error?: string | null;
|
|
conflict?: boolean;
|
|
result?: AgentObservabilityTestReceipt | null;
|
|
/** Changes only after an explicit successful mutation, never a background refetch. */
|
|
resetKey?: number;
|
|
onSave: (input: UpdateAgentObservabilityRequest) => void;
|
|
onTest: () => void;
|
|
onRemove: () => void;
|
|
onReload?: () => void;
|
|
}
|
|
|
|
export function AgentObservabilitySettingsView(props: AgentObservabilitySettingsViewProps) {
|
|
const { companyId, settings, canManage = true, saving, testing, removing, error, conflict, onSave, onTest, onRemove, onReload } = props;
|
|
const [provider, setProvider] = useState<"braintrust" | "otlp">("braintrust");
|
|
const [projectId, setProjectId] = useState("");
|
|
const [endpoint, setEndpoint] = useState("");
|
|
const [enabled, setEnabled] = useState(false);
|
|
const [capture, setCapture] = useState<AgentObservabilityCapture>({ ...DEFAULT_AGENT_OBSERVABILITY_CAPTURE });
|
|
const [apiKey, setApiKey] = useState("");
|
|
const [replaceKey, setReplaceKey] = useState(false);
|
|
const [headers, setHeaders] = useState<HeaderDraft[]>([]);
|
|
const [validation, setValidation] = useState<string | null>(null);
|
|
const [applied, setApplied] = useState<AgentObservabilitySettings | null>(settings);
|
|
const nextHeader = useRef(0);
|
|
const revision = settings?.revision ?? null;
|
|
function reset() {
|
|
setApplied(settings);
|
|
setProvider(settings?.destination.provider ?? "braintrust");
|
|
setProjectId(settings?.destination.provider === "braintrust" ? settings.destination.projectId : "");
|
|
setEndpoint(settings?.destination.provider === "otlp" ? settings.destination.endpointBaseUrl : "");
|
|
setEnabled(settings?.enabled ?? false);
|
|
setCapture({ ...(settings?.capture ?? DEFAULT_AGENT_OBSERVABILITY_CAPTURE) });
|
|
setApiKey(""); setReplaceKey(false); setValidation(null);
|
|
setHeaders((settings?.destination.provider === "otlp" ? settings.headerNames : []).map(name => ({ id: nextHeader.current++, originalName: name, name, value: "" })));
|
|
}
|
|
const original = applied;
|
|
const headersChanged = provider === "otlp" && (headers.some(row => row.value || row.originalName !== row.name.toLowerCase())
|
|
|| JSON.stringify(headers.map(row => row.name.toLowerCase()).sort()) !== JSON.stringify(original?.destination.provider === "otlp" ? [...original.headerNames].sort() : []));
|
|
const dirty = !original || provider !== original.destination.provider || enabled !== original.enabled || replaceKey || Boolean(apiKey) || headersChanged
|
|
|| JSON.stringify(capture) !== JSON.stringify(original.capture)
|
|
|| (provider === "braintrust" ? projectId !== (original.destination.provider === "braintrust" ? original.destination.projectId : "")
|
|
: endpoint !== (original.destination.provider === "otlp" ? original.destination.endpointBaseUrl : ""));
|
|
// Explicit mutation success/company changes erase secrets. Background reads
|
|
// may update a clean form, but cannot overwrite an unsaved draft.
|
|
useEffect(() => { reset(); }, [companyId, props.resetKey]);
|
|
useEffect(() => { if (!dirty && !conflict) reset(); }, [revision]);
|
|
const hasConflict = Boolean(conflict || revision !== (original?.revision ?? null));
|
|
const requireFreshHeaders = provider === "otlp" && original?.destination.provider === "otlp"
|
|
&& original.headerNames.length > 0 && !isSameOtlpOrigin(original.destination, { provider: "otlp", endpointBaseUrl: endpoint });
|
|
const busy = saving || testing || removing;
|
|
const providerChanged = !original || original.destination.provider !== provider;
|
|
function save(overrideEnabled?: boolean) {
|
|
if (requireFreshHeaders && headers.some(row => !row.value)) {
|
|
setValidation("Re-enter every header value for the new endpoint, or remove the header."); return;
|
|
}
|
|
const common = { expectedRevision: original?.revision ?? null, enabled: overrideEnabled ?? enabled, capture };
|
|
const input = provider === "braintrust"
|
|
? { ...common, destination: { provider, projectId }, credentials: providerChanged || replaceKey || apiKey || (!original?.credentialsConfigured && common.enabled) ? { mode: "replace", apiKey } : { mode: "keep" } }
|
|
: { ...common, destination: { provider, endpointBaseUrl: endpoint }, credentials: providerChanged || headersChanged || requireFreshHeaders
|
|
? { mode: "replace", headers: headers.map(row => ({ name: row.name, ...(row.value ? { value: row.value } : {}) })) } : { mode: "keep" } };
|
|
const parsed = updateAgentObservabilitySchema.safeParse(input);
|
|
if (!parsed.success) { setValidation(parsed.error.issues[0]?.message ?? "Review the configuration."); return; }
|
|
setValidation(null); onSave(parsed.data);
|
|
}
|
|
const receipt = props.result?.revision === revision ? props.result : settings?.lastTest;
|
|
return <section aria-labelledby="agent-observability-heading" className="max-w-2xl space-y-4">
|
|
<div className="space-y-1">
|
|
<h2 id="agent-observability-heading" className="text-lg font-medium">Agent observability</h2>
|
|
<p className="text-sm text-muted-foreground">Send Codex, Claude Code and native OpenCode execution data to your observability service.</p>
|
|
</div>
|
|
{!canManage ? <p className="text-sm text-muted-foreground">Manage connections permission is required to configure agent observability.</p> : <>
|
|
<fieldset disabled={busy} className="space-y-4">
|
|
<div className="space-y-2">
|
|
<Label htmlFor="agent-observability-provider">Destination</Label>
|
|
<select id="agent-observability-provider" className="h-9 w-full rounded-md border border-input bg-background px-3 text-sm" value={provider}
|
|
onChange={event => { setProvider(event.target.value as "braintrust" | "otlp"); setApiKey(""); setReplaceKey(false); setValidation(null); }}>
|
|
<option value="braintrust">Braintrust</option><option value="otlp">Custom OTLP</option>
|
|
</select>
|
|
</div>
|
|
{provider === "braintrust" ? <>
|
|
<div className="space-y-2"><Label htmlFor="agent-observability-project">Project ID</Label>
|
|
<Input id="agent-observability-project" value={projectId} onChange={event => setProjectId(event.target.value)} placeholder="Braintrust project UUID" autoComplete="off" />
|
|
</div>
|
|
<div className="space-y-2">
|
|
<Label htmlFor="agent-observability-key">API key</Label>
|
|
{!providerChanged && original?.credentialsConfigured && !replaceKey ? <div className="flex items-center justify-between gap-3">
|
|
<span className="text-sm text-muted-foreground">API key configured</span><Button type="button" variant="outline" size="sm" onClick={() => setReplaceKey(true)}>Replace API key</Button>
|
|
</div> : <Input id="agent-observability-key" type="password" value={apiKey} onChange={event => setApiKey(event.target.value)} autoComplete="new-password" />}
|
|
</div>
|
|
</> : <>
|
|
<div className="space-y-2"><Label htmlFor="agent-observability-endpoint">OTLP base URL</Label>
|
|
<Input id="agent-observability-endpoint" value={endpoint} onChange={event => setEndpoint(event.target.value)} placeholder="https://collector.example.com" autoComplete="off" />
|
|
<p className="text-xs text-muted-foreground">Use the base URL without /v1/logs or /v1/traces. It must be reachable from each agent environment.</p>
|
|
</div>
|
|
<div className="space-y-2"><div className="flex items-center justify-between gap-3"><Label>Headers</Label>
|
|
<Button type="button" variant="outline" size="sm" disabled={headers.length >= 16} onClick={() => setHeaders(rows => [...rows, { id: nextHeader.current++, originalName: null, name: "", value: "" }])}>Add header</Button></div>
|
|
{headers.length === 0 && <p className="text-sm text-muted-foreground">No authentication headers.</p>}
|
|
{headers.map(row => <div key={row.id} className="flex flex-wrap items-center gap-2">
|
|
<Input className="min-w-0 flex-1" aria-label="Header name" value={row.name} onChange={event => setHeaders(rows => rows.map(item => item.id === row.id ? { ...item, name: event.target.value } : item))} autoComplete="off" />
|
|
<Input className="min-w-0 flex-1" aria-label={`Value for ${row.name || "header"}`} type="password" value={row.value} placeholder={row.originalName && !requireFreshHeaders ? "Keep saved value" : "Header value"}
|
|
onChange={event => setHeaders(rows => rows.map(item => item.id === row.id ? { ...item, value: event.target.value } : item))} autoComplete="new-password" />
|
|
<Button type="button" size="sm" variant="ghost" aria-label={`Remove ${row.name || "header"}`} onClick={() => setHeaders(rows => rows.filter(item => item.id !== row.id))}>Remove</Button>
|
|
</div>)}
|
|
</div>
|
|
</>}
|
|
<p className="text-xs text-muted-foreground">The agent harness receives these credentials. Use a key limited to telemetry ingestion.</p>
|
|
<ToggleField label="Enable export" checked={enabled} onChange={setEnabled} hint="Applies to executions that start preparation after saving." />
|
|
<details><summary className="cursor-pointer text-sm font-medium">Content capture</summary>
|
|
<div className="space-y-3 pt-3">{captureLabels.map(row => <ToggleField key={row.key} label={row.label} checked={capture[row.key]} onChange={value => setCapture(current => ({ ...current, [row.key]: value }))} />)}
|
|
<p className="text-xs text-muted-foreground">Native limits apply. Exported records can contain task content, including prompts and tool output. A collector can forward records to multiple services.</p>
|
|
</div>
|
|
</details>
|
|
</fieldset>
|
|
{(validation || error || hasConflict) && <p role="alert" className="text-sm text-destructive">{validation || error || "Another administrator changed these settings. Reload the saved settings to continue."}</p>}
|
|
{hasConflict && <Button type="button" size="sm" variant="outline" disabled={busy} onClick={() => { reset(); onReload?.(); }}>Reload saved settings</Button>}
|
|
{!dirty && receipt && <div role="status" className="space-y-1 text-sm">
|
|
<p className="font-medium">{receipt.status === "accepted" ? "Test payload accepted" : receipt.status === "partial" ? "Some test records were rejected" : "Test payload failed"}</p>
|
|
<p className="text-xs text-muted-foreground">{new Date(receipt.finishedAt).toLocaleString()} · Sent from the Paperclip server.</p>
|
|
{(["logs", "traces"] as const).map(signal => receipt.signals[signal].message && <p key={signal}>{signal === "logs" ? "Logs" : "Traces"}: {receipt.signals[signal].message}</p>)}
|
|
</div>}
|
|
<div className="flex items-center justify-between gap-3">
|
|
<Button type="button" variant="ghost" disabled={busy || !dirty} onClick={reset}>Cancel</Button>
|
|
<Button type="button" disabled={busy || !dirty || hasConflict} onClick={() => save()}>{saving ? "Saving…" : "Save changes"}</Button>
|
|
</div>
|
|
{dirty && settings && <p className="text-xs text-muted-foreground">Save changes before testing.</p>}
|
|
{settings && <div className="flex flex-wrap items-center gap-2">
|
|
<Button type="button" variant="outline" disabled={busy || dirty || hasConflict} onClick={onTest}>{testing ? "Testing…" : "Test saved settings"}</Button>
|
|
{settings.enabled && <Button type="button" size="sm" variant="ghost" disabled={busy || dirty || hasConflict} onClick={() => save(false)}>Disable export</Button>}
|
|
<Button type="button" size="sm" variant="ghost" disabled={busy || dirty || hasConflict} onClick={onRemove}>{removing ? "Removing…" : "Remove configuration"}</Button>
|
|
</div>}
|
|
</>}
|
|
</section>;
|
|
}
|
|
|
|
export function AgentObservabilitySettingsSection({ companyId }: { companyId: string }) {
|
|
return <AgentObservabilitySettingsContainer key={companyId} companyId={companyId} />;
|
|
}
|
|
function AgentObservabilitySettingsContainer({ companyId }: { companyId: string }) {
|
|
const client = useQueryClient();
|
|
const queryKey = ["agent-observability", companyId];
|
|
const query = useQuery({ queryKey, queryFn: () => agentObservabilityApi.settings(companyId) });
|
|
const [error, setError] = useState<string | null>(null);
|
|
const [conflict, setConflict] = useState(false);
|
|
const [resetKey, setResetKey] = useState(0);
|
|
const accept = (data: AgentObservabilitySettingsResponse) => { client.setQueryData(queryKey, data); setError(null); setConflict(false); setResetKey(value => value + 1); };
|
|
const reject = (cause: unknown) => {
|
|
const stale = cause instanceof ApiError && cause.status === 409;
|
|
setConflict(stale);
|
|
setError(stale ? "Another administrator changed these settings. Reload the saved settings to continue." : cause instanceof Error ? cause.message : "The observability settings could not be updated.");
|
|
};
|
|
const save = useMutation({ gcTime: 0, mutationFn: (input: UpdateAgentObservabilityRequest) => agentObservabilityApi.update(companyId, input), onSuccess: accept, onError: reject, onSettled: () => queueMicrotask(() => save.reset()) });
|
|
const remove = useMutation({ mutationFn: (revision: string) => agentObservabilityApi.remove(companyId, revision), onSuccess: accept, onError: reject });
|
|
const test = useMutation({ mutationFn: (revision: string) => agentObservabilityApi.test(companyId, revision), onSuccess: receipt => {
|
|
setError(null); client.setQueryData<AgentObservabilitySettingsResponse>(queryKey, current => current?.settings?.revision === receipt.revision
|
|
? { ...current, settings: { ...current.settings, lastTest: receipt } } : current);
|
|
}, onError: reject });
|
|
useEffect(() => { setError(null); setConflict(false); save.reset(); test.reset(); remove.reset(); }, [companyId]);
|
|
if (query.isPending) return <p className="text-sm text-muted-foreground">Loading agent observability…</p>;
|
|
if (!query.data) return <div role="alert" className="space-y-2 text-sm"><p>Agent observability settings could not be loaded.</p><Button variant="outline" size="sm" onClick={() => void query.refetch()}>Retry</Button></div>;
|
|
return <AgentObservabilitySettingsView key={companyId} companyId={companyId} settings={query.data.settings} canManage={query.data.canManage}
|
|
saving={save.isPending} removing={remove.isPending} testing={test.isPending} error={error ?? (query.isError ? "Saved settings could not be refreshed. Your draft is unchanged." : null)} conflict={conflict} resetKey={resetKey}
|
|
onSave={input => save.mutate(input)} onTest={() => { if (query.data.settings) test.mutate(query.data.settings.revision); }}
|
|
onRemove={() => { if (query.data.settings) remove.mutate(query.data.settings.revision); }}
|
|
onReload={() => { setConflict(false); setError(null); void query.refetch(); }} />;
|
|
}
|