mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-27 02:44:50 +01:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - The Skills Manager gives operators a reusable skill layer, but iteration still required manual edits, ad hoc prompts, and indirect run inspection. > - Skill authors need a focused workflow for editing skill files, saving representative test inputs, and running those inputs through an agent without exposing harness tasks as normal company work. > - The backend therefore needs durable test inputs, reusable run templates, hidden harness issues, scoped run execution, retention metadata, and read-containment rules around hidden work. > - The frontend needs a three-pane Studio that keeps skill files, saved inputs/templates, and run output/history visible together while preserving the existing design system and token rules. > - This pull request ships that Skill Studio surface end to end: database migrations, shared contracts, server APIs/services, hidden harness execution behavior, UI routes/components, and focused tests. > - The benefit is faster and safer skill iteration, with inspectable outputs and fewer ways for internal harness work to leak into normal task lists, costs, or adjacent read APIs. ## Linked Issues or Issue Description No public GitHub issue exists for this feature. Feature request summary: - Problem: Skill authors need to edit and test company skills in one place instead of switching between the skill detail page, task creation, run output, and manual prompt history. - Proposed solution: Add a Skill Studio workbench with saved inputs, reusable templates, hidden sandboxed test runs, live run status, output inspection, run history, rerun/delete controls, and frontmatter-aware editing. - Expected users: Paperclip operators and agent-company maintainers who create, fork, import, and tune skills. - Related public PRs: Supersedes #9205, which was replaced so the public PR branch name follows contributor policy. - Duplicate search: searched public GitHub issues and PRs for "Skill Studio"; no other active public issue or PR directly covers this feature. ## What Changed - Added database migrations for Skill Studio test inputs, test runs, test run retention, and reusable run templates. - Added shared Skill Studio types, validators, route helpers, frontmatter utilities, and status handling. - Added server services and routes for saved inputs, test runs, templates, reruns, terminal-run deletion, hidden harness issue execution, and run-detail hydration. - Strengthened hidden-issue read containment across issue-adjacent routes and cost rollups used by skill test harness work. - Added the Skill Studio UI with skill file editing, frontmatter editing, saved inputs, templates, run creation/cancel/rerun/delete flows, output rendering, history, route support, and responsive pane behavior. - Added focused backend, shared, and UI tests for the new APIs, routing logic, editor/run behavior, hidden-issue containment, and migration safety. - Rebased onto current `master`, removed the generated lockfile diff from the PR, and verified no workflow files are changed. ## Verification - [x] `pnpm --filter @paperclipai/db check:migrations` - [x] `pnpm check:token-gates` - [x] `pnpm exec vitest run server/src/__tests__/company-skills-service.test.ts server/src/__tests__/company-skills-routes.test.ts server/src/__tests__/company-skill-test-runs-service.test.ts ui/src/lib/skill-studio.test.ts ui/src/pages/SkillStudio.test.tsx` — 5 files, 132 tests passed - [x] Greptile review on the latest PR head - [x] GitHub PR checks on the latest PR head ## Risks - Medium risk because this is a broad feature touching database schema, server orchestration, issue visibility, and a large UI surface. - Hidden harness issue containment is security-sensitive; this PR includes regression coverage for adjacent read paths and cost rollups. - The new migrations are additive and use idempotent guards where applicable, but deployed databases that previously tested draft migration numbers should still be checked carefully. - The UI depends on a new resizable panels package in `ui/package.json`; the lockfile is intentionally left to repository automation. > 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 OpenAI Codex, GPT-5 coding agent with shell, git, and GitHub CLI tool use. Earlier feature commits include assistance from other Paperclip coding agents; this PR preparation, rebase, cleanup commit, and PR body were completed by OpenAI Codex in a Paperclip worktree. ## 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> Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
382 lines
12 KiB
TypeScript
382 lines
12 KiB
TypeScript
import { createHash, createHmac, randomUUID } from "node:crypto";
|
|
import express from "express";
|
|
import request from "supertest";
|
|
import { afterEach, beforeEach, describe, expect, it } from "vitest";
|
|
import {
|
|
activityLog,
|
|
agentApiKeys,
|
|
agents,
|
|
boardApiKeys,
|
|
heartbeatRuns,
|
|
} from "@paperclipai/db";
|
|
import { actorMiddleware } from "../middleware/auth.js";
|
|
import { errorHandler } from "../middleware/error-handler.js";
|
|
import { createLocalAgentJwt } from "../agent-auth-jwt.js";
|
|
import { assertCompanyAccess } from "../routes/authz.js";
|
|
|
|
function hashToken(token: string) {
|
|
return createHash("sha256").update(token).digest("hex");
|
|
}
|
|
|
|
function createSelectChain(rowsForTable: (table: unknown) => unknown[]) {
|
|
return {
|
|
from(table: unknown) {
|
|
return {
|
|
where() {
|
|
return Promise.resolve(rowsForTable(table));
|
|
},
|
|
};
|
|
},
|
|
};
|
|
}
|
|
|
|
function createDbState(input: {
|
|
agent: { id: string; companyId: string; status?: string };
|
|
agentKey?: { id: string; agentId: string; companyId: string; keyHash: string; responsibleUserId?: string | null };
|
|
run?: { id: string; companyId: string; agentId: string; responsibleUserId?: string | null };
|
|
}) {
|
|
const activity: Array<Record<string, unknown>> = [];
|
|
const agentRow = {
|
|
id: input.agent.id,
|
|
companyId: input.agent.companyId,
|
|
status: input.agent.status ?? "active",
|
|
};
|
|
const keyRow = input.agentKey
|
|
? {
|
|
id: input.agentKey.id,
|
|
agentId: input.agentKey.agentId,
|
|
companyId: input.agentKey.companyId,
|
|
keyHash: input.agentKey.keyHash,
|
|
responsibleUserId: input.agentKey.responsibleUserId ?? null,
|
|
revokedAt: null,
|
|
scopeConfig: null,
|
|
}
|
|
: null;
|
|
const runRow = input.run
|
|
? {
|
|
id: input.run.id,
|
|
companyId: input.run.companyId,
|
|
agentId: input.run.agentId,
|
|
responsibleUserId: input.run.responsibleUserId ?? null,
|
|
}
|
|
: null;
|
|
|
|
const db = {
|
|
select: () =>
|
|
createSelectChain((table) => {
|
|
if (table === boardApiKeys) return [];
|
|
if (table === agentApiKeys) return keyRow ? [keyRow] : [];
|
|
if (table === agents) return [agentRow];
|
|
if (table === heartbeatRuns) return runRow ? [runRow] : [];
|
|
return [];
|
|
}),
|
|
update: () => ({
|
|
set() {
|
|
return {
|
|
where() {
|
|
return Promise.resolve([]);
|
|
},
|
|
};
|
|
},
|
|
}),
|
|
insert: (table: unknown) => ({
|
|
values(values: Record<string, unknown>) {
|
|
if (table === activityLog) activity.push(values);
|
|
return Promise.resolve([]);
|
|
},
|
|
}),
|
|
} as any;
|
|
|
|
return { db, activity };
|
|
}
|
|
|
|
function createApp(db: any) {
|
|
const app = express();
|
|
app.use(express.json());
|
|
app.use(
|
|
actorMiddleware(db, {
|
|
deploymentMode: "authenticated",
|
|
resolveSession: async () => null,
|
|
}),
|
|
);
|
|
app.get("/actor", (req, res) => {
|
|
res.json(req.actor);
|
|
});
|
|
app.get("/companies/:companyId/protected", (req, res) => {
|
|
assertCompanyAccess(req, req.params.companyId);
|
|
res.json({ ok: true });
|
|
});
|
|
app.get("/companies/:companyId/issues/:issueId", (req, res) => {
|
|
assertCompanyAccess(req, req.params.companyId);
|
|
res.json({ id: req.params.issueId, readable: true });
|
|
});
|
|
app.patch("/companies/:companyId/issues/:issueId", (req, res) => {
|
|
assertCompanyAccess(req, req.params.companyId);
|
|
res.json({ id: req.params.issueId, writable: true });
|
|
});
|
|
app.use(errorHandler);
|
|
return app;
|
|
}
|
|
|
|
function craftAgentJwtWithoutResponsibleClaim(input: {
|
|
secret: string;
|
|
agentId: string;
|
|
companyId: string;
|
|
adapterType: string;
|
|
runId: string;
|
|
}) {
|
|
const now = Math.floor(Date.now() / 1000);
|
|
const header = { alg: "HS256", typ: "JWT" };
|
|
const claims = {
|
|
sub: input.agentId,
|
|
company_id: input.companyId,
|
|
adapter_type: input.adapterType,
|
|
run_id: input.runId,
|
|
iat: now,
|
|
exp: now + 3600,
|
|
iss: "paperclip",
|
|
aud: "paperclip-api",
|
|
};
|
|
const headerB64 = Buffer.from(JSON.stringify(header), "utf8").toString("base64url");
|
|
const claimsB64 = Buffer.from(JSON.stringify(claims), "utf8").toString("base64url");
|
|
const signingInput = `${headerB64}.${claimsB64}`;
|
|
// Sign with the same per-instance, per-company key the server derives. The
|
|
// instance defaults to "default" (beforeEach clears PAPERCLIP_INSTANCE_ID),
|
|
// matching the live control plane this middleware test exercises. This helper
|
|
// only omits the responsible_user_id claim — it is not a cross-instance token.
|
|
const signingKey = createHmac("sha256", input.secret).update(`jwt:default:${input.companyId}`).digest("hex");
|
|
const signature = createHmac("sha256", signingKey).update(signingInput).digest("base64url");
|
|
return `${signingInput}.${signature}`;
|
|
}
|
|
|
|
describe("agent auth middleware", () => {
|
|
const originalSecret = process.env.PAPERCLIP_AGENT_JWT_SECRET;
|
|
const originalTtl = process.env.PAPERCLIP_AGENT_JWT_TTL_SECONDS;
|
|
const originalInstanceId = process.env.PAPERCLIP_INSTANCE_ID;
|
|
|
|
beforeEach(() => {
|
|
process.env.PAPERCLIP_AGENT_JWT_SECRET = "auth-middleware-secret";
|
|
process.env.PAPERCLIP_AGENT_JWT_TTL_SECONDS = "3600";
|
|
// Pin the control-plane instance so mint/verify (and the hand-crafted
|
|
// legacy token helper) all derive keys under the "default" live instance.
|
|
delete process.env.PAPERCLIP_INSTANCE_ID;
|
|
});
|
|
|
|
afterEach(() => {
|
|
if (originalSecret === undefined) delete process.env.PAPERCLIP_AGENT_JWT_SECRET;
|
|
else process.env.PAPERCLIP_AGENT_JWT_SECRET = originalSecret;
|
|
if (originalTtl === undefined) delete process.env.PAPERCLIP_AGENT_JWT_TTL_SECONDS;
|
|
else process.env.PAPERCLIP_AGENT_JWT_TTL_SECONDS = originalTtl;
|
|
if (originalInstanceId === undefined) delete process.env.PAPERCLIP_INSTANCE_ID;
|
|
else process.env.PAPERCLIP_INSTANCE_ID = originalInstanceId;
|
|
});
|
|
|
|
it("uses the signed responsible_user_id claim and keeps the signed run id authoritative", async () => {
|
|
const companyId = randomUUID();
|
|
const agentId = randomUUID();
|
|
const runId = randomUUID();
|
|
const { db } = createDbState({
|
|
agent: { id: agentId, companyId },
|
|
run: { id: runId, companyId, agentId, responsibleUserId: "user-row" },
|
|
});
|
|
const token = createLocalAgentJwt(agentId, companyId, "codex_local", runId, "user-claim");
|
|
|
|
const res = await request(createApp(db))
|
|
.get("/actor")
|
|
.set("Authorization", `Bearer ${token}`)
|
|
.set("X-Paperclip-Run-Id", runId);
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(res.body).toMatchObject({
|
|
type: "agent",
|
|
agentId,
|
|
companyId,
|
|
runId,
|
|
onBehalfOfUserId: "user-claim",
|
|
source: "agent_jwt",
|
|
});
|
|
});
|
|
|
|
it("preserves signed skill_test JWT scope on the request actor", async () => {
|
|
const companyId = randomUUID();
|
|
const agentId = randomUUID();
|
|
const runId = randomUUID();
|
|
const issueId = randomUUID();
|
|
const { db } = createDbState({
|
|
agent: { id: agentId, companyId },
|
|
run: { id: runId, companyId, agentId, responsibleUserId: "user-claim" },
|
|
});
|
|
const token = createLocalAgentJwt(agentId, companyId, "codex_local", runId, "user-claim", {
|
|
kind: "skill_test",
|
|
issueId,
|
|
});
|
|
|
|
const res = await request(createApp(db))
|
|
.get("/actor")
|
|
.set("Authorization", `Bearer ${token}`)
|
|
.set("X-Paperclip-Run-Id", runId);
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(res.body).toMatchObject({
|
|
type: "agent",
|
|
agentId,
|
|
companyId,
|
|
keyScope: { kind: "skill_test", issueId },
|
|
source: "agent_jwt",
|
|
});
|
|
});
|
|
|
|
it("rejects mismatched run headers for agent JWTs and audits the spoof attempt", async () => {
|
|
const companyId = randomUUID();
|
|
const agentId = randomUUID();
|
|
const runId = randomUUID();
|
|
const spoofedRunId = randomUUID();
|
|
const { db, activity } = createDbState({
|
|
agent: { id: agentId, companyId },
|
|
run: { id: runId, companyId, agentId, responsibleUserId: "user-claim" },
|
|
});
|
|
const token = createLocalAgentJwt(agentId, companyId, "codex_local", runId, "user-claim");
|
|
|
|
const res = await request(createApp(db))
|
|
.get("/actor")
|
|
.set("Authorization", `Bearer ${token}`)
|
|
.set("X-Paperclip-Run-Id", spoofedRunId);
|
|
|
|
expect(res.status).toBe(422);
|
|
expect(res.body.code).toBe("agent_jwt_run_id_mismatch");
|
|
expect(activity).toHaveLength(1);
|
|
expect(activity[0]).toMatchObject({
|
|
companyId,
|
|
actorType: "agent",
|
|
actorId: agentId,
|
|
action: "auth.agent_jwt_run_header_mismatch",
|
|
entityType: "heartbeat_run",
|
|
entityId: runId,
|
|
runId,
|
|
details: { claimRunId: runId, headerRunId: spoofedRunId },
|
|
});
|
|
});
|
|
|
|
it("falls back to the run row responsible user for legacy claim-less agent JWTs", async () => {
|
|
const companyId = randomUUID();
|
|
const agentId = randomUUID();
|
|
const runId = randomUUID();
|
|
const { db } = createDbState({
|
|
agent: { id: agentId, companyId },
|
|
run: { id: runId, companyId, agentId, responsibleUserId: "user-legacy" },
|
|
});
|
|
const token = craftAgentJwtWithoutResponsibleClaim({
|
|
secret: process.env.PAPERCLIP_AGENT_JWT_SECRET!,
|
|
agentId,
|
|
companyId,
|
|
adapterType: "codex_local",
|
|
runId,
|
|
});
|
|
|
|
const res = await request(createApp(db))
|
|
.get("/actor")
|
|
.set("Authorization", `Bearer ${token}`);
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(res.body).toMatchObject({
|
|
type: "agent",
|
|
runId,
|
|
onBehalfOfUserId: "user-legacy",
|
|
source: "agent_jwt",
|
|
});
|
|
});
|
|
|
|
it("rejects fork-minted run JWTs before issue reads or writes reach live issue data", async () => {
|
|
const companyId = randomUUID();
|
|
const agentId = randomUUID();
|
|
const runId = randomUUID();
|
|
const issueId = randomUUID();
|
|
const { db } = createDbState({
|
|
agent: { id: agentId, companyId },
|
|
run: { id: runId, companyId, agentId, responsibleUserId: "user-claim" },
|
|
});
|
|
|
|
process.env.PAPERCLIP_INSTANCE_ID = "pap-12899-worktree";
|
|
const forkToken = createLocalAgentJwt(agentId, companyId, "codex_local", runId, "user-claim");
|
|
expect(forkToken).not.toBeNull();
|
|
|
|
process.env.PAPERCLIP_INSTANCE_ID = "default";
|
|
const app = createApp(db);
|
|
const readRes = await request(app)
|
|
.get(`/companies/${companyId}/issues/${issueId}`)
|
|
.set("Authorization", `Bearer ${forkToken}`)
|
|
.set("X-Paperclip-Run-Id", runId);
|
|
const writeRes = await request(app)
|
|
.patch(`/companies/${companyId}/issues/${issueId}`)
|
|
.set("Authorization", `Bearer ${forkToken}`)
|
|
.set("X-Paperclip-Run-Id", runId)
|
|
.send({ title: "should not write" });
|
|
|
|
expect(readRes.status).toBe(401);
|
|
expect(writeRes.status).toBe(401);
|
|
});
|
|
|
|
it("populates agent-key actors from the key responsible user binding", async () => {
|
|
const companyId = randomUUID();
|
|
const agentId = randomUUID();
|
|
const token = "pcp_test_agent_key";
|
|
const { db } = createDbState({
|
|
agent: { id: agentId, companyId },
|
|
agentKey: {
|
|
id: randomUUID(),
|
|
agentId,
|
|
companyId,
|
|
keyHash: hashToken(token),
|
|
responsibleUserId: "user-key",
|
|
},
|
|
});
|
|
|
|
const res = await request(createApp(db))
|
|
.get("/actor")
|
|
.set("Authorization", `Bearer ${token}`);
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(res.body).toMatchObject({
|
|
type: "agent",
|
|
agentId,
|
|
companyId,
|
|
onBehalfOfUserId: "user-key",
|
|
source: "agent_key",
|
|
});
|
|
});
|
|
|
|
it("rejects agent keys that lack a responsible user binding and audits the denial", async () => {
|
|
const companyId = randomUUID();
|
|
const agentId = randomUUID();
|
|
const keyId = randomUUID();
|
|
const token = "pcp_test_agent_key_without_user";
|
|
const { db, activity } = createDbState({
|
|
agent: { id: agentId, companyId },
|
|
agentKey: {
|
|
id: keyId,
|
|
agentId,
|
|
companyId,
|
|
keyHash: hashToken(token),
|
|
responsibleUserId: null,
|
|
},
|
|
});
|
|
|
|
const res = await request(createApp(db))
|
|
.get(`/companies/${companyId}/protected`)
|
|
.set("Authorization", `Bearer ${token}`);
|
|
|
|
expect(res.status).toBe(403);
|
|
expect(res.body.code).toBe("RESPONSIBLE_USER_UNAVAILABLE");
|
|
expect(activity).toHaveLength(1);
|
|
expect(activity[0]).toMatchObject({
|
|
companyId,
|
|
actorType: "agent",
|
|
actorId: agentId,
|
|
action: "auth.agent_key_missing_responsible_user",
|
|
entityType: "agent_api_key",
|
|
entityId: keyId,
|
|
details: { method: "GET", url: `/companies/${companyId}/protected` },
|
|
});
|
|
});
|
|
});
|