Files
PaperClipAI/ui/src/components/folders/skill-folder-tree.test.ts
T
DottaandPaperclip 52aea90263 feat: organize skills with nested folders and My Skills (#9633)
## Thinking Path

> - Paperclip is the open source control plane people use to organize
and govern AI-agent companies
> - Company skills are durable resources that users browse, import,
assign, and maintain over time
> - A flat skill list plus tags does not provide a stable location or
hierarchy for personal, company, project-imported, and bundled skills
> - Folder paths need to be canonical, company-scoped, safe to move, and
preserved across re-imports without changing skill IDs
> - The `/skills` UI also needs traversal, breadcrumbs, move/create
flows, and a dedicated My Skills namespace that work on desktop and
mobile
> - This pull request adds the folder data model and APIs, reserved-root
lifecycle, project import behavior, and the folder-first skills
experience
> - The benefit is a predictable filesystem-like organization model
while tags remain available for cross-cutting classification

## Linked Issues or Issue Description

Refs #9619 — the reviewed folder foundation was intentionally closed and
folded into this combined feature PR.
Refs #9026 — earlier flat-folder attempt superseded by this integrated
implementation.
Refs #3281 — related skill organization proposal; this PR uses canonical
persisted folders rather than deriving groups from skill keys, and does
not add hidden-skill behavior.

**Feature request**

- **Problem:** Skills currently lack a canonical hierarchical location,
making personal skills, project imports, bundled skills, and
company-authored skills difficult to traverse and manage at scale.
- **Proposed behavior:** Add nested company-scoped folders with stable
paths, reserved My/Projects/Bundled roots, subtree queries, safe
move/create operations, and a folder-first `/skills` library UI.
- **Import behavior:** New project scans file skills under
`projects/<project-slug>`; later imports update content without
overriding a user-selected folder.
- **Alternatives considered:** Tags alone remain useful for
cross-cutting classification, but they do not provide canonical
location, nesting, reserved namespaces, or stable import placement.
- **Roadmap alignment:** Extends the completed Skills Manager and
Scheduled Routines capabilities without duplicating an active roadmap
item.

## What Changed

- Adds `folders` persistence for routine and skill folders, nested
canonical paths, parent/slug/system-key fields, migration backfills, and
reapply-safe migrations `0174`–`0175` after current master migrations.
- Adds company-scoped folder CRUD, cycle/depth/namespace validation,
reserved My/Projects/Bundled lifecycle, item moves, subtree filtering,
and folder paths on skill results.
- Preserves project-import placement: first import files into the
project folder, while re-import keeps user-owned placement and stable
skill IDs.
- Adds the `/skills` folder tree rail, tags facet, breadcrumbs,
subfolder browser, move/new-folder dialog, canonical detail location,
inline tag editing, and folder-aware Studio creation.
- Keeps bundled skills read-only even when their source metadata is
incomplete by detecting the reserved Bundled folder and hiding
selection/move actions.
- Extends routine folder UI and OpenAPI coverage, and adds regression
tests across migrations, services, routes, tree helpers, pages, and
Studio creation.

## Verification

- `pnpm exec vitest run
packages/db/src/nested-skill-folders-migration.test.ts
server/src/__tests__/folders-routes.test.ts
server/src/__tests__/folders-service.test.ts
server/src/__tests__/company-skills-service.test.ts
server/src/__tests__/routines-service.test.ts
ui/src/components/folders/FolderControls.test.tsx
ui/src/components/folders/SkillFolderTree.test.tsx
ui/src/components/folders/skill-folder-tree.test.ts
ui/src/pages/CompanySkills.test.tsx ui/src/pages/Routines.test.tsx
ui/src/pages/SkillStudio.test.tsx
ui/src/lib/company-skill-routes.test.ts ui/src/lib/skill-create.test.ts`
— 13 files, 192 tests passed.
- `pnpm exec vitest run ui/src/pages/CompanySkills.test.tsx
ui/src/components/folders/SkillFolderTree.test.tsx` — 2 files, 20 tests
passed after preserving the existing PR's bundled-skill fixes.
- `pnpm -r typecheck` — passed for all workspace packages.
- `pnpm test:run` — passed in an isolated CI-like environment with
inherited Paperclip runtime identity and static AWS credential variables
removed.
- `pnpm build` — production build passed for all workspace packages.
- Greptile iteration 2 — 5/5 confidence with zero unresolved threads on
commit `ff2d67aa71`.
- Latest-head GitHub checks — all success, neutral, or skipped; PR is
mergeable with a clean merge state.
- `pnpm check:token-gates` — reports nine existing `#9627` comment false
positives already present on `master`; this PR introduces no new token
violation.

## Risks

- **Migration/backfill:** `0174` creates the foundation and `0175` adds
nested/reserved semantics. Both are ordered after current master
migration `0173`, are covered by numbering/safety checks, and are
designed to be reapply-safe.
- **Reserved namespaces:** My, Projects, and Bundled roots are
service-managed. Regression coverage prevents namespace squatting,
cross-company folder use, bundled writes, cycles, and excessive depth.
- **Behavioral change:** Project scans choose a project folder only on
initial creation; existing skills deliberately retain their current
folder during refresh.
- **UI scope:** The folder rail applies to the Installed library;
Catalog retains the discovery-oriented category sidebar.

> 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 `gpt-5.5` in Codex CLI, medium reasoning mode; runtime did not
expose a context-window value. Used repository/file tools, terminal
execution, Git/GitHub operations, test execution, and code editing.

## 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>
2026-07-16 15:50:45 -05:00

119 lines
5.4 KiB
TypeScript

import { describe, expect, it } from "vitest";
import type { FolderListItem } from "@paperclipai/shared";
import {
buildSkillFolderTree,
folderBreadcrumbTrail,
isBundledFolder,
isProjectsFolder,
reservedRootLabel,
skillFolderDisplayPath,
skillFolderPathDisplayFallback,
subtreeFolderIds,
} from "./skill-folder-tree";
function folder(partial: Partial<FolderListItem> & { id: string; slug: string; path: string }): FolderListItem {
return {
companyId: "co",
kind: "skill",
parentId: null,
name: partial.slug,
systemKey: null,
depth: 1,
color: null,
position: 0,
itemCount: 0,
createdAt: new Date(),
updatedAt: new Date(),
...partial,
};
}
const folders: FolderListItem[] = [
folder({ id: "my", slug: "my", path: "my", systemKey: "my", name: "my", position: 0 }),
folder({ id: "mine", slug: "dotta", path: "my/dotta", parentId: "my", systemKey: "my:u1", depth: 2, position: 0 }),
folder({ id: "eng", slug: "engineering", path: "engineering", name: "Engineering", position: 1 }),
folder({ id: "eng-review", slug: "review", path: "engineering/review", parentId: "eng", depth: 2, name: "Review", position: 0 }),
folder({ id: "proj", slug: "projects", path: "projects", systemKey: "projects", name: "projects", position: 2 }),
folder({ id: "proj-a", slug: "acme", path: "projects/acme", parentId: "proj", systemKey: "project:a", depth: 2 }),
folder({ id: "bundled", slug: "bundled", path: "bundled", systemKey: "bundled", name: "bundled", position: 3 }),
folder({ id: "bundled-git", slug: "git", path: "bundled/git", parentId: "bundled", systemKey: "bundled:git", depth: 2 }),
];
describe("buildSkillFolderTree", () => {
it("groups reserved roots and company folders in order", () => {
const model = buildSkillFolderTree(folders);
expect(model.my?.folder.id).toBe("my");
expect(model.projects?.folder.id).toBe("proj");
expect(model.bundled?.folder.id).toBe("bundled");
expect(model.company.map((n) => n.folder.id)).toEqual(["eng"]);
// Ordered roots: My → company → Projects → Bundled.
expect(model.roots.map((n) => n.folder.id)).toEqual(["my", "eng", "proj", "bundled"]);
});
it("nests children under their parent", () => {
const model = buildSkillFolderTree(folders);
expect(model.my?.children.map((n) => n.folder.id)).toEqual(["mine"]);
expect(model.company[0]?.children.map((n) => n.folder.id)).toEqual(["eng-review"]);
expect(model.childrenById.get("bundled")?.map((n) => n.folder.id)).toEqual(["bundled-git"]);
});
});
describe("subtreeFolderIds", () => {
it("includes the folder and all descendants", () => {
const model = buildSkillFolderTree(folders);
expect([...subtreeFolderIds(model, "eng")].sort()).toEqual(["eng", "eng-review"]);
expect([...subtreeFolderIds(model, "my")].sort()).toEqual(["mine", "my"]);
expect([...subtreeFolderIds(model, "eng-review")]).toEqual(["eng-review"]);
});
});
describe("folderBreadcrumbTrail", () => {
it("walks from top-level root down to the target", () => {
const model = buildSkillFolderTree(folders);
expect(folderBreadcrumbTrail(model, "eng-review").map((f) => f.id)).toEqual(["eng", "eng-review"]);
expect(folderBreadcrumbTrail(model, "mine").map((f) => f.id)).toEqual(["my", "mine"]);
});
});
describe("reserved subtree detection", () => {
it("flags bundled root and descendants", () => {
expect(isBundledFolder({ path: "bundled", systemKey: "bundled" })).toBe(true);
expect(isBundledFolder({ path: "bundled/git", systemKey: "bundled:git" })).toBe(true);
expect(isBundledFolder({ path: "engineering", systemKey: null })).toBe(false);
});
it("flags projects root and descendants", () => {
expect(isProjectsFolder({ path: "projects", systemKey: "projects" })).toBe(true);
expect(isProjectsFolder({ path: "projects/acme", systemKey: "project:a" })).toBe(true);
expect(isProjectsFolder({ path: "my/dotta", systemKey: "my:u1" })).toBe(false);
});
});
describe("reservedRootLabel", () => {
it("renames reserved roots and passes through others", () => {
expect(reservedRootLabel({ systemKey: "my", name: "my" })).toBe("My Skills");
expect(reservedRootLabel({ systemKey: "projects", name: "projects" })).toBe("Projects");
expect(reservedRootLabel({ systemKey: "bundled", name: "bundled" })).toBe("Bundled");
expect(reservedRootLabel({ systemKey: null, name: "Engineering" })).toBe("Engineering");
});
});
describe("skillFolderDisplayPath", () => {
it("prefixes company folders and preserves reserved-root labels", () => {
const model = buildSkillFolderTree(folders);
expect(skillFolderDisplayPath(model, "eng-review")).toBe("Company / Engineering / Review");
expect(skillFolderDisplayPath(model, "mine")).toBe("My Skills / dotta");
expect(skillFolderDisplayPath(model, "bundled-git")).toBe("Bundled / git");
expect(skillFolderDisplayPath(model, null)).toBeNull();
});
});
describe("skillFolderPathDisplayFallback", () => {
it("humanizes cold detail paths before folder metadata loads", () => {
expect(skillFolderPathDisplayFallback("engineering/code-review")).toBe("Company / Engineering / Code Review");
expect(skillFolderPathDisplayFallback("my/local-board/drafts")).toBe("My Skills / Local Board / Drafts");
expect(skillFolderPathDisplayFallback("bundled/review-pr")).toBe("Bundled / Review Pr");
expect(skillFolderPathDisplayFallback(null)).toBeNull();
});
});