File size: 7,546 Bytes
7421850 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 | /**
* @license
* Copyright 2025 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import type { Config } from '@google/gemini-cli-core';
import {
OutputFormat,
JsonFormatter,
StreamJsonFormatter,
JsonStreamEventType,
uiTelemetryService,
parseAndFormatApiError,
FatalTurnLimitedError,
FatalCancellationError,
FatalToolExecutionError,
isFatalToolError,
debugLogger,
coreEvents,
getErrorType,
getErrorMessage,
} from '@google/gemini-cli-core';
import { runSyncCleanup } from './cleanup.js';
interface ErrorWithCode extends Error {
exitCode?: number;
code?: string | number;
status?: string | number;
}
/**
* Extracts the appropriate error code from an error object.
*/
function extractErrorCode(error: unknown): string | number {
// eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
const errorWithCode = error as ErrorWithCode;
// Prioritize exitCode for FatalError types, fall back to other codes
if (typeof errorWithCode.exitCode === 'number') {
return errorWithCode.exitCode;
}
if (errorWithCode.code !== undefined) {
return errorWithCode.code;
}
if (errorWithCode.status !== undefined) {
return errorWithCode.status;
}
return 1; // Default exit code
}
/**
* Converts an error code to a numeric exit code.
*/
function getNumericExitCode(errorCode: string | number): number {
return typeof errorCode === 'number' ? errorCode : 1;
}
/**
* Handles errors consistently for both JSON and text output formats.
* In JSON mode, outputs formatted JSON error and exits.
* In streaming JSON mode, emits a result event with error status.
* In text mode, outputs error message and re-throws.
*/
export function handleError(
error: unknown,
config: Config,
customErrorCode?: string | number,
): never {
const errorMessage = parseAndFormatApiError(
error,
config.getContentGeneratorConfig()?.authType,
);
if (config.getOutputFormat() === OutputFormat.STREAM_JSON) {
const streamFormatter = new StreamJsonFormatter();
const errorCode = customErrorCode ?? extractErrorCode(error);
const metrics = uiTelemetryService.getMetrics();
streamFormatter.emitEvent({
type: JsonStreamEventType.RESULT,
timestamp: new Date().toISOString(),
status: 'error',
error: {
type: getErrorType(error),
message: errorMessage,
},
stats: streamFormatter.convertToStreamStats(metrics, 0),
});
runSyncCleanup();
process.exit(getNumericExitCode(errorCode));
} else if (config.getOutputFormat() === OutputFormat.JSON) {
const formatter = new JsonFormatter();
const errorCode = customErrorCode ?? extractErrorCode(error);
const formattedError = formatter.formatError(
error instanceof Error ? error : new Error(getErrorMessage(error)),
errorCode,
config.getSessionId(),
);
coreEvents.emitFeedback('error', formattedError);
runSyncCleanup();
process.exit(getNumericExitCode(errorCode));
} else {
throw error;
}
}
/**
* Handles tool execution errors specifically.
*
* Fatal errors (e.g., NO_SPACE_LEFT) cause the CLI to exit immediately,
* as they indicate unrecoverable system state.
*
* Non-fatal errors (e.g., INVALID_TOOL_PARAMS, FILE_NOT_FOUND, PATH_NOT_IN_WORKSPACE)
* are logged to stderr and the error response is sent back to the model,
* allowing it to self-correct.
*/
export function handleToolError(
toolName: string,
toolError: Error,
config: Config,
errorType?: string,
resultDisplay?: string,
): void {
const errorMessage = `Error executing tool ${toolName}: ${resultDisplay || toolError.message}`;
const isFatal = isFatalToolError(errorType);
if (isFatal) {
const toolExecutionError = new FatalToolExecutionError(errorMessage);
if (config.getOutputFormat() === OutputFormat.STREAM_JSON) {
const streamFormatter = new StreamJsonFormatter();
const metrics = uiTelemetryService.getMetrics();
streamFormatter.emitEvent({
type: JsonStreamEventType.RESULT,
timestamp: new Date().toISOString(),
status: 'error',
error: {
type: errorType ?? 'FatalToolExecutionError',
message: toolExecutionError.message,
},
stats: streamFormatter.convertToStreamStats(metrics, 0),
});
} else if (config.getOutputFormat() === OutputFormat.JSON) {
const formatter = new JsonFormatter();
const formattedError = formatter.formatError(
toolExecutionError,
errorType ?? toolExecutionError.exitCode,
config.getSessionId(),
);
coreEvents.emitFeedback('error', formattedError);
} else {
coreEvents.emitFeedback('error', errorMessage);
}
runSyncCleanup();
process.exit(toolExecutionError.exitCode);
}
// Non-fatal: log and continue
debugLogger.warn(errorMessage);
}
/**
* Handles cancellation/abort signals consistently.
*/
export function handleCancellationError(config: Config): never {
const cancellationError = new FatalCancellationError('Operation cancelled.');
if (config.getOutputFormat() === OutputFormat.STREAM_JSON) {
const streamFormatter = new StreamJsonFormatter();
const metrics = uiTelemetryService.getMetrics();
streamFormatter.emitEvent({
type: JsonStreamEventType.RESULT,
timestamp: new Date().toISOString(),
status: 'error',
error: {
type: getErrorType(cancellationError),
message: cancellationError.message,
},
stats: streamFormatter.convertToStreamStats(metrics, 0),
});
runSyncCleanup();
process.exit(cancellationError.exitCode);
} else if (config.getOutputFormat() === OutputFormat.JSON) {
const formatter = new JsonFormatter();
const formattedError = formatter.formatError(
cancellationError,
cancellationError.exitCode,
config.getSessionId(),
);
coreEvents.emitFeedback('error', formattedError);
runSyncCleanup();
process.exit(cancellationError.exitCode);
} else {
coreEvents.emitFeedback('error', cancellationError.message);
runSyncCleanup();
process.exit(cancellationError.exitCode);
}
}
/**
* Handles max session turns exceeded consistently.
*/
export function handleMaxTurnsExceededError(config: Config): never {
const maxTurnsError = new FatalTurnLimitedError(
'Reached max session turns for this session. Increase the number of turns by specifying maxSessionTurns in settings.json.',
);
if (config.getOutputFormat() === OutputFormat.STREAM_JSON) {
const streamFormatter = new StreamJsonFormatter();
const metrics = uiTelemetryService.getMetrics();
streamFormatter.emitEvent({
type: JsonStreamEventType.RESULT,
timestamp: new Date().toISOString(),
status: 'error',
error: {
type: getErrorType(maxTurnsError),
message: maxTurnsError.message,
},
stats: streamFormatter.convertToStreamStats(metrics, 0),
});
runSyncCleanup();
process.exit(maxTurnsError.exitCode);
} else if (config.getOutputFormat() === OutputFormat.JSON) {
const formatter = new JsonFormatter();
const formattedError = formatter.formatError(
maxTurnsError,
maxTurnsError.exitCode,
config.getSessionId(),
);
coreEvents.emitFeedback('error', formattedError);
runSyncCleanup();
process.exit(maxTurnsError.exitCode);
} else {
coreEvents.emitFeedback('error', maxTurnsError.message);
runSyncCleanup();
process.exit(maxTurnsError.exitCode);
}
}
|