mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-11 13:24:55 +01: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>
264 lines
9.2 KiB
TypeScript
264 lines
9.2 KiB
TypeScript
// @vitest-environment jsdom
|
|
|
|
import type { ReactNode } from "react";
|
|
import { flushSync } from "react-dom";
|
|
import { createRoot } from "react-dom/client";
|
|
import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
import { CloudAccessGate } from "./components/CloudAccessGate";
|
|
import appSource from "./App.tsx?raw";
|
|
|
|
const mockHealthApi = vi.hoisted(() => ({
|
|
get: vi.fn(),
|
|
}));
|
|
|
|
const mockAuthApi = vi.hoisted(() => ({
|
|
getSession: vi.fn(),
|
|
}));
|
|
|
|
const mockAccessApi = vi.hoisted(() => ({
|
|
getCurrentBoardAccess: vi.fn(),
|
|
claimBootstrapAdmin: vi.fn(),
|
|
}));
|
|
|
|
vi.mock("./api/health", () => ({
|
|
healthApi: mockHealthApi,
|
|
}));
|
|
|
|
vi.mock("./api/auth", () => ({
|
|
authApi: mockAuthApi,
|
|
}));
|
|
|
|
vi.mock("./api/access", () => ({
|
|
accessApi: mockAccessApi,
|
|
}));
|
|
|
|
vi.mock("@/lib/router", () => ({
|
|
Link: ({ to, children }: { to: string; children?: ReactNode }) => <a href={to}>{children}</a>,
|
|
Navigate: ({ to }: { to: string }) => <div>Navigate:{to}</div>,
|
|
Outlet: () => <div>Outlet content</div>,
|
|
Route: ({ children }: { children?: ReactNode }) => <>{children}</>,
|
|
Routes: ({ children }: { children?: ReactNode }) => <>{children}</>,
|
|
useLocation: () => ({ pathname: "/instance/settings/general", search: "", hash: "" }),
|
|
useParams: () => ({}),
|
|
}));
|
|
|
|
async function flushReact() {
|
|
await Promise.resolve();
|
|
await new Promise((resolve) => window.setTimeout(resolve, 0));
|
|
}
|
|
|
|
async function waitForText(container: HTMLElement, text: string) {
|
|
for (let attempt = 0; attempt < 20; attempt += 1) {
|
|
if (container.textContent?.includes(text)) return;
|
|
await flushReact();
|
|
}
|
|
expect(container.textContent).toContain(text);
|
|
}
|
|
|
|
function renderGate(container: HTMLElement) {
|
|
const root = createRoot(container);
|
|
const queryClient = new QueryClient({
|
|
defaultOptions: { queries: { retry: false } },
|
|
});
|
|
|
|
flushSync(() => {
|
|
root.render(
|
|
<QueryClientProvider client={queryClient}>
|
|
<CloudAccessGate />
|
|
</QueryClientProvider>,
|
|
);
|
|
});
|
|
|
|
return root;
|
|
}
|
|
|
|
function unmountRoot(root: ReturnType<typeof createRoot>) {
|
|
flushSync(() => {
|
|
root.unmount();
|
|
});
|
|
}
|
|
|
|
describe("CloudAccessGate", () => {
|
|
let container: HTMLDivElement;
|
|
|
|
beforeEach(() => {
|
|
container = document.createElement("div");
|
|
document.body.appendChild(container);
|
|
mockHealthApi.get.mockResolvedValue({
|
|
status: "ok",
|
|
deploymentMode: "authenticated",
|
|
deploymentExposure: "private",
|
|
bootstrapStatus: "ready",
|
|
});
|
|
});
|
|
|
|
afterEach(() => {
|
|
container.remove();
|
|
document.body.innerHTML = "";
|
|
vi.clearAllMocks();
|
|
});
|
|
|
|
it("shows a no-access message for signed-in users without org access", async () => {
|
|
mockAuthApi.getSession.mockResolvedValue({
|
|
session: { id: "session-1", userId: "user-1" },
|
|
user: { id: "user-1", email: "user@example.com", name: "User", image: null },
|
|
});
|
|
mockAccessApi.getCurrentBoardAccess.mockResolvedValue({
|
|
user: { id: "user-1", email: "user@example.com", name: "User", image: null },
|
|
userId: "user-1",
|
|
isInstanceAdmin: false,
|
|
companyIds: [],
|
|
source: "session",
|
|
keyId: null,
|
|
});
|
|
|
|
const root = renderGate(container);
|
|
await waitForText(container, "No company access");
|
|
|
|
expect(container.textContent).toContain("No company access");
|
|
expect(container.textContent).not.toContain("Outlet content");
|
|
|
|
unmountRoot(root);
|
|
});
|
|
|
|
it("allows authenticated users with company access through to the board", async () => {
|
|
mockAuthApi.getSession.mockResolvedValue({
|
|
session: { id: "session-1", userId: "user-1" },
|
|
user: { id: "user-1", email: "user@example.com", name: "User", image: null },
|
|
});
|
|
mockAccessApi.getCurrentBoardAccess.mockResolvedValue({
|
|
user: { id: "user-1", email: "user@example.com", name: "User", image: null },
|
|
userId: "user-1",
|
|
isInstanceAdmin: false,
|
|
companyIds: ["company-1"],
|
|
source: "session",
|
|
keyId: null,
|
|
});
|
|
|
|
const root = renderGate(container);
|
|
await waitForText(container, "Outlet content");
|
|
|
|
expect(container.textContent).toContain("Outlet content");
|
|
expect(container.textContent).not.toContain("No company access");
|
|
|
|
unmountRoot(root);
|
|
});
|
|
|
|
it("shows browser sign-in setup for signed-out private bootstrap-pending instances", async () => {
|
|
mockHealthApi.get.mockResolvedValue({
|
|
status: "ok",
|
|
deploymentMode: "authenticated",
|
|
deploymentExposure: "private",
|
|
bootstrapStatus: "bootstrap_pending",
|
|
bootstrapInviteActive: false,
|
|
});
|
|
mockAuthApi.getSession.mockResolvedValue(null);
|
|
|
|
const root = renderGate(container);
|
|
await waitForText(container, "Finish setting up this Paperclip");
|
|
|
|
expect(container.textContent).toContain("Finish setting up this Paperclip");
|
|
expect(container.textContent).toContain("Sign in / Create account");
|
|
expect(container.textContent).toContain("npx paperclipai auth bootstrap-ceo");
|
|
expect(mockAccessApi.getCurrentBoardAccess).not.toHaveBeenCalled();
|
|
|
|
unmountRoot(root);
|
|
});
|
|
|
|
it("shows the claim action for signed-in private bootstrap-pending instances", async () => {
|
|
mockHealthApi.get.mockResolvedValue({
|
|
status: "ok",
|
|
deploymentMode: "authenticated",
|
|
deploymentExposure: "private",
|
|
bootstrapStatus: "bootstrap_pending",
|
|
bootstrapInviteActive: false,
|
|
});
|
|
mockAuthApi.getSession.mockResolvedValue({
|
|
session: { id: "session-1", userId: "user-1" },
|
|
user: { id: "user-1", email: "user@example.com", name: "User", image: null },
|
|
});
|
|
mockAccessApi.claimBootstrapAdmin.mockResolvedValue({ claimed: true, userId: "user-1" });
|
|
|
|
const root = renderGate(container);
|
|
await waitForText(container, "Claim this instance");
|
|
|
|
expect(container.textContent).toContain("Claim this instance");
|
|
expect(container.textContent).toContain("Signed in as user@example.com");
|
|
expect(mockAccessApi.getCurrentBoardAccess).not.toHaveBeenCalled();
|
|
|
|
const button = Array.from(container.querySelectorAll("button")).find((candidate) =>
|
|
candidate.textContent?.includes("Claim this instance"),
|
|
);
|
|
expect(button).toBeTruthy();
|
|
flushSync(() => {
|
|
button?.dispatchEvent(new MouseEvent("click", { bubbles: true }));
|
|
});
|
|
await waitForText(container, "You're the instance admin");
|
|
|
|
expect(mockAccessApi.claimBootstrapAdmin).toHaveBeenCalledTimes(1);
|
|
expect(container.textContent).toContain("You're the instance admin");
|
|
expect(container.textContent).toContain("Continue to dashboard");
|
|
|
|
unmountRoot(root);
|
|
});
|
|
|
|
it("keeps public bootstrap-pending instances invite-only", async () => {
|
|
mockHealthApi.get.mockResolvedValue({
|
|
status: "ok",
|
|
deploymentMode: "authenticated",
|
|
deploymentExposure: "public",
|
|
bootstrapStatus: "bootstrap_pending",
|
|
bootstrapInviteActive: true,
|
|
});
|
|
mockAuthApi.getSession.mockResolvedValue({
|
|
session: { id: "session-1", userId: "user-1" },
|
|
user: { id: "user-1", email: "user@example.com", name: "User", image: null },
|
|
});
|
|
|
|
const root = renderGate(container);
|
|
await waitForText(container, "This Paperclip is waiting on its first admin");
|
|
|
|
expect(container.textContent).toContain("This Paperclip is waiting on its first admin");
|
|
expect(container.textContent).toContain("invite-only mode");
|
|
expect(container.textContent).not.toContain("Claim this instance");
|
|
expect(container.textContent).not.toContain("Sign in / Create account");
|
|
expect(mockAccessApi.claimBootstrapAdmin).not.toHaveBeenCalled();
|
|
|
|
unmountRoot(root);
|
|
});
|
|
});
|
|
|
|
describe("Skill Studio routes", () => {
|
|
it("registers create mode before the skillId route in prefixed and unprefixed routing", () => {
|
|
const createRoute = 'path="skills/studio/new"';
|
|
const detailRoute = 'path="skills/studio/:skillId"';
|
|
const createIndexes = [...appSource.matchAll(new RegExp(createRoute, "g"))].map((match) => match.index ?? -1);
|
|
const detailIndexes = [...appSource.matchAll(new RegExp(detailRoute, "g"))].map((match) => match.index ?? -1);
|
|
|
|
expect(createIndexes).toHaveLength(2);
|
|
expect(detailIndexes).toHaveLength(2);
|
|
expect(createIndexes[0]).toBeLessThan(detailIndexes[0]!);
|
|
expect(createIndexes[1]).toBeLessThan(detailIndexes[1]!);
|
|
});
|
|
});
|
|
|
|
describe("Apps routes", () => {
|
|
it("uses browse as the Apps landing page and gives connections a canonical URL", () => {
|
|
expect(appSource).toContain('<Route path="apps" element={<Browse />} />');
|
|
expect(appSource).toContain('<Route path="apps/browse" element={<Navigate to="/apps" replace />} />');
|
|
expect(appSource).toContain('<Route path="apps/connections" element={<Connections />} />');
|
|
expect(appSource).toContain('<Route path="apps/connect/:appKey" element={<Navigate to="/apps" replace />} />');
|
|
expect(appSource).toContain('<Route path="apps/connect/:appKey/:stage" element={<Navigate to="/apps" replace />} />');
|
|
});
|
|
});
|
|
|
|
describe("Decisions routes", () => {
|
|
it("does not register decision-training views", () => {
|
|
expect(appSource).not.toContain('path="decisions/training"');
|
|
expect(appSource).not.toContain('path="decisions/training/:id"');
|
|
expect(appSource).not.toContain('path="training"');
|
|
expect(appSource).not.toContain('path="training/:id"');
|
|
});
|
|
});
|