/** * Confirmation Hook — 工具执行前用户确认钩子(v0.2.0 新增) * * 对 requiresPermission=true 或 riskLevel >= HIGH 的工具, * 通过 IPC 请求用户确认后再执行。 * * 支持两种自动执行机制: * 1. 持久化自动执行(跨会话):存储在 ConfigService `tools.{toolName}.autoExecute` * 2. 会话内记忆:同一会话内不再重复询问(rememberDecisions) * * @see docs/生产级通用 AI Agent 智能体桌面应用:完整设计与构建指南.html — 第五章 */ import { BrowserWindow } from 'electron'; import type { MetonaToolCall, MetonaToolDef } from '../types'; import type { PreToolHook, HookResult } from './pre-tool'; import type { ConfigService } from '../../services/config.service'; export interface ConfirmationRequest { toolCallId: string; toolName: string; args: Record; riskLevel: string; reason: string; /** * 发起确认的会话 ID(v0.5.1 新增) * 主会话为 sessionId;SubAgent 委派的工具确认为 taskId。 * 前端确认弹框据此在会话 TERMINATED 时只清除该会话的请求, * 避免并发会话场景下误清其他会话等待中的确认。 */ sessionId?: string; /** * 过期时间戳(ms),由 waitForConfirmation 注入,用于前端倒计时 UI。 * 注意:beforeExecute 构造 request 时不带此字段,仅在 waitForConfirmation 中追加。 */ expiresAt?: number; } export class ConfirmationHook implements PreToolHook { /** 需要确认的风险等级 */ private static REQUIRES_CONFIRMATION = ['high', 'critical']; /** L-12 修复: 确认超时范围魔法数字提取为命名常量(30 秒 ~ 600 秒) */ private static readonly MIN_CONFIRMATION_TIMEOUT_MS = 30_000; private static readonly MAX_CONFIRMATION_TIMEOUT_MS = 600_000; /** 工具定义缓存(由外部设置) */ private toolDefs = new Map(); /** * 用户选择记忆(sessionId → toolName → 决策) * * v0.5.0: 从全局 Map 改为按会话隔离的两级 Map — 多会话并发时, * A 会话的"记住拒绝/批准"不再影响 B 会话(与 PolicyEngine 频率限制的会话隔离策略一致)。 * 值为 { approved, at } 以支持拒绝记忆 TTL(v0.4.1)。 */ private rememberedDecisions = new Map>(); /** * v0.4.1: 会话内拒绝记忆的 TTL(10 分钟) * * 历史问题:用户勾选"记住拒绝"后,该工具在本会话永久被拒且无恢复入口, * 用户只能重启会话。现给拒绝记忆加 TTL——过期后恢复询问; * 批准记忆不受 TTL 影响(记住批准是低风险决定,保留原语义)。 */ private static readonly DENIAL_TTL_MS = 10 * 60 * 1000; /** 持久化自动执行的工具集合(从 ConfigService 加载,跨会话生效) */ private autoExecuteTools = new Set(); /** 等待确认的 Promise 解析器(含完整请求信息,供 getPendingConfirmations 返回) */ private pendingConfirmations = new Map< string, { resolve: (v: boolean) => void; timer: NodeJS.Timeout; toolName: string; expiresAt: number; /** v0.5.0: 发起确认的会话 ID(clearPending 按会话清理的依据) */ sessionId: string; /** v0.3.2 批量审批:缓存完整请求信息,供 getPendingConfirmations() 重建 ConfirmationRequest */ args?: Record; riskLevel?: string; reason?: string; } >(); /** 确认超时时间(可从配置读取,默认 120 秒) */ private confirmationTimeoutMs = 120_000; /** * v0.6.4 P2-1: 策略引擎引用(可选注入) * * 用于消费 PolicyEngine 中策略级 requireConfirmation 声明 —— 特别是 `mcp_*` * 通配策略。修复跨层防线不一致:MCPToolAdapter 将 MCP 工具标为 * requiresPermission:false + MEDIUM,原判定直接放行全部外部 MCP 工具, * PolicyEngine 配置的"需确认"从未生效。 */ private policyEngine: { requiresConfirmation(toolName: string): boolean } | null = null; constructor( private mainWindow: BrowserWindow | null = null, private configService: ConfigService | null = null, ) { this.loadAutoExecuteList(); this.loadConfirmationTimeout(); } /** v0.6.4 P2-1: 注入策略引擎(main.ts 装配时调用) */ setPolicyEngine(policyEngine: { requiresConfirmation(toolName: string): boolean }): void { this.policyEngine = policyEngine; } /** 设置主窗口(用于发送 IPC 消息) */ setMainWindow(window: BrowserWindow): void { this.mainWindow = window; } /** * v0.7.2 P2-7 根治: 确认请求/超时通知从"仅 mainWindow"升级为全窗口广播。 * * 原缺陷:流式事件已走 broadcast() 多窗口分发(P2-10),但确认弹框只发给 * 注册时捕获的 ctx.mainWindow —— 第二窗口里运行的会话触发确认时,弹框 * 只出现在主窗口(甚至随窗口重建指向已销毁实例),多窗口场景确认链路不可达。 * * 现契约:遍历所有存活窗口广播;getAllWindows 为空或不可用时回退到注入的 * mainWindow(测试环境 / 生命周期早期兜底),行为向后兼容。 */ private broadcastToAllWindows(channel: string, payload: unknown): void { const windows = BrowserWindow.getAllWindows().filter((w) => !w.isDestroyed() && w.webContents); if (windows.length > 0) { for (const win of windows) { win.webContents.send(channel, payload); } return; } if (this.mainWindow && !this.mainWindow.isDestroyed()) { this.mainWindow.webContents.send(channel, payload); } } /** 当前是否存在任何可接收确认请求的窗口(广播窗口或注入的 mainWindow) */ private hasAvailableWindow(): boolean { if (BrowserWindow.getAllWindows().some((w) => !w.isDestroyed())) return true; return Boolean(this.mainWindow && !this.mainWindow.isDestroyed()); } /** * 从 ConfigService 加载已设置为自动执行的工具列表 * 配置键格式:tools.{toolName}.autoExecute = true */ private loadAutoExecuteList(): void { if (!this.configService) return; try { const all = this.configService.getAll(); this.autoExecuteTools.clear(); for (const [key, value] of Object.entries(all)) { // 匹配 tools.{toolName}.autoExecute 键 const match = /^tools\.(.+)\.autoExecute$/.exec(key); if (match && value === true) { this.autoExecuteTools.add(match[1]); } } } catch { // 配置加载失败,忽略(不阻塞启动) } } /** * 设置/取消工具的持久化自动执行 * @param toolName 工具名 * @param enabled true=自动执行(不再询问),false=每次询问 */ setAutoExecute(toolName: string, enabled: boolean): void { const configKey = `tools.${toolName}.autoExecute`; if (this.configService) { this.configService.set(configKey, enabled); } if (enabled) { this.autoExecuteTools.add(toolName); // 自动执行时同步清除所有会话的"拒绝"记忆(避免冲突 — 自动执行是跨会话的全局设置) this.clearDenialMemoryAllSessions(toolName); } else { this.autoExecuteTools.delete(toolName); } } /** * 获取当前自动执行的工具列表 */ getAutoExecuteList(): string[] { return Array.from(this.autoExecuteTools); } /** * 从 ConfigService 加载确认超时时间 * 配置键:agent.confirmationTimeoutMs(单位毫秒,最小 30 秒,最大 600 秒) */ private loadConfirmationTimeout(): void { if (!this.configService) return; try { const timeout = this.configService.get('agent.confirmationTimeoutMs'); if (timeout != null) { // L-12 修复: 使用命名常量替代魔法数字 this.confirmationTimeoutMs = Math.min( ConfirmationHook.MAX_CONFIRMATION_TIMEOUT_MS, Math.max(ConfirmationHook.MIN_CONFIRMATION_TIMEOUT_MS, timeout), ); } } catch { // 配置加载失败,使用默认值 } } /** 设置确认超时时间(运行时更新) */ setConfirmationTimeout(ms: number): void { // L-12 修复: 使用命名常量替代魔法数字 this.confirmationTimeoutMs = Math.min( ConfirmationHook.MAX_CONFIRMATION_TIMEOUT_MS, Math.max(ConfirmationHook.MIN_CONFIRMATION_TIMEOUT_MS, ms), ); } /** 获取当前确认超时时间 */ getConfirmationTimeout(): number { return this.confirmationTimeoutMs; } /** 注入工具定义列表(用于查询风险等级) */ setToolDefs(defs: MetonaToolDef[]): void { this.toolDefs.clear(); for (const def of defs) { this.toolDefs.set(def.name, def); } } /** * 处理用户确认响应(由 IPC handler 调用) * @param remember 会话内记住决定 * @param autoExecute 永久自动执行(持久化) */ resolveConfirmation( toolCallId: string, approved: boolean, remember: boolean, autoExecute: boolean = false, ): void { const pending = this.pendingConfirmations.get(toolCallId); if (pending) { clearTimeout(pending.timer); pending.resolve(approved); // 永久自动执行(仅当用户批准时才设置) if (autoExecute && approved) { this.setAutoExecute(pending.toolName, true); } // 会话内记忆(v0.4.1: 拒绝记忆带时间戳用于 TTL;v0.5.0: 按 pending 所属会话写入) if (remember) { this.decisionsFor(pending.sessionId).set(pending.toolName, { approved, at: Date.now() }); } this.pendingConfirmations.delete(toolCallId); } } /** * 批量处理用户确认响应(由 IPC tool:confirmationResponseBatch 调用) * * 设计要点: * 1. 单次批量 resolve 即可处理 N 个 pending(避免逐个 IPC 往返) * 2. remember/autoExecute 按 toolName 去重写入,避免 Map 重复赋值 * 3. 批量拒绝时若 remember=true 也会写入"拒绝"记忆(与单条语义一致) * * @param toolCallIds 待处理的 toolCallId 列表 * @param approved 批准/拒绝 * @param remember 会话内记住决定(按 toolName 去重) * @param autoExecute 永久自动执行(仅 approved=true 时生效,按 toolName 去重) * @returns 实际处理成功的 toolCallId 数组(未找到的会被跳过) */ resolveConfirmationsBatch( toolCallIds: string[], approved: boolean, remember: boolean, autoExecute: boolean = false, ): string[] { const resolved: string[] = []; // 同一 toolName 在批量中可能多次出现,仅写入一次决策记忆 const processedToolNames = new Set(); for (const id of toolCallIds) { const pending = this.pendingConfirmations.get(id); if (!pending) continue; // 已超时或不存在,跳过 clearTimeout(pending.timer); pending.resolve(approved); this.pendingConfirmations.delete(id); resolved.push(id); // 按工具名去重写入决策(同一工具的多次调用共享一次决策) if (!processedToolNames.has(pending.toolName)) { processedToolNames.add(pending.toolName); if (autoExecute && approved) { this.setAutoExecute(pending.toolName, true); } if (remember) { this.decisionsFor(pending.sessionId).set(pending.toolName, { approved, at: Date.now() }); } } } return resolved; } /** * 获取当前所有等待中的确认请求(供前端批量审批 UI 拉取已积压的请求) * * 场景:并行工具触发的多个 IPC 事件可能在前端 state 中互相覆盖, * 前端可在弹框打开时主动调用此接口,确保拿到完整的 pending 列表。 * * @returns pending 确认请求的快照(含 toolCallId/toolName/args/riskLevel/reason/expiresAt) */ getPendingConfirmations(): ConfirmationRequest[] { const result: ConfirmationRequest[] = []; for (const [id, pending] of this.pendingConfirmations) { // 重建 ConfirmationRequest(前端需要 args 用于展示参数详情) // pending 已在 waitForConfirmation 中缓存完整请求信息 result.push({ toolCallId: id, toolName: pending.toolName, args: pending.args ?? {}, riskLevel: pending.riskLevel ?? 'medium', reason: pending.reason ?? `Tool "${pending.toolName}" requires confirmation`, sessionId: pending.sessionId, expiresAt: pending.expiresAt, }); } return result; } /** * v0.4.1: 获取记住"拒绝"的工具列表(含剩余有效期,供前端展示恢复入口) * v0.5.0: 按 sessionId 过滤 — 只返回指定会话的拒绝记忆;未指定时聚合所有会话(按剩余时间最长去重) * * 拒绝记忆有 TTL(默认 10 分钟),到期自动恢复询问; * 此方法返回未过期的拒绝记忆,前端可提供"重新询问"按钮主动重置。 * * @param sessionId 会话 ID(前端应传当前会话;缺省时聚合全部会话) */ getRememberedDenials(sessionId?: string): Array<{ toolName: string; expiresInSeconds: number }> { const now = Date.now(); // toolName → 剩余秒数(跨会话聚合时取最长剩余时间) const merged = new Map(); for (const [sid, decisions] of this.rememberedDecisions) { if (sessionId && sid !== sessionId) continue; for (const [toolName, decision] of decisions) { if (decision.approved) continue; const elapsed = now - decision.at; if (elapsed >= ConfirmationHook.DENIAL_TTL_MS) { // 已过期 — 顺手清理,避免列表返回过期条目 decisions.delete(toolName); continue; } const remaining = Math.ceil((ConfirmationHook.DENIAL_TTL_MS - elapsed) / 1000); merged.set(toolName, Math.max(merged.get(toolName) ?? 0, remaining)); } } return Array.from(merged.entries()).map(([toolName, expiresInSeconds]) => ({ toolName, expiresInSeconds, })); } /** * v0.4.1: 重置指定工具的会话内拒绝记忆(恢复询问) * v0.5.0: sessionId 指定会话;未指定时重置所有会话中该工具的拒绝记忆 * @returns true 表示重置成功(存在该工具的拒绝记忆);false 表示没有可重置的记忆 */ resetRememberedDenial(toolName: string, sessionId?: string): boolean { let reset = false; for (const [sid, decisions] of this.rememberedDecisions) { if (sessionId && sid !== sessionId) continue; const decision = decisions.get(toolName); if (decision && !decision.approved) { decisions.delete(toolName); reset = true; } } return reset; } async beforeExecute(toolCall: MetonaToolCall, sessionId: string): Promise { const def = this.toolDefs.get(toolCall.name); if (!def) { // 未知工具,放行(由 ToolRegistry 处理未知工具错误) return { blocked: false }; } // 检查是否需要确认 // v0.6.4 P2-1: 增加第三个来源 —— 策略引擎的 requireConfirmation(mcp_* 通配 // 策略等)。此前只看工具定义的 requiresPermission / riskLevel,外部 MCP 工具 // 被 adapter 全量标为免审批,策略层的"需确认"从未真正生效。 const policyRequiresConfirmation = this.policyEngine?.requiresConfirmation(toolCall.name) ?? false; const needsConfirmation = def.requiresPermission || ConfirmationHook.REQUIRES_CONFIRMATION.includes(def.riskLevel) || policyRequiresConfirmation; if (!needsConfirmation) { return { blocked: false }; } // 优先检查持久化自动执行(跨会话生效) if (this.autoExecuteTools.has(toolCall.name)) { return { blocked: false }; } // 检查本会话记住的决策(v0.4.1: 拒绝记忆带 TTL,过期后恢复询问;v0.5.0: 按会话隔离) const sessionDecisions = this.rememberedDecisions.get(sessionId); const remembered = sessionDecisions?.get(toolCall.name); if (sessionDecisions && remembered !== undefined) { const isExpiredDenial = !remembered.approved && Date.now() - remembered.at > ConfirmationHook.DENIAL_TTL_MS; if (isExpiredDenial) { // 拒绝记忆已过期 — 移除并继续走正常确认流程 sessionDecisions.delete(toolCall.name); } else { if (remembered.approved) return { blocked: false }; return { blocked: true, reason: `User previously denied tool "${toolCall.name}" (remembered in this session; expires in ${Math.ceil((ConfirmationHook.DENIAL_TTL_MS - (Date.now() - remembered.at)) / 60000)} min)`, }; } } // 如果没有任何可用窗口(全窗口广播 + mainWindow 双通道皆不可达),安全起见阻止执行 if (!this.hasAvailableWindow()) { return { blocked: true, reason: 'Cannot request confirmation: no main window available' }; } // 发送确认请求到渲染进程 const request: ConfirmationRequest = { toolCallId: toolCall.id, toolName: toolCall.name, args: toolCall.args, riskLevel: def.riskLevel, reason: def.requiresPermission ? `Tool "${toolCall.name}" requires permission (risk: ${def.riskLevel})` : `Tool "${toolCall.name}" has high risk level: ${def.riskLevel}`, sessionId, }; // 等待用户响应(带超时) const approved = await this.waitForConfirmation(request, sessionId); if (!approved) { return { blocked: true, reason: `User denied execution of tool "${toolCall.name}"` }; } return { blocked: false }; } /** * 等待用户确认(带超时) * 发送 expiresAt 到前端,供倒计时 UI 使用;超时时发送 toast 通知 * * v0.3.2 修复:超时 toast 防风暴 * 并行工具全部超时时会触发 N 个 toast,用 lastToastAt 节流(3 秒内只发 1 条), * 且消息改为汇总形式"工具确认超时,N 个工具未执行"。 */ private lastTimeoutToastAt = 0; // ===== v0.8.1 P2-2: 连续同类工具批量确认聚合 ===== /** * 同 (sessionId, toolName) 的请求在 AGGREGATION_WINDOW_MS 内聚合:窗口结束时 * 若积压 >= AGGREGATION_THRESHOLD 条则只广播一条 `tool:confirmationRequestBatch` * (前端一次性拉取/渲染全部 pending),否则逐条广播(原行为)。 * 目的:批量重构等场景(并行工具连续触发 3+ 同类确认)不再弹出 N 个连续弹框。 */ private static readonly AGGREGATION_WINDOW_MS = 800; private static readonly AGGREGATION_THRESHOLD = 3; private aggregationBuffers = new Map< string, { requests: ConfirmationRequest[]; timer: NodeJS.Timeout | null } >(); private flushAggregationBuffer(key: string): void { const buf = this.aggregationBuffers.get(key); if (!buf) return; this.aggregationBuffers.delete(key); if (buf.timer) { clearTimeout(buf.timer); buf.timer = null; } if (buf.requests.length >= ConfirmationHook.AGGREGATION_THRESHOLD) { // 批量事件:携带完整请求列表(expiresAt 已含) this.broadcastToAllWindows('tool:confirmationRequestBatch', buf.requests); } else { // 逐条广播(原行为) for (const req of buf.requests) { this.broadcastToAllWindows('tool:confirmationRequest', req); } } } private waitForConfirmation(request: ConfirmationRequest, sessionId: string): Promise { return new Promise((resolve) => { const expiresAt = Date.now() + this.confirmationTimeoutMs; // #18 修复: 超时与用户确认的竞态条件防护 // 场景:超时 setTimeout 回调已进入事件循环队列但尚未执行时,用户点击确认, // resolveConfirmation 中 clearTimeout 无法取消已排队的回调, // 导致用户已确认但仍弹出"超时 toast"等副作用。 // 使用 settled 标志确保超时分支与确认分支互斥,先到者赢,另一分支直接 return。 let settled = false; const safeResolve = (v: boolean) => { if (settled) return; settled = true; resolve(v); }; // 设置超时 const timer = setTimeout(() => { if (settled) return; // 已被 resolveConfirmation 处理,跳过超时副作用 this.pendingConfirmations.delete(request.toolCallId); // 超时发送 toast 通知用户(3 秒节流,防止并行工具风暴) // v0.7.2 P2-7: 超时提示同样广播到所有窗口(与确认请求同通道语义) const now = Date.now(); if (now - this.lastTimeoutToastAt > 3000) { this.lastTimeoutToastAt = now; // 统计当前还有多少 pending(含本次刚超时的) const pendingCount = this.pendingConfirmations.size + 1; const message = pendingCount > 1 ? `工具确认超时(${Math.round(this.confirmationTimeoutMs / 1000)}秒),${pendingCount} 个工具未执行` : `工具确认超时(${Math.round(this.confirmationTimeoutMs / 1000)}秒),"${request.toolName}" 未执行`; this.broadcastToAllWindows('toast:show', { type: 'warning', message }); } safeResolve(false); // 超时视为拒绝 }, this.confirmationTimeoutMs); this.pendingConfirmations.set(request.toolCallId, { resolve: safeResolve, timer, toolName: request.toolName, expiresAt, sessionId, // v0.3.2 批量审批:同步缓存完整请求信息,供 getPendingConfirmations() 返回 args: request.args, riskLevel: request.riskLevel, reason: request.reason, }); // 发送确认请求到渲染进程(携带过期时间戳,供前端倒计时) // v0.7.2 P2-7: 广播到所有窗口 —— 多窗口场景下任意窗口发起的会话 // 触发的确认请求都可达(ConfirmationDialog 按会话过滤展示) // v0.8.1 P2-2: 聚合窗口 —— 同会话同类工具的并行请求进入缓冲; // 窗口结束达到阈值时合并为单条批量事件,否则逐条广播(原行为) const aggKey = `${sessionId}:${request.toolName}`; let buf = this.aggregationBuffers.get(aggKey); if (!buf) { buf = { requests: [], timer: null }; this.aggregationBuffers.set(aggKey, buf); buf.timer = setTimeout( () => this.flushAggregationBuffer(aggKey), ConfirmationHook.AGGREGATION_WINDOW_MS, ); } buf.requests.push({ ...request, expiresAt }); // 窗口内积压已达阈值 → 立即 flush(不等满窗口) if (buf.requests.length >= ConfirmationHook.AGGREGATION_THRESHOLD) { this.flushAggregationBuffer(aggKey); } }); } /** * 清理等待中的确认(会话中断时调用) * * v0.5.0: 支持按会话清理 — 多会话并发时,中断 A 会话只拒绝 A 的 pending, * 不再误杀 B 会话等待中的确认请求(原实现全局清空)。 * * @param sessionId 指定会话 ID 时只清理该会话的 pending;缺省时清空全部(紧急路径) */ clearPending(sessionId?: string): void { if (sessionId === undefined) { for (const [, pending] of this.pendingConfirmations) { clearTimeout(pending.timer); pending.resolve(false); } this.pendingConfirmations.clear(); // v0.8.1 P2-2: 清空聚合缓冲(resolve(false) 已由逐条 timer 覆盖……缓冲内的 // 请求本身尚未注册 pending,需丢弃防止稍后广播已失效请求) this.aggregationBuffers.clear(); return; } for (const [id, pending] of this.pendingConfirmations) { if (pending.sessionId !== sessionId) continue; clearTimeout(pending.timer); pending.resolve(false); this.pendingConfirmations.delete(id); } // v0.8.1 P2-2: 丢弃该会话尚未广播的聚合缓冲 for (const [key, buf] of this.aggregationBuffers) { if (!key.startsWith(`${sessionId}:`)) continue; if (buf.timer) clearTimeout(buf.timer); for (const req of buf.requests) { const pending = this.pendingConfirmations.get(req.toolCallId); if (pending) { clearTimeout(pending.timer); pending.resolve(false); this.pendingConfirmations.delete(req.toolCallId); } } this.aggregationBuffers.delete(key); } } /** * v0.7.3 P2-3: 会话生命周期终态清理(会话删除 / SubAgent 终结时调用)。 * * 此前 rememberedDecisions 两级 Map 只增不减 —— 会话删除/子任务终结后其 * 决策记忆永久残留,长期运行实例随会话数缓慢泄漏。本方法与 clearPending * 的区别:clearPending 只处理等待中的确认(会话中断时用,会话本身仍存活), * 本方法面向"会话已终结"的终态,同时清空 pending 与决策记忆。 * * @param sessionId 会话 ID(主会话或 SubAgent taskId) */ forgetSession(sessionId: string): void { if (!sessionId) return; this.clearPending(sessionId); this.rememberedDecisions.delete(sessionId); } // ===== 私有辅助(v0.5.0: 会话隔离) ===== /** 获取(或创建)指定会话的决策记忆表 */ private decisionsFor(sessionId: string): Map { let decisions = this.rememberedDecisions.get(sessionId); if (!decisions) { decisions = new Map(); this.rememberedDecisions.set(sessionId, decisions); } return decisions; } /** 清除所有会话中指定工具的拒绝记忆(setAutoExecute 启用时调用) */ private clearDenialMemoryAllSessions(toolName: string): void { for (const decisions of this.rememberedDecisions.values()) { const decision = decisions.get(toolName); if (decision && !decision.approved) { decisions.delete(toolName); } } } }