Files
PaperClipAI/ui/src/components/BuiltInBundlePanel.test.tsx
T
DottaandPaperclip 8b6a06ee25 [codex] Add built-in agents and Reflection Coach bundle (#9206)
## 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>
2026-07-09 16:29:30 -05:00

240 lines
8.8 KiB
TypeScript

// @vitest-environment jsdom
import { flushSync } from "react-dom";
import { createRoot, type Root } from "react-dom/client";
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
import { BuiltInBundlePanel } from "./BuiltInBundlePanel";
import type {
BuiltInAgentState,
BuiltInManagedResourceState,
BuiltInManagedResourceStockStatus,
} from "@/api/builtInAgents";
// The panel links to agent tabs via `@/lib/router` (company-prefixed Link).
// Stub it to a plain anchor so the panel test doesn't need CompanyContext.
vi.mock("@/lib/router", () => ({
Link: ({ children, to }: { children: React.ReactNode; to: string }) => <a href={to}>{children}</a>,
}));
function resource(
resourceKind: BuiltInManagedResourceState["resourceKind"],
stockStatus: BuiltInManagedResourceStockStatus,
overrides: Partial<BuiltInManagedResourceState> = {},
): BuiltInManagedResourceState {
return {
resourceKind,
resourceKey: resourceKind === "skill" ? "reflection-coach" : resourceKind === "routine" ? "recent-agent-reflection" : "AGENTS.md",
resourceId: "res-1",
stockVersion: "2026-07-08",
stockHash: "aaaa",
currentHash: stockStatus === "missing" ? null : stockStatus === "stock_current" ? "aaaa" : "bbbb",
stockStatus,
updateAvailable: stockStatus === "stock_update_available" || stockStatus === "operator_modified",
resetAvailable: stockStatus !== "stock_current",
...overrides,
};
}
function makeState(
status: BuiltInAgentState["status"],
resources: BuiltInManagedResourceState[],
): BuiltInAgentState {
return {
definition: {
key: "reflection-coach",
displayName: "Reflection Coach",
featureKeys: ["reflection"],
shortPurpose: "Coaches recent agents.",
defaultInstructions: "…",
defaultRole: "general",
allowedAdapterTypes: ["codex_local"],
defaultBudgetMonthlyCents: 0,
bundle: {
stockVersion: "2026-07-08",
instructions: { entryFile: "AGENTS.md", files: ["AGENTS.md"] },
skill: {
skillKey: "reflection-coach",
displayName: "reflection-coach",
slug: "reflection-coach",
canonicalKey: "paperclipai/bundled/paperclip-operations/reflection-coach",
files: ["reflection-coach/SKILL.md"],
},
routine: {
routineKey: "recent-agent-reflection",
title: "Recent agent reflection",
status: "paused",
triggerCount: 1,
scheduleLabel: "Weekly · Mon 09:00 UTC",
},
},
},
status,
agentId: "agent-1",
// eslint-disable-next-line @typescript-eslint/no-explicit-any
agent: { id: "agent-1", pausedAt: status === "paused" ? new Date().toISOString() : null } as any,
pauseReason: null,
resources,
};
}
async function flushReact() {
for (let index = 0; index < 5; index += 1) {
await Promise.resolve();
await new Promise((resolve) => window.setTimeout(resolve, 0));
}
flushSync(() => {});
}
const READY_RESOURCES = [
resource("skill", "stock_current"),
resource("instructions", "stock_current"),
resource("routine", "stock_current"),
];
describe("BuiltInBundlePanel (PAP-13099)", () => {
let container: HTMLDivElement;
let root: Root | null = null;
function render(state: BuiltInAgentState, handlers: Partial<{
onConfigure: () => void;
onResetResource: (kind: BuiltInManagedResourceState["resourceKind"]) => void;
onRunRoutine: (routineKey: string) => void;
onEnableSchedule: (routineKey: string) => void;
onDisableSchedule: (routineKey: string) => void;
}> = {}) {
root = createRoot(container);
flushSync(() => {
root!.render(
<BuiltInBundlePanel
state={state}
agentRef="reflectioncoach"
onConfigure={handlers.onConfigure ?? (() => {})}
onResetResource={handlers.onResetResource ?? (() => {})}
onRunRoutine={handlers.onRunRoutine ?? (() => {})}
onEnableSchedule={handlers.onEnableSchedule ?? (() => {})}
onDisableSchedule={handlers.onDisableSchedule ?? (() => {})}
/>,
);
});
}
beforeEach(() => {
container = document.createElement("div");
document.body.appendChild(container);
});
afterEach(() => {
flushSync(() => root?.unmount());
root = null;
container.remove();
// Radix portals dialog content onto body; clear leftovers between tests.
document.body.querySelectorAll("[data-slot='alert-dialog-portal']").forEach((node) => node.remove());
});
it("renders four resource rows with ready + schedule-off chips when healthy", () => {
render(makeState("ready", READY_RESOURCES));
const text = container.textContent ?? "";
expect(text).toContain("Bundle status");
expect(text).toContain("Adapter");
expect(text).toContain("Skill");
expect(text).toContain("Instructions");
expect(text).toContain("Routine");
// Zero-token guarantee copy is always present on the routine row.
expect(text).toContain("costs zero tokens by default");
expect(text).toContain("Schedule off");
expect(text).toContain("Ready");
expect(text).toContain("Run once");
expect(text).toContain("Enable weekly");
});
it("shows the active weekly schedule and disable action when enabled", () => {
render(makeState("ready", [
resource("skill", "stock_current"),
resource("instructions", "stock_current"),
resource("routine", "stock_current", { scheduleEnabled: true }),
]));
const text = container.textContent ?? "";
expect(text).toContain("Weekly · Mon 09:00 UTC");
expect(text).toContain("can create background work");
expect(text).toContain("Disable schedule");
expect(text).not.toContain("Enable weekly");
});
it("links to a pending proposal interaction when the routine resource reports one", () => {
render(makeState("ready", [
resource("skill", "stock_current"),
resource("instructions", "stock_current"),
resource("routine", "stock_current", {
pendingUpdateInteractionId: "interaction-1",
pendingUpdateIssueId: "issue-1",
pendingUpdateIssueIdentifier: "PAP-42",
}),
]));
const link = Array.from(container.querySelectorAll("a")).find((anchor) => anchor.textContent === "Review proposal");
expect(container.textContent).toContain("Proposal pending");
expect(link?.getAttribute("href")).toBe("/issues/PAP-42#interaction-interaction-1");
});
it("shows Needs setup for the adapter when the agent is not configured yet", () => {
render(makeState("needs_setup", READY_RESOURCES));
const text = container.textContent ?? "";
expect(text).toContain("Needs setup");
expect(text).toContain("Pick an adapter this coach can run on");
});
it("surfaces an update-available chip and Update action for unedited stock drift", () => {
render(makeState("ready", [
resource("skill", "stock_current"),
resource("instructions", "stock_update_available"),
resource("routine", "stock_current"),
]));
const text = container.textContent ?? "";
expect(text).toContain("Update available");
expect(text).toContain("Paperclip shipped a newer default");
// The per-resource Update trigger button is present.
const buttons = Array.from(container.querySelectorAll("button")).map((b) => b.textContent);
expect(buttons).toContain("Update");
});
it("surfaces a Drifted chip and Reset action for operator-modified resources", () => {
render(makeState("ready", [
resource("skill", "operator_modified"),
resource("instructions", "stock_current"),
resource("routine", "stock_current"),
]));
const text = container.textContent ?? "";
expect(text).toContain("Drifted");
expect(text).toContain("Your changes are kept");
const buttons = Array.from(container.querySelectorAll("button")).map((b) => b.textContent);
expect(buttons).toContain("Reset");
});
it("shows a Missing chip when a resource is not materialized", () => {
render(makeState("ready", [
resource("skill", "missing"),
resource("instructions", "stock_current"),
resource("routine", "stock_current"),
]));
expect(container.textContent).toContain("Missing");
});
it("fires onConfigure when the adapter Configure button is clicked", () => {
const onConfigure = vi.fn();
render(makeState("needs_setup", READY_RESOURCES), { onConfigure });
const configureBtn = Array.from(container.querySelectorAll("button")).find(
(b) => b.textContent === "Configure",
);
expect(configureBtn).toBeTruthy();
flushSync(() => configureBtn!.dispatchEvent(new MouseEvent("click", { bubbles: true })));
expect(onConfigure).toHaveBeenCalledTimes(1);
});
it("renders nothing for a built-in without a bundle", () => {
const flat = makeState("ready", READY_RESOURCES);
delete flat.definition.bundle;
render(flat);
expect(container.textContent).toBe("");
});
});