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

147 lines
4.9 KiB
TypeScript

import { describe, expect, it } from "vitest";
import type {
CompanySkillForkSummary,
CompanySkillOriginalSummary,
CompanySkillUsageAgent,
} from "@paperclipai/shared";
import {
agentUsageSentence,
formatForkSourceName,
formatLineageLabel,
isProjectScanSkill,
pickReusableFork,
reassignTargetIds,
shortSha,
} from "./skill-fork";
function original(
over: Partial<CompanySkillOriginalSummary> = {},
): CompanySkillOriginalSummary {
return {
id: "orig-1",
name: "Deep Research",
slug: "deep-research",
sourceType: "github",
sourceLocator: "https://github.com/anthropics/skills",
sourceRef: "0123456789abcdef0123456789abcdef01234567",
...over,
};
}
function fork(over: Partial<CompanySkillForkSummary> = {}): CompanySkillForkSummary {
return {
...original(),
id: "fork-1",
key: "deep-research-fork",
forkedFromSkillId: "orig-1",
forkedFromCompanyId: "co-1",
currentVersionId: "v1",
createdByCurrentActor: true,
diverged: false,
createdAt: new Date("2026-07-09T00:00:00Z"),
updatedAt: new Date("2026-07-09T00:00:00Z"),
...over,
};
}
describe("shortSha", () => {
it("shortens a full hex sha to 7 chars", () => {
expect(shortSha("0123456789abcdef0123456789abcdef01234567")).toBe("0123456");
});
it("leaves branch/tag names intact", () => {
expect(shortSha("main")).toBe("main");
expect(shortSha("v1.2.0")).toBe("v1.2.0");
});
it("returns null for empty/nullish refs", () => {
expect(shortSha(null)).toBeNull();
expect(shortSha("")).toBeNull();
expect(shortSha(" ")).toBeNull();
});
});
describe("formatForkSourceName", () => {
it("extracts owner/repo from a github url", () => {
expect(
formatForkSourceName({ sourceType: "github", sourceLocator: "https://github.com/anthropics/skills" }),
).toBe("anthropics/skills");
});
it("extracts owner/repo from github shorthand with subpath and ref", () => {
expect(
formatForkSourceName({ sourceType: "github", sourceLocator: "anthropics/skills/some/path#main" }),
).toBe("anthropics/skills");
});
it("strips .git and ssh scheme", () => {
expect(
formatForkSourceName({ sourceType: "github", sourceLocator: "git@github.com:anthropics/skills.git" }),
).toBe("anthropics/skills");
});
it("cleans a url source", () => {
expect(
formatForkSourceName({ sourceType: "url", sourceLocator: "https://example.com/skill/" }),
).toBe("example.com/skill");
});
it("falls back to a source-type label when no locator", () => {
expect(formatForkSourceName({ sourceType: "skills_sh", sourceLocator: null })).toBe("skills.sh");
expect(formatForkSourceName({ sourceType: "catalog", sourceLocator: null })).toBe("the catalog");
});
});
describe("formatLineageLabel", () => {
it("includes short sha when a hex ref is pinned", () => {
expect(formatLineageLabel(original())).toBe("anthropics/skills @ 0123456");
});
it("omits the sha clause when no ref is present", () => {
expect(formatLineageLabel(original({ sourceRef: null }))).toBe("anthropics/skills");
});
});
describe("pickReusableFork", () => {
it("returns an un-diverged fork by the current actor", () => {
const reusable = fork({ id: "reuse-me" });
expect(pickReusableFork([reusable])?.id).toBe("reuse-me");
});
it("ignores diverged forks", () => {
expect(pickReusableFork([fork({ diverged: true })])).toBeNull();
});
it("ignores forks created by other actors", () => {
expect(pickReusableFork([fork({ createdByCurrentActor: false })])).toBeNull();
});
it("returns null with no forks", () => {
expect(pickReusableFork([])).toBeNull();
});
});
describe("agentUsageSentence", () => {
it("handles zero", () => {
expect(agentUsageSentence(0)).toBe("No agents currently use this skill");
});
it("uses singular verb agreement for one agent", () => {
expect(agentUsageSentence(1)).toBe("1 agent currently uses this skill");
});
it("uses plural for many", () => {
expect(agentUsageSentence(3)).toBe("3 agents currently use this skill");
});
});
describe("reassignTargetIds", () => {
it("maps usage agents to their ids", () => {
const agents: CompanySkillUsageAgent[] = [
{ id: "a1", name: "One", urlKey: "one", adapterType: "claude", desired: true, actualState: null, versionId: null },
{ id: "a2", name: "Two", urlKey: "two", adapterType: "codex", desired: true, actualState: null, versionId: null },
];
expect(reassignTargetIds(agents)).toEqual(["a1", "a2"]);
});
});
describe("isProjectScanSkill", () => {
it("detects project_scan metadata", () => {
expect(isProjectScanSkill({ sourceKind: "project_scan" })).toBe(true);
});
it("ignores other source kinds / missing metadata", () => {
expect(isProjectScanSkill({ sourceKind: "managed_local" })).toBe(false);
expect(isProjectScanSkill(null)).toBe(false);
expect(isProjectScanSkill(undefined)).toBe(false);
expect(isProjectScanSkill({})).toBe(false);
});
});