mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-22 16:51:28 +02:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - Operators need first-party agent capabilities for repeatable company work, not just manually created one-off agents. > - Built-in agents need to behave like normal company-scoped agents while preserving approval gates, permissions, budgets, and audit trails. > - Reflection and coaching work also needs bundled instructions, skill content, and a routine so the feature can be installed and reset predictably. > - The API, database, UI, portability, and tests all need to agree on the built-in lifecycle from not provisioned through setup, approval, ready, paused, and reset. > - This pull request adds built-in agent provisioning and the Reflection Coach bundle end-to-end. > - The benefit is a safer first-party path for Paperclip-managed agents without bypassing the same governance model used for operator-created agents. ## Linked Issues or Issue Description No public GitHub issue was found for this exact built-in agent and Reflection Coach bundle work. Problem/motivation: - Paperclip did not have a first-party built-in agent lifecycle for product-owned agents. - Bundled agent resources such as default instructions, skills, and routines needed managed ownership and reset semantics. - Approval-gated companies needed built-in setup to preserve requested adapter, budget, manager, and permission state through board approval. - The board UI needed clear built-in badges, setup affordances, readiness state, and bundle status without exposing secrets. Proposed solution: - Add a company-scoped built-in agent registry, provisioning/reset/reconcile/status APIs, and Reflection Coach bundled resources. - Track bundled managed resources in the database with idempotent migration behavior. - Reuse existing agent approval, authorization, budget, and activity-log paths instead of creating a bypass. - Add UI setup, badges, gates, bundle panels, and route coverage for built-in agents. Duplicate search: - Searched GitHub PRs for `built-in agents Reflection Coach repo:paperclipai/paperclip`; only this PR was returned. - Searched GitHub issues for the same query; no public issues were returned. ## What Changed - Added built-in agent definitions, lifecycle state derivation, provisioning, reset, reconcile, status, and routine-control routes. - Added the `built_in_managed_resources` migration and schema exports for bundled instructions, skill, and routine ownership. - Added the Reflection Coach built-in bundle with default instructions, skill catalog content, routine template, default permissions, and managed-resource drift handling. - Added approval-aware provisioning behavior that preserves requested adapter config, budgets, manager assignment, and built-in permissions through hire approval. - Added authorization and mutation gates for built-in agent and skill changes, including consented Reflection Coach change paths. - Added UI surfaces for built-in agent setup, roster/detail badges, readiness gates, bundle status, routine controls, and route filtering. - Added company import/export and validator coverage for built-in managed resources and low-trust/red-team presets. - Addressed Greptile follow-ups for pending approval reconciliation, consent-gate error propagation, config-read authorization fallback, approval-path manager preservation, and non-model adapter provisioning. ## Verification Local verification: - `git diff --check public/master..HEAD` passed. - `pnpm check:token-gates` passed with all gates clean. - `pnpm exec vitest run ui/src/components/ConfigureBuiltInAgentModal.test.tsx` passed: 1 file, 4 tests. - `pnpm exec vitest run ui/src/components/EntityRow.test.tsx ui/src/pages/Agents.test.tsx ui/src/components/BuiltInAgentGate.test.tsx ui/src/components/ConfigureBuiltInAgentModal.test.tsx ui/src/components/BuiltInBundlePanel.test.tsx ui/src/pages/InstanceExperimentalSettings.test.tsx ui/src/pages/Routines.test.tsx` passed: 7 files, 64 tests. - `pnpm --filter @paperclipai/server exec vitest run src/__tests__/built-in-agents.test.ts src/__tests__/authorization-service.test.ts src/__tests__/company-skills-routes.test.ts` passed: 3 files, 91 tests. - `pnpm --filter @paperclipai/db check:migrations` passed. - `pnpm -r typecheck` passed after the rebase; `pnpm --filter ui typecheck` passed after the final UI review fix. Remote verification on latest head `1c61f693a4ec881d739022b0e75a8ca8bf8c2cd8`: - Merge state: `CLEAN`. - Greptile: `5/5`, zero unresolved Greptile threads. - PR check rollup: all checks successful, neutral, or skipped as expected. - Passing gates include Build, Typecheck + Release Registry, all server shards, all workspace shards, all serialized server suites, e2e, Canary Dry Run, policy, review, verify, Socket, Superagent, and Snyk. ## Risks - This adds a new managed-resource table and migration; the migration uses idempotent create/add/index guards and passed migration safety checks. - Built-in agent provisioning touches approval and authorization paths; tests cover pending approval preservation, stale retry rejection, consent gates, and config-read fallback behavior. - Reflection Coach creates managed instructions, skill, and routine resources; drift/reset behavior is covered by service tests and redacted API responses. - Non-model adapter setup now provisions a `needs_setup` built-in row before command/endpoint fields are complete; this matches the server lifecycle and is covered by the setup modal regression test. ## Model Used OpenAI Codex coding agent based on GPT-5. Exact hosted model ID, context-window size, and reasoning-mode labels are not exposed in this runtime; tool use, shell execution, GitHub CLI/API access, and local code editing were enabled. ## 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 --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
164 lines
6.3 KiB
TypeScript
164 lines
6.3 KiB
TypeScript
// @vitest-environment jsdom
|
|
|
|
import { act } from "react";
|
|
import type { ReactNode } from "react";
|
|
import { createRoot, type Root } from "react-dom/client";
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
import { Inbox } from "lucide-react";
|
|
import { SidebarNavItem, SidebarNavExpandedProvider } from "./SidebarNavItem";
|
|
import { TooltipProvider } from "@/components/ui/tooltip";
|
|
|
|
const sidebarState = vi.hoisted(() => ({
|
|
isMobile: false,
|
|
setSidebarOpen: () => {},
|
|
collapsed: false,
|
|
peeking: false,
|
|
}));
|
|
|
|
vi.mock("@/lib/router", () => ({
|
|
NavLink: ({ children, to, className, ...props }: {
|
|
children: ReactNode | ((state: { isActive: boolean }) => ReactNode);
|
|
to: string;
|
|
className?: string | ((state: { isActive: boolean }) => string);
|
|
}) => {
|
|
const resolvedClassName = typeof className === "function" ? className({ isActive: false }) : className;
|
|
const resolvedChildren = typeof children === "function" ? children({ isActive: false }) : children;
|
|
return (
|
|
<a href={to} className={resolvedClassName} {...props}>
|
|
{resolvedChildren}
|
|
</a>
|
|
);
|
|
},
|
|
}));
|
|
|
|
vi.mock("../context/SidebarContext", () => ({
|
|
useSidebar: () => sidebarState,
|
|
}));
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
(globalThis as any).IS_REACT_ACT_ENVIRONMENT = true;
|
|
|
|
describe("SidebarNavItem", () => {
|
|
let container: HTMLDivElement;
|
|
let root: Root;
|
|
|
|
beforeEach(() => {
|
|
sidebarState.collapsed = false;
|
|
sidebarState.peeking = false;
|
|
container = document.createElement("div");
|
|
document.body.appendChild(container);
|
|
root = createRoot(container);
|
|
});
|
|
|
|
afterEach(() => {
|
|
act(() => {
|
|
root.unmount();
|
|
});
|
|
container.remove();
|
|
vi.clearAllMocks();
|
|
});
|
|
|
|
function render(node: ReactNode) {
|
|
act(() => {
|
|
root.render(<TooltipProvider>{node}</TooltipProvider>);
|
|
});
|
|
}
|
|
|
|
function link() {
|
|
return container.querySelector("a") as HTMLAnchorElement;
|
|
}
|
|
|
|
function classTokens(element: Element | null | undefined) {
|
|
return element?.className.toString().split(/\s+/).filter(Boolean) ?? [];
|
|
}
|
|
|
|
it("shows the full label and numeric badge when expanded", () => {
|
|
render(<SidebarNavItem to="/inbox" label="Inbox" icon={Inbox} badge={28} badgeLabel="unread" />);
|
|
|
|
const label = Array.from(container.querySelectorAll("span")).find((el) => el.textContent === "Inbox");
|
|
expect(label?.className).not.toContain("sr-only");
|
|
// The numeric badge is rendered in full (not a dot) and no rail aria-label is set.
|
|
expect(container.textContent).toContain("28");
|
|
expect(link().getAttribute("aria-label")).toBeNull();
|
|
});
|
|
|
|
it("clips the label (kept in flow for 1:1 row height) and collapses the badge to a dot in the rail", () => {
|
|
sidebarState.collapsed = true;
|
|
render(<SidebarNavItem to="/inbox" label="Inbox" icon={Inbox} badge={28} badgeLabel="unread" />);
|
|
|
|
// The label stays in the DOM/a11y tree (not display:none) so screen readers
|
|
// still announce it. Unlike sr-only it is kept IN FLOW (zero-width, clipped,
|
|
// transparent) so it still contributes its line-height — that keeps the row
|
|
// exactly as tall as the expanded state, so the icon never shifts (PAP-10676).
|
|
const label = Array.from(container.querySelectorAll("span")).find((el) => el.textContent === "Inbox");
|
|
expect(label).toBeTruthy();
|
|
expect(label?.className).not.toContain("sr-only");
|
|
expect(classTokens(label)).toContain("w-0");
|
|
expect(classTokens(label)).toContain("overflow-hidden");
|
|
|
|
// The numeric count is no longer rendered as text; it is a dot with an
|
|
// accessible text equivalent on the link.
|
|
expect(container.textContent).not.toContain("28 ");
|
|
expect(link().getAttribute("aria-label")).toBe("Inbox, 28 unread");
|
|
|
|
// Tooltip wraps the row; the trigger is the wrapper element so the NavLink's
|
|
// own flex className is preserved (PAP-10676), with the <a> nested inside it.
|
|
expect(link().parentElement?.getAttribute("data-slot")).toBe("tooltip-trigger");
|
|
});
|
|
|
|
it("surfaces the trailing status label in the rail aria-label", () => {
|
|
sidebarState.collapsed = true;
|
|
render(
|
|
<SidebarNavItem
|
|
to="/agents/codexcoder"
|
|
label="CodexCoder"
|
|
icon={Inbox}
|
|
trailing={<span aria-label="Invalid reporting chain" />}
|
|
trailingLabel="Invalid reporting chain"
|
|
/>,
|
|
);
|
|
|
|
// The trailing warning is hidden in the rail, so its text equivalent must
|
|
// ride on the link's accessible name.
|
|
expect(link().getAttribute("aria-label")).toBe("CodexCoder, Invalid reporting chain");
|
|
});
|
|
|
|
it("keeps the full presentation while peeking even when collapsed", () => {
|
|
sidebarState.collapsed = true;
|
|
sidebarState.peeking = true;
|
|
render(<SidebarNavItem to="/inbox" label="Inbox" icon={Inbox} badge={28} badgeLabel="unread" />);
|
|
|
|
const label = Array.from(container.querySelectorAll("span")).find((el) => el.textContent === "Inbox");
|
|
expect(label?.className).not.toContain("sr-only");
|
|
expect(container.textContent).toContain("28");
|
|
expect(link().getAttribute("aria-label")).toBeNull();
|
|
});
|
|
|
|
it("forces the full label inside an expanded contextual pane even when globally collapsed", () => {
|
|
// The takeover model collapses the global sidebar (collapsed=true) while the
|
|
// 240px SecondarySidebar still needs readable labels (PAP-10700). The
|
|
// provider must override the global rail collapse.
|
|
sidebarState.collapsed = true;
|
|
render(
|
|
<SidebarNavExpandedProvider>
|
|
<SidebarNavItem to="/inbox" label="Inbox" icon={Inbox} badge={28} badgeLabel="unread" />
|
|
</SidebarNavExpandedProvider>,
|
|
);
|
|
|
|
const label = Array.from(container.querySelectorAll("span")).find((el) => el.textContent === "Inbox");
|
|
expect(classTokens(label)).not.toContain("w-0");
|
|
expect(classTokens(label)).toContain("flex-1");
|
|
// Full numeric badge, no rail aria-label, no tooltip wrapper.
|
|
expect(container.textContent).toContain("28");
|
|
expect(link().getAttribute("aria-label")).toBeNull();
|
|
expect(link().parentElement?.getAttribute("data-slot")).not.toBe("tooltip-trigger");
|
|
});
|
|
|
|
it("surfaces the live count in the rail aria-label", () => {
|
|
sidebarState.collapsed = true;
|
|
render(<SidebarNavItem to="/dashboard" label="Dashboard" icon={Inbox} liveCount={3} />);
|
|
|
|
expect(link().getAttribute("aria-label")).toBe("Dashboard, 3 live");
|
|
});
|
|
});
|