Files
oh-my-pi/packages/coding-agent/src/modes/rpc/rpc-client.ts
T
2026-02-10 07:39:39 +01:00

534 lines
15 KiB
TypeScript

/**
* RPC Client for programmatic access to the coding agent.
*
* Spawns the agent in RPC mode and provides a typed API for all operations.
*/
import type { AgentEvent, AgentMessage, ThinkingLevel } from "@oh-my-pi/pi-agent-core";
import type { ImageContent } from "@oh-my-pi/pi-ai";
import { ptree, readJsonl } from "@oh-my-pi/pi-utils";
import type { BashResult } from "../../exec/bash-executor";
import type { SessionStats } from "../../session/agent-session";
import type { CompactionResult } from "../../session/compaction";
import type { RpcCommand, RpcResponse, RpcSessionState } from "./rpc-types";
/** Distributive Omit that works with union types */
type DistributiveOmit<T, K extends keyof T> = T extends unknown ? Omit<T, K> : never;
/** RpcCommand without the id field (for internal send) */
type RpcCommandBody = DistributiveOmit<RpcCommand, "id">;
export interface RpcClientOptions {
/** Path to the CLI entry point (default: searches for dist/cli.js) */
cliPath?: string;
/** Working directory for the agent */
cwd?: string;
/** Environment variables */
env?: Record<string, string>;
/** Provider to use */
provider?: string;
/** Model ID to use */
model?: string;
/** Additional CLI arguments */
args?: string[];
}
export interface ModelInfo {
provider: string;
id: string;
contextWindow: number;
reasoning: boolean;
}
export type RpcEventListener = (event: AgentEvent) => void;
const agentEventTypes = new Set<AgentEvent["type"]>([
"agent_start",
"agent_end",
"turn_start",
"turn_end",
"message_start",
"message_update",
"message_end",
"tool_execution_start",
"tool_execution_update",
"tool_execution_end",
]);
function isRecord(value: unknown): value is Record<string, unknown> {
return typeof value === "object" && value !== null && !Array.isArray(value);
}
function isRpcResponse(value: unknown): value is RpcResponse {
if (!isRecord(value)) return false;
if (value.type !== "response") return false;
if (typeof value.command !== "string") return false;
if (typeof value.success !== "boolean") return false;
if (value.id !== undefined && typeof value.id !== "string") return false;
if (value.success === false) {
return typeof value.error === "string";
}
return true;
}
function isAgentEvent(value: unknown): value is AgentEvent {
if (!isRecord(value)) return false;
const type = value.type;
if (typeof type !== "string") return false;
return agentEventTypes.has(type as AgentEvent["type"]);
}
// ============================================================================
// RPC Client
// ============================================================================
export class RpcClient {
#process: ptree.ChildProcess | null = null;
#eventListeners: RpcEventListener[] = [];
#pendingRequests: Map<string, { resolve: (response: RpcResponse) => void; reject: (error: Error) => void }> =
new Map();
#requestId = 0;
#abortController = new AbortController();
constructor(private options: RpcClientOptions = {}) {}
/**
* Start the RPC agent process.
*/
async start(): Promise<void> {
if (this.#process) {
throw new Error("Client already started");
}
const cliPath = this.options.cliPath ?? "dist/cli.js";
const args = ["--mode", "rpc"];
if (this.options.provider) {
args.push("--provider", this.options.provider);
}
if (this.options.model) {
args.push("--model", this.options.model);
}
if (this.options.args) {
args.push(...this.options.args);
}
this.#process = ptree.spawn(["bun", cliPath, ...args], {
cwd: this.options.cwd,
env: { ...Bun.env, ...this.options.env },
stdin: "pipe",
});
// Process lines in background
const lines = readJsonl(this.#process.stdout, this.#abortController.signal);
void (async () => {
for await (const line of lines) {
this.#handleLine(line);
}
})().catch(() => {});
// Wait a moment for process to initialize
await Bun.sleep(100);
try {
const exitCode = await Promise.race([this.#process.exited, Bun.sleep(500).then(() => null)]);
if (exitCode !== null) {
throw new Error(
`Agent process exited immediately with code ${exitCode}. Stderr: ${this.#process.peekStderr()}`,
);
}
} catch {
// Process still running, which is what we want
}
}
/**
* Stop the RPC agent process.
*/
stop() {
if (!this.#process) return;
this.#process.kill();
this.#abortController.abort();
this.#process = null;
this.#pendingRequests.clear();
}
/**
* Subscribe to agent events.
*/
onEvent(listener: RpcEventListener): () => void {
this.#eventListeners.push(listener);
return () => {
const index = this.#eventListeners.indexOf(listener);
if (index !== -1) {
this.#eventListeners.splice(index, 1);
}
};
}
/**
* Get collected stderr output (useful for debugging).
*/
getStderr(): string {
return this.#process?.peekStderr() ?? "";
}
// =========================================================================
// Command Methods
// =========================================================================
/**
* Send a prompt to the agent.
* Returns immediately after sending; use onEvent() to receive streaming events.
* Use waitForIdle() to wait for completion.
*/
async prompt(message: string, images?: ImageContent[]): Promise<void> {
await this.#send({ type: "prompt", message, images });
}
/**
* Queue a steering message to interrupt the agent mid-run.
*/
async steer(message: string, images?: ImageContent[]): Promise<void> {
await this.#send({ type: "steer", message, images });
}
/**
* Queue a follow-up message to be processed after the agent finishes.
*/
async followUp(message: string, images?: ImageContent[]): Promise<void> {
await this.#send({ type: "follow_up", message, images });
}
/**
* Abort current operation.
*/
async abort(): Promise<void> {
await this.#send({ type: "abort" });
}
/**
* Start a new session, optionally with parent tracking.
* @param parentSession - Optional parent session path for lineage tracking
* @returns Object with `cancelled: true` if an extension cancelled the new session
*/
async newSession(parentSession?: string): Promise<{ cancelled: boolean }> {
const response = await this.#send({ type: "new_session", parentSession });
return this.#getData(response);
}
/**
* Get current session state.
*/
async getState(): Promise<RpcSessionState> {
const response = await this.#send({ type: "get_state" });
return this.#getData(response);
}
/**
* Set model by provider and ID.
*/
async setModel(provider: string, modelId: string): Promise<{ provider: string; id: string }> {
const response = await this.#send({ type: "set_model", provider, modelId });
return this.#getData(response);
}
/**
* Cycle to next model.
*/
async cycleModel(): Promise<{
model: { provider: string; id: string };
thinkingLevel: ThinkingLevel;
isScoped: boolean;
} | null> {
const response = await this.#send({ type: "cycle_model" });
return this.#getData(response);
}
/**
* Get list of available models.
*/
async getAvailableModels(): Promise<ModelInfo[]> {
const response = await this.#send({ type: "get_available_models" });
return this.#getData<{ models: ModelInfo[] }>(response).models;
}
/**
* Set thinking level.
*/
async setThinkingLevel(level: ThinkingLevel): Promise<void> {
await this.#send({ type: "set_thinking_level", level });
}
/**
* Cycle thinking level.
*/
async cycleThinkingLevel(): Promise<{ level: ThinkingLevel } | null> {
const response = await this.#send({ type: "cycle_thinking_level" });
return this.#getData(response);
}
/**
* Set steering mode.
*/
async setSteeringMode(mode: "all" | "one-at-a-time"): Promise<void> {
await this.#send({ type: "set_steering_mode", mode });
}
/**
* Set follow-up mode.
*/
async setFollowUpMode(mode: "all" | "one-at-a-time"): Promise<void> {
await this.#send({ type: "set_follow_up_mode", mode });
}
/**
* Compact session context.
*/
async compact(customInstructions?: string): Promise<CompactionResult> {
const response = await this.#send({ type: "compact", customInstructions });
return this.#getData(response);
}
/**
* Set auto-compaction enabled/disabled.
*/
async setAutoCompaction(enabled: boolean): Promise<void> {
await this.#send({ type: "set_auto_compaction", enabled });
}
/**
* Set auto-retry enabled/disabled.
*/
async setAutoRetry(enabled: boolean): Promise<void> {
await this.#send({ type: "set_auto_retry", enabled });
}
/**
* Abort in-progress retry.
*/
async abortRetry(): Promise<void> {
await this.#send({ type: "abort_retry" });
}
/**
* Execute a bash command.
*/
async bash(command: string): Promise<BashResult> {
const response = await this.#send({ type: "bash", command });
return this.#getData(response);
}
/**
* Abort running bash command.
*/
async abortBash(): Promise<void> {
await this.#send({ type: "abort_bash" });
}
/**
* Get session statistics.
*/
async getSessionStats(): Promise<SessionStats> {
const response = await this.#send({ type: "get_session_stats" });
return this.#getData(response);
}
/**
* Export session to HTML.
*/
async exportHtml(outputPath?: string): Promise<{ path: string }> {
const response = await this.#send({ type: "export_html", outputPath });
return this.#getData(response);
}
/**
* Switch to a different session file.
* @returns Object with `cancelled: true` if an extension cancelled the switch
*/
async switchSession(sessionPath: string): Promise<{ cancelled: boolean }> {
const response = await this.#send({ type: "switch_session", sessionPath });
return this.#getData(response);
}
/**
* Branch from a specific message.
* @returns Object with `text` (the message text) and `cancelled` (if extension cancelled)
*/
async branch(entryId: string): Promise<{ text: string; cancelled: boolean }> {
const response = await this.#send({ type: "branch", entryId });
return this.#getData(response);
}
/**
* Get messages available for branching.
*/
async getBranchMessages(): Promise<Array<{ entryId: string; text: string }>> {
const response = await this.#send({ type: "get_branch_messages" });
return this.#getData<{ messages: Array<{ entryId: string; text: string }> }>(response).messages;
}
/**
* Get text of last assistant message.
*/
async getLastAssistantText(): Promise<string | null> {
const response = await this.#send({ type: "get_last_assistant_text" });
return this.#getData<{ text: string | null }>(response).text;
}
/**
* Get all messages in the session.
*/
async getMessages(): Promise<AgentMessage[]> {
const response = await this.#send({ type: "get_messages" });
return this.#getData<{ messages: AgentMessage[] }>(response).messages;
}
// =========================================================================
// Helpers
// =========================================================================
/**
* Wait for agent to become idle (no streaming).
* Resolves when agent_end event is received.
*/
waitForIdle(timeout = 60000): Promise<void> {
const { promise, resolve, reject } = Promise.withResolvers<void>();
let settled = false;
const unsubscribe = this.onEvent(event => {
if (event.type === "agent_end") {
settled = true;
unsubscribe();
resolve();
}
});
void (async () => {
await Bun.sleep(timeout);
if (settled) return;
settled = true;
unsubscribe();
reject(new Error(`Timeout waiting for agent to become idle. Stderr: ${this.#process?.peekStderr() ?? ""}`));
})();
return promise;
}
/**
* Collect events until agent becomes idle.
*/
collectEvents(timeout = 60000): Promise<AgentEvent[]> {
const { promise, resolve, reject } = Promise.withResolvers<AgentEvent[]>();
const events: AgentEvent[] = [];
let settled = false;
const unsubscribe = this.onEvent(event => {
events.push(event);
if (event.type === "agent_end") {
settled = true;
unsubscribe();
resolve(events);
}
});
void (async () => {
await Bun.sleep(timeout);
if (settled) return;
settled = true;
unsubscribe();
reject(new Error(`Timeout collecting events. Stderr: ${this.#process?.peekStderr() ?? ""}`));
})();
return promise;
}
/**
* Send prompt and wait for completion, returning all events.
*/
async promptAndWait(message: string, images?: ImageContent[], timeout = 60000): Promise<AgentEvent[]> {
const eventsPromise = this.collectEvents(timeout);
await this.prompt(message, images);
return eventsPromise;
}
// =========================================================================
// Internal
// =========================================================================
#handleLine(data: unknown): void {
// Check if it's a response to a pending request
if (isRpcResponse(data)) {
const id = data.id;
if (id && this.#pendingRequests.has(id)) {
const pending = this.#pendingRequests.get(id)!;
this.#pendingRequests.delete(id);
pending.resolve(data);
return;
}
}
if (!isAgentEvent(data)) return;
// Otherwise it's an event
for (const listener of this.#eventListeners) {
listener(data);
}
}
#send(command: RpcCommandBody): Promise<RpcResponse> {
if (!this.#process?.stdin) {
throw new Error("Client not started");
}
const id = `req_${++this.#requestId}`;
const fullCommand = { ...command, id } as RpcCommand;
const { promise, resolve, reject } = Promise.withResolvers<RpcResponse>();
let settled = false;
void (async () => {
await Bun.sleep(30000);
if (settled) return;
this.#pendingRequests.delete(id);
settled = true;
reject(
new Error(`Timeout waiting for response to ${command.type}. Stderr: ${this.#process?.peekStderr() ?? ""}`),
);
})();
this.#pendingRequests.set(id, {
resolve: response => {
if (settled) return;
settled = true;
resolve(response);
},
reject: error => {
if (settled) return;
settled = true;
reject(error);
},
});
// Write to stdin after registering the handler
const stdin = this.#process!.stdin as import("bun").FileSink;
stdin.write(`${JSON.stringify(fullCommand)}\n`);
// flush() returns number | Promise<number> - handle both cases
const flushResult = stdin.flush();
if (flushResult instanceof Promise) {
flushResult.catch((err: Error) => {
this.#pendingRequests.delete(id);
if (settled) return;
settled = true;
reject(err);
});
}
return promise;
}
#getData<T>(response: RpcResponse): T {
if (!response.success) {
const errorResponse = response as Extract<RpcResponse, { success: false }>;
throw new Error(errorResponse.error);
}
// Type assertion: we trust response.data matches T based on the command sent.
// This is safe because each public method specifies the correct T for its command.
const successResponse = response as Extract<RpcResponse, { success: true; data: unknown }>;
return successResponse.data as T;
}
}