mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-20 15:09:57 +02: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>
355 lines
11 KiB
TypeScript
355 lines
11 KiB
TypeScript
// @vitest-environment jsdom
|
|
|
|
import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
|
|
import type { IssueAttachment } from "@paperclipai/shared";
|
|
import type { ComponentProps, ReactNode } from "react";
|
|
import { flushSync } from "react-dom";
|
|
import { createRoot, type Root } from "react-dom/client";
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
import { IssueAttachmentsSection } from "./IssueAttachmentsSection";
|
|
|
|
vi.mock("./MarkdownBody", () => ({
|
|
MarkdownBody: ({ children, className }: { children: string; className?: string }) => (
|
|
<div className={className} data-testid="markdown-body">{children}</div>
|
|
),
|
|
}));
|
|
|
|
vi.mock("./FoldCurtain", () => ({
|
|
FoldCurtain: ({ children }: { children?: ReactNode }) => <div data-testid="fold-curtain">{children}</div>,
|
|
}));
|
|
|
|
vi.mock("@/components/ui/button", () => ({
|
|
Button: ({
|
|
asChild,
|
|
children,
|
|
onClick,
|
|
type = "button",
|
|
...props
|
|
}: ComponentProps<"button"> & { asChild?: boolean }) => {
|
|
if (asChild) return <>{children}</>;
|
|
return <button type={type} onClick={onClick} {...props}>{children}</button>;
|
|
},
|
|
}));
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
(globalThis as any).IS_REACT_ACT_ENVIRONMENT = true;
|
|
|
|
async function act(callback: () => void | Promise<void>) {
|
|
let result: void | Promise<void> = undefined;
|
|
flushSync(() => {
|
|
result = callback();
|
|
});
|
|
await result;
|
|
}
|
|
|
|
function makeAttachment(overrides: Partial<IssueAttachment> = {}): IssueAttachment {
|
|
return {
|
|
id: "attachment-1",
|
|
companyId: "company-1",
|
|
issueId: "issue-1",
|
|
issueCommentId: null,
|
|
assetId: "asset-1",
|
|
provider: "local_disk",
|
|
objectKey: "att-1",
|
|
contentType: "text/plain",
|
|
byteSize: 1024,
|
|
sha256: "sha",
|
|
originalFilename: "notes.txt",
|
|
createdByAgentId: null,
|
|
createdByUserId: "user-1",
|
|
createdAt: new Date("2026-06-01T00:00:00.000Z"),
|
|
updatedAt: new Date("2026-06-01T00:00:00.000Z"),
|
|
contentPath: "/api/attachments/attachment-1/content",
|
|
...overrides,
|
|
};
|
|
}
|
|
|
|
async function flushReact() {
|
|
await act(async () => {
|
|
await Promise.resolve();
|
|
await new Promise((resolve) => window.setTimeout(resolve, 0));
|
|
});
|
|
}
|
|
|
|
async function waitForAssertion(assertion: () => void, attempts = 20) {
|
|
let lastError: unknown;
|
|
for (let index = 0; index < attempts; index += 1) {
|
|
try {
|
|
assertion();
|
|
return;
|
|
} catch (error) {
|
|
lastError = error;
|
|
await flushReact();
|
|
}
|
|
}
|
|
throw lastError;
|
|
}
|
|
|
|
describe("IssueAttachmentsSection", () => {
|
|
let container: HTMLDivElement;
|
|
let root: Root;
|
|
let queryClient: QueryClient;
|
|
let fetchSpy: ReturnType<typeof vi.fn>;
|
|
|
|
beforeEach(() => {
|
|
container = document.createElement("div");
|
|
document.body.appendChild(container);
|
|
root = createRoot(container);
|
|
queryClient = new QueryClient({
|
|
defaultOptions: {
|
|
queries: { retry: false },
|
|
},
|
|
});
|
|
fetchSpy = vi.fn().mockResolvedValue({
|
|
ok: true,
|
|
text: () => Promise.resolve("# Imported plan\n\n- Use the document renderer"),
|
|
});
|
|
vi.stubGlobal("fetch", fetchSpy);
|
|
});
|
|
|
|
afterEach(async () => {
|
|
await act(async () => {
|
|
root.unmount();
|
|
});
|
|
queryClient.clear();
|
|
container.remove();
|
|
vi.unstubAllGlobals();
|
|
});
|
|
|
|
it("renders markdown attachments with the document markdown presentation", async () => {
|
|
const attachment = makeAttachment({
|
|
id: "markdown-attachment",
|
|
originalFilename: "plan.md",
|
|
contentType: "text/plain",
|
|
contentPath: "/api/attachments/markdown-attachment/content",
|
|
});
|
|
|
|
await act(async () => {
|
|
root.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<IssueAttachmentsSection
|
|
attachments={[attachment]}
|
|
onDelete={vi.fn()}
|
|
onImageClick={vi.fn()}
|
|
/>
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
await flushReact();
|
|
|
|
expect(fetchSpy).toHaveBeenCalledWith(
|
|
"/api/attachments/markdown-attachment/content",
|
|
expect.objectContaining({
|
|
headers: expect.objectContaining({ Accept: expect.stringContaining("text/markdown") }),
|
|
}),
|
|
);
|
|
await waitForAssertion(() => {
|
|
expect(container.querySelector('[data-testid="fold-curtain"]')).toBeTruthy();
|
|
const markdownBody = container.querySelector('[data-testid="markdown-body"]');
|
|
expect(markdownBody?.textContent).toContain("Imported plan");
|
|
expect(markdownBody?.className).toContain("paperclip-edit-in-place-content");
|
|
});
|
|
});
|
|
|
|
it("does not promote specific non-markdown content types by filename alone", async () => {
|
|
const attachment = makeAttachment({
|
|
id: "zip-markdown",
|
|
originalFilename: "report.md",
|
|
contentType: "application/zip",
|
|
contentPath: "/api/attachments/zip-markdown/content",
|
|
openPath: "/api/attachments/zip-markdown/content",
|
|
downloadPath: "/api/attachments/zip-markdown/content?download=1",
|
|
});
|
|
|
|
await act(async () => {
|
|
root.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<IssueAttachmentsSection
|
|
attachments={[attachment]}
|
|
onDelete={vi.fn()}
|
|
onImageClick={vi.fn()}
|
|
/>
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
await flushReact();
|
|
|
|
expect(container.querySelector('[data-testid="markdown-body"]')).toBeNull();
|
|
expect(container.textContent).toContain("report.md");
|
|
expect(container.textContent).toContain("application/zip");
|
|
expect(fetchSpy).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("renders video attachments through the same player used for artifact outputs", async () => {
|
|
const attachment = makeAttachment({
|
|
id: "video-attachment",
|
|
originalFilename: "demo.webm",
|
|
contentType: "video/webm",
|
|
contentPath: "/api/attachments/video-attachment/content",
|
|
});
|
|
|
|
await act(async () => {
|
|
root.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<IssueAttachmentsSection
|
|
attachments={[attachment]}
|
|
onDelete={vi.fn()}
|
|
onImageClick={vi.fn()}
|
|
/>
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
await flushReact();
|
|
|
|
const video = container.querySelector("video");
|
|
expect(video?.getAttribute("src")).toBe("/api/attachments/video-attachment/content");
|
|
expect(video?.getAttribute("controls")).not.toBeNull();
|
|
expect(fetchSpy).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("lets video attachments open the shared media gallery", async () => {
|
|
const attachment = makeAttachment({
|
|
id: "video-attachment",
|
|
originalFilename: "demo.webm",
|
|
contentType: "video/webm",
|
|
contentPath: "/api/attachments/video-attachment/content",
|
|
});
|
|
const onImageClick = vi.fn();
|
|
|
|
await act(async () => {
|
|
root.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<IssueAttachmentsSection
|
|
attachments={[attachment]}
|
|
onDelete={vi.fn()}
|
|
onImageClick={onImageClick}
|
|
/>
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
await flushReact();
|
|
|
|
const browse = container.querySelector<HTMLButtonElement>(
|
|
'button[aria-label="Browse demo.webm in gallery"]',
|
|
);
|
|
expect(browse).toBeTruthy();
|
|
|
|
await act(async () => {
|
|
browse?.click();
|
|
});
|
|
|
|
expect(onImageClick).toHaveBeenCalledWith(attachment);
|
|
});
|
|
|
|
it("treats mp4 filenames as playable videos even with a generic binary content type", async () => {
|
|
const attachment = makeAttachment({
|
|
id: "misclassified-mp4",
|
|
originalFilename: "demo.mp4",
|
|
contentType: "application/octet-stream",
|
|
contentPath: "/api/attachments/misclassified-mp4/content",
|
|
});
|
|
|
|
await act(async () => {
|
|
root.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<IssueAttachmentsSection
|
|
attachments={[attachment]}
|
|
onDelete={vi.fn()}
|
|
onImageClick={vi.fn()}
|
|
/>
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
await flushReact();
|
|
|
|
const video = container.querySelector("video");
|
|
expect(video?.getAttribute("src")).toBe("/api/attachments/misclassified-mp4/content");
|
|
expect(container.textContent).toContain("application/octet-stream");
|
|
expect(fetchSpy).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("does not promote specific non-video content types by filename alone", async () => {
|
|
const attachment = makeAttachment({
|
|
id: "zip-mp4",
|
|
originalFilename: "bundle.mp4",
|
|
contentType: "application/zip",
|
|
contentPath: "/api/attachments/zip-mp4/content",
|
|
openPath: "/api/attachments/zip-mp4/content",
|
|
downloadPath: "/api/attachments/zip-mp4/content?download=1",
|
|
});
|
|
|
|
await act(async () => {
|
|
root.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<IssueAttachmentsSection
|
|
attachments={[attachment]}
|
|
onDelete={vi.fn()}
|
|
onImageClick={vi.fn()}
|
|
/>
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
await flushReact();
|
|
|
|
expect(container.querySelector("video")).toBeNull();
|
|
expect(container.textContent).toContain("bundle.mp4");
|
|
expect(container.textContent).toContain("application/zip");
|
|
expect(fetchSpy).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("keeps generic attachments as compact file rows with open and download actions", async () => {
|
|
const attachment = makeAttachment({
|
|
id: "pdf-attachment",
|
|
originalFilename: "report.pdf",
|
|
contentType: "application/pdf",
|
|
contentPath: "/api/attachments/pdf-attachment/content",
|
|
});
|
|
|
|
await act(async () => {
|
|
root.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<IssueAttachmentsSection
|
|
attachments={[attachment]}
|
|
onDelete={vi.fn()}
|
|
onImageClick={vi.fn()}
|
|
/>
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
await flushReact();
|
|
|
|
expect(container.textContent).toContain("report.pdf");
|
|
expect(container.textContent).toContain("application/pdf");
|
|
expect(container.querySelector('a[aria-label="Open report.pdf"]')?.getAttribute("href")).toBe(
|
|
"/api/attachments/pdf-attachment/content",
|
|
);
|
|
expect(container.querySelector('a[aria-label="Download report.pdf"]')?.getAttribute("href")).toBe(
|
|
"/api/attachments/pdf-attachment/content?download=1",
|
|
);
|
|
});
|
|
|
|
it("can render read-only attachments without destructive controls", async () => {
|
|
const attachment = makeAttachment({
|
|
id: "read-only-pdf",
|
|
originalFilename: "stored-report.pdf",
|
|
contentType: "application/pdf",
|
|
contentPath: "/api/attachments/read-only-pdf/content",
|
|
});
|
|
|
|
await act(async () => {
|
|
root.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<IssueAttachmentsSection attachments={[attachment]} onImageClick={vi.fn()} />
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
await flushReact();
|
|
|
|
expect(container.textContent).toContain("stored-report.pdf");
|
|
expect(container.querySelector('a[aria-label="Open stored-report.pdf"]')).toBeTruthy();
|
|
expect(container.querySelector('a[aria-label="Download stored-report.pdf"]')).toBeTruthy();
|
|
expect(container.querySelector('button[title="Delete attachment"]')).toBeNull();
|
|
expect(container.textContent).not.toContain("Delete this attachment?");
|
|
});
|
|
});
|