mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-11 14:10:50 +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>
198 lines
6.6 KiB
TypeScript
198 lines
6.6 KiB
TypeScript
import fs from "node:fs";
|
|
import os from "node:os";
|
|
import path from "node:path";
|
|
import { Command } from "commander";
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
import * as prompts from "@clack/prompts";
|
|
import { registerConnectCommand } from "../commands/client/connect.js";
|
|
import { loginBoardCli } from "../client/board-auth.js";
|
|
|
|
vi.mock("@clack/prompts", () => ({
|
|
intro: vi.fn(),
|
|
outro: vi.fn(),
|
|
cancel: vi.fn(),
|
|
isCancel: vi.fn(() => false),
|
|
text: vi.fn(),
|
|
select: vi.fn(),
|
|
}));
|
|
|
|
vi.mock("../client/board-auth.js", () => ({
|
|
loginBoardCli: vi.fn(),
|
|
}));
|
|
|
|
const COMPANY_ID = "22222222-2222-4222-8222-222222222222";
|
|
const AGENT_ID = "33333333-3333-4333-8333-333333333333";
|
|
const API_BASE = "http://127.0.0.1:3197";
|
|
|
|
function createProgram(): Command {
|
|
const program = new Command();
|
|
program.exitOverride();
|
|
program.configureOutput({ writeOut: () => {}, writeErr: () => {} });
|
|
registerConnectCommand(program);
|
|
return program;
|
|
}
|
|
|
|
function jsonResponse(body: unknown = { ok: true }, init: ResponseInit = { status: 200 }): Response {
|
|
return new Response(JSON.stringify(body), init);
|
|
}
|
|
|
|
function createTempContextPath() {
|
|
return path.join(fs.mkdtempSync(path.join(os.tmpdir(), "paperclip-connect-test-")), "context.json");
|
|
}
|
|
|
|
function readContext(filePath: string) {
|
|
return JSON.parse(fs.readFileSync(filePath, "utf8")) as {
|
|
currentProfile: string;
|
|
profiles: Record<string, Record<string, unknown>>;
|
|
};
|
|
}
|
|
|
|
describe("connect command", () => {
|
|
let originalStdinIsTTY: boolean | undefined;
|
|
let originalStdoutIsTTY: boolean | undefined;
|
|
|
|
beforeEach(() => {
|
|
originalStdinIsTTY = process.stdin.isTTY;
|
|
originalStdoutIsTTY = process.stdout.isTTY;
|
|
Object.defineProperty(process.stdin, "isTTY", { value: true, configurable: true });
|
|
Object.defineProperty(process.stdout, "isTTY", { value: true, configurable: true });
|
|
vi.restoreAllMocks();
|
|
vi.mocked(loginBoardCli).mockResolvedValue({
|
|
token: "board-login-token",
|
|
approvalUrl: `${API_BASE}/cli-auth/challenge-1`,
|
|
userId: "user-1",
|
|
});
|
|
vi.spyOn(console, "log").mockImplementation(() => {});
|
|
});
|
|
|
|
afterEach(() => {
|
|
Object.defineProperty(process.stdin, "isTTY", { value: originalStdinIsTTY, configurable: true });
|
|
Object.defineProperty(process.stdout, "isTTY", { value: originalStdoutIsTTY, configurable: true });
|
|
vi.restoreAllMocks();
|
|
});
|
|
|
|
it("drives the interactive board profile flow through prompts and context writes", async () => {
|
|
const contextPath = createTempContextPath();
|
|
vi.mocked(prompts.text).mockResolvedValue(API_BASE);
|
|
vi.mocked(prompts.select).mockResolvedValue(COMPANY_ID);
|
|
const fetchMock = vi.fn(async (input: RequestInfo | URL, init?: RequestInit) => {
|
|
const url = new URL(String(input));
|
|
if (url.pathname === "/api/health") return jsonResponse({ status: "ok" });
|
|
if (url.pathname === "/api/companies") {
|
|
return jsonResponse([{ id: COMPANY_ID, name: "Connect Co" }]);
|
|
}
|
|
if (url.pathname === "/api/board-api-keys" && init?.method === "POST") {
|
|
return jsonResponse({
|
|
id: "board-key-1",
|
|
name: "connect-board-token",
|
|
token: "pcp_board_created",
|
|
createdAt: "2026-05-24T12:00:00.000Z",
|
|
expiresAt: null,
|
|
});
|
|
}
|
|
return jsonResponse({ error: `Unexpected ${init?.method ?? "GET"} ${url.pathname}` }, { status: 500 });
|
|
});
|
|
vi.stubGlobal("fetch", fetchMock);
|
|
|
|
await createProgram().parseAsync([
|
|
"connect",
|
|
"--persona",
|
|
"board",
|
|
"--profile",
|
|
"cli-board",
|
|
"--token-name",
|
|
"connect-board-token",
|
|
"--context",
|
|
contextPath,
|
|
"--api-base",
|
|
API_BASE,
|
|
"--json",
|
|
], { from: "user" });
|
|
|
|
expect(loginBoardCli).toHaveBeenCalledWith(expect.objectContaining({
|
|
apiBase: API_BASE,
|
|
requestedAccess: "board",
|
|
command: "paperclipai connect",
|
|
}));
|
|
expect(fetchMock.mock.calls.map((call) => [call[1]?.method ?? "GET", new URL(String(call[0])).pathname])).toEqual([
|
|
["GET", "/api/health"],
|
|
["GET", "/api/companies"],
|
|
["POST", "/api/board-api-keys"],
|
|
]);
|
|
expect(readContext(contextPath)).toMatchObject({
|
|
currentProfile: "cli-board",
|
|
profiles: {
|
|
"cli-board": {
|
|
apiBase: API_BASE,
|
|
companyId: COMPANY_ID,
|
|
persona: "board",
|
|
tokenId: "board-key-1",
|
|
tokenName: "connect-board-token",
|
|
},
|
|
},
|
|
});
|
|
});
|
|
|
|
it("drives the interactive agent profile flow through prompts and context writes", async () => {
|
|
const contextPath = createTempContextPath();
|
|
vi.mocked(prompts.text).mockResolvedValue(API_BASE);
|
|
vi.mocked(prompts.select).mockResolvedValue(AGENT_ID);
|
|
const fetchMock = vi.fn(async (input: RequestInfo | URL, init?: RequestInit) => {
|
|
const url = new URL(String(input));
|
|
if (url.pathname === "/api/health") return jsonResponse({ status: "ok" });
|
|
if (url.pathname === "/api/companies") {
|
|
return jsonResponse([{ id: COMPANY_ID, name: "Connect Co" }]);
|
|
}
|
|
if (url.pathname === `/api/companies/${COMPANY_ID}/agents`) {
|
|
return jsonResponse([{ id: AGENT_ID, name: "Connect Agent", role: "Operator" }]);
|
|
}
|
|
if (url.pathname === `/api/agents/${AGENT_ID}/keys` && init?.method === "POST") {
|
|
return jsonResponse({
|
|
id: "agent-key-1",
|
|
name: "connect-agent-token",
|
|
token: "pcp_agent_created",
|
|
createdAt: "2026-05-24T12:00:00.000Z",
|
|
});
|
|
}
|
|
return jsonResponse({ error: `Unexpected ${init?.method ?? "GET"} ${url.pathname}` }, { status: 500 });
|
|
});
|
|
vi.stubGlobal("fetch", fetchMock);
|
|
|
|
await createProgram().parseAsync([
|
|
"connect",
|
|
"--persona",
|
|
"agent",
|
|
"--profile",
|
|
"cli-agent",
|
|
"--token-name",
|
|
"connect-agent-token",
|
|
"--context",
|
|
contextPath,
|
|
"--api-base",
|
|
API_BASE,
|
|
"--json",
|
|
], { from: "user" });
|
|
|
|
expect(fetchMock.mock.calls.map((call) => [call[1]?.method ?? "GET", new URL(String(call[0])).pathname])).toEqual([
|
|
["GET", "/api/health"],
|
|
["GET", "/api/companies"],
|
|
["GET", `/api/companies/${COMPANY_ID}/agents`],
|
|
["POST", `/api/agents/${AGENT_ID}/keys`],
|
|
]);
|
|
expect(readContext(contextPath)).toMatchObject({
|
|
currentProfile: "cli-agent",
|
|
profiles: {
|
|
"cli-agent": {
|
|
apiBase: API_BASE,
|
|
companyId: COMPANY_ID,
|
|
persona: "agent",
|
|
agentId: AGENT_ID,
|
|
agentName: "Connect Agent",
|
|
tokenId: "agent-key-1",
|
|
tokenName: "connect-agent-token",
|
|
},
|
|
},
|
|
});
|
|
});
|
|
});
|