Files
PaperClipAI/ui/src/lib/skill-fork.ts
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

120 lines
4.3 KiB
TypeScript

import type {
CompanySkillForkSummary,
CompanySkillOriginalSummary,
CompanySkillSourceType,
CompanySkillUsageAgent,
} from "@paperclipai/shared";
/**
* Pure logic for the Skill Studio "Edit a copy" fork flow (PAP-13112). Kept
* free of React so the dialog's decision logic — lineage labelling, existing-
* copy detection, agent-reassignment targeting — is unit-testable in isolation
* (plan §3 / §4.2 of PAP-13070).
*/
/**
* Shorten a git commit SHA to 7 characters for display. Branch/tag names and
* anything that is not a hex object id are returned unchanged so a pinned
* `main`/`v1.2.0` ref still reads sensibly in the lineage chip.
*/
export function shortSha(ref: string | null | undefined): string | null {
if (!ref) return null;
const trimmed = ref.trim();
if (!trimmed) return null;
return /^[0-9a-f]{8,40}$/i.test(trimmed) ? trimmed.slice(0, 7) : trimmed;
}
function sourceTypeFallbackLabel(sourceType: CompanySkillSourceType): string {
switch (sourceType) {
case "github":
return "GitHub";
case "skills_sh":
return "skills.sh";
case "url":
return "a URL";
case "catalog":
return "the catalog";
case "local_path":
return "a local path";
default:
return "its source";
}
}
/** Extract `owner/repo` from a GitHub URL or `owner/repo[/subpath][#ref]` shorthand. */
function githubOwnerRepo(locator: string): string | null {
let value = locator
.replace(/^git@github\.com:/i, "")
.replace(/^https?:\/\/github\.com\//i, "");
value = value.split("#")[0].split("?")[0].replace(/\.git$/i, "");
const segments = value.split("/").filter(Boolean);
return segments.length >= 2 ? `${segments[0]}/${segments[1]}` : null;
}
function prettyUrl(locator: string): string {
return locator.replace(/^https?:\/\//i, "").replace(/\/+$/, "");
}
/**
* Human-readable source name for a fork's origin — `owner/repo` for GitHub,
* a cleaned host/path for URLs, otherwise the raw locator or a source-type
* fallback when no locator is recorded.
*/
export function formatForkSourceName(source: {
sourceType: CompanySkillSourceType;
sourceLocator: string | null;
}): string {
const locator = source.sourceLocator?.trim() ?? "";
if (!locator) return sourceTypeFallbackLabel(source.sourceType);
if (source.sourceType === "github") return githubOwnerRepo(locator) ?? locator;
if (source.sourceType === "url") return prettyUrl(locator);
return locator;
}
/**
* The lineage chip label: `owner/repo @ <short-sha>` (the `@ sha` clause is
* dropped when the source has no pinned ref, e.g. skills.sh / URL sources).
*/
export function formatLineageLabel(original: CompanySkillOriginalSummary): string {
const name = formatForkSourceName(original);
const sha = shortSha(original.sourceRef);
return sha ? `${name} @ ${sha}` : name;
}
/**
* Fork-sprawl guard (plan §5): the first existing fork of this skill that the
* current actor created and has not yet diverged, so the dialog can offer
* "Open your existing copy" instead of minting `-fork-2`, `-fork-3`, … .
*/
export function pickReusableFork(
existingForks: CompanySkillForkSummary[],
): CompanySkillForkSummary | null {
return (
existingForks.find((fork) => fork.createdByCurrentActor && !fork.diverged) ?? null
);
}
/** Unmissable agent-usage sentence for the dialog body (P3 hard requirement). */
export function agentUsageSentence(count: number): string {
if (count <= 0) return "No agents currently use this skill";
return `${count} ${count === 1 ? "agent" : "agents"} currently use${count === 1 ? "s" : ""} this skill`;
}
/** Agent ids to reassign when the "Switch these agents to the copy" toggle is on. */
export function reassignTargetIds(usedByAgents: CompanySkillUsageAgent[]): string[] {
return usedByAgents.map((agent) => agent.id);
}
/**
* Whether a skill is repo-synced (`project_scan`) — editable, but its saves
* write directly into the user's project working tree (plan §3.3). Detected via
* the skill's `metadata.sourceKind`.
*/
export function isProjectScanSkill(
metadata: Record<string, unknown> | null | undefined,
): boolean {
if (!metadata || typeof metadata !== "object") return false;
const raw = (metadata as Record<string, unknown>).sourceKind;
return typeof raw === "string" && raw.trim() === "project_scan";
}