mirror of
https://github.com/getcompanion-ai/co-mono.git
synced 2026-04-15 20:03:05 +00:00
- Add ! prefix in TUI editor to execute shell commands directly
- Output streams in real-time and is added to LLM context
- Supports multiline commands, cancellation (Escape), truncation
- Preview mode shows last 20 lines, Ctrl+O expands full output
- Commands persist in session history as bashExecution messages
- Add bash command to RPC mode via {type:'bash',command:'...'}
- Add RPC tests for bash command execution and context inclusion
- Update docs: rpc.md, session.md, README.md, CHANGELOG.md
Closes #112
Co-authored-by: Markus Ylisiurunen <markus.ylisiurunen@gmail.com>
429 lines
13 KiB
TypeScript
429 lines
13 KiB
TypeScript
import { type ChildProcess, spawn } from "node:child_process";
|
|
import { existsSync, readdirSync, readFileSync, rmSync } from "node:fs";
|
|
import { tmpdir } from "node:os";
|
|
import { dirname, join } from "node:path";
|
|
import * as readline from "node:readline";
|
|
import { fileURLToPath } from "node:url";
|
|
import type { AgentEvent } from "@mariozechner/pi-agent-core";
|
|
import { afterEach, beforeEach, describe, expect, test } from "vitest";
|
|
import type { BashExecutionMessage } from "../src/messages.js";
|
|
import type { CompactionEntry } from "../src/session-manager.js";
|
|
|
|
const __dirname = dirname(fileURLToPath(import.meta.url));
|
|
|
|
/**
|
|
* RPC mode tests.
|
|
* Regression test for issue #83: https://github.com/badlogic/pi-mono/issues/83
|
|
*/
|
|
describe.skipIf(!process.env.ANTHROPIC_API_KEY && !process.env.ANTHROPIC_OAUTH_TOKEN)("RPC mode", () => {
|
|
let agent: ChildProcess;
|
|
let sessionDir: string;
|
|
|
|
beforeEach(() => {
|
|
// Create a unique temp directory for sessions
|
|
sessionDir = join(tmpdir(), `pi-rpc-test-${Date.now()}`);
|
|
});
|
|
|
|
afterEach(() => {
|
|
// Kill the agent if still running
|
|
if (agent && !agent.killed) {
|
|
agent.kill("SIGKILL");
|
|
}
|
|
// Clean up session directory
|
|
if (sessionDir && existsSync(sessionDir)) {
|
|
rmSync(sessionDir, { recursive: true });
|
|
}
|
|
});
|
|
|
|
test("should save messages to session file", async () => {
|
|
// Spawn agent in RPC mode with custom session directory
|
|
agent = spawn(
|
|
"node",
|
|
["dist/cli.js", "--mode", "rpc", "--provider", "anthropic", "--model", "claude-sonnet-4-5"],
|
|
{
|
|
cwd: join(__dirname, ".."),
|
|
env: {
|
|
...process.env,
|
|
PI_CODING_AGENT_DIR: sessionDir,
|
|
},
|
|
},
|
|
);
|
|
|
|
const events: AgentEvent[] = [];
|
|
|
|
// Parse agent events
|
|
const rl = readline.createInterface({ input: agent.stdout!, terminal: false });
|
|
|
|
// Collect stderr for debugging
|
|
let stderr = "";
|
|
agent.stderr?.on("data", (data) => {
|
|
stderr += data.toString();
|
|
});
|
|
|
|
// Wait for agent_end which signals the full prompt/response cycle is complete
|
|
const waitForAgentEnd = new Promise<void>((resolve, reject) => {
|
|
const timeout = setTimeout(() => reject(new Error("Timeout waiting for agent_end")), 60000);
|
|
|
|
rl.on("line", (line: string) => {
|
|
try {
|
|
const event = JSON.parse(line) as AgentEvent;
|
|
events.push(event);
|
|
|
|
// agent_end means the full prompt cycle completed (user msg + assistant response)
|
|
if (event.type === "agent_end") {
|
|
clearTimeout(timeout);
|
|
resolve();
|
|
}
|
|
} catch {
|
|
// Ignore non-JSON lines
|
|
}
|
|
});
|
|
|
|
rl.on("close", () => {
|
|
clearTimeout(timeout);
|
|
reject(new Error("Agent stdout closed before agent_end"));
|
|
});
|
|
});
|
|
|
|
// Send a simple prompt - the LLM will respond
|
|
agent.stdin!.write(JSON.stringify({ type: "prompt", message: "Reply with just the word 'hello'" }) + "\n");
|
|
|
|
// Wait for full prompt/response cycle to complete
|
|
await waitForAgentEnd;
|
|
|
|
// Check that message_end events were emitted
|
|
const messageEndEvents = events.filter((e) => e.type === "message_end");
|
|
expect(messageEndEvents.length).toBeGreaterThanOrEqual(2); // user + assistant
|
|
|
|
// Wait a bit for file writes to complete
|
|
await new Promise((resolve) => setTimeout(resolve, 200));
|
|
|
|
// Kill the agent gracefully
|
|
agent.kill("SIGTERM");
|
|
|
|
// Find and verify the session file
|
|
const sessionsPath = join(sessionDir, "sessions");
|
|
expect(existsSync(sessionsPath), `Sessions path should exist: ${sessionsPath}. Stderr: ${stderr}`).toBe(true);
|
|
|
|
// Find the session directory (it's based on cwd)
|
|
const sessionDirs = readdirSync(sessionsPath);
|
|
expect(sessionDirs.length, `Should have at least one session dir. Stderr: ${stderr}`).toBeGreaterThan(0);
|
|
|
|
const cwdSessionDir = join(sessionsPath, sessionDirs[0]);
|
|
const allFiles = readdirSync(cwdSessionDir);
|
|
const sessionFiles = allFiles.filter((f) => f.endsWith(".jsonl"));
|
|
expect(
|
|
sessionFiles.length,
|
|
`Should have exactly one session file. Dir: ${cwdSessionDir}, Files: ${JSON.stringify(allFiles)}, Stderr: ${stderr}`,
|
|
).toBe(1);
|
|
|
|
// Read and verify session content
|
|
const sessionContent = readFileSync(join(cwdSessionDir, sessionFiles[0]), "utf8");
|
|
const lines = sessionContent.trim().split("\n");
|
|
|
|
// Should have session header and at least 2 messages (user + assistant)
|
|
expect(lines.length).toBeGreaterThanOrEqual(3);
|
|
|
|
const entries = lines.map((line) => JSON.parse(line));
|
|
|
|
// First entry should be session header
|
|
expect(entries[0].type).toBe("session");
|
|
|
|
// Should have user and assistant messages
|
|
const messages = entries.filter((e: { type: string }) => e.type === "message");
|
|
expect(messages.length).toBeGreaterThanOrEqual(2);
|
|
|
|
const roles = messages.map((m: { message: { role: string } }) => m.message.role);
|
|
expect(roles).toContain("user");
|
|
expect(roles).toContain("assistant");
|
|
}, 90000);
|
|
|
|
test("should handle manual compaction", async () => {
|
|
// Spawn agent in RPC mode
|
|
agent = spawn(
|
|
"node",
|
|
["dist/cli.js", "--mode", "rpc", "--provider", "anthropic", "--model", "claude-sonnet-4-5"],
|
|
{
|
|
cwd: join(__dirname, ".."),
|
|
env: {
|
|
...process.env,
|
|
PI_CODING_AGENT_DIR: sessionDir,
|
|
},
|
|
},
|
|
);
|
|
|
|
const events: (AgentEvent | CompactionEntry | { type: "error"; error: string })[] = [];
|
|
|
|
const rl = readline.createInterface({ input: agent.stdout!, terminal: false });
|
|
|
|
let stderr = "";
|
|
agent.stderr?.on("data", (data) => {
|
|
stderr += data.toString();
|
|
});
|
|
|
|
// Helper to wait for a specific event type
|
|
const waitForEvent = (eventType: string, timeout = 60000) =>
|
|
new Promise<void>((resolve, reject) => {
|
|
const timer = setTimeout(() => reject(new Error(`Timeout waiting for ${eventType}`)), timeout);
|
|
|
|
const checkExisting = () => {
|
|
if (events.some((e) => e.type === eventType)) {
|
|
clearTimeout(timer);
|
|
resolve();
|
|
return true;
|
|
}
|
|
return false;
|
|
};
|
|
|
|
if (checkExisting()) return;
|
|
|
|
const handler = (line: string) => {
|
|
try {
|
|
const event = JSON.parse(line);
|
|
events.push(event);
|
|
if (event.type === eventType) {
|
|
clearTimeout(timer);
|
|
rl.off("line", handler);
|
|
resolve();
|
|
}
|
|
} catch {
|
|
// Ignore non-JSON
|
|
}
|
|
};
|
|
rl.on("line", handler);
|
|
});
|
|
|
|
// First, send a prompt to have some messages to compact
|
|
agent.stdin!.write(JSON.stringify({ type: "prompt", message: "Say hello" }) + "\n");
|
|
await waitForEvent("agent_end");
|
|
|
|
// Clear events to focus on compaction
|
|
events.length = 0;
|
|
|
|
// Send compact command
|
|
agent.stdin!.write(JSON.stringify({ type: "compact" }) + "\n");
|
|
await waitForEvent("compaction");
|
|
|
|
// Verify compaction event
|
|
const compactionEvent = events.find((e) => e.type === "compaction") as CompactionEntry | undefined;
|
|
expect(compactionEvent).toBeDefined();
|
|
expect(compactionEvent!.summary).toBeDefined();
|
|
expect(compactionEvent!.tokensBefore).toBeGreaterThan(0);
|
|
|
|
// Wait for file writes
|
|
await new Promise((resolve) => setTimeout(resolve, 200));
|
|
|
|
agent.kill("SIGTERM");
|
|
|
|
// Verify compaction was saved to session file
|
|
const sessionsPath = join(sessionDir, "sessions");
|
|
const sessionDirs = readdirSync(sessionsPath);
|
|
const cwdSessionDir = join(sessionsPath, sessionDirs[0]);
|
|
const sessionFiles = readdirSync(cwdSessionDir).filter((f) => f.endsWith(".jsonl"));
|
|
const sessionContent = readFileSync(join(cwdSessionDir, sessionFiles[0]), "utf8");
|
|
const entries = sessionContent
|
|
.trim()
|
|
.split("\n")
|
|
.map((line) => JSON.parse(line));
|
|
|
|
// Should have a compaction entry
|
|
const compactionEntries = entries.filter((e: { type: string }) => e.type === "compaction");
|
|
expect(compactionEntries.length).toBe(1);
|
|
expect(compactionEntries[0].summary).toBeDefined();
|
|
}, 120000);
|
|
|
|
test("should execute bash command and add to context", async () => {
|
|
// Spawn agent in RPC mode
|
|
agent = spawn(
|
|
"node",
|
|
["dist/cli.js", "--mode", "rpc", "--provider", "anthropic", "--model", "claude-sonnet-4-5"],
|
|
{
|
|
cwd: join(__dirname, ".."),
|
|
env: {
|
|
...process.env,
|
|
PI_CODING_AGENT_DIR: sessionDir,
|
|
},
|
|
},
|
|
);
|
|
|
|
const events: (
|
|
| AgentEvent
|
|
| { type: "bash_end"; message: BashExecutionMessage }
|
|
| { type: "error"; error: string }
|
|
)[] = [];
|
|
|
|
const rl = readline.createInterface({ input: agent.stdout!, terminal: false });
|
|
|
|
let stderr = "";
|
|
agent.stderr?.on("data", (data) => {
|
|
stderr += data.toString();
|
|
});
|
|
|
|
// Set up persistent event collector BEFORE sending any commands
|
|
// This is critical for fast commands like bash that complete before
|
|
// a per-call handler would be registered
|
|
rl.on("line", (line: string) => {
|
|
try {
|
|
const event = JSON.parse(line);
|
|
events.push(event);
|
|
} catch {
|
|
// Ignore non-JSON
|
|
}
|
|
});
|
|
|
|
// Helper to wait for a specific event type by polling collected events
|
|
const waitForEvent = (eventType: string, timeout = 60000) =>
|
|
new Promise<void>((resolve, reject) => {
|
|
const timer = setTimeout(
|
|
() => reject(new Error(`Timeout waiting for ${eventType}. Stderr: ${stderr}`)),
|
|
timeout,
|
|
);
|
|
const check = () => {
|
|
if (events.some((e) => e.type === eventType)) {
|
|
clearTimeout(timer);
|
|
resolve();
|
|
} else {
|
|
setTimeout(check, 50);
|
|
}
|
|
};
|
|
check();
|
|
});
|
|
|
|
// Send a bash command
|
|
agent.stdin!.write(JSON.stringify({ type: "bash", command: "echo hello" }) + "\n");
|
|
await waitForEvent("bash_end");
|
|
|
|
// Verify bash_end event
|
|
const bashEvent = events.find((e) => e.type === "bash_end") as
|
|
| { type: "bash_end"; message: BashExecutionMessage }
|
|
| undefined;
|
|
expect(bashEvent).toBeDefined();
|
|
expect(bashEvent!.message.role).toBe("bashExecution");
|
|
expect(bashEvent!.message.command).toBe("echo hello");
|
|
expect(bashEvent!.message.output.trim()).toBe("hello");
|
|
expect(bashEvent!.message.exitCode).toBe(0);
|
|
expect(bashEvent!.message.cancelled).toBe(false);
|
|
|
|
// Clear events for next phase
|
|
events.length = 0;
|
|
|
|
// Session only initializes after user+assistant exchange, so send a prompt
|
|
agent.stdin!.write(JSON.stringify({ type: "prompt", message: "Say hi" }) + "\n");
|
|
await waitForEvent("agent_end");
|
|
|
|
// Wait for file writes
|
|
await new Promise((resolve) => setTimeout(resolve, 200));
|
|
|
|
agent.kill("SIGTERM");
|
|
|
|
// Verify bash execution was saved to session file
|
|
const sessionsPath = join(sessionDir, "sessions");
|
|
const sessionDirs = readdirSync(sessionsPath);
|
|
const cwdSessionDir = join(sessionsPath, sessionDirs[0]);
|
|
const sessionFiles = readdirSync(cwdSessionDir).filter((f) => f.endsWith(".jsonl"));
|
|
const sessionContent = readFileSync(join(cwdSessionDir, sessionFiles[0]), "utf8");
|
|
const entries = sessionContent
|
|
.trim()
|
|
.split("\n")
|
|
.map((line) => JSON.parse(line));
|
|
|
|
// Should have a bashExecution message
|
|
const bashMessages = entries.filter(
|
|
(e: { type: string; message?: { role: string } }) =>
|
|
e.type === "message" && e.message?.role === "bashExecution",
|
|
);
|
|
expect(bashMessages.length).toBe(1);
|
|
expect(bashMessages[0].message.command).toBe("echo hello");
|
|
expect(bashMessages[0].message.output.trim()).toBe("hello");
|
|
}, 90000);
|
|
|
|
test("should include bash output in LLM context", async () => {
|
|
// Spawn agent in RPC mode
|
|
agent = spawn(
|
|
"node",
|
|
["dist/cli.js", "--mode", "rpc", "--provider", "anthropic", "--model", "claude-sonnet-4-5"],
|
|
{
|
|
cwd: join(__dirname, ".."),
|
|
env: {
|
|
...process.env,
|
|
PI_CODING_AGENT_DIR: sessionDir,
|
|
},
|
|
},
|
|
);
|
|
|
|
const events: (
|
|
| AgentEvent
|
|
| { type: "bash_end"; message: BashExecutionMessage }
|
|
| { type: "error"; error: string }
|
|
)[] = [];
|
|
|
|
const rl = readline.createInterface({ input: agent.stdout!, terminal: false });
|
|
|
|
let stderr = "";
|
|
agent.stderr?.on("data", (data) => {
|
|
stderr += data.toString();
|
|
});
|
|
|
|
// Set up persistent event collector BEFORE sending any commands
|
|
rl.on("line", (line: string) => {
|
|
try {
|
|
const event = JSON.parse(line);
|
|
events.push(event);
|
|
} catch {
|
|
// Ignore non-JSON
|
|
}
|
|
});
|
|
|
|
// Helper to wait for a specific event type by polling collected events
|
|
const waitForEvent = (eventType: string, timeout = 60000) =>
|
|
new Promise<void>((resolve, reject) => {
|
|
const timer = setTimeout(
|
|
() => reject(new Error(`Timeout waiting for ${eventType}. Stderr: ${stderr}`)),
|
|
timeout,
|
|
);
|
|
const check = () => {
|
|
if (events.some((e) => e.type === eventType)) {
|
|
clearTimeout(timer);
|
|
resolve();
|
|
} else {
|
|
setTimeout(check, 50);
|
|
}
|
|
};
|
|
check();
|
|
});
|
|
|
|
// Wait for agent to initialize (session manager, etc.)
|
|
await new Promise((resolve) => setTimeout(resolve, 500));
|
|
|
|
// First, run a bash command with a unique value
|
|
const uniqueValue = `test-${Date.now()}`;
|
|
agent.stdin!.write(JSON.stringify({ type: "bash", command: `echo ${uniqueValue}` }) + "\n");
|
|
await waitForEvent("bash_end");
|
|
|
|
// Clear events but keep collecting new ones
|
|
events.length = 0;
|
|
|
|
// Now ask the LLM what the output was - it should be in context
|
|
agent.stdin!.write(
|
|
JSON.stringify({
|
|
type: "prompt",
|
|
message: `What was the exact output of the echo command I just ran? Reply with just the value, nothing else.`,
|
|
}) + "\n",
|
|
);
|
|
await waitForEvent("agent_end");
|
|
|
|
// Find the assistant's response
|
|
const messageEndEvents = events.filter((e) => e.type === "message_end") as AgentEvent[];
|
|
const assistantMessage = messageEndEvents.find(
|
|
(e) => e.type === "message_end" && (e as any).message?.role === "assistant",
|
|
) as any;
|
|
|
|
expect(assistantMessage).toBeDefined();
|
|
|
|
// The assistant should mention the unique value from the bash output
|
|
const textContent = assistantMessage.message.content.find((c: any) => c.type === "text");
|
|
expect(textContent?.text).toContain(uniqueValue);
|
|
|
|
agent.kill("SIGTERM");
|
|
}, 90000);
|
|
});
|