@oh-my-pi/pi-coding-agent 16.1.13 → 16.1.14

package/src/eval/rb/executor.ts

@@ -0,0 +1,504 @@
+import * as fs from "node:fs";
+import * as path from "node:path";
+
+import { getProjectDir, logger } from "@oh-my-pi/pi-utils";
+import type { ToolSession } from "../../tools";
+import {
+	attachSessionOwner,
+	buildManagedKernelEnv,
+	buildManagedKernelEnvPatch,
+	createCancelledKernelResult,
+	executeWithKernelBase,
+	getExecutionDeadlineMs,
+	getRemainingTimeoutMs,
+	isCancellationError,
+	isTimedOutCancellation,
+	waitForPromiseWithCancellation,
+} from "../executor-base";
+import type { JsStatusEvent } from "../js/shared/types";
+import { ensurePyToolBridge } from "../py/tool-bridge";
+import {
+	checkRubyKernelAvailability,
+	type KernelDisplayOutput,
+	type KernelExecuteOptions,
+	type KernelExecuteResult,
+	RubyKernel,
+} from "./kernel";
+import { resolveExplicitRubyRuntime } from "./runtime";
+
+export interface RubyExecutorOptions {
+	/** Working directory for command execution */
+	cwd?: string;
+	/** Timeout in milliseconds */
+	timeoutMs?: number;
+	/** Absolute wall-clock deadline in milliseconds since epoch */
+	deadlineMs?: number;
+	/**
+	 * Runtime-work budget (ms). Used only for timeout-annotation text when the
+	 * caller drives cancellation via the eval watchdog `signal`. Does not arm a timer.
+	 */
+	idleTimeoutMs?: number;
+	/** Callback for streaming output chunks (already sanitized) */
+	onChunk?: (chunk: string) => Promise<void> | void;
+	/** AbortSignal for cancellation */
+	signal?: AbortSignal;
+	/** Session identifier for kernel reuse */
+	sessionId?: string;
+	/** Logical owner identifier for retained kernel cleanup */
+	kernelOwnerId?: string;
+	/** Explicit interpreter path (`ruby.interpreter`). Skips discovery when set. */
+	interpreter?: string;
+	/** Restart the kernel before executing */
+	reset?: boolean;
+	/** Session file path for accessing task outputs */
+	sessionFile?: string;
+	/** Effective artifacts directory for the current session. */
+	artifactsDir?: string;
+	/** Artifact path/id for full output storage */
+	artifactPath?: string;
+	artifactId?: string;
+	/**
+	 * On-disk roots the prelude helpers substitute for internal-URL schemes
+	 * (e.g. `{ local: "/…/artifacts/local" }`). Exported to the kernel as
+	 * `PI_EVAL_LOCAL_ROOTS` (JSON).
+	 */
+	localRoots?: Record<string, string>;
+	/**
+	 * ToolSession used to resolve host-side `tool.<name>(args)` calls. When
+	 * omitted, the bridge env vars are not injected and `tool.foo(...)` raises.
+	 */
+	toolSession?: ToolSession;
+	/** Callback for status events emitted by tool bridge invocations. */
+	emitStatus?: (event: JsStatusEvent) => void;
+	/** Live status events streamed as they are emitted. */
+	onStatus?: (event: JsStatusEvent) => void;
+	/** @internal Bridge session id, set by `executeRuby` before delegating. */
+	bridgeSessionId?: string;
+	/** @internal Bridge endpoint info, set by `executeRuby` before delegating. */
+	bridge?: { url: string; token: string };
+}
+
+export interface RubyKernelExecutor {
+	execute: (code: string, options?: KernelExecuteOptions) => Promise<KernelExecuteResult>;
+}
+
+export interface RubyResult {
+	output: string;
+	exitCode: number | undefined;
+	cancelled: boolean;
+	truncated: boolean;
+	artifactId?: string;
+	totalLines: number;
+	totalBytes: number;
+	outputLines: number;
+	outputBytes: number;
+	displayOutputs: KernelDisplayOutput[];
+	stdinRequested: boolean;
+}
+
+// ---------------------------------------------------------------------------
+// Session bookkeeping
+//
+// One RubyKernel subprocess per (session id, cwd, interpreter) tuple. The
+// runner mutates process-global cwd/$LOAD_PATH/ENV during execution, so
+// cross-directory work must never share a live kernel. Multiple agent owners can
+// register against the same tuple; the kernel stays alive until the last owner detaches.
+// ---------------------------------------------------------------------------
+
+interface RubySessionOwners {
+	ownerIds: Set<string>;
+	hasFallbackOwner: boolean;
+}
+
+interface RubySession extends RubySessionOwners {
+	sessionKey: string;
+	sessionId: string;
+	cwd: string;
+	kernel: RubyKernel;
+}
+
+interface StartingRubySession extends RubySessionOwners {
+	promise: Promise<RubySession>;
+}
+
+const sessions = new Map<string, RubySession>();
+const startingSessions = new Map<string, StartingRubySession>();
+const resettingSessions = new Map<string, Promise<void>>();
+
+function normalizeSessionCwd(cwd: string): string {
+	return path.resolve(cwd);
+}
+
+function normalizeExplicitInterpreter(cwd: string, interpreter: string | undefined): string {
+	if (interpreter === undefined) return "";
+	const resolved = resolveExplicitRubyRuntime(interpreter, cwd, {}).rubyPath;
+	try {
+		return fs.realpathSync.native(resolved);
+	} catch {
+		return resolved;
+	}
+}
+
+function buildSessionKey(sessionId: string, cwd: string, interpreter: string | undefined): string {
+	const normalizedCwd = normalizeSessionCwd(cwd);
+	return `${sessionId}\0${normalizedCwd}\0${normalizeExplicitInterpreter(normalizedCwd, interpreter)}`;
+}
+
+// ---------------------------------------------------------------------------
+// Cancellation plumbing
+// ---------------------------------------------------------------------------
+
+class RubyExecutionCancelledError extends Error {
+	readonly timedOut: boolean;
+
+	constructor(timedOut: boolean) {
+		super(timedOut ? "Command timed out" : "Command aborted");
+		this.name = timedOut ? "TimeoutError" : "AbortError";
+		this.timedOut = timedOut;
+	}
+}
+
+function requireRemainingTimeoutMs(deadlineMs?: number): number | undefined {
+	const remainingMs = getRemainingTimeoutMs(deadlineMs);
+	if (remainingMs === undefined) return undefined;
+	if (remainingMs <= 0) {
+		throw new RubyExecutionCancelledError(true);
+	}
+	return remainingMs;
+}
+
+// ---------------------------------------------------------------------------
+// Result formatting
+// ---------------------------------------------------------------------------
+
+function formatTimeoutAnnotation(timeoutMs?: number): string | undefined {
+	if (timeoutMs === undefined) return "Command timed out";
+	const secs = Math.max(1, Math.round(timeoutMs / 1000));
+	return `Command timed out after ${secs} seconds`;
+}
+
+function formatKernelTimeoutAnnotation(timeoutMs: number | undefined, kernelKilled: boolean): string {
+	const secs = timeoutMs === undefined ? undefined : Math.max(1, Math.round(timeoutMs / 1000));
+	if (kernelKilled) {
+		return "eval cell timed out and the kernel was unresponsive to interrupt; the kernel has been killed and will be recreated on the next call.";
+	}
+	const duration = secs === undefined ? "the configured timeout" : `${secs}s`;
+	return `eval cell timed out after ${duration}; kernel interrupted but remains running. Reset the kernel via { reset: true } if state appears corrupted.`;
+}
+
+function createCancelledRubyResult(timedOut: boolean, timeoutMs?: number): RubyResult {
+	const output = timedOut ? (formatTimeoutAnnotation(timeoutMs) ?? "Command timed out") : "";
+	return createCancelledKernelResult(output);
+}
+
+// ---------------------------------------------------------------------------
+// Kernel start helpers
+// ---------------------------------------------------------------------------
+
+async function startKernel(cwd: string, options: RubyExecutorOptions): Promise<RubyKernel> {
+	requireRemainingTimeoutMs(options.deadlineMs);
+	return await RubyKernel.start({
+		cwd,
+		env: buildManagedKernelEnv(options),
+		signal: options.signal,
+		deadlineMs: options.deadlineMs,
+		interpreter: options.interpreter,
+	});
+}
+
+async function acquireSession(
+	sessionKey: string,
+	sessionId: string,
+	cwd: string,
+	options: RubyExecutorOptions,
+): Promise<RubySession> {
+	const existing = sessions.get(sessionKey);
+	if (existing) {
+		attachSessionOwner(existing, sessionId, options.kernelOwnerId);
+		return existing;
+	}
+	const starting = startingSessions.get(sessionKey);
+	if (starting) {
+		attachSessionOwner(starting, sessionId, options.kernelOwnerId);
+		return await starting.promise;
+	}
+	let startingSession!: StartingRubySession;
+	const startup = (async () => {
+		const kernel = await startKernel(cwd, options);
+		const session: RubySession = {
+			sessionKey,
+			sessionId,
+			cwd,
+			kernel,
+			ownerIds: new Set(startingSession.ownerIds),
+			hasFallbackOwner: startingSession.hasFallbackOwner,
+		};
+		if (startingSessions.get(sessionKey) === startingSession) {
+			sessions.set(sessionKey, session);
+		}
+		return session;
+	})();
+	startingSession = {
+		ownerIds: new Set(),
+		hasFallbackOwner: false,
+		promise: startup,
+	};
+	attachSessionOwner(startingSession, sessionId, options.kernelOwnerId);
+	startingSessions.set(sessionKey, startingSession);
+	try {
+		return await startup;
+	} finally {
+		if (startingSessions.get(sessionKey) === startingSession) startingSessions.delete(sessionKey);
+	}
+}
+
+async function replaceSessionKernel(session: RubySession, cwd: string, options: RubyExecutorOptions): Promise<void> {
+	const old = session.kernel;
+	const remaining = getRemainingTimeoutMs(options.deadlineMs);
+	await old
+		.shutdown(remaining !== undefined ? { timeoutMs: Math.max(0, remaining) } : undefined)
+		.catch(() => undefined);
+	if (sessions.get(session.sessionKey) !== session) {
+		throw new RubyExecutionCancelledError(false);
+	}
+	requireRemainingTimeoutMs(options.deadlineMs);
+	const next = await startKernel(cwd, options);
+	if (sessions.get(session.sessionKey) !== session) {
+		await next.shutdown().catch(() => undefined);
+		throw new RubyExecutionCancelledError(false);
+	}
+	session.kernel = next;
+}
+
+async function resetSession(sessionKey: string): Promise<void> {
+	const existing =
+		sessions.get(sessionKey) ?? (await startingSessions.get(sessionKey)?.promise.catch(() => undefined));
+	if (!existing) return;
+	sessions.delete(sessionKey);
+	await existing.kernel.shutdown().catch(() => undefined);
+}
+
+// ---------------------------------------------------------------------------
+// Public dispose entry points
+// ---------------------------------------------------------------------------
+
+export async function disposeAllRubyKernelSessions(): Promise<void> {
+	const pending = [...startingSessions.values()].map(starting => starting.promise);
+	startingSessions.clear();
+	const started = await Promise.allSettled(pending);
+	const all = [...sessions.entries()];
+	for (const result of started) {
+		if (result.status !== "fulfilled") continue;
+		if (!all.some(([, session]) => session === result.value)) {
+			all.push([result.value.sessionKey, result.value]);
+		}
+	}
+	for (const [id, session] of all) {
+		if (sessions.get(id) === session) sessions.delete(id);
+	}
+	const results = await Promise.allSettled(all.map(([, session]) => session.kernel.shutdown()));
+	for (let i = 0; i < all.length; i += 1) {
+		const [id, session] = all[i];
+		const result = results[i];
+		if (result.status === "fulfilled" && result.value?.confirmed !== false) continue;
+		const reason = result.status === "rejected" ? result.reason : "not confirmed";
+		logger.warn("Ruby kernel shutdown not confirmed", {
+			sessionId: session.sessionId,
+			sessionKey: id,
+			cwd: session.cwd,
+			reason,
+		});
+		if (!sessions.has(id)) sessions.set(id, session);
+	}
+}
+
+export async function disposeRubyKernelSessionsByOwner(ownerId: string): Promise<void> {
+	const toShutdown: RubySession[] = [];
+	const startingToShutdown: StartingRubySession[] = [];
+	for (const session of [...sessions.values()]) {
+		if (!session.ownerIds.has(ownerId)) continue;
+		if (session.ownerIds.size === 1) {
+			toShutdown.push(session);
+			continue;
+		}
+		session.ownerIds.delete(ownerId);
+	}
+	for (const [sessionKey, starting] of [...startingSessions.entries()]) {
+		if (sessions.has(sessionKey) || !starting.ownerIds.has(ownerId)) continue;
+		if (starting.ownerIds.size === 1) {
+			startingSessions.delete(sessionKey);
+			startingToShutdown.push(starting);
+			continue;
+		}
+		starting.ownerIds.delete(ownerId);
+	}
+	for (const session of toShutdown) {
+		if (sessions.get(session.sessionKey) === session) sessions.delete(session.sessionKey);
+	}
+	const started = await Promise.allSettled(startingToShutdown.map(starting => starting.promise));
+	for (const result of started) {
+		if (result.status !== "fulfilled") continue;
+		const session = result.value;
+		if (sessions.get(session.sessionKey) === session) sessions.delete(session.sessionKey);
+		toShutdown.push(session);
+	}
+	const results = await Promise.allSettled(toShutdown.map(session => session.kernel.shutdown()));
+	for (let i = 0; i < toShutdown.length; i += 1) {
+		const session = toShutdown[i];
+		const result = results[i];
+		if (result.status === "fulfilled" && result.value?.confirmed !== false) {
+			session.ownerIds.delete(ownerId);
+			continue;
+		}
+		const reason = result.status === "rejected" ? result.reason : "not confirmed";
+		logger.warn("Ruby kernel shutdown not confirmed", {
+			sessionId: session.sessionId,
+			sessionKey: session.sessionKey,
+			cwd: session.cwd,
+			reason,
+		});
+		if (!sessions.has(session.sessionKey)) sessions.set(session.sessionKey, session);
+	}
+}
+
+// ---------------------------------------------------------------------------
+// Execution
+// ---------------------------------------------------------------------------
+
+async function executeWithKernel(
+	kernel: RubyKernelExecutor,
+	code: string,
+	options: RubyExecutorOptions | undefined,
+): Promise<RubyResult> {
+	return executeWithKernelBase<RubyExecutorOptions>({
+		kernel,
+		code,
+		options,
+		runIdPrefix: "rb",
+		errorLogLabel: "Ruby",
+		cancelledErrorClass: RubyExecutionCancelledError,
+		buildKernelEnvPatch: buildManagedKernelEnvPatch,
+		formatKernelTimeoutAnnotation,
+		formatTimeoutAnnotation,
+	});
+}
+
+async function ensureKernelAvailable(cwd: string, options: RubyExecutorOptions): Promise<void> {
+	const availability = await waitForPromiseWithCancellation(
+		checkRubyKernelAvailability(cwd, options.interpreter),
+		options,
+		RubyExecutionCancelledError,
+	);
+	if (!availability.ok) {
+		throw new Error(availability.reason ?? "Ruby kernel unavailable");
+	}
+}
+
+async function ensureToolBridge(options: RubyExecutorOptions): Promise<void> {
+	if (!options.toolSession || options.bridge) return;
+	try {
+		options.bridge = await ensurePyToolBridge();
+	} catch (err) {
+		logger.warn("Failed to start Ruby tool bridge", {
+			error: err instanceof Error ? err.message : String(err),
+		});
+	}
+}
+
+async function executeOnSession(code: string, cwd: string, options: RubyExecutorOptions): Promise<RubyResult> {
+	const sessionId = options.sessionId ?? `session:${cwd}`;
+	const sessionKey = buildSessionKey(sessionId, cwd, options.interpreter);
+	if (options.bridge && !options.bridgeSessionId) {
+		options.bridgeSessionId = sessionId;
+	}
+	if (options.reset) {
+		const inFlight = resettingSessions.get(sessionKey);
+		if (inFlight) await inFlight.catch(() => undefined);
+		else {
+			const resetPromise = resetSession(sessionKey);
+			resettingSessions.set(
+				sessionKey,
+				resetPromise.then(() => undefined),
+			);
+			try {
+				await resetPromise;
+			} finally {
+				resettingSessions.delete(sessionKey);
+			}
+		}
+	} else {
+		const inFlight = resettingSessions.get(sessionKey);
+		if (inFlight) await inFlight.catch(() => undefined);
+	}
+	const session = await acquireSession(sessionKey, sessionId, cwd, options);
+	if (options.signal?.aborted) {
+		throw new RubyExecutionCancelledError(
+			isTimedOutCancellation(options.signal.reason, RubyExecutionCancelledError, options.signal),
+		);
+	}
+	if (sessions.get(session.sessionKey) !== session) {
+		throw new RubyExecutionCancelledError(false);
+	}
+	if (!session.kernel.isAlive()) {
+		await replaceSessionKernel(session, cwd, options);
+		if (sessions.get(session.sessionKey) !== session) {
+			throw new RubyExecutionCancelledError(false);
+		}
+	}
+	const runOptions = { ...options, cwd };
+	try {
+		return await executeWithKernel(session.kernel, code, runOptions);
+	} catch (err) {
+		if (isCancellationError(err, RubyExecutionCancelledError) || options.signal?.aborted) throw err;
+		if (session.kernel.isAlive()) throw err;
+		if (sessions.get(session.sessionKey) !== session) {
+			throw new RubyExecutionCancelledError(false);
+		}
+		await replaceSessionKernel(session, cwd, options);
+		if (sessions.get(session.sessionKey) !== session) {
+			throw new RubyExecutionCancelledError(false);
+		}
+		return await executeWithKernel(session.kernel, code, runOptions);
+	}
+}
+
+export async function executeRubyWithKernel(
+	kernel: RubyKernelExecutor,
+	code: string,
+	options?: RubyExecutorOptions,
+): Promise<RubyResult> {
+	return await executeWithKernel(kernel, code, options);
+}
+
+export async function executeRuby(code: string, options?: RubyExecutorOptions): Promise<RubyResult> {
+	const cwd = normalizeSessionCwd(options?.cwd ?? getProjectDir());
+	const deadlineMs = getExecutionDeadlineMs(options);
+	const executionOptions: RubyExecutorOptions = {
+		...(options ?? {}),
+		cwd,
+		deadlineMs,
+	};
+
+	try {
+		requireRemainingTimeoutMs(deadlineMs);
+		if (executionOptions.signal?.aborted) {
+			throw new RubyExecutionCancelledError(
+				isTimedOutCancellation(
+					executionOptions.signal.reason,
+					RubyExecutionCancelledError,
+					executionOptions.signal,
+				),
+			);
+		}
+		await ensureKernelAvailable(cwd, executionOptions);
+		await ensureToolBridge(executionOptions);
+		return await executeOnSession(code, cwd, executionOptions);
+	} catch (err) {
+		if (isCancellationError(err, RubyExecutionCancelledError) || executionOptions.signal?.aborted) {
+			return createCancelledRubyResult(
+				isTimedOutCancellation(err, RubyExecutionCancelledError, executionOptions.signal),
+			);
+		}
+		throw err;
+	}
+}

package/src/eval/rb/index.ts

@@ -0,0 +1,54 @@
+import type { ToolSession } from "../../tools";
+import {
+	type ExecutorBackend,
+	type ExecutorBackendExecOptions,
+	type ExecutorBackendResult,
+	resolveEvalUrlRoots,
+} from "../backend";
+import {
+	namespaceSessionId as sharedNamespace,
+	readInterpreterSetting as sharedReadInterpreterSetting,
+	toExecutorBackendResult,
+} from "../backend-helpers";
+import { executeRuby } from "./executor";
+import { checkRubyKernelAvailability } from "./kernel";
+
+const RUBY_SESSION_PREFIX = "ruby:";
+
+export function namespaceSessionId(sessionId: string): string {
+	return sharedNamespace(sessionId, RUBY_SESSION_PREFIX);
+}
+
+function readInterpreterSetting(session: ToolSession): string | undefined {
+	return sharedReadInterpreterSetting(session, "ruby.interpreter");
+}
+
+export default {
+	id: "ruby",
+	label: "Ruby",
+	highlightLang: "ruby",
+
+	async isAvailable(session: ToolSession): Promise<boolean> {
+		const availability = await checkRubyKernelAvailability(session.cwd, readInterpreterSetting(session));
+		return availability.ok;
+	},
+
+	async execute(code: string, opts: ExecutorBackendExecOptions): Promise<ExecutorBackendResult> {
+		const result = await executeRuby(code, {
+			cwd: opts.cwd,
+			idleTimeoutMs: opts.idleTimeoutMs,
+			signal: opts.signal,
+			sessionId: namespaceSessionId(opts.sessionId),
+			interpreter: readInterpreterSetting(opts.session),
+			sessionFile: opts.sessionFile,
+			artifactsDir: opts.session.getArtifactsDir?.() ?? undefined,
+			localRoots: resolveEvalUrlRoots(opts.session),
+			kernelOwnerId: opts.kernelOwnerId,
+			reset: opts.reset,
+			onChunk: opts.onChunk,
+			onStatus: opts.onStatus,
+			toolSession: opts.session,
+		});
+		return toExecutorBackendResult(result);
+	},
+} satisfies ExecutorBackend;