Files
metona-ai-desktop/electron/harness/hooks/confirmation-hook.ts
T
thzxx c727ad075c
CI / 产物编译验证 (push) Successful in 10m9s
CI / 类型检查 + Lint + 单元测试 (push) Failing after 6m4s
CI / 全量测试 (Electron ABI) (push) Failing after 5m24s
fix: v0.5.1 工具调用链路复检修复 — SubAgent 孤儿工具拦截 + 确认弹框会话隔离
背景:v0.5.0 发布后对工具调用链路(adapter 流式 tool_call → 引擎 PARSING →
preToolHooks 管道 → ToolRegistry → 结果回填)做全链路复检,发现并修复两处问题。

安全修复:
- SubAgent 中止时 pending 确认未清理(安全回归):SubEngine 以 taskId 为
  sessionId 写入 ConfirmationHook,abortSession 的 clearPending(sessionId)
  清不到它们。后果:中止会话后残留弹框若被补批,孤儿工具会真实执行副作用
  (v0.4.x 的全局清空反而能拦截)。修复:abortByParent 返回被中止的
  taskId 列表,abortSession 一并 clearPending(taskId)。

确认弹框会话隔离(前端对齐后端 v0.5.0 语义):
- ConfirmationRequest 新增 sessionId 字段(主会话为 sessionId,SubAgent 为
  taskId),弹框在会话 INIT/TERMINATED 时只清除该会话的请求 —— 修复并发
  会话下任意会话结束误清其他会话等待中确认的问题
- 选中计数按当前 requests 收敛(selectedIds 残留 id 无害化)

测试(207 → 215 用例):
- 新增引擎级工具调用链路集成测试 ×6(engine-toolchain.test.ts):真实
  PermissionCheckHook + RateLimitHook + ConfirmationHook 管道 + 真实
  ToolRegistry,覆盖 SAFE 工具直通 / HIGH 工具批准执行 / 拒绝以 Blocked
  错误回传 LLM / 会话隔离端到端 / 工具异常不中断循环 / 策略拦截系统路径
- 新增 FTS 触发器 × NULL content 删除安全性测试 ×2:验证 truncateAfter
  (编辑重发/重新生成)删除 content=NULL 的 assistant 消息(模型仅发
  tool_calls 的标准场景)不抛错且索引保持一致
- agent.test.ts 的 orchestrator mock 适配 abortByParent 新返回类型

验证: lint 0 problems / typecheck 双工程 0 errors / test:electron 215 全过 / build 成功
2026-08-21 21:47:03 +08:00

528 lines
20 KiB
TypeScript
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
/**
* 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<string, unknown>;
riskLevel: string;
reason: string;
/**
* 发起确认的会话 ID(v0.5.1 新增)
* 主会话为 sessionIdSubAgent 委派的工具确认为 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<string, MetonaToolDef>();
/**
* 用户选择记忆(sessionId → toolName → 决策)
*
* v0.5.0: 从全局 Map 改为按会话隔离的两级 Map — 多会话并发时,
* A 会话的"记住拒绝/批准"不再影响 B 会话(与 PolicyEngine 频率限制的会话隔离策略一致)。
* 值为 { approved, at } 以支持拒绝记忆 TTLv0.4.1)。
*/
private rememberedDecisions = new Map<string, Map<string, { approved: boolean; at: number }>>();
/**
* v0.4.1: 会话内拒绝记忆的 TTL10 分钟)
*
* 历史问题:用户勾选"记住拒绝"后,该工具在本会话永久被拒且无恢复入口,
* 用户只能重启会话。现给拒绝记忆加 TTL——过期后恢复询问;
* 批准记忆不受 TTL 影响(记住批准是低风险决定,保留原语义)。
*/
private static readonly DENIAL_TTL_MS = 10 * 60 * 1000;
/** 持久化自动执行的工具集合(从 ConfigService 加载,跨会话生效) */
private autoExecuteTools = new Set<string>();
/** 等待确认的 Promise 解析器(含完整请求信息,供 getPendingConfirmations 返回) */
private pendingConfirmations = new Map<
string,
{
resolve: (v: boolean) => void;
timer: NodeJS.Timeout;
toolName: string;
expiresAt: number;
/** v0.5.0: 发起确认的会话 IDclearPending 按会话清理的依据) */
sessionId: string;
/** v0.3.2 批量审批:缓存完整请求信息,供 getPendingConfirmations() 重建 ConfirmationRequest */
args?: Record<string, unknown>;
riskLevel?: string;
reason?: string;
}
>();
/** 确认超时时间(可从配置读取,默认 120 秒) */
private confirmationTimeoutMs = 120_000;
constructor(
private mainWindow: BrowserWindow | null = null,
private configService: ConfigService | null = null,
) {
this.loadAutoExecuteList();
this.loadConfirmationTimeout();
}
/** 设置主窗口(用于发送 IPC 消息) */
setMainWindow(window: BrowserWindow): void {
this.mainWindow = window;
}
/**
* 从 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<number>('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: 拒绝记忆带时间戳用于 TTLv0.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<string>();
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<string, number>();
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<HookResult> {
const def = this.toolDefs.get(toolCall.name);
if (!def) {
// 未知工具,放行(由 ToolRegistry 处理未知工具错误)
return { blocked: false };
}
// 检查是否需要确认
const needsConfirmation =
def.requiresPermission || ConfirmationHook.REQUIRES_CONFIRMATION.includes(def.riskLevel);
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)`,
};
}
}
// 如果没有主窗口,安全起见阻止执行
if (!this.mainWindow || this.mainWindow.isDestroyed()) {
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;
private waitForConfirmation(request: ConfirmationRequest, sessionId: string): Promise<boolean> {
return new Promise<boolean>((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 秒节流,防止并行工具风暴)
if (this.mainWindow && !this.mainWindow.isDestroyed()) {
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.mainWindow.webContents.send('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,
});
// 发送确认请求到渲染进程(携带过期时间戳,供前端倒计时)
if (this.mainWindow && !this.mainWindow.isDestroyed()) {
this.mainWindow.webContents.send('tool:confirmationRequest', {
...request,
expiresAt,
});
}
});
}
/**
* 清理等待中的确认(会话中断时调用)
*
* 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();
return;
}
for (const [id, pending] of this.pendingConfirmations) {
if (pending.sessionId !== sessionId) continue;
clearTimeout(pending.timer);
pending.resolve(false);
this.pendingConfirmations.delete(id);
}
}
// ===== 私有辅助(v0.5.0: 会话隔离) =====
/** 获取(或创建)指定会话的决策记忆表 */
private decisionsFor(sessionId: string): Map<string, { approved: boolean; at: number }> {
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);
}
}
}
}