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>
251 lines
7.4 KiB
TypeScript
251 lines
7.4 KiB
TypeScript
// @vitest-environment jsdom
|
|
|
|
import { act } from "react";
|
|
import type { ComponentProps } from "react";
|
|
import { createRoot } from "react-dom/client";
|
|
import type { ExecutionWorkspace, Issue } from "@paperclipai/shared";
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
import { IssueWorkspaceCard } from "./IssueWorkspaceCard";
|
|
|
|
const useQueryMock = vi.fn();
|
|
|
|
vi.mock("@tanstack/react-query", async () => {
|
|
const actual = await vi.importActual<typeof import("@tanstack/react-query")>("@tanstack/react-query");
|
|
return {
|
|
...actual,
|
|
useQuery: (options: unknown) => useQueryMock(options),
|
|
};
|
|
});
|
|
|
|
vi.mock("../context/CompanyContext", () => ({
|
|
useCompany: () => ({ selectedCompanyId: "company-1" }),
|
|
}));
|
|
|
|
vi.mock("@/lib/router", () => ({
|
|
Link: ({ children, className, ...props }: ComponentProps<"a">) => (
|
|
<a className={className} {...props}>{children}</a>
|
|
),
|
|
}));
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
(globalThis as any).IS_REACT_ACT_ENVIRONMENT = true;
|
|
|
|
function createExecutionWorkspace(overrides: Partial<ExecutionWorkspace> = {}): ExecutionWorkspace {
|
|
return {
|
|
id: "workspace-1",
|
|
companyId: "company-1",
|
|
projectId: "project-1",
|
|
projectWorkspaceId: "project-workspace-1",
|
|
sourceIssueId: null,
|
|
mode: "isolated_workspace",
|
|
strategyType: "git_worktree",
|
|
name: "Issue sandbox",
|
|
status: "active",
|
|
cwd: "/tmp/issue-sandbox",
|
|
repoUrl: null,
|
|
baseRef: null,
|
|
branchName: "paperclip/papa-81",
|
|
providerType: "git_worktree",
|
|
providerRef: null,
|
|
derivedFromExecutionWorkspaceId: null,
|
|
lastUsedAt: new Date("2026-04-16T05:00:00.000Z"),
|
|
openedAt: new Date("2026-04-16T04:59:00.000Z"),
|
|
closedAt: null,
|
|
cleanupEligibleAt: null,
|
|
cleanupReason: null,
|
|
config: {
|
|
environmentId: "env-workspace",
|
|
provisionCommand: null,
|
|
teardownCommand: null,
|
|
cleanupCommand: null,
|
|
workspaceRuntime: null,
|
|
desiredState: null,
|
|
},
|
|
metadata: null,
|
|
runtimeServices: [],
|
|
createdAt: new Date("2026-04-16T04:59:00.000Z"),
|
|
updatedAt: new Date("2026-04-16T05:00:00.000Z"),
|
|
...overrides,
|
|
};
|
|
}
|
|
|
|
function createIssue(overrides: Partial<Issue> = {}): Issue {
|
|
return {
|
|
id: "issue-1",
|
|
identifier: "PAPA-81",
|
|
companyId: "company-1",
|
|
projectId: "project-1",
|
|
projectWorkspaceId: "project-workspace-1",
|
|
goalId: null,
|
|
parentId: null,
|
|
title: "Sandboxing",
|
|
description: null,
|
|
status: "in_progress",
|
|
priority: "medium",
|
|
assigneeAgentId: "agent-1",
|
|
assigneeUserId: null,
|
|
createdByAgentId: null,
|
|
createdByUserId: null,
|
|
issueNumber: 81,
|
|
requestDepth: 0,
|
|
billingCode: null,
|
|
assigneeAdapterOverrides: null,
|
|
executionWorkspaceId: "workspace-1",
|
|
executionWorkspacePreference: "isolated_workspace",
|
|
executionWorkspaceSettings: {
|
|
mode: "isolated_workspace",
|
|
environmentId: "env-issue",
|
|
},
|
|
checkoutRunId: null,
|
|
executionRunId: null,
|
|
executionAgentNameKey: null,
|
|
executionLockedAt: null,
|
|
startedAt: null,
|
|
completedAt: null,
|
|
cancelledAt: null,
|
|
hiddenAt: null,
|
|
createdAt: new Date("2026-04-16T04:30:00.000Z"),
|
|
updatedAt: new Date("2026-04-16T05:30:00.000Z"),
|
|
labels: [],
|
|
labelIds: [],
|
|
currentExecutionWorkspace: null,
|
|
...overrides,
|
|
workMode: overrides.workMode ?? "standard",
|
|
};
|
|
}
|
|
|
|
describe("IssueWorkspaceCard", () => {
|
|
let container: HTMLDivElement;
|
|
|
|
beforeEach(() => {
|
|
container = document.createElement("div");
|
|
document.body.appendChild(container);
|
|
useQueryMock.mockReset();
|
|
});
|
|
|
|
afterEach(() => {
|
|
container.remove();
|
|
});
|
|
|
|
it("locks the environment selector and clears the issue override when reusing a workspace", () => {
|
|
const root = createRoot(container);
|
|
const onUpdate = vi.fn();
|
|
const reusableWorkspace = createExecutionWorkspace();
|
|
|
|
useQueryMock.mockImplementation((options: { queryKey: unknown[] }) => {
|
|
if (options.queryKey[0] === "instance") {
|
|
return { data: { enableEnvironments: true, enableIsolatedWorkspaces: true } };
|
|
}
|
|
if (options.queryKey[0] === "environments") {
|
|
return {
|
|
data: [{ id: "env-workspace", name: "Local", driver: "local" }],
|
|
};
|
|
}
|
|
if (options.queryKey[0] === "execution-workspaces") {
|
|
return { data: [reusableWorkspace] };
|
|
}
|
|
return { data: undefined };
|
|
});
|
|
|
|
act(() => {
|
|
root.render(
|
|
<IssueWorkspaceCard
|
|
issue={createIssue()}
|
|
project={{
|
|
id: "project-1",
|
|
executionWorkspacePolicy: {
|
|
enabled: true,
|
|
defaultMode: "isolated_workspace",
|
|
environmentId: "env-project",
|
|
},
|
|
}}
|
|
onUpdate={onUpdate}
|
|
/>,
|
|
);
|
|
});
|
|
|
|
const editButton = Array.from(container.querySelectorAll("button")).find((button) => button.textContent?.includes("Edit"));
|
|
expect(editButton).not.toBeUndefined();
|
|
|
|
act(() => {
|
|
editButton!.dispatchEvent(new MouseEvent("click", { bubbles: true, cancelable: true }));
|
|
});
|
|
|
|
const selects = container.querySelectorAll("select");
|
|
expect(selects).toHaveLength(3);
|
|
|
|
const environmentSelect = selects[2] as HTMLSelectElement;
|
|
expect(environmentSelect.disabled).toBe(true);
|
|
expect(environmentSelect.value).toBe("env-workspace");
|
|
expect(container.textContent).toContain("Environment selection is locked while reusing an existing workspace.");
|
|
|
|
const saveButton = Array.from(container.querySelectorAll("button")).find((button) => button.textContent?.includes("Save"));
|
|
expect(saveButton).not.toBeUndefined();
|
|
|
|
act(() => {
|
|
saveButton!.dispatchEvent(new MouseEvent("click", { bubbles: true, cancelable: true }));
|
|
});
|
|
|
|
expect(onUpdate).toHaveBeenCalledWith({
|
|
executionWorkspacePreference: "reuse_existing",
|
|
executionWorkspaceId: "workspace-1",
|
|
executionWorkspaceSettings: {
|
|
mode: "isolated_workspace",
|
|
environmentId: null,
|
|
},
|
|
});
|
|
|
|
act(() => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
|
|
it("hides environment UI when environments are disabled", () => {
|
|
const root = createRoot(container);
|
|
|
|
useQueryMock.mockImplementation((options: { queryKey: unknown[] }) => {
|
|
if (options.queryKey[0] === "instance") {
|
|
return { data: { enableEnvironments: false, enableIsolatedWorkspaces: true } };
|
|
}
|
|
if (options.queryKey[0] === "execution-workspaces") {
|
|
return { data: [createExecutionWorkspace()] };
|
|
}
|
|
return { data: undefined };
|
|
});
|
|
|
|
act(() => {
|
|
root.render(
|
|
<IssueWorkspaceCard
|
|
issue={createIssue()}
|
|
project={{
|
|
id: "project-1",
|
|
executionWorkspacePolicy: {
|
|
enabled: true,
|
|
defaultMode: "isolated_workspace",
|
|
environmentId: "env-project",
|
|
},
|
|
}}
|
|
onUpdate={vi.fn()}
|
|
/>,
|
|
);
|
|
});
|
|
|
|
expect(container.textContent).not.toContain("Environment:");
|
|
|
|
const editButton = Array.from(container.querySelectorAll("button")).find((button) => button.textContent?.includes("Edit"));
|
|
expect(editButton).not.toBeUndefined();
|
|
|
|
act(() => {
|
|
editButton!.dispatchEvent(new MouseEvent("click", { bubbles: true, cancelable: true }));
|
|
});
|
|
|
|
const selects = container.querySelectorAll("select");
|
|
expect(selects).toHaveLength(2);
|
|
expect(container.textContent).not.toContain("Project default environment");
|
|
|
|
act(() => {
|
|
root.unmount();
|
|
});
|
|
});
|
|
});
|