Files
paperclip/server/src/__tests__/issue-tree-control-routes.test.ts
T
Aron Prins 70b1a9109d Improve CLI API parity coverage (#6626)
## Thinking Path

> - Paperclip is a control plane for AI-agent companies, with the CLI
acting as a scriptable operator and agent interface to that control
plane.
> - The REST API surface has grown across companies, agents, issues,
routines, plugins, auth, workspaces, secrets, and operational inspection
commands.
> - The CLI had drifted from that API surface: some commands were
missing, some command shapes differed from docs/reference material, and
several edge cases only failed during end-to-end local-source testing.
> - The local development runbook requires these tests to be disposable
and isolated from a real `~/.paperclip`, `~/.codex`, or `~/.claude`
installation.
> - This pull request adds broad CLI/API parity coverage, fixes the
actionable bugs found during that pass, and records the reproducible
test log under `doc/logs`.
> - The benefit is a more complete, scriptable CLI surface with
regression coverage for the command families exercised by the parity
run.

## What Changed

- Added or expanded CLI command coverage for access/auth, companies,
agents, projects, goals, issues and subresources, routines, plugins,
workspaces, activity/run/cost/dashboard inspection, assets, skills,
secrets, tokens, prompt/wake flows, and local setup helpers.
- Fixed CLI/API parity bugs found during the run, including context
profile patching, issue interaction optional payloads, malformed
tree-hold errors, environment duplicate handling, configure
invalid-section exit codes, worktree pnpm invocation, token agent ID
resolution, plugin tool worker lookup, and routine webhook secret
cleanup.
- Added missing CLI wrappers and route coverage for health/access,
invite resolution URL forwarding, join status normalization, secret
lifecycle commands, LLM docs routes, available-skill isolation, positive
board-claim coverage, and interactive `connect` prompt-flow tests.
- Added a schema-backed `/api/openapi.json` route sufficient for CLI
parity and `paperclipai openapi --json` smoke coverage.
- Added `doc/logs/2026-05-24-cli-api-parity-e2e-log.md` with the
detailed living test/bug log and renamed the log directory from
`doc/bugs` to `doc/logs`.
- Added `doc/plans/2026-05-23-cli-api-parity.md` and the OpenAPI parity
reference used during the pass.

OpenAPI note: this PR intentionally does not try to subsume
`feature/openapi-spec`. The OpenAPI implementation here is schema-backed
and better than the earlier route-inventory stub, but
`feature/openapi-spec` is the fuller/better OpenAPI branch because it
includes exact mounted-route coverage tests and additional current route
coverage. That branch should stay as its own PR and can supersede this
OpenAPI route implementation.

## Verification

Targeted automated checks run:

- `pnpm exec vitest run server/src/__tests__/openapi-routes.test.ts`
- `pnpm exec vitest run server/src/__tests__/board-claim.test.ts`
- `pnpm exec vitest run cli/src/__tests__/connect.test.ts`
- `pnpm exec vitest run cli/src/__tests__/agent-lifecycle.test.ts`
- `pnpm exec vitest run server/src/__tests__/plugin-database.test.ts`
- `pnpm exec vitest run server/src/__tests__/routines-service.test.ts`
- `pnpm --dir cli typecheck`
- `pnpm --dir server typecheck`

Manual/local E2E verification:

- Ran the full disposable local-source CLI/API parity pass with isolated
`PAPERCLIP_HOME`, `PAPERCLIP_CONFIG`, `PAPERCLIP_CONTEXT`,
`PAPERCLIP_AUTH_STORE`, `CODEX_HOME`, and `CLAUDE_HOME` under
`tmp/cli-api-parity`.
- Verified `DATABASE_URL` and `DATABASE_MIGRATION_URL` stayed unset for
the scratch server.
- Verified live health and schema-backed OpenAPI responses on
non-default port `3197`.
- Revoked created board/agent tokens and cleaned up temporary plugins,
secrets, non-default environments, and project workspaces.
- See `doc/logs/2026-05-24-cli-api-parity-e2e-log.md` for the full
command-by-command reproduction log.

Not run:

- Full `pnpm test`, `pnpm test:run`, or `pnpm build` were not run after
the entire branch because the branch is broad and the parity pass used
focused test/typecheck verification plus live isolated CLI reruns.

## Risks

- This is a broad PR and touches many CLI command modules, so review
surface is high. The changes are grouped around one theme, but a split
may be easier if maintainers prefer narrower PRs.
- The OpenAPI route in this PR is not the final/best OpenAPI
implementation. `feature/openapi-spec` has stronger exact-route coverage
and should remain the source for the dedicated OpenAPI PR.
- The living log is intentionally detailed and large. It is useful for
reproducibility but adds documentation weight.
- No UI changes are intended; screenshots are not applicable.

> 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-based coding agent in Codex desktop. Exact served
model/context-window identifier was not exposed in the local app. Work
used shell/Git/GitHub CLI tooling, local source inspection, targeted
test execution, and live isolated Paperclip CLI/API smoke testing.

## 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: Devin Foley <devin@devinfoley.com>
2026-06-02 17:13:29 -07:00

420 lines
14 KiB
TypeScript

import express from "express";
import request from "supertest";
import { beforeEach, describe, expect, it, vi } from "vitest";
const mockIssueService = vi.hoisted(() => ({
getById: vi.fn(),
}));
const mockTreeControlService = vi.hoisted(() => ({
preview: vi.fn(),
createHold: vi.fn(),
cancelIssueStatusesForHold: vi.fn(),
restoreIssueStatusesForHold: vi.fn(),
getHold: vi.fn(),
releaseHold: vi.fn(),
cancelUnclaimedWakeupsForTree: vi.fn(),
}));
const mockLogActivity = vi.hoisted(() => vi.fn());
const mockHeartbeatService = vi.hoisted(() => ({
cancelRun: vi.fn(),
wakeup: vi.fn(),
}));
vi.mock("../services/index.js", () => ({
heartbeatService: () => mockHeartbeatService,
issueService: () => mockIssueService,
issueTreeControlService: () => mockTreeControlService,
logActivity: mockLogActivity,
}));
async function createApp(actor: Record<string, unknown>) {
const [{ errorHandler }, { issueTreeControlRoutes }] = await Promise.all([
import("../middleware/index.js"),
import("../routes/issue-tree-control.js"),
]);
const app = express();
app.use(express.json());
app.use((req, _res, next) => {
(req as any).actor = actor;
next();
});
app.use("/api", issueTreeControlRoutes({} as any));
app.use(errorHandler);
return app;
}
describe("issue tree control routes", () => {
beforeEach(() => {
vi.clearAllMocks();
mockIssueService.getById.mockResolvedValue({
id: "11111111-1111-4111-8111-111111111111",
companyId: "company-2",
});
mockTreeControlService.cancelUnclaimedWakeupsForTree.mockResolvedValue([]);
mockTreeControlService.cancelIssueStatusesForHold.mockResolvedValue({ updatedIssueIds: [], updatedIssues: [] });
mockTreeControlService.restoreIssueStatusesForHold.mockResolvedValue({
updatedIssueIds: [],
updatedIssues: [],
releasedCancelHoldIds: [],
restoreHold: null,
});
mockHeartbeatService.cancelRun.mockResolvedValue(null);
mockHeartbeatService.wakeup.mockResolvedValue(null);
});
it("rejects cross-company preview requests before calling the preview service", async () => {
const app = await createApp({
type: "board",
userId: "user-1",
companyIds: ["company-1"],
source: "session",
isInstanceAdmin: false,
});
const res = await request(app)
.post("/api/issues/11111111-1111-4111-8111-111111111111/tree-control/preview")
.send({ mode: "pause" });
expect(res.status).toBe(403);
expect(mockTreeControlService.preview).not.toHaveBeenCalled();
expect(mockLogActivity).not.toHaveBeenCalled();
});
it("requires board access for hold creation", async () => {
const app = await createApp({
type: "agent",
agentId: "22222222-2222-4222-8222-222222222222",
companyId: "company-2",
runId: null,
source: "api_key",
});
const res = await request(app)
.post("/api/issues/11111111-1111-4111-8111-111111111111/tree-holds")
.send({ mode: "pause" });
expect(res.status).toBe(403);
expect(mockIssueService.getById).not.toHaveBeenCalled();
expect(mockTreeControlService.createHold).not.toHaveBeenCalled();
});
it("rejects malformed tree hold IDs before querying the hold service", async () => {
const app = await createApp({
type: "board",
userId: "user-1",
companyIds: ["company-2"],
source: "session",
isInstanceAdmin: false,
});
const getRes = await request(app)
.get("/api/issues/11111111-1111-4111-8111-111111111111/tree-holds/null");
const releaseRes = await request(app)
.post("/api/issues/11111111-1111-4111-8111-111111111111/tree-holds/null/release")
.send({ reason: "bad hold id" });
expect(getRes.status).toBe(400);
expect(releaseRes.status).toBe(400);
expect(mockTreeControlService.getHold).not.toHaveBeenCalled();
expect(mockTreeControlService.releaseHold).not.toHaveBeenCalled();
});
it("cancels active descendant runs when creating a pause hold", async () => {
const app = await createApp({
type: "board",
userId: "user-1",
companyIds: ["company-2"],
source: "session",
isInstanceAdmin: false,
});
mockTreeControlService.createHold.mockResolvedValue({
hold: {
id: "33333333-3333-4333-8333-333333333333",
mode: "pause",
reason: "pause subtree",
},
preview: {
mode: "pause",
totals: { affectedIssues: 1 },
warnings: [],
activeRuns: [
{
id: "44444444-4444-4444-8444-444444444444",
issueId: "11111111-1111-4111-8111-111111111111",
},
],
},
});
const res = await request(app)
.post("/api/issues/11111111-1111-4111-8111-111111111111/tree-holds")
.send({ mode: "pause", reason: "pause subtree" });
expect(res.status).toBe(201);
expect(mockHeartbeatService.cancelRun).toHaveBeenCalledWith("44444444-4444-4444-8444-444444444444");
expect(mockTreeControlService.cancelUnclaimedWakeupsForTree).toHaveBeenCalledWith(
"company-2",
"11111111-1111-4111-8111-111111111111",
"Cancelled because an active subtree pause hold was created",
);
expect(mockLogActivity).toHaveBeenCalledWith(
expect.anything(),
expect.objectContaining({
action: "issue.tree_hold_run_interrupted",
entityId: "44444444-4444-4444-8444-444444444444",
}),
);
});
it("marks affected issues cancelled when creating a cancel hold", async () => {
const app = await createApp({
type: "board",
userId: "user-1",
companyIds: ["company-2"],
source: "session",
isInstanceAdmin: false,
});
mockTreeControlService.createHold.mockResolvedValue({
hold: {
id: "33333333-3333-4333-8333-333333333333",
mode: "cancel",
reason: "cancel subtree",
},
preview: {
mode: "cancel",
totals: { affectedIssues: 2 },
warnings: [],
activeRuns: [],
},
});
mockTreeControlService.cancelIssueStatusesForHold.mockResolvedValue({
updatedIssueIds: [
"11111111-1111-4111-8111-111111111111",
"55555555-5555-4555-8555-555555555555",
],
updatedIssues: [],
});
const res = await request(app)
.post("/api/issues/11111111-1111-4111-8111-111111111111/tree-holds")
.send({ mode: "cancel", reason: "cancel subtree" });
expect(res.status).toBe(201);
expect(mockTreeControlService.cancelIssueStatusesForHold).toHaveBeenCalledWith(
"company-2",
"11111111-1111-4111-8111-111111111111",
"33333333-3333-4333-8333-333333333333",
);
expect(mockLogActivity).toHaveBeenCalledWith(
expect.anything(),
expect.objectContaining({
action: "issue.tree_cancel_status_updated",
details: expect.objectContaining({ cancelledIssueCount: 2 }),
}),
);
});
it("still marks affected issues cancelled when run interruption fails", async () => {
const app = await createApp({
type: "board",
userId: "user-1",
companyIds: ["company-2"],
source: "session",
isInstanceAdmin: false,
});
mockTreeControlService.createHold.mockResolvedValue({
hold: {
id: "33333333-3333-4333-8333-333333333333",
mode: "cancel",
reason: "cancel subtree",
},
preview: {
mode: "cancel",
totals: { affectedIssues: 1 },
warnings: [],
activeRuns: [
{
id: "44444444-4444-4444-8444-444444444444",
issueId: "11111111-1111-4111-8111-111111111111",
},
],
},
});
mockTreeControlService.cancelIssueStatusesForHold.mockResolvedValue({
updatedIssueIds: ["11111111-1111-4111-8111-111111111111"],
updatedIssues: [],
});
mockHeartbeatService.cancelRun.mockRejectedValue(new Error("adapter process did not exit"));
const res = await request(app)
.post("/api/issues/11111111-1111-4111-8111-111111111111/tree-holds")
.send({ mode: "cancel", reason: "cancel subtree" });
expect(res.status).toBe(201);
expect(mockHeartbeatService.cancelRun).toHaveBeenCalledWith("44444444-4444-4444-8444-444444444444");
expect(mockTreeControlService.cancelIssueStatusesForHold).toHaveBeenCalledWith(
"company-2",
"11111111-1111-4111-8111-111111111111",
"33333333-3333-4333-8333-333333333333",
);
expect(mockLogActivity).toHaveBeenCalledWith(
expect.anything(),
expect.objectContaining({
action: "issue.tree_hold_run_interrupt_failed",
entityId: "44444444-4444-4444-8444-444444444444",
details: expect.objectContaining({
error: "adapter process did not exit",
}),
}),
);
});
it("restores affected issues and can request explicit wakeups", async () => {
const app = await createApp({
type: "board",
userId: "user-1",
companyIds: ["company-2"],
source: "session",
isInstanceAdmin: false,
});
mockTreeControlService.createHold.mockResolvedValue({
hold: {
id: "66666666-6666-4666-8666-666666666666",
mode: "restore",
reason: "restore subtree",
},
preview: {
mode: "restore",
totals: { affectedIssues: 1 },
warnings: [],
activeRuns: [],
},
});
mockTreeControlService.restoreIssueStatusesForHold.mockResolvedValue({
updatedIssueIds: ["55555555-5555-4555-8555-555555555555"],
updatedIssues: [
{
id: "55555555-5555-4555-8555-555555555555",
status: "todo",
assigneeAgentId: "22222222-2222-4222-8222-222222222222",
},
],
releasedCancelHoldIds: ["33333333-3333-4333-8333-333333333333"],
restoreHold: {
id: "66666666-6666-4666-8666-666666666666",
mode: "restore",
status: "released",
},
});
mockHeartbeatService.wakeup.mockResolvedValue({
id: "77777777-7777-4777-8777-777777777777",
});
const res = await request(app)
.post("/api/issues/11111111-1111-4111-8111-111111111111/tree-holds")
.send({ mode: "restore", reason: "restore subtree", metadata: { wakeAgents: true } });
expect(res.status).toBe(200);
expect(mockTreeControlService.restoreIssueStatusesForHold).toHaveBeenCalledWith(
"company-2",
"11111111-1111-4111-8111-111111111111",
"66666666-6666-4666-8666-666666666666",
expect.objectContaining({ reason: "restore subtree" }),
);
expect(mockHeartbeatService.wakeup).toHaveBeenCalledWith(
"22222222-2222-4222-8222-222222222222",
expect.objectContaining({
reason: "issue_tree_restored",
payload: expect.objectContaining({ issueId: "55555555-5555-4555-8555-555555555555" }),
}),
);
expect(res.body.hold.status).toBe("released");
});
it("releases a restore hold if the restore application fails", async () => {
const app = await createApp({
type: "board",
userId: "user-1",
companyIds: ["company-2"],
source: "session",
isInstanceAdmin: false,
});
mockTreeControlService.createHold.mockResolvedValue({
hold: {
id: "66666666-6666-4666-8666-666666666666",
mode: "restore",
reason: "restore subtree",
},
preview: {
mode: "restore",
totals: { affectedIssues: 1 },
warnings: [],
activeRuns: [],
},
});
mockTreeControlService.restoreIssueStatusesForHold.mockRejectedValue(new Error("restore failed"));
mockTreeControlService.releaseHold.mockResolvedValue({
id: "66666666-6666-4666-8666-666666666666",
mode: "restore",
status: "released",
});
const res = await request(app)
.post("/api/issues/11111111-1111-4111-8111-111111111111/tree-holds")
.send({ mode: "restore", reason: "restore subtree" });
expect(res.status).toBe(500);
expect(mockTreeControlService.releaseHold).toHaveBeenCalledWith(
"company-2",
"11111111-1111-4111-8111-111111111111",
"66666666-6666-4666-8666-666666666666",
expect.objectContaining({
reason: "Restore operation failed before subtree status updates completed",
metadata: { cleanup: "restore_failed_before_apply" },
}),
);
});
it("returns resume operations as released holds and avoids cancellation side effects", async () => {
const app = await createApp({
type: "board",
userId: "user-1",
companyIds: ["company-2"],
source: "session",
isInstanceAdmin: false,
});
mockTreeControlService.createHold.mockResolvedValue({
hold: {
id: "77777777-7777-4777-8777-777777777777",
mode: "resume",
status: "released",
reason: "resume subtree",
},
preview: {
mode: "resume",
totals: {
affectedIssues: 1,
},
warnings: [],
activeRuns: [],
},
resumedPauseHoldIds: ["33333333-3333-4333-8333-333333333333"],
});
const res = await request(app)
.post("/api/issues/11111111-1111-4111-8111-111111111111/tree-holds")
.send({ mode: "resume", reason: "resume subtree" });
expect(res.status).toBe(200);
expect(res.body.hold.mode).toBe("resume");
expect(res.body.hold.status).toBe("released");
expect(res.body.resumedPauseHoldIds).toEqual(["33333333-3333-4333-8333-333333333333"]);
expect(mockHeartbeatService.cancelRun).not.toHaveBeenCalled();
expect(mockTreeControlService.cancelUnclaimedWakeupsForTree).not.toHaveBeenCalled();
expect(mockTreeControlService.cancelIssueStatusesForHold).not.toHaveBeenCalled();
expect(mockTreeControlService.restoreIssueStatusesForHold).not.toHaveBeenCalled();
});
});