mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-10 20:50:08 +02:00
## 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>
221 lines
8.7 KiB
TypeScript
221 lines
8.7 KiB
TypeScript
import { Command } from "commander";
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
import { registerAgentCommands } from "../commands/client/agent.js";
|
|
import { registerIssueCommands } from "../commands/client/issue.js";
|
|
import { registerRunCommands } from "../commands/client/run.js";
|
|
|
|
const COMPANY_ID = "22222222-2222-4222-8222-222222222222";
|
|
const AGENT_ID = "11111111-1111-4111-8111-111111111111";
|
|
const RUN_ID = "33333333-3333-4333-8333-333333333333";
|
|
const ISSUE_ID = "44444444-4444-4444-8444-444444444444";
|
|
|
|
function createProgram(): Command {
|
|
const program = new Command();
|
|
program.exitOverride();
|
|
program.configureOutput({
|
|
writeOut: () => {},
|
|
writeErr: () => {},
|
|
});
|
|
const run = program.command("run").action(() => {});
|
|
registerRunCommands(run);
|
|
registerAgentCommands(program);
|
|
registerIssueCommands(program);
|
|
return program;
|
|
}
|
|
|
|
describe("run inspection commands", () => {
|
|
beforeEach(() => {
|
|
vi.restoreAllMocks();
|
|
delete process.env.PAPERCLIP_API_KEY;
|
|
delete process.env.PAPERCLIP_API_URL;
|
|
});
|
|
|
|
afterEach(() => {
|
|
vi.restoreAllMocks();
|
|
});
|
|
|
|
it("lists and reads heartbeat runs through run subcommands", async () => {
|
|
const fetchMock = vi
|
|
.fn()
|
|
.mockResolvedValueOnce(new Response(JSON.stringify([
|
|
{ id: RUN_ID, companyId: COMPANY_ID, agentId: AGENT_ID, status: "running", invocationSource: "on_demand" },
|
|
]), { status: 200 }))
|
|
.mockResolvedValueOnce(new Response(JSON.stringify({
|
|
id: RUN_ID,
|
|
companyId: COMPANY_ID,
|
|
agentId: AGENT_ID,
|
|
status: "running",
|
|
invocationSource: "on_demand",
|
|
}), { status: 200 }))
|
|
.mockResolvedValueOnce(new Response(JSON.stringify({
|
|
text: "hello",
|
|
offset: 0,
|
|
nextOffset: 5,
|
|
}), { status: 200 }))
|
|
.mockResolvedValueOnce(new Response(JSON.stringify({ id: RUN_ID, status: "cancelled" }), { status: 200 }));
|
|
vi.stubGlobal("fetch", fetchMock);
|
|
vi.spyOn(console, "log").mockImplementation(() => {});
|
|
vi.spyOn(process.stdout, "write").mockImplementation(() => true);
|
|
|
|
await createProgram().parseAsync([
|
|
"run", "list",
|
|
"--api-base", "http://localhost:3100",
|
|
"--api-key", "board-token",
|
|
"--company-id", COMPANY_ID,
|
|
"--agent-id", AGENT_ID,
|
|
"--limit", "25",
|
|
], { from: "user" });
|
|
|
|
await createProgram().parseAsync([
|
|
"run", "get", RUN_ID,
|
|
"--api-base", "http://localhost:3100",
|
|
"--api-key", "board-token",
|
|
], { from: "user" });
|
|
|
|
await createProgram().parseAsync([
|
|
"run", "log", RUN_ID,
|
|
"--api-base", "http://localhost:3100",
|
|
"--api-key", "board-token",
|
|
"--offset", "4",
|
|
"--limit-bytes", "100",
|
|
"--text",
|
|
], { from: "user" });
|
|
|
|
await createProgram().parseAsync([
|
|
"run", "cancel", RUN_ID,
|
|
"--api-base", "http://localhost:3100",
|
|
"--api-key", "board-token",
|
|
], { from: "user" });
|
|
|
|
expect(fetchMock.mock.calls[0]?.[0]).toBe(
|
|
`http://localhost:3100/api/companies/${COMPANY_ID}/heartbeat-runs?agentId=${AGENT_ID}&limit=25`,
|
|
);
|
|
expect(fetchMock.mock.calls[1]?.[0]).toBe(`http://localhost:3100/api/heartbeat-runs/${RUN_ID}`);
|
|
expect(fetchMock.mock.calls[2]?.[0]).toBe(
|
|
`http://localhost:3100/api/heartbeat-runs/${RUN_ID}/log?offset=4&limitBytes=100`,
|
|
);
|
|
expect(fetchMock.mock.calls[3]?.[0]).toBe(`http://localhost:3100/api/heartbeat-runs/${RUN_ID}/cancel`);
|
|
expect(fetchMock.mock.calls[3]?.[1]?.method).toBe("POST");
|
|
});
|
|
|
|
it("supports run events, issues, workspace operations, and watchdog decisions", async () => {
|
|
const fetchMock = vi
|
|
.fn()
|
|
.mockResolvedValueOnce(new Response(JSON.stringify([
|
|
{ id: 1, runId: RUN_ID, agentId: AGENT_ID, seq: 1, eventType: "output", message: "hi" },
|
|
]), { status: 200 }))
|
|
.mockResolvedValueOnce(new Response(JSON.stringify([
|
|
{ id: ISSUE_ID, identifier: "PC-1", title: "Fix it", status: "in_progress", priority: "normal" },
|
|
]), { status: 200 }))
|
|
.mockResolvedValueOnce(new Response(JSON.stringify([
|
|
{ id: "55555555-5555-4555-8555-555555555555", status: "succeeded", phase: "workspace_provision" },
|
|
]), { status: 200 }))
|
|
.mockResolvedValueOnce(new Response(JSON.stringify({ text: "workspace" }), { status: 200 }))
|
|
.mockResolvedValueOnce(new Response(JSON.stringify({ id: "decision-1", decision: "continue" }), { status: 200 }));
|
|
vi.stubGlobal("fetch", fetchMock);
|
|
vi.spyOn(console, "log").mockImplementation(() => {});
|
|
|
|
await createProgram().parseAsync([
|
|
"run", "events", RUN_ID,
|
|
"--api-base", "http://localhost:3100",
|
|
"--api-key", "board-token",
|
|
"--after-seq", "7",
|
|
"--limit", "50",
|
|
], { from: "user" });
|
|
await createProgram().parseAsync([
|
|
"run", "issues", RUN_ID,
|
|
"--api-base", "http://localhost:3100",
|
|
"--api-key", "board-token",
|
|
], { from: "user" });
|
|
await createProgram().parseAsync([
|
|
"run", "workspace-operations", RUN_ID,
|
|
"--api-base", "http://localhost:3100",
|
|
"--api-key", "board-token",
|
|
], { from: "user" });
|
|
await createProgram().parseAsync([
|
|
"run", "workspace-log", "55555555-5555-4555-8555-555555555555",
|
|
"--api-base", "http://localhost:3100",
|
|
"--api-key", "board-token",
|
|
], { from: "user" });
|
|
await createProgram().parseAsync([
|
|
"run", "watchdog-decision", RUN_ID,
|
|
"--api-base", "http://localhost:3100",
|
|
"--api-key", "board-token",
|
|
"--decision", "continue",
|
|
"--reason", "operator reviewed",
|
|
], { from: "user" });
|
|
|
|
expect(fetchMock.mock.calls[0]?.[0]).toBe(
|
|
`http://localhost:3100/api/heartbeat-runs/${RUN_ID}/events?afterSeq=7&limit=50`,
|
|
);
|
|
expect(fetchMock.mock.calls[1]?.[0]).toBe(`http://localhost:3100/api/heartbeat-runs/${RUN_ID}/issues`);
|
|
expect(fetchMock.mock.calls[2]?.[0]).toBe(`http://localhost:3100/api/heartbeat-runs/${RUN_ID}/workspace-operations`);
|
|
expect(fetchMock.mock.calls[3]?.[0]).toBe(
|
|
"http://localhost:3100/api/workspace-operations/55555555-5555-4555-8555-555555555555/log?offset=0",
|
|
);
|
|
expect(fetchMock.mock.calls[4]?.[0]).toBe(`http://localhost:3100/api/heartbeat-runs/${RUN_ID}/watchdog-decisions`);
|
|
expect(JSON.parse(String(fetchMock.mock.calls[4]?.[1]?.body))).toMatchObject({
|
|
decision: "continue",
|
|
reason: "operator reviewed",
|
|
});
|
|
});
|
|
|
|
it("wakes agents and exposes issue run helpers", async () => {
|
|
const fetchMock = vi
|
|
.fn()
|
|
.mockResolvedValueOnce(new Response(JSON.stringify({
|
|
id: AGENT_ID,
|
|
name: "Builder",
|
|
companyId: COMPANY_ID,
|
|
urlKey: "builder",
|
|
}), { status: 200 }))
|
|
.mockResolvedValueOnce(new Response(JSON.stringify({
|
|
id: RUN_ID,
|
|
companyId: COMPANY_ID,
|
|
agentId: AGENT_ID,
|
|
status: "queued",
|
|
}), { status: 202 }))
|
|
.mockResolvedValueOnce(new Response(JSON.stringify([{ id: RUN_ID, status: "succeeded" }]), { status: 200 }))
|
|
.mockResolvedValueOnce(new Response(JSON.stringify([{ id: RUN_ID, status: "running" }]), { status: 200 }))
|
|
.mockResolvedValueOnce(new Response(JSON.stringify({ id: RUN_ID, status: "running" }), { status: 200 }));
|
|
vi.stubGlobal("fetch", fetchMock);
|
|
vi.spyOn(console, "log").mockImplementation(() => {});
|
|
|
|
await createProgram().parseAsync([
|
|
"agent", "wake", "builder",
|
|
"--api-base", "http://localhost:3100",
|
|
"--api-key", "board-token",
|
|
"--company-id", COMPANY_ID,
|
|
"--reason", "manual check",
|
|
"--payload", "{\"issueId\":\"PC-1\"}",
|
|
], { from: "user" });
|
|
await createProgram().parseAsync([
|
|
"issue", "runs", "PC-1",
|
|
"--api-base", "http://localhost:3100",
|
|
"--api-key", "board-token",
|
|
], { from: "user" });
|
|
await createProgram().parseAsync([
|
|
"issue", "live-runs", "PC-1",
|
|
"--api-base", "http://localhost:3100",
|
|
"--api-key", "board-token",
|
|
], { from: "user" });
|
|
await createProgram().parseAsync([
|
|
"issue", "active-run", "PC-1",
|
|
"--api-base", "http://localhost:3100",
|
|
"--api-key", "board-token",
|
|
], { from: "user" });
|
|
|
|
expect(fetchMock.mock.calls[0]?.[0]).toBe(`http://localhost:3100/api/agents/builder?companyId=${COMPANY_ID}`);
|
|
expect(fetchMock.mock.calls[1]?.[0]).toBe(`http://localhost:3100/api/agents/${AGENT_ID}/wakeup`);
|
|
expect(JSON.parse(String(fetchMock.mock.calls[1]?.[1]?.body))).toMatchObject({
|
|
source: "on_demand",
|
|
triggerDetail: "manual",
|
|
reason: "manual check",
|
|
payload: { issueId: "PC-1" },
|
|
});
|
|
expect(fetchMock.mock.calls[2]?.[0]).toBe("http://localhost:3100/api/issues/PC-1/runs");
|
|
expect(fetchMock.mock.calls[3]?.[0]).toBe("http://localhost:3100/api/issues/PC-1/live-runs");
|
|
expect(fetchMock.mock.calls[4]?.[0]).toBe("http://localhost:3100/api/issues/PC-1/active-run");
|
|
});
|
|
});
|