fix(config): 优雅处理 Provider 未配置错误

- 添加 ConfigurationError 类替代 process.exit(1)
- Server 端捕获配置错误并返回友好消息
- UI 端支持 config_error 类型的 WebSocket 消息
- 服务器不再因配置缺失而崩溃
This commit is contained in:
2025-12-14 22:24:51 +08:00
parent c307cd3a7c
commit 32064a3531
6 changed files with 107 additions and 15 deletions
+1 -1
View File
@@ -1,6 +1,6 @@
export { Agent } from './core/agent.js';
export { toolRegistry, todoManager, initTaskContext, updateTaskDescription, updateSkillDescription } from './tools/index.js';
export { loadConfig, saveConfig, getConfig, loadVisionConfig } from './utils/config.js';
export { loadConfig, saveConfig, getConfig, loadVisionConfig, ConfigurationError } from './utils/config.js';
export type { VisionConfig } from './utils/config.js';
// Context compression
+22 -3
View File
@@ -4,6 +4,23 @@ import * as os from 'os';
import type { AgentConfig, ProviderType } from '../types/index.js';
import { providerRegistry, resolveApiKey } from '../provider/index.js';
/**
* 配置错误异常
*
* 当配置缺失或无效时抛出,用于替代 process.exit()
* 允许调用方优雅地处理错误并向用户显示友好提示
*/
export class ConfigurationError extends Error {
constructor(
message: string,
public readonly provider: string,
public readonly missingKey: 'apiKey' | 'provider'
) {
super(message);
this.name = 'ConfigurationError';
}
}
const CONFIG_DIR = path.join(os.homedir(), '.ai-terminal-assistant');
const CONFIG_FILE = path.join(CONFIG_DIR, 'config.json');
@@ -90,9 +107,11 @@ export function loadConfig(): AgentConfig {
const finalApiKey = resolveApiKey(providerConfig);
if (!finalApiKey) {
console.error(`❌ 错误: 未配置 API Key`);
console.error(`请在设置中配置 ${finalProvider} 的 API Key`);
process.exit(1);
throw new ConfigurationError(
`配置 ${finalProvider} 的 API Key,请在 Provider 设置中配置`,
finalProvider,
'apiKey'
);
}
// 确定模型
+52 -9
View File
@@ -97,6 +97,9 @@ let coreModule: CoreModule | null = null;
// Agent 实例缓存(每个 session 一个)
const agentCache: Map<string, AgentInstance> = new Map();
// 配置错误缓存(用于向客户端返回友好错误)
let lastConfigError: { provider: string; message: string } | null = null;
// ============================================================================
// 公共 API
// ============================================================================
@@ -135,8 +138,13 @@ export function isCoreAvailable(): boolean {
/**
* 获取或创建 Agent 实例
*
* @returns Agent 实例,或 nullCore 不可用或配置错误)
*/
export function getOrCreateAgent(sessionId: string): AgentInstance | null {
// 清除之前的配置错误
lastConfigError = null;
if (!coreModule) {
return null;
}
@@ -146,17 +154,32 @@ export function getOrCreateAgent(sessionId: string): AgentInstance | null {
return agentCache.get(sessionId)!;
}
// 创建新 Agent
const config = coreModule.loadConfig();
const agent = new coreModule.Agent(config);
agent.setRegistry(coreModule.toolRegistry);
try {
// 创建新 Agent(可能抛出 ConfigurationError
const config = coreModule.loadConfig();
const agent = new coreModule.Agent(config);
agent.setRegistry(coreModule.toolRegistry);
// 设置权限回调,通过 WebSocket 请求用户确认
const permissionManager = coreModule.getPermissionManager();
permissionManager.setAskCallback(createServerPermissionCallback(sessionId));
// 设置权限回调,通过 WebSocket 请求用户确认
const permissionManager = coreModule.getPermissionManager();
permissionManager.setAskCallback(createServerPermissionCallback(sessionId));
agentCache.set(sessionId, agent);
return agent;
agentCache.set(sessionId, agent);
return agent;
} catch (error) {
// 检测配置错误(通过 error.name 识别,避免直接依赖 Core 类型)
if (error instanceof Error && error.name === 'ConfigurationError') {
const configError = error as Error & { provider?: string };
lastConfigError = {
provider: configError.provider || 'unknown',
message: error.message,
};
console.warn(`[Agent] Configuration error: ${error.message}`);
return null;
}
// 其他错误继续抛出
throw error;
}
}
/**
@@ -180,6 +203,26 @@ export async function processMessage(sessionId: string, content: string): Promis
const agent = getOrCreateAgent(sessionId);
if (!agent) {
// 检查是否为配置错误
if (lastConfigError) {
// 返回配置错误,引导用户配置 Provider
broadcastToSession(sessionId, {
type: 'error',
sessionId,
payload: {
type: 'config_error',
message: lastConfigError.message,
provider: lastConfigError.provider,
action: 'open_providers_panel',
},
});
emitLogEvent(sessionId, 'error', `配置错误: ${lastConfigError.message}`);
sessionManager.updateStatus(sessionId, 'idle' as SessionStatus);
emitStatusEvent(sessionId, 'idle');
return;
}
// Core 模块不可用,返回占位响应
broadcastToSession(sessionId, {
type: 'chunk',
+2
View File
@@ -122,6 +122,8 @@ export type {
CompressionStatus,
CompressionType,
CompressionResult,
// WebSocket error types
ConfigErrorPayload,
} from './types.js';
// API Configuration
+18
View File
@@ -756,3 +756,21 @@ export interface CompressionResult {
summaryTokens?: number;
}
// ============ WebSocket 错误相关 ============
/**
* 配置错误 Payload
*
* 当 Provider 未配置 API Key 时,通过 WebSocket 返回此错误
*/
export interface ConfigErrorPayload {
/** 错误类型标识 */
type: 'config_error';
/** 错误消息 */
message: string;
/** 缺失配置的 Provider */
provider?: string;
/** 建议的操作 */
action: 'open_providers_panel' | 'open_settings';
}
+12 -2
View File
@@ -7,12 +7,15 @@
import { useState, useEffect, useCallback, useRef } from 'react';
import { createWebSocket, getMessages, type Message } from '../api/client.js';
import type { PermissionRequest } from '../components/PermissionDialog.js';
import type { ConfigErrorPayload } from '../api/types.js';
interface UseChatOptions {
sessionId: string;
onError?: (error: Error) => void;
onSessionNotFound?: () => void;
onSessionUpdated?: (sessionId: string, name: string) => void;
/** 配置错误回调(如 API Key 未配置) */
onConfigError?: (error: ConfigErrorPayload) => void;
}
interface ChatState {
@@ -23,7 +26,7 @@ interface ChatState {
permissionRequest: PermissionRequest | null;
}
export function useChat({ sessionId, onError, onSessionNotFound, onSessionUpdated }: UseChatOptions) {
export function useChat({ sessionId, onError, onSessionNotFound, onSessionUpdated, onConfigError }: UseChatOptions) {
const [state, setState] = useState<ChatState>({
messages: [],
isConnected: false,
@@ -43,9 +46,11 @@ export function useChat({ sessionId, onError, onSessionNotFound, onSessionUpdate
const onErrorRef = useRef(onError);
const onSessionNotFoundRef = useRef(onSessionNotFound);
const onSessionUpdatedRef = useRef(onSessionUpdated);
const onConfigErrorRef = useRef(onConfigError);
onErrorRef.current = onError;
onSessionNotFoundRef.current = onSessionNotFound;
onSessionUpdatedRef.current = onSessionUpdated;
onConfigErrorRef.current = onConfigError;
// 加载历史消息
const loadMessages = useCallback(async () => {
@@ -137,7 +142,12 @@ export function useChat({ sessionId, onError, onSessionNotFound, onSessionUpdate
break;
case 'error':
onErrorRef.current?.(new Error(message.payload?.message || 'Unknown error'));
// 检查是否为配置错误
if (message.payload?.type === 'config_error') {
onConfigErrorRef.current?.(message.payload as ConfigErrorPayload);
} else {
onErrorRef.current?.(new Error(message.payload?.message || 'Unknown error'));
}
setState((prev) => ({ ...prev, isLoading: false, streamingContent: '' }));
break;