mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-01 15:35:12 +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>
305 lines
9.3 KiB
TypeScript
305 lines
9.3 KiB
TypeScript
// @vitest-environment jsdom
|
|
|
|
import type { ReactNode } from "react";
|
|
import { flushSync } from "react-dom";
|
|
import { createRoot, type Root } from "react-dom/client";
|
|
import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
|
|
import type {
|
|
CompanySkillDetail,
|
|
CompanySkillForkPrecheckResult,
|
|
CompanySkillForkSummary,
|
|
CompanySkillUsageAgent,
|
|
} from "@paperclipai/shared";
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
import { ForkSkillDialog } from "./ForkSkillDialog";
|
|
|
|
const mockNavigate = vi.hoisted(() => vi.fn());
|
|
const mockCompanySkillsApi = vi.hoisted(() => ({
|
|
fork: vi.fn(),
|
|
forkPrecheck: vi.fn(),
|
|
detail: vi.fn(),
|
|
}));
|
|
const mockPushToast = vi.hoisted(() => vi.fn());
|
|
|
|
vi.mock("@/lib/router", () => ({
|
|
Link: ({ children, to }: { children: ReactNode; to: string }) => <a href={to}>{children}</a>,
|
|
useNavigate: () => mockNavigate,
|
|
}));
|
|
vi.mock("@/api/companySkills", () => ({ companySkillsApi: mockCompanySkillsApi }));
|
|
vi.mock("@/context/ToastContext", () => ({
|
|
useOptionalToastActions: () => ({ pushToast: mockPushToast }),
|
|
}));
|
|
|
|
(globalThis as unknown as { IS_REACT_ACT_ENVIRONMENT: boolean }).IS_REACT_ACT_ENVIRONMENT = true;
|
|
|
|
let root: Root | null = null;
|
|
let container: HTMLDivElement | null = null;
|
|
|
|
// React's `act` is not usable in this vitest setup; drive updates via flushSync
|
|
// like SkillStudio.test.tsx / AgentsUsingSkillDialog.test.tsx do.
|
|
async function act(callback: () => void | Promise<void>) {
|
|
let result: void | Promise<void> = undefined;
|
|
flushSync(() => {
|
|
result = callback();
|
|
});
|
|
await result;
|
|
}
|
|
|
|
async function flush() {
|
|
await Promise.resolve();
|
|
await new Promise((resolve) => window.setTimeout(resolve, 0));
|
|
}
|
|
|
|
function teardown() {
|
|
if (root) flushSync(() => root?.unmount());
|
|
container?.remove();
|
|
root = null;
|
|
container = null;
|
|
document.body.innerHTML = "";
|
|
}
|
|
|
|
async function renderNode(node: ReactNode) {
|
|
teardown();
|
|
container = document.createElement("div");
|
|
document.body.appendChild(container);
|
|
root = createRoot(container);
|
|
const queryClient = new QueryClient({
|
|
defaultOptions: { queries: { retry: false }, mutations: { retry: false } },
|
|
});
|
|
await act(async () => {
|
|
root?.render(<QueryClientProvider client={queryClient}>{node}</QueryClientProvider>);
|
|
});
|
|
await flush();
|
|
}
|
|
|
|
async function click(el: Element) {
|
|
await act(async () => {
|
|
el.dispatchEvent(new MouseEvent("click", { bubbles: true }));
|
|
});
|
|
await flush();
|
|
}
|
|
|
|
function findButton(match: (text: string) => boolean): HTMLButtonElement {
|
|
const found = Array.from(document.body.querySelectorAll("button")).find((button) =>
|
|
match(button.textContent?.trim() ?? ""),
|
|
) as HTMLButtonElement | undefined;
|
|
if (!found) throw new Error("button not found");
|
|
return found;
|
|
}
|
|
|
|
function makeAgent(over: Partial<CompanySkillUsageAgent> = {}): CompanySkillUsageAgent {
|
|
return {
|
|
id: "agent-1",
|
|
name: "Reviewer",
|
|
urlKey: "reviewer",
|
|
adapterType: "claude_local",
|
|
desired: true,
|
|
actualState: null,
|
|
versionId: null,
|
|
...over,
|
|
};
|
|
}
|
|
|
|
function makeSkill(over: Partial<CompanySkillDetail> = {}): CompanySkillDetail {
|
|
return {
|
|
id: "skill-1",
|
|
companyId: "company-1",
|
|
key: "github/anthropics/skills",
|
|
slug: "deep-research",
|
|
name: "Deep Research",
|
|
description: null,
|
|
markdown: "",
|
|
sourceType: "github",
|
|
sourceLocator: "https://github.com/anthropics/skills",
|
|
sourceRef: "0123456789abcdef0123456789abcdef01234567",
|
|
trustLevel: "markdown_only",
|
|
compatibility: "compatible",
|
|
fileInventory: [],
|
|
iconUrl: null,
|
|
color: null,
|
|
tagline: null,
|
|
authorName: null,
|
|
homepageUrl: null,
|
|
categories: [],
|
|
sharingScope: "company",
|
|
publicShareToken: null,
|
|
forkedFromSkillId: null,
|
|
forkedFromCompanyId: null,
|
|
starCount: 0,
|
|
installCount: 0,
|
|
forkCount: 0,
|
|
currentVersionId: "ver-1",
|
|
metadata: null,
|
|
createdAt: new Date("2026-01-01T00:00:00Z"),
|
|
updatedAt: new Date("2026-01-02T00:00:00Z"),
|
|
attachedAgentCount: 0,
|
|
usedByAgents: [],
|
|
editable: false,
|
|
editableReason: "This skill comes from GitHub and is read-only.",
|
|
sourceLabel: "GitHub",
|
|
sourceBadge: "github",
|
|
sourcePath: null,
|
|
currentVersion: null,
|
|
starredByCurrentActor: false,
|
|
existingForks: [],
|
|
...over,
|
|
};
|
|
}
|
|
|
|
function makePrecheck(over: Partial<CompanySkillForkPrecheckResult> = {}): CompanySkillForkPrecheckResult {
|
|
return {
|
|
skillId: "skill-1",
|
|
original: {
|
|
id: "skill-1",
|
|
name: "Deep Research",
|
|
slug: "deep-research",
|
|
sourceType: "github",
|
|
sourceLocator: "https://github.com/anthropics/skills",
|
|
sourceRef: "0123456789abcdef0123456789abcdef01234567",
|
|
},
|
|
agentUsageCount: 0,
|
|
usedByAgents: [],
|
|
existingForks: [],
|
|
...over,
|
|
};
|
|
}
|
|
|
|
function makeForkSummary(over: Partial<CompanySkillForkSummary> = {}): CompanySkillForkSummary {
|
|
return {
|
|
id: "fork-existing",
|
|
name: "Deep Research (copy)",
|
|
slug: "deep-research-fork",
|
|
sourceType: "local_path",
|
|
sourceLocator: null,
|
|
sourceRef: null,
|
|
key: "company/deep-research-fork",
|
|
forkedFromSkillId: "skill-1",
|
|
forkedFromCompanyId: "company-1",
|
|
currentVersionId: "v1",
|
|
createdByCurrentActor: true,
|
|
diverged: false,
|
|
createdAt: new Date("2026-07-01T00:00:00Z"),
|
|
updatedAt: new Date("2026-07-01T00:00:00Z"),
|
|
...over,
|
|
};
|
|
}
|
|
|
|
beforeEach(() => {
|
|
mockCompanySkillsApi.forkPrecheck.mockResolvedValue(makePrecheck());
|
|
mockCompanySkillsApi.fork.mockResolvedValue({
|
|
skill: { id: "fork-new" },
|
|
original: makePrecheck().original,
|
|
reassignments: [],
|
|
});
|
|
mockCompanySkillsApi.detail.mockResolvedValue(makeSkill());
|
|
mockNavigate.mockReset();
|
|
mockPushToast.mockReset();
|
|
});
|
|
|
|
afterEach(() => {
|
|
teardown();
|
|
vi.clearAllMocks();
|
|
});
|
|
|
|
describe("ForkSkillDialog", () => {
|
|
it("shows the agent count prominently and forks with reassignment ON by default", async () => {
|
|
const agents = [makeAgent({ id: "a1", name: "Reviewer" }), makeAgent({ id: "a2", name: "Planner" })];
|
|
mockCompanySkillsApi.forkPrecheck.mockResolvedValue(
|
|
makePrecheck({ agentUsageCount: 2, usedByAgents: agents }),
|
|
);
|
|
mockCompanySkillsApi.fork.mockResolvedValue({
|
|
skill: { id: "fork-new" },
|
|
original: makePrecheck().original,
|
|
reassignments: [
|
|
{ agentId: "a1", previousSkillKey: "k", nextSkillKey: "kf" },
|
|
{ agentId: "a2", previousSkillKey: "k", nextSkillKey: "kf" },
|
|
],
|
|
});
|
|
|
|
await renderNode(
|
|
<ForkSkillDialog
|
|
companyId="company-1"
|
|
skill={makeSkill({ usedByAgents: agents, attachedAgentCount: 2 })}
|
|
open
|
|
onOpenChange={() => {}}
|
|
/>,
|
|
);
|
|
|
|
expect(document.body.textContent).toContain("2 agents currently use this skill");
|
|
expect(document.body.textContent).toContain("Reviewer");
|
|
expect(document.body.textContent).toContain("Planner");
|
|
|
|
const confirm = findButton((t) => t.startsWith("Create copy & switch 2 agents"));
|
|
await click(confirm);
|
|
|
|
expect(mockCompanySkillsApi.fork).toHaveBeenCalledWith("company-1", "skill-1", {
|
|
reassignAgentIds: ["a1", "a2"],
|
|
});
|
|
expect(mockNavigate).toHaveBeenCalledWith("/skills/studio/fork-new");
|
|
expect(mockPushToast).toHaveBeenCalledWith(
|
|
expect.objectContaining({ tone: "success" }),
|
|
);
|
|
});
|
|
|
|
it("forks with NO reassignment when the toggle is switched off", async () => {
|
|
const agents = [makeAgent({ id: "a1" })];
|
|
mockCompanySkillsApi.forkPrecheck.mockResolvedValue(
|
|
makePrecheck({ agentUsageCount: 1, usedByAgents: agents }),
|
|
);
|
|
|
|
await renderNode(
|
|
<ForkSkillDialog
|
|
companyId="company-1"
|
|
skill={makeSkill({ usedByAgents: agents, attachedAgentCount: 1 })}
|
|
open
|
|
onOpenChange={() => {}}
|
|
/>,
|
|
);
|
|
|
|
const toggle = document.body.querySelector<HTMLButtonElement>(
|
|
'button[aria-label="Switch these agents to the copy"]',
|
|
);
|
|
expect(toggle).toBeTruthy();
|
|
expect(toggle?.getAttribute("aria-checked")).toBe("true");
|
|
await click(toggle!);
|
|
expect(toggle?.getAttribute("aria-checked")).toBe("false");
|
|
|
|
await click(findButton((t) => t === "Create copy"));
|
|
|
|
expect(mockCompanySkillsApi.fork).toHaveBeenCalledWith("company-1", "skill-1", {
|
|
reassignAgentIds: [],
|
|
});
|
|
});
|
|
|
|
it("offers 'Open your existing copy' when an un-diverged same-actor fork exists", async () => {
|
|
mockCompanySkillsApi.forkPrecheck.mockResolvedValue(
|
|
makePrecheck({ existingForks: [makeForkSummary({ id: "fork-existing" })] }),
|
|
);
|
|
|
|
await renderNode(
|
|
<ForkSkillDialog
|
|
companyId="company-1"
|
|
skill={makeSkill({ existingForks: [makeForkSummary({ id: "fork-existing" })] })}
|
|
open
|
|
onOpenChange={() => {}}
|
|
/>,
|
|
);
|
|
|
|
expect(document.body.textContent).toContain("You already have a copy");
|
|
await click(findButton((t) => t === "Open your existing copy"));
|
|
expect(mockNavigate).toHaveBeenCalledWith("/skills/studio/fork-existing");
|
|
expect(mockCompanySkillsApi.fork).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("hides the toggle and reports zero usage when no agents use the skill", async () => {
|
|
await renderNode(
|
|
<ForkSkillDialog companyId="company-1" skill={makeSkill()} open onOpenChange={() => {}} />,
|
|
);
|
|
|
|
expect(document.body.textContent).toContain("No agents currently use this skill");
|
|
expect(
|
|
document.body.querySelector('button[aria-label="Switch these agents to the copy"]'),
|
|
).toBeNull();
|
|
});
|
|
});
|