mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-01 06:42:06 +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>
296 lines
10 KiB
TypeScript
296 lines
10 KiB
TypeScript
import { and, asc, eq, inArray, sql } from "drizzle-orm";
|
|
import type { Db } from "@paperclipai/db";
|
|
import { approvalComments, approvals } from "@paperclipai/db";
|
|
import { notFound, unprocessable } from "../errors.js";
|
|
import { redactCurrentUserText } from "../log-redaction.js";
|
|
import { agentService } from "./agents.js";
|
|
import { budgetService } from "./budgets.js";
|
|
import { notifyHireApproved } from "./hire-hook.js";
|
|
import { instanceSettingsService } from "./instance-settings.js";
|
|
|
|
export function approvalService(db: Db) {
|
|
const agentsSvc = agentService(db);
|
|
const budgets = budgetService(db);
|
|
const instanceSettings = instanceSettingsService(db);
|
|
const canResolveStatuses = new Set(["pending", "revision_requested"]);
|
|
const resolvableStatuses = Array.from(canResolveStatuses);
|
|
type ApprovalRecord = typeof approvals.$inferSelect;
|
|
type ResolutionResult = { approval: ApprovalRecord; applied: boolean };
|
|
|
|
function redactApprovalComment<T extends { body: string }>(comment: T, censorUsernameInLogs: boolean): T {
|
|
return {
|
|
...comment,
|
|
body: redactCurrentUserText(comment.body, { enabled: censorUsernameInLogs }),
|
|
};
|
|
}
|
|
|
|
async function reconcileApprovedBuiltInAgent(companyId: string, payload: Record<string, unknown>) {
|
|
const sourceBuiltInAgentKey = typeof payload.sourceBuiltInAgentKey === "string" ? payload.sourceBuiltInAgentKey : null;
|
|
if (!sourceBuiltInAgentKey) return;
|
|
const { builtInAgentService } = await import("./built-in-agents.js");
|
|
await builtInAgentService(db).ensure(companyId, sourceBuiltInAgentKey);
|
|
}
|
|
|
|
async function getExistingApproval(id: string) {
|
|
const existing = await db
|
|
.select()
|
|
.from(approvals)
|
|
.where(eq(approvals.id, id))
|
|
.then((rows) => rows[0] ?? null);
|
|
if (!existing) throw notFound("Approval not found");
|
|
return existing;
|
|
}
|
|
|
|
async function resolveApproval(
|
|
id: string,
|
|
targetStatus: "approved" | "rejected",
|
|
decidedByUserId: string,
|
|
decisionNote: string | null | undefined,
|
|
): Promise<ResolutionResult> {
|
|
const existing = await getExistingApproval(id);
|
|
if (!canResolveStatuses.has(existing.status)) {
|
|
if (existing.status === targetStatus) {
|
|
return { approval: existing, applied: false };
|
|
}
|
|
throw unprocessable(
|
|
`Only pending or revision requested approvals can be ${targetStatus === "approved" ? "approved" : "rejected"}`,
|
|
);
|
|
}
|
|
|
|
const now = new Date();
|
|
const updated = await db
|
|
.update(approvals)
|
|
.set({
|
|
status: targetStatus,
|
|
decidedByUserId,
|
|
decisionNote: decisionNote ?? null,
|
|
decidedAt: now,
|
|
updatedAt: now,
|
|
})
|
|
.where(and(eq(approvals.id, id), inArray(approvals.status, resolvableStatuses)))
|
|
.returning()
|
|
.then((rows) => rows[0] ?? null);
|
|
|
|
if (updated) {
|
|
return { approval: updated, applied: true };
|
|
}
|
|
|
|
const latest = await getExistingApproval(id);
|
|
if (latest.status === targetStatus) {
|
|
return { approval: latest, applied: false };
|
|
}
|
|
|
|
throw unprocessable(
|
|
`Only pending or revision requested approvals can be ${targetStatus === "approved" ? "approved" : "rejected"}`,
|
|
);
|
|
}
|
|
|
|
return {
|
|
list: (companyId: string, status?: string) => {
|
|
const conditions = [eq(approvals.companyId, companyId)];
|
|
if (status) conditions.push(eq(approvals.status, status));
|
|
return db.select().from(approvals).where(and(...conditions));
|
|
},
|
|
|
|
getById: (id: string) =>
|
|
db
|
|
.select()
|
|
.from(approvals)
|
|
.where(eq(approvals.id, id))
|
|
.then((rows) => rows[0] ?? null),
|
|
|
|
findOpenHireApprovalForAgent: async (companyId: string, agentId: string) => {
|
|
const rows = await db
|
|
.select()
|
|
.from(approvals)
|
|
.where(
|
|
and(
|
|
eq(approvals.companyId, companyId),
|
|
eq(approvals.type, "hire_agent"),
|
|
inArray(approvals.status, resolvableStatuses),
|
|
sql`${approvals.payload} ->> 'agentId' = ${agentId}`,
|
|
),
|
|
);
|
|
return rows[0] ?? null;
|
|
},
|
|
|
|
create: (companyId: string, data: Omit<typeof approvals.$inferInsert, "companyId">) =>
|
|
db
|
|
.insert(approvals)
|
|
.values({ ...data, companyId })
|
|
.returning()
|
|
.then((rows) => rows[0]),
|
|
|
|
approve: async (id: string, decidedByUserId: string, decisionNote?: string | null) => {
|
|
const { approval: updated, applied } = await resolveApproval(
|
|
id,
|
|
"approved",
|
|
decidedByUserId,
|
|
decisionNote,
|
|
);
|
|
|
|
let hireApprovedAgentId: string | null = null;
|
|
const now = new Date();
|
|
if (applied && updated.type === "hire_agent") {
|
|
const payload = updated.payload as Record<string, unknown>;
|
|
const payloadAgentId = typeof payload.agentId === "string" ? payload.agentId : null;
|
|
if (payloadAgentId) {
|
|
await agentsSvc.activatePendingApproval(payloadAgentId, payload);
|
|
await reconcileApprovedBuiltInAgent(updated.companyId, payload);
|
|
hireApprovedAgentId = payloadAgentId;
|
|
} else {
|
|
const created = await agentsSvc.create(updated.companyId, {
|
|
name: String(payload.name ?? "New Agent"),
|
|
role: String(payload.role ?? "general"),
|
|
title: typeof payload.title === "string" ? payload.title : null,
|
|
reportsTo: typeof payload.reportsTo === "string" ? payload.reportsTo : null,
|
|
capabilities: typeof payload.capabilities === "string" ? payload.capabilities : null,
|
|
adapterType: String(payload.adapterType ?? "process"),
|
|
adapterConfig:
|
|
typeof payload.adapterConfig === "object" && payload.adapterConfig !== null
|
|
? (payload.adapterConfig as Record<string, unknown>)
|
|
: {},
|
|
budgetMonthlyCents:
|
|
typeof payload.budgetMonthlyCents === "number" ? payload.budgetMonthlyCents : 0,
|
|
metadata:
|
|
typeof payload.metadata === "object" && payload.metadata !== null
|
|
? (payload.metadata as Record<string, unknown>)
|
|
: null,
|
|
status: "idle",
|
|
spentMonthlyCents: 0,
|
|
permissions: undefined,
|
|
lastHeartbeatAt: null,
|
|
});
|
|
hireApprovedAgentId = created?.id ?? null;
|
|
}
|
|
if (hireApprovedAgentId) {
|
|
const budgetMonthlyCents =
|
|
typeof payload.budgetMonthlyCents === "number" ? payload.budgetMonthlyCents : 0;
|
|
if (budgetMonthlyCents > 0) {
|
|
await budgets.upsertPolicy(
|
|
updated.companyId,
|
|
{
|
|
scopeType: "agent",
|
|
scopeId: hireApprovedAgentId,
|
|
amount: budgetMonthlyCents,
|
|
windowKind: "calendar_month_utc",
|
|
},
|
|
decidedByUserId,
|
|
);
|
|
}
|
|
void notifyHireApproved(db, {
|
|
companyId: updated.companyId,
|
|
agentId: hireApprovedAgentId,
|
|
source: "approval",
|
|
sourceId: id,
|
|
approvedAt: now,
|
|
}).catch(() => {});
|
|
}
|
|
}
|
|
|
|
return { approval: updated, applied };
|
|
},
|
|
|
|
reject: async (id: string, decidedByUserId: string, decisionNote?: string | null) => {
|
|
const { approval: updated, applied } = await resolveApproval(
|
|
id,
|
|
"rejected",
|
|
decidedByUserId,
|
|
decisionNote,
|
|
);
|
|
|
|
if (applied && updated.type === "hire_agent") {
|
|
const payload = updated.payload as Record<string, unknown>;
|
|
const payloadAgentId = typeof payload.agentId === "string" ? payload.agentId : null;
|
|
if (payloadAgentId) {
|
|
await agentsSvc.terminate(payloadAgentId);
|
|
}
|
|
}
|
|
|
|
return { approval: updated, applied };
|
|
},
|
|
|
|
requestRevision: async (id: string, decidedByUserId: string, decisionNote?: string | null) => {
|
|
const existing = await getExistingApproval(id);
|
|
if (existing.status !== "pending") {
|
|
throw unprocessable("Only pending approvals can request revision");
|
|
}
|
|
|
|
const now = new Date();
|
|
return db
|
|
.update(approvals)
|
|
.set({
|
|
status: "revision_requested",
|
|
decidedByUserId,
|
|
decisionNote: decisionNote ?? null,
|
|
decidedAt: now,
|
|
updatedAt: now,
|
|
})
|
|
.where(eq(approvals.id, id))
|
|
.returning()
|
|
.then((rows) => rows[0]);
|
|
},
|
|
|
|
resubmit: async (id: string, payload?: Record<string, unknown>) => {
|
|
const existing = await getExistingApproval(id);
|
|
if (existing.status !== "revision_requested") {
|
|
throw unprocessable("Only revision requested approvals can be resubmitted");
|
|
}
|
|
|
|
const now = new Date();
|
|
return db
|
|
.update(approvals)
|
|
.set({
|
|
status: "pending",
|
|
payload: payload ?? existing.payload,
|
|
decisionNote: null,
|
|
decidedByUserId: null,
|
|
decidedAt: null,
|
|
updatedAt: now,
|
|
})
|
|
.where(eq(approvals.id, id))
|
|
.returning()
|
|
.then((rows) => rows[0]);
|
|
},
|
|
|
|
listComments: async (approvalId: string) => {
|
|
const existing = await getExistingApproval(approvalId);
|
|
const { censorUsernameInLogs } = await instanceSettings.getGeneral();
|
|
return db
|
|
.select()
|
|
.from(approvalComments)
|
|
.where(
|
|
and(
|
|
eq(approvalComments.approvalId, approvalId),
|
|
eq(approvalComments.companyId, existing.companyId),
|
|
),
|
|
)
|
|
.orderBy(asc(approvalComments.createdAt))
|
|
.then((comments) => comments.map((comment) => redactApprovalComment(comment, censorUsernameInLogs)));
|
|
},
|
|
|
|
addComment: async (
|
|
approvalId: string,
|
|
body: string,
|
|
actor: { agentId?: string; userId?: string },
|
|
) => {
|
|
const existing = await getExistingApproval(approvalId);
|
|
const currentUserRedactionOptions = {
|
|
enabled: (await instanceSettings.getGeneral()).censorUsernameInLogs,
|
|
};
|
|
const redactedBody = redactCurrentUserText(body, currentUserRedactionOptions);
|
|
return db
|
|
.insert(approvalComments)
|
|
.values({
|
|
companyId: existing.companyId,
|
|
approvalId,
|
|
authorAgentId: actor.agentId ?? null,
|
|
authorUserId: actor.userId ?? null,
|
|
body: redactedBody,
|
|
})
|
|
.returning()
|
|
.then((rows) => redactApprovalComment(rows[0], currentUserRedactionOptions.enabled));
|
|
},
|
|
};
|
|
}
|