467 lines
18 KiB
TypeScript
467 lines
18 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2025 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
import { Content, SchemaUnion, Type } from '@google/genai';
|
|
import { getErrorMessage, isNodeError } from '../utils/errors.js';
|
|
import { GeminiClient } from '../core/client.js';
|
|
import { Config } from '../config/config.js';
|
|
import { promises as fs } from 'fs';
|
|
import { exec as _exec } from 'child_process';
|
|
import { promisify } from 'util';
|
|
|
|
// Define the AnalysisStatus type alias
|
|
type AnalysisStatus =
|
|
| 'Running'
|
|
| 'SuccessReported'
|
|
| 'ErrorReported'
|
|
| 'Unknown'
|
|
| 'AnalysisFailed';
|
|
|
|
// Promisify child_process.exec for easier async/await usage
|
|
const execAsync = promisify(_exec);
|
|
|
|
// Define the expected interface for the AI client dependency
|
|
export interface AiClient {
|
|
generateJson(
|
|
prompt: Content[], // Keep flexible or define a stricter prompt structure type
|
|
schema: SchemaUnion,
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
): Promise<any>; // Ideally, specify the expected JSON structure TAnalysisResult | TAnalysisFailure
|
|
}
|
|
|
|
// Identifier for the background process (e.g., PID)
|
|
// Using `unknown` allows more flexibility than `object` while still being type-safe
|
|
export type ProcessHandle = number | string | unknown;
|
|
|
|
// Represents the structure expected from a successful LLM analysis call
|
|
export interface AnalysisResult {
|
|
summary: string;
|
|
inferredStatus: 'Running' | 'SuccessReported' | 'ErrorReported' | 'Unknown';
|
|
}
|
|
|
|
// Represents the structure returned when the LLM analysis itself fails
|
|
export interface AnalysisFailure {
|
|
error: string;
|
|
inferredStatus: 'AnalysisFailed';
|
|
}
|
|
|
|
// Type guard to check if the result is a failure object
|
|
function isAnalysisFailure(
|
|
result: AnalysisResult | AnalysisFailure,
|
|
): result is AnalysisFailure {
|
|
return (result as AnalysisFailure).inferredStatus === 'AnalysisFailed';
|
|
}
|
|
|
|
// Represents the final outcome after polling is complete (or failed/timed out)
|
|
export interface FinalAnalysisOutcome {
|
|
status: string; // e.g., 'Completed_SuccessReported', 'TimedOut_Running', 'AnalysisFailed'
|
|
summary: string; // Final summary or error message
|
|
}
|
|
|
|
export class BackgroundTerminalAnalyzer {
|
|
private geminiClient: GeminiClient | null = null;
|
|
private readonly maxOutputAnalysisLength = 20000;
|
|
private pollIntervalMs: number;
|
|
private maxAttempts: number;
|
|
private initialDelayMs: number;
|
|
|
|
constructor(
|
|
config: Config, // Accept Config object
|
|
options: {
|
|
pollIntervalMs?: number;
|
|
maxAttempts?: number;
|
|
initialDelayMs?: number;
|
|
} = {},
|
|
) {
|
|
try {
|
|
// Initialize Gemini client using config
|
|
this.geminiClient = new GeminiClient(config);
|
|
} catch (error) {
|
|
console.error(
|
|
'Failed to initialize GeminiClient in BackgroundTerminalAnalyzer:',
|
|
error,
|
|
);
|
|
// Set client to null so analyzeOutput handles it
|
|
this.geminiClient = null;
|
|
}
|
|
this.pollIntervalMs = options.pollIntervalMs ?? 5000; // Default 5 seconds
|
|
this.maxAttempts = options.maxAttempts ?? 6; // Default 6 attempts (approx 30s total)
|
|
this.initialDelayMs = options.initialDelayMs ?? 500; // Default 0.5s initial delay
|
|
}
|
|
|
|
/**
|
|
* Polls the output of a background process using an LLM
|
|
* until a conclusive status is determined or timeout occurs.
|
|
* @param pid The handle/identifier of the background process (typically PID number).
|
|
* @param tempStdoutFilePath Path to the temporary file capturing stdout.
|
|
* @param tempStderrFilePath Path to the temporary file capturing stderr.
|
|
* @param command The command string that was executed (for context in prompts).
|
|
* @returns A promise resolving to the final analysis outcome.
|
|
*/
|
|
async analyze(
|
|
pid: ProcessHandle,
|
|
tempStdoutFilePath: string,
|
|
tempStderrFilePath: string,
|
|
command: string,
|
|
): Promise<FinalAnalysisOutcome> {
|
|
// --- Validate PID ---
|
|
if (typeof pid !== 'number' || !Number.isInteger(pid) || pid <= 0) {
|
|
console.error(
|
|
`BackgroundTerminalAnalyzer: Invalid or non-numeric PID provided (${pid}). Analysis cannot proceed.`,
|
|
);
|
|
return {
|
|
status: 'AnalysisFailed',
|
|
summary: 'Invalid PID provided for analysis.',
|
|
};
|
|
}
|
|
|
|
// --- Initial Delay ---
|
|
// Wait briefly before the first check to allow the process to initialize
|
|
// and potentially write initial output.
|
|
await new Promise((resolve) => setTimeout(resolve, this.initialDelayMs));
|
|
|
|
let attempts = 0;
|
|
let lastAnalysisResult: AnalysisResult | AnalysisFailure | null = null;
|
|
|
|
while (attempts < this.maxAttempts) {
|
|
attempts++;
|
|
let currentStdout = '';
|
|
let currentStderr = '';
|
|
|
|
// --- Robust File Reading ---
|
|
try {
|
|
currentStdout = await fs.readFile(tempStdoutFilePath, 'utf-8');
|
|
} catch (error: unknown) {
|
|
// If file doesn't exist yet or isn't readable, treat as empty, but log warning
|
|
if (!isNodeError(error) || error.code !== 'ENOENT') {
|
|
console.warn(
|
|
`Attempt ${attempts}: Failed to read stdout file ${tempStdoutFilePath}: ${getErrorMessage(error)}`,
|
|
);
|
|
}
|
|
}
|
|
try {
|
|
currentStderr = await fs.readFile(tempStderrFilePath, 'utf-8');
|
|
} catch (error: unknown) {
|
|
if (!isNodeError(error) || error.code !== 'ENOENT') {
|
|
console.warn(
|
|
`Attempt ${attempts}: Failed to read stderr file ${tempStderrFilePath}: ${getErrorMessage(error)}`,
|
|
);
|
|
}
|
|
}
|
|
|
|
// --- Process Status Check ---
|
|
let isRunning = false;
|
|
try {
|
|
// Check if process is running *before* the final analysis if it seems to have ended
|
|
isRunning = await this.isProcessRunning(pid);
|
|
if (!isRunning) {
|
|
// Reread files one last time in case output was written just before exit
|
|
try {
|
|
currentStdout = await fs.readFile(tempStdoutFilePath, 'utf-8');
|
|
} catch {
|
|
/* ignore */
|
|
}
|
|
try {
|
|
currentStderr = await fs.readFile(tempStderrFilePath, 'utf-8');
|
|
} catch {
|
|
/* ignore */
|
|
}
|
|
|
|
lastAnalysisResult = await this.performLlmAnalysis(
|
|
currentStdout,
|
|
currentStderr,
|
|
command,
|
|
pid,
|
|
);
|
|
|
|
if (isAnalysisFailure(lastAnalysisResult)) {
|
|
return {
|
|
status: 'Completed_AnalysisFailed',
|
|
summary: `Process ended. Final analysis failed: ${lastAnalysisResult.error}`,
|
|
};
|
|
}
|
|
// Append ProcessEnded to the status determined by the final analysis
|
|
return {
|
|
status: 'Completed_' + lastAnalysisResult.inferredStatus,
|
|
summary: `Process ended. Final analysis summary: ${lastAnalysisResult.summary}`,
|
|
};
|
|
}
|
|
} catch (procCheckError: unknown) {
|
|
// Log the error but allow polling to continue, as log analysis might still be useful
|
|
console.warn(
|
|
`Could not check process status for PID ${pid} on attempt ${attempts}: ${getErrorMessage(procCheckError)}`,
|
|
);
|
|
// Decide if you want to bail out here or continue analysis based on logs only
|
|
// For now, we continue.
|
|
}
|
|
|
|
// --- LLM Analysis ---
|
|
lastAnalysisResult = await this.performLlmAnalysis(
|
|
currentStdout,
|
|
currentStderr,
|
|
command,
|
|
pid,
|
|
);
|
|
|
|
if (isAnalysisFailure(lastAnalysisResult)) {
|
|
console.error(
|
|
`LLM Analysis failed for PID ${pid} on attempt ${attempts}:`,
|
|
lastAnalysisResult.error,
|
|
);
|
|
// Stop polling on analysis failure, returning the specific failure status
|
|
return {
|
|
status: lastAnalysisResult.inferredStatus,
|
|
summary: lastAnalysisResult.error,
|
|
};
|
|
}
|
|
|
|
// --- Exit Conditions ---
|
|
if (
|
|
lastAnalysisResult.inferredStatus === 'SuccessReported' ||
|
|
lastAnalysisResult.inferredStatus === 'ErrorReported'
|
|
) {
|
|
return {
|
|
status: lastAnalysisResult.inferredStatus,
|
|
summary: lastAnalysisResult.summary,
|
|
};
|
|
}
|
|
|
|
// Heuristic: If the process seems stable and 'Running' after several checks,
|
|
// return that status without waiting for the full timeout. Adjust threshold as needed.
|
|
const runningExitThreshold = Math.floor(this.maxAttempts / 3) + 1; // e.g., exit after attempt 4 if maxAttempts is 6
|
|
if (
|
|
attempts >= runningExitThreshold &&
|
|
lastAnalysisResult.inferredStatus === 'Running'
|
|
) {
|
|
return {
|
|
status: lastAnalysisResult.inferredStatus,
|
|
summary: lastAnalysisResult.summary,
|
|
};
|
|
}
|
|
|
|
// --- Wait before next poll ---
|
|
if (attempts < this.maxAttempts) {
|
|
await new Promise((resolve) =>
|
|
setTimeout(resolve, this.pollIntervalMs),
|
|
);
|
|
}
|
|
} // End while loop
|
|
|
|
// --- Timeout Condition ---
|
|
console.warn(
|
|
`Polling timed out for PID ${pid} after ${this.maxAttempts} attempts.`,
|
|
);
|
|
|
|
// Determine final status based on the last successful analysis (if any)
|
|
const finalStatus =
|
|
lastAnalysisResult && !isAnalysisFailure(lastAnalysisResult)
|
|
? `TimedOut_${lastAnalysisResult.inferredStatus}` // e.g., TimedOut_Running
|
|
: 'TimedOut_AnalysisFailed'; // If last attempt failed or no analysis succeeded
|
|
|
|
const finalSummary =
|
|
lastAnalysisResult && !isAnalysisFailure(lastAnalysisResult)
|
|
? `Polling timed out after ${this.maxAttempts} attempts. Last known summary: ${lastAnalysisResult.summary}`
|
|
: lastAnalysisResult && isAnalysisFailure(lastAnalysisResult)
|
|
? `Polling timed out; last analysis attempt failed: ${lastAnalysisResult}`
|
|
: `Polling timed out after ${this.maxAttempts} attempts without any successful analysis.`;
|
|
|
|
return { status: finalStatus, summary: finalSummary };
|
|
}
|
|
|
|
// --- Actual Implementation of isProcessRunning ---
|
|
/**
|
|
* Checks if the background process is still running using OS-specific methods.
|
|
* @param pid Process handle/identifier (expects a number for standard checks).
|
|
* @returns True if running, false otherwise.
|
|
* @throws Error if the check itself fails critically (e.g., command not found, permissions).
|
|
*/
|
|
private async isProcessRunning(pid: ProcessHandle): Promise<boolean> {
|
|
if (typeof pid !== 'number' || !Number.isInteger(pid) || pid <= 0) {
|
|
console.warn(
|
|
`isProcessRunning: Invalid PID provided (${pid}). Assuming not running.`,
|
|
);
|
|
return false;
|
|
}
|
|
|
|
try {
|
|
if (process.platform === 'win32') {
|
|
// Windows: Use tasklist command
|
|
const command = `tasklist /FI "PID eq ${pid}" /NH`; // /NH for no header
|
|
const { stdout } = await execAsync(command);
|
|
// Check if the output contains the process information (it will have the image name if found)
|
|
return stdout.toLowerCase().includes('.exe'); // A simple check, adjust if needed
|
|
}
|
|
// Linux/macOS/Unix-like: Use kill -0 signal
|
|
// process.kill sends signal 0 to check existence without killing
|
|
process.kill(pid, 0);
|
|
return true; // If no error is thrown, process exists
|
|
} catch (error: unknown) {
|
|
if (isNodeError(error) && error.code === 'ESRCH') {
|
|
// ESRCH: Standard error code for "No such process" on Unix-like systems
|
|
return false;
|
|
}
|
|
if (
|
|
process.platform === 'win32' &&
|
|
getErrorMessage(error).includes('No tasks are running')
|
|
) {
|
|
// tasklist specific error when PID doesn't exist
|
|
return false;
|
|
}
|
|
// Other errors (e.g., EPERM - permission denied) mean we couldn't determine status.
|
|
// Re-throwing might be appropriate depending on desired behavior.
|
|
// Here, we log it and cautiously return true, assuming it *might* still be running.
|
|
console.warn(
|
|
`isProcessRunning(${pid}) encountered error: ${getErrorMessage(error)}. Assuming process might still exist.`,
|
|
);
|
|
// Or you could throw the error: throw new Error(`Failed to check process status for PID ${pid}: ${error.message}`);
|
|
return true; // Cautious assumption
|
|
}
|
|
}
|
|
|
|
// --- LLM Analysis Method (largely unchanged but added validation robustness) ---
|
|
private async performLlmAnalysis(
|
|
stdoutContent: string,
|
|
stderrContent: string,
|
|
command: string,
|
|
pid: number,
|
|
): Promise<AnalysisResult | AnalysisFailure> {
|
|
if (!this.geminiClient) {
|
|
return {
|
|
error: '[Analysis unavailable: Gemini client not initialized]',
|
|
inferredStatus: 'AnalysisFailed',
|
|
};
|
|
}
|
|
|
|
const truncatedStdout =
|
|
stdoutContent.substring(0, this.maxOutputAnalysisLength) +
|
|
(stdoutContent.length > this.maxOutputAnalysisLength
|
|
? '... [truncated]'
|
|
: '');
|
|
const truncatedStderr =
|
|
stderrContent.substring(0, this.maxOutputAnalysisLength) +
|
|
(stderrContent.length > this.maxOutputAnalysisLength
|
|
? '... [truncated]'
|
|
: '');
|
|
|
|
const analysisPrompt = `**Analyze Background Process Logs**
|
|
|
|
**Context:** A command (\`${command}\`) was executed in the background. You are analyzing the standard output (stdout) and standard error (stderr) collected so far to understand its progress and outcome. This analysis will be used to inform a user about what the command did.
|
|
|
|
**Input:**
|
|
* **Command:** \`${command}\`
|
|
* **Stdout:**
|
|
\`\`\`
|
|
${truncatedStdout}
|
|
\`\`\`
|
|
* **Stderr:**
|
|
\`\`\`
|
|
${truncatedStderr}
|
|
\`\`\`
|
|
|
|
**Task:**
|
|
|
|
Based *only* on the provided stdout and stderr:
|
|
|
|
1. **Interpret and Summarize:** Do *not* simply repeat the logs. Analyze the content and provide a concise summary describing the significant actions, results, progress, or errors reported by the command. If logs are empty, state that no output was captured. Summaries should be formatted as markdown. Focus on the most recent or conclusive information if logs are long.
|
|
2. **Infer Current Status:** Based *only* on the log content, infer the likely status of the command's execution as reflected *in the logs*. Choose the most appropriate status from the options defined in the schema (\`Running\`, \`SuccessReported\`, \`ErrorReported\`, \`Unknown\`). For example:
|
|
* If logs show ongoing activity or progress messages without clear completion or error signals, use \`Running\`.
|
|
* If logs contain explicit messages indicating successful completion or the final expected output of a successful run, use \`SuccessReported\`.
|
|
* If logs contain error messages, stack traces, or failure indications, use \`ErrorReported\`.
|
|
* If the logs provide insufficient information to determine a clear status (e.g., empty logs, vague messages), use \`Unknown\`.
|
|
* If dealing with a node server, the second the port has been shown the server is considered booted, use \`SuccessReported\`.
|
|
* *Note: This status reflects the log content, not necessarily the absolute real-time state of the OS process.*
|
|
3. **Format Output:** Return the results as a JSON object adhering strictly to the following schema:
|
|
|
|
\`\`\`json
|
|
${JSON.stringify(
|
|
{
|
|
// Generate the schema JSON string for the prompt context
|
|
type: 'object',
|
|
properties: {
|
|
summary: {
|
|
type: 'string',
|
|
description:
|
|
'Concise markdown summary (1-3 sentences) of log interpretation.',
|
|
},
|
|
inferredStatus: {
|
|
type: 'string',
|
|
enum: ['Running', 'SuccessReported', 'ErrorReported', 'Unknown'],
|
|
description:
|
|
'Status inferred from logs: Running, SuccessReported, ErrorReported, Unknown',
|
|
},
|
|
},
|
|
required: ['summary', 'inferredStatus'],
|
|
},
|
|
null,
|
|
2,
|
|
)}
|
|
\`\`\`
|
|
|
|
**Instructions:**
|
|
* The \`summary\` must be an interpretation of the logs, focusing on key outcomes or activities. Prioritize recent events if logs are extensive.
|
|
* The \`inferredStatus\` should reflect the most likely state *deduced purely from the log text provided*. Ensure it is one of the specified enum values.`;
|
|
|
|
const schema: SchemaUnion = {
|
|
type: Type.OBJECT,
|
|
properties: {
|
|
summary: {
|
|
type: Type.STRING,
|
|
description:
|
|
'Concise markdown summary (1-3 sentences) of log interpretation.',
|
|
},
|
|
inferredStatus: {
|
|
type: Type.STRING,
|
|
description:
|
|
'Status inferred from logs: Running, SuccessReported, ErrorReported, Unknown',
|
|
enum: ['Running', 'SuccessReported', 'ErrorReported', 'Unknown'],
|
|
},
|
|
},
|
|
required: ['summary', 'inferredStatus'],
|
|
};
|
|
|
|
try {
|
|
const resultJson = await this.geminiClient.generateJson(
|
|
[{ role: 'user', parts: [{ text: analysisPrompt }] }],
|
|
schema,
|
|
);
|
|
|
|
// Validate and construct the AnalysisResult object
|
|
const summary =
|
|
typeof resultJson?.summary === 'string'
|
|
? resultJson.summary
|
|
: '[Summary unavailable]';
|
|
|
|
// Define valid statuses using the AnalysisStatus type (ensure it's defined above)
|
|
const validStatuses: Array<Exclude<AnalysisStatus, 'AnalysisFailed'>> = [
|
|
'Running',
|
|
'SuccessReported',
|
|
'ErrorReported',
|
|
'Unknown',
|
|
];
|
|
|
|
// Cast the unknown value to string before checking with includes
|
|
const statusString = resultJson?.inferredStatus as string;
|
|
const inferredStatus = validStatuses.includes(
|
|
statusString as Exclude<AnalysisStatus, 'AnalysisFailed'>,
|
|
)
|
|
? (statusString as Exclude<AnalysisStatus, 'AnalysisFailed'>)
|
|
: 'Unknown';
|
|
|
|
// Explicitly construct the object matching AnalysisResult type
|
|
const analysisResult: AnalysisResult = { summary, inferredStatus };
|
|
return analysisResult;
|
|
} catch (error: unknown) {
|
|
console.error(`LLM Analysis Request Failed for PID ${pid}:`, error);
|
|
// Return the AnalysisFailure type
|
|
const analysisFailure: AnalysisFailure = {
|
|
error: `[Analysis failed: ${getErrorMessage(error)}]`,
|
|
inferredStatus: 'AnalysisFailed', // This matches the AnalysisStatus type
|
|
};
|
|
return analysisFailure;
|
|
}
|
|
}
|
|
}
|