mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-09 06:15:21 +02:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work > - Paperclip provides CLI commands and guidance for operators and agents > - The `pnpm paperclipai` script can pass argument values through a shell > - Shell re-parsing can execute command substitutions inside quoted values > - This pull request routes guidance through inert-argv `npx paperclipai` commands and adds regression coverage > - The benefit is safer operator guidance across documentation and runtime hints ## Linked Issues or Issue Description This pull request fixes a command-injection-class defect in Paperclip CLI guidance. **What happened?** The `pnpm paperclipai <sub> --flag "$VALUE"` form can re-parse argument values through a shell. A command substitution inside a quoted value can execute on the host. **Expected behavior** Paperclip guidance must pass CLI values as inert argument values. Host-derived values must not appear in copyable commands. **Steps to reproduce** 1. Run a Paperclip guidance command that uses the `pnpm paperclipai` script. 2. Provide a quoted value that contains a command substitution. 3. Observe that the shell can evaluate the substitution before the CLI starts. 4. Compare the result with the `npx paperclipai` form. **Paperclip version or commit** `5670984b75d109950c968542a0111ebb6967f4da` **Deployment mode** All deployment modes that show or use the affected CLI guidance. **Installation method** Built from source and installed CLI guidance. **Agent adapter(s) involved** Not adapter-specific (core bug). **Database mode** Not database-related. **Access context** Both. **Additional context** The earlier merged PR [#11343](https://github.com/paperclipai/paperclip/pull/11343) used the unsafe `pnpm exec paperclipai` form. This fresh PR replaces that guidance with the safe `npx paperclipai` form. ## What Changed - Standardize documentation and runtime hints on `npx paperclipai`. - Remove the broken `pnpm exec paperclipai` guidance. - Use a static `<host>` placeholder in private-hostname guidance. - Add regression tests for unsafe forms, continued lines, static hosts, and offline guidance. ## Verification - `git diff --check origin/master...origin/fix/paperclipai-cli-npx-safe-invocation` passes. - The branch adds `server/src/__tests__/cli-invocation-safety.test.ts` and updates private-hostname tests. - CI must run the new tests, typecheck, lint, and build checks. - Local Vitest execution was not available because this worktree has no installed Vitest binary. ## Risks - The change affects operator and agent documentation text. - The runtime hints now show `<host>` instead of a request-derived host value. - No database schema or migration changes exist. - CI will detect any missed unsafe invocation or type error. ## Model Used OpenAI GPT-5, exact model ID `gpt-5`, with tool use and code-review assistance. The model used repository inspection, Git operations, and PR preparation. ## 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 searched GitHub for duplicate or related PRs and linked them above - [x] I have either (a) linked existing issues with `Fixes: #` / `Closes #` / `Refs #` OR (b) described the issue in-PR following the relevant issue template - [x] I have not referenced internal/instance-local Paperclip issues or links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip` URLs) - [x] My branch name describes the change (e.g. `docs/...`, `fix/...`) and contains no internal Paperclip ticket id or instance-derived details - [x] CI ran the test suites and they pass; local test execution was unavailable in this worktree - [x] I have added or updated tests where applicable - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [x] All Paperclip CI gates are green - [x] Greptile is 5/5 with no open P2s, recommendations, or follow-ups - [x] I addressed all Greptile and reviewer comments before requesting merge --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
108 lines
4.0 KiB
TypeScript
108 lines
4.0 KiB
TypeScript
import { afterEach, describe, expect, it, vi } from "vitest";
|
|
import { ApiConnectionError, ApiRequestError, PaperclipApiClient } from "../client/http.js";
|
|
|
|
describe("PaperclipApiClient", () => {
|
|
afterEach(() => {
|
|
vi.unstubAllGlobals();
|
|
vi.restoreAllMocks();
|
|
});
|
|
|
|
it("adds authorization and run-id headers", async () => {
|
|
const fetchMock = vi.fn().mockResolvedValue(
|
|
new Response(JSON.stringify({ ok: true }), { status: 200 }),
|
|
);
|
|
vi.stubGlobal("fetch", fetchMock);
|
|
|
|
const client = new PaperclipApiClient({
|
|
apiBase: "http://localhost:3100",
|
|
apiKey: "token-123",
|
|
runId: "run-abc",
|
|
});
|
|
|
|
await client.post("/api/test", { hello: "world" });
|
|
|
|
expect(fetchMock).toHaveBeenCalledTimes(1);
|
|
const call = fetchMock.mock.calls[0] as [string, RequestInit];
|
|
expect(call[0]).toContain("/api/test");
|
|
|
|
const headers = call[1].headers as Record<string, string>;
|
|
expect(headers.authorization).toBe("Bearer token-123");
|
|
expect(headers["x-paperclip-run-id"]).toBe("run-abc");
|
|
expect(headers["content-type"]).toBe("application/json");
|
|
});
|
|
|
|
it("returns null on ignoreNotFound", async () => {
|
|
const fetchMock = vi.fn().mockResolvedValue(
|
|
new Response(JSON.stringify({ error: "Not found" }), { status: 404 }),
|
|
);
|
|
vi.stubGlobal("fetch", fetchMock);
|
|
|
|
const client = new PaperclipApiClient({ apiBase: "http://localhost:3100" });
|
|
const result = await client.get("/api/missing", { ignoreNotFound: true });
|
|
expect(result).toBeNull();
|
|
});
|
|
|
|
it("throws ApiRequestError with details", async () => {
|
|
const fetchMock = vi.fn().mockResolvedValue(
|
|
new Response(
|
|
JSON.stringify({ error: "Issue checkout conflict", details: { issueId: "1" } }),
|
|
{ status: 409 },
|
|
),
|
|
);
|
|
vi.stubGlobal("fetch", fetchMock);
|
|
|
|
const client = new PaperclipApiClient({ apiBase: "http://localhost:3100" });
|
|
|
|
await expect(client.post("/api/issues/1/checkout", {})).rejects.toMatchObject({
|
|
status: 409,
|
|
message: "Issue checkout conflict",
|
|
details: { issueId: "1" },
|
|
} satisfies Partial<ApiRequestError>);
|
|
});
|
|
|
|
it("throws ApiConnectionError with recovery guidance when fetch fails", async () => {
|
|
const fetchMock = vi.fn().mockRejectedValue(new TypeError("fetch failed"));
|
|
vi.stubGlobal("fetch", fetchMock);
|
|
|
|
const client = new PaperclipApiClient({ apiBase: "http://localhost:3100" });
|
|
|
|
await expect(client.post("/api/companies/import/preview", {})).rejects.toBeInstanceOf(ApiConnectionError);
|
|
await expect(client.post("/api/companies/import/preview", {})).rejects.toMatchObject({
|
|
url: "http://localhost:3100/api/companies/import/preview",
|
|
method: "POST",
|
|
causeMessage: "fetch failed",
|
|
} satisfies Partial<ApiConnectionError>);
|
|
await expect(client.post("/api/companies/import/preview", {})).rejects.toThrow(
|
|
/Could not reach the Paperclip API\./,
|
|
);
|
|
await expect(client.post("/api/companies/import/preview", {})).rejects.toThrow(
|
|
/curl http:\/\/localhost:3100\/api\/health/,
|
|
);
|
|
await expect(client.post("/api/companies/import/preview", {})).rejects.toThrow(
|
|
/pnpm dev|npx paperclipai run/,
|
|
);
|
|
});
|
|
|
|
it("retries once after interactive auth recovery", async () => {
|
|
const fetchMock = vi
|
|
.fn()
|
|
.mockResolvedValueOnce(new Response(JSON.stringify({ error: "Board access required" }), { status: 403 }))
|
|
.mockResolvedValueOnce(new Response(JSON.stringify({ ok: true }), { status: 200 }));
|
|
vi.stubGlobal("fetch", fetchMock);
|
|
|
|
const recoverAuth = vi.fn().mockResolvedValue("board-token-123");
|
|
const client = new PaperclipApiClient({
|
|
apiBase: "http://localhost:3100",
|
|
recoverAuth,
|
|
});
|
|
|
|
const result = await client.post<{ ok: boolean }>("/api/test", { hello: "world" });
|
|
|
|
expect(result).toEqual({ ok: true });
|
|
expect(recoverAuth).toHaveBeenCalledOnce();
|
|
expect(fetchMock).toHaveBeenCalledTimes(2);
|
|
const retryHeaders = fetchMock.mock.calls[1]?.[1]?.headers as Record<string, string>;
|
|
expect(retryHeaders.authorization).toBe("Bearer board-token-123");
|
|
});
|
|
});
|