mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-06 21:05:21 +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>
161 lines
5.3 KiB
TypeScript
161 lines
5.3 KiB
TypeScript
import fs from "node:fs";
|
|
import os from "node:os";
|
|
import path from "node:path";
|
|
import { afterEach, beforeEach, describe, expect, it } from "vitest";
|
|
import { writeContext } from "../client/context.js";
|
|
import { setStoredBoardCredential } from "../client/board-auth.js";
|
|
import { resolveApiBase, resolveCommandContext } from "../commands/client/common.js";
|
|
|
|
const ORIGINAL_ENV = { ...process.env };
|
|
|
|
function createTempPath(name: string): string {
|
|
const dir = fs.mkdtempSync(path.join(os.tmpdir(), "paperclip-cli-common-"));
|
|
return path.join(dir, name);
|
|
}
|
|
|
|
describe("resolveCommandContext", () => {
|
|
beforeEach(() => {
|
|
process.env = { ...ORIGINAL_ENV };
|
|
delete process.env.PAPERCLIP_API_URL;
|
|
delete process.env.PAPERCLIP_API_KEY;
|
|
delete process.env.PAPERCLIP_COMPANY_ID;
|
|
delete process.env.PAPERCLIP_AUTH_STORE;
|
|
delete process.env.PAPERCLIP_SERVER_PORT;
|
|
});
|
|
|
|
afterEach(() => {
|
|
process.env = { ...ORIGINAL_ENV };
|
|
});
|
|
|
|
it("uses profile defaults when options/env are not provided", () => {
|
|
const contextPath = createTempPath("context.json");
|
|
|
|
writeContext(
|
|
{
|
|
version: 2,
|
|
currentProfile: "ops",
|
|
profiles: {
|
|
ops: {
|
|
apiBase: "http://127.0.0.1:9999",
|
|
companyId: "company-profile",
|
|
apiKeyEnvVarName: "AGENT_KEY",
|
|
},
|
|
},
|
|
},
|
|
contextPath,
|
|
);
|
|
process.env.AGENT_KEY = "key-from-env";
|
|
|
|
const resolved = resolveCommandContext({ context: contextPath }, { requireCompany: true });
|
|
expect(resolved.api.apiBase).toBe("http://127.0.0.1:9999");
|
|
expect(resolved.companyId).toBe("company-profile");
|
|
expect(resolved.api.apiKey).toBe("key-from-env");
|
|
});
|
|
|
|
it("prefers explicit options over profile values", () => {
|
|
const contextPath = createTempPath("context.json");
|
|
writeContext(
|
|
{
|
|
version: 2,
|
|
currentProfile: "default",
|
|
profiles: {
|
|
default: {
|
|
apiBase: "http://profile:3100",
|
|
companyId: "company-profile",
|
|
},
|
|
},
|
|
},
|
|
contextPath,
|
|
);
|
|
|
|
const resolved = resolveCommandContext(
|
|
{
|
|
context: contextPath,
|
|
apiBase: "http://override:3200",
|
|
apiKey: "direct-token",
|
|
companyId: "company-override",
|
|
},
|
|
{ requireCompany: true },
|
|
);
|
|
|
|
expect(resolved.api.apiBase).toBe("http://override:3200");
|
|
expect(resolved.companyId).toBe("company-override");
|
|
expect(resolved.api.apiKey).toBe("direct-token");
|
|
});
|
|
|
|
it("throws when company is required but unresolved", () => {
|
|
const contextPath = createTempPath("context.json");
|
|
writeContext(
|
|
{
|
|
version: 2,
|
|
currentProfile: "default",
|
|
profiles: { default: {} },
|
|
},
|
|
contextPath,
|
|
);
|
|
|
|
expect(() =>
|
|
resolveCommandContext({ context: contextPath, apiBase: "http://localhost:3100" }, { requireCompany: true }),
|
|
).toThrow(/Company ID is required/);
|
|
});
|
|
|
|
it("resolves api base by explicit, env, profile, then config/default precedence", () => {
|
|
const configPath = createTempPath("config.json");
|
|
fs.writeFileSync(configPath, JSON.stringify({
|
|
$meta: { version: 1, updatedAt: "2026-05-23T00:00:00.000Z", source: "onboard" },
|
|
database: { mode: "embedded-postgres" },
|
|
logging: { mode: "file" },
|
|
server: { deploymentMode: "local_trusted", exposure: "private", host: "127.0.0.1", port: 4111 },
|
|
}));
|
|
|
|
expect(resolveApiBase({ apiBase: "http://explicit:1", config: configPath }, { apiBase: "http://profile:2" }))
|
|
.toBe("http://explicit:1");
|
|
|
|
process.env.PAPERCLIP_API_URL = "http://env:3/";
|
|
expect(resolveApiBase({ config: configPath }, { apiBase: "http://profile:2" })).toBe("http://env:3");
|
|
|
|
delete process.env.PAPERCLIP_API_URL;
|
|
expect(resolveApiBase({ config: configPath }, { apiBase: "http://profile:2/" })).toBe("http://profile:2");
|
|
expect(resolveApiBase({ config: configPath }, {})).toBe("http://localhost:4111");
|
|
});
|
|
|
|
it("prefers explicit and env tokens over profile env and stored board auth", () => {
|
|
const contextPath = createTempPath("context.json");
|
|
const authStorePath = createTempPath("auth.json");
|
|
process.env.PAPERCLIP_AUTH_STORE = authStorePath;
|
|
process.env.PROFILE_KEY = "profile-token";
|
|
setStoredBoardCredential({
|
|
apiBase: "http://localhost:3100",
|
|
token: "stored-board-token",
|
|
userId: "user-1",
|
|
storePath: authStorePath,
|
|
});
|
|
writeContext(
|
|
{
|
|
version: 2,
|
|
currentProfile: "default",
|
|
profiles: {
|
|
default: {
|
|
apiBase: "http://localhost:3100",
|
|
apiKeyEnvVarName: "PROFILE_KEY",
|
|
},
|
|
},
|
|
},
|
|
contextPath,
|
|
);
|
|
|
|
const profileResolved = resolveCommandContext({ context: contextPath });
|
|
expect(profileResolved.api.apiKey).toBe("profile-token");
|
|
expect(profileResolved.authSource).toBe("profile_env");
|
|
|
|
process.env.PAPERCLIP_API_KEY = "env-token";
|
|
const envResolved = resolveCommandContext({ context: contextPath });
|
|
expect(envResolved.api.apiKey).toBe("env-token");
|
|
expect(envResolved.authSource).toBe("env");
|
|
|
|
const explicitResolved = resolveCommandContext({ context: contextPath, apiKey: "explicit-token" });
|
|
expect(explicitResolved.api.apiKey).toBe("explicit-token");
|
|
expect(explicitResolved.authSource).toBe("explicit");
|
|
});
|
|
});
|