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. > - The agent page is where an operator reads and changes one agent. > - The page grew one tab at a time. Ten tabs sit in one flat list, the header holds many buttons, and the audit links leave the agent. > - A design pass, called Refine-v2, made a calmer layout for this page. It ran in a prototype on fixture data only. > - This pull request moves the Refine-v2 layout and behavior into the live agent page. Where the prototype and the live page differ, the live behavior stays. For example, the floating save bar stays on screen. > - The benefit is a shorter navigation, edits in place, and audit data that stays inside the agent. ## Linked Issues or Issue Description Refs #13716 Refs #9166 Both pull requests mount plugin tabs or slots on the agent page. They touch the same files, so one of the three needs a rebase after the others merge. **Subsystem affected** The agent detail page in `ui/` (`ui/src/pages/AgentDetail.tsx`, its sidebar, header actions, and the shared agent config form). **Problem or motivation** The agent page is hard to scan. The navigation shows ten items in one list. The header shows Run now, Pause, Clear error, and Assign task as separate buttons. The name, title, and manager are form fields deep in the Harness tab. Activity, Runs, Costs, and Budgets open company-wide pages, so the operator loses the agent context. Each tab uses a different card and table style. **Proposed solution** Use one layout system for every agent tab. Group the navigation into Agent and Audit. Edit the name and title in the header. Move the work actions into the actions menu. Show audit views inside the agent. Keep the persistent save bar and add a status dot to it. **Alternatives considered** We considered a flag that lets operators opt in to the new layout. We did not use a flag, because two layouts on one page double the test surface. We also considered moving the save button to the end of the scrolling content, as the prototype did. We kept the floating save bar, because it is always visible. **Roadmap alignment** `ROADMAP.md` has no item for the agent page. This change is a UI refinement of an existing page. It adds one optional field to an existing API request and no database schema change. ## What Changed - **Navigation.** The agent sidebar shows two groups. Agent has Overview, Identity, Harness / Runtime, Secrets & variables, Permissions / Trust, and Advanced. Audit has Activity, Runs, Costs, and Budgets. Skills, Tools, Channels, and API Keys leave the navigation. Their URLs still open. The Instructions tab is now Identity, at `/identity`. The old `/instructions` URL redirects. - **Header.** The agent character shows at a larger size. The name and title edit in place. Enter or blur saves. Escape cancels. An error restores the old value. A rename updates the URL. While a tab has unsaved changes, the header refuses the edit and asks the operator to save or discard first. The third line shows the title and a link to the manager. A crown button to the right of the name replaces the "Set as my primary" link and the separate primary indicator. It is outlined and dimmed until the agent is your primary, then fills with a short pop. Replacing an existing primary asks for confirmation first, and the pop plays after the dialog closes. Reduced motion skips the pop. Run now, Pause or Resume, Clear error, and Agent history move into the actions menu. Assign task is the primary button. For an agent that still needs setup, Finish setup is the primary button and Assign task moves into the menu. - **Agent history.** A new dialog in the actions menu replaces the Revisions entry. Each row shows a plain-language summary, the person or agent who made the change, the date, and Restore. Restore asks for confirmation. A failed restore shows its reason inside the confirmation. - **Overview.** Four metric tiles show activity this week, runs this week, costs this month, and budget used. Each tile links to its audit view. When the list behind a count is capped, the tile shows a lower bound, for example 200+. The activity tile follows live updates. Profile, Skills, and Recent tasks panels follow. The Profile panel lists direct reports under their label in at most two rows, then a "+N more" button that expands the list. The Latest run card is removed. - **Identity.** The file preview shows the raw text. A pencil button switches to a plain text editor. Copy and Delete are icon buttons. A chip next to the file name says "Managed by you" or "Managed externally". Per-file history and unsaved edits stay. - **External instructions.** "Advanced settings" opens Root path and Entry file fields and a Load profile button. Load profile asks the server to switch only if the root directory and the entry file already exist. If either is missing, the server refuses and the panel shows the reason. The entry file can have any name inside the root. - **Instructions bundle API.** `PATCH /agents/:id/instructions-bundle` accepts an optional `requireExistingEntry` flag (`packages/shared` validator, `server` service, `ui` client). With the flag, the server checks the root directory and entry file before it creates or copies anything. Without the flag, the behavior does not change. - **Harness / Runtime.** The config form gets a `panels` layout: Harness and Execution side by side, then the runtime test, then environment variables. The identity and run-policy sections are hidden from this tab. - **Secrets & variables and Advanced.** These tabs use the same filled panels and table headers. - **Permissions / Trust.** The trust presets show as selectable cards. An Allowed connectors panel shows up to three connector logos and links to Apps, filtered to installed connectors. Capabilities sit in their own panel. Changes on this tab save at once, with no save bar. - **Audit inside the agent.** Activity, Runs, Costs, and Budgets render inside the agent page. Runs is locked to the current agent. A failed budget incident action shows its reason under the incident. - **Save bar.** The floating save bar stays. It shows an amber dot for unsaved changes and a green dot with "Changes saved" after a save. Discard stays. - **Leave guard.** If the form has unsaved changes and the operator clicks a link, a dialog asks to keep editing or discard the changes. Browser back and the header actions keep the native confirm. - **Apps.** `/apps?source=installed` opens the Apps page on the Installed filter. - **Tokens.** New `--agent-detail-*` tokens in `ui/src/index.css` hold every spacing and fill value. Each fill is a mix of foreground into background, so one value works in light and dark themes. - **Tests and maps.** Tests cover the navigation model, sidebar, header menu, Overview layout, Identity editor, and helpers. The agent-configuration recipe in `maps/feature-map/agents.md` describes the new page. ## Verification - `cd ui && npx vitest run`: 849 test files and 10,081 tests pass. - `cd server && npx vitest run src/__tests__/agent-instructions-routes.test.ts src/__tests__/agent-instructions-service.test.ts`: 40 tests pass. - `npx playwright test --config tests/e2e/playwright.config.ts tests/e2e/onboarding.spec.ts tests/e2e/chat-adapters-ui-providers.spec.ts`: 26 tests pass. - `cd ui && pnpm typecheck` passes. This includes the Storybook catalog check. The `server` and `packages/shared` typechecks pass. - `cd ui && pnpm build` passes. - `pnpm run check:token-gates` reports all gates clean. - `node scripts/check-maps.mjs` and `node scripts/storybook-catalog.mjs --check` pass. - Manual check on a local instance, in light and dark themes: 1. Open an agent. Confirm the sidebar shows the Agent and Audit groups. 2. Click the agent name in the header. Type a new name and press Enter. Confirm the URL changes. Rename it back. 3. Open the actions menu. Open Agent history. Confirm the rows and the Restore confirmation. 4. Open Identity. Click the pencil. Change a line. Confirm the save bar shows the amber dot. Click a sidebar link. Confirm the discard dialog. Click Keep editing, then save. Confirm the green dot. 5. Open Harness / Runtime, Secrets & variables, and Permissions / Trust. Confirm the panels and the trust cards. 6. Open Runs under Audit. Confirm the list shows only this agent and the page stays inside the agent. ## Risks - This changes a high-traffic page for every operator at once. There is no flag to switch back. - Run policy and Reports to are no longer editable on the agent page. The header shows the manager as a link only. - Skills, Tools, Channels, and API Keys are reachable by URL only. Operators who use them from the sidebar must use the URL. - The pull request conflicts with #13716 and #9166 in `AgentDetail.tsx` and the agent sidebar. - Storybook stories for the agent page and `DESIGN.md` are not updated in this pull request. - The new `requireExistingEntry` flag is opt-in. Existing API callers keep the old behavior, which creates a missing external directory and entry file. - I ran two e2e spec files locally, not the full `pnpm test:e2e` or `pnpm test:release-smoke`. CI runs the full e2e suite. I did not run the repo-wide `pnpm -r typecheck`, because the local toolchain has no Rust. > For core feature work, check [`ROADMAP.md`](ROADMAP.md) first and discuss it in `#dev` before opening the PR. Feature PRs that overlap with planned core work may need to be redirected — check the roadmap first. See `CONTRIBUTING.md`. ## Model Used - Anthropic Claude Opus 5.5 (`claude-opus-5-5`), in Claude Code, with reasoning and tool use (shell, file edits, and a browser for visual checks). A person directed every design decision. ## 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 - [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 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
167 lines
6.0 KiB
TypeScript
167 lines
6.0 KiB
TypeScript
// @vitest-environment jsdom
|
|
|
|
import { renderToStaticMarkup } from "react-dom/server";
|
|
import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
|
|
import type { AgentDetail, AgentRuntimeState, HeartbeatRun, Issue } from "@paperclipai/shared";
|
|
import { describe, expect, it, vi } from "vitest";
|
|
import { AgentOverview } from "./AgentDetail";
|
|
import { TooltipProvider } from "@/components/ui/tooltip";
|
|
import { queryKeys } from "../lib/queryKeys";
|
|
|
|
vi.mock("@/lib/router", async () => {
|
|
const actual = await vi.importActual<typeof import("react-router-dom")>("react-router-dom");
|
|
return {
|
|
...actual,
|
|
Link: ({ to, children, ...props }: { to: string; children: React.ReactNode }) => (
|
|
<a href={to} {...props}>{children}</a>
|
|
),
|
|
};
|
|
});
|
|
|
|
vi.mock("../components/MarkdownBody", () => ({
|
|
MarkdownBody: ({ children }: { children: string }) => <div>{children}</div>,
|
|
}));
|
|
|
|
describe("AgentOverview", () => {
|
|
it("leads with audit cards, then Profile, Skills and Recent tasks", () => {
|
|
const agent = {
|
|
id: "agent-1",
|
|
companyId: "company-1",
|
|
name: "Codex Coder",
|
|
urlKey: "codexcoder",
|
|
role: "engineer",
|
|
title: "Product engineer",
|
|
status: "active",
|
|
reportsTo: null,
|
|
capabilities: "Builds and verifies product changes.",
|
|
adapterType: "codex_local",
|
|
adapterConfig: { model: "gpt-5.6-sol" },
|
|
runtimeConfig: {},
|
|
chainOfCommand: [],
|
|
access: { canAssignTasks: true, taskAssignSource: "explicit_grant", membership: null, grants: [] },
|
|
} as unknown as AgentDetail;
|
|
const issue = {
|
|
id: "issue-1",
|
|
companyId: "company-1",
|
|
identifier: "PAP-42",
|
|
title: "Simplify agent information architecture",
|
|
status: "in_progress",
|
|
priority: "high",
|
|
updatedAt: new Date("2026-08-31T12:00:00Z"),
|
|
} as unknown as Issue;
|
|
const runtime = {
|
|
sessionDisplayId: "codex-session-42",
|
|
} as unknown as AgentRuntimeState;
|
|
|
|
const markup = renderToStaticMarkup(
|
|
<QueryClientProvider client={new QueryClient()}>
|
|
<TooltipProvider>
|
|
<AgentOverview
|
|
agent={agent}
|
|
runs={[] as HeartbeatRun[]}
|
|
assignedIssues={[issue]}
|
|
runtimeState={runtime}
|
|
directReportCount={2}
|
|
skillNames={["Design Guide", "Check PR"]}
|
|
agentRouteId="codexcoder"
|
|
/>
|
|
</TooltipProvider>
|
|
</QueryClientProvider>,
|
|
);
|
|
|
|
for (const label of ["Activity", "Runs", "Costs", "Budget used", "Profile", "Skills", "Recent tasks"]) {
|
|
expect(markup).toContain(label);
|
|
}
|
|
for (const page of ["activity", "runs", "costs", "budgets"]) {
|
|
expect(markup).toContain(`href="/agents/codexcoder/${page}"`);
|
|
}
|
|
expect(markup).toContain("2 enabled");
|
|
expect(markup).toContain("Design Guide");
|
|
expect(markup).toContain("Simplify agent information architecture");
|
|
expect(markup).toContain("PAP-42");
|
|
expect(markup).toContain("See all tasks");
|
|
expect(markup).not.toContain("Latest Run");
|
|
expect(markup).not.toContain("Harness / Runtime");
|
|
expect(markup).not.toContain("Capabilities");
|
|
expect(markup).not.toContain("agentId=agent-1");
|
|
expect(markup).not.toContain("Created by");
|
|
});
|
|
|
|
function renderOverview(createdByUserId: string | null, client: QueryClient) {
|
|
const agent = {
|
|
id: "agent-2",
|
|
companyId: "company-1",
|
|
name: "Shared Agent",
|
|
urlKey: "sharedagent",
|
|
role: "engineer",
|
|
title: null,
|
|
status: "idle",
|
|
reportsTo: null,
|
|
capabilities: null,
|
|
adapterType: "codex_local",
|
|
adapterConfig: {},
|
|
runtimeConfig: {},
|
|
createdByUserId,
|
|
chainOfCommand: [],
|
|
access: { canAssignTasks: true, taskAssignSource: "explicit_grant", membership: null, grants: [] },
|
|
} as unknown as AgentDetail;
|
|
return renderToStaticMarkup(
|
|
<QueryClientProvider client={client}>
|
|
<AgentOverview
|
|
agent={agent}
|
|
runs={[] as HeartbeatRun[]}
|
|
assignedIssues={[]}
|
|
directReportCount={0}
|
|
skillNames={[]}
|
|
agentRouteId="sharedagent"
|
|
/>
|
|
</QueryClientProvider>,
|
|
);
|
|
}
|
|
|
|
function renderWithDirectory(createdByUserId: string, principalIds: string[]) {
|
|
const client = new QueryClient();
|
|
client.setQueryData(queryKeys.access.companyUserDirectory("company-1"), {
|
|
users: principalIds.map((principalId) => ({
|
|
principalId,
|
|
status: "active",
|
|
user: { id: principalId, name: principalId === "user-alice" ? "Alice Admin" : "Bob Builder", email: null, image: null },
|
|
})),
|
|
});
|
|
return renderOverview(createdByUserId, client);
|
|
}
|
|
|
|
it("shows who created the agent when the company has more than one human user", () => {
|
|
const markup = renderWithDirectory("user-alice", ["user-alice", "user-bob"]);
|
|
expect(markup).toContain("Created by");
|
|
expect(markup).toContain("Alice Admin");
|
|
});
|
|
|
|
it("hides the creator when only one human user shares the company with the Board", () => {
|
|
const markup = renderWithDirectory("user-alice", ["user-alice", "local-board"]);
|
|
expect(markup).not.toContain("Created by");
|
|
});
|
|
|
|
function failedDirectoryClient() {
|
|
const client = new QueryClient({ defaultOptions: { queries: { retryOnMount: false } } });
|
|
client.getQueryCache().build(client, { queryKey: queryKeys.access.companyUserDirectory("company-1") }).setState({
|
|
status: "error",
|
|
error: new Error("Directory unavailable"),
|
|
fetchStatus: "idle",
|
|
});
|
|
return client;
|
|
}
|
|
|
|
it("shows an error when the company user directory cannot be loaded", () => {
|
|
const markup = renderOverview("user-alice", failedDirectoryClient());
|
|
expect(markup).toContain("Created by");
|
|
expect(markup).toContain("Could not load creator");
|
|
});
|
|
|
|
it.each([null, "local-board"])("keeps the creator row hidden for creator %s when the directory failed", (createdByUserId) => {
|
|
const markup = renderOverview(createdByUserId, failedDirectoryClient());
|
|
expect(markup).not.toContain("Created by");
|
|
expect(markup).not.toContain("Could not load creator");
|
|
});
|
|
});
|