fix(core): prevent followup suggestion I/O from appearing in tool call UI

[wenshao]

Summary

Follow-up suggestion generation API calls were leaking into the tool call UI. This PR isolates internal API calls at three layers.

Root Cause

Leak path	Symptom
Forked query included tools in generation config	Model could return function calls instead of plain text
logApiResponse/logApiError wrote to chatRecordingService	Suggestion API events appeared in session JSONL and WebUI as tool calls
LoggingContentGenerator recorded requests/responses	Suggestion I/O appeared in OpenAI logs

Changes

New utils/internalPromptIds.ts — Centralises internal prompt IDs (prompt_suggestion, forked_query) in a ReadonlySet with an exported isInternalPromptId() guard. Adding a new internal ID requires changing only this file.

followup/forkedQuery.ts — runForkedQuery sets tools: [] via a NO_TOOLS constant in the per-request config, preventing the model from producing function calls. createForkedChat retains the full generationConfig (including tools) so speculation callers can still execute tool calls.

telemetry/loggers.ts — logApiResponse and logApiError skip chatRecordingService.recordUiTelemetryEvent() for internal prompt IDs. uiTelemetryService.addEvent() is preserved so /stats still tracks suggestion token usage.

loggingContentGenerator.ts — For internal prompt IDs:

• Skips logApiRequest, buildOpenAIRequestForLogging, and logOpenAIInteraction
• loggingStreamWrapper skips response collection and consolidation to reduce CPU/memory overhead
• Tracks firstResponseId/firstModelVersion during iteration so _logApiResponse/_logApiError retain accurate IDs even without full response collection

Not affected

• /stats token tracking ✅
• Speculation (speculative execution) ✅
• Normal conversation logging and recording ✅

Test plan

• 158 related tests pass (followup × 106, loggingContentGenerator × 7, loggers × 40, internalPromptIds × 5)
• CLI: suggestion ghost text appears in input prompt after task completion
• CLI: Tab/Enter/Right Arrow correctly accept suggestions
• /stats includes suggestion token counts
• WebUI session replay no longer shows suggestion API calls as tool calls
• Speculation feature works (tools available in speculative loop)

🤖 Generated with Claude Code

[github-actions]

📋 Review Summary

This PR addresses a clean separation between internal background operations (suggestion generation, forked queries) and user-visible session logging. The changes prevent internal API calls from appearing in tool call UI, session JSONL recordings, and WebUI replays while preserving token usage tracking for /stats. The implementation is well-structured with consistent patterns across three files.

🔍 General Feedback

• Consistent pattern: The isInternalPromptId() helper is implemented in both LoggingContentGenerator and loggers.ts, providing a clear guard mechanism for internal operations
• Minimal changes: Each modification is surgical and focused on the specific goal of filtering internal operations from persistent logs
• Good preservation: Token usage tracking via _logApiResponse is explicitly preserved for /stats functionality
• Clear documentation: JSDoc comments explain the purpose of the internal prompt ID guard functions

🎯 Specific Feedback

🟡 High

• File: packages/core/src/core/loggingContentGenerator/loggingContentGenerator.ts:82 and packages/core/src/telemetry/loggers.ts:130 - Duplicate isInternalPromptId() implementation: The same function is implemented in two separate files. This creates maintenance burden and risk of divergence. Consider extracting this to a shared utility module (e.g., packages/core/src/utils/internalPromptIds.ts) or a common constants file that both modules can import.

  Suggested fix: Create a shared utility:

  // packages/core/src/utils/internalPromptIds.ts
  export function isInternalPromptId(promptId: string): boolean {
    return promptId === 'prompt_suggestion' || promptId === 'forked_query';
  }

🟢 Medium

• File: packages/core/src/followup/forkedQuery.ts:195 - Magic string for tools: []: The comment explains the intent well, but the magic empty array could be extracted to a named constant for clarity and to prevent accidental modification. Consider using Object.freeze([]) or a named constant like NO_TOOLS_CONFIG.

  Suggested improvement:

  const NO_TOOLS_CONFIG: GenerateContentConfig = Object.freeze({ tools: [] });
  const requestConfig: GenerateContentConfig = { ...NO_TOOLS_CONFIG };

• File: packages/core/src/core/loggingContentGenerator/loggingContentGenerator.ts:155-165 - Inconsistent null handling for openaiRequest: When isInternal is true, openaiRequest is set to undefined, but the type system may not reflect this properly. The logOpenAIInteraction calls are guarded, which is correct, but consider making the type explicit or using a more explicit pattern.

🔵 Low

• File: packages/core/src/core/loggingContentGenerator/loggingContentGenerator.ts:78-83 - JSDoc could mention specific internal operations: The comment mentions "suggestion generation, forked queries" which is good, but could also reference the specific prompt ID values for easier cross-referencing.

• File: packages/core/src/telemetry/loggers.ts:125-130 - Consider exporting isInternalPromptId for testing: If this function needs to be tested in isolation, it should be exported. Currently it's private to the module which may make unit testing the guard logic more difficult.

✅ Highlights

• Excellent test plan: The PR description includes a comprehensive test plan covering all affected functionality (ghost text, suggestion submission, /stats, WebUI replay, speculation feature)
• Clear separation of concerns: The distinction between runForkedQuery (no tools) and createForkedChat (retains tools for speculation) is well-implemented and documented
• Preserves important functionality: Careful attention to preserving _logApiResponse for token tracking while filtering UI-visible logging shows good architectural awareness
• Minimal invasive changes: The guards are placed at the right abstraction level, avoiding the need to thread parameters through multiple layers

[wenshao]

整体方案比纯 UI 层修复更彻底，赞同从源头解决。补充几点建议：

1. 提取 isInternalPromptId 消除重复（对应 Bot 高优建议）

isInternalPromptId() 在 loggers.ts 和 loggingContentGenerator.ts 中各有一份实现，逻辑完全一致。建议提取到共享工具模块，例如：

// packages/core/src/utils/internalPromptIds.ts
export const INTERNAL_PROMPT_IDS = Object.freeze({
  SUGGESTION: "prompt_suggestion",
  FORKED_QUERY: "forked_query",
}) as { readonly [key: string]: string };

export function isInternalPromptId(promptId: string): boolean {
  return promptId in INTERNAL_PROMPT_IDS;
}

使用 Object.freeze + 常量映射而非硬编码字符串比较，后续新增内部 promptId 时只需改一处，避免两份实现产生分歧。

2. tools: [] 建议提取为常量

forkedQuery.ts 中的 { tools: [] } 建议提取为命名常量：

const NO_TOOLS_CONFIG: GenerateContentConfig = Object.freeze({ tools: [] });
// ...
const requestConfig: GenerateContentConfig = { ...NO_TOOLS_CONFIG };

3. openaiRequest = undefined 的类型安全

内部 promptId 时 openaiRequest 被赋值为 undefined，但 logOpenAIInteraction 的参数类型可能不接受 undefined。建议将 openaiRequest 声明为 SomeType | undefined，或在调用处增加类型守卫，确保 TypeScript 无 warning。

4. 补充 isInternalPromptId 的单元测试

建议验证 "prompt_suggestion" → true、"forked_query" → true、"user_query" → false、空字符串 → false。

— qwen3.6-plus

[wenshao]

已处理 review 反馈，提交 3c28d03fa：

🟡 High — 重复 isInternalPromptId() 实现
已修复。将 isInternalPromptId() 提取为 telemetry/loggers.ts 的 export 函数，LoggingContentGenerator 直接 import 使用，消除重复。同时更新测试 mock 使用 importOriginal 以暴露真实的 isInternalPromptId。

🟢 Medium — tools: [] magic value
保持现状。tools: [] 在 requestConfig 初始化处有清晰注释说明意图，提取为 Object.freeze 常量反而增加间接性，且此处是唯一使用点。

🟢 Medium — openaiRequest null 处理
logOpenAIInteraction 参数类型已为 OpenAI.Chat.ChatCompletionCreateParams | undefined，且第 315 行有 if (!openaiRequest) return 的 early-return guard。当前行为正确。

🔵 Low — JSDoc 和 export
JSDoc 已补充具体 prompt ID 值（prompt_suggestion, forked_query）。函数已改为 export 可用于测试。

[wenshao]

已处理维护者反馈，提交 662a123b4：

1. 提取 isInternalPromptId 到共享 utils
已创建 packages/core/src/utils/internalPromptIds.ts，使用 ReadonlySet<string> 管理内部 prompt ID 集合。新增内部 ID 只需改一处。loggers.ts 通过 re-export 保持兼容，loggingContentGenerator.ts 直接从 utils 导入。

2. tools: [] 提取为常量
已在 forkedQuery.ts 中提取为 const NO_TOOLS: GenerateContentConfig = Object.freeze({ tools: [] })，使用处改为 { ...NO_TOOLS }。

3. openaiRequest 类型安全
logOpenAIInteraction 参数类型已为 OpenAI.Chat.ChatCompletionCreateParams | undefined，第 315 行有 if (!openaiRequest) return guard，TypeScript 编译无 warning。

4. 单元测试
已添加 internalPromptIds.test.ts，覆盖：prompt_suggestion → true、forked_query → true、user_query → false、空字符串 → false、其他任意 ID → false。150 个测试全部通过。

[Copilot]

Pull request overview

This PR prevents internal follow-up/suggestion generation requests from surfacing as tool-call UI events by treating them as “internal” prompt IDs and suppressing their recording/logging in the session replay artifacts.

Changes:

• Added isInternalPromptId() and used it to skip chatRecordingService recording for api_response / api_error events tied to internal prompt IDs.
• Updated forked query execution to strip tools per request (tools: []) so follow-up generation can’t produce function calls.
• Updated LoggingContentGenerator to skip request/OpenAI interaction logging for internal prompt IDs while preserving API response/error metrics logging.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.

File	Description
packages/core/src/telemetry/loggers.ts	Adds internal prompt ID detection and prevents internal API events from being recorded into session JSONL/WebUI replay.
packages/core/src/followup/forkedQuery.ts	Forces forked queries to run with no tools to avoid tool-call UI artifacts.
packages/core/src/core/loggingContentGenerator/loggingContentGenerator.ts	Skips request/OpenAI logging for internal prompt IDs while keeping response/error metric logging.
packages/core/src/core/loggingContentGenerator/loggingContentGenerator.test.ts	Adjusts logger mocking to preserve new exports while still mocking request/response/error logging.

Comments suppressed due to low confidence (3)

packages/core/src/followup/forkedQuery.ts:211

• runForkedQuery now explicitly overrides tools to an empty list to prevent function calls. There’s test coverage for CacheSafeParams in this module, but nothing asserting that runForkedQuery actually sends requests with tools stripped (or that it cannot emit tool-call parts). Add a unit test that stubs GeminiChat.sendMessageStream/content generator and verifies the merged config contains tools: [] for the 'forked_query' prompt_id.

  const model = options?.model ?? params.model;
  const chat = createForkedChat(config, params);

  // Build per-request config overrides.
  // NO_TOOLS prevents the model from producing function calls — forked
  // queries are pure text completion and must not appear in tool-call UI.
  const requestConfig: GenerateContentConfig = { ...NO_TOOLS };
  if (options?.abortSignal) {
    requestConfig.abortSignal = options.abortSignal;
  }
  if (options?.jsonSchema) {
    requestConfig.responseMimeType = 'application/json';
    requestConfig.responseJsonSchema = options.jsonSchema;
  }

  const stream = await chat.sendMessageStream(
    model,
    {

packages/core/src/core/loggingContentGenerator/loggingContentGenerator.ts:217

• For internal prompt IDs, openaiRequest is set to undefined (so OpenAI logging is effectively disabled), but the streaming path still runs the full response consolidation work in loggingStreamWrapper before calling logOpenAIInteraction (which then returns early). To avoid unnecessary CPU/memory overhead for suggestion/forked queries, propagate isInternal into the wrapper and skip consolidating + logOpenAIInteraction entirely when internal.

    const isInternal = isInternalPromptId(userPromptId);
    if (!isInternal) {
      this.logApiRequest(
        this.toContents(req.contents),
        req.model,
        userPromptId,
      );
    }
    const openaiRequest = isInternal
      ? undefined
      : await this.buildOpenAIRequestForLogging(req);

    let stream: AsyncGenerator<GenerateContentResponse>;
    try {
      stream = await this.wrapped.generateContentStream(req, userPromptId);
    } catch (error) {
      const durationMs = Date.now() - startTime;
      this._logApiError('', durationMs, error, req.model, userPromptId);
      if (!isInternal) {
        await this.logOpenAIInteraction(openaiRequest, undefined, error);
      }
      throw error;
    }

    return this.loggingStreamWrapper(
      stream,
      startTime,
      userPromptId,
      req.model,
      openaiRequest,
    );

packages/core/src/telemetry/loggers.ts:133

• isInternalPromptId and the new guards in logApiError/logApiResponse change recording behavior (skip chatRecordingService.recordUiTelemetryEvent for internal prompt IDs). There are existing logger unit tests, but none exercise this new branch. Add tests that pass prompt_id='prompt_suggestion'/'forked_query' with a mocked getChatRecordingService() and assert recordUiTelemetryEvent is not called, while it still is for normal prompt IDs.

// Re-export for consumers that import from this module.
export { isInternalPromptId } from '../utils/internalPromptIds.js';

export function logStartSession(
  config: Config,
  event: StartSessionEvent,
): void {
  QwenLogger.getInstance(config)?.logStartSessionEvent(event);
  if (!isTelemetrySdkInitialized()) return;

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated 3 comments.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.

Comments suppressed due to low confidence (2)

packages/core/src/followup/forkedQuery.ts:224

• requestConfig is now always non-empty because it always includes tools: [] via NO_TOOLS, so Object.keys(requestConfig).length > 0 ? requestConfig : undefined is redundant and will always select requestConfig. Consider simplifying to pass config: requestConfig directly (or keep the empty-config branch only if NO_TOOLS can be conditionally applied).

  // Build per-request config overrides.
  // NO_TOOLS prevents the model from producing function calls — forked
  // queries are pure text completion and must not appear in tool-call UI.
  const requestConfig: GenerateContentConfig = { ...NO_TOOLS };
  if (options?.abortSignal) {
    requestConfig.abortSignal = options.abortSignal;
  }
  if (options?.jsonSchema) {
    requestConfig.responseMimeType = 'application/json';
    requestConfig.responseJsonSchema = options.jsonSchema;
  }

  const stream = await chat.sendMessageStream(
    model,
    {
      message: [{ text: userMessage }],
      config: Object.keys(requestConfig).length > 0 ? requestConfig : undefined,
    },

packages/core/src/core/loggingContentGenerator/loggingContentGenerator.ts:217

• The internal-prompt behavior is updated for generateContentStream (skipping logApiRequest, OpenAI request conversion, and OpenAI interaction logging), but the new tests only cover generateContent. Add a focused unit test for generateContentStream with userPromptId in ['prompt_suggestion','forked_query'] to assert: logApiRequest/OpenAILogger.logInteraction are not called, while logApiResponse still is (for /stats).

  async generateContentStream(
    req: GenerateContentParameters,
    userPromptId: string,
  ): Promise<AsyncGenerator<GenerateContentResponse>> {
    const startTime = Date.now();
    const isInternal = isInternalPromptId(userPromptId);
    if (!isInternal) {
      this.logApiRequest(
        this.toContents(req.contents),
        req.model,
        userPromptId,
      );
    }
    const openaiRequest = isInternal
      ? undefined
      : await this.buildOpenAIRequestForLogging(req);

    let stream: AsyncGenerator<GenerateContentResponse>;
    try {
      stream = await this.wrapped.generateContentStream(req, userPromptId);
    } catch (error) {
      const durationMs = Date.now() - startTime;
      this._logApiError('', durationMs, error, req.model, userPromptId);
      if (!isInternal) {
        await this.logOpenAIInteraction(openaiRequest, undefined, error);
      }
      throw error;
    }

    return this.loggingStreamWrapper(
      stream,
      startTime,
      userPromptId,
      req.model,
      openaiRequest,
    );

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated no new comments.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.