Files
paperclip/ui/src/lib/issue-tree.test.ts
T
Dotta a1b30c9f35 Add planning mode for issue work (#5353)
## Thinking Path

> - Paperclip is a control plane for autonomous AI companies.
> - Issues are the core unit of work, and issue comments are how board
users and agents coordinate execution.
> - Some issue conversations need to produce plans and approvals instead
of immediate implementation work.
> - The existing issue contract did not distinguish standard execution
comments from planning-oriented issue work.
> - This pull request adds an issue work-mode contract and board UI
affordances for standard vs planning mode.
> - The benefit is that planning-mode issues can be created, displayed,
discussed, and carried through agent heartbeat context without losing
the normal issue workflow.

## What Changed

- Added `standard` / `planning` issue work-mode contracts across DB,
shared validators/types, server issue flows, plugin protocol, and
adapter heartbeat payloads.
- Added an idempotent `0081_optimal_dormammu` migration for
`issues.work_mode`, ordered after current `public-gh/master` migrations.
- Updated heartbeat/context summaries and issue-thread interaction
behavior so planning work mode is preserved when creating suggested
follow-up issues.
- Added UI support for planning-mode issue creation, issue rows, detail
composer styling, and composer work-mode toggles.
- Added focused server/shared/UI tests plus a Playwright visual
verification spec for planning-mode surfaces.
- Rebased the branch onto current `public-gh/master` and added durable
planning-mode screenshots under `doc/assets/pap-3368/`.

## Verification

- `pnpm --filter @paperclipai/db run check:migrations`
- `pnpm exec vitest run --project @paperclipai/shared
packages/shared/src/validators/issue.test.ts`
- `pnpm exec vitest run --project @paperclipai/server
server/src/__tests__/heartbeat-context-summary.test.ts
server/src/__tests__/issue-thread-interactions-service.test.ts
server/src/__tests__/issues-goal-context-routes.test.ts --pool=forks
--poolOptions.forks.isolate=true`
- `pnpm exec vitest run --project @paperclipai/ui
ui/src/components/IssueChatThread.test.tsx
ui/src/components/NewIssueDialog.test.tsx
ui/src/components/IssueRow.test.tsx ui/src/pages/IssueDetail.test.tsx`
- `pnpm exec vitest run --project @paperclipai/adapter-utils
packages/adapter-utils/src/server-utils.test.ts`
- `PAPERCLIP_E2E_SKIP_LLM=true npx playwright test --config
tests/e2e/playwright.config.ts
tests/e2e/planning-mode-visual-verification.spec.ts`

## Screenshots

Desktop planning detail:

![Desktop planning
detail](https://raw.githubusercontent.com/paperclipai/paperclip/PAP-3368-plan-a-planning-mode-for-issues/doc/assets/pap-3368/desktop-planning-detail.png)

Desktop planning row:

![Desktop planning
row](https://raw.githubusercontent.com/paperclipai/paperclip/PAP-3368-plan-a-planning-mode-for-issues/doc/assets/pap-3368/desktop-planning-row.png)

Desktop staged standard toggle:

![Desktop staged standard
toggle](https://raw.githubusercontent.com/paperclipai/paperclip/PAP-3368-plan-a-planning-mode-for-issues/doc/assets/pap-3368/desktop-standard-toggle.png)

Mobile planning detail:

![Mobile planning
detail](https://raw.githubusercontent.com/paperclipai/paperclip/PAP-3368-plan-a-planning-mode-for-issues/doc/assets/pap-3368/mobile-planning-detail.png)

Mobile planning row:

![Mobile planning
row](https://raw.githubusercontent.com/paperclipai/paperclip/PAP-3368-plan-a-planning-mode-for-issues/doc/assets/pap-3368/mobile-planning-row.png)

## Risks

- Medium migration risk: this adds a non-null issue column. The
migration uses `ADD COLUMN IF NOT EXISTS` so installations that applied
an older branch-local migration number can still apply the final
numbered migration safely.
- Medium contract risk: issue payloads, plugin payloads, and adapter
heartbeat payloads now include work mode; compatibility is handled by
defaulting missing values to `standard`.
- UI risk is moderate because composer controls changed; focused
component tests and visual e2e coverage exercise standard vs planning
display and toggle behavior.

> 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 in a local Paperclip worktree, with
shell/tool use. Exact context-window size is not exposed in this
runtime.

## 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 run tests locally and they pass
- [x] I have added or updated tests where applicable
- [x] If this change affects the UI, I have included before/after
screenshots
- [x] I have updated relevant documentation to reflect my changes
- [x] I have considered and documented any risks above
- [x] I will address all Greptile and reviewer comments before
requesting merge

---------

Co-authored-by: Paperclip <noreply@paperclip.ing>
2026-05-06 07:01:28 -05:00

162 lines
5.4 KiB
TypeScript

import { describe, expect, it } from "vitest";
import type { Issue } from "@paperclipai/shared";
import { buildIssueTree, countDescendants, filterIssueDescendants } from "./issue-tree";
function makeIssue(id: string, parentId: string | null = null): Issue {
return {
id,
identifier: id.toUpperCase(),
companyId: "company-1",
projectId: null,
projectWorkspaceId: null,
goalId: null,
parentId,
title: `Issue ${id}`,
description: null,
status: "todo",
workMode: "standard",
priority: "medium",
assigneeAgentId: null,
assigneeUserId: null,
createdByAgentId: null,
createdByUserId: null,
issueNumber: 1,
requestDepth: 0,
billingCode: null,
assigneeAdapterOverrides: null,
executionWorkspaceId: null,
executionWorkspacePreference: null,
executionWorkspaceSettings: null,
checkoutRunId: null,
executionRunId: null,
executionAgentNameKey: null,
executionLockedAt: null,
startedAt: null,
completedAt: null,
cancelledAt: null,
hiddenAt: null,
createdAt: new Date("2026-01-01T00:00:00.000Z"),
updatedAt: new Date("2026-01-01T00:00:00.000Z"),
labels: [],
labelIds: [],
myLastTouchAt: null,
lastExternalCommentAt: null,
isUnreadForMe: false,
};
}
describe("buildIssueTree", () => {
it("returns all items as roots when no parent-child relationships exist", () => {
const items = [makeIssue("a"), makeIssue("b"), makeIssue("c")];
const { roots, childMap } = buildIssueTree(items);
expect(roots.map((r) => r.id)).toEqual(["a", "b", "c"]);
expect(childMap.size).toBe(0);
});
it("places children under their parent and excludes them from roots", () => {
const parent = makeIssue("parent");
const child1 = makeIssue("child1", "parent");
const child2 = makeIssue("child2", "parent");
const { roots, childMap } = buildIssueTree([parent, child1, child2]);
expect(roots.map((r) => r.id)).toEqual(["parent"]);
expect(childMap.get("parent")?.map((c) => c.id)).toEqual(["child1", "child2"]);
});
it("handles multiple levels of nesting", () => {
const grandparent = makeIssue("gp");
const parent = makeIssue("p", "gp");
const child = makeIssue("c", "p");
const { roots, childMap } = buildIssueTree([grandparent, parent, child]);
expect(roots.map((r) => r.id)).toEqual(["gp"]);
expect(childMap.get("gp")?.map((i) => i.id)).toEqual(["p"]);
expect(childMap.get("p")?.map((i) => i.id)).toEqual(["c"]);
});
it("promotes orphaned sub-tasks (parent not in list) to root level", () => {
// child references a parent that is not in the items array (e.g. filtered out)
const child = makeIssue("child", "missing-parent");
const unrelated = makeIssue("unrelated");
const { roots, childMap } = buildIssueTree([child, unrelated]);
expect(roots.map((r) => r.id)).toEqual(["child", "unrelated"]);
expect(childMap.size).toBe(0);
});
it("returns empty roots and empty childMap for an empty list", () => {
const { roots, childMap } = buildIssueTree([]);
expect(roots).toEqual([]);
expect(childMap.size).toBe(0);
});
it("preserves list order within roots and within children", () => {
const p1 = makeIssue("p1");
const p2 = makeIssue("p2");
const c1 = makeIssue("c1", "p1");
const c2 = makeIssue("c2", "p1");
const { roots, childMap } = buildIssueTree([p1, c1, p2, c2]);
expect(roots.map((r) => r.id)).toEqual(["p1", "p2"]);
expect(childMap.get("p1")?.map((c) => c.id)).toEqual(["c1", "c2"]);
});
});
describe("countDescendants", () => {
it("returns 0 for a leaf node", () => {
const { childMap } = buildIssueTree([makeIssue("a")]);
expect(countDescendants("a", childMap)).toBe(0);
});
it("returns direct child count for a single-level parent", () => {
const { childMap } = buildIssueTree([
makeIssue("p"),
makeIssue("c1", "p"),
makeIssue("c2", "p"),
]);
expect(countDescendants("p", childMap)).toBe(2);
});
it("counts all descendants across multiple levels", () => {
// P → C → G1, G2 (P has 3 total descendants: C, G1, G2)
const { childMap } = buildIssueTree([
makeIssue("p"),
makeIssue("c", "p"),
makeIssue("g1", "c"),
makeIssue("g2", "c"),
]);
expect(countDescendants("p", childMap)).toBe(3);
});
it("returns 0 for an id not in the childMap", () => {
const { childMap } = buildIssueTree([makeIssue("a"), makeIssue("b")]);
expect(countDescendants("nonexistent", childMap)).toBe(0);
});
});
describe("filterIssueDescendants", () => {
it("returns only children and deeper descendants of the requested root", () => {
const root = makeIssue("root");
const child = makeIssue("child", "root");
const grandchild = makeIssue("grandchild", "child");
const unrelatedParent = makeIssue("other");
const unrelatedChild = makeIssue("other-child", "other");
expect(filterIssueDescendants("root", [
root,
child,
grandchild,
unrelatedParent,
unrelatedChild,
]).map((issue) => issue.id)).toEqual(["child", "grandchild"]);
});
it("handles stale broad issue-list responses without requiring the root in the list", () => {
const child = makeIssue("child", "root");
const grandchild = makeIssue("grandchild", "child");
const globalIssue = makeIssue("global");
expect(filterIssueDescendants("root", [
globalIssue,
child,
grandchild,
]).map((issue) => issue.id)).toEqual(["child", "grandchild"]);
});
});