mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-21 08:22:20 +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>
399 lines
14 KiB
TypeScript
399 lines
14 KiB
TypeScript
import { useMemo, useState, type DragEvent, type ReactNode } from "react";
|
|
import { useQuery } from "@tanstack/react-query";
|
|
import type { IssueAttachment } from "@paperclipai/shared";
|
|
import { Download, ExternalLink, FileText, Maximize2, Paperclip, Trash2 } from "lucide-react";
|
|
import { Button } from "@/components/ui/button";
|
|
import { FoldCurtain } from "./FoldCurtain";
|
|
import { MarkdownBody } from "./MarkdownBody";
|
|
import { OutputFileTile } from "./issue-output/OutputFileTile";
|
|
import { OutputVideoPlayer } from "./issue-output/OutputVideoPlayer";
|
|
import { formatBytes } from "@/lib/issue-output";
|
|
import {
|
|
attachmentDownloadPath,
|
|
attachmentFilename,
|
|
attachmentOpenPath,
|
|
isImageAttachment,
|
|
isMarkdownAttachment,
|
|
isVideoAttachment,
|
|
} from "@/lib/issue-attachments";
|
|
import { queryKeys } from "@/lib/queryKeys";
|
|
import { cn } from "@/lib/utils";
|
|
import { Card } from "@/components/ui/card";
|
|
|
|
interface IssueAttachmentsSectionProps {
|
|
attachments: IssueAttachment[];
|
|
uploadButton?: ReactNode;
|
|
error?: string | null;
|
|
dragActive?: boolean;
|
|
deletePending?: boolean;
|
|
onDelete?: (attachmentId: string) => void;
|
|
onImageClick: (attachment: IssueAttachment) => void;
|
|
onDragEnter?: (evt: DragEvent<HTMLDivElement>) => void;
|
|
onDragOver?: (evt: DragEvent<HTMLDivElement>) => void;
|
|
onDragLeave?: (evt: DragEvent<HTMLDivElement>) => void;
|
|
onDrop?: (evt: DragEvent<HTMLDivElement>) => void;
|
|
}
|
|
|
|
async function fetchAttachmentText(attachment: IssueAttachment) {
|
|
const response = await fetch(attachment.contentPath, {
|
|
headers: { Accept: "text/markdown,text/plain;q=0.9,*/*;q=0.1" },
|
|
});
|
|
if (!response.ok) {
|
|
throw new Error(`Unable to load attachment preview (${response.status})`);
|
|
}
|
|
return response.text();
|
|
}
|
|
|
|
function AttachmentActions({
|
|
attachment,
|
|
onDelete,
|
|
deletePending,
|
|
onPreview,
|
|
}: {
|
|
attachment: IssueAttachment;
|
|
onDelete?: (attachmentId: string) => void;
|
|
deletePending?: boolean;
|
|
onPreview?: (attachment: IssueAttachment) => void;
|
|
}) {
|
|
const filename = attachmentFilename(attachment);
|
|
return (
|
|
<div className="flex shrink-0 items-center gap-1">
|
|
{onPreview ? (
|
|
<Button
|
|
variant="ghost"
|
|
size="icon-sm"
|
|
title="Browse gallery"
|
|
aria-label={`Browse ${filename} in gallery`}
|
|
onClick={() => onPreview(attachment)}
|
|
>
|
|
<Maximize2 className="h-4 w-4" />
|
|
</Button>
|
|
) : null}
|
|
<Button asChild variant="ghost" size="icon-sm" title="Open in new tab">
|
|
<a href={attachmentOpenPath(attachment)} target="_blank" rel="noreferrer" aria-label={`Open ${filename}`}>
|
|
<ExternalLink className="h-4 w-4" />
|
|
</a>
|
|
</Button>
|
|
<Button asChild variant="ghost" size="icon-sm" title="Download">
|
|
<a href={attachmentDownloadPath(attachment)} aria-label={`Download ${filename}`}>
|
|
<Download className="h-4 w-4" />
|
|
</a>
|
|
</Button>
|
|
{onDelete ? (
|
|
<Button
|
|
variant="ghost"
|
|
size="icon-sm"
|
|
title="Delete attachment"
|
|
className="text-muted-foreground hover:text-destructive"
|
|
onClick={() => onDelete(attachment.id)}
|
|
disabled={deletePending}
|
|
>
|
|
<Trash2 className="h-4 w-4" />
|
|
</Button>
|
|
) : null}
|
|
</div>
|
|
);
|
|
}
|
|
|
|
function AttachmentMeta({ attachment }: { attachment: IssueAttachment }) {
|
|
return (
|
|
<p className="mt-0.5 text-(length:--text-micro) text-muted-foreground">
|
|
Attachment · {attachment.contentType} · {formatBytes(attachment.byteSize)}
|
|
</p>
|
|
);
|
|
}
|
|
|
|
function MarkdownAttachmentCard({
|
|
attachment,
|
|
onDelete,
|
|
deletePending,
|
|
}: {
|
|
attachment: IssueAttachment;
|
|
onDelete?: (attachmentId: string) => void;
|
|
deletePending?: boolean;
|
|
}) {
|
|
const filename = attachmentFilename(attachment);
|
|
const { data, isLoading, error } = useQuery({
|
|
queryKey: queryKeys.issues.attachmentPreview(attachment.id),
|
|
queryFn: () => fetchAttachmentText(attachment),
|
|
});
|
|
|
|
return (
|
|
<div id={`attachment-${attachment.id}`} className="scroll-mt-20 rounded-lg border border-border p-3">
|
|
<div className="flex items-start justify-between gap-3">
|
|
<div className="min-w-0">
|
|
<div className="flex min-w-0 items-center gap-2">
|
|
<FileText className="h-4 w-4 shrink-0 text-muted-foreground" />
|
|
<span className="truncate text-sm font-medium" title={filename}>{filename}</span>
|
|
</div>
|
|
<AttachmentMeta attachment={attachment} />
|
|
</div>
|
|
<AttachmentActions attachment={attachment} onDelete={onDelete} deletePending={deletePending} />
|
|
</div>
|
|
<div className="mt-3 rounded-md hover:bg-accent/10">
|
|
{isLoading ? (
|
|
<p className="px-1 py-2 text-xs text-muted-foreground">Loading preview...</p>
|
|
) : error ? (
|
|
<p className="px-1 py-2 text-xs text-destructive">Could not load markdown preview.</p>
|
|
) : (
|
|
<FoldCurtain>
|
|
<MarkdownBody className="paperclip-edit-in-place-content min-h-(--sz-220px) text-sm leading-7" softBreaks={false}>
|
|
{data ?? ""}
|
|
</MarkdownBody>
|
|
</FoldCurtain>
|
|
)}
|
|
</div>
|
|
</div>
|
|
);
|
|
}
|
|
|
|
function VideoAttachmentCard({
|
|
attachment,
|
|
onDelete,
|
|
deletePending,
|
|
onPreview,
|
|
}: {
|
|
attachment: IssueAttachment;
|
|
onDelete?: (attachmentId: string) => void;
|
|
deletePending?: boolean;
|
|
onPreview?: (attachment: IssueAttachment) => void;
|
|
}) {
|
|
const filename = attachmentFilename(attachment);
|
|
return (
|
|
<Card id={`attachment-${attachment.id}`} className="block scroll-mt-20 overflow-hidden py-0">
|
|
<OutputVideoPlayer src={attachment.contentPath} title={filename} />
|
|
<div className="flex flex-col gap-2 p-3 md:flex-row md:items-center md:justify-between">
|
|
<div className="min-w-0">
|
|
<p className="break-words text-sm font-semibold text-foreground">{filename}</p>
|
|
<AttachmentMeta attachment={attachment} />
|
|
</div>
|
|
<AttachmentActions
|
|
attachment={attachment}
|
|
onDelete={onDelete}
|
|
deletePending={deletePending}
|
|
onPreview={onPreview}
|
|
/>
|
|
</div>
|
|
</Card>
|
|
);
|
|
}
|
|
|
|
function GenericAttachmentRow({
|
|
attachment,
|
|
onDelete,
|
|
deletePending,
|
|
}: {
|
|
attachment: IssueAttachment;
|
|
onDelete?: (attachmentId: string) => void;
|
|
deletePending?: boolean;
|
|
}) {
|
|
const filename = attachmentFilename(attachment);
|
|
return (
|
|
<Card id={`attachment-${attachment.id}`} className="flex-row scroll-mt-20 items-center gap-2.5 p-2">
|
|
<OutputFileTile contentType={attachment.contentType} />
|
|
<div className="min-w-0 flex-1">
|
|
<a
|
|
href={attachmentOpenPath(attachment)}
|
|
target="_blank"
|
|
rel="noreferrer"
|
|
className="block truncate text-sm font-medium text-foreground hover:underline"
|
|
title={filename}
|
|
>
|
|
{filename}
|
|
</a>
|
|
<p className="truncate text-(length:--text-micro) text-muted-foreground">
|
|
Attachment · {attachment.contentType} · {formatBytes(attachment.byteSize)}
|
|
</p>
|
|
</div>
|
|
<AttachmentActions attachment={attachment} onDelete={onDelete} deletePending={deletePending} />
|
|
</Card>
|
|
);
|
|
}
|
|
|
|
export function IssueAttachmentsSection({
|
|
attachments,
|
|
uploadButton,
|
|
error,
|
|
dragActive = false,
|
|
deletePending = false,
|
|
onDelete,
|
|
onImageClick,
|
|
onDragEnter,
|
|
onDragOver,
|
|
onDragLeave,
|
|
onDrop,
|
|
}: IssueAttachmentsSectionProps) {
|
|
const [confirmDeleteId, setConfirmDeleteId] = useState<string | null>(null);
|
|
const { imageAttachments, markdownAttachments, videoAttachments, genericAttachments } = useMemo(() => {
|
|
const images: IssueAttachment[] = [];
|
|
const markdown: IssueAttachment[] = [];
|
|
const videos: IssueAttachment[] = [];
|
|
const generic: IssueAttachment[] = [];
|
|
|
|
for (const attachment of attachments) {
|
|
if (isImageAttachment(attachment)) images.push(attachment);
|
|
else if (isMarkdownAttachment(attachment)) markdown.push(attachment);
|
|
else if (isVideoAttachment(attachment)) videos.push(attachment);
|
|
else generic.push(attachment);
|
|
}
|
|
|
|
return {
|
|
imageAttachments: images,
|
|
markdownAttachments: markdown,
|
|
videoAttachments: videos,
|
|
genericAttachments: generic,
|
|
};
|
|
}, [attachments]);
|
|
|
|
const requestDelete = (attachmentId: string) => setConfirmDeleteId(attachmentId);
|
|
const confirmDelete = (attachmentId: string) => {
|
|
if (!onDelete) return;
|
|
onDelete(attachmentId);
|
|
setConfirmDeleteId(null);
|
|
};
|
|
|
|
return (
|
|
<div
|
|
className={cn(
|
|
"space-y-3 rounded-lg transition-colors",
|
|
dragActive && "bg-primary/5",
|
|
)}
|
|
onDragEnter={onDragEnter}
|
|
onDragOver={onDragOver}
|
|
onDragLeave={onDragLeave}
|
|
onDrop={onDrop}
|
|
>
|
|
<div className="flex items-center justify-between gap-2">
|
|
<div className="flex items-center gap-2">
|
|
<Paperclip className="h-3.5 w-3.5 text-muted-foreground" aria-hidden="true" />
|
|
<h3 className="text-sm font-medium text-muted-foreground">Attachments</h3>
|
|
<span className="text-xs text-muted-foreground">{attachments.length}</span>
|
|
</div>
|
|
{uploadButton}
|
|
</div>
|
|
|
|
{error && (
|
|
<p className="text-xs text-destructive">{error}</p>
|
|
)}
|
|
|
|
{imageAttachments.length > 0 && (
|
|
<div className="grid grid-cols-4 gap-2">
|
|
{imageAttachments.map((attachment) => (
|
|
<div
|
|
key={attachment.id}
|
|
id={`attachment-${attachment.id}`}
|
|
className="group relative aspect-square cursor-pointer scroll-mt-20 overflow-hidden rounded-lg border border-border bg-accent/10"
|
|
onClick={() => onImageClick(attachment)}
|
|
>
|
|
<img
|
|
src={attachment.contentPath}
|
|
alt={attachment.originalFilename ?? "attachment"}
|
|
className="h-full w-full object-cover"
|
|
loading="lazy"
|
|
/>
|
|
<div className="absolute inset-0 bg-black/0 transition-colors group-hover:bg-black/30" />
|
|
{onDelete && confirmDeleteId === attachment.id ? (
|
|
<div
|
|
className="absolute inset-0 flex flex-col items-center justify-center gap-1.5 bg-black/60"
|
|
onClick={(event) => event.stopPropagation()}
|
|
>
|
|
<p className="text-xs font-medium text-white">Delete?</p>
|
|
<div className="flex gap-1.5">
|
|
<button
|
|
type="button"
|
|
className="rounded bg-destructive px-2 py-0.5 text-xs text-white hover:bg-destructive/80"
|
|
onClick={(event) => {
|
|
event.stopPropagation();
|
|
confirmDelete(attachment.id);
|
|
}}
|
|
disabled={deletePending}
|
|
>
|
|
Yes
|
|
</button>
|
|
<button
|
|
type="button"
|
|
className="rounded bg-muted px-2 py-0.5 text-xs hover:bg-muted/80"
|
|
onClick={(event) => {
|
|
event.stopPropagation();
|
|
setConfirmDeleteId(null);
|
|
}}
|
|
>
|
|
No
|
|
</button>
|
|
</div>
|
|
</div>
|
|
) : onDelete ? (
|
|
<button
|
|
type="button"
|
|
className="absolute right-1.5 top-1.5 rounded-md bg-black/50 p-1 text-white opacity-0 transition-opacity hover:bg-destructive group-hover:opacity-100"
|
|
onClick={(event) => {
|
|
event.stopPropagation();
|
|
requestDelete(attachment.id);
|
|
}}
|
|
title="Delete attachment"
|
|
>
|
|
<Trash2 className="h-3.5 w-3.5" />
|
|
</button>
|
|
) : null}
|
|
</div>
|
|
))}
|
|
</div>
|
|
)}
|
|
|
|
{markdownAttachments.length > 0 && (
|
|
<div className="space-y-3">
|
|
{markdownAttachments.map((attachment) => (
|
|
<MarkdownAttachmentCard
|
|
key={attachment.id}
|
|
attachment={attachment}
|
|
onDelete={onDelete ? requestDelete : undefined}
|
|
deletePending={deletePending}
|
|
/>
|
|
))}
|
|
</div>
|
|
)}
|
|
|
|
{videoAttachments.length > 0 && (
|
|
<div className="space-y-3">
|
|
{videoAttachments.map((attachment) => (
|
|
<VideoAttachmentCard
|
|
key={attachment.id}
|
|
attachment={attachment}
|
|
onDelete={onDelete ? requestDelete : undefined}
|
|
deletePending={deletePending}
|
|
onPreview={onImageClick}
|
|
/>
|
|
))}
|
|
</div>
|
|
)}
|
|
|
|
{genericAttachments.length > 0 && (
|
|
<div className="space-y-2">
|
|
{genericAttachments.map((attachment) => (
|
|
<GenericAttachmentRow
|
|
key={attachment.id}
|
|
attachment={attachment}
|
|
onDelete={onDelete ? requestDelete : undefined}
|
|
deletePending={deletePending}
|
|
/>
|
|
))}
|
|
</div>
|
|
)}
|
|
|
|
{onDelete && confirmDeleteId && !imageAttachments.some((attachment) => attachment.id === confirmDeleteId) ? (
|
|
<div className="flex items-center justify-between gap-3 rounded-md border border-destructive/20 bg-destructive/5 px-4 py-3">
|
|
<p className="text-sm font-medium text-destructive">Delete this attachment? This cannot be undone.</p>
|
|
<div className="flex shrink-0 items-center gap-2">
|
|
<Button variant="ghost" size="sm" onClick={() => setConfirmDeleteId(null)} disabled={deletePending}>
|
|
Cancel
|
|
</Button>
|
|
<Button variant="destructive" size="sm" onClick={() => confirmDelete(confirmDeleteId)} disabled={deletePending}>
|
|
{deletePending ? "Deleting..." : "Delete"}
|
|
</Button>
|
|
</div>
|
|
</div>
|
|
) : null}
|
|
</div>
|
|
);
|
|
}
|