Add error messaging for 429 errors (#1316)

This commit is contained in:
Abhi
2025-06-23 17:30:13 -04:00
committed by GitHub
parent 21e6a36cf1
commit dc76bcc433
7 changed files with 139 additions and 45 deletions

View File

@@ -4,6 +4,11 @@
* SPDX-License-Identifier: Apache-2.0
*/
import { StructuredError } from '@gemini-cli/core';
const RATE_LIMIT_ERROR_MESSAGE =
'\nPlease wait and try again later. To increase your limits, upgrade to a plan with higher limits, or use /auth to switch to using a paid API key from AI Studio at https://aistudio.google.com/apikey';
export interface ApiError {
error: {
code: number;
@@ -23,34 +28,57 @@ function isApiError(error: unknown): error is ApiError {
);
}
export function parseAndFormatApiError(errorMessage: string): string {
// The error message might be prefixed with some text, like "[Stream Error: ...]".
// We want to find the start of the JSON object.
const jsonStart = errorMessage.indexOf('{');
if (jsonStart === -1) {
return errorMessage; // Not a JSON error, return as is.
}
const jsonString = errorMessage.substring(jsonStart);
try {
const error = JSON.parse(jsonString) as unknown;
if (isApiError(error)) {
let finalMessage = error.error.message;
try {
// See if the message is a stringified JSON with another error
const nestedError = JSON.parse(finalMessage) as unknown;
if (isApiError(nestedError)) {
finalMessage = nestedError.error.message;
}
} catch (_e) {
// It's not a nested JSON error, so we just use the message as is.
}
return `API Error: ${finalMessage} (Status: ${error.error.status})`;
}
} catch (_e) {
// Not a valid JSON, fall through and return the original message.
}
return errorMessage;
function isStructuredError(error: unknown): error is StructuredError {
return (
typeof error === 'object' &&
error !== null &&
'message' in error &&
typeof (error as StructuredError).message === 'string'
);
}
export function parseAndFormatApiError(error: unknown): string {
if (isStructuredError(error)) {
let text = `[API Error: ${error.message}]`;
if (error.status === 429) {
text += RATE_LIMIT_ERROR_MESSAGE;
}
return text;
}
// The error message might be a string containing a JSON object.
if (typeof error === 'string') {
const jsonStart = error.indexOf('{');
if (jsonStart === -1) {
return `[API Error: ${error}]`; // Not a JSON error, return as is.
}
const jsonString = error.substring(jsonStart);
try {
const parsedError = JSON.parse(jsonString) as unknown;
if (isApiError(parsedError)) {
let finalMessage = parsedError.error.message;
try {
// See if the message is a stringified JSON with another error
const nestedError = JSON.parse(finalMessage) as unknown;
if (isApiError(nestedError)) {
finalMessage = nestedError.error.message;
}
} catch (_e) {
// It's not a nested JSON error, so we just use the message as is.
}
let text = `[API Error: ${finalMessage} (Status: ${parsedError.error.status})]`;
if (parsedError.error.code === 429) {
text += RATE_LIMIT_ERROR_MESSAGE;
}
return text;
}
} catch (_e) {
// Not a valid JSON, fall through and return the original message.
}
return `[API Error: ${error}]`;
}
return '[API Error: An unknown error occurred.]';
}