mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-28 12:04:41 +01: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>
250 lines
8.1 KiB
TypeScript
250 lines
8.1 KiB
TypeScript
import { randomUUID } from "node:crypto";
|
|
import { afterAll, afterEach, beforeAll, describe, expect, it } from "vitest";
|
|
import { eq } from "drizzle-orm";
|
|
import {
|
|
agents,
|
|
companies,
|
|
createDb,
|
|
heartbeatRuns,
|
|
issueThreadInteractions,
|
|
issues,
|
|
} from "@paperclipai/db";
|
|
import {
|
|
getEmbeddedPostgresTestSupport,
|
|
startEmbeddedPostgresTestDatabase,
|
|
} from "./helpers/embedded-postgres.js";
|
|
import {
|
|
changeConsentGateService,
|
|
skillChangeTargetKey,
|
|
} from "../services/change-consent-gate.js";
|
|
|
|
const embeddedPostgresSupport = await getEmbeddedPostgresTestSupport();
|
|
const describeEmbeddedPostgres = embeddedPostgresSupport.supported ? describe : describe.skip;
|
|
|
|
describeEmbeddedPostgres("changeConsentGateService", () => {
|
|
let db!: ReturnType<typeof createDb>;
|
|
let tempDb: Awaited<ReturnType<typeof startEmbeddedPostgresTestDatabase>> | null = null;
|
|
|
|
beforeAll(async () => {
|
|
tempDb = await startEmbeddedPostgresTestDatabase("paperclip-reflection-coach-gate-");
|
|
db = createDb(tempDb.connectionString);
|
|
}, 20_000);
|
|
|
|
afterEach(async () => {
|
|
await db.delete(issueThreadInteractions);
|
|
await db.delete(issues);
|
|
await db.delete(heartbeatRuns);
|
|
await db.delete(agents);
|
|
await db.delete(companies);
|
|
});
|
|
|
|
afterAll(async () => {
|
|
await tempDb?.cleanup();
|
|
});
|
|
|
|
async function seedGateFixture() {
|
|
const companyId = randomUUID();
|
|
const coachId = randomUUID();
|
|
const sourceRunId = randomUUID();
|
|
const proposalIssueId = randomUUID();
|
|
const skillId = randomUUID();
|
|
const targetKey = skillChangeTargetKey(skillId);
|
|
|
|
await db.insert(companies).values({
|
|
id: companyId,
|
|
name: "Paperclip",
|
|
issuePrefix: "PAP",
|
|
defaultResponsibleUserId: "board-user",
|
|
});
|
|
await db.insert(agents).values({
|
|
id: coachId,
|
|
companyId,
|
|
name: "Reflection Coach",
|
|
role: "general",
|
|
adapterType: "codex_local",
|
|
adapterConfig: {},
|
|
runtimeConfig: {},
|
|
permissions: { canCreateSkills: true },
|
|
});
|
|
await db.insert(heartbeatRuns).values({
|
|
id: sourceRunId,
|
|
companyId,
|
|
agentId: coachId,
|
|
status: "succeeded",
|
|
});
|
|
await db.insert(issues).values({
|
|
id: proposalIssueId,
|
|
companyId,
|
|
title: "Review Reflection Coach proposal",
|
|
status: "in_review",
|
|
priority: "medium",
|
|
identifier: "PAP-1",
|
|
issueNumber: 1,
|
|
createdByAgentId: coachId,
|
|
});
|
|
|
|
return { companyId, coachId, sourceRunId, proposalIssueId, skillId, targetKey };
|
|
}
|
|
|
|
it("rejects Reflection Coach skill mutation without an accepted bound interaction", async () => {
|
|
const { companyId, coachId, targetKey } = await seedGateFixture();
|
|
|
|
await expect(changeConsentGateService(db).assertConsented({
|
|
companyId,
|
|
actorAgentId: coachId,
|
|
actorRunId: randomUUID(),
|
|
targetKeys: [targetKey],
|
|
})).rejects.toMatchObject({
|
|
status: 403,
|
|
details: { code: "reflection_coach_mutation_gate_required" },
|
|
});
|
|
});
|
|
|
|
it("rejects accepted interactions from the same run as the apply mutation", async () => {
|
|
const { companyId, coachId, sourceRunId, proposalIssueId, targetKey } = await seedGateFixture();
|
|
await db.insert(issueThreadInteractions).values({
|
|
id: randomUUID(),
|
|
companyId,
|
|
issueId: proposalIssueId,
|
|
kind: "request_confirmation",
|
|
status: "accepted",
|
|
continuationPolicy: "wake_assignee_on_accept",
|
|
sourceRunId,
|
|
createdByAgentId: coachId,
|
|
payload: {
|
|
version: 1,
|
|
prompt: "Apply this Reflection Coach skill diff?",
|
|
detailsMarkdown: "```diff\n+Tighten the workflow.\n```",
|
|
target: { type: "custom", key: targetKey, revisionId: "proposal-v1" },
|
|
},
|
|
result: { version: 1, outcome: "accepted" },
|
|
resolvedByUserId: "board-user",
|
|
resolvedAt: new Date(),
|
|
});
|
|
|
|
await expect(changeConsentGateService(db).assertConsented({
|
|
companyId,
|
|
actorAgentId: coachId,
|
|
actorRunId: sourceRunId,
|
|
targetKeys: [targetKey],
|
|
})).rejects.toMatchObject({
|
|
status: 403,
|
|
details: { code: "reflection_coach_mutation_gate_required" },
|
|
});
|
|
});
|
|
|
|
it("allows a previous-run accepted interaction with a displayed diff for the bound target", async () => {
|
|
const { companyId, coachId, sourceRunId, proposalIssueId, targetKey } = await seedGateFixture();
|
|
const interactionId = randomUUID();
|
|
await db.insert(issueThreadInteractions).values({
|
|
id: interactionId,
|
|
companyId,
|
|
issueId: proposalIssueId,
|
|
kind: "request_confirmation",
|
|
status: "accepted",
|
|
continuationPolicy: "wake_assignee_on_accept",
|
|
sourceRunId,
|
|
createdByAgentId: coachId,
|
|
payload: {
|
|
version: 1,
|
|
prompt: "Apply this Reflection Coach skill diff?",
|
|
detailsMarkdown: "```diff\n+Tighten the workflow.\n```",
|
|
target: { type: "custom", key: targetKey, revisionId: "proposal-v1" },
|
|
},
|
|
result: { version: 1, outcome: "accepted" },
|
|
resolvedByUserId: "board-user",
|
|
resolvedAt: new Date(),
|
|
});
|
|
const actorRunId = randomUUID();
|
|
|
|
await expect(changeConsentGateService(db).assertConsented({
|
|
companyId,
|
|
actorAgentId: coachId,
|
|
actorRunId,
|
|
targetKeys: [targetKey],
|
|
})).resolves.toBe(true);
|
|
|
|
const [stored] = await db
|
|
.select({ result: issueThreadInteractions.result })
|
|
.from(issueThreadInteractions)
|
|
.where(eq(issueThreadInteractions.id, interactionId));
|
|
|
|
expect(stored?.result).toMatchObject({
|
|
consumedByRunId: actorRunId,
|
|
outcome: "accepted",
|
|
version: 1,
|
|
});
|
|
expect((stored?.result as { consumedAt?: unknown } | undefined)?.consumedAt).toEqual(expect.any(String));
|
|
});
|
|
|
|
it("rejects reusing an accepted interaction after it is consumed by a mutation", async () => {
|
|
const { companyId, coachId, sourceRunId, proposalIssueId, targetKey } = await seedGateFixture();
|
|
await db.insert(issueThreadInteractions).values({
|
|
id: randomUUID(),
|
|
companyId,
|
|
issueId: proposalIssueId,
|
|
kind: "request_confirmation",
|
|
status: "accepted",
|
|
continuationPolicy: "wake_assignee_on_accept",
|
|
sourceRunId,
|
|
createdByAgentId: coachId,
|
|
payload: {
|
|
version: 1,
|
|
prompt: "Apply this Reflection Coach skill diff?",
|
|
detailsMarkdown: "```diff\n+Tighten the workflow.\n```",
|
|
target: { type: "custom", key: targetKey, revisionId: "proposal-v1" },
|
|
},
|
|
result: { version: 1, outcome: "accepted" },
|
|
resolvedByUserId: "board-user",
|
|
resolvedAt: new Date(),
|
|
});
|
|
|
|
await expect(changeConsentGateService(db).assertConsented({
|
|
companyId,
|
|
actorAgentId: coachId,
|
|
actorRunId: randomUUID(),
|
|
targetKeys: [targetKey],
|
|
})).resolves.toBe(true);
|
|
|
|
await expect(changeConsentGateService(db).assertConsented({
|
|
companyId,
|
|
actorAgentId: coachId,
|
|
actorRunId: randomUUID(),
|
|
targetKeys: [targetKey],
|
|
})).rejects.toMatchObject({
|
|
status: 403,
|
|
details: { code: "reflection_coach_mutation_gate_required" },
|
|
});
|
|
});
|
|
|
|
it("allows legacy Reflection Coach target keys for durable accepted interactions", async () => {
|
|
const { companyId, coachId, sourceRunId, proposalIssueId, skillId, targetKey } = await seedGateFixture();
|
|
await db.insert(issueThreadInteractions).values({
|
|
id: randomUUID(),
|
|
companyId,
|
|
issueId: proposalIssueId,
|
|
kind: "request_confirmation",
|
|
status: "accepted",
|
|
continuationPolicy: "wake_assignee_on_accept",
|
|
sourceRunId,
|
|
createdByAgentId: coachId,
|
|
payload: {
|
|
version: 1,
|
|
prompt: "Apply this Reflection Coach skill diff?",
|
|
detailsMarkdown: "```diff\n+Tighten the workflow.\n```",
|
|
target: { type: "custom", key: `reflection-coach:company-skill:${skillId}`, revisionId: "proposal-v1" },
|
|
},
|
|
result: { version: 1, outcome: "accepted" },
|
|
resolvedByUserId: "board-user",
|
|
resolvedAt: new Date(),
|
|
});
|
|
|
|
await expect(changeConsentGateService(db).assertConsented({
|
|
companyId,
|
|
actorAgentId: coachId,
|
|
actorRunId: randomUUID(),
|
|
targetKeys: [targetKey],
|
|
})).resolves.toBe(true);
|
|
});
|
|
});
|