Files
PaperClipAI/ui/src/components/skill-studio/ForkSkillDialog.tsx
T
b13eb5b2b5 Skill Studio: three-pane skill IDE with sandboxed test runs (#9241)
## 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>
2026-07-09 13:08:56 -05:00

252 lines
8.7 KiB
TypeScript

import { useEffect, useMemo, useState } from "react";
import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
import { GitFork, Loader2, Users } from "lucide-react";
import type {
CompanySkillDetail,
CompanySkillForkPrecheckResult,
} from "@paperclipai/shared";
import { useNavigate } from "@/lib/router";
import { companySkillsApi } from "@/api/companySkills";
import { queryKeys } from "@/lib/queryKeys";
import { skillStudioRoute } from "@/lib/company-skill-routes";
import { useOptionalToastActions } from "@/context/ToastContext";
import {
agentUsageSentence,
pickReusableFork,
reassignTargetIds,
} from "@/lib/skill-fork";
import { Button } from "@/components/ui/button";
import {
Dialog,
DialogContent,
DialogDescription,
DialogFooter,
DialogHeader,
DialogTitle,
} from "@/components/ui/dialog";
import { ToggleSwitch } from "@/components/ui/toggle-switch";
import { cn } from "@/lib/utils";
/**
* "Edit a copy" confirm dialog for read-only external skills (PAP-13112,
* plan §3.1 / §3.2). Forks the skill through the existing fork endpoint and —
* critically (P3, Dotta: "important! definitely need to show this to the
* user") — surfaces how many agents run the original and offers a default-ON
* switch to move them to the copy. When an un-diverged copy by the current
* actor already exists, it offers to open that instead of minting another
* (fork-sprawl guard, §5).
*/
export function ForkSkillDialog({
companyId,
skill,
open,
onOpenChange,
}: {
companyId: string;
skill: CompanySkillDetail;
open: boolean;
onOpenChange: (open: boolean) => void;
}) {
const navigate = useNavigate();
const queryClient = useQueryClient();
const toast = useOptionalToastActions();
const [reassign, setReassign] = useState(true);
// Seed from the already-loaded skill detail so the dialog renders instantly,
// then let the dedicated precheck endpoint refresh usage/existing-fork data.
const seededPrecheck: CompanySkillForkPrecheckResult = useMemo(
() => ({
skillId: skill.id,
original: {
id: skill.id,
name: skill.name,
slug: skill.slug,
sourceType: skill.sourceType,
sourceLocator: skill.sourceLocator,
sourceRef: skill.sourceRef,
},
agentUsageCount: skill.attachedAgentCount,
usedByAgents: skill.usedByAgents,
existingForks: skill.existingForks,
}),
[skill],
);
const precheckQuery = useQuery({
queryKey: queryKeys.companySkills.forkPrecheck(companyId, skill.id),
queryFn: () => companySkillsApi.forkPrecheck(companyId, skill.id),
enabled: open && Boolean(companyId && skill.id),
initialData: seededPrecheck,
});
const precheck = precheckQuery.data ?? seededPrecheck;
const usedByAgents = precheck.usedByAgents;
const agentCount = precheck.agentUsageCount;
const reusableFork = useMemo(
() => pickReusableFork(precheck.existingForks),
[precheck.existingForks],
);
// Reset the toggle each time the dialog opens (default ON per §3.2).
useEffect(() => {
if (open) setReassign(true);
}, [open]);
const forkMutation = useMutation({
mutationFn: () =>
companySkillsApi.fork(companyId, skill.id, {
reassignAgentIds: reassign ? reassignTargetIds(usedByAgents) : [],
}),
onSuccess: (result) => {
queryClient.invalidateQueries({ queryKey: queryKeys.companySkills.list(companyId) });
queryClient.invalidateQueries({
queryKey: queryKeys.companySkills.detail(companyId, skill.id),
});
queryClient.invalidateQueries({ queryKey: queryKeys.agents.list(companyId) });
for (const entry of result.reassignments) {
queryClient.invalidateQueries({
queryKey: queryKeys.agents.skills(entry.agentId),
});
}
const switched = result.reassignments.length;
toast?.pushToast({
tone: "success",
title: "Editing a copy",
body:
switched > 0
? `Created a copy of ${skill.name} and switched ${switched} ${switched === 1 ? "agent" : "agents"} to it.`
: `Created a copy of ${skill.name}. It's now editable.`,
});
onOpenChange(false);
navigate(skillStudioRoute(result.skill.id));
},
onError: (error) => {
toast?.pushToast({
tone: "error",
title: "Couldn't create a copy",
body: error instanceof Error ? error.message : "The fork request failed.",
});
},
});
const busy = forkMutation.isPending;
const forkLabel =
reassign && agentCount > 0
? `Create copy & switch ${agentCount} ${agentCount === 1 ? "agent" : "agents"}`
: "Create copy";
const openExisting = () => {
if (!reusableFork) return;
onOpenChange(false);
navigate(skillStudioRoute(reusableFork.id));
};
return (
<Dialog open={open} onOpenChange={(next) => (busy ? undefined : onOpenChange(next))}>
<DialogContent className="sm:max-w-lg">
<DialogHeader>
<DialogTitle className="flex items-center gap-2">
<GitFork className="h-4 w-4" />
Edit a copy of {skill.name}
</DialogTitle>
<DialogDescription>
{skill.name} is read-only because it comes from an external source.
Creating a fully editable copy in your workspace leaves the original
untouched and still updatable.
</DialogDescription>
</DialogHeader>
{reusableFork ? (
<div className="rounded-md border border-primary/40 bg-primary/5 p-3 text-sm">
<p className="font-medium text-foreground">You already have a copy</p>
<p className="mt-0.5 text-muted-foreground">
An unedited copy of this skill already exists. Open it instead of
making another.
</p>
<Button
type="button"
size="sm"
className="mt-2"
onClick={openExisting}
disabled={busy}
>
Open your existing copy
</Button>
</div>
) : null}
{/* P3 — unmissable agent-switch block (plan §3.2), not fine print. */}
<div
className={cn(
"rounded-md border p-3",
agentCount > 0 ? "border-amber-500/40 bg-amber-500/5" : "border-border bg-muted/30",
)}
>
<div className="flex items-center gap-2 text-sm font-medium text-foreground">
<Users className="h-4 w-4 shrink-0" />
<span>{agentUsageSentence(agentCount)}</span>
</div>
{agentCount > 0 ? (
<>
<div className="mt-2 flex flex-wrap gap-1.5">
{usedByAgents.map((agent) => (
<span
key={agent.id}
className="inline-flex items-center rounded-full border border-border bg-background px-2 py-0.5 text-xs text-foreground"
>
{agent.name}
</span>
))}
</div>
<label className="mt-3 flex items-start justify-between gap-3">
<span className="text-sm">
<span className="font-medium text-foreground">
Switch these agents to the copy
</span>
<span className="mt-0.5 block text-xs text-muted-foreground">
{reassign
? "These agents will run your copy instead of the original."
: "These agents keep running the original — your copy won't change what they do."}
</span>
</span>
<ToggleSwitch
checked={reassign}
onCheckedChange={setReassign}
disabled={busy}
aria-label="Switch these agents to the copy"
/>
</label>
</>
) : (
<p className="mt-1 text-xs text-muted-foreground">
Nothing is assigned to it, so your copy won't change any agent's
behaviour.
</p>
)}
</div>
<DialogFooter>
<Button
type="button"
variant="ghost"
onClick={() => onOpenChange(false)}
disabled={busy}
>
Cancel
</Button>
<Button
type="button"
variant={reusableFork ? "outline" : "default"}
onClick={() => forkMutation.mutate()}
disabled={busy}
>
{busy ? <Loader2 className="mr-1.5 h-4 w-4 animate-spin" /> : null}
{reusableFork ? "Create another copy" : forkLabel}
</Button>
</DialogFooter>
</DialogContent>
</Dialog>
);
}