forked from farhoodlabs/paperclip
a1b30c9f35
## 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 row:  Desktop staged standard toggle:  Mobile planning detail:  Mobile planning row:  ## 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>
262 lines
7.5 KiB
TypeScript
262 lines
7.5 KiB
TypeScript
// @vitest-environment jsdom
|
|
|
|
import { act } from "react";
|
|
import { createRoot } from "react-dom/client";
|
|
import type { Issue } from "@paperclipai/shared";
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
import { IssueRow } from "./IssueRow";
|
|
|
|
vi.mock("@/lib/router", () => ({
|
|
Link: ({
|
|
children,
|
|
className,
|
|
disableIssueQuicklook: _disableIssueQuicklook,
|
|
issuePrefetch,
|
|
...props
|
|
}: React.ComponentProps<"a"> & { disableIssueQuicklook?: boolean; issuePrefetch?: Issue | null }) => (
|
|
<a
|
|
className={className}
|
|
data-disable-issue-quicklook={_disableIssueQuicklook ? "true" : undefined}
|
|
data-issue-prefetch-id={issuePrefetch?.id}
|
|
{...props}
|
|
>
|
|
{children}
|
|
</a>
|
|
),
|
|
}));
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
(globalThis as any).IS_REACT_ACT_ENVIRONMENT = true;
|
|
|
|
function createIssue(overrides: Partial<Issue> = {}): Issue {
|
|
return {
|
|
id: "issue-1",
|
|
identifier: "PAP-1",
|
|
companyId: "company-1",
|
|
projectId: null,
|
|
projectWorkspaceId: null,
|
|
goalId: null,
|
|
parentId: null,
|
|
title: "Inbox item",
|
|
description: null,
|
|
status: "todo",
|
|
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-03-11T00:00:00.000Z"),
|
|
updatedAt: new Date("2026-03-11T00:00:00.000Z"),
|
|
labels: [],
|
|
labelIds: [],
|
|
myLastTouchAt: null,
|
|
lastExternalCommentAt: null,
|
|
isUnreadForMe: false,
|
|
...overrides,
|
|
workMode: overrides.workMode ?? "standard",
|
|
};
|
|
}
|
|
|
|
describe("IssueRow", () => {
|
|
let container: HTMLDivElement;
|
|
|
|
beforeEach(() => {
|
|
container = document.createElement("div");
|
|
document.body.appendChild(container);
|
|
});
|
|
|
|
afterEach(() => {
|
|
container.remove();
|
|
});
|
|
|
|
it("suppresses accent hover styling when the row is selected", () => {
|
|
const root = createRoot(container);
|
|
const issue = createIssue();
|
|
|
|
act(() => {
|
|
root.render(<IssueRow issue={issue} selected />);
|
|
});
|
|
|
|
const link = container.querySelector("[data-inbox-issue-link]") as HTMLAnchorElement | null;
|
|
expect(link).not.toBeNull();
|
|
expect(link?.className).toContain("hover:bg-transparent");
|
|
expect(link?.className).not.toContain("hover:bg-accent/50");
|
|
|
|
act(() => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it("neutralizes selected status and unread dot accents", () => {
|
|
const root = createRoot(container);
|
|
|
|
act(() => {
|
|
root.render(<IssueRow issue={createIssue()} selected unreadState="visible" />);
|
|
});
|
|
|
|
const markReadButton = container.querySelector('button[aria-label="Mark as read"]');
|
|
const unreadDot = markReadButton?.querySelector("span");
|
|
const statusIcon = container.querySelector('span[class*="border-muted-foreground"]');
|
|
|
|
expect(markReadButton).not.toBeNull();
|
|
expect(markReadButton?.className).toContain("hover:bg-muted/80");
|
|
expect(markReadButton?.className).not.toContain("hover:bg-blue-500/20");
|
|
expect(unreadDot).not.toBeNull();
|
|
expect(unreadDot?.className).toContain("bg-muted-foreground/70");
|
|
expect(unreadDot?.className).not.toContain("bg-blue-600");
|
|
expect(statusIcon).not.toBeNull();
|
|
expect(statusIcon?.className).toContain("!border-muted-foreground");
|
|
expect(statusIcon?.className).toContain("!text-muted-foreground");
|
|
|
|
act(() => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it("preserves the issue detail breadcrumb source and href in the link target", () => {
|
|
const root = createRoot(container);
|
|
const issue = createIssue();
|
|
const state = {
|
|
issueDetailBreadcrumb: { label: "Inbox", href: "/PAP/inbox/mine" },
|
|
issueDetailSource: "inbox",
|
|
};
|
|
|
|
act(() => {
|
|
root.render(<IssueRow issue={issue} issueLinkState={state} />);
|
|
});
|
|
|
|
const link = container.querySelector("[data-inbox-issue-link]") as HTMLAnchorElement | null;
|
|
expect(link).not.toBeNull();
|
|
expect(link?.getAttribute("to") ?? link?.getAttribute("href")).toBe("/issues/PAP-1");
|
|
|
|
act(() => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it("opts issue quicklook out for dense inbox rows", () => {
|
|
const root = createRoot(container);
|
|
|
|
act(() => {
|
|
root.render(<IssueRow issue={createIssue()} />);
|
|
});
|
|
|
|
const link = container.querySelector("[data-inbox-issue-link]") as HTMLAnchorElement | null;
|
|
expect(link).not.toBeNull();
|
|
expect(link?.getAttribute("data-disable-issue-quicklook")).toBe("true");
|
|
|
|
act(() => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it("passes the visible row issue into the navigation prefetch path", () => {
|
|
const root = createRoot(container);
|
|
|
|
act(() => {
|
|
root.render(<IssueRow issue={createIssue()} />);
|
|
});
|
|
|
|
const link = container.querySelector("[data-inbox-issue-link]") as HTMLAnchorElement | null;
|
|
expect(link?.getAttribute("data-issue-prefetch-id")).toBe("issue-1");
|
|
|
|
act(() => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it("renders titleSuffix inline after the issue title", () => {
|
|
const root = createRoot(container);
|
|
const issue = createIssue({ title: "Parent task" });
|
|
|
|
act(() => {
|
|
root.render(
|
|
<IssueRow
|
|
issue={issue}
|
|
titleSuffix={<span data-testid="suffix">(3 sub-tasks)</span>}
|
|
/>,
|
|
);
|
|
});
|
|
|
|
const titleEl = container.querySelector(".line-clamp-2, .truncate");
|
|
expect(titleEl?.textContent).toContain("Parent task");
|
|
expect(titleEl?.textContent).toContain("(3 sub-tasks)");
|
|
expect(container.querySelector('[data-testid="suffix"]')).not.toBeNull();
|
|
|
|
act(() => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it("renders checklist step numbers beside the issue identifier", () => {
|
|
const root = createRoot(container);
|
|
|
|
act(() => {
|
|
root.render(
|
|
<IssueRow
|
|
issue={createIssue({ identifier: "PAP-42" })}
|
|
checklistStepNumber="2.1"
|
|
mobileMeta="updated now"
|
|
/>,
|
|
);
|
|
});
|
|
|
|
const link = container.querySelector("[data-inbox-issue-link]") as HTMLAnchorElement | null;
|
|
const metaRow = Array.from(link?.querySelectorAll("span.flex.items-center.gap-2") ?? [])
|
|
.find((element) => element.textContent?.includes("PAP-42"));
|
|
|
|
expect(metaRow).not.toBeUndefined();
|
|
expect(metaRow?.textContent?.replace(/\s+/g, "")).toContain("2.1.PAP-42");
|
|
|
|
act(() => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it("renders planning mode marker for planning work mode issues", () => {
|
|
const root = createRoot(container);
|
|
|
|
act(() => {
|
|
root.render(<IssueRow issue={createIssue({ workMode: "planning" })} />);
|
|
});
|
|
|
|
const link = container.querySelector("[data-inbox-issue-link]") as HTMLAnchorElement | null;
|
|
expect(link).not.toBeNull();
|
|
expect(link?.textContent).toContain("Planning");
|
|
|
|
act(() => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it("renders without error when titleSuffix is omitted", () => {
|
|
const root = createRoot(container);
|
|
|
|
act(() => {
|
|
root.render(<IssueRow issue={createIssue()} />);
|
|
});
|
|
|
|
const titleEl = container.querySelector(".line-clamp-2, .truncate");
|
|
expect(titleEl?.textContent).toContain("Inbox item");
|
|
|
|
act(() => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
});
|