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>
218 lines
6.5 KiB
TypeScript
218 lines
6.5 KiB
TypeScript
import { describe, expect, it } from "vitest";
|
|
import {
|
|
armIssueDetailInboxQuickArchive,
|
|
createIssueDetailLocationState,
|
|
createIssueDetailPath,
|
|
hasLegacyIssueDetailQuery,
|
|
readIssueDetailHeaderSeed,
|
|
readIssueDetailLocationState,
|
|
readIssueDetailBreadcrumb,
|
|
rememberIssueDetailLocationState,
|
|
shouldArmIssueDetailInboxQuickArchive,
|
|
withIssueDetailHeaderSeed,
|
|
} from "./issueDetailBreadcrumb";
|
|
import type { Issue } from "@paperclipai/shared";
|
|
|
|
const sessionStorageMock = (() => {
|
|
const store = new Map<string, string>();
|
|
return {
|
|
getItem: (key: string) => store.get(key) ?? null,
|
|
setItem: (key: string, value: string) => {
|
|
store.set(key, value);
|
|
},
|
|
clear: () => {
|
|
store.clear();
|
|
},
|
|
};
|
|
})();
|
|
|
|
Object.defineProperty(globalThis, "window", {
|
|
configurable: true,
|
|
value: { sessionStorage: sessionStorageMock },
|
|
});
|
|
|
|
describe("issueDetailBreadcrumb", () => {
|
|
function createIssue(overrides: Partial<Issue> = {}): Issue {
|
|
return {
|
|
id: "11111111-1111-4111-8111-111111111111",
|
|
companyId: "company-1",
|
|
projectId: "project-1",
|
|
projectWorkspaceId: null,
|
|
goalId: null,
|
|
parentId: null,
|
|
title: "Prefilled issue title",
|
|
description: null,
|
|
status: "todo",
|
|
priority: "medium",
|
|
assigneeAgentId: null,
|
|
assigneeUserId: null,
|
|
checkoutRunId: null,
|
|
executionRunId: null,
|
|
executionAgentNameKey: null,
|
|
executionLockedAt: null,
|
|
createdByAgentId: null,
|
|
createdByUserId: null,
|
|
issueNumber: 42,
|
|
identifier: "PAP-42",
|
|
originKind: "manual",
|
|
originId: null,
|
|
originRunId: null,
|
|
requestDepth: 0,
|
|
billingCode: null,
|
|
assigneeAdapterOverrides: null,
|
|
executionPolicy: null,
|
|
executionState: null,
|
|
executionWorkspaceId: null,
|
|
executionWorkspacePreference: null,
|
|
executionWorkspaceSettings: null,
|
|
startedAt: null,
|
|
completedAt: null,
|
|
cancelledAt: null,
|
|
hiddenAt: null,
|
|
project: {
|
|
id: "project-1",
|
|
companyId: "company-1",
|
|
urlKey: "paperclip-app",
|
|
goalId: null,
|
|
goalIds: [],
|
|
goals: [],
|
|
name: "Paperclip App",
|
|
description: null,
|
|
status: "in_progress",
|
|
leadAgentId: null,
|
|
targetDate: null,
|
|
color: null,
|
|
env: null,
|
|
pauseReason: null,
|
|
pausedAt: null,
|
|
executionWorkspacePolicy: null,
|
|
codebase: {
|
|
workspaceId: null,
|
|
repoUrl: null,
|
|
repoRef: null,
|
|
defaultRef: null,
|
|
repoName: null,
|
|
localFolder: null,
|
|
managedFolder: "/tmp/paperclip-app",
|
|
effectiveLocalFolder: "/tmp/paperclip-app",
|
|
origin: "local_folder",
|
|
},
|
|
workspaces: [],
|
|
primaryWorkspace: null,
|
|
archivedAt: null,
|
|
createdAt: new Date(),
|
|
updatedAt: new Date(),
|
|
},
|
|
goal: null,
|
|
currentExecutionWorkspace: null,
|
|
workProducts: [],
|
|
mentionedProjects: [],
|
|
myLastTouchAt: null,
|
|
lastExternalCommentAt: null,
|
|
lastActivityAt: null,
|
|
isUnreadForMe: false,
|
|
createdAt: new Date(),
|
|
updatedAt: new Date(),
|
|
...overrides,
|
|
workMode: overrides.workMode ?? "standard",
|
|
};
|
|
}
|
|
|
|
it("returns clean issue detail paths", () => {
|
|
expect(createIssueDetailPath("PAP-465")).toBe("/issues/PAP-465");
|
|
});
|
|
|
|
it("prefers the full breadcrumb from route state", () => {
|
|
const state = createIssueDetailLocationState("Inbox", "/inbox/mine", "inbox");
|
|
|
|
expect(readIssueDetailBreadcrumb("PAP-465", state, "?from=issues")).toEqual({
|
|
label: "Inbox",
|
|
href: "/inbox/mine",
|
|
});
|
|
});
|
|
|
|
it("falls back to the source query param when route state is unavailable", () => {
|
|
expect(readIssueDetailBreadcrumb("PAP-465", null, "?from=inbox")).toEqual({
|
|
label: "Inbox",
|
|
href: "/inbox",
|
|
});
|
|
});
|
|
|
|
it("can detect legacy query-based breadcrumb links", () => {
|
|
expect(hasLegacyIssueDetailQuery("?from=inbox&fromHref=%2Finbox%2Fmine")).toBe(true);
|
|
expect(hasLegacyIssueDetailQuery("?q=test")).toBe(false);
|
|
});
|
|
|
|
it("restores the exact breadcrumb href from the query fallback", () => {
|
|
expect(
|
|
readIssueDetailBreadcrumb("PAP-465", null, "?from=inbox&fromHref=%2FPAP%2Finbox%2Funread"),
|
|
).toEqual({
|
|
label: "Inbox",
|
|
href: "/PAP/inbox/unread",
|
|
});
|
|
});
|
|
|
|
it("reads hidden breadcrumb context from session storage when route state is unavailable", () => {
|
|
const state = createIssueDetailLocationState("Inbox", "/inbox/mine", "inbox");
|
|
sessionStorageMock.clear();
|
|
rememberIssueDetailLocationState("PAP-465", state);
|
|
|
|
expect(
|
|
readIssueDetailLocationState("PAP-465", null),
|
|
).toEqual({
|
|
issueDetailBreadcrumb: { label: "Inbox", href: "/inbox/mine" },
|
|
issueDetailSource: "inbox",
|
|
issueDetailInboxQuickArchiveArmed: false,
|
|
});
|
|
});
|
|
|
|
it("attaches and reads issue header seed data from route state", () => {
|
|
const seededState = withIssueDetailHeaderSeed(
|
|
createIssueDetailLocationState("Issues", "/issues", "issues"),
|
|
createIssue(),
|
|
);
|
|
|
|
expect(readIssueDetailHeaderSeed(seededState)).toEqual({
|
|
id: "11111111-1111-4111-8111-111111111111",
|
|
identifier: "PAP-42",
|
|
title: "Prefilled issue title",
|
|
status: "todo",
|
|
priority: "medium",
|
|
projectId: "project-1",
|
|
projectName: "Paperclip App",
|
|
originKind: "manual",
|
|
originId: null,
|
|
});
|
|
});
|
|
|
|
it("persists issue header seed data when breadcrumb state is remembered", () => {
|
|
const seededState = withIssueDetailHeaderSeed(
|
|
createIssueDetailLocationState("Inbox", "/inbox/mine", "inbox"),
|
|
createIssue(),
|
|
);
|
|
|
|
sessionStorageMock.clear();
|
|
rememberIssueDetailLocationState("PAP-42", seededState);
|
|
|
|
const restoredState = readIssueDetailLocationState("PAP-42", null);
|
|
expect(readIssueDetailHeaderSeed(restoredState)).toEqual({
|
|
id: "11111111-1111-4111-8111-111111111111",
|
|
identifier: "PAP-42",
|
|
title: "Prefilled issue title",
|
|
status: "todo",
|
|
priority: "medium",
|
|
projectId: "project-1",
|
|
projectName: "Paperclip App",
|
|
originKind: "manual",
|
|
originId: null,
|
|
});
|
|
});
|
|
|
|
it("can arm quick archive only for explicit inbox keyboard entry state", () => {
|
|
const state = createIssueDetailLocationState("Inbox", "/inbox/mine", "inbox");
|
|
|
|
expect(shouldArmIssueDetailInboxQuickArchive(state)).toBe(false);
|
|
expect(shouldArmIssueDetailInboxQuickArchive(armIssueDetailInboxQuickArchive(state))).toBe(true);
|
|
});
|
|
});
|