mirror of
https://github.com/alkimake/paperclip.git
synced 2026-06-14 01:50:39 +09:00
## Thinking Path > - Paperclip orchestrates AI agents for zero-human companies > - The Cursor adapter spawns the Cursor CLI against local, SSH, and sandbox execution targets; on a fresh sandbox lease, it has to resolve where Cursor was installed > - The previous resolver only looked for `~/.local/bin/cursor-agent` even though the official installer (and the adapter's own `SANDBOX_INSTALL_COMMAND`) sometimes lays the binary down as `~/.local/bin/agent`, so a sandbox where the install ran successfully would still fail to find the CLI > - This pull request lets the resolver accept either basename and lets the caller pass an optional `remoteSystemHomeDirHint` so a probe doesn't pay the cost of a remote `printf $HOME` round-trip when the home directory is already known > - The benefit is sandboxed Cursor runs find the binary that the install actually produced, and runtime probes are cheaper when the home dir is already resolved ## What Changed - `packages/adapters/cursor-local/src/server/remote-command.ts`: accept either `agent` or `cursor-agent` as the preferred basename; new optional `remoteSystemHomeDirHint` short-circuits the home-dir probe - `packages/adapters/cursor-local/src/server/execute.ts`: thread the home-dir hint through, prefer the resolved binary path, and shift the effective execution cwd to the per-run managed subdirectory once the runtime is prepared - New `remote-command.test.ts` and `execute.test.ts` cover both basenames, the hint short-circuit, and the cwd shift - `packages/adapters/cursor-local/src/index.ts`: update doc string to reflect the broader resolution - `execute.remote.test.ts` updated to expect the managed-subdirectory cwd shape introduced by the cwd shift ## Verification - `pnpm vitest run --no-coverage --project @paperclipai/adapter-cursor-local` — 6/6 passing - `pnpm typecheck` clean - Manual: a fresh sandbox lease with `npm install -g …`-installed Cursor (binary lands as `~/.local/bin/agent`) now runs cleanly through the adapter ## Risks Low. Resolver is strictly broader (matches a superset of paths); existing setups with `~/.local/bin/cursor-agent` continue to work. The home-dir hint is opt-in; callers that don't pass it get the existing probe behavior. Cursor's effective execution cwd now matches the rest of the adapters (per-run managed subdirectory) — sessions previously rooted at the workspace root will land in the new subdirectory. ## Model Used Claude Opus 4.7 (1M context) ## 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 — new tests cover both basenames + hint short-circuit + cwd shift - [x] If this change affects the UI, I have included before/after screenshots — N/A (no UI) - [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 --- > **Stacked PR.** Sits on top of #5445 (which sits on #5444). Cumulative diff against `master` includes both of those PRs' content; the files touched by *this* PR's commit are listed under "What Changed" above. Will rebase onto `master` and force-push once the prerequisite PRs merge.
352 lines
12 KiB
TypeScript
352 lines
12 KiB
TypeScript
import fs from "node:fs/promises";
|
|
import os from "node:os";
|
|
import path from "node:path";
|
|
import { describe, expect, it, vi } from "vitest";
|
|
import type { AdapterExecutionTarget } from "@paperclipai/adapter-utils/execution-target";
|
|
import { runChildProcess } from "@paperclipai/adapter-utils/server-utils";
|
|
import { SANDBOX_INSTALL_COMMAND } from "../index.js";
|
|
import { execute } from "./execute.js";
|
|
|
|
type PrepareCursorSandboxCommandInput = {
|
|
runId: string;
|
|
target: AdapterExecutionTarget | null | undefined;
|
|
command: string;
|
|
cwd: string;
|
|
env: Record<string, string>;
|
|
remoteSystemHomeDirHint?: string | null;
|
|
timeoutSec: number;
|
|
graceSec: number;
|
|
};
|
|
|
|
type PrepareCursorSandboxCommandResult = {
|
|
command: string;
|
|
env: Record<string, string>;
|
|
remoteSystemHomeDir: string | null;
|
|
addedPathEntry: string | null;
|
|
preferredCommandPath: string | null;
|
|
};
|
|
|
|
const {
|
|
setPrepareCursorSandboxCommand,
|
|
} = vi.hoisted(() => {
|
|
const setPrepareCursorSandboxCommand = vi.fn<
|
|
(input: PrepareCursorSandboxCommandInput) => Promise<PrepareCursorSandboxCommandResult>
|
|
>();
|
|
return { setPrepareCursorSandboxCommand };
|
|
});
|
|
|
|
vi.mock("@paperclipai/adapter-utils/execution-target", async () => {
|
|
const actual = await vi.importActual<typeof import("@paperclipai/adapter-utils/execution-target")>(
|
|
"@paperclipai/adapter-utils/execution-target",
|
|
);
|
|
return {
|
|
...actual,
|
|
startAdapterExecutionTargetPaperclipBridge: async () => null,
|
|
};
|
|
});
|
|
|
|
vi.mock("./remote-command.js", async () => {
|
|
const actual = await vi.importActual<typeof import("./remote-command.js")>("./remote-command.js");
|
|
return {
|
|
...actual,
|
|
prepareCursorSandboxCommand: async (input: Parameters<typeof actual.prepareCursorSandboxCommand>[0]) => {
|
|
return setPrepareCursorSandboxCommand(input);
|
|
},
|
|
};
|
|
});
|
|
|
|
function buildFakeAgentScript(captureDir: string): string {
|
|
return `#!/bin/sh
|
|
cat > ${JSON.stringify(path.join(captureDir, "prompt.txt"))}
|
|
printf '%s' "$0" > ${JSON.stringify(path.join(captureDir, "command.txt"))}
|
|
printf '%s' "$PATH" > ${JSON.stringify(path.join(captureDir, "path.txt"))}
|
|
printf '%s\\n' '{"type":"system","subtype":"init","session_id":"cursor-session-fresh-1","model":"auto"}'
|
|
printf '%s\\n' '{"type":"assistant","message":{"content":[{"type":"output_text","text":"hello"}]}}'
|
|
printf '%s\\n' '{"type":"result","subtype":"success","session_id":"cursor-session-fresh-1","result":"ok"}'
|
|
`;
|
|
}
|
|
|
|
function buildInstallSimulationCommand(commandPath: string, captureDir: string): string {
|
|
return [
|
|
`mkdir -p ${JSON.stringify(path.dirname(commandPath))}`,
|
|
`mkdir -p ${JSON.stringify(captureDir)}`,
|
|
`cat > ${JSON.stringify(commandPath)} <<'EOF'`,
|
|
buildFakeAgentScript(captureDir),
|
|
"EOF",
|
|
`chmod +x ${JSON.stringify(commandPath)}`,
|
|
].join("\n");
|
|
}
|
|
|
|
function createFreshLeaseSandboxRunner(options: {
|
|
homeDir: string;
|
|
installCommandPath: string;
|
|
captureDir: string;
|
|
}) {
|
|
let counter = 0;
|
|
const installCommands: string[] = [];
|
|
const systemPath = [
|
|
"/usr/local/bin",
|
|
"/opt/homebrew/bin",
|
|
"/usr/local/sbin",
|
|
"/usr/bin",
|
|
"/bin",
|
|
"/usr/sbin",
|
|
"/sbin",
|
|
].join(path.delimiter);
|
|
|
|
return {
|
|
installCommands,
|
|
execute: async (input: {
|
|
command: string;
|
|
args?: string[];
|
|
cwd?: string;
|
|
env?: Record<string, string>;
|
|
stdin?: string;
|
|
timeoutMs?: number;
|
|
onLog?: (stream: "stdout" | "stderr", chunk: string) => Promise<void>;
|
|
onSpawn?: (meta: { pid: number; startedAt: string }) => Promise<void>;
|
|
}) => {
|
|
counter += 1;
|
|
const args = [...(input.args ?? [])];
|
|
if (args[1] === SANDBOX_INSTALL_COMMAND) {
|
|
installCommands.push(args[1]);
|
|
args[1] = buildInstallSimulationCommand(options.installCommandPath, options.captureDir);
|
|
}
|
|
|
|
const inheritedPath = input.env?.PATH ?? systemPath;
|
|
const pathWithLocalBin = `${path.join(options.homeDir, ".local", "bin")}${path.delimiter}${inheritedPath}`;
|
|
const env = {
|
|
...(input.env ?? {}),
|
|
HOME: input.env?.HOME ?? options.homeDir,
|
|
PATH: pathWithLocalBin,
|
|
};
|
|
|
|
return await runChildProcess(`cursor-fresh-lease-${counter}`, input.command, args, {
|
|
cwd: input.cwd ?? process.cwd(),
|
|
env,
|
|
stdin: input.stdin,
|
|
timeoutSec: Math.max(1, Math.ceil((input.timeoutMs ?? 30_000) / 1000)),
|
|
graceSec: 5,
|
|
onLog: input.onLog ?? (async () => {}),
|
|
onSpawn: input.onSpawn
|
|
? async (meta) => input.onSpawn?.({ pid: meta.pid, startedAt: meta.startedAt })
|
|
: undefined,
|
|
});
|
|
},
|
|
};
|
|
}
|
|
|
|
describe("cursor execute", () => {
|
|
it("installs the default agent command on a fresh sandbox lease before execution", async () => {
|
|
setPrepareCursorSandboxCommand.mockReset();
|
|
setPrepareCursorSandboxCommand.mockImplementation(async (input) => {
|
|
const actual = await vi.importActual<typeof import("./remote-command.js")>("./remote-command.js");
|
|
return actual.prepareCursorSandboxCommand(input);
|
|
});
|
|
|
|
const root = await fs.mkdtemp(path.join(os.tmpdir(), "paperclip-cursor-fresh-lease-"));
|
|
const homeDir = path.join(root, "home");
|
|
const workspace = path.join(root, "workspace");
|
|
const remoteWorkspace = path.join(root, "remote-workspace");
|
|
const captureDir = path.join(root, "capture");
|
|
const agentPath = path.join(homeDir, ".local", "bin", "agent");
|
|
await fs.mkdir(workspace, { recursive: true });
|
|
await fs.mkdir(remoteWorkspace, { recursive: true });
|
|
|
|
const runner = createFreshLeaseSandboxRunner({
|
|
homeDir,
|
|
installCommandPath: agentPath,
|
|
captureDir,
|
|
});
|
|
|
|
const previousHome = process.env.HOME;
|
|
process.env.HOME = homeDir;
|
|
|
|
try {
|
|
const result = await execute({
|
|
runId: "run-fresh-lease-1",
|
|
agent: {
|
|
id: "agent-1",
|
|
companyId: "company-1",
|
|
name: "Cursor Coder",
|
|
adapterType: "cursor",
|
|
adapterConfig: {},
|
|
},
|
|
runtime: {
|
|
sessionId: null,
|
|
sessionParams: null,
|
|
sessionDisplayId: null,
|
|
taskKey: null,
|
|
},
|
|
executionTarget: {
|
|
kind: "remote",
|
|
transport: "sandbox",
|
|
remoteCwd: remoteWorkspace,
|
|
runner,
|
|
timeoutMs: 30_000,
|
|
},
|
|
config: {
|
|
command: "agent",
|
|
cwd: workspace,
|
|
promptTemplate: "Follow the paperclip heartbeat.",
|
|
},
|
|
context: {},
|
|
authToken: "run-jwt-token",
|
|
onLog: async () => {},
|
|
});
|
|
|
|
expect(result.exitCode).toBe(0);
|
|
expect(result.errorMessage).toBeNull();
|
|
expect(runner.installCommands).toEqual([SANDBOX_INSTALL_COMMAND]);
|
|
|
|
const command = await fs.readFile(path.join(captureDir, "command.txt"), "utf8");
|
|
const runtimePath = await fs.readFile(path.join(captureDir, "path.txt"), "utf8");
|
|
const prompt = await fs.readFile(path.join(captureDir, "prompt.txt"), "utf8");
|
|
expect(command).toBe(agentPath);
|
|
expect(runtimePath.split(path.delimiter)[0]).toBe(path.join(homeDir, ".local", "bin"));
|
|
expect(prompt).toContain("Follow the paperclip heartbeat.");
|
|
} finally {
|
|
if (previousHome === undefined) delete process.env.HOME;
|
|
else process.env.HOME = previousHome;
|
|
await fs.rm(root, { recursive: true, force: true });
|
|
}
|
|
});
|
|
|
|
it("reruns sandbox command resolution after managed runtime setup and keeps the original sandbox home", async () => {
|
|
setPrepareCursorSandboxCommand.mockReset();
|
|
const prepareInputs: PrepareCursorSandboxCommandInput[] = [];
|
|
let finalPreparedCommand: string | null = null;
|
|
|
|
const rootDir = await fs.mkdtemp(path.join(os.tmpdir(), "paperclip-cursor-fresh-lease-managed-"));
|
|
const workspaceDir = path.join(rootDir, "workspace");
|
|
const remoteWorkspace = path.join(rootDir, "remote-workspace");
|
|
const systemHomeDir = path.join(rootDir, "system-home");
|
|
const managedCaptureDir = path.join(rootDir, "managed-capture");
|
|
await fs.mkdir(managedCaptureDir, { recursive: true });
|
|
await fs.mkdir(workspaceDir, { recursive: true });
|
|
await fs.mkdir(remoteWorkspace, { recursive: true });
|
|
const preferredAgentScript = `#!/bin/sh
|
|
printf '%s\\n' '{"type":"system","subtype":"init","session_id":"cursor-session-fresh-1","model":"auto"}'
|
|
printf '%s\\n' '{"type":"assistant","message":{"content":[{"type":"output_text","text":"hello"}]}}'
|
|
printf '%s\\n' '{"type":"result","subtype":"success","session_id":"cursor-session-fresh-1","result":"ok"}'
|
|
`;
|
|
|
|
setPrepareCursorSandboxCommand.mockImplementation(async (input) => {
|
|
const call = prepareInputs.length;
|
|
prepareInputs.push(input);
|
|
if (call === 0) {
|
|
return {
|
|
command: input.command,
|
|
env: input.env,
|
|
remoteSystemHomeDir: systemHomeDir,
|
|
addedPathEntry: null,
|
|
preferredCommandPath: null,
|
|
};
|
|
}
|
|
|
|
expect(input.remoteSystemHomeDirHint).toBe(systemHomeDir);
|
|
const preferredCommandPath = path.join(systemHomeDir, ".local", "bin", input.command);
|
|
finalPreparedCommand = preferredCommandPath;
|
|
const runtimeEnv = {
|
|
...input.env,
|
|
PATH: `${path.join(systemHomeDir, ".local", "bin")}${path.delimiter}${input.env.PATH}`,
|
|
};
|
|
await fs.mkdir(path.dirname(preferredCommandPath), { recursive: true });
|
|
await fs.writeFile(preferredCommandPath, preferredAgentScript);
|
|
await fs.chmod(preferredCommandPath, 0o755);
|
|
await fs.writeFile(path.join(managedCaptureDir, "agent-output.log"), preferredCommandPath);
|
|
|
|
return {
|
|
command: preferredCommandPath,
|
|
env: runtimeEnv,
|
|
remoteSystemHomeDir: systemHomeDir,
|
|
addedPathEntry: path.join(systemHomeDir, ".local", "bin"),
|
|
preferredCommandPath,
|
|
};
|
|
});
|
|
|
|
const runnerState = {
|
|
commands: [] as string[],
|
|
};
|
|
const runner = {
|
|
execute: async (input: { command: string; args?: string[]; env?: Record<string, string> }) => {
|
|
runnerState.commands.push(input.command);
|
|
if (input.command === "sh") {
|
|
return {
|
|
exitCode: 0,
|
|
signal: null,
|
|
timedOut: false,
|
|
stdout: "",
|
|
stderr: "",
|
|
pid: 555,
|
|
startedAt: new Date().toISOString(),
|
|
};
|
|
}
|
|
|
|
return runChildProcess(`cursor-fresh-lease-${runnerState.commands.length}`, input.command, input.args ?? [], {
|
|
cwd: remoteWorkspace,
|
|
env: input.env ?? {},
|
|
timeoutSec: 30,
|
|
graceSec: 5,
|
|
onLog: async () => {},
|
|
onSpawn: async () => {},
|
|
});
|
|
},
|
|
};
|
|
|
|
const runMeta: Array<{ command?: string; [key: string]: unknown }> = [];
|
|
const previousHome = process.env.HOME;
|
|
process.env.HOME = systemHomeDir;
|
|
|
|
try {
|
|
const command = "agent";
|
|
const result = await execute({
|
|
runId: "run-fresh-lease-managed",
|
|
agent: {
|
|
id: "agent-1",
|
|
companyId: "company-1",
|
|
name: "Cursor Coder",
|
|
adapterType: "cursor",
|
|
adapterConfig: {},
|
|
},
|
|
runtime: {
|
|
sessionId: null,
|
|
sessionParams: null,
|
|
sessionDisplayId: null,
|
|
taskKey: null,
|
|
},
|
|
executionTarget: {
|
|
kind: "remote",
|
|
transport: "sandbox",
|
|
remoteCwd: remoteWorkspace,
|
|
providerKey: "fixture",
|
|
runner: runner,
|
|
timeoutMs: 30_000,
|
|
},
|
|
config: {
|
|
command,
|
|
cwd: workspaceDir,
|
|
promptTemplate: "Run against runtime-managed command.",
|
|
},
|
|
context: {},
|
|
authToken: "run-jwt-token",
|
|
onLog: async () => {},
|
|
onMeta: async (meta) => {
|
|
runMeta.push(meta as unknown as { command?: string; [key: string]: unknown });
|
|
},
|
|
});
|
|
|
|
expect(result.exitCode).toBe(0);
|
|
expect(prepareInputs).toHaveLength(2);
|
|
expect(finalPreparedCommand).not.toBeNull();
|
|
expect(finalPreparedCommand).toMatch(/\.local\/(bin|sbin)\/agent$/);
|
|
const resolvedCommand = runMeta.find(Boolean)?.command as string | undefined;
|
|
expect(resolvedCommand).toMatch(/\.local\/bin\/agent$/);
|
|
expect(resolvedCommand).toContain(path.join(systemHomeDir, ".local", "bin", command));
|
|
} finally {
|
|
if (previousHome === undefined) delete process.env.HOME;
|
|
else process.env.HOME = previousHome;
|
|
await fs.rm(rootDir, { recursive: true, force: true });
|
|
}
|
|
});
|
|
});
|