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>
316 lines
14 KiB
TypeScript
316 lines
14 KiB
TypeScript
import { createHmac } from "node:crypto";
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
import { createLocalAgentJwt, verifyLocalAgentJwt } from "../agent-auth-jwt.js";
|
|
|
|
describe("agent local JWT", () => {
|
|
const secretEnv = "PAPERCLIP_AGENT_JWT_SECRET";
|
|
const betterAuthSecretEnv = "BETTER_AUTH_SECRET";
|
|
const ttlEnv = "PAPERCLIP_AGENT_JWT_TTL_SECONDS";
|
|
const issuerEnv = "PAPERCLIP_AGENT_JWT_ISSUER";
|
|
const audienceEnv = "PAPERCLIP_AGENT_JWT_AUDIENCE";
|
|
const disableLegacyFallbackEnv = "PAPERCLIP_AGENT_JWT_DISABLE_LEGACY_FALLBACK";
|
|
const instanceIdEnv = "PAPERCLIP_INSTANCE_ID";
|
|
|
|
const originalEnv = {
|
|
secret: process.env[secretEnv],
|
|
betterAuthSecret: process.env[betterAuthSecretEnv],
|
|
ttl: process.env[ttlEnv],
|
|
issuer: process.env[issuerEnv],
|
|
audience: process.env[audienceEnv],
|
|
disableLegacyFallback: process.env[disableLegacyFallbackEnv],
|
|
instanceId: process.env[instanceIdEnv],
|
|
};
|
|
|
|
beforeEach(() => {
|
|
process.env[secretEnv] = "test-secret";
|
|
delete process.env[betterAuthSecretEnv];
|
|
process.env[ttlEnv] = "3600";
|
|
delete process.env[issuerEnv];
|
|
delete process.env[audienceEnv];
|
|
delete process.env[disableLegacyFallbackEnv];
|
|
delete process.env[instanceIdEnv];
|
|
vi.useFakeTimers();
|
|
});
|
|
|
|
afterEach(() => {
|
|
vi.useRealTimers();
|
|
if (originalEnv.secret === undefined) delete process.env[secretEnv];
|
|
else process.env[secretEnv] = originalEnv.secret;
|
|
if (originalEnv.betterAuthSecret === undefined) delete process.env[betterAuthSecretEnv];
|
|
else process.env[betterAuthSecretEnv] = originalEnv.betterAuthSecret;
|
|
if (originalEnv.ttl === undefined) delete process.env[ttlEnv];
|
|
else process.env[ttlEnv] = originalEnv.ttl;
|
|
if (originalEnv.issuer === undefined) delete process.env[issuerEnv];
|
|
else process.env[issuerEnv] = originalEnv.issuer;
|
|
if (originalEnv.audience === undefined) delete process.env[audienceEnv];
|
|
else process.env[audienceEnv] = originalEnv.audience;
|
|
if (originalEnv.disableLegacyFallback === undefined) delete process.env[disableLegacyFallbackEnv];
|
|
else process.env[disableLegacyFallbackEnv] = originalEnv.disableLegacyFallback;
|
|
if (originalEnv.instanceId === undefined) delete process.env[instanceIdEnv];
|
|
else process.env[instanceIdEnv] = originalEnv.instanceId;
|
|
});
|
|
|
|
it("creates and verifies a token", () => {
|
|
vi.setSystemTime(new Date("2026-01-01T00:00:00.000Z"));
|
|
const token = createLocalAgentJwt("agent-1", "company-1", "claude_local", "run-1", "user-1");
|
|
expect(typeof token).toBe("string");
|
|
|
|
const claims = verifyLocalAgentJwt(token!);
|
|
expect(claims).toMatchObject({
|
|
sub: "agent-1",
|
|
company_id: "company-1",
|
|
adapter_type: "claude_local",
|
|
run_id: "run-1",
|
|
responsible_user_id: "user-1",
|
|
iss: "paperclip",
|
|
aud: "paperclip-api",
|
|
});
|
|
});
|
|
|
|
it("round-trips a skill_test run scope", () => {
|
|
vi.setSystemTime(new Date("2026-01-01T00:00:00.000Z"));
|
|
const issueId = "11111111-1111-4111-8111-111111111111";
|
|
const token = createLocalAgentJwt("agent-1", "company-1", "claude_local", "run-1", "user-1", {
|
|
kind: "skill_test",
|
|
issueId,
|
|
});
|
|
|
|
const claims = verifyLocalAgentJwt(token!);
|
|
expect(claims?.key_scope).toEqual({ kind: "skill_test", issueId });
|
|
});
|
|
|
|
it("returns null when secret is missing", () => {
|
|
process.env[secretEnv] = "";
|
|
const token = createLocalAgentJwt("agent-1", "company-1", "claude_local", "run-1");
|
|
expect(token).toBeNull();
|
|
expect(verifyLocalAgentJwt("abc.def.ghi")).toBeNull();
|
|
});
|
|
|
|
it("falls back to BETTER_AUTH_SECRET when PAPERCLIP_AGENT_JWT_SECRET is absent", () => {
|
|
delete process.env[secretEnv];
|
|
process.env[betterAuthSecretEnv] = "fallback-secret";
|
|
vi.setSystemTime(new Date("2026-01-01T00:00:00.000Z"));
|
|
const token = createLocalAgentJwt("agent-1", "company-1", "claude_local", "run-1");
|
|
expect(typeof token).toBe("string");
|
|
|
|
const claims = verifyLocalAgentJwt(token!);
|
|
expect(claims).toMatchObject({
|
|
sub: "agent-1",
|
|
company_id: "company-1",
|
|
adapter_type: "claude_local",
|
|
run_id: "run-1",
|
|
});
|
|
});
|
|
|
|
it("rejects expired tokens", () => {
|
|
process.env[ttlEnv] = "1";
|
|
vi.setSystemTime(new Date("2026-01-01T00:00:00.000Z"));
|
|
const token = createLocalAgentJwt("agent-1", "company-1", "claude_local", "run-1");
|
|
|
|
vi.setSystemTime(new Date("2026-01-01T00:00:05.000Z"));
|
|
expect(verifyLocalAgentJwt(token!)).toBeNull();
|
|
});
|
|
|
|
it("rejects issuer/audience mismatch", () => {
|
|
process.env[issuerEnv] = "custom-issuer";
|
|
process.env[audienceEnv] = "custom-audience";
|
|
vi.setSystemTime(new Date("2026-01-01T00:00:00.000Z"));
|
|
const token = createLocalAgentJwt("agent-1", "company-1", "codex_local", "run-1");
|
|
|
|
process.env[issuerEnv] = "paperclip";
|
|
process.env[audienceEnv] = "paperclip-api";
|
|
expect(verifyLocalAgentJwt(token!)).toBeNull();
|
|
});
|
|
|
|
it("does not verify a token across companies (per-company isolation)", () => {
|
|
vi.setSystemTime(new Date("2026-01-01T00:00:00.000Z"));
|
|
const tokenA = createLocalAgentJwt("agent-1", "company-A", "claude_local", "run-1");
|
|
expect(tokenA).not.toBeNull();
|
|
|
|
// A token whose body claims company-A must verify successfully under its
|
|
// own company-A derived key.
|
|
expect(verifyLocalAgentJwt(tokenA!)?.company_id).toBe("company-A");
|
|
|
|
// Tamper: forge a token by copying tokenA's header+signature and swapping
|
|
// the claim's company_id to company-B. The signature was bound to the
|
|
// company-A derived key over the original claims; once we re-encode with a
|
|
// different company_id (or rebind to company-B's key) verification must
|
|
// fail because the signature is over the original signing input.
|
|
const [headerB64, claimsB64, signature] = tokenA!.split(".");
|
|
const claims = JSON.parse(Buffer.from(claimsB64, "base64url").toString("utf8"));
|
|
claims.company_id = "company-B";
|
|
const tamperedClaimsB64 = Buffer.from(JSON.stringify(claims), "utf8").toString("base64url");
|
|
const tampered = `${headerB64}.${tamperedClaimsB64}.${signature}`;
|
|
expect(verifyLocalAgentJwt(tampered)).toBeNull();
|
|
});
|
|
|
|
it("accepts legacy tokens signed with the master secret (backward compat)", () => {
|
|
vi.setSystemTime(new Date("2026-01-01T00:00:00.000Z"));
|
|
const masterSecret = process.env[secretEnv]!;
|
|
|
|
// Hand-craft a token signed directly with the master secret, simulating a
|
|
// JWT issued before per-company derivation existed.
|
|
const now = Math.floor(Date.now() / 1000);
|
|
const header = { alg: "HS256", typ: "JWT" };
|
|
const claims = {
|
|
sub: "agent-legacy",
|
|
company_id: "company-legacy",
|
|
adapter_type: "claude_local",
|
|
run_id: "run-legacy",
|
|
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}`;
|
|
const legacySig = createHmac("sha256", masterSecret).update(signingInput).digest("base64url");
|
|
const legacyToken = `${signingInput}.${legacySig}`;
|
|
|
|
const verified = verifyLocalAgentJwt(legacyToken);
|
|
expect(verified).toMatchObject({
|
|
sub: "agent-legacy",
|
|
company_id: "company-legacy",
|
|
adapter_type: "claude_local",
|
|
run_id: "run-legacy",
|
|
});
|
|
});
|
|
|
|
// --- Instance isolation (PAP-12899) ---------------------------------------
|
|
// A worktree/fork control-plane instance runs under a distinct
|
|
// PAPERCLIP_INSTANCE_ID but deliberately shares PAPERCLIP_AGENT_JWT_SECRET
|
|
// with its source instance (provisioning copies the secret). Before this
|
|
// change, a fork-minted run JWT validated successfully against the live plane
|
|
// (reads worked; writes then failed on missing heartbeat_runs FK rows). These
|
|
// tests pin the boundary that keeps fork tokens out of the live plane.
|
|
|
|
it("stamps the minting instance id into the token claims", () => {
|
|
process.env[instanceIdEnv] = "default";
|
|
vi.setSystemTime(new Date("2026-01-01T00:00:00.000Z"));
|
|
const token = createLocalAgentJwt("agent-1", "company-1", "claude_local", "run-1");
|
|
const claims = verifyLocalAgentJwt(token!);
|
|
expect(claims?.instance_id).toBe("default");
|
|
});
|
|
|
|
it("rejects a fork/worktree-minted token on the live control plane", () => {
|
|
vi.setSystemTime(new Date("2026-01-01T00:00:00.000Z"));
|
|
|
|
// Mint on a worktree/fork instance (distinct instance id, SAME secret).
|
|
process.env[instanceIdEnv] = "pap-12899-worktree";
|
|
const forkToken = createLocalAgentJwt("agent-1", "company-1", "claude_local", "run-1");
|
|
expect(forkToken).not.toBeNull();
|
|
// Sanity: it verifies on the instance that minted it.
|
|
expect(verifyLocalAgentJwt(forkToken!)?.company_id).toBe("company-1");
|
|
|
|
// Now switch to the live control plane (same shared secret, "default"
|
|
// instance) and confirm the fork token no longer authenticates — neither
|
|
// its instance-scoped signature nor the legacy master-secret fallback
|
|
// matches, so reads and writes are both refused.
|
|
process.env[instanceIdEnv] = "default";
|
|
expect(verifyLocalAgentJwt(forkToken!)).toBeNull();
|
|
});
|
|
|
|
it("keeps live-plane heartbeat tokens authenticating across mint/verify", () => {
|
|
process.env[instanceIdEnv] = "default";
|
|
vi.setSystemTime(new Date("2026-01-01T00:00:00.000Z"));
|
|
const token = createLocalAgentJwt("agent-1", "company-1", "claude_local", "run-1", "user-1");
|
|
const claims = verifyLocalAgentJwt(token!);
|
|
expect(claims).toMatchObject({
|
|
sub: "agent-1",
|
|
company_id: "company-1",
|
|
run_id: "run-1",
|
|
instance_id: "default",
|
|
});
|
|
});
|
|
|
|
it("rejects a token whose instance_id claim is forged to match the live plane", () => {
|
|
vi.setSystemTime(new Date("2026-01-01T00:00:00.000Z"));
|
|
|
|
// Mint a fork token, then tamper the instance_id claim to impersonate the
|
|
// live "default" instance. The signature was bound to the fork instance's
|
|
// derived key, so re-encoding the claim cannot make it validate on the
|
|
// live plane — the claim check is defense-in-depth, the key is the boundary.
|
|
process.env[instanceIdEnv] = "pap-12899-worktree";
|
|
const forkToken = createLocalAgentJwt("agent-1", "company-1", "claude_local", "run-1");
|
|
const [headerB64, claimsB64, signature] = forkToken!.split(".");
|
|
const claims = JSON.parse(Buffer.from(claimsB64, "base64url").toString("utf8"));
|
|
claims.instance_id = "default";
|
|
const tamperedClaimsB64 = Buffer.from(JSON.stringify(claims), "utf8").toString("base64url");
|
|
const tampered = `${headerB64}.${tamperedClaimsB64}.${signature}`;
|
|
|
|
process.env[instanceIdEnv] = "default";
|
|
expect(verifyLocalAgentJwt(tampered)).toBeNull();
|
|
});
|
|
|
|
it("still rejects the master-secret legacy fallback once it is disabled (full instance isolation)", () => {
|
|
vi.setSystemTime(new Date("2026-01-01T00:00:00.000Z"));
|
|
process.env[disableLegacyFallbackEnv] = "true";
|
|
process.env[instanceIdEnv] = "default";
|
|
// The legacy fallback signs with the raw shared secret and is therefore
|
|
// instance-agnostic; disabling it closes that residual cross-instance hole.
|
|
const legacyToken = craftLegacyMasterSecretToken(process.env[secretEnv]!, "company-1");
|
|
expect(verifyLocalAgentJwt(legacyToken)).toBeNull();
|
|
});
|
|
|
|
it("defaults TTL to 1h when PAPERCLIP_AGENT_JWT_TTL_SECONDS is unset", () => {
|
|
delete process.env[ttlEnv];
|
|
vi.setSystemTime(new Date("2026-01-01T00:00:00.000Z"));
|
|
const token = createLocalAgentJwt("agent-1", "company-1", "claude_local", "run-1");
|
|
const claims = verifyLocalAgentJwt(token!);
|
|
expect(claims).not.toBeNull();
|
|
expect(claims!.exp - claims!.iat).toBe(60 * 60);
|
|
});
|
|
|
|
// Helper: hand-craft a token signed with the raw master secret (legacy path).
|
|
function craftLegacyMasterSecretToken(masterSecret: string, companyId: string) {
|
|
const now = Math.floor(Date.now() / 1000);
|
|
const header = { alg: "HS256", typ: "JWT" };
|
|
const claims = {
|
|
sub: "agent-legacy",
|
|
company_id: companyId,
|
|
adapter_type: "claude_local",
|
|
run_id: "run-legacy",
|
|
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}`;
|
|
const legacySig = createHmac("sha256", masterSecret).update(signingInput).digest("base64url");
|
|
return `${signingInput}.${legacySig}`;
|
|
}
|
|
|
|
it("accepts master-secret-signed tokens when PAPERCLIP_AGENT_JWT_DISABLE_LEGACY_FALLBACK is unset", () => {
|
|
vi.setSystemTime(new Date("2026-01-01T00:00:00.000Z"));
|
|
delete process.env[disableLegacyFallbackEnv];
|
|
const legacyToken = craftLegacyMasterSecretToken(process.env[secretEnv]!, "company-legacy");
|
|
const verified = verifyLocalAgentJwt(legacyToken);
|
|
expect(verified).not.toBeNull();
|
|
expect(verified!.company_id).toBe("company-legacy");
|
|
});
|
|
|
|
it("rejects master-secret-signed tokens when PAPERCLIP_AGENT_JWT_DISABLE_LEGACY_FALLBACK is enabled", () => {
|
|
vi.setSystemTime(new Date("2026-01-01T00:00:00.000Z"));
|
|
process.env[disableLegacyFallbackEnv] = "true";
|
|
const legacyToken = craftLegacyMasterSecretToken(process.env[secretEnv]!, "company-legacy");
|
|
expect(verifyLocalAgentJwt(legacyToken)).toBeNull();
|
|
});
|
|
|
|
it("still verifies per-company-signed tokens when PAPERCLIP_AGENT_JWT_DISABLE_LEGACY_FALLBACK is enabled", () => {
|
|
vi.setSystemTime(new Date("2026-01-01T00:00:00.000Z"));
|
|
process.env[disableLegacyFallbackEnv] = "true";
|
|
const token = createLocalAgentJwt("agent-1", "company-1", "claude_local", "run-1");
|
|
expect(token).not.toBeNull();
|
|
const verified = verifyLocalAgentJwt(token!);
|
|
expect(verified).toMatchObject({
|
|
sub: "agent-1",
|
|
company_id: "company-1",
|
|
adapter_type: "claude_local",
|
|
run_id: "run-1",
|
|
});
|
|
});
|
|
});
|