Compare commits

...

45 Commits

Author SHA1 Message Date
mkorwel 6deaf3dd0f fix(core,cli): stabilize agent harness, resolve build/lint errors, and fix flaky tests 2026-02-20 20:12:49 +00:00
mkorwel 102881c27f feat(core): stabilize agent harness, fix result extraction and turn limits 2026-02-19 10:34:49 -06:00
mkorwel 456f8be568 wip 2026-02-18 15:45:46 -06:00
mkorwel fa0e6e252f wip: restored baseline with crash fixes 2026-02-12 14:23:02 -06:00
mkorwel 9d8351c5c9 wip: fork agent harness UI and fix engine delegation loop 2026-02-12 13:10:40 -06:00
mkorwel 3b9d5d6e8c feat(core): add debug logging to legacy LocalAgentExecutor 2026-02-12 00:39:11 -06:00
mkorwel 303d001251 feat(core): add standardized lifecycle debug logging for agents 2026-02-12 00:31:56 -06:00
mkorwel ed32dcb179 fix(core): truncate excessive debug output in MessageBus 2026-02-12 00:13:59 -06:00
mkorwel 39fe31d2d3 agent harnness 2026-02-11 22:31:43 -06:00
mkorwel 67819bf5ae fix(core): ensure subagents have access to tools and skills in new harness 2026-02-11 21:53:12 -06:00
mkorwel c989087ba5 refactor(core): unify ReAct loop in AgentHarness using Behavioral architecture 2026-02-11 21:28:57 -06:00
mkorwel 14e781c77c refactor(core): unify ReAct loop in AgentHarness using Behavioral architecture 2026-02-11 21:19:11 -06:00
mkorwel 70105b687c feat(core): implement recovery logic and time-based deadlines in AgentHarness
This adds DeadlineTimer support and a unified recovery loop to AgentHarness, bringing it to full parity with LocalAgentExecutor. (Skipped problematic lints for unsafe assertions on terminateReason enum)
2026-02-11 20:29:08 -06:00
mkorwel 3faa6f2056 fix(core): intercept complete_task calls in AgentHarness to prevent scheduler crash
Fixes a bug where the virtual complete_task tool was being passed to the tool scheduler, causing a 'Tool not found' error because it is not registered in the ToolRegistry. It is now handled internally by the harness.
2026-02-11 20:20:39 -06:00
mkorwel ac8f6f6e7e Merge remote-tracking branch 'origin/main' into mk-agentfactory 2026-02-11 18:02:27 -06:00
mkorwel fbade116c3 feat(cli): add --experimental-enable-agents command line flag 2026-02-11 17:50:36 -06:00
mkorwel 85c31ad2da feat(cli): add --experimental-agent-harness command line flag #18267 2026-02-11 17:43:37 -06:00
Pyush Sinha b8008695db refactor(cli): Reactive useSettingsStore hook (#14915) 2026-02-11 23:40:27 +00:00
mkorwel 886417efc1 fix(core/cli): resolve build errors and integrate SubagentActivity event #18267 2026-02-11 17:33:38 -06:00
mkorwel e650c10cf5 feat(core): implement unified AgentHarness and AgentFactory #18267 2026-02-11 17:24:20 -06:00
Christian Gunderman 6c1773170e More grep prompt tweaks (#18846) 2026-02-11 21:55:27 +00:00
Dev Randalpura 00966062b8 Removed getPlainTextLength (#18848) 2026-02-11 21:47:02 +00:00
Adam Weidman 4138667bae feat(a2a): add value-resolver for auth credential resolution (#18653) 2026-02-11 21:23:28 +00:00
Sandy Tao bfa791e13d feat(core): update internal utility models to Gemini 3 (#18773) 2026-02-11 20:20:14 +00:00
Adib234 e9a9474810 Revert unintended credentials exposure (#18840) 2026-02-11 20:06:28 +00:00
Jerop Kipruto 02adfe2bca docs(plan): add ask_user tool documentation (#18830) 2026-02-11 20:04:01 +00:00
Christian Gunderman 2a08456ed0 Update prompt and grep tool definition to limit context size (#18780) 2026-02-11 19:20:51 +00:00
christine betts 2dac98dc8d Remove experimental note in extension settings docs (#18822) 2026-02-11 19:17:51 +00:00
Jerop Kipruto 77849cadac docs(plan): add documentation for plan mode tools (#18827) 2026-02-11 18:53:43 +00:00
Adib234 84ce53aafa feat(plan): allow skills to be enabled in plan mode (#18817)
Co-authored-by: Jerop Kipruto <jerop@google.com>
2026-02-11 17:59:03 +00:00
Sandy Tao b19b026f30 fix(cli): update F12 behavior to only open drawer if browser fails (#18829) 2026-02-11 17:45:43 +00:00
Jacob Richman eb9223b6a4 Fix pressing any key to exit select mode. (#18421) 2026-02-11 17:38:01 +00:00
Jerop Kipruto 65d26e73a2 feat(plan): document and validate Plan Mode policy overrides (#18825) 2026-02-11 17:32:02 +00:00
Brad Dux 0080589939 fix(cli): resolve double rendering in shpool and address vscode lint warnings (#18704) 2026-02-11 17:29:18 +00:00
Sehoon Shon 34a47a51f4 fix(core): cache CLI version to ensure consistency during sessions (#18793) 2026-02-11 17:01:50 +00:00
Dmitry Lyalin f5dd1068f6 fix(core): complete MCP discovery when configured servers are skipped (#18586)
Co-authored-by: christine betts <chrstn@uw.edu>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
2026-02-11 16:30:46 +00:00
matt korwel c202cf3145 perf(cli): truncate large debug logs and limit message history (#18663) 2026-02-11 15:17:01 +00:00
Jack Wotherspoon 5baad108d9 feat: multi-line text answers in ask-user tool (#18741) 2026-02-11 14:14:53 +00:00
Dev Randalpura 63e9d5d15f perf(ui): optimize table rendering by memoizing styled characters (#18770) 2026-02-11 13:10:30 +00:00
Abhi 3776c4d613 feat(masking): enable tool output masking by default (#18564) 2026-02-11 06:21:55 +00:00
Sandy Tao 2af5a3a01e fix(cli): allow closing debug console after auto-open via flicker (#18795) 2026-02-11 05:37:23 +00:00
Christian Gunderman 0d034b8c18 Introduce limits for search results. (#18767) 2026-02-11 03:50:10 +00:00
Jerop Kipruto 49d55d972e feat(core): formalize 5-phase sequential planning workflow (#18759) 2026-02-11 03:02:20 +00:00
Dmitry Lyalin 7a02d7261a feat(cli): add setting to hide shortcuts hint UI (#18562) 2026-02-11 02:46:20 +00:00
Jerop Kipruto 9c11ff2d58 test(evals): mark all save_memory evals as USUALLY_PASSES due to unreliability (#18786) 2026-02-11 02:16:52 +00:00
114 changed files with 6606 additions and 674 deletions
+2 -4
View File
@@ -1,9 +1,7 @@
{
"experimental": {
"toolOutputMasking": {
"enabled": true
},
"plan": true
"plan": true,
"enableAgentHarness": true
},
"general": {
"devtools": true
+2 -1
View File
@@ -131,7 +131,8 @@ available combinations.
- `!` on an empty prompt: Enter or exit shell mode.
- `?` on an empty prompt: Toggle the shortcuts panel above the input. Press
`Esc`, `Backspace`, or any printable key to close it. Press `?` again to close
the panel and insert a `?` into the prompt.
the panel and insert a `?` into the prompt. You can hide only the hint text
via `ui.showShortcutsHint`, without changing this keyboard behavior.
- `\` (at end of a line) + `Enter`: Insert a newline without leaving single-line
mode.
- `Esc` pressed twice quickly: Clear the input prompt if it is not empty,
+87 -7
View File
@@ -30,6 +30,8 @@ implementation strategy.
- [The Planning Workflow](#the-planning-workflow)
- [Exiting Plan Mode](#exiting-plan-mode)
- [Tool Restrictions](#tool-restrictions)
- [Customizing Planning with Skills](#customizing-planning-with-skills)
- [Customizing Policies](#customizing-policies)
## Starting in Plan Mode
@@ -61,15 +63,18 @@ You can enter Plan Mode in three ways:
1. **Keyboard Shortcut:** Press `Shift+Tab` to cycle through approval modes
(`Default` -> `Plan` -> `Auto-Edit`).
2. **Command:** Type `/plan` in the input box.
3. **Natural Language:** Ask the agent to "start a plan for...".
3. **Natural Language:** Ask the agent to "start a plan for...". The agent will
then call the [`enter_plan_mode`] tool to switch modes.
### The Planning Workflow
1. **Requirements:** The agent clarifies goals using `ask_user`.
1. **Requirements:** The agent clarifies goals using [`ask_user`].
2. **Exploration:** The agent uses read-only tools (like [`read_file`]) to map
the codebase and validate assumptions.
3. **Planning:** A detailed plan is written to a temporary Markdown file.
4. **Review:** You review the plan.
3. **Design:** The agent proposes alternative approaches with a recommended
solution for you to choose from.
4. **Planning:** A detailed plan is written to a temporary Markdown file.
5. **Review:** You review the plan.
- **Approve:** Exit Plan Mode and start implementation (switching to
Auto-Edit or Default approval mode).
- **Iterate:** Provide feedback to refine the plan.
@@ -79,8 +84,8 @@ You can enter Plan Mode in three ways:
To exit Plan Mode:
1. **Keyboard Shortcut:** Press `Shift+Tab` to cycle to the desired mode.
1. **Tool:** The agent calls the `exit_plan_mode` tool to present the finalized
plan for your approval.
2. **Tool:** The agent calls the [`exit_plan_mode`] tool to present the
finalized plan for your approval.
## Tool Restrictions
@@ -90,11 +95,80 @@ These are the only allowed tools:
- **FileSystem (Read):** [`read_file`], [`list_directory`], [`glob`]
- **Search:** [`grep_search`], [`google_web_search`]
- **Interaction:** `ask_user`
- **Interaction:** [`ask_user`]
- **MCP Tools (Read):** Read-only [MCP tools] (e.g., `github_read_issue`,
`postgres_read_schema`) are allowed.
- **Planning (Write):** [`write_file`] and [`replace`] ONLY allowed for `.md`
files in the `~/.gemini/tmp/<project>/plans/` directory.
- **Skills:** [`activate_skill`] (allows loading specialized instructions and
resources in a read-only manner)
### Customizing Planning with Skills
You can leverage [Agent Skills](./skills.md) to customize how Gemini CLI
approaches planning for specific types of tasks. When a skill is activated
during Plan Mode, its specialized instructions and procedural workflows will
guide the research and design phases.
For example:
- A **"Database Migration"** skill could ensure the plan includes data safety
checks and rollback strategies.
- A **"Security Audit"** skill could prompt the agent to look for specific
vulnerabilities during codebase exploration.
- A **"Frontend Design"** skill could guide the agent to use specific UI
components and accessibility standards in its proposal.
To use a skill in Plan Mode, you can explicitly ask the agent to "use the
[skill-name] skill to plan..." or the agent may autonomously activate it based
on the task description.
### Customizing Policies
Plan Mode is designed to be read-only by default to ensure safety during the
research phase. However, you may occasionally need to allow specific tools to
assist in your planning.
Because user policies (Tier 2) have a higher base priority than built-in
policies (Tier 1), you can override Plan Mode's default restrictions by creating
a rule in your `~/.gemini/policies/` directory.
#### Example: Allow `git status` and `git diff` in Plan Mode
This rule allows you to check the repository status and see changes while in
Plan Mode.
`~/.gemini/policies/git-research.toml`
```toml
[[rule]]
toolName = "run_shell_command"
commandPrefix = ["git status", "git diff"]
decision = "allow"
priority = 100
modes = ["plan"]
```
#### Example: Enable research sub-agents in Plan Mode
You can enable [experimental research sub-agents] like `codebase_investigator`
to help gather architecture details during the planning phase.
`~/.gemini/policies/research-subagents.toml`
```toml
[[rule]]
toolName = "codebase_investigator"
decision = "allow"
priority = 100
modes = ["plan"]
```
Tell the agent it can use these tools in your prompt, for example: _"You can
check ongoing changes in git."_
For more information on how the policy engine works, see the [Policy Engine
Guide].
[`list_directory`]: /docs/tools/file-system.md#1-list_directory-readfolder
[`read_file`]: /docs/tools/file-system.md#2-read_file-readfile
@@ -104,3 +178,9 @@ These are the only allowed tools:
[`google_web_search`]: /docs/tools/web-search.md
[`replace`]: /docs/tools/file-system.md#6-replace-edit
[MCP tools]: /docs/tools/mcp-server.md
[`activate_skill`]: /docs/cli/skills.md
[experimental research sub-agents]: /docs/core/subagents.md
[Policy Engine Guide]: /docs/core/policy-engine.md
[`enter_plan_mode`]: /docs/tools/planning.md#1-enter_plan_mode-enterplanmode
[`exit_plan_mode`]: /docs/tools/planning.md#2-exit_plan_mode-exitplanmode
[`ask_user`]: /docs/tools/ask-user.md
+6 -4
View File
@@ -49,6 +49,7 @@ they appear in the UI.
| Dynamic Window Title | `ui.dynamicWindowTitle` | Update the terminal window title with current status icons (Ready: ◇, Action Required: ✋, Working: ✦) | `true` |
| Show Home Directory Warning | `ui.showHomeDirectoryWarning` | Show a warning when running Gemini CLI in the home directory. | `true` |
| Hide Tips | `ui.hideTips` | Hide helpful tips in the UI | `false` |
| Show Shortcuts Hint | `ui.showShortcutsHint` | Show the "? for shortcuts" hint above the input. | `true` |
| Hide Banner | `ui.hideBanner` | Hide the application banner | `false` |
| Hide Context Summary | `ui.hideContextSummary` | Hide the context summary (GEMINI.md, MCP servers) above the input. | `false` |
| Hide CWD | `ui.footer.hideCWD` | Hide the current working directory path in the footer. | `false` |
@@ -124,10 +125,11 @@ they appear in the UI.
### Experimental
| UI Label | Setting | Description | Default |
| ---------------- | ---------------------------- | ----------------------------------------------------------------------------------- | ------- |
| Use OSC 52 Paste | `experimental.useOSC52Paste` | Use OSC 52 sequence for pasting instead of clipboardy (useful for remote sessions). | `false` |
| Plan | `experimental.plan` | Enable planning features (Plan Mode and tools). | `false` |
| UI Label | Setting | Description | Default |
| -------------------------- | ---------------------------------------- | ----------------------------------------------------------------------------------- | ------- |
| Enable Tool Output Masking | `experimental.toolOutputMasking.enabled` | Enables tool output masking to save tokens. | `true` |
| Use OSC 52 Paste | `experimental.useOSC52Paste` | Use OSC 52 sequence for pasting instead of clipboardy (useful for remote sessions). | `false` |
| Plan | `experimental.plan` | Enable planning features (Plan Mode and tools). | `false` |
### Skills
+87
View File
@@ -0,0 +1,87 @@
# Agent harness architecture
This document provides a detailed walkthrough of the architectural shift from
linear turn-based execution to the unified hierarchical loop model used by the
Agent Harness.
> **Note:** This is a preview feature currently under active development.
## Overview
The Agent Harness represents a fundamental evolution in how Gemini CLI manages
interactions with Large Language Models (LLMs) and tools. It unifies the
execution logic for both the main CLI agent and subagents, providing parity in
features like model routing, history management, and tool execution.
## Legacy architecture: Linear turns
The legacy system operates on a "Stop-and-Go" model where the UI manages the
execution turn-by-turn.
In this model, when you send a prompt, the system follows these steps:
1. **Orchestration:** The `GeminiClient` and the `useGeminiStream` hook manage
the flow.
2. **Execution:** Gemini returns a single response containing text or tool
calls.
3. **UI Interruption:** The execution stops at the UI layer. If Gemini calls
tools, the UI schedules them, waits for results, and then re-submits the
entire history as a brand-new turn.
4. **Subagents:** Subagents are treated as "Black Box" tools. The main agent
calls a subagent (for example, `codebase_investigator`), waits for it to
complete its private loop using `LocalAgentExecutor`, and receives a single
string result.
This model results in duplicated logic for subagents and prevents them from
using advanced features available to the main agent.
## New architecture: Unified agent harness
The Agent Harness treats the ReAct (Reasoning and Action) loop as a first-class,
autonomous process.
The new model introduces several key improvements:
1. **Continuous Loop:** The `AgentHarness` manages the entire lifecycle
internally. It handles LLM calls, tool execution, and reasoning without
relinquishing control to the UI until it reaches the final goal.
2. **Event Stream:** The harness yields a continuous stream of events
(`GeminiEvent`) that the UI listens to and renders in real-time.
3. **Hierarchical Delegation:** Because the harness is unified, a subagent is
simply another instance of `AgentHarness` running inside a tool call of the
parent harness.
4. **Feature Parity:** Subagents can now use the same features as the main
agent, including dynamic model routing, history compression, and complex
interactive tools.
## UI synchronization challenges
Moving to a hierarchical model introduces complexity in how the UI maintains a
consistent history.
The `HistoryManager` expects a flat list of messages, but the harness provides a
nested, multi-turn stream. This creates two primary challenges:
1. **History Persistence:** Legacy code may clear the "active" turn state
prematurely when a turn boundary is crossed. The harness uses a
`TurnFinished` event to signal when to "lock in" reasoning without ending
the overall session.
2. **Hierarchical Boxes:** In a hierarchical model, internal subagent tool
calls (for example, reading a file) shouldn't clutter the main history. The
UI uses `SubagentActivity` events to update a single, persistent subagent
box rather than rendering every internal step as a top-level item.
## Isolation strategy
To ensure stability during this transition, the project uses a "Dual
Implementation" strategy.
This strategy isolates the experimental logic from the stable codebase:
- **Hook Isolation:** `useAgentHarness.ts` provides a dedicated hook for the new
event model, leaving the stable `useGeminiStream` untouched.
- **Logic Isolation:** `HarnessSubagentInvocation.ts` manages subagent execution
specifically for the harness, while `LocalSubagentInvocation.ts` continues to
serve the legacy path.
- **Conditional Forking:** The system switches between these paths based on the
`experimental-agent-harness` configuration flag.
+13 -3
View File
@@ -119,9 +119,17 @@ For example:
Approval modes allow the policy engine to apply different sets of rules based on
the CLI's operational mode. A rule can be associated with one or more modes
(e.g., `yolo`, `autoEdit`). The rule will only be active if the CLI is running
in one of its specified modes. If a rule has no modes specified, it is always
active.
(e.g., `yolo`, `autoEdit`, `plan`). The rule will only be active if the CLI is
running in one of its specified modes. If a rule has no modes specified, it is
always active.
- `default`: The standard interactive mode where most write tools require
confirmation.
- `autoEdit`: Optimized for automated code editing; some write tools may be
auto-approved.
- `plan`: A strict, read-only mode for research and design. See [Customizing
Plan Mode Policies].
- `yolo`: A mode where all tools are auto-approved (use with extreme caution).
## Rule matching
@@ -303,3 +311,5 @@ out-of-the-box experience.
- In **`yolo`** mode, a high-priority rule allows all tools.
- In **`autoEdit`** mode, rules allow certain write operations to happen without
prompting.
[Customizing Plan Mode Policies]: /docs/cli/plan-mode.md#customizing-policies
-3
View File
@@ -179,9 +179,6 @@ precedence.
### Settings
_Note: This is an experimental feature. We do not yet recommend extension
authors introduce settings as part of their core flows._
Extensions can define settings that the user will be prompted to provide upon
installation. This is useful for things like API keys, URLs, or other
configuration that the extension needs to function.
+40 -8
View File
@@ -220,6 +220,10 @@ their corresponding top-level category object in your `settings.json` file.
- **Description:** Hide helpful tips in the UI
- **Default:** `false`
- **`ui.showShortcutsHint`** (boolean):
- **Description:** Show the "? for shortcuts" hint above the input.
- **Default:** `true`
- **`ui.hideBanner`** (boolean):
- **Description:** Hide the application banner
- **Default:** `false`
@@ -443,6 +447,12 @@ their corresponding top-level category object in your `settings.json` file.
"model": "gemini-2.5-flash"
}
},
"gemini-3-flash-base": {
"extends": "base",
"modelConfig": {
"model": "gemini-3-flash-preview"
}
},
"classifier": {
"extends": "base",
"modelConfig": {
@@ -498,7 +508,7 @@ their corresponding top-level category object in your `settings.json` file.
}
},
"web-search": {
"extends": "gemini-2.5-flash-base",
"extends": "gemini-3-flash-base",
"modelConfig": {
"generateContentConfig": {
"tools": [
@@ -510,7 +520,7 @@ their corresponding top-level category object in your `settings.json` file.
}
},
"web-fetch": {
"extends": "gemini-2.5-flash-base",
"extends": "gemini-3-flash-base",
"modelConfig": {
"generateContentConfig": {
"tools": [
@@ -522,25 +532,25 @@ their corresponding top-level category object in your `settings.json` file.
}
},
"web-fetch-fallback": {
"extends": "gemini-2.5-flash-base",
"extends": "gemini-3-flash-base",
"modelConfig": {}
},
"loop-detection": {
"extends": "gemini-2.5-flash-base",
"extends": "gemini-3-flash-base",
"modelConfig": {}
},
"loop-detection-double-check": {
"extends": "base",
"modelConfig": {
"model": "gemini-2.5-pro"
"model": "gemini-3-pro-preview"
}
},
"llm-edit-fixer": {
"extends": "gemini-2.5-flash-base",
"extends": "gemini-3-flash-base",
"modelConfig": {}
},
"next-speaker-checker": {
"extends": "gemini-2.5-flash-base",
"extends": "gemini-3-flash-base",
"modelConfig": {}
},
"chat-compression-3-pro": {
@@ -570,7 +580,7 @@ their corresponding top-level category object in your `settings.json` file.
},
"chat-compression-default": {
"modelConfig": {
"model": "gemini-2.5-pro"
"model": "gemini-3-pro-preview"
}
}
}
@@ -848,6 +858,28 @@ their corresponding top-level category object in your `settings.json` file.
#### `experimental`
- **`experimental.toolOutputMasking.enabled`** (boolean):
- **Description:** Enables tool output masking to save tokens.
- **Default:** `true`
- **Requires restart:** Yes
- **`experimental.toolOutputMasking.toolProtectionThreshold`** (number):
- **Description:** Minimum number of tokens to protect from masking (most
recent tool outputs).
- **Default:** `50000`
- **Requires restart:** Yes
- **`experimental.toolOutputMasking.minPrunableTokensThreshold`** (number):
- **Description:** Minimum prunable tokens required to trigger a masking pass.
- **Default:** `30000`
- **Requires restart:** Yes
- **`experimental.toolOutputMasking.protectLatestTurn`** (boolean):
- **Description:** Ensures the absolute latest turn is never masked,
regardless of token count.
- **Default:** `true`
- **Requires restart:** Yes
- **`experimental.enableAgents`** (boolean):
- **Description:** Enable local and remote subagents. Warning: Experimental
feature, uses YOLO mode for subagents
+4
View File
@@ -88,6 +88,10 @@
"label": "Sub-agents (experimental)",
"slug": "docs/core/subagents"
},
{
"label": "Agent harness architecture (experimental)",
"slug": "docs/core/agent-harness-architecture"
},
{
"label": "Remote subagents (experimental)",
"slug": "docs/core/remote-agents"
+95
View File
@@ -0,0 +1,95 @@
# Ask User Tool
The `ask_user` tool allows the agent to ask you one or more questions to gather
preferences, clarify requirements, or make decisions. It supports multiple
question types including multiple-choice, free-form text, and Yes/No
confirmation.
## `ask_user` (Ask User)
- **Tool name:** `ask_user`
- **Display name:** Ask User
- **File:** `ask-user.ts`
- **Parameters:**
- `questions` (array of objects, required): A list of 1 to 4 questions to ask.
Each question object has the following properties:
- `question` (string, required): The complete question text.
- `header` (string, required): A short label (max 16 chars) displayed as a
chip/tag (e.g., "Auth", "Database").
- `type` (string, optional): The type of question. Defaults to `'choice'`.
- `'choice'`: Multiple-choice with options (supports multi-select).
- `'text'`: Free-form text input.
- `'yesno'`: Yes/No confirmation.
- `options` (array of objects, optional): Required for `'choice'` type. 2-4
selectable options.
- `label` (string, required): Display text (1-5 words).
- `description` (string, required): Brief explanation.
- `multiSelect` (boolean, optional): For `'choice'` type, allows selecting
multiple options.
- `placeholder` (string, optional): Hint text for input fields.
- **Behavior:**
- Presents an interactive dialog to the user with the specified questions.
- Pauses execution until the user provides answers or dismisses the dialog.
- Returns the user's answers to the model.
- **Output (`llmContent`):** A JSON string containing the user's answers,
indexed by question position (e.g.,
`{"answers":{"0": "Option A", "1": "Some text"}}`).
- **Confirmation:** Yes. The tool inherently involves user interaction.
## Usage Examples
### Multiple Choice Question
```json
{
"questions": [
{
"header": "Database",
"question": "Which database would you like to use?",
"type": "choice",
"options": [
{
"label": "PostgreSQL",
"description": "Powerful, open source object-relational database system."
},
{
"label": "SQLite",
"description": "C-library that implements a SQL database engine."
}
]
}
]
}
```
### Text Input Question
```json
{
"questions": [
{
"header": "Project Name",
"question": "What is the name of your new project?",
"type": "text",
"placeholder": "e.g., my-awesome-app"
}
]
}
```
### Yes/No Question
```json
{
"questions": [
{
"header": "Deploy",
"question": "Do you want to deploy the application now?",
"type": "yesno"
}
]
}
```
+3
View File
@@ -86,6 +86,9 @@ Gemini CLI's built-in tools can be broadly categorized as follows:
information across sessions.
- **[Todo Tool](./todos.md) (`write_todos`):** For managing subtasks of complex
requests.
- **[Planning Tools](./planning.md):** For entering and exiting Plan Mode.
- **[Ask User Tool](./ask-user.md) (`ask_user`):** For gathering user input and
making decisions.
Additionally, these tools incorporate:
+1 -12
View File
@@ -739,21 +739,10 @@ The MCP integration tracks several states:
cautiously and only for servers you completely control
- **Access tokens:** Be security-aware when configuring environment variables
containing API keys or tokens
- **Environment variable redaction:** By default, the Gemini CLI redacts
sensitive environment variables (such as `GEMINI_API_KEY`, `GOOGLE_API_KEY`,
and variables matching patterns like `*TOKEN*`, `*SECRET*`, `*PASSWORD*`) when
spawning MCP servers using the `stdio` transport. This prevents unintended
exposure of your credentials to third-party servers.
- **Explicit environment variables:** If you need to pass a specific environment
variable to an MCP server, you should define it explicitly in the `env`
property of the server configuration in `settings.json`.
- **Sandbox compatibility:** When using sandboxing, ensure MCP servers are
available within the sandbox environment.
available within the sandbox environment
- **Private data:** Using broadly scoped personal access tokens can lead to
information leakage between repositories.
- **Untrusted servers:** Be extremely cautious when adding MCP servers from
untrusted or third-party sources. Malicious servers could attempt to
exfiltrate data or perform unauthorized actions through the tools they expose.
### Performance and resource management
+55
View File
@@ -0,0 +1,55 @@
# Gemini CLI planning tools
Planning tools allow the Gemini model to switch into a safe, read-only "Plan
Mode" for researching and planning complex changes, and to signal the
finalization of a plan to the user.
## 1. `enter_plan_mode` (EnterPlanMode)
`enter_plan_mode` switches the CLI to Plan Mode. This tool is typically called
by the agent when you ask it to "start a plan" using natural language. In this
mode, the agent is restricted to read-only tools to allow for safe exploration
and planning.
- **Tool name:** `enter_plan_mode`
- **Display name:** Enter Plan Mode
- **File:** `enter-plan-mode.ts`
- **Parameters:**
- `reason` (string, optional): A short reason explaining why the agent is
entering plan mode (e.g., "Starting a complex feature implementation").
- **Behavior:**
- Switches the CLI's approval mode to `PLAN`.
- Notifies the user that the agent has entered Plan Mode.
- **Output (`llmContent`):** A message indicating the switch, e.g.,
`Switching to Plan mode.`
- **Confirmation:** Yes. The user is prompted to confirm entering Plan Mode.
## 2. `exit_plan_mode` (ExitPlanMode)
`exit_plan_mode` signals that the planning phase is complete. It presents the
finalized plan to the user and requests approval to start the implementation.
- **Tool name:** `exit_plan_mode`
- **Display name:** Exit Plan Mode
- **File:** `exit-plan-mode.ts`
- **Parameters:**
- `plan_path` (string, required): The path to the finalized Markdown plan
file. This file MUST be located within the project's temporary plans
directory (e.g., `~/.gemini/tmp/<project>/plans/`).
- **Behavior:**
- Validates that the `plan_path` is within the allowed directory and that the
file exists and has content.
- Presents the plan to the user for review.
- If the user approves the plan:
- Switches the CLI's approval mode to the user's chosen approval mode (
`DEFAULT` or `AUTO_EDIT`).
- Marks the plan as approved for implementation.
- If the user rejects the plan:
- Stays in Plan Mode.
- Returns user feedback to the model to refine the plan.
- **Output (`llmContent`):**
- On approval: A message indicating the plan was approved and the new approval
mode.
- On rejection: A message containing the user's feedback.
- **Confirmation:** Yes. Shows the finalized plan and asks for user approval to
proceed with implementation.
+144
View File
@@ -0,0 +1,144 @@
/**
* @license
* Copyright 2026 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import { describe, expect } from 'vitest';
import { evalTest } from './test-helper.js';
/**
* Evals to verify that the agent uses search tools efficiently (frugally)
* by utilizing limiting parameters like `total_max_matches` and `max_matches_per_file`.
* This ensures the agent doesn't flood the context window with unnecessary search results.
*/
describe('Frugal Search', () => {
const getGrepParams = (call: any): any => {
let args = call.toolRequest.args;
if (typeof args === 'string') {
try {
args = JSON.parse(args);
} catch (e) {
// Ignore parse errors
}
}
return args;
};
evalTest('USUALLY_PASSES', {
name: 'should use targeted search with limit',
prompt: 'find me a sample usage of path.resolve() in the codebase',
files: {
'package.json': JSON.stringify({
name: 'test-project',
version: '1.0.0',
main: 'dist/index.js',
scripts: {
build: 'tsc',
test: 'vitest',
},
dependencies: {
typescript: '^5.0.0',
'@types/node': '^20.0.0',
vitest: '^1.0.0',
},
}),
'src/index.ts': `
import { App } from './app.ts';
const app = new App();
app.start();
`,
'src/app.ts': `
import * as path from 'path';
import { UserController } from './controllers/user.ts';
export class App {
constructor() {
console.log('App initialized');
}
public start(): void {
const userController = new UserController();
console.log('Static path:', path.resolve(__dirname, '../public'));
}
}
`,
'src/utils.ts': `
import * as path from 'path';
import * as fs from 'fs';
export function resolvePath(p: string): string {
return path.resolve(process.cwd(), p);
}
export function ensureDir(dirPath: string): void {
const absolutePath = path.resolve(dirPath);
if (!fs.existsSync(absolutePath)) {
fs.mkdirSync(absolutePath, { recursive: true });
}
}
`,
'src/config.ts': `
import * as path from 'path';
export const config = {
dbPath: path.resolve(process.cwd(), 'data/db.sqlite'),
logLevel: 'info',
};
`,
'src/controllers/user.ts': `
import * as path from 'path';
export class UserController {
public getUsers(): any[] {
console.log('Loading users from:', path.resolve('data/users.json'));
return [{ id: 1, name: 'Alice' }];
}
}
`,
'tests/app.test.ts': `
import { describe, it, expect } from 'vitest';
import * as path from 'path';
describe('App', () => {
it('should resolve paths', () => {
const p = path.resolve('test');
expect(p).toBeDefined();
});
});
`,
},
assert: async (rig) => {
const toolCalls = rig.readToolLogs();
const grepCalls = toolCalls.filter(
(call) => call.toolRequest.name === 'grep_search',
);
expect(grepCalls.length).toBeGreaterThan(0);
const grepParams = grepCalls.map(getGrepParams);
const hasTotalMaxLimit = grepParams.some(
(p) => p.total_max_matches !== undefined && p.total_max_matches <= 100,
);
expect(
hasTotalMaxLimit,
`Expected agent to use a small total_max_matches (<= 100) for a sample usage request. Actual values: ${JSON.stringify(
grepParams.map((p) => p.total_max_matches),
)}`,
).toBe(true);
const hasMaxMatchesPerFileLimit = grepParams.some(
(p) =>
p.max_matches_per_file !== undefined && p.max_matches_per_file <= 5,
);
expect(
hasMaxMatchesPerFileLimit,
`Expected agent to use a small max_matches_per_file (<= 5) for a sample usage request. Actual values: ${JSON.stringify(
grepParams.map((p) => p.max_matches_per_file),
)}`,
).toBe(true);
},
});
});
+11 -11
View File
@@ -14,7 +14,7 @@ import {
describe('save_memory', () => {
const TEST_PREFIX = 'Save memory test: ';
const rememberingFavoriteColor = "Agent remembers user's favorite color";
evalTest('ALWAYS_PASSES', {
evalTest('USUALLY_PASSES', {
name: rememberingFavoriteColor,
params: {
settings: { tools: { core: ['save_memory'] } },
@@ -36,7 +36,7 @@ describe('save_memory', () => {
},
});
const rememberingCommandRestrictions = 'Agent remembers command restrictions';
evalTest('ALWAYS_PASSES', {
evalTest('USUALLY_PASSES', {
name: rememberingCommandRestrictions,
params: {
settings: { tools: { core: ['save_memory'] } },
@@ -57,7 +57,7 @@ describe('save_memory', () => {
});
const rememberingWorkflow = 'Agent remembers workflow preferences';
evalTest('ALWAYS_PASSES', {
evalTest('USUALLY_PASSES', {
name: rememberingWorkflow,
params: {
settings: { tools: { core: ['save_memory'] } },
@@ -79,7 +79,7 @@ describe('save_memory', () => {
const ignoringTemporaryInformation =
'Agent ignores temporary conversation details';
evalTest('ALWAYS_PASSES', {
evalTest('USUALLY_PASSES', {
name: ignoringTemporaryInformation,
params: {
settings: { tools: { core: ['save_memory'] } },
@@ -104,7 +104,7 @@ describe('save_memory', () => {
});
const rememberingPetName = "Agent remembers user's pet's name";
evalTest('ALWAYS_PASSES', {
evalTest('USUALLY_PASSES', {
name: rememberingPetName,
params: {
settings: { tools: { core: ['save_memory'] } },
@@ -125,7 +125,7 @@ describe('save_memory', () => {
});
const rememberingCommandAlias = 'Agent remembers custom command aliases';
evalTest('ALWAYS_PASSES', {
evalTest('USUALLY_PASSES', {
name: rememberingCommandAlias,
params: {
settings: { tools: { core: ['save_memory'] } },
@@ -147,7 +147,7 @@ describe('save_memory', () => {
const ignoringDbSchemaLocation =
"Agent ignores workspace's database schema location";
evalTest('ALWAYS_PASSES', {
evalTest('USUALLY_PASSES', {
name: ignoringDbSchemaLocation,
params: {
settings: {
@@ -178,7 +178,7 @@ describe('save_memory', () => {
const rememberingCodingStyle =
"Agent remembers user's coding style preference";
evalTest('ALWAYS_PASSES', {
evalTest('USUALLY_PASSES', {
name: rememberingCodingStyle,
params: {
settings: { tools: { core: ['save_memory'] } },
@@ -200,7 +200,7 @@ describe('save_memory', () => {
const ignoringBuildArtifactLocation =
'Agent ignores workspace build artifact location';
evalTest('ALWAYS_PASSES', {
evalTest('USUALLY_PASSES', {
name: ignoringBuildArtifactLocation,
params: {
settings: {
@@ -230,7 +230,7 @@ describe('save_memory', () => {
});
const ignoringMainEntryPoint = "Agent ignores workspace's main entry point";
evalTest('ALWAYS_PASSES', {
evalTest('USUALLY_PASSES', {
name: ignoringMainEntryPoint,
params: {
settings: {
@@ -260,7 +260,7 @@ describe('save_memory', () => {
});
const rememberingBirthday = "Agent remembers user's birthday";
evalTest('ALWAYS_PASSES', {
evalTest('USUALLY_PASSES', {
name: rememberingBirthday,
params: {
settings: { tools: { core: ['save_memory'] } },
+21 -13
View File
@@ -26,7 +26,7 @@ class MockClient implements acp.Client {
};
}
describe('ACP Environment and Auth', () => {
describe.skip('ACP Environment and Auth', () => {
let rig: TestRig;
let child: ChildProcess | undefined;
@@ -55,15 +55,19 @@ describe('ACP Environment and Auth', () => {
const bundlePath = join(import.meta.dirname, '..', 'bundle/gemini.js');
const customEnv = {
...process.env,
GEMINI_CLI_HOME: rig.homeDir!,
VERBOSE: 'true',
};
// eslint-disable-next-line @typescript-eslint/no-explicit-any
delete (customEnv as any).GEMINI_API_KEY;
child = spawn('node', [bundlePath, '--experimental-acp'], {
cwd: rig.homeDir!,
stdio: ['pipe', 'pipe', 'inherit'],
env: {
...process.env,
GEMINI_CLI_HOME: rig.homeDir!,
GEMINI_API_KEY: undefined,
VERBOSE: 'true',
},
// eslint-disable-next-line @typescript-eslint/no-explicit-any
env: customEnv as any,
});
const input = Writable.toWeb(child.stdin!);
@@ -120,15 +124,19 @@ describe('ACP Environment and Auth', () => {
const bundlePath = join(import.meta.dirname, '..', 'bundle/gemini.js');
const customEnv = {
...process.env,
GEMINI_CLI_HOME: rig.homeDir!,
VERBOSE: 'true',
};
// eslint-disable-next-line @typescript-eslint/no-explicit-any
delete (customEnv as any).GEMINI_API_KEY;
child = spawn('node', [bundlePath, '--experimental-acp'], {
cwd: rig.homeDir!,
stdio: ['pipe', 'pipe', 'inherit'],
env: {
...process.env,
GEMINI_CLI_HOME: rig.homeDir!,
GEMINI_API_KEY: undefined,
VERBOSE: 'true',
},
// eslint-disable-next-line @typescript-eslint/no-explicit-any
env: customEnv as any,
});
const input = Writable.toWeb(child.stdin!);
@@ -0,0 +1,94 @@
/**
* @license
* Copyright 2025 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import { describe, it, expect, beforeEach, afterEach } from 'vitest';
import { TestRig } from './test-helper.js';
import * as fs from 'node:fs';
import * as path from 'node:path';
describe('Agent Harness E2E', () => {
let rig: TestRig;
beforeEach(() => {
rig = new TestRig();
});
afterEach(async () => await rig.cleanup());
it('should execute a simple prompt using the agent harness', async () => {
await rig.setup('agent-harness-simple');
// Run with the harness enabled via env var
// Turn 1
const result1 = await rig.run({
args: ['chat', 'My name is GeminiUser'],
env: {
...process.env,
GEMINI_ENABLE_AGENT_HARNESS: 'true',
},
});
expect(result1).toBeDefined();
// Turn 2
const result2 = await rig.run({
args: ['chat', 'What is my name?', '--resume', 'latest'],
env: {
...process.env,
GEMINI_ENABLE_AGENT_HARNESS: 'true',
},
});
expect(result2).toContain('GeminiUser');
}, 120000);
it('should delegate to codebase_investigator and synthesize results', async () => {
await rig.setup('agent-harness-delegation');
// Create a dummy file for CBI to find
const historyDir = path.join(rig.testDir!, 'packages/core/src');
fs.mkdirSync(historyDir, { recursive: true });
fs.writeFileSync(
path.join(historyDir, 'history.ts'),
`
/** ChatHistory maintains the message history for the session. */
export class ChatHistory {
private messages: any[] = [];
addMessage(msg: any) { this.messages.push(msg); }
}
`,
);
const result = await rig.run({
args: [
'chat',
'use @codebase_investigator to tell me about how chat history is maintained',
],
env: {
...process.env,
GEMINI_ENABLE_AGENT_HARNESS: 'true',
},
});
// Verify synthesis: CBI should have found ChatHistory or history.ts
const output = result.toLowerCase();
expect(output).toMatch(/history|chat/);
// Verify single delegation: CBI should only be called once.
// We check the tool logs for 'codebase_investigator'
const toolLogs = rig.readToolLogs();
const cbiCalls = toolLogs.filter(
(log) => log.toolRequest?.name === 'codebase_investigator',
);
if (cbiCalls.length < 1) {
console.log('DEBUG: Full tool logs:', JSON.stringify(toolLogs, null, 2));
if (rig._lastRunStdout) {
console.log('DEBUG: Full stdout length:', rig._lastRunStdout.length);
}
}
expect(cbiCalls.length).toBeGreaterThanOrEqual(1);
}, 240000);
});
-7
View File
@@ -128,13 +128,6 @@ async function addMcpServer(
settings.setValue(settingsScope, 'mcpServers', mcpServers);
if (transport === 'stdio') {
debugLogger.warn(
'Security Warning: Running MCP servers with stdio transport can expose inherited environment variables. ' +
'While the Gemini CLI redacts common API keys and secrets by default, you should only run servers from trusted sources.',
);
}
if (isExistingServer) {
debugLogger.log(`MCP server "${name}" updated in ${scope} settings.`);
} else {
+20 -1
View File
@@ -78,6 +78,8 @@ export interface CliArgs {
allowedMcpServerNames: string[] | undefined;
allowedTools: string[] | undefined;
experimentalAcp: boolean | undefined;
experimentalAgentHarness: boolean | undefined;
experimentalEnableAgents: boolean | undefined;
extensions: string[] | undefined;
listExtensions: boolean | undefined;
resume: string | typeof RESUME_LATEST | undefined;
@@ -162,6 +164,14 @@ export async function parseArguments(
type: 'boolean',
description: 'Starts the agent in ACP mode',
})
.option('experimental-agent-harness', {
type: 'boolean',
description: 'Enable the new unified agent harness',
})
.option('experimental-enable-agents', {
type: 'boolean',
description: 'Enable local and remote subagents',
})
.option('allowed-mcp-server-names', {
type: 'array',
string: true,
@@ -787,7 +797,16 @@ export async function loadCliConfig(
enabledExtensions: argv.extensions,
extensionLoader: extensionManager,
enableExtensionReloading: settings.experimental?.extensionReloading,
enableAgents: settings.experimental?.enableAgents,
enableAgents:
argv.experimentalEnableAgents ?? settings.experimental?.enableAgents,
enableAgentHarness:
argv.experimentalAgentHarness ??
(process.env['GEMINI_ENABLE_AGENT_HARNESS'] === 'true'
? true
: process.env['GEMINI_ENABLE_AGENT_HARNESS'] === 'false'
? false
: settings.experimental?.enableAgentHarness),
plan: settings.experimental?.plan,
enableEventDrivenScheduler: true,
skillsSupport: settings.skills?.enabled ?? true,
+44
View File
@@ -2546,6 +2546,50 @@ describe('Settings Loading and Merging', () => {
});
});
describe('Reactivity & Snapshots', () => {
let loadedSettings: LoadedSettings;
beforeEach(() => {
const emptySettingsFile: SettingsFile = {
path: '/mock/path',
settings: {},
originalSettings: {},
};
loadedSettings = new LoadedSettings(
{ ...emptySettingsFile, path: getSystemSettingsPath() },
{ ...emptySettingsFile, path: getSystemDefaultsPath() },
{ ...emptySettingsFile, path: USER_SETTINGS_PATH },
{ ...emptySettingsFile, path: MOCK_WORKSPACE_SETTINGS_PATH },
true, // isTrusted
[],
);
});
it('getSnapshot() should return stable reference if no changes occur', () => {
const snap1 = loadedSettings.getSnapshot();
const snap2 = loadedSettings.getSnapshot();
expect(snap1).toBe(snap2);
});
it('setValue() should create a new snapshot reference and emit event', () => {
const oldSnapshot = loadedSettings.getSnapshot();
const oldUserRef = oldSnapshot.user.settings;
loadedSettings.setValue(SettingScope.User, 'ui.theme', 'high-contrast');
const newSnapshot = loadedSettings.getSnapshot();
expect(newSnapshot).not.toBe(oldSnapshot);
expect(newSnapshot.user.settings).not.toBe(oldUserRef);
expect(newSnapshot.user.settings.ui?.theme).toBe('high-contrast');
expect(newSnapshot.system.settings).not.toBe(oldSnapshot.system.settings);
expect(mockCoreEvents.emitSettingsChanged).toHaveBeenCalled();
});
});
describe('Security and Sandbox', () => {
let originalArgv: string[];
let originalEnv: NodeJS.ProcessEnv;
+48
View File
@@ -10,6 +10,7 @@ import { platform } from 'node:os';
import * as dotenv from 'dotenv';
import process from 'node:process';
import {
CoreEvent,
FatalConfigError,
GEMINI_DIR,
getErrorMessage,
@@ -284,6 +285,20 @@ export function createTestMergedSettings(
) as MergedSettings;
}
/**
* An immutable snapshot of settings state.
* Used with useSyncExternalStore for reactive updates.
*/
export interface LoadedSettingsSnapshot {
system: SettingsFile;
systemDefaults: SettingsFile;
user: SettingsFile;
workspace: SettingsFile;
isTrusted: boolean;
errors: SettingsError[];
merged: MergedSettings;
}
export class LoadedSettings {
constructor(
system: SettingsFile,
@@ -303,6 +318,7 @@ export class LoadedSettings {
: this.createEmptyWorkspace(workspace);
this.errors = errors;
this._merged = this.computeMergedSettings();
this._snapshot = this.computeSnapshot();
}
readonly system: SettingsFile;
@@ -314,6 +330,7 @@ export class LoadedSettings {
private _workspaceFile: SettingsFile;
private _merged: MergedSettings;
private _snapshot: LoadedSettingsSnapshot;
private _remoteAdminSettings: Partial<Settings> | undefined;
get merged(): MergedSettings {
@@ -368,6 +385,36 @@ export class LoadedSettings {
return merged;
}
private computeSnapshot(): LoadedSettingsSnapshot {
const cloneSettingsFile = (file: SettingsFile): SettingsFile => ({
path: file.path,
rawJson: file.rawJson,
settings: structuredClone(file.settings),
originalSettings: structuredClone(file.originalSettings),
});
return {
system: cloneSettingsFile(this.system),
systemDefaults: cloneSettingsFile(this.systemDefaults),
user: cloneSettingsFile(this.user),
workspace: cloneSettingsFile(this.workspace),
isTrusted: this.isTrusted,
errors: [...this.errors],
merged: structuredClone(this._merged),
};
}
// Passing this along with getSnapshot to useSyncExternalStore allows for idiomatic reactivity on settings changes
// React will pass a listener fn into this subscribe fn
// that listener fn will perform an object identity check on the snapshot and trigger a React re render if the snapshot has changed
subscribe(listener: () => void): () => void {
coreEvents.on(CoreEvent.SettingsChanged, listener);
return () => coreEvents.off(CoreEvent.SettingsChanged, listener);
}
getSnapshot(): LoadedSettingsSnapshot {
return this._snapshot;
}
forScope(scope: LoadableSettingScope): SettingsFile {
switch (scope) {
case SettingScope.User:
@@ -409,6 +456,7 @@ export class LoadedSettings {
}
this._merged = this.computeMergedSettings();
this._snapshot = this.computeSnapshot();
coreEvents.emitSettingsChanged();
}
@@ -186,6 +186,9 @@ describe('SettingsSchema', () => {
expect(getSettingsSchema().ui.properties.hideTips.showInDialog).toBe(
true,
);
expect(
getSettingsSchema().ui.properties.showShortcutsHint.showInDialog,
).toBe(true);
expect(getSettingsSchema().ui.properties.hideBanner.showInDialog).toBe(
true,
);
@@ -328,6 +331,28 @@ describe('SettingsSchema', () => {
).toBe('Enable debug logging of keystrokes to the console.');
});
it('should have showShortcutsHint setting in schema', () => {
expect(getSettingsSchema().ui.properties.showShortcutsHint).toBeDefined();
expect(getSettingsSchema().ui.properties.showShortcutsHint.type).toBe(
'boolean',
);
expect(getSettingsSchema().ui.properties.showShortcutsHint.category).toBe(
'UI',
);
expect(getSettingsSchema().ui.properties.showShortcutsHint.default).toBe(
true,
);
expect(
getSettingsSchema().ui.properties.showShortcutsHint.requiresRestart,
).toBe(false);
expect(
getSettingsSchema().ui.properties.showShortcutsHint.showInDialog,
).toBe(true);
expect(
getSettingsSchema().ui.properties.showShortcutsHint.description,
).toBe('Show the "? for shortcuts" hint above the input.');
});
it('should have enableAgents setting in schema', () => {
const setting = getSettingsSchema().experimental.properties.enableAgents;
expect(setting).toBeDefined();
+21 -3
View File
@@ -462,6 +462,15 @@ const SETTINGS_SCHEMA = {
description: 'Hide helpful tips in the UI',
showInDialog: true,
},
showShortcutsHint: {
type: 'boolean',
label: 'Show Shortcuts Hint',
category: 'UI',
requiresRestart: false,
default: true,
description: 'Show the "? for shortcuts" hint above the input.',
showInDialog: true,
},
hideBanner: {
type: 'boolean',
label: 'Hide Banner',
@@ -1462,7 +1471,7 @@ const SETTINGS_SCHEMA = {
label: 'Tool Output Masking',
category: 'Experimental',
requiresRestart: true,
ignoreInDocs: true,
ignoreInDocs: false,
default: {},
description:
'Advanced settings for tool output masking to manage context window efficiency.',
@@ -1473,9 +1482,9 @@ const SETTINGS_SCHEMA = {
label: 'Enable Tool Output Masking',
category: 'Experimental',
requiresRestart: true,
default: false,
default: true,
description: 'Enables tool output masking to save tokens.',
showInDialog: false,
showInDialog: true,
},
toolProtectionThreshold: {
type: 'number',
@@ -1519,6 +1528,15 @@ const SETTINGS_SCHEMA = {
'Enable local and remote subagents. Warning: Experimental feature, uses YOLO mode for subagents',
showInDialog: false,
},
enableAgentHarness: {
type: 'boolean',
label: 'Enable Agent Harness',
category: 'Experimental',
requiresRestart: true,
default: false,
description: 'Enable the new unified agent harness (experimental).',
showInDialog: false,
},
extensionManagement: {
type: 'boolean',
label: 'Extension Management',
+12 -19
View File
@@ -238,18 +238,15 @@ vi.mock('./validateNonInterActiveAuth.js', () => ({
}));
describe('gemini.tsx main function', () => {
let originalEnvGeminiSandbox: string | undefined;
let originalEnvSandbox: string | undefined;
let originalIsTTY: boolean | undefined;
let initialUnhandledRejectionListeners: NodeJS.UnhandledRejectionListener[] =
[];
beforeEach(() => {
// Store and clear sandbox-related env variables to ensure a consistent test environment
originalEnvGeminiSandbox = process.env['GEMINI_SANDBOX'];
originalEnvSandbox = process.env['SANDBOX'];
delete process.env['GEMINI_SANDBOX'];
delete process.env['SANDBOX'];
vi.stubEnv('GEMINI_SANDBOX', '');
vi.stubEnv('SANDBOX', '');
vi.stubEnv('SHPOOL_SESSION_NAME', '');
initialUnhandledRejectionListeners =
process.listeners('unhandledRejection');
@@ -260,18 +257,6 @@ describe('gemini.tsx main function', () => {
});
afterEach(() => {
// Restore original env variables
if (originalEnvGeminiSandbox !== undefined) {
process.env['GEMINI_SANDBOX'] = originalEnvGeminiSandbox;
} else {
delete process.env['GEMINI_SANDBOX'];
}
if (originalEnvSandbox !== undefined) {
process.env['SANDBOX'] = originalEnvSandbox;
} else {
delete process.env['SANDBOX'];
}
const currentListeners = process.listeners('unhandledRejection');
currentListeners.forEach((listener) => {
if (!initialUnhandledRejectionListeners.includes(listener)) {
@@ -282,6 +267,7 @@ describe('gemini.tsx main function', () => {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
(process.stdin as any).isTTY = originalIsTTY;
vi.unstubAllEnvs();
vi.restoreAllMocks();
});
@@ -481,6 +467,8 @@ describe('gemini.tsx main function kitty protocol', () => {
allowedMcpServerNames: undefined,
allowedTools: undefined,
experimentalAcp: undefined,
experimentalAgentHarness: undefined,
experimentalEnableAgents: undefined,
extensions: undefined,
listExtensions: undefined,
includeDirectories: undefined,
@@ -1209,7 +1197,12 @@ describe('startInteractiveUI', () => {
registerTelemetryConfig: vi.fn(),
}));
beforeEach(() => {
vi.stubEnv('SHPOOL_SESSION_NAME', '');
});
afterEach(() => {
vi.unstubAllEnvs();
vi.restoreAllMocks();
});
@@ -1308,7 +1301,7 @@ describe('startInteractiveUI', () => {
// Verify all startup tasks were called
expect(getVersion).toHaveBeenCalledTimes(1);
expect(registerCleanup).toHaveBeenCalledTimes(3);
expect(registerCleanup).toHaveBeenCalledTimes(4);
// Verify cleanup handler is registered with unmount function
const cleanupFn = vi.mocked(registerCleanup).mock.calls[0][0];
+33 -20
View File
@@ -57,8 +57,8 @@ import {
writeToStderr,
disableMouseEvents,
enableMouseEvents,
enterAlternateScreen,
disableLineWrapping,
enableLineWrapping,
shouldEnterAlternateScreen,
startupProfiler,
ExitCodes,
@@ -89,6 +89,7 @@ import { SessionStatsProvider } from './ui/contexts/SessionContext.js';
import { VimModeProvider } from './ui/contexts/VimModeContext.js';
import { KeypressProvider } from './ui/contexts/KeypressContext.js';
import { useKittyKeyboardProtocol } from './ui/hooks/useKittyKeyboardProtocol.js';
import { useTerminalSize } from './ui/hooks/useTerminalSize.js';
import {
relaunchAppInChildProcess,
relaunchOnExitCode,
@@ -214,9 +215,13 @@ export async function startInteractiveUI(
const { stdout: inkStdout, stderr: inkStderr } = createWorkingStdio();
const isShpool = !!process.env['SHPOOL_SESSION_NAME'];
// Create wrapper component to use hooks inside render
const AppWrapper = () => {
useKittyKeyboardProtocol();
const { columns, rows } = useTerminalSize();
return (
<SettingsContext.Provider value={settings}>
<KeypressProvider
@@ -234,6 +239,7 @@ export async function startInteractiveUI(
<SessionStatsProvider>
<VimModeProvider settings={settings}>
<AppContainer
key={`${columns}-${rows}`}
config={config}
startupWarnings={startupWarnings}
version={version}
@@ -250,6 +256,17 @@ export async function startInteractiveUI(
);
};
if (isShpool) {
// Wait a moment for shpool to stabilize terminal size and state.
// shpool is a persistence tool that restores terminal state by replaying it.
// This delay gives shpool time to finish its restoration replay and send
// the actual terminal size (often via an immediate SIGWINCH) before we
// render the first TUI frame. Without this, the first frame may be
// garbled or rendered at an incorrect size, which disabling incremental
// rendering alone cannot fix for the initial frame.
await new Promise((resolve) => setTimeout(resolve, 100));
}
const instance = render(
process.env['DEBUG'] ? (
<React.StrictMode>
@@ -273,10 +290,19 @@ export async function startInteractiveUI(
patchConsole: false,
alternateBuffer: useAlternateBuffer,
incrementalRendering:
settings.merged.ui.incrementalRendering !== false && useAlternateBuffer,
settings.merged.ui.incrementalRendering !== false &&
useAlternateBuffer &&
!isShpool,
},
);
if (useAlternateBuffer) {
disableLineWrapping();
registerCleanup(() => {
enableLineWrapping();
});
}
checkForUpdates(settings)
.then((info) => {
handleAutoUpdate(info, settings, config.getProjectRoot());
@@ -590,26 +616,13 @@ export async function main() {
// input showing up in the output.
process.stdin.setRawMode(true);
if (
shouldEnterAlternateScreen(
isAlternateBufferEnabled(settings),
config.getScreenReader(),
)
) {
enterAlternateScreen();
disableLineWrapping();
// Ink will cleanup so there is no need for us to manually cleanup.
}
// This cleanup isn't strictly needed but may help in certain situations.
const restoreRawMode = () => {
process.on('SIGTERM', () => {
process.stdin.setRawMode(wasRaw);
};
process.off('SIGTERM', restoreRawMode);
process.on('SIGTERM', restoreRawMode);
process.off('SIGINT', restoreRawMode);
process.on('SIGINT', restoreRawMode);
});
process.on('SIGINT', () => {
process.stdin.setRawMode(wasRaw);
});
}
await setupTerminalAndTheme(config, settings);
+102 -126
View File
@@ -84,7 +84,7 @@ vi.mock('@google/gemini-cli-core', async (importOriginal) => {
};
});
import ansiEscapes from 'ansi-escapes';
import { type LoadedSettings, mergeSettings } from '../config/settings.js';
import { mergeSettings, type LoadedSettings } from '../config/settings.js';
import type { InitializationResult } from '../core/initializer.js';
import { useQuotaAndFallback } from './hooks/useQuotaAndFallback.js';
import { UIStateContext, type UIState } from './contexts/UIStateContext.js';
@@ -92,6 +92,7 @@ import {
UIActionsContext,
type UIActions,
} from './contexts/UIActionsContext.js';
import { KeypressProvider } from './contexts/KeypressContext.js';
// Mock useStdout to capture terminal title writes
vi.mock('ink', async (importOriginal) => {
@@ -133,7 +134,6 @@ vi.mock('./hooks/useGeminiStream.js');
vi.mock('./hooks/vim.js');
vi.mock('./hooks/useFocus.js');
vi.mock('./hooks/useBracketedPaste.js');
vi.mock('./hooks/useKeypress.js');
vi.mock('./hooks/useLoadingIndicator.js');
vi.mock('./hooks/useFolderTrust.js');
vi.mock('./hooks/useIdeTrustListener.js');
@@ -197,7 +197,7 @@ import { useTextBuffer } from './components/shared/text-buffer.js';
import { useLogger } from './hooks/useLogger.js';
import { useLoadingIndicator } from './hooks/useLoadingIndicator.js';
import { useInputHistoryStore } from './hooks/useInputHistoryStore.js';
import { useKeypress, type Key } from './hooks/useKeypress.js';
import { useKeypress } from './hooks/useKeypress.js';
import { measureElement } from 'ink';
import { useTerminalSize } from './hooks/useTerminalSize.js';
import {
@@ -232,13 +232,15 @@ describe('AppContainer State Management', () => {
resumedSessionData?: ResumedSessionData;
} = {}) => (
<SettingsContext.Provider value={settings}>
<AppContainer
config={config}
version={version}
initializationResult={initResult}
startupWarnings={startupWarnings}
resumedSessionData={resumedSessionData}
/>
<KeypressProvider config={config}>
<AppContainer
config={config}
version={version}
initializationResult={initResult}
startupWarnings={startupWarnings}
resumedSessionData={resumedSessionData}
/>
</KeypressProvider>
</SettingsContext.Provider>
);
@@ -268,7 +270,6 @@ describe('AppContainer State Management', () => {
const mockedUseTextBuffer = useTextBuffer as Mock;
const mockedUseLogger = useLogger as Mock;
const mockedUseLoadingIndicator = useLoadingIndicator as Mock;
const mockedUseKeypress = useKeypress as Mock;
const mockedUseInputHistoryStore = useInputHistoryStore as Mock;
const mockedUseHookDisplayState = useHookDisplayState as Mock;
const mockedUseTerminalTheme = useTerminalTheme as Mock;
@@ -1770,47 +1771,36 @@ describe('AppContainer State Management', () => {
});
describe('Keyboard Input Handling (CTRL+C / CTRL+D)', () => {
let handleGlobalKeypress: (key: Key) => boolean;
let mockHandleSlashCommand: Mock;
let mockCancelOngoingRequest: Mock;
let rerender: () => void;
let unmount: () => void;
let stdin: ReturnType<typeof render>['stdin'];
// Helper function to reduce boilerplate in tests
const setupKeypressTest = async () => {
const renderResult = renderAppContainer();
stdin = renderResult.stdin;
await act(async () => {
vi.advanceTimersByTime(0);
});
rerender = () => renderResult.rerender(getAppContainer());
rerender = () => {
renderResult.rerender(getAppContainer());
};
unmount = renderResult.unmount;
};
const pressKey = (key: Partial<Key>, times = 1) => {
const pressKey = (sequence: string, times = 1) => {
for (let i = 0; i < times; i++) {
act(() => {
handleGlobalKeypress({
name: 'c',
shift: false,
alt: false,
ctrl: false,
cmd: false,
...key,
} as Key);
stdin.write(sequence);
});
rerender();
}
};
beforeEach(() => {
// Capture the keypress handler from the AppContainer
mockedUseKeypress.mockImplementation(
(callback: (key: Key) => boolean) => {
handleGlobalKeypress = callback;
},
);
// Mock slash command handler
mockHandleSlashCommand = vi.fn();
mockedUseSlashCommandProcessor.mockReturnValue({
@@ -1855,7 +1845,7 @@ describe('AppContainer State Management', () => {
});
await setupKeypressTest();
pressKey({ name: 'c', ctrl: true });
pressKey('\x03'); // Ctrl+C
expect(mockCancelOngoingRequest).toHaveBeenCalledTimes(1);
expect(mockHandleSlashCommand).not.toHaveBeenCalled();
@@ -1865,7 +1855,7 @@ describe('AppContainer State Management', () => {
it('should quit on second press', async () => {
await setupKeypressTest();
pressKey({ name: 'c', ctrl: true }, 2);
pressKey('\x03', 2); // Ctrl+C
expect(mockCancelOngoingRequest).toHaveBeenCalledTimes(2);
expect(mockHandleSlashCommand).toHaveBeenCalledWith(
@@ -1880,7 +1870,7 @@ describe('AppContainer State Management', () => {
it('should reset press count after a timeout', async () => {
await setupKeypressTest();
pressKey({ name: 'c', ctrl: true });
pressKey('\x03'); // Ctrl+C
expect(mockHandleSlashCommand).not.toHaveBeenCalled();
// Advance timer past the reset threshold
@@ -1888,7 +1878,7 @@ describe('AppContainer State Management', () => {
vi.advanceTimersByTime(WARNING_PROMPT_DURATION_MS + 1);
});
pressKey({ name: 'c', ctrl: true });
pressKey('\x03'); // Ctrl+C
expect(mockHandleSlashCommand).not.toHaveBeenCalled();
unmount();
});
@@ -1898,7 +1888,7 @@ describe('AppContainer State Management', () => {
it('should quit on second press if buffer is empty', async () => {
await setupKeypressTest();
pressKey({ name: 'd', ctrl: true }, 2);
pressKey('\x04', 2); // Ctrl+D
expect(mockHandleSlashCommand).toHaveBeenCalledWith(
'/quit',
@@ -1909,7 +1899,7 @@ describe('AppContainer State Management', () => {
unmount();
});
it('should NOT quit if buffer is not empty (bubbles from InputPrompt)', async () => {
it('should NOT quit if buffer is not empty', async () => {
mockedUseTextBuffer.mockReturnValue({
text: 'some text',
setText: vi.fn(),
@@ -1919,30 +1909,12 @@ describe('AppContainer State Management', () => {
});
await setupKeypressTest();
// Capture return value
let result = true;
const originalPressKey = (key: Partial<Key>) => {
act(() => {
result = handleGlobalKeypress({
name: 'd',
shift: false,
alt: false,
ctrl: true,
cmd: false,
...key,
} as Key);
});
rerender();
};
pressKey('\x04'); // Ctrl+D
originalPressKey({ name: 'd', ctrl: true });
// AppContainer's handler should return true if it reaches it
expect(result).toBe(true);
// But it should only be called once, so count is 1, not quitting yet.
// Should only be called once, so count is 1, not quitting yet.
expect(mockHandleSlashCommand).not.toHaveBeenCalled();
originalPressKey({ name: 'd', ctrl: true });
pressKey('\x04'); // Ctrl+D
// Now count is 2, it should quit.
expect(mockHandleSlashCommand).toHaveBeenCalledWith(
'/quit',
@@ -1956,7 +1928,7 @@ describe('AppContainer State Management', () => {
it('should reset press count after a timeout', async () => {
await setupKeypressTest();
pressKey({ name: 'd', ctrl: true });
pressKey('\x04'); // Ctrl+D
expect(mockHandleSlashCommand).not.toHaveBeenCalled();
// Advance timer past the reset threshold
@@ -1964,7 +1936,7 @@ describe('AppContainer State Management', () => {
vi.advanceTimersByTime(WARNING_PROMPT_DURATION_MS + 1);
});
pressKey({ name: 'd', ctrl: true });
pressKey('\x04'); // Ctrl+D
expect(mockHandleSlashCommand).not.toHaveBeenCalled();
unmount();
});
@@ -1982,7 +1954,7 @@ describe('AppContainer State Management', () => {
it('should focus shell input on Tab', async () => {
await setupKeypressTest();
pressKey({ name: 'tab', shift: false });
pressKey('\t');
expect(capturedUIState.embeddedShellFocused).toBe(true);
unmount();
@@ -1992,11 +1964,11 @@ describe('AppContainer State Management', () => {
await setupKeypressTest();
// Focus first
pressKey({ name: 'tab', shift: false });
pressKey('\t');
expect(capturedUIState.embeddedShellFocused).toBe(true);
// Unfocus via Shift+Tab
pressKey({ name: 'tab', shift: true });
pressKey('\x1b[Z');
expect(capturedUIState.embeddedShellFocused).toBe(false);
unmount();
});
@@ -2015,13 +1987,7 @@ describe('AppContainer State Management', () => {
// Focus it
act(() => {
handleGlobalKeypress({
name: 'tab',
shift: false,
alt: false,
ctrl: false,
cmd: false,
} as Key);
renderResult.stdin.write('\t');
});
expect(capturedUIState.embeddedShellFocused).toBe(true);
@@ -2056,7 +2022,7 @@ describe('AppContainer State Management', () => {
expect(capturedUIState.embeddedShellFocused).toBe(false);
// Press Tab
pressKey({ name: 'tab', shift: false });
pressKey('\t');
// Should be focused
expect(capturedUIState.embeddedShellFocused).toBe(true);
@@ -2084,7 +2050,7 @@ describe('AppContainer State Management', () => {
expect(capturedUIState.embeddedShellFocused).toBe(false);
// Press Ctrl+B
pressKey({ name: 'b', ctrl: true });
pressKey('\x02');
// Should have toggled (closed) the shell
expect(mockToggleBackgroundShell).toHaveBeenCalled();
@@ -2113,7 +2079,7 @@ describe('AppContainer State Management', () => {
});
// Press Ctrl+B
pressKey({ name: 'b', ctrl: true });
pressKey('\x02');
// Should have toggled (shown) the shell
expect(mockToggleBackgroundShell).toHaveBeenCalled();
@@ -2126,11 +2092,14 @@ describe('AppContainer State Management', () => {
});
describe('Copy Mode (CTRL+S)', () => {
let handleGlobalKeypress: (key: Key) => boolean;
let rerender: () => void;
let unmount: () => void;
let stdin: ReturnType<typeof render>['stdin'];
const setupCopyModeTest = async (isAlternateMode = false) => {
const setupCopyModeTest = async (
isAlternateMode = false,
childHandler?: Mock,
) => {
// Update settings for this test run
const defaultMergedSettings = mergeSettings({}, {}, {}, {}, true);
const testSettings = {
@@ -2144,23 +2113,39 @@ describe('AppContainer State Management', () => {
},
} as unknown as LoadedSettings;
const renderResult = renderAppContainer({ settings: testSettings });
function TestChild() {
useKeypress(childHandler || (() => {}), {
isActive: !!childHandler,
priority: true,
});
return null;
}
const getTree = (settings: LoadedSettings) => (
<SettingsContext.Provider value={settings}>
<KeypressProvider config={mockConfig}>
<AppContainer
config={mockConfig}
version="1.0.0"
initializationResult={mockInitResult}
/>
<TestChild />
</KeypressProvider>
</SettingsContext.Provider>
);
const renderResult = render(getTree(testSettings));
stdin = renderResult.stdin;
await act(async () => {
vi.advanceTimersByTime(0);
});
rerender = () =>
renderResult.rerender(getAppContainer({ settings: testSettings }));
rerender = () => renderResult.rerender(getTree(testSettings));
unmount = renderResult.unmount;
};
beforeEach(() => {
mocks.mockStdout.write.mockClear();
mockedUseKeypress.mockImplementation(
(callback: (key: Key) => boolean) => {
handleGlobalKeypress = callback;
},
);
vi.useFakeTimers();
});
@@ -2186,15 +2171,7 @@ describe('AppContainer State Management', () => {
mocks.mockStdout.write.mockClear(); // Clear initial enable call
act(() => {
handleGlobalKeypress({
name: 's',
shift: false,
alt: false,
ctrl: true,
cmd: false,
insertable: false,
sequence: '\x13',
});
stdin.write('\x13'); // Ctrl+S
});
rerender();
@@ -2213,30 +2190,14 @@ describe('AppContainer State Management', () => {
// Turn it on (disable mouse)
act(() => {
handleGlobalKeypress({
name: 's',
shift: false,
alt: false,
ctrl: true,
cmd: false,
insertable: false,
sequence: '\x13',
});
stdin.write('\x13'); // Ctrl+S
});
rerender();
expect(disableMouseEvents).toHaveBeenCalled();
// Turn it off (enable mouse)
act(() => {
handleGlobalKeypress({
name: 'any', // Any key should exit copy mode
shift: false,
alt: false,
ctrl: false,
cmd: false,
insertable: true,
sequence: 'a',
});
stdin.write('a'); // Any key should exit copy mode
});
rerender();
@@ -2249,15 +2210,7 @@ describe('AppContainer State Management', () => {
// Enter copy mode
act(() => {
handleGlobalKeypress({
name: 's',
shift: false,
alt: false,
ctrl: true,
cmd: false,
insertable: false,
sequence: '\x13',
});
stdin.write('\x13'); // Ctrl+S
});
rerender();
@@ -2265,15 +2218,7 @@ describe('AppContainer State Management', () => {
// Press any other key
act(() => {
handleGlobalKeypress({
name: 'a',
shift: false,
alt: false,
ctrl: false,
cmd: false,
insertable: true,
sequence: 'a',
});
stdin.write('a');
});
rerender();
@@ -2281,6 +2226,37 @@ describe('AppContainer State Management', () => {
expect(enableMouseEvents).toHaveBeenCalled();
unmount();
});
it('should have higher priority than other priority listeners when enabled', async () => {
// 1. Initial state with a child component's priority listener (already subscribed)
// It should NOT handle Ctrl+S so we can enter copy mode.
const childHandler = vi.fn().mockReturnValue(false);
await setupCopyModeTest(true, childHandler);
// 2. Enter copy mode
act(() => {
stdin.write('\x13'); // Ctrl+S
});
rerender();
// 3. Verify we are in copy mode
expect(disableMouseEvents).toHaveBeenCalled();
// 4. Press any key
childHandler.mockClear();
// Now childHandler should return true for other keys, simulating a greedy listener
childHandler.mockReturnValue(true);
act(() => {
stdin.write('a');
});
rerender();
// 5. Verify that the exit handler took priority and childHandler was NOT called
expect(childHandler).not.toHaveBeenCalled();
expect(enableMouseEvents).toHaveBeenCalled();
unmount();
});
}
});
});
+67 -52
View File
@@ -95,12 +95,14 @@ import { computeTerminalTitle } from '../utils/windowTitle.js';
import { useTextBuffer } from './components/shared/text-buffer.js';
import { useLogger } from './hooks/useLogger.js';
import { useGeminiStream } from './hooks/useGeminiStream.js';
import { useAgentHarness } from './hooks/useAgentHarness.js';
import { type BackgroundShell } from './hooks/shellCommandProcessor.js';
import { useVim } from './hooks/vim.js';
import { type LoadableSettingScope, SettingScope } from '../config/settings.js';
import { type InitializationResult } from '../core/initializer.js';
import { useFocus } from './hooks/useFocus.js';
import { useKeypress, type Key } from './hooks/useKeypress.js';
import { KeypressPriority } from './contexts/KeypressContext.js';
import { keyMatchers, Command } from './keyMatchers.js';
import { useLoadingIndicator } from './hooks/useLoadingIndicator.js';
import { useShellInactivityStatus } from './hooks/useShellInactivityStatus.js';
@@ -363,7 +365,9 @@ export const AppContainer = (props: AppContainerProps) => {
(async () => {
// Note: the program will not work if this fails so let errors be
// handled by the global catch.
await config.initialize();
if (!config.isInitialized()) {
await config.initialize();
}
setConfigInitialized(true);
startupProfiler.flush(config);
@@ -963,26 +967,9 @@ Logging in with Google... Restarting Gemini CLI to continue.
}
}, [pendingRestorePrompt, inputHistory, historyManager.history]);
const {
streamingState,
submitQuery,
initError,
pendingHistoryItems: pendingGeminiHistoryItems,
thought,
cancelOngoingRequest,
pendingToolCalls,
handleApprovalModeChange,
activePtyId,
loopDetectionConfirmationRequest,
lastOutputTime,
backgroundShellCount,
isBackgroundShellVisible,
toggleBackgroundShell,
backgroundCurrentShell,
backgroundShells,
dismissBackgroundShell,
retryStatus,
} = useGeminiStream(
const isAgentHarnessEnabled = config.isAgentHarnessEnabled();
const legacyStream = useGeminiStream(
config.getGeminiClient(),
historyManager.history,
historyManager.addItem,
@@ -1003,6 +990,40 @@ Logging in with Google... Restarting Gemini CLI to continue.
embeddedShellFocused,
);
const harnessStream = useAgentHarness(
historyManager.addItem,
config,
onCancelSubmit,
);
const activeStream = isAgentHarnessEnabled ? harnessStream : legacyStream;
const {
streamingState,
submitQuery,
initError,
pendingHistoryItems: pendingGeminiHistoryItems,
thought,
cancelOngoingRequest,
toolCalls: pendingToolCalls,
handleApprovalModeChange,
activePtyId: rawActivePtyId,
loopDetectionConfirmationRequest: rawLoopDetectionConfirmationRequest,
lastOutputTime,
backgroundShellCount,
isBackgroundShellVisible,
toggleBackgroundShell,
backgroundCurrentShell,
backgroundShells: rawBackgroundShells,
dismissBackgroundShell,
retryStatus: rawRetryStatus,
} = activeStream;
const activePtyId = rawActivePtyId ?? undefined;
const loopDetectionConfirmationRequest = rawLoopDetectionConfirmationRequest;
const backgroundShells = rawBackgroundShells;
const retryStatus = rawRetryStatus;
toggleBackgroundShellRef.current = toggleBackgroundShell;
isBackgroundShellVisibleRef.current = isBackgroundShellVisible;
backgroundShellsRef.current = backgroundShells;
@@ -1481,13 +1502,6 @@ Logging in with Google... Restarting Gemini CLI to continue.
const handleGlobalKeypress = useCallback(
(key: Key): boolean => {
if (copyModeEnabled) {
setCopyModeEnabled(false);
enableMouseEvents();
// We don't want to process any other keys if we're in copy mode.
return true;
}
// Debug log keystrokes if enabled
if (settings.merged.general.debugKeystrokeLogging) {
debugLogger.log('[DEBUG] Keystroke:', JSON.stringify(key));
@@ -1520,28 +1534,15 @@ Logging in with Google... Restarting Gemini CLI to continue.
if (keyMatchers[Command.SHOW_ERROR_DETAILS](key)) {
if (settings.merged.general.devtools) {
void (async () => {
try {
const { startDevToolsServer } = await import(
'../utils/devtoolsService.js'
);
const { openBrowserSecurely, shouldLaunchBrowser } = await import(
'@google/gemini-cli-core'
);
const url = await startDevToolsServer(config);
if (shouldLaunchBrowser()) {
try {
await openBrowserSecurely(url);
} catch (e) {
setShowErrorDetails((prev) => !prev);
debugLogger.warn('Failed to open browser securely:', e);
}
} else {
setShowErrorDetails((prev) => !prev);
}
} catch (e) {
setShowErrorDetails(true);
debugLogger.error('Failed to start DevTools server:', e);
}
const { toggleDevToolsPanel } = await import(
'../utils/devtoolsService.js'
);
await toggleDevToolsPanel(
config,
showErrorDetails,
() => setShowErrorDetails((prev) => !prev),
() => setShowErrorDetails(true),
);
})();
} else {
setShowErrorDetails((prev) => !prev);
@@ -1627,7 +1628,7 @@ Logging in with Google... Restarting Gemini CLI to continue.
return false;
} else if (keyMatchers[Command.TOGGLE_BACKGROUND_SHELL](key)) {
if (activePtyId) {
backgroundCurrentShell();
backgroundCurrentShell?.();
// After backgrounding, we explicitly do NOT show or focus the background UI.
} else {
toggleBackgroundShell();
@@ -1668,7 +1669,6 @@ Logging in with Google... Restarting Gemini CLI to continue.
settings.merged.general.debugKeystrokeLogging,
refreshStatic,
setCopyModeEnabled,
copyModeEnabled,
isAlternateBuffer,
backgroundCurrentShell,
toggleBackgroundShell,
@@ -1679,11 +1679,26 @@ Logging in with Google... Restarting Gemini CLI to continue.
tabFocusTimeoutRef,
showTransientMessage,
settings.merged.general.devtools,
showErrorDetails,
],
);
useKeypress(handleGlobalKeypress, { isActive: true, priority: true });
useKeypress(
() => {
setCopyModeEnabled(false);
enableMouseEvents();
return true;
},
{
isActive: copyModeEnabled,
// We need to receive keypresses first so they do not bubble to other
// handlers.
priority: KeypressPriority.Critical,
},
);
useEffect(() => {
// Respect hideWindowTitle settings
if (settings.merged.ui.hideWindowTitle) return;
@@ -110,6 +110,7 @@ describe('ApiAuthDialog', () => {
keypressHandler({
name: keyName,
shift: false,
alt: false,
ctrl: false,
cmd: false,
sequence,
@@ -4,7 +4,7 @@
* SPDX-License-Identifier: Apache-2.0
*/
import { describe, it, expect, vi, afterEach } from 'vitest';
import { describe, it, expect, vi, afterEach, beforeEach } from 'vitest';
import { act } from 'react';
import { renderWithProviders } from '../../test-utils/render.js';
import { waitFor } from '../../test-utils/async.js';
@@ -21,6 +21,14 @@ const writeKey = (stdin: { write: (data: string) => void }, key: string) => {
};
describe('AskUserDialog', () => {
// Ensure keystrokes appear spaced in time to avoid bufferFastReturn
// converting Enter into Shift+Enter during synchronous test execution.
let mockTime: number;
beforeEach(() => {
mockTime = 0;
vi.spyOn(Date, 'now').mockImplementation(() => (mockTime += 50));
});
afterEach(() => {
vi.restoreAllMocks();
});
@@ -158,6 +166,57 @@ describe('AskUserDialog', () => {
});
});
it('supports multi-line input for "Other" option in choice questions', async () => {
const authQuestionWithOther: Question[] = [
{
question: 'Which authentication method?',
header: 'Auth',
options: [{ label: 'OAuth 2.0', description: '' }],
multiSelect: false,
},
];
const onSubmit = vi.fn();
const { stdin, lastFrame } = renderWithProviders(
<AskUserDialog
questions={authQuestionWithOther}
onSubmit={onSubmit}
onCancel={vi.fn()}
width={120}
/>,
{ width: 120 },
);
// Navigate to "Other" option
writeKey(stdin, '\x1b[B'); // Down to "Other"
// Type first line
for (const char of 'Line 1') {
writeKey(stdin, char);
}
// Insert newline using \ + Enter (handled by bufferBackslashEnter)
writeKey(stdin, '\\');
writeKey(stdin, '\r');
// Type second line
for (const char of 'Line 2') {
writeKey(stdin, char);
}
await waitFor(() => {
expect(lastFrame()).toContain('Line 1');
expect(lastFrame()).toContain('Line 2');
});
// Press Enter to submit
writeKey(stdin, '\r');
await waitFor(() => {
expect(onSubmit).toHaveBeenCalledWith({ '0': 'Line 1\nLine 2' });
});
});
describe.each([
{ useAlternateBuffer: true, expectedArrows: false },
{ useAlternateBuffer: false, expectedArrows: true },
@@ -763,7 +822,7 @@ describe('AskUserDialog', () => {
});
});
it('does not submit empty text', () => {
it('submits empty text as unanswered', async () => {
const textQuestion: Question[] = [
{
question: 'Enter the class name:',
@@ -785,8 +844,9 @@ describe('AskUserDialog', () => {
writeKey(stdin, '\r');
// onSubmit should not be called for empty text
expect(onSubmit).not.toHaveBeenCalled();
await waitFor(() => {
expect(onSubmit).toHaveBeenCalledWith({});
});
});
it('clears text on Ctrl+C', async () => {
@@ -93,6 +93,7 @@ type AskUserDialogAction =
payload: {
index: number;
answer: string;
submit?: boolean;
};
}
| { type: 'SET_EDITING_CUSTOM'; payload: { isEditing: boolean } }
@@ -114,7 +115,7 @@ function askUserDialogReducerLogic(
switch (action.type) {
case 'SET_ANSWER': {
const { index, answer } = action.payload;
const { index, answer, submit } = action.payload;
const hasAnswer =
answer !== undefined && answer !== null && answer.trim() !== '';
const newAnswers = { ...state.answers };
@@ -128,6 +129,7 @@ function askUserDialogReducerLogic(
return {
...state,
answers: newAnswers,
submitted: submit ? true : state.submitted,
};
}
case 'SET_EDITING_CUSTOM': {
@@ -283,8 +285,8 @@ const TextQuestionView: React.FC<TextQuestionViewProps> = ({
const buffer = useTextBuffer({
initialText: initialAnswer,
viewport: { width: Math.max(1, bufferWidth), height: 1 },
singleLine: true,
viewport: { width: Math.max(1, bufferWidth), height: 3 },
singleLine: false,
});
const { text: textValue } = buffer;
@@ -317,9 +319,7 @@ const TextQuestionView: React.FC<TextQuestionViewProps> = ({
const handleSubmit = useCallback(
(val: string) => {
if (val.trim()) {
onAnswer(val.trim());
}
onAnswer(val.trim());
},
[onAnswer],
);
@@ -561,8 +561,8 @@ const ChoiceQuestionView: React.FC<ChoiceQuestionViewProps> = ({
const customBuffer = useTextBuffer({
initialText: initialCustomText,
viewport: { width: Math.max(1, bufferWidth), height: 1 },
singleLine: true,
viewport: { width: Math.max(1, bufferWidth), height: 3 },
singleLine: false,
});
const customOptionText = customBuffer.text;
@@ -850,9 +850,22 @@ const ChoiceQuestionView: React.FC<ChoiceQuestionViewProps> = ({
buffer={customBuffer}
placeholder={placeholder}
focus={context.isSelected}
onSubmit={() => handleSelect(optionItem)}
onSubmit={(val) => {
if (question.multiSelect) {
const fullAnswer = buildAnswerString(
selectedIndices,
true,
val,
);
if (fullAnswer) {
onAnswer(fullAnswer);
}
} else if (val.trim()) {
onAnswer(val.trim());
}
}}
/>
{isChecked && !question.multiSelect && (
{isChecked && !question.multiSelect && !context.isSelected && (
<Text color={theme.status.success}> </Text>
)}
</Box>
@@ -1012,21 +1025,27 @@ export const AskUserDialog: React.FC<AskUserDialogProps> = ({
(answer: string) => {
if (submitted) return;
dispatch({
type: 'SET_ANSWER',
payload: {
index: currentQuestionIndex,
answer,
},
});
if (questions.length > 1) {
dispatch({
type: 'SET_ANSWER',
payload: {
index: currentQuestionIndex,
answer,
},
});
goToNextTab();
} else {
dispatch({ type: 'SUBMIT' });
dispatch({
type: 'SET_ANSWER',
payload: {
index: currentQuestionIndex,
answer,
submit: true,
},
});
}
},
[currentQuestionIndex, questions.length, submitted, goToNextTab],
[currentQuestionIndex, questions, submitted, goToNextTab],
);
const handleReviewSubmit = useCallback(() => {
@@ -650,6 +650,19 @@ describe('Composer', () => {
});
describe('Shortcuts Hint', () => {
it('hides shortcuts hint when showShortcutsHint setting is false', () => {
const uiState = createMockUIState();
const settings = createMockSettings({
ui: {
showShortcutsHint: false,
},
});
const { lastFrame } = renderComposer(uiState, settings);
expect(lastFrame()).not.toContain('ShortcutsHint');
});
it('hides shortcuts hint when a action is required (e.g. dialog is open)', () => {
const uiState = createMockUIState({
customDialog: (
+2 -1
View File
@@ -133,7 +133,8 @@ export const Composer = ({ isFocused = true }: { isFocused?: boolean }) => {
flexDirection="column"
alignItems={isNarrow ? 'flex-start' : 'flex-end'}
>
{!hasPendingActionRequired && <ShortcutsHint />}
{settings.merged.ui.showShortcutsHint &&
!hasPendingActionRequired && <ShortcutsHint />}
</Box>
</Box>
{uiState.shortcutsHelpVisible && <ShortcutsHelp />}
@@ -47,6 +47,13 @@ const writeKey = (stdin: { write: (data: string) => void }, key: string) => {
act(() => {
stdin.write(key);
});
// Advance timers to simulate time passing between keystrokes.
// This avoids bufferFastReturn converting Enter to Shift+Enter.
if (vi.isFakeTimers()) {
act(() => {
vi.advanceTimersByTime(50);
});
}
};
describe('ExitPlanModeDialog', () => {
@@ -234,7 +241,6 @@ Implement a comprehensive authentication system with multiple providers.
// Navigate to feedback option
writeKey(stdin, '\x1b[B'); // Down arrow
writeKey(stdin, '\x1b[B'); // Down arrow
writeKey(stdin, '\r'); // Select to focus input
// Type feedback
for (const char of 'Add tests') {
@@ -512,7 +518,6 @@ Implement a comprehensive authentication system with multiple providers.
// Navigate to feedback option and start typing
writeKey(stdin, '\x1b[B'); // Down arrow
writeKey(stdin, '\x1b[B'); // Down arrow
writeKey(stdin, '\r'); // Select to focus input
// Type some feedback
for (const char of 'test') {
@@ -4296,6 +4296,30 @@ describe('InputPrompt', () => {
});
describe('shortcuts help visibility', () => {
it('opens shortcuts help with ? on empty prompt even when showShortcutsHint is false', async () => {
const setShortcutsHelpVisible = vi.fn();
const settings = createMockSettings({
ui: { showShortcutsHint: false },
});
const { stdin, unmount } = renderWithProviders(
<InputPrompt {...props} />,
{
settings,
uiActions: { setShortcutsHelpVisible },
},
);
await act(async () => {
stdin.write('?');
});
await waitFor(() => {
expect(setShortcutsHelpVisible).toHaveBeenCalledWith(true);
});
unmount();
});
it.each([
{
name: 'terminal paste event occurs',
@@ -110,7 +110,8 @@ export const Notifications = () => {
marginBottom={1}
>
<Text color={theme.status.error}>
Initialization Error: {initError}
Initialization Error:{' '}
{initError instanceof Error ? initError.message : initError}
</Text>
<Text color={theme.status.error}>
{' '}
@@ -54,14 +54,3 @@ exports[`<BackgroundShellDisplay /> > scrolls to active shell when list opens 1`
│ ● 2. tail -f log.txt (PID: 1002) │
└──────────────────────────────────────────────────────────────────────────────────────────────────┘"
`;
exports[`<BackgroundShellDisplay /> > selects the current process and closes the list when Ctrl+L is pressed in list view 1`] = `
"┌──────────────────────────────────────────────────────────────────────────────────────────────────┐
│ 1: npm sta... (PID: 1001) (Focused) Close (Ctrl+B) | Kill (Ctrl+K) | List (Ctrl+L) │
│ │
│ Select Process (Enter to select, Ctrl+K to kill, Esc to cancel): │
│ │
│ ● 1. npm start (PID: 1001) │
│ 2. tail -f log.txt (PID: 1002) │
└──────────────────────────────────────────────────────────────────────────────────────────────────┘"
`;
@@ -21,7 +21,7 @@ Files to Modify
Approves plan and allows tools to run automatically
2. Yes, manually accept edits
Approves plan but requires confirmation for each tool
● 3. Type your feedback...
● 3. Type your feedback...
Enter to submit · Esc to cancel"
`;
@@ -47,7 +47,7 @@ Files to Modify
Approves plan and allows tools to run automatically
2. Yes, manually accept edits
Approves plan but requires confirmation for each tool
● 3. Add tests
● 3. Add tests
Enter to submit · Esc to cancel"
`;
@@ -127,7 +127,7 @@ Files to Modify
Approves plan and allows tools to run automatically
2. Yes, manually accept edits
Approves plan but requires confirmation for each tool
● 3. Type your feedback...
● 3. Type your feedback...
Enter to submit · Esc to cancel"
`;
@@ -153,7 +153,7 @@ Files to Modify
Approves plan and allows tools to run automatically
2. Yes, manually accept edits
Approves plan but requires confirmation for each tool
● 3. Add tests
● 3. Add tests
Enter to submit · Esc to cancel"
`;
@@ -13,6 +13,7 @@ import chalk from 'chalk';
import { theme } from '../../semantic-colors.js';
import type { TextBuffer } from './text-buffer.js';
import { cpSlice, cpIndexToOffset } from '../../utils/textUtils.js';
import { keyMatchers, Command } from '../../keyMatchers.js';
export interface TextInputProps {
buffer: TextBuffer;
@@ -45,7 +46,7 @@ export function TextInput({
return true;
}
if (key.name === 'return' && onSubmit) {
if (keyMatchers[Command.SUBMIT](key) && onSubmit) {
onSubmit(text);
return true;
}
@@ -6,6 +6,7 @@
import { debugLogger, type Config } from '@google/gemini-cli-core';
import { useStdin } from 'ink';
import { MultiMap } from 'mnemonist';
import type React from 'react';
import {
createContext,
@@ -26,6 +27,13 @@ export const ESC_TIMEOUT = 50;
export const PASTE_TIMEOUT = 30_000;
export const FAST_RETURN_TIMEOUT = 30;
export enum KeypressPriority {
Low = -100,
Normal = 0,
High = 100,
Critical = 200,
}
// Parse the key itself
const KEY_INFO_MAP: Record<
string,
@@ -645,7 +653,10 @@ export interface Key {
export type KeypressHandler = (key: Key) => boolean | void;
interface KeypressContextValue {
subscribe: (handler: KeypressHandler, priority?: boolean) => void;
subscribe: (
handler: KeypressHandler,
priority?: KeypressPriority | boolean,
) => void;
unsubscribe: (handler: KeypressHandler) => void;
}
@@ -674,44 +685,75 @@ export function KeypressProvider({
}) {
const { stdin, setRawMode } = useStdin();
const prioritySubscribers = useRef<Set<KeypressHandler>>(new Set()).current;
const normalSubscribers = useRef<Set<KeypressHandler>>(new Set()).current;
const subscribersToPriority = useRef<Map<KeypressHandler, number>>(
new Map(),
).current;
const subscribers = useRef(
new MultiMap<number, KeypressHandler>(Set),
).current;
const sortedPriorities = useRef<number[]>([]);
const subscribe = useCallback(
(handler: KeypressHandler, priority = false) => {
const set = priority ? prioritySubscribers : normalSubscribers;
set.add(handler);
(
handler: KeypressHandler,
priority: KeypressPriority | boolean = KeypressPriority.Normal,
) => {
const p =
typeof priority === 'boolean'
? priority
? KeypressPriority.High
: KeypressPriority.Normal
: priority;
subscribersToPriority.set(handler, p);
const hadPriority = subscribers.has(p);
subscribers.set(p, handler);
if (!hadPriority) {
// Cache sorted priorities only when a new priority level is added
sortedPriorities.current = Array.from(subscribers.keys()).sort(
(a, b) => b - a,
);
}
},
[prioritySubscribers, normalSubscribers],
[subscribers, subscribersToPriority],
);
const unsubscribe = useCallback(
(handler: KeypressHandler) => {
prioritySubscribers.delete(handler);
normalSubscribers.delete(handler);
const p = subscribersToPriority.get(handler);
if (p !== undefined) {
subscribers.remove(p, handler);
subscribersToPriority.delete(handler);
if (!subscribers.has(p)) {
// Cache sorted priorities only when a priority level is completely removed
sortedPriorities.current = Array.from(subscribers.keys()).sort(
(a, b) => b - a,
);
}
}
},
[prioritySubscribers, normalSubscribers],
[subscribers, subscribersToPriority],
);
const broadcast = useCallback(
(key: Key) => {
// Process priority subscribers first, in reverse order (stack behavior: last subscribed is first to handle)
const priorityHandlers = Array.from(prioritySubscribers).reverse();
for (const handler of priorityHandlers) {
if (handler(key) === true) {
return;
}
}
// Use cached sorted priorities to avoid sorting on every keypress
for (const p of sortedPriorities.current) {
const set = subscribers.get(p);
if (!set) continue;
// Then process normal subscribers, also in reverse order
const normalHandlers = Array.from(normalSubscribers).reverse();
for (const handler of normalHandlers) {
if (handler(key) === true) {
return;
// Within a priority level, use stack behavior (last subscribed is first to handle)
const handlers = Array.from(set).reverse();
for (const handler of handlers) {
if (handler(key) === true) {
return;
}
}
}
},
[prioritySubscribers, normalSubscribers],
[subscribers],
);
useEffect(() => {
@@ -0,0 +1,167 @@
/**
* @license
* Copyright 2025 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import type React from 'react';
import { Component, type ReactNode } from 'react';
import { renderHook, render } from '../../test-utils/render.js';
import { act } from 'react';
import { describe, it, expect, vi, beforeEach } from 'vitest';
import { SettingsContext, useSettingsStore } from './SettingsContext.js';
import {
type LoadedSettings,
SettingScope,
type LoadedSettingsSnapshot,
type SettingsFile,
createTestMergedSettings,
} from '../../config/settings.js';
const createMockSettingsFile = (path: string): SettingsFile => ({
path,
settings: {},
originalSettings: {},
});
const mockSnapshot: LoadedSettingsSnapshot = {
system: createMockSettingsFile('/system'),
systemDefaults: createMockSettingsFile('/defaults'),
user: createMockSettingsFile('/user'),
workspace: createMockSettingsFile('/workspace'),
isTrusted: true,
errors: [],
merged: createTestMergedSettings({
ui: { theme: 'default-theme' },
}),
};
class ErrorBoundary extends Component<
{ children: ReactNode; onError: (error: Error) => void },
{ hasError: boolean }
> {
constructor(props: { children: ReactNode; onError: (error: Error) => void }) {
super(props);
this.state = { hasError: false };
}
static getDerivedStateFromError(_error: Error) {
return { hasError: true };
}
override componentDidCatch(error: Error) {
this.props.onError(error);
}
override render() {
if (this.state.hasError) {
return null;
}
return this.props.children;
}
}
const TestHarness = () => {
useSettingsStore();
return null;
};
describe('SettingsContext', () => {
let mockLoadedSettings: LoadedSettings;
let listeners: Array<() => void> = [];
beforeEach(() => {
listeners = [];
mockLoadedSettings = {
subscribe: vi.fn((listener: () => void) => {
listeners.push(listener);
return () => {
listeners = listeners.filter((l) => l !== listener);
};
}),
getSnapshot: vi.fn(() => mockSnapshot),
setValue: vi.fn(),
} as unknown as LoadedSettings;
});
const wrapper = ({ children }: { children: React.ReactNode }) => (
<SettingsContext.Provider value={mockLoadedSettings}>
{children}
</SettingsContext.Provider>
);
it('should provide the correct initial state', () => {
const { result } = renderHook(() => useSettingsStore(), { wrapper });
expect(result.current.settings.merged).toEqual(mockSnapshot.merged);
expect(result.current.settings.isTrusted).toBe(true);
});
it('should allow accessing settings for a specific scope', () => {
const { result } = renderHook(() => useSettingsStore(), { wrapper });
const userSettings = result.current.settings.forScope(SettingScope.User);
expect(userSettings).toBe(mockSnapshot.user);
const workspaceSettings = result.current.settings.forScope(
SettingScope.Workspace,
);
expect(workspaceSettings).toBe(mockSnapshot.workspace);
});
it('should trigger re-renders when settings change (external event)', () => {
const { result } = renderHook(() => useSettingsStore(), { wrapper });
expect(result.current.settings.merged.ui?.theme).toBe('default-theme');
const newSnapshot = {
...mockSnapshot,
merged: { ui: { theme: 'new-theme' } },
};
(
mockLoadedSettings.getSnapshot as ReturnType<typeof vi.fn>
).mockReturnValue(newSnapshot);
// Trigger the listeners (simulate coreEvents emission)
act(() => {
listeners.forEach((l) => l());
});
expect(result.current.settings.merged.ui?.theme).toBe('new-theme');
});
it('should call store.setValue when setSetting is called', () => {
const { result } = renderHook(() => useSettingsStore(), { wrapper });
act(() => {
result.current.setSetting(SettingScope.User, 'ui.theme', 'dark');
});
expect(mockLoadedSettings.setValue).toHaveBeenCalledWith(
SettingScope.User,
'ui.theme',
'dark',
);
});
it('should throw error if used outside provider', () => {
const onError = vi.fn();
// Suppress console.error (React logs error boundary info)
const consoleSpy = vi.spyOn(console, 'error').mockImplementation(() => {});
render(
<ErrorBoundary onError={onError}>
<TestHarness />
</ErrorBoundary>,
);
expect(onError).toHaveBeenCalledWith(
expect.objectContaining({
message: 'useSettingsStore must be used within a SettingsProvider',
}),
);
consoleSpy.mockRestore();
});
});
@@ -4,17 +4,81 @@
* SPDX-License-Identifier: Apache-2.0
*/
import React, { useContext } from 'react';
import type { LoadedSettings } from '../../config/settings.js';
import React, { useContext, useMemo, useSyncExternalStore } from 'react';
import type {
LoadableSettingScope,
LoadedSettings,
LoadedSettingsSnapshot,
SettingsFile,
} from '../../config/settings.js';
import { SettingScope } from '../../config/settings.js';
export const SettingsContext = React.createContext<LoadedSettings | undefined>(
undefined,
);
export const useSettings = () => {
export const useSettings = (): LoadedSettings => {
const context = useContext(SettingsContext);
if (context === undefined) {
throw new Error('useSettings must be used within a SettingsProvider');
}
return context;
};
export interface SettingsState extends LoadedSettingsSnapshot {
forScope: (scope: LoadableSettingScope) => SettingsFile;
}
export interface SettingsStoreValue {
settings: SettingsState;
setSetting: (
scope: LoadableSettingScope,
key: string,
value: unknown,
) => void;
}
// Components that call this hook will re render when a settings change event is emitted
export const useSettingsStore = (): SettingsStoreValue => {
const store = useContext(SettingsContext);
if (store === undefined) {
throw new Error('useSettingsStore must be used within a SettingsProvider');
}
// React passes a listener fn into the subscribe function
// When the listener runs, it re renders the component if the snapshot changed
const snapshot = useSyncExternalStore(
(listener) => store.subscribe(listener),
() => store.getSnapshot(),
);
const settings: SettingsState = useMemo(
() => ({
...snapshot,
forScope: (scope: LoadableSettingScope) => {
switch (scope) {
case SettingScope.User:
return snapshot.user;
case SettingScope.Workspace:
return snapshot.workspace;
case SettingScope.System:
return snapshot.system;
case SettingScope.SystemDefaults:
return snapshot.systemDefaults;
default:
throw new Error(`Invalid scope: ${scope}`);
}
},
}),
[snapshot],
);
return useMemo(
() => ({
settings,
setSetting: (scope: LoadableSettingScope, key: string, value: unknown) =>
store.setValue(scope, key, value),
}),
[settings, store],
);
};
@@ -98,7 +98,7 @@ export interface UIState {
permissionConfirmationRequest: PermissionConfirmationRequest | null;
geminiMdFileCount: number;
streamingState: StreamingState;
initError: string | null;
initError: string | Error | null;
pendingGeminiHistoryItems: HistoryItemWithoutId[];
thought: ThoughtSummary | null;
shellModeActive: boolean;
+7 -4
View File
@@ -61,10 +61,13 @@ export function mapToDisplay(
const displayName = call.tool?.displayName ?? call.request.name;
if (call.status === 'error') {
if (call.status === 'error' || !call.invocation) {
description = JSON.stringify(call.request.args);
} else {
description = call.invocation.getDescription();
}
if (call.tool) {
renderOutputAsMarkdown = call.tool.isOutputMarkdown;
}
@@ -86,12 +89,12 @@ export function mapToDisplay(
switch (call.status) {
case 'success':
resultDisplay = call.response.resultDisplay;
outputFile = call.response.outputFile;
resultDisplay = call.response?.resultDisplay;
outputFile = call.response?.outputFile;
break;
case 'error':
case 'cancelled':
resultDisplay = call.response.resultDisplay;
resultDisplay = call.response?.resultDisplay;
break;
case 'awaiting_approval':
correlationId = call.correlationId;
@@ -0,0 +1,190 @@
/**
* @license
* Copyright 2026 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import { describe, it, expect, vi, beforeEach, type Mock } from 'vitest';
import { act } from 'react';
import { renderHookWithProviders } from '../../test-utils/render.js';
import { useAgentHarness } from './useAgentHarness.js';
import {
GeminiEventType as ServerGeminiEventType,
ROOT_SCHEDULER_ID,
} from '@google/gemini-cli-core';
import { makeFakeConfig } from '../../../../core/src/test-utils/config.js';
import type {
Config,
ServerGeminiStreamEvent as GeminiEvent,
} from '@google/gemini-cli-core';
import { StreamingState, MessageType } from '../types.js';
vi.mock('@google/gemini-cli-core', async (importOriginal) => {
const actual =
await importOriginal<typeof import('@google/gemini-cli-core')>();
return {
...actual,
AgentFactory: {
createHarness: vi.fn(),
},
};
});
describe('useAgentHarness', () => {
let mockAddItem: Mock;
let mockConfig: Config;
let mockOnCancelSubmit: Mock;
beforeEach(() => {
mockAddItem = vi.fn();
mockConfig = makeFakeConfig();
mockOnCancelSubmit = vi.fn();
vi.spyOn(mockConfig, 'getToolRegistry').mockReturnValue({
getTool: vi.fn().mockReturnValue({
displayName: 'codebase_investigator',
createInvocation: vi.fn().mockReturnValue({
getDescription: () => 'Test Tool Description',
}),
}),
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any);
vi.spyOn(mockConfig, 'getMessageBus').mockReturnValue({
subscribe: vi.fn().mockReturnValue(vi.fn()),
unsubscribe: vi.fn(),
publish: vi.fn(),
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any);
vi.clearAllMocks();
});
it('initializes in Idle state', () => {
const { result } = renderHookWithProviders(() =>
useAgentHarness(mockAddItem, mockConfig, mockOnCancelSubmit),
);
expect(result.current.streamingState).toBe(StreamingState.Idle);
expect(result.current.isResponding).toBe(false);
});
it('updates state live during processEvent', async () => {
const { result } = renderHookWithProviders(() =>
useAgentHarness(mockAddItem, mockConfig, mockOnCancelSubmit),
);
// 1. Send content
await act(async () => {
result.current.processEvent({
type: ServerGeminiEventType.Content,
value: 'Hello',
} as GeminiEvent);
});
expect(result.current.streamingContent).toBe('Hello');
expect(result.current.streamingState).toBe(StreamingState.Responding);
// 2. Send thought
await act(async () => {
result.current.processEvent({
type: ServerGeminiEventType.Thought,
value: { subject: 'Thinking' },
} as GeminiEvent);
});
expect(result.current.thought?.subject).toBe('Thinking');
// 3. Send tool request
await act(async () => {
result.current.processEvent({
type: ServerGeminiEventType.ToolCallRequest,
value: {
name: 'tool_1',
callId: 'c1',
args: {},
schedulerId: ROOT_SCHEDULER_ID,
},
} as GeminiEvent);
});
expect(result.current.toolCalls).toHaveLength(1);
expect(result.current.toolCalls[0].request.name).toBe('tool_1');
});
it('merges subagent activity into active tool calls', async () => {
const { result } = renderHookWithProviders(() =>
useAgentHarness(mockAddItem, mockConfig, mockOnCancelSubmit),
);
// Start a delegation tool
await act(async () => {
result.current.processEvent({
type: ServerGeminiEventType.ToolCallRequest,
value: {
name: 'subagent_tool',
callId: 'c1',
args: {},
schedulerId: ROOT_SCHEDULER_ID,
},
} as GeminiEvent);
});
// Send subagent activity
await act(async () => {
result.current.processEvent({
type: ServerGeminiEventType.SubagentActivity,
value: {
agentName: 'codebase_investigator',
type: 'THOUGHT',
data: { subject: 'Analyzing logs' },
},
} as GeminiEvent);
});
// Verify the tool box resultDisplay was updated with the thought
expect(
// eslint-disable-next-line @typescript-eslint/no-explicit-any
(result.current.toolCalls[0] as any).response?.resultDisplay,
).toContain('🤖💭 Analyzing logs');
// Send another activity
await act(async () => {
result.current.processEvent({
type: ServerGeminiEventType.SubagentActivity,
value: {
agentName: 'codebase_investigator',
type: 'TOOL_CALL_START',
data: { name: 'list_directory' },
},
} as GeminiEvent);
});
expect(
// eslint-disable-next-line @typescript-eslint/no-explicit-any
(result.current.toolCalls[0] as any).response?.resultDisplay,
).toContain('🛠️ Calling codebase_investigator...');
});
it('flushes to history on TurnFinished', async () => {
const { result } = renderHookWithProviders(() =>
useAgentHarness(mockAddItem, mockConfig, mockOnCancelSubmit),
);
// Setup some state
await act(async () => {
result.current.processEvent({
type: ServerGeminiEventType.Content,
value: 'Done',
} as GeminiEvent);
result.current.processEvent({
type: ServerGeminiEventType.TurnFinished,
} as GeminiEvent);
});
expect(mockAddItem).toHaveBeenCalledWith(
expect.objectContaining({
type: MessageType.GEMINI,
text: 'Done',
}),
);
expect(result.current.streamingContent).toBe(''); // Should be cleared
});
});
@@ -0,0 +1,446 @@
/**
* @license
* Copyright 2026 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import { useState, useRef, useCallback, useEffect, useMemo } from 'react';
import {
GeminiEventType as ServerGeminiEventType,
ROOT_SCHEDULER_ID,
AgentFactory,
MessageBusType,
} from '@google/gemini-cli-core';
import type {
Config,
ServerGeminiStreamEvent as GeminiEvent,
ThoughtSummary,
RetryAttemptPayload,
ToolCallsUpdateMessage,
ValidatingToolCall,
} from '@google/gemini-cli-core';
import { type PartListUnion, type Part } from '@google/genai';
import {
StreamingState,
MessageType,
type HistoryItemWithoutId,
type LoopDetectionConfirmationRequest,
} from '../types.js';
import { useStateAndRef } from './useStateAndRef.js';
import type { UseHistoryManagerReturn } from './useHistoryManager.js';
import { mapToDisplay as mapTrackedToolCallsToDisplay } from './toolMapping.js';
import type { TrackedToolCall } from './useToolScheduler.js';
import { type BackgroundShell } from './shellReducer.js';
export interface UseAgentHarnessReturn {
streamingState: StreamingState;
isResponding: boolean;
thought: ThoughtSummary | null;
streamingContent: string;
toolCalls: TrackedToolCall[];
submitQuery: (query: PartListUnion) => Promise<void>;
processEvent: (event: GeminiEvent) => void;
cancelOngoingRequest: () => void;
reset: () => void;
// Legacy compatibility properties
initError: Error | null;
pendingHistoryItems: HistoryItemWithoutId[];
handleApprovalModeChange: (mode: string) => void;
activePtyId: number | null;
loopDetectionConfirmationRequest: LoopDetectionConfirmationRequest | null;
lastOutputTime: number;
backgroundShellCount: number;
isBackgroundShellVisible: boolean;
toggleBackgroundShell: () => void;
backgroundCurrentShell: (() => void) | null;
backgroundShells: Map<number, BackgroundShell>;
dismissBackgroundShell: (pid: number) => void;
retryStatus: RetryAttemptPayload | null;
}
/**
* A specialized hook for processing streams from the AgentHarness.
* COMPLETELY FORKED from useGeminiStream to ensure zero regressions in legacy mode.
*/
export const useAgentHarness = (
addItem: UseHistoryManagerReturn['addItem'],
config: Config,
onCancelSubmit: (fullReset: boolean) => void,
): UseAgentHarnessReturn => {
const [streamingState, setStreamingState] = useState<StreamingState>(
StreamingState.Idle,
);
const [streamingContent, setStreamingContent] = useState('');
const streamingContentRef = useRef('');
const [thought, thoughtRef, setThought] =
useStateAndRef<ThoughtSummary | null>(null);
// Tools for the CURRENT turn of the main agent
const [toolCalls, setToolCalls] = useState<TrackedToolCall[]>([]);
const toolCallsRef = useRef<TrackedToolCall[]>([]);
// Sync ref with state (still useful for some parts)
useEffect(() => {
toolCallsRef.current = toolCalls;
}, [toolCalls]);
const pushedToolCallIdsRef = useRef<Set<string>>(new Set());
// Listen to the MessageBus for live tool updates (e.g. from subagents or long-running tools)
useEffect(() => {
const bus = config.getMessageBus();
const handler = (event: ToolCallsUpdateMessage) => {
setToolCalls((prev) => {
const next = [...prev];
for (const coreCall of event.toolCalls) {
const index = next.findIndex(
(tc) => tc.request.callId === coreCall.request.callId,
);
if (index !== -1) {
next[index] = {
...next[index],
...coreCall,
};
}
}
toolCallsRef.current = next;
return next;
});
};
bus.subscribe(MessageBusType.TOOL_CALLS_UPDATE, handler);
return () => {
bus.unsubscribe(MessageBusType.TOOL_CALLS_UPDATE, handler);
};
}, [config]);
const pendingHistoryItems = useMemo(() => {
const items: HistoryItemWithoutId[] = [];
// Only show the top-level thought if we aren't currently executing tools (delegations)
// Subagent internal thoughts are merged into the tool box via SubagentActivity handler.
if (thought && toolCalls.length === 0) {
items.push({
type: MessageType.THINKING,
thought,
} as HistoryItemWithoutId);
}
if (toolCalls.length > 0) {
const unpushed = toolCalls.filter(
(tc) => !pushedToolCallIdsRef.current.has(tc.request.callId),
);
if (unpushed.length > 0) {
items.push(
mapToDisplayInternal(unpushed, {
borderBottom: true,
}),
);
}
}
if (streamingContent) {
items.push({ type: MessageType.GEMINI, text: streamingContent });
}
return items;
}, [thought, toolCalls, streamingContent]);
const abortControllerRef = useRef<AbortController | null>(null);
const reset = useCallback(() => {
setStreamingState(StreamingState.Idle);
setStreamingContent('');
streamingContentRef.current = '';
setThought(null);
setToolCalls([]);
toolCallsRef.current = [];
pushedToolCallIdsRef.current.clear();
}, [setThought]);
const cancelOngoingRequest = useCallback(() => {
if (abortControllerRef.current) {
abortControllerRef.current.abort();
}
onCancelSubmit(true);
reset();
}, [onCancelSubmit, reset]);
const processEvent = useCallback(
(event: GeminiEvent) => {
switch (event.type) {
case ServerGeminiEventType.Content:
setStreamingState(StreamingState.Responding);
{
const nextContent =
streamingContentRef.current + (event.value || '');
streamingContentRef.current = nextContent;
setStreamingContent(nextContent);
}
break;
case ServerGeminiEventType.Thought:
setThought(event.value);
break;
case ServerGeminiEventType.ToolCallRequest:
{
setThought(null);
const tool = config.getToolRegistry().getTool(event.value.name);
// eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-type-assertion
const invocation = (tool as any)?.createInvocation?.(
event.value.args,
config.getMessageBus(),
);
// In Harness mode, top-level calls might not have schedulerId set yet.
// We default to ROOT_SCHEDULER_ID to ensure they are visible.
// eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
const newCall: TrackedToolCall = {
request: {
...event.value,
schedulerId: event.value.schedulerId || ROOT_SCHEDULER_ID,
},
status: 'validating',
schedulerId: event.value.schedulerId || ROOT_SCHEDULER_ID,
tool: tool || undefined,
invocation: invocation || undefined,
} as ValidatingToolCall;
const nextCalls = [...toolCallsRef.current, newCall];
toolCallsRef.current = nextCalls;
setToolCalls(nextCalls);
}
break;
case ServerGeminiEventType.ToolCallResponse:
{
const response = event.value;
const nextCalls = toolCallsRef.current.map((tc) =>
tc.request.callId === response.callId
? // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
({
...tc,
status: 'success',
response,
} as unknown as TrackedToolCall)
: tc,
);
toolCallsRef.current = nextCalls;
setToolCalls(nextCalls);
}
break;
case ServerGeminiEventType.TurnFinished:
// MAIN AGENT turn finished. Flush current state to history.
if (thoughtRef.current) {
addItem({
type: MessageType.THINKING,
thought: thoughtRef.current,
} as HistoryItemWithoutId);
setThought(null);
}
if (toolCallsRef.current.length > 0) {
const unpushed = toolCallsRef.current.filter(
(tc) => !pushedToolCallIdsRef.current.has(tc.request.callId),
);
if (unpushed.length > 0) {
addItem(
mapToDisplayInternal(unpushed, {
borderBottom: true,
}),
);
unpushed.forEach((tc) =>
pushedToolCallIdsRef.current.add(tc.request.callId),
);
}
}
if (streamingContentRef.current) {
addItem({
type: MessageType.GEMINI,
text: streamingContentRef.current,
});
setStreamingContent('');
streamingContentRef.current = '';
}
toolCallsRef.current = [];
setToolCalls([]);
break;
case ServerGeminiEventType.SubagentActivity:
{
const activity = event.value;
let matched = false;
const nextCalls = toolCallsRef.current.map((tc) => {
// Try to find the tool box that belongs to this agent.
// Note: We search ALL tool calls, not just 'executing', in case of race conditions.
if (
tc.request.name === activity.agentName ||
(tc.tool?.displayName || tc.request.name) === activity.agentName
) {
matched = true;
let output = '';
if (
tc.status === 'success' ||
tc.status === 'error' ||
tc.status === 'cancelled'
) {
output = String(tc.response.resultDisplay || '');
}
if (typeof output !== 'string') output = '';
if (activity.type === 'TOOL_CALL_START') {
const rawName = String(activity.data['name'] || 'a tool');
const tool = config.getToolRegistry().getTool(rawName);
const displayName = tool?.displayName || rawName;
output += `🛠️ Calling ${displayName}...\n`;
} else if (activity.type === 'THOUGHT') {
const subject = String(
activity.data['subject'] || 'Thinking',
);
output += `🤖💭 ${subject}\n`;
}
const currentResponse =
tc.status === 'success' ||
tc.status === 'error' ||
tc.status === 'cancelled'
? tc.response
: {};
// eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
return {
...tc,
response: {
...currentResponse,
resultDisplay: output,
},
} as unknown as TrackedToolCall;
}
return tc;
});
if (matched) {
toolCallsRef.current = nextCalls;
setToolCalls(nextCalls);
} else {
// Fallback: If no tool box matches, show it as a standalone item
if (activity.type === 'THOUGHT') {
addItem({
type: MessageType.GEMINI,
text: `🤖💭 [${activity.agentName}] ${activity.data['subject']}`,
});
}
}
}
break;
case ServerGeminiEventType.Finished:
setStreamingState(StreamingState.Idle);
break;
default:
break;
}
},
[addItem, config, setThought, thoughtRef],
);
// Listen for nested subagent activity on the MessageBus
useEffect(() => {
const bus = config.getMessageBus();
/* eslint-disable @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-type-assertion */
const handler = (event: any) => {
processEvent({
type: ServerGeminiEventType.SubagentActivity,
value: event.activity,
} as any as GeminiEvent);
};
/* eslint-enable @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-type-assertion */
bus.subscribe(MessageBusType.SUBAGENT_ACTIVITY, handler);
return () => {
bus.unsubscribe(MessageBusType.SUBAGENT_ACTIVITY, handler);
};
}, [config, processEvent]);
const submitQuery = useCallback(
async (parts: PartListUnion) => {
reset();
setStreamingState(StreamingState.Responding);
abortControllerRef.current = new AbortController();
const harness = AgentFactory.createHarness(config);
// Convert parts to Part[] array for harness
/* eslint-disable @typescript-eslint/no-unsafe-type-assertion */
const requestParts: Part[] = Array.isArray(parts)
? (parts as Part[])
: [{ text: String(parts) }];
/* eslint-enable @typescript-eslint/no-unsafe-type-assertion */
const stream = harness.run(
requestParts,
abortControllerRef.current.signal,
);
try {
for await (const event of stream) {
processEvent(event);
}
} catch (err: unknown) {
if (err instanceof Error && err.name === 'AbortError') return;
const msg = err instanceof Error ? err.message : String(err);
addItem({ type: MessageType.ERROR, text: msg });
} finally {
setStreamingState(StreamingState.Idle);
}
},
[config, reset, processEvent, addItem],
);
return {
streamingState,
isResponding: streamingState !== StreamingState.Idle,
thought,
streamingContent,
toolCalls,
submitQuery,
processEvent,
cancelOngoingRequest,
reset,
initError: null,
pendingHistoryItems,
handleApprovalModeChange: () => {},
activePtyId: null,
loopDetectionConfirmationRequest: null,
lastOutputTime: 0,
backgroundShellCount: 0,
isBackgroundShellVisible: false,
toggleBackgroundShell: () => {},
backgroundCurrentShell: null,
backgroundShells: new Map<number, BackgroundShell>(),
dismissBackgroundShell: () => {},
retryStatus: null,
};
};
/**
* Internal mapper to ensure we don't accidentally leak subagent-internal tools
* into the main UI boxes while in Harness Mode.
*/
function mapToDisplayInternal(
calls: TrackedToolCall[],
options: { borderTop?: boolean; borderBottom?: boolean },
): HistoryItemWithoutId {
// We filter out any tool calls that are NOT part of the root harness level.
// This prevents internal subagent work (like list_directory) from appearing
// as loose tool boxes in the main chat.
const filtered = calls.filter(
(c) =>
// Only show tools belonging to the main top-level session.
c.schedulerId === ROOT_SCHEDULER_ID,
);
return mapTrackedToolCallsToDisplay(filtered, options);
}
@@ -31,6 +31,7 @@ function consoleMessagesReducer(
state: ConsoleMessageItem[],
action: Action,
): ConsoleMessageItem[] {
const MAX_CONSOLE_MESSAGES = 1000;
switch (action.type) {
case 'ADD_MESSAGES': {
const newMessages = [...state];
@@ -51,6 +52,12 @@ function consoleMessagesReducer(
newMessages.push({ ...queuedMessage, count: 1 });
}
}
// Limit the number of messages to prevent memory issues
if (newMessages.length > MAX_CONSOLE_MESSAGES) {
return newMessages.slice(newMessages.length - MAX_CONSOLE_MESSAGES);
}
return newMessages;
}
case 'CLEAR':
@@ -91,9 +98,17 @@ export function useConsoleMessages(): UseConsoleMessagesReturn {
useEffect(() => {
const handleConsoleLog = (payload: ConsoleLogPayload) => {
let content = payload.content;
const MAX_CONSOLE_MSG_LENGTH = 10000;
if (content.length > MAX_CONSOLE_MSG_LENGTH) {
content =
content.slice(0, MAX_CONSOLE_MSG_LENGTH) +
`... [Truncated ${content.length - MAX_CONSOLE_MSG_LENGTH} characters]`;
}
handleNewMessage({
type: payload.type,
content: payload.content,
content,
count: 1,
});
};
@@ -102,10 +117,18 @@ export function useConsoleMessages(): UseConsoleMessagesReturn {
isStderr: boolean;
chunk: Uint8Array | string;
}) => {
const content =
let content =
typeof payload.chunk === 'string'
? payload.chunk
: new TextDecoder().decode(payload.chunk);
const MAX_OUTPUT_CHUNK_LENGTH = 10000;
if (content.length > MAX_OUTPUT_CHUNK_LENGTH) {
content =
content.slice(0, MAX_OUTPUT_CHUNK_LENGTH) +
`... [Truncated ${content.length - MAX_OUTPUT_CHUNK_LENGTH} characters]`;
}
// It would be nice if we could show stderr as 'warn' but unfortunately
// we log non warning info to stderr before the app starts so that would
// be misleading.
+7 -1
View File
@@ -1168,6 +1168,12 @@ export const useGeminiStream = (
case ServerGeminiEventType.InvalidStream:
// Will add the missing logic later
break;
case ServerGeminiEventType.SubagentActivity:
// TODO: UI implementation for subagent activity
break;
case ServerGeminiEventType.TurnFinished:
// No-op for now to satisfy exhaustive switch
break;
default: {
// enforces exhaustive switch-case
const unreachable: never = event;
@@ -1677,7 +1683,7 @@ export const useGeminiStream = (
pendingHistoryItems,
thought,
cancelOngoingRequest,
pendingToolCalls: toolCalls,
toolCalls,
handleApprovalModeChange,
activePtyId,
loopDetectionConfirmationRequest,
+11 -4
View File
@@ -5,8 +5,12 @@
*/
import { useEffect } from 'react';
import type { KeypressHandler, Key } from '../contexts/KeypressContext.js';
import { useKeypressContext } from '../contexts/KeypressContext.js';
import {
useKeypressContext,
type KeypressHandler,
type Key,
type KeypressPriority,
} from '../contexts/KeypressContext.js';
export type { Key };
@@ -16,11 +20,14 @@ export type { Key };
* @param onKeypress - The callback function to execute on each keypress.
* @param options - Options to control the hook's behavior.
* @param options.isActive - Whether the hook should be actively listening for input.
* @param options.priority - Whether the hook should have priority over normal subscribers.
* @param options.priority - Priority level (integer or KeypressPriority enum) or boolean for backward compatibility.
*/
export function useKeypress(
onKeypress: KeypressHandler,
{ isActive, priority }: { isActive: boolean; priority?: boolean },
{
isActive,
priority,
}: { isActive: boolean; priority?: KeypressPriority | boolean },
) {
const { subscribe, unsubscribe } = useKeypressContext();
+1
View File
@@ -373,6 +373,7 @@ export enum MessageType {
AGENTS_LIST = 'agents_list',
MCP_STATUS = 'mcp_status',
CHAT_LIST = 'chat_list',
THINKING = 'thinking',
HOOKS_LIST = 'hooks_list',
}
@@ -1,25 +0,0 @@
/**
* @license
* Copyright 2025 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import { getPlainTextLength } from './InlineMarkdownRenderer.js';
import { describe, it, expect } from 'vitest';
describe('getPlainTextLength', () => {
it.each([
['**Primary Go', 12],
['*Primary Go', 11],
['**Primary Go**', 10],
['*Primary Go*', 10],
['**', 2],
['*', 1],
['compile-time**', 14],
])(
'should measure markdown text length correctly for "%s"',
(input, expected) => {
expect(getPlainTextLength(input)).toBe(expected);
},
);
});
@@ -7,7 +7,6 @@
import React from 'react';
import { Text } from 'ink';
import { theme } from '../semantic-colors.js';
import stringWidth from 'string-width';
import { debugLogger } from '@google/gemini-cli-core';
// Constants for Markdown parsing
@@ -171,19 +170,3 @@ const RenderInlineInternal: React.FC<RenderInlineProps> = ({
};
export const RenderInline = React.memo(RenderInlineInternal);
/**
* Utility function to get the plain text length of a string with markdown formatting
* This is useful for calculating column widths in tables
*/
export const getPlainTextLength = (text: string): number => {
const cleanText = text
.replace(/\*\*(.*?)\*\*/g, '$1')
.replace(/\*(.+?)\*/g, '$1')
.replace(/_(.*?)_/g, '$1')
.replace(/~~(.*?)~~/g, '$1')
.replace(/`(.*?)`/g, '$1')
.replace(/<u>(.*?)<\/u>/g, '$1')
.replace(/.*\[(.*?)\]\(.*\)/g, '$1');
return stringWidth(cleanText);
};
@@ -314,4 +314,35 @@ describe('TableRenderer', () => {
});
expect(output).toMatchSnapshot();
});
it.each([
{
name: 'renders correctly when headers are empty but rows have data',
headers: [] as string[],
rows: [['Data 1', 'Data 2']],
expected: ['Data 1', 'Data 2'],
},
{
name: 'renders correctly when there are more headers than columns in rows',
headers: ['Header 1', 'Header 2', 'Header 3'],
rows: [['Data 1', 'Data 2']],
expected: ['Header 1', 'Header 2', 'Header 3', 'Data 1', 'Data 2'],
},
])('$name', ({ headers, rows, expected }) => {
const terminalWidth = 50;
const { lastFrame } = renderWithProviders(
<TableRenderer
headers={headers}
rows={rows}
terminalWidth={terminalWidth}
/>,
);
const output = lastFrame();
expected.forEach((text) => {
expect(output).toContain(text);
});
expect(output).toMatchSnapshot();
});
});
+44 -28
View File
@@ -28,8 +28,7 @@ const MIN_COLUMN_WIDTH = 5;
const COLUMN_PADDING = 2;
const TABLE_MARGIN = 2;
const calculateWidths = (text: string) => {
const styledChars = toStyledCharacters(text);
const calculateWidths = (styledChars: StyledChar[]) => {
const contentWidth = styledCharsWidth(styledChars);
const words: StyledChar[][] = wordBreakStyledChars(styledChars);
@@ -60,31 +59,48 @@ export const TableRenderer: React.FC<TableRendererProps> = ({
[headers],
);
const styledHeaders = useMemo(
() => cleanedHeaders.map((header) => toStyledCharacters(header)),
[cleanedHeaders],
);
const styledRows = useMemo(
() => rows.map((row) => row.map((cell) => toStyledCharacters(cell))),
[rows],
);
const { wrappedHeaders, wrappedRows, adjustedWidths } = useMemo(() => {
const numColumns = styledRows.reduce(
(max, row) => Math.max(max, row.length),
styledHeaders.length,
);
// --- Define Constraints per Column ---
const constraints = cleanedHeaders.map((header, colIndex) => {
let { contentWidth: maxContentWidth, maxWordWidth } =
calculateWidths(header);
const constraints = Array.from({ length: numColumns }).map(
(_, colIndex) => {
const headerStyledChars = styledHeaders[colIndex] || [];
let { contentWidth: maxContentWidth, maxWordWidth } =
calculateWidths(headerStyledChars);
rows.forEach((row) => {
const cell = row[colIndex] || '';
const { contentWidth: cellWidth, maxWordWidth: cellWordWidth } =
calculateWidths(cell);
styledRows.forEach((row) => {
const cellStyledChars = row[colIndex] || [];
const { contentWidth: cellWidth, maxWordWidth: cellWordWidth } =
calculateWidths(cellStyledChars);
maxContentWidth = Math.max(maxContentWidth, cellWidth);
maxWordWidth = Math.max(maxWordWidth, cellWordWidth);
});
maxContentWidth = Math.max(maxContentWidth, cellWidth);
maxWordWidth = Math.max(maxWordWidth, cellWordWidth);
});
const minWidth = maxWordWidth;
const maxWidth = Math.max(minWidth, maxContentWidth);
const minWidth = maxWordWidth;
const maxWidth = Math.max(minWidth, maxContentWidth);
return { minWidth, maxWidth };
});
return { minWidth, maxWidth };
},
);
// --- Calculate Available Space ---
// Fixed overhead: borders (n+1) + padding (2n)
const fixedOverhead =
cleanedHeaders.length + 1 + cleanedHeaders.length * COLUMN_PADDING;
const fixedOverhead = numColumns + 1 + numColumns * COLUMN_PADDING;
const availableWidth = Math.max(
0,
terminalWidth - fixedOverhead - TABLE_MARGIN,
@@ -136,17 +152,18 @@ export const TableRenderer: React.FC<TableRendererProps> = ({
}
// --- Pre-wrap and Optimize Widths ---
const actualColumnWidths = new Array(cleanedHeaders.length).fill(0);
const actualColumnWidths = new Array(numColumns).fill(0);
const wrapAndProcessRow = (row: string[]) => {
const wrapAndProcessRow = (row: StyledChar[][]) => {
const rowResult: ProcessedLine[][] = [];
row.forEach((cell, colIndex) => {
// Ensure we iterate up to numColumns, filling with empty cells if needed
for (let colIndex = 0; colIndex < numColumns; colIndex++) {
const cellStyledChars = row[colIndex] || [];
const allocatedWidth = finalContentWidths[colIndex];
const contentWidth = Math.max(1, allocatedWidth);
const contentStyledChars = toStyledCharacters(cell);
const wrappedStyledLines = wrapStyledChars(
contentStyledChars,
cellStyledChars,
contentWidth,
);
@@ -161,19 +178,18 @@ export const TableRenderer: React.FC<TableRendererProps> = ({
width: styledCharsWidth(line),
}));
rowResult.push(lines);
});
}
return rowResult;
};
const wrappedHeaders = wrapAndProcessRow(cleanedHeaders);
const wrappedRows = rows.map((row) => wrapAndProcessRow(row));
const wrappedHeaders = wrapAndProcessRow(styledHeaders);
const wrappedRows = styledRows.map((row) => wrapAndProcessRow(row));
// Use the TIGHTEST widths that fit the wrapped content + padding
const adjustedWidths = actualColumnWidths.map((w) => w + COLUMN_PADDING);
return { wrappedHeaders, wrappedRows, adjustedWidths };
}, [cleanedHeaders, rows, terminalWidth]);
}, [styledHeaders, styledRows, terminalWidth]);
// Helper function to render a cell with proper width
const renderCell = (
content: ProcessedLine,
@@ -44,6 +44,26 @@ exports[`TableRenderer > 'renders a table with only emojis and …' 1`] = `
"
`;
exports[`TableRenderer > 'renders correctly when headers are em…' 1`] = `
"
┌────────┬────────┐
│ │ │
├────────┼────────┤
│ Data 1 │ Data 2 │
└────────┴────────┘
"
`;
exports[`TableRenderer > 'renders correctly when there are more…' 1`] = `
"
┌──────────┬──────────┬──────────┐
│ Header 1 │ Header 2 │ Header 3 │
├──────────┼──────────┼──────────┤
│ Data 1 │ Data 2 │ │
└──────────┴──────────┴──────────┘
"
`;
exports[`TableRenderer > handles wrapped bold headers without showing markers 1`] = `
"
┌─────────────┬───────┬─────────┐
@@ -70,12 +70,20 @@ vi.mock('./activityLogger.js', () => ({
},
}));
const mockShouldLaunchBrowser = vi.hoisted(() => vi.fn(() => true));
const mockOpenBrowserSecurely = vi.hoisted(() =>
vi.fn(() => Promise.resolve()),
);
vi.mock('@google/gemini-cli-core', () => ({
debugLogger: {
log: vi.fn(),
debug: vi.fn(),
error: vi.fn(),
warn: vi.fn(),
},
shouldLaunchBrowser: mockShouldLaunchBrowser,
openBrowserSecurely: mockOpenBrowserSecurely,
}));
vi.mock('ws', () => ({
@@ -92,6 +100,7 @@ vi.mock('gemini-cli-devtools', () => ({
import {
setupInitialActivityLogger,
startDevToolsServer,
toggleDevToolsPanel,
resetForTesting,
} from './devtoolsService.js';
@@ -426,4 +435,98 @@ describe('devtoolsService', () => {
expect(mockAddNetworkTransport).toHaveBeenCalledTimes(3);
});
});
describe('toggleDevToolsPanel', () => {
it('calls toggle (to close) when already open', async () => {
const config = createMockConfig();
const toggle = vi.fn();
const setOpen = vi.fn();
const promise = toggleDevToolsPanel(config, true, toggle, setOpen);
await promise;
expect(toggle).toHaveBeenCalledTimes(1);
expect(setOpen).not.toHaveBeenCalled();
});
it('does NOT call toggle or setOpen when browser opens successfully', async () => {
const config = createMockConfig();
const toggle = vi.fn();
const setOpen = vi.fn();
mockShouldLaunchBrowser.mockReturnValue(true);
mockOpenBrowserSecurely.mockResolvedValue(undefined);
mockDevToolsInstance.start.mockResolvedValue('http://127.0.0.1:25417');
mockDevToolsInstance.getPort.mockReturnValue(25417);
const promise = toggleDevToolsPanel(config, false, toggle, setOpen);
await vi.waitFor(() => expect(MockWebSocket.instances.length).toBe(1));
MockWebSocket.instances[0].simulateError();
await promise;
expect(toggle).not.toHaveBeenCalled();
expect(setOpen).not.toHaveBeenCalled();
});
it('calls setOpen when browser fails to open', async () => {
const config = createMockConfig();
const toggle = vi.fn();
const setOpen = vi.fn();
mockShouldLaunchBrowser.mockReturnValue(true);
mockOpenBrowserSecurely.mockRejectedValue(new Error('no browser'));
mockDevToolsInstance.start.mockResolvedValue('http://127.0.0.1:25417');
mockDevToolsInstance.getPort.mockReturnValue(25417);
const promise = toggleDevToolsPanel(config, false, toggle, setOpen);
await vi.waitFor(() => expect(MockWebSocket.instances.length).toBe(1));
MockWebSocket.instances[0].simulateError();
await promise;
expect(toggle).not.toHaveBeenCalled();
expect(setOpen).toHaveBeenCalledTimes(1);
});
it('calls setOpen when shouldLaunchBrowser returns false', async () => {
const config = createMockConfig();
const toggle = vi.fn();
const setOpen = vi.fn();
mockShouldLaunchBrowser.mockReturnValue(false);
mockDevToolsInstance.start.mockResolvedValue('http://127.0.0.1:25417');
mockDevToolsInstance.getPort.mockReturnValue(25417);
const promise = toggleDevToolsPanel(config, false, toggle, setOpen);
await vi.waitFor(() => expect(MockWebSocket.instances.length).toBe(1));
MockWebSocket.instances[0].simulateError();
await promise;
expect(toggle).not.toHaveBeenCalled();
expect(setOpen).toHaveBeenCalledTimes(1);
});
it('calls setOpen when DevTools server fails to start', async () => {
const config = createMockConfig();
const toggle = vi.fn();
const setOpen = vi.fn();
mockDevToolsInstance.start.mockRejectedValue(new Error('fail'));
const promise = toggleDevToolsPanel(config, false, toggle, setOpen);
await vi.waitFor(() => expect(MockWebSocket.instances.length).toBe(1));
MockWebSocket.instances[0].simulateError();
await promise;
expect(toggle).not.toHaveBeenCalled();
expect(setOpen).toHaveBeenCalledTimes(1);
});
});
});
+42
View File
@@ -210,6 +210,48 @@ async function startDevToolsServerImpl(config: Config): Promise<string> {
return url;
}
/**
* Handles the F12 key toggle for the DevTools panel.
* Starts the DevTools server, attempts to open the browser.
* If the panel is already open, it closes it.
* If the panel is closed:
* - Attempts to open the browser.
* - If browser opening is successful, the panel remains closed.
* - If browser opening fails or is not possible, the panel is opened.
*/
export async function toggleDevToolsPanel(
config: Config,
isOpen: boolean,
toggle: () => void,
setOpen: () => void,
): Promise<void> {
if (isOpen) {
toggle();
return;
}
try {
const { openBrowserSecurely, shouldLaunchBrowser } = await import(
'@google/gemini-cli-core'
);
const url = await startDevToolsServer(config);
if (shouldLaunchBrowser()) {
try {
await openBrowserSecurely(url);
// Browser opened successfully, don't open drawer.
return;
} catch (e) {
debugLogger.warn('Failed to open browser securely:', e);
}
}
// If we can't launch browser or it failed, open drawer.
setOpen();
} catch (e) {
setOpen();
debugLogger.error('Failed to start DevTools server:', e);
}
}
/** Reset module-level state — test only. */
export function resetForTesting() {
promotionAttempts = 0;
+47
View File
@@ -0,0 +1,47 @@
/**
* @license
* Copyright 2026 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import { type Config } from '../config/config.js';
import { AgentHarness, type AgentHarnessOptions } from './harness.js';
import { type AgentDefinition, type LocalAgentDefinition } from './types.js';
import { MainAgentBehavior, SubagentBehavior } from './behavior.js';
import { debugLogger } from '../utils/debugLogger.js';
/**
* Factory for creating agent executors/harnesses.
* Respects experimental flags to determine which implementation to use.
*/
export class AgentFactory {
static createHarness(
config: Config,
definition?: AgentDefinition,
options: Partial<AgentHarnessOptions> = {},
): AgentHarness {
let behavior;
if (definition && definition.kind === 'local') {
const localDef: LocalAgentDefinition = definition;
behavior = new SubagentBehavior(
config,
localDef,
options.inputs,
options.parentPromptId,
);
} else {
behavior = new MainAgentBehavior(config, options.parentPromptId);
}
debugLogger.debug(
`[AgentFactory] Creating harness for agent: ${behavior.name} (agentId: ${behavior.agentId})`,
);
return new AgentHarness({
config,
behavior,
isolatedTools: !!definition,
...options,
});
}
}
+13 -1
View File
@@ -12,6 +12,7 @@ import type {
} from '../scheduler/types.js';
import type { ToolRegistry } from '../tools/tool-registry.js';
import type { EditorType } from '../utils/editor.js';
import type { MessageBus } from '../confirmation-bus/message-bus.js';
/**
* Options for scheduling agent tools.
@@ -29,6 +30,13 @@ export interface AgentSchedulingOptions {
getPreferredEditor?: () => EditorType | undefined;
/** Optional function to be notified when the scheduler is waiting for user confirmation. */
onWaitingForConfirmation?: (waiting: boolean) => void;
/**
* Optional message bus override.
* If provided, the scheduler will broadcast to this bus.
* If explicitly null, broadcasting is disabled.
* If omitted, the global config message bus is used.
*/
messageBus?: MessageBus | null;
}
/**
@@ -51,6 +59,7 @@ export async function scheduleAgentTools(
signal,
getPreferredEditor,
onWaitingForConfirmation,
messageBus,
} = options;
// Create a proxy/override of the config to provide the agent-specific tool registry.
@@ -59,7 +68,10 @@ export async function scheduleAgentTools(
const scheduler = new Scheduler({
config: agentConfig,
messageBus: config.getMessageBus(),
messageBus:
messageBus === undefined
? config.getMessageBus()
: (messageBus ?? undefined),
getPreferredEditor: getPreferredEditor ?? (() => undefined),
schedulerId,
parentCallId,
@@ -363,4 +363,171 @@ Hidden`,
expect(result.errors).toHaveLength(1);
});
});
describe('remote agent auth configuration', () => {
it('should parse remote agent with apiKey auth', async () => {
const filePath = await writeAgentMarkdown(`---
kind: remote
name: api-key-agent
agent_card_url: https://example.com/card
auth:
type: apiKey
key: $MY_API_KEY
in: header
name: X-Custom-Key
---
`);
const result = await parseAgentMarkdown(filePath);
expect(result).toHaveLength(1);
expect(result[0]).toMatchObject({
kind: 'remote',
name: 'api-key-agent',
auth: {
type: 'apiKey',
key: '$MY_API_KEY',
in: 'header',
name: 'X-Custom-Key',
},
});
});
it('should parse remote agent with http Bearer auth', async () => {
const filePath = await writeAgentMarkdown(`---
kind: remote
name: bearer-agent
agent_card_url: https://example.com/card
auth:
type: http
scheme: Bearer
token: $BEARER_TOKEN
---
`);
const result = await parseAgentMarkdown(filePath);
expect(result).toHaveLength(1);
expect(result[0]).toMatchObject({
kind: 'remote',
name: 'bearer-agent',
auth: {
type: 'http',
scheme: 'Bearer',
token: '$BEARER_TOKEN',
},
});
});
it('should parse remote agent with http Basic auth', async () => {
const filePath = await writeAgentMarkdown(`---
kind: remote
name: basic-agent
agent_card_url: https://example.com/card
auth:
type: http
scheme: Basic
username: $AUTH_USER
password: $AUTH_PASS
---
`);
const result = await parseAgentMarkdown(filePath);
expect(result).toHaveLength(1);
expect(result[0]).toMatchObject({
kind: 'remote',
name: 'basic-agent',
auth: {
type: 'http',
scheme: 'Basic',
username: '$AUTH_USER',
password: '$AUTH_PASS',
},
});
});
it('should throw error for Bearer auth without token', async () => {
const filePath = await writeAgentMarkdown(`---
kind: remote
name: invalid-bearer
agent_card_url: https://example.com/card
auth:
type: http
scheme: Bearer
---
`);
await expect(parseAgentMarkdown(filePath)).rejects.toThrow(
/Bearer scheme requires "token"/,
);
});
it('should throw error for Basic auth without credentials', async () => {
const filePath = await writeAgentMarkdown(`---
kind: remote
name: invalid-basic
agent_card_url: https://example.com/card
auth:
type: http
scheme: Basic
username: user
---
`);
await expect(parseAgentMarkdown(filePath)).rejects.toThrow(
/Basic scheme requires "username" and "password"/,
);
});
it('should throw error for apiKey auth without key', async () => {
const filePath = await writeAgentMarkdown(`---
kind: remote
name: invalid-apikey
agent_card_url: https://example.com/card
auth:
type: apiKey
---
`);
await expect(parseAgentMarkdown(filePath)).rejects.toThrow(
/auth\.key.*Required/,
);
});
it('should convert auth config in markdownToAgentDefinition', () => {
const markdown = {
kind: 'remote' as const,
name: 'auth-agent',
agent_card_url: 'https://example.com/card',
auth: {
type: 'apiKey' as const,
key: '$API_KEY',
in: 'header' as const,
},
};
const result = markdownToAgentDefinition(markdown);
expect(result).toMatchObject({
kind: 'remote',
name: 'auth-agent',
auth: {
type: 'apiKey',
key: '$API_KEY',
location: 'header',
},
});
});
it('should parse auth with agent_card_requires_auth flag', async () => {
const filePath = await writeAgentMarkdown(`---
kind: remote
name: protected-card-agent
agent_card_url: https://example.com/card
auth:
type: apiKey
key: $MY_API_KEY
agent_card_requires_auth: true
---
`);
const result = await parseAgentMarkdown(filePath);
expect(result[0]).toMatchObject({
auth: {
type: 'apiKey',
agent_card_requires_auth: true,
},
});
});
});
});
+153
View File
@@ -15,6 +15,7 @@ import {
DEFAULT_MAX_TURNS,
DEFAULT_MAX_TIME_MINUTES,
} from './types.js';
import type { A2AAuthConfig } from './auth-provider/types.js';
import { isValidToolName } from '../tools/tool-names.js';
import { FRONTMATTER_REGEX } from '../skills/skillLoader.js';
import { getErrorMessage } from '../utils/errors.js';
@@ -39,11 +40,29 @@ interface FrontmatterLocalAgentDefinition
timeout_mins?: number;
}
/**
* Authentication configuration for remote agents in frontmatter format.
*/
interface FrontmatterAuthConfig {
type: 'apiKey' | 'http';
agent_card_requires_auth?: boolean;
// API Key
key?: string;
in?: 'header' | 'query' | 'cookie';
name?: string;
// HTTP
scheme?: 'Bearer' | 'Basic';
token?: string;
username?: string;
password?: string;
}
interface FrontmatterRemoteAgentDefinition
extends FrontmatterBaseAgentDefinition {
kind: 'remote';
description?: string;
agent_card_url: string;
auth?: FrontmatterAuthConfig;
}
type FrontmatterAgentDefinition =
@@ -95,6 +114,66 @@ const localAgentSchema = z
})
.strict();
/**
* Base fields shared by all auth configs.
*/
const baseAuthFields = {
agent_card_requires_auth: z.boolean().optional(),
};
/**
* API Key auth schema.
* Supports sending key in header, query parameter, or cookie.
*/
const apiKeyAuthSchema = z.object({
...baseAuthFields,
type: z.literal('apiKey'),
key: z.string().min(1, 'API key is required'),
in: z.enum(['header', 'query', 'cookie']).optional(),
name: z.string().optional(),
});
/**
* HTTP auth schema (Bearer or Basic).
* Note: Validation for scheme-specific fields is applied in authConfigSchema
* since discriminatedUnion doesn't support refined schemas directly.
*/
const httpAuthSchemaBase = z.object({
...baseAuthFields,
type: z.literal('http'),
scheme: z.enum(['Bearer', 'Basic']),
token: z.string().optional(),
username: z.string().optional(),
password: z.string().optional(),
});
/**
* Combined auth schema - discriminated union of all auth types.
* Note: We use the base schema for discriminatedUnion, then apply refinements
* via superRefine since discriminatedUnion doesn't support refined schemas directly.
*/
const authConfigSchema = z
.discriminatedUnion('type', [apiKeyAuthSchema, httpAuthSchemaBase])
.superRefine((data, ctx) => {
// Apply HTTP auth validation after union parsing
if (data.type === 'http') {
if (data.scheme === 'Bearer' && !data.token) {
ctx.addIssue({
code: z.ZodIssueCode.custom,
message: 'Bearer scheme requires "token"',
path: ['token'],
});
}
if (data.scheme === 'Basic' && (!data.username || !data.password)) {
ctx.addIssue({
code: z.ZodIssueCode.custom,
message: 'Basic scheme requires "username" and "password"',
path: data.username ? ['password'] : ['username'],
});
}
}
});
const remoteAgentSchema = z
.object({
kind: z.literal('remote').optional().default('remote'),
@@ -102,6 +181,7 @@ const remoteAgentSchema = z
description: z.string().optional(),
display_name: z.string().optional(),
agent_card_url: z.string().url(),
auth: authConfigSchema.optional(),
})
.strict();
@@ -238,6 +318,76 @@ export async function parseAgentMarkdown(
return [agentDef];
}
/**
* Converts frontmatter auth config to the internal A2AAuthConfig type.
* This handles the mapping from snake_case YAML to the internal type structure.
*/
function convertFrontmatterAuthToConfig(
frontmatter: FrontmatterAuthConfig,
): A2AAuthConfig {
const base = {
agent_card_requires_auth: frontmatter.agent_card_requires_auth,
};
switch (frontmatter.type) {
case 'apiKey':
if (!frontmatter.key) {
throw new Error('Internal error: API key missing after validation.');
}
return {
...base,
type: 'apiKey',
key: frontmatter.key,
location: frontmatter.in,
name: frontmatter.name,
};
case 'http': {
if (!frontmatter.scheme) {
throw new Error(
'Internal error: HTTP scheme missing after validation.',
);
}
switch (frontmatter.scheme) {
case 'Bearer':
if (!frontmatter.token) {
throw new Error(
'Internal error: Bearer token missing after validation.',
);
}
return {
...base,
type: 'http',
scheme: 'Bearer',
token: frontmatter.token,
};
case 'Basic':
if (!frontmatter.username || !frontmatter.password) {
throw new Error(
'Internal error: Basic auth credentials missing after validation.',
);
}
return {
...base,
type: 'http',
scheme: 'Basic',
username: frontmatter.username,
password: frontmatter.password,
};
default: {
const exhaustive: never = frontmatter.scheme;
throw new Error(`Unknown HTTP scheme: ${exhaustive}`);
}
}
}
default: {
const exhaustive: never = frontmatter.type;
throw new Error(`Unknown auth type: ${exhaustive}`);
}
}
}
/**
* Converts a FrontmatterAgentDefinition DTO to the internal AgentDefinition structure.
*
@@ -270,6 +420,9 @@ export function markdownToAgentDefinition(
description: markdown.description || '(Loading description...)',
displayName: markdown.display_name,
agentCardUrl: markdown.agent_card_url,
auth: markdown.auth
? convertFrontmatterAuthToConfig(markdown.auth)
: undefined,
inputConfig,
metadata,
};
@@ -9,17 +9,33 @@ import type { A2AAuthProvider, A2AAuthProviderType } from './types.js';
/**
* Abstract base class for A2A authentication providers.
* Provides default implementations for optional methods.
*/
export abstract class BaseA2AAuthProvider implements A2AAuthProvider {
/**
* The type of authentication provider.
*/
abstract readonly type: A2AAuthProviderType;
/**
* Get the HTTP headers to include in requests.
* Subclasses must implement this method.
*/
abstract headers(): Promise<HttpHeaders>;
private static readonly MAX_AUTH_RETRIES = 2;
private authRetryCount = 0;
/**
* Default: retry on 401/403 with fresh headers.
* Subclasses with cached tokens must override to force-refresh to avoid infinite retries.
* Check if a request should be retried with new headers.
*
* The default implementation checks for 401/403 status codes and
* returns fresh headers for retry. Subclasses can override for
* custom retry logic.
*
* @param _req The original request init
* @param res The response from the server
* @returns New headers for retry, or undefined if no retry should be made
*/
async shouldRetryWithHeaders(
_req: RequestInit,
@@ -32,10 +48,15 @@ export abstract class BaseA2AAuthProvider implements A2AAuthProvider {
this.authRetryCount++;
return this.headers();
}
// Reset on success
// Reset count if not an auth error
this.authRetryCount = 0;
return undefined;
}
async initialize(): Promise<void> {}
/**
* Initialize the provider. Override in subclasses that need async setup.
*/
async initialize(): Promise<void> {
// Default: no-op
}
}
@@ -0,0 +1,136 @@
/**
* @license
* Copyright 2026 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import { describe, it, expect, afterEach, vi } from 'vitest';
import {
resolveAuthValue,
needsResolution,
maskSensitiveValue,
} from './value-resolver.js';
describe('value-resolver', () => {
describe('resolveAuthValue', () => {
describe('environment variables', () => {
afterEach(() => {
vi.unstubAllEnvs();
});
it('should resolve environment variable with $ prefix', async () => {
vi.stubEnv('TEST_API_KEY', 'secret-key-123');
const result = await resolveAuthValue('$TEST_API_KEY');
expect(result).toBe('secret-key-123');
});
it('should throw error for unset environment variable', async () => {
await expect(resolveAuthValue('$UNSET_VAR_12345')).rejects.toThrow(
"Environment variable 'UNSET_VAR_12345' is not set or is empty",
);
});
it('should throw error for empty environment variable', async () => {
vi.stubEnv('EMPTY_VAR', '');
await expect(resolveAuthValue('$EMPTY_VAR')).rejects.toThrow(
"Environment variable 'EMPTY_VAR' is not set or is empty",
);
});
});
describe('shell commands', () => {
it('should execute shell command with ! prefix', async () => {
const result = await resolveAuthValue('!echo hello');
expect(result).toBe('hello');
});
it('should trim whitespace from command output', async () => {
const result = await resolveAuthValue('!echo " hello "');
expect(result).toBe('hello');
});
it('should throw error for empty command', async () => {
await expect(resolveAuthValue('!')).rejects.toThrow(
'Empty command in auth value',
);
});
it('should throw error for command that returns empty output', async () => {
await expect(resolveAuthValue('!echo -n ""')).rejects.toThrow(
'returned empty output',
);
});
it('should throw error for failed command', async () => {
await expect(
resolveAuthValue('!nonexistent-command-12345'),
).rejects.toThrow(/Command.*failed/);
});
});
describe('literal values', () => {
it('should return literal value as-is', async () => {
const result = await resolveAuthValue('literal-api-key');
expect(result).toBe('literal-api-key');
});
it('should return empty string as-is', async () => {
const result = await resolveAuthValue('');
expect(result).toBe('');
});
it('should not treat values starting with other characters as special', async () => {
const result = await resolveAuthValue('api-key-123');
expect(result).toBe('api-key-123');
});
});
describe('escaped literals', () => {
it('should return $ literal when value starts with $$', async () => {
const result = await resolveAuthValue('$$LITERAL');
expect(result).toBe('$LITERAL');
});
it('should return ! literal when value starts with !!', async () => {
const result = await resolveAuthValue('!!not-a-command');
expect(result).toBe('!not-a-command');
});
});
});
describe('needsResolution', () => {
it('should return true for environment variable reference', () => {
expect(needsResolution('$ENV_VAR')).toBe(true);
});
it('should return true for command reference', () => {
expect(needsResolution('!command')).toBe(true);
});
it('should return false for literal value', () => {
expect(needsResolution('literal')).toBe(false);
});
it('should return false for empty string', () => {
expect(needsResolution('')).toBe(false);
});
});
describe('maskSensitiveValue', () => {
it('should mask value longer than 12 characters', () => {
expect(maskSensitiveValue('1234567890abcd')).toBe('12****cd');
});
it('should return **** for short values', () => {
expect(maskSensitiveValue('short')).toBe('****');
});
it('should return **** for exactly 12 characters', () => {
expect(maskSensitiveValue('123456789012')).toBe('****');
});
it('should return **** for empty string', () => {
expect(maskSensitiveValue('')).toBe('****');
});
});
});
@@ -0,0 +1,106 @@
/**
* @license
* Copyright 2026 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import { debugLogger } from '../../utils/debugLogger.js';
import { getShellConfiguration, spawnAsync } from '../../utils/shell-utils.js';
const COMMAND_TIMEOUT_MS = 60_000;
/**
* Resolves a value that may be an environment variable reference,
* a shell command, or a literal value.
*
* Supported formats:
* - `$ENV_VAR`: Read from environment variable
* - `!command`: Execute shell command and use output (trimmed)
* - `$$` or `!!`: Escape prefix, returns rest as literal
* - Any other string: Use as literal value
*
* @param value The value to resolve
* @returns The resolved value
* @throws Error if environment variable is not set or command fails
*/
export async function resolveAuthValue(value: string): Promise<string> {
// Support escaping with double prefix (e.g. $$ or !!).
// Strips one prefix char: $$FOO → $FOO, !!cmd → !cmd (literal, not resolved).
if (value.startsWith('$$') || value.startsWith('!!')) {
return value.slice(1);
}
// Environment variable: $MY_VAR
if (value.startsWith('$')) {
const envVar = value.slice(1);
const resolved = process.env[envVar];
if (resolved === undefined || resolved === '') {
throw new Error(
`Environment variable '${envVar}' is not set or is empty. ` +
`Please set it before using this agent.`,
);
}
debugLogger.debug(
`[AgentHarness] [AuthValueResolver] Resolved env var: ${envVar}`,
);
return resolved;
}
// Shell command: !command arg1 arg2
if (value.startsWith('!')) {
const command = value.slice(1).trim();
if (!command) {
throw new Error('Empty command in auth value. Expected format: !command');
}
debugLogger.debug(
`[AgentHarness] [AuthValueResolver] Executing command for auth value`,
);
const shellConfig = getShellConfiguration();
try {
const { stdout } = await spawnAsync(
shellConfig.executable,
[...shellConfig.argsPrefix, command],
{
signal: AbortSignal.timeout(COMMAND_TIMEOUT_MS),
windowsHide: true,
},
);
const trimmed = stdout.trim();
if (!trimmed) {
throw new Error(`Command '${command}' returned empty output`);
}
return trimmed;
} catch (error) {
if (error instanceof Error && error.name === 'AbortError') {
throw new Error(
`Command '${command}' timed out after ${COMMAND_TIMEOUT_MS / 1000} seconds`,
);
}
throw error;
}
}
// Literal value - return as-is
return value;
}
/**
* Check if a value needs resolution (is an env var or command reference).
*/
export function needsResolution(value: string): boolean {
return value.startsWith('$') || value.startsWith('!');
}
/**
* Mask a sensitive value for logging purposes.
* Shows the first and last 2 characters with asterisks in between.
*/
export function maskSensitiveValue(value: string): string {
if (value.length <= 12) {
return '****';
}
return `${value.slice(0, 2)}****${value.slice(-2)}`;
}
+611
View File
@@ -0,0 +1,611 @@
/**
* @license
* Copyright 2026 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import {
type Content,
type Part,
type FunctionDeclaration,
Type,
} from '@google/genai';
import { type Config } from '../config/config.js';
import {
type Turn,
type ServerGeminiStreamEvent,
GeminiEventType,
} from '../core/turn.js';
import {
AgentTerminateMode,
type LocalAgentDefinition,
type AgentInputs,
} from './types.js';
import { getCoreSystemPrompt } from '../core/prompts.js';
import {
getInitialChatHistory,
getDirectoryContextString,
} from '../utils/environmentContext.js';
import { templateString } from './utils.js';
import { getVersion } from '../utils/version.js';
import { zodToJsonSchema } from 'zod-to-json-schema';
import type { Schema } from '@google/genai';
import { checkNextSpeaker } from '../utils/nextSpeakerChecker.js';
import { partToString } from '../utils/partUtils.js';
import { ideContextStore } from '../ide/ideContext.js';
import { type IdeContext } from '../ide/types.js';
import { promptIdContext } from '../utils/promptIdContext.js';
import { logRecoveryAttempt } from '../telemetry/loggers.js';
import { RecoveryAttemptEvent } from '../telemetry/types.js';
import { DeadlineTimer } from '../utils/deadlineTimer.js';
import { debugLogger } from '../utils/debugLogger.js';
import type { ToolRegistry } from '../tools/tool-registry.js';
import type { ToolCallResponseInfo } from '../scheduler/types.js';
const TASK_COMPLETE_TOOL_NAME = 'complete_task';
const GRACE_PERIOD_MS = 60 * 1000;
/**
* Defines the extension points for the unified ReAct loop in AgentHarness.
*/
export interface AgentBehavior {
/** The unique ID for this agent instance. */
readonly agentId: string;
/** The human-readable name of the agent. */
readonly name: string;
/** The definition of the agent, if applicable. */
readonly definition?: LocalAgentDefinition;
/** Initializes any state needed for the agent. */
initialize(toolRegistry: ToolRegistry): Promise<void>;
/** Returns the system instruction for the chat. */
getSystemInstruction(): Promise<string | undefined>;
/** Returns the initial chat history. */
getInitialHistory(): Promise<Content[]>;
/**
* Prepares the tools list for the current turn.
* @param baseTools The tools from the tool registry.
*/
prepareTools(baseTools: FunctionDeclaration[]): FunctionDeclaration[];
/**
* Performs any environment synchronization (e.g., IDE context) before a turn.
*/
syncEnvironment(history: Content[]): Promise<{ additionalParts?: Part[] }>;
/**
* Fires the "Before Agent" hooks if applicable.
*/
fireBeforeAgent(request: Part[]): Promise<{
stop?: boolean;
reason?: string;
systemMessage?: string;
additionalContext?: string;
}>;
/**
* Fires the "After Agent" hooks if applicable.
*/
fireAfterAgent(
request: Part[],
response: string,
turn: Turn,
): Promise<{
stop?: boolean;
reason?: string;
systemMessage?: string;
contextCleared?: boolean;
shouldContinue?: boolean;
}>;
/**
* Transforms the initial request if needed (e.g. subagent 'Start' templating).
*/
transformRequest(request: Part[]): Promise<Part[]>;
/**
* Determines if the current tool results signify that the agent's goal is met.
* (e.g., Subagents checking for 'complete_task')
*/
isGoalReached(
toolResults: Array<{
name: string;
part: Part;
result: ToolCallResponseInfo;
}>,
): boolean;
/**
* Checks if the agent should continue executing after a model turn with no tool calls.
* (e.g., Main agent running next_speaker check)
*/
getContinuationRequest(
turn: Turn,
signal: AbortSignal,
): Promise<Part[] | null>;
/**
* Attempts to recover from a termination state (e.g., Subagent "Final Warning").
* Returns a stream of events if recovery is attempted.
*/
executeRecovery(
turn: Turn,
reason: AgentTerminateMode,
signal: AbortSignal,
): AsyncGenerator<ServerGeminiStreamEvent, boolean>;
/**
* Returns a final failure message for a given termination reason.
*/
getFinalFailureMessage(
reason: AgentTerminateMode,
maxTurns: number,
maxTime: number,
): string;
}
/**
* Behavior for the main CLI agent.
*/
export class MainAgentBehavior implements AgentBehavior {
readonly agentId: string;
readonly name = 'main';
private lastSentIdeContext: IdeContext | undefined;
private forceFullIdeContext = true;
constructor(
private readonly config: Config,
parentPromptId?: string,
) {
const randomIdPart = Math.random().toString(36).slice(2, 8);
const parentPrefix = parentPromptId ? `${parentPromptId}-` : '';
this.agentId = `${parentPrefix}main-${randomIdPart}`;
}
async initialize(_toolRegistry: ToolRegistry) {
debugLogger.debug(
`[AgentHarness] [${this.name}:${this.agentId}] Initialized`,
);
}
async getSystemInstruction() {
const systemMemory = this.config.getUserMemory();
return getCoreSystemPrompt(this.config, systemMemory);
}
async getInitialHistory() {
return getInitialChatHistory(this.config);
}
prepareTools(baseTools: FunctionDeclaration[]) {
return baseTools;
}
async syncEnvironment(history: Content[]) {
if (!this.config.getIdeMode()) return {};
const lastMessage =
history.length > 0 ? history[history.length - 1] : undefined;
const hasPendingToolCall =
!!lastMessage &&
lastMessage.role === 'model' &&
(lastMessage.parts?.some((p) => 'functionCall' in p) || false);
if (hasPendingToolCall) return {};
const currentIdeContext = ideContextStore.get();
if (!currentIdeContext) return {};
let contextParts: string[] = [];
if (
this.forceFullIdeContext ||
this.lastSentIdeContext === undefined ||
history.length === 0
) {
contextParts = this.getFullIdeContextParts(currentIdeContext);
} else {
contextParts = this.getDeltaIdeContextParts(
currentIdeContext,
this.lastSentIdeContext,
);
}
if (contextParts.length > 0) {
this.lastSentIdeContext = currentIdeContext;
this.forceFullIdeContext = false;
return { additionalParts: [{ text: contextParts.join('\n') }] };
}
return {};
}
private getFullIdeContextParts(context: IdeContext): string[] {
const openFiles = context.workspaceState?.openFiles || [];
const activeFile = openFiles.find((f) => f.isActive);
const otherOpenFiles = openFiles
.filter((f) => !f.isActive)
.map((f) => f.path);
const contextData: Record<string, unknown> = {};
if (activeFile) {
contextData['activeFile'] = {
path: activeFile.path,
cursor: activeFile.cursor,
selectedText: activeFile.selectedText || undefined,
};
}
if (otherOpenFiles.length > 0)
contextData['otherOpenFiles'] = otherOpenFiles;
if (Object.keys(contextData).length === 0) return [];
return [
"Here is the user's editor context as a JSON object. This is for your information only.",
'```json',
JSON.stringify(contextData, null, 2),
'```',
];
}
private getDeltaIdeContextParts(
_current: IdeContext,
_last: IdeContext,
): string[] {
// Simplified delta logic for now, similar to GeminiClient
const changes: Record<string, unknown> = {};
// ... delta logic ...
if (Object.keys(changes).length === 0) return [];
return [
"Here is a summary of changes in the user's editor context, in JSON format. This is for your information only.",
'```json',
JSON.stringify({ changes }, null, 2),
'```',
];
}
async fireBeforeAgent(request: Part[]) {
if (!this.config.getEnableHooks()) return {};
const hookOutput = await this.config
.getHookSystem()
?.fireBeforeAgentEvent(partToString(request));
if (!hookOutput) return {};
return {
stop: hookOutput.shouldStopExecution() || hookOutput.isBlockingDecision(),
reason: hookOutput.getEffectiveReason(),
systemMessage: hookOutput.systemMessage,
additionalContext: hookOutput.getAdditionalContext(),
};
}
async fireAfterAgent(request: Part[], response: string, turn: Turn) {
if (!this.config.getEnableHooks()) return {};
if (turn.pendingToolCalls.length > 0) return {};
const hookOutput = await this.config
.getHookSystem()
?.fireAfterAgentEvent(partToString(request), response);
if (!hookOutput) return {};
return {
stop: hookOutput.shouldStopExecution(),
shouldContinue: hookOutput.isBlockingDecision(),
reason: hookOutput.getEffectiveReason(),
systemMessage: hookOutput.systemMessage,
contextCleared: hookOutput.shouldClearContext(),
};
}
async transformRequest(request: Part[]) {
return request;
}
isGoalReached() {
return false;
}
async getContinuationRequest(turn: Turn, signal: AbortSignal) {
const nextSpeaker = await checkNextSpeaker(
turn.chat,
this.config.getBaseLlmClient(),
signal,
this.agentId,
);
if (nextSpeaker?.next_speaker === 'model') {
return [{ text: 'Please continue.' }];
}
return null;
}
async *executeRecovery(): AsyncGenerator<ServerGeminiStreamEvent, boolean> {
if (this.agentId === 'never') yield { type: GeminiEventType.Retry };
return false;
}
getFinalFailureMessage() {
return 'Execution terminated.';
}
}
/**
* Behavior for subagents.
*/
export class SubagentBehavior implements AgentBehavior {
readonly agentId: string;
readonly name: string;
constructor(
private readonly config: Config,
readonly definition: LocalAgentDefinition,
private readonly inputs?: AgentInputs,
parentPromptId?: string,
) {
this.name = definition.name;
const randomIdPart = Math.random().toString(36).slice(2, 8);
const parentPrefix = parentPromptId ? `${parentPromptId}-` : '';
this.agentId = `${parentPrefix}${this.name}-${randomIdPart}`;
}
async initialize(toolRegistry: ToolRegistry) {
debugLogger.debug(
`[AgentHarness] [${this.name}:${this.agentId}] Initializing tool registry`,
);
const parentToolRegistry = this.config.getToolRegistry();
if (this.definition.toolConfig) {
for (const toolRef of this.definition.toolConfig.tools) {
if (typeof toolRef === 'string') {
const tool = parentToolRegistry.getTool(toolRef);
if (tool) toolRegistry.registerTool(tool);
} else if (typeof toolRef === 'object' && 'build' in toolRef) {
toolRegistry.registerTool(toolRef);
}
}
} else {
for (const toolName of parentToolRegistry.getAllToolNames()) {
const tool = parentToolRegistry.getTool(toolName);
if (tool) toolRegistry.registerTool(tool);
}
}
toolRegistry.sortTools();
}
async getSystemInstruction() {
const augmentedInputs = {
...this.inputs,
cliVersion: await getVersion(),
activeModel: this.config.getActiveModel(),
today: new Date().toLocaleDateString(),
};
let prompt = templateString(
this.definition.promptConfig.systemPrompt || '',
augmentedInputs,
);
const dirContext = await getDirectoryContextString(this.config);
prompt += `\n\n# Environment Context\n${dirContext}`;
prompt += `\n\nImportant Rules:\n* You are running in a non-interactive mode. You CANNOT ask the user for input or clarification.\n* Work systematically using available tools to complete your task.\n* Always use absolute paths for file operations.`;
const hasOutput = !!this.definition.outputConfig;
prompt += `\n* When you have completed your task, you MUST call the \`${TASK_COMPLETE_TOOL_NAME}\` tool${hasOutput ? ' with your structured output' : ''}.`;
return prompt;
}
async getInitialHistory() {
const initialMessages = this.definition.promptConfig.initialMessages ?? [];
if (this.inputs) {
return initialMessages.map((content) => ({
...content,
parts: (content.parts ?? []).map((part) =>
'text' in part && part.text
? { text: templateString(part.text, this.inputs!) }
: part,
),
}));
}
return initialMessages;
}
prepareTools(baseTools: FunctionDeclaration[]) {
const completeTool: FunctionDeclaration = {
name: TASK_COMPLETE_TOOL_NAME,
description:
'Call this tool to submit your final answer and complete the task.',
parameters: { type: Type.OBJECT, properties: {}, required: [] },
};
if (this.definition.outputConfig) {
const schema = zodToJsonSchema(this.definition.outputConfig.schema);
const {
$schema: _,
definitions: __,
...cleanSchema
} = schema as Record<string, unknown>;
completeTool.parameters!.properties![
this.definition.outputConfig.outputName
] = cleanSchema as Schema;
completeTool.parameters!.required!.push(
this.definition.outputConfig.outputName,
);
} else {
completeTool.parameters!.properties!['result'] = {
type: Type.STRING,
description: 'Your final results or findings.',
};
completeTool.parameters!.required!.push('result');
}
return [...baseTools, completeTool];
}
async syncEnvironment() {
return {};
}
async fireBeforeAgent() {
return {};
}
async fireAfterAgent() {
return {};
}
async transformRequest(request: Part[]): Promise<Part[]> {
if (
request.length === 1 &&
'text' in request[0] &&
request[0].text === 'Start'
) {
return [
{
text: this.definition.promptConfig.query
? templateString(
this.definition.promptConfig.query,
this.inputs || {},
)
: 'Get Started!',
},
];
}
return request;
}
isGoalReached(
toolResults: Array<{
name: string;
part: Part;
result: ToolCallResponseInfo;
}>,
) {
const completeCall = toolResults.find(
(r) => r.name === TASK_COMPLETE_TOOL_NAME,
);
if (completeCall) {
// If there's an error in the call, we don't treat it as reached (model should retry)
return !completeCall.part.functionResponse?.response?.['error'];
}
return false;
}
async getContinuationRequest() {
return null;
}
async *executeRecovery(
turn: Turn,
reason: AgentTerminateMode,
signal: AbortSignal,
): AsyncGenerator<ServerGeminiStreamEvent, boolean> {
debugLogger.debug(
`[AgentHarness] [${this.name}:${this.agentId}] Entering recovery mode. Reason: ${reason}`,
);
const recoveryStartTime = Date.now();
let success = false;
const graceTimeoutController = new DeadlineTimer(
GRACE_PERIOD_MS,
'Grace period timed out.',
);
const combinedSignal = AbortSignal.any([
signal,
graceTimeoutController.signal,
]);
try {
const recoveryMessage: Part[] = [
{ text: this.getFinalWarningMessage(reason) },
];
const promptId = `${this.agentId}#recovery`;
const recoveryStream = promptIdContext.run(promptId, () =>
turn.run(
{ model: this.config.getActiveModel() },
recoveryMessage,
combinedSignal,
),
);
for await (const event of recoveryStream) {
yield event;
}
// Check if they called complete_task in the recovery turn
const completeCall = turn.pendingToolCalls.find(
(c) => c.name === TASK_COMPLETE_TOOL_NAME,
);
if (completeCall) {
success = true;
// Capture the result in the turn object explicitly
const outputName = this.definition.outputConfig?.outputName || 'result';
const rawFindings =
completeCall.args[outputName] || completeCall.args['result'];
if (rawFindings) {
turn.submittedOutput =
typeof rawFindings === 'object'
? JSON.stringify(rawFindings, null, 2)
: String(rawFindings);
debugLogger.debug(
`[AgentHarness] [${this.name}:${this.agentId}] Captured findings from recovery complete_task. Length: ${String(turn.submittedOutput).length}`,
);
}
}
} finally {
graceTimeoutController.abort();
logRecoveryAttempt(
this.config,
new RecoveryAttemptEvent(
this.agentId,
this.name,
reason,
Date.now() - recoveryStartTime,
success,
0,
),
);
}
return success;
}
private getFinalWarningMessage(reason: AgentTerminateMode): string {
let explanation = '';
switch (reason) {
case AgentTerminateMode.TIMEOUT:
explanation = 'You have exceeded the time limit.';
break;
case AgentTerminateMode.MAX_TURNS:
explanation = 'You have exceeded the maximum number of turns.';
break;
case AgentTerminateMode.ERROR_NO_COMPLETE_TASK_CALL:
explanation = 'You have stopped calling tools without finishing.';
break;
default:
explanation = 'Execution was interrupted.';
}
return `${explanation} You have one final chance to provide your findings. You MUST call \`${TASK_COMPLETE_TOOL_NAME}\` immediately with your best synthesis and conclusion for the main agent. Do not call any other tools.`;
}
getFinalFailureMessage(
reason: AgentTerminateMode,
maxTurns: number,
maxTime: number,
) {
switch (reason) {
case AgentTerminateMode.TIMEOUT:
return `Agent timed out after ${maxTime} minutes.`;
case AgentTerminateMode.MAX_TURNS:
return `Agent reached max turns limit (${maxTurns}).`;
case AgentTerminateMode.ERROR_NO_COMPLETE_TASK_CALL:
return `Agent stopped calling tools but did not call '${TASK_COMPLETE_TOOL_NAME}'.`;
default:
return 'Agent execution was terminated before completion.';
}
}
}
@@ -109,8 +109,8 @@ export const CodebaseInvestigatorAgent = (
},
runConfig: {
maxTimeMinutes: 3,
maxTurns: 10,
maxTimeMinutes: 10,
maxTurns: 50,
},
toolConfig: {
@@ -0,0 +1,398 @@
/**
* @license
* Copyright 2026 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import { describe, it, expect, vi, beforeEach, type Mock } from 'vitest';
import { HarnessSubagentInvocation } from './harness-invocation.js';
import { makeFakeConfig } from '../test-utils/config.js';
import { AgentFactory } from './agent-factory.js';
import { type Turn } from '../core/turn.js';
import { type Config } from '../config/config.js';
import { type MessageBus } from '../confirmation-bus/message-bus.js';
import type { z } from 'zod';
import type { Part } from '@google/genai';
import { type LocalAgentDefinition } from './types.js';
vi.mock('../core/geminiChat.js', () => ({
GeminiChat: vi.fn(),
}));
vi.mock('./agent-factory.js', () => ({
AgentFactory: {
createHarness: vi.fn(),
},
}));
describe('HarnessSubagentInvocation', () => {
let mockConfig: Config;
let mockMessageBus: MessageBus;
let definition: LocalAgentDefinition<z.ZodUnknown>;
beforeEach(() => {
mockConfig = makeFakeConfig();
mockMessageBus = {
publish: vi.fn(),
subscribe: vi.fn(),
} as unknown as MessageBus;
definition = {
kind: 'local',
name: 'test-agent',
displayName: 'Test Agent',
description: 'A test agent',
inputConfig: {
inputSchema: { type: 'object', properties: {}, required: [] },
},
modelConfig: { model: 'test-model' },
runConfig: { maxTurns: 5 },
promptConfig: { systemPrompt: 'Test' },
};
vi.clearAllMocks();
});
it('extracts result from complete_task tool call arguments', async () => {
const invocation = new HarnessSubagentInvocation(
definition,
mockConfig,
{},
mockMessageBus,
);
const mockHarness = {
run: vi.fn().mockReturnValue(
(async function* () {
// No intermediate events
yield* [];
})(),
),
};
(AgentFactory.createHarness as Mock).mockReturnValue(mockHarness);
const mockChat = {
getHistory: vi.fn().mockReturnValue([
{
role: 'model',
parts: [
{
functionCall: {
name: 'complete_task',
args: { result: 'Extracted Finding' },
},
},
],
},
]),
};
const mockTurn = {
getResponseText: vi.fn().mockReturnValue(''), // Text is empty
chat: mockChat,
} as unknown as Turn;
// Simulate the generator returning the final turn
mockHarness.run.mockReturnValue(
(async function* () {
yield* [];
return mockTurn;
})(),
);
const result = await invocation.execute(new AbortController().signal);
expect(result.data?.['result']).toBe('Extracted Finding');
expect((result.llmContent as Part[])?.[0]).toEqual({
text: `Subagent 'test-agent' finished.
Termination Reason: goal
Result:
Extracted Finding`,
});
expect(result.returnDisplay).toContain('Extracted Finding');
});
it('prefers direct text response over complete_task arguments if available', async () => {
const invocation = new HarnessSubagentInvocation(
definition,
mockConfig,
{},
mockMessageBus,
);
const mockHarness = {
run: vi.fn(),
};
(AgentFactory.createHarness as Mock).mockReturnValue(mockHarness);
const mockChat = {
getHistory: vi.fn().mockReturnValue([
{
role: 'model',
parts: [{ text: 'Textual Result' }],
},
]),
};
const mockTurn = {
getResponseText: vi.fn().mockReturnValue('Textual Result'),
chat: mockChat,
} as unknown as Turn;
mockHarness.run.mockReturnValue(
(async function* () {
yield* [];
return mockTurn;
})(),
);
const result = await invocation.execute(new AbortController().signal);
expect(result.data?.['result']).toBe('Textual Result');
expect((result.llmContent as Part[])?.[0]).toEqual({
text: `Subagent 'test-agent' finished.
Termination Reason: goal
Result:
Textual Result`,
});
expect(result.returnDisplay).toContain('Textual Result');
});
it('falls back to a default message if no result is found', async () => {
const invocation = new HarnessSubagentInvocation(
definition,
mockConfig,
{},
mockMessageBus,
);
const mockHarness = {
run: vi.fn(),
};
(AgentFactory.createHarness as Mock).mockReturnValue(mockHarness);
const mockChat = {
getHistory: vi.fn().mockReturnValue([]),
};
const mockTurn = {
getResponseText: vi.fn().mockReturnValue(''),
chat: mockChat,
} as unknown as Turn;
mockHarness.run.mockReturnValue(
(async function* () {
yield* [];
return mockTurn;
})(),
);
const result = await invocation.execute(new AbortController().signal);
expect(result.data?.['result']).toBe('Task completed.');
expect(result.returnDisplay).toContain('Task completed.');
});
it('finds the LAST relevant model message if multiple exist', async () => {
const invocation = new HarnessSubagentInvocation(
definition,
mockConfig,
{},
mockMessageBus,
);
const mockHarness = {
run: vi.fn(),
};
(AgentFactory.createHarness as Mock).mockReturnValue(mockHarness);
const mockChat = {
getHistory: vi.fn().mockReturnValue([
{
role: 'model',
parts: [{ text: 'Old Result' }],
},
{
role: 'user',
parts: [{ text: 'Keep going' }],
},
{
role: 'model',
parts: [
{
functionCall: {
name: 'complete_task',
args: { result: 'Newest Result' },
},
},
],
},
]),
};
const mockTurn = {
getResponseText: vi.fn().mockReturnValue(''),
chat: mockChat,
} as unknown as Turn;
mockHarness.run.mockReturnValue(
(async function* () {
yield* [];
return mockTurn;
})(),
);
const result = await invocation.execute(new AbortController().signal);
expect(result.data?.['result']).toBe('Newest Result');
expect(result.returnDisplay).toContain('Newest Result');
});
it('handles model messages with only thoughts and no result-bearing parts', async () => {
const invocation = new HarnessSubagentInvocation(
definition,
mockConfig,
{},
mockMessageBus,
);
const mockHarness = {
run: vi.fn(),
};
(AgentFactory.createHarness as Mock).mockReturnValue(mockHarness);
const mockChat = {
getHistory: vi.fn().mockReturnValue([
{
role: 'model',
parts: [
// eslint-disable-next-line @typescript-eslint/no-explicit-any
{ thought: true, text: 'Thinking about finishing...' } as any,
],
},
]),
};
const mockTurn = {
getResponseText: vi.fn().mockReturnValue(''),
chat: mockChat,
} as unknown as Turn;
mockHarness.run.mockReturnValue(
(async function* () {
yield* [];
return mockTurn;
})(),
);
const result = await invocation.execute(new AbortController().signal);
expect(result.data?.['result']).toBe('Task completed.');
expect(result.returnDisplay).toContain('Task completed.');
});
it('extracts result using the custom outputName from outputConfig', async () => {
const customDefinition: LocalAgentDefinition = {
...definition,
outputConfig: {
outputName: 'report',
description: 'A custom report',
// eslint-disable-next-line @typescript-eslint/no-explicit-any
schema: { type: 'string' } as any,
},
};
const invocation = new HarnessSubagentInvocation(
customDefinition,
mockConfig,
{},
mockMessageBus,
);
const mockHarness = {
run: vi.fn(),
};
(AgentFactory.createHarness as Mock).mockReturnValue(mockHarness);
const mockChat = {
getHistory: vi.fn().mockReturnValue([
{
role: 'model',
parts: [
{
functionCall: {
name: 'complete_task',
args: { report: 'The custom report content' },
},
},
],
},
]),
};
const mockTurn = {
getResponseText: vi.fn().mockReturnValue(''),
chat: mockChat,
} as unknown as Turn;
mockHarness.run.mockReturnValue(
(async function* () {
yield* [];
return mockTurn;
})(),
);
const result = await invocation.execute(new AbortController().signal);
expect(result.data?.['report']).toBe('The custom report content');
expect(result.returnDisplay).toContain('The custom report content');
});
it('prioritizes complete_task args over whitespace-only text', async () => {
const invocation = new HarnessSubagentInvocation(
definition,
mockConfig,
{},
mockMessageBus,
);
const mockHarness = {
run: vi.fn(),
};
(AgentFactory.createHarness as Mock).mockReturnValue(mockHarness);
const mockChat = {
getHistory: vi.fn().mockReturnValue([
{
role: 'model',
parts: [
{ text: ' \n ' },
{
functionCall: {
name: 'complete_task',
args: { result: 'Actual Result' },
},
},
],
},
]),
};
const mockTurn = {
getResponseText: vi.fn().mockReturnValue(' \n '),
chat: mockChat,
} as unknown as Turn;
mockHarness.run.mockReturnValue(
(async function* () {
yield* [];
return mockTurn;
})(),
);
const result = await invocation.execute(new AbortController().signal);
expect(result.data?.['result']).toBe('Actual Result');
expect(result.returnDisplay).toContain('Actual Result');
});
});
@@ -0,0 +1,297 @@
/**
* @license
* Copyright 2026 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import type { Config } from '../config/config.js';
import type { AnsiOutput } from '../utils/terminalSerializer.js';
import { BaseToolInvocation, type ToolResult } from '../tools/tools.js';
import { ToolErrorType } from '../tools/tool-error.js';
import { debugLogger } from '../utils/debugLogger.js';
import type { LocalAgentDefinition, AgentInputs } from './types.js';
import type { MessageBus } from '../confirmation-bus/message-bus.js';
import { MessageBusType } from '../confirmation-bus/types.js';
import { AgentFactory } from './agent-factory.js';
import { type Turn, GeminiEventType } from '../core/turn.js';
import { promptIdContext } from '../utils/promptIdContext.js';
const INPUT_PREVIEW_MAX_LENGTH = 50;
const DESCRIPTION_MAX_LENGTH = 200;
/**
* A specialized invocation for running subagents within the AgentHarness.
* COMPLETELY FORKED from LocalSubagentInvocation to ensure isolated logic.
*/
export class HarnessSubagentInvocation extends BaseToolInvocation<
AgentInputs,
ToolResult
> {
constructor(
private readonly definition: LocalAgentDefinition,
private readonly config: Config,
params: AgentInputs,
messageBus: MessageBus,
_toolName?: string,
_toolDisplayName?: string,
) {
super(
params,
messageBus,
_toolName ?? definition.name,
_toolDisplayName ?? definition.displayName,
);
}
getDescription(): string {
const inputSummary = Object.entries(this.params)
.map(
([key, value]) =>
`${key}: ${String(value).slice(0, INPUT_PREVIEW_MAX_LENGTH)}`,
)
.join(', ');
return `Running harness subagent '${this.definition.name}' with inputs: { ${inputSummary} }`.slice(
0,
DESCRIPTION_MAX_LENGTH,
);
}
async execute(
signal: AbortSignal,
updateOutput?: (output: string | AnsiOutput) => void,
): Promise<ToolResult> {
try {
if (updateOutput) {
updateOutput(`Subagent ${this.definition.name} starting (Harness Mode)...
`);
}
const harness = AgentFactory.createHarness(this.config, this.definition, {
inputs: this.params,
parentPromptId: promptIdContext.getStore(),
});
const initialRequest = [{ text: 'Start' }];
const stream = harness.run(
initialRequest,
signal,
this.definition.runConfig?.maxTurns,
);
let turn: Turn | undefined;
let lastThought = '';
while (true) {
const { value, done } = await stream.next();
if (done) {
turn = value;
break;
}
const event = value;
if (updateOutput) {
if (event.type === GeminiEventType.Thought && 'value' in event) {
lastThought = event.value.subject;
updateOutput(`🤖💭 ${lastThought}\n`);
// Also publish to message bus so UI hooks can see it regardless of where they listen
void this.messageBus.publish({
type: MessageBusType.SUBAGENT_ACTIVITY,
activity: {
agentName: this.definition.name,
type: 'THOUGHT',
data: { subject: lastThought },
},
});
} else if (
event.type === GeminiEventType.SubagentActivity &&
'value' in event
) {
if (event.value.type === 'TOOL_CALL_START') {
const toolName = String(event.value.data['name'] || 'a tool');
updateOutput(`🛠️ Calling ${toolName}...\n`);
}
// Forward the core activity to the global bus
void this.messageBus.publish({
type: MessageBusType.SUBAGENT_ACTIVITY,
// eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-type-assertion
activity: event.value as any,
});
}
}
}
if (!turn) {
throw new Error('Agent failed to return a valid turn.');
}
// 1. Initialize result with the explicit submitted output if available
let finalResultRaw: unknown = turn.submittedOutput;
// 2. Fallback: If no explicit output, try textual response
if (finalResultRaw === undefined) {
const output = turn.getResponseText();
debugLogger.debug(
`[AgentHarness] [Invocation:${this.definition.name}] Initial response text: "${output}"`,
);
if (output.trim()) {
finalResultRaw = output;
}
}
const outputName = this.definition.outputConfig?.outputName || 'result';
// 3. Fallback: If still no result, extract from 'complete_task' tool call arguments (Directly from the turn)
if (finalResultRaw === undefined) {
const completeCall = turn.pendingToolCalls?.find(
(c) => c.name === 'complete_task',
);
if (completeCall) {
debugLogger.debug(
`[AgentHarness] [Invocation:${this.definition.name}] Found 'complete_task' call in pending tool calls.`,
);
finalResultRaw =
completeCall.args[outputName] || completeCall.args['result'];
if (finalResultRaw !== undefined) {
debugLogger.debug(
`[AgentHarness] [Invocation:${this.definition.name}] Extracted raw result from complete_task args (${outputName}).`,
);
}
}
}
// 4. Fallback: If no result yet, look for any definitive findings in the history
if (finalResultRaw === undefined) {
debugLogger.debug(
`[AgentHarness] [Invocation:${this.definition.name}] No direct result found, checking history...`,
);
const history = turn.chat.getHistory();
// Find the last model message that has either non-thought text or a complete_task call
const lastMsgWithResult = history.findLast(
(m) =>
m.role === 'model' &&
m.parts &&
(m.parts.some(
(p) =>
!('thought' in p && p.thought) && 'text' in p && p.text?.trim(),
) ||
m.parts.some(
(p) =>
'functionCall' in p &&
p.functionCall &&
p.functionCall.name === 'complete_task',
)),
);
if (lastMsgWithResult?.parts) {
// Check for text part first (likely injected by Harness)
const textPart = lastMsgWithResult.parts.find(
(p) =>
!('thought' in p && p.thought) && 'text' in p && p.text?.trim(),
);
if (textPart && 'text' in textPart && textPart.text) {
finalResultRaw = textPart.text;
debugLogger.debug(
`[AgentHarness] [Invocation:${this.definition.name}] Extracted result from history text part.`,
);
} else {
// Check for complete_task call in history (what the tests use)
const callPart = lastMsgWithResult.parts.find(
(p) =>
'functionCall' in p && p.functionCall?.name === 'complete_task',
);
if (
callPart &&
'functionCall' in callPart &&
callPart.functionCall
) {
finalResultRaw =
// eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
(callPart.functionCall.args as Record<string, unknown>)?.[
outputName
] ||
// eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
(callPart.functionCall.args as Record<string, unknown>)?.[
'result'
];
if (finalResultRaw !== undefined) {
debugLogger.debug(
`[AgentHarness] [Invocation:${this.definition.name}] Extracted result from history function call.`,
);
}
}
}
}
}
const finalResultString =
typeof finalResultRaw === 'object'
? JSON.stringify(finalResultRaw, null, 2)
: String(finalResultRaw ?? 'Task completed.');
const displayContent = `
Subagent ${this.definition.name} Finished (Harness Mode)
Result:
${finalResultString}
`;
if (updateOutput) {
updateOutput(displayContent);
}
// Parse as JSON if it's a string that looks like an object, to satisfy schema requirements
let finalResultData = finalResultRaw ?? 'Task completed.';
if (
typeof finalResultData === 'string' &&
finalResultData.trim().startsWith('{')
) {
try {
finalResultData = JSON.parse(finalResultData);
debugLogger.debug(
`[AgentHarness] [Invocation:${this.definition.name}] Parsed string result into JSON object.`,
);
} catch (_e) {
// Not valid JSON, keep as string
}
}
debugLogger.debug(
`[AgentHarness] [Invocation:${this.definition.name}] Returning data to parent: ${JSON.stringify(
finalResultData,
).slice(0, 500)}...`,
);
const resultContent = `Subagent '${this.definition.name}' finished.
Termination Reason: goal
Result:
${finalResultString}`;
return {
llmContent: [{ text: resultContent }],
returnDisplay: displayContent,
data: {
[outputName]: finalResultData,
result: finalResultData,
},
};
} catch (error) {
const errorMessage =
error instanceof Error ? error.message : String(error);
return {
llmContent: [],
returnDisplay: `Subagent Failed: ${this.definition.name}
Error: ${errorMessage}`,
error: {
message: errorMessage,
type: ToolErrorType.EXECUTION_FAILED,
},
};
}
}
}
+447
View File
@@ -0,0 +1,447 @@
/**
* @license
* Copyright 2026 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import { describe, it, expect, vi, beforeEach, type Mock } from 'vitest';
import { AgentHarness } from './harness.js';
import { makeFakeConfig } from '../test-utils/config.js';
import { GeminiChat, StreamEventType } from '../core/geminiChat.js';
import { GeminiEventType, type ServerGeminiStreamEvent } from '../core/turn.js';
import { z } from 'zod';
import { AgentTerminateMode, type LocalAgentDefinition } from './types.js';
import { scheduleAgentTools } from './agent-scheduler.js';
import { logAgentFinish } from '../telemetry/loggers.js';
import { type Config } from '../config/config.js';
import { MainAgentBehavior, SubagentBehavior } from './behavior.js';
vi.mock('../telemetry/loggers.js', async (importOriginal) => {
const actual =
await importOriginal<typeof import('../telemetry/loggers.js')>();
return {
...actual,
logAgentStart: vi.fn(),
logAgentFinish: vi.fn(),
};
});
vi.mock('../core/geminiChat.js', () => ({
GeminiChat: vi.fn(),
StreamEventType: {
CHUNK: 'chunk',
},
}));
vi.mock('./agent-scheduler.js', () => ({
scheduleAgentTools: vi.fn(),
}));
describe('AgentHarness', () => {
let mockConfig: Config;
beforeEach(() => {
mockConfig = makeFakeConfig();
mockConfig.getToolRegistry = vi.fn().mockReturnValue({
getTool: vi.fn(),
getAllToolNames: vi.fn().mockReturnValue([]),
getFunctionDeclarations: vi.fn().mockReturnValue([]),
registerTool: vi.fn(),
sortTools: vi.fn(),
});
mockConfig.getAgentRegistry = vi.fn().mockReturnValue({
getAllDefinitions: vi.fn().mockReturnValue([]),
});
mockConfig.getEnableHooks = vi.fn().mockReturnValue(false);
mockConfig.getHookSystem = vi.fn().mockReturnValue(null);
mockConfig.getIdeMode = vi.fn().mockReturnValue(false);
mockConfig.getBaseLlmClient = vi.fn().mockReturnValue({});
mockConfig.getModelRouterService = vi.fn().mockReturnValue({
route: vi.fn().mockResolvedValue({
model: 'gemini-test-model',
metadata: { source: 'test' },
}),
});
vi.clearAllMocks();
});
describe('SubagentBehavior', () => {
it('executes a subagent and finishes when complete_task is called', async () => {
const definition: LocalAgentDefinition<z.ZodUnknown> = {
kind: 'local',
name: 'test-agent',
displayName: 'Test Agent',
description: 'A test agent',
inputConfig: {
inputSchema: { type: 'object', properties: {}, required: [] },
},
modelConfig: { model: 'gemini-test-model' },
runConfig: { maxTurns: 5, maxTimeMinutes: 5 },
promptConfig: { systemPrompt: 'You are a test agent.' },
outputConfig: {
outputName: 'result',
description: 'The final result.',
schema: z.unknown(),
},
};
const behavior = new SubagentBehavior(mockConfig, definition);
const harness = new AgentHarness({
config: mockConfig,
behavior,
isolatedTools: true,
});
const mockChat = {
sendMessageStream: vi.fn(),
setTools: vi.fn(),
getHistory: vi.fn().mockReturnValue([]),
addHistory: vi.fn(),
setSystemInstruction: vi.fn(),
maybeIncludeSchemaDepthContext: vi.fn(),
getLastPromptTokenCount: vi.fn().mockReturnValue(0),
} as unknown as GeminiChat;
(GeminiChat as unknown as Mock).mockReturnValue(mockChat);
// Mock model response with complete_task call
(mockChat.sendMessageStream as Mock).mockResolvedValue(
(async function* () {
yield {
type: StreamEventType.CHUNK,
value: {
candidates: [
{
content: { parts: [{ text: 'Done!' }] },
finishReason: 'STOP',
},
],
functionCalls: [
{
name: 'complete_task',
args: { result: 'Success' },
id: 'call_1',
},
],
},
};
})(),
);
// Mock tool execution
(scheduleAgentTools as unknown as Mock).mockResolvedValue([
{
request: {
name: 'complete_task',
args: { result: 'Success' },
callId: 'call_1',
},
status: 'success',
response: {
responseParts: [
{
functionResponse: {
name: 'complete_task',
response: { status: 'OK' },
id: 'call_1',
},
},
],
},
},
]);
const events: ServerGeminiStreamEvent[] = [];
const run = harness.run(
[{ text: 'Start' }],
new AbortController().signal,
);
while (true) {
const { value, done } = await run.next();
if (done) break;
events.push(value);
}
expect(
events.some(
(e) =>
e.type === GeminiEventType.ToolCallRequest &&
e.value.name === 'complete_task',
),
).toBe(true);
expect(vi.mocked(logAgentFinish)).toHaveBeenCalledWith(
expect.anything(),
expect.objectContaining({ terminate_reason: AgentTerminateMode.GOAL }),
);
});
it('handles multiple turns and model routing', async () => {
const definition: LocalAgentDefinition<z.ZodUnknown> = {
kind: 'local',
name: 'multi-turn-agent',
description: 'Testing multiple turns',
inputConfig: {
inputSchema: { type: 'object', properties: {}, required: [] },
},
modelConfig: { model: 'initial-model' },
runConfig: { maxTurns: 5 },
promptConfig: { systemPrompt: 'Test' },
};
const behavior = new SubagentBehavior(mockConfig, definition);
const harness = new AgentHarness({ config: mockConfig, behavior });
const mockChat = {
sendMessageStream: vi.fn(),
setTools: vi.fn(),
getHistory: vi.fn().mockReturnValue([]),
addHistory: vi.fn(),
setSystemInstruction: vi.fn(),
maybeIncludeSchemaDepthContext: vi.fn(),
getLastPromptTokenCount: vi.fn().mockReturnValue(0),
} as unknown as GeminiChat;
(GeminiChat as unknown as Mock).mockReturnValue(mockChat);
// Turn 1: Model calls a tool
(mockChat.sendMessageStream as Mock).mockResolvedValueOnce(
(async function* () {
yield {
type: StreamEventType.CHUNK,
value: {
candidates: [
{
content: { parts: [{ text: 'Thinking...' }] },
finishReason: 'STOP',
},
],
functionCalls: [{ name: 'tool_1', args: {}, id: 'c1' }],
},
};
})(),
);
// Turn 2: Model finishes with complete_task
(mockChat.sendMessageStream as Mock).mockResolvedValueOnce(
(async function* () {
yield {
type: StreamEventType.CHUNK,
value: {
candidates: [
{
content: { parts: [{ text: 'Done' }] },
finishReason: 'STOP',
},
],
functionCalls: [
{
name: 'complete_task',
args: { result: 'Success' },
id: 'c2',
},
],
},
};
})(),
);
(scheduleAgentTools as unknown as Mock).mockResolvedValue([
{
request: { name: 'tool_1', callId: 'c1' },
status: 'success',
response: {
responseParts: [
{ functionResponse: { name: 'tool_1', response: {}, id: 'c1' } },
],
},
},
]);
const run = harness.run(
[{ text: 'Start' }],
new AbortController().signal,
);
while (true) {
const { done } = await run.next();
if (done) break;
}
// Should have called LLM twice
expect(mockChat.sendMessageStream).toHaveBeenCalledTimes(2);
expect(mockConfig.getModelRouterService().route).toHaveBeenCalled();
});
it('attempts recovery when max turns is reached', async () => {
const definition: LocalAgentDefinition<z.ZodUnknown> = {
kind: 'local',
name: 'unproductive-agent',
description: 'Reaches max turns',
inputConfig: {
inputSchema: { type: 'object', properties: {}, required: [] },
},
modelConfig: { model: 'test' },
runConfig: { maxTurns: 1 },
promptConfig: { systemPrompt: 'Test' },
};
const behavior = new SubagentBehavior(mockConfig, definition);
const harness = new AgentHarness({ config: mockConfig, behavior });
const mockChat = {
sendMessageStream: vi.fn(),
setTools: vi.fn(),
getHistory: vi.fn().mockReturnValue([]),
addHistory: vi.fn(),
setSystemInstruction: vi.fn(),
maybeIncludeSchemaDepthContext: vi.fn(),
getLastPromptTokenCount: vi.fn().mockReturnValue(0),
} as unknown as GeminiChat;
(GeminiChat as unknown as Mock).mockReturnValue(mockChat);
// Turn 1: Model does nothing (just content) -> reaches limit
(mockChat.sendMessageStream as Mock).mockResolvedValueOnce(
(async function* () {
yield {
type: StreamEventType.CHUNK,
value: {
candidates: [
{
content: { parts: [{ text: 'Thinking...' }] },
finishReason: 'STOP',
},
],
},
};
})(),
);
// Turn 2 (Recovery): Model yields complete_task
(mockChat.sendMessageStream as Mock).mockResolvedValueOnce(
(async function* () {
yield {
type: StreamEventType.CHUNK,
value: {
candidates: [
{
content: { parts: [{ text: 'Final Answer' }] },
finishReason: 'STOP',
},
],
functionCalls: [
{
name: 'complete_task',
args: { result: 'Recovered' },
id: 'rec',
},
],
},
};
})(),
);
const run = harness.run(
[{ text: 'Start' }],
new AbortController().signal,
);
while (true) {
const { done } = await run.next();
if (done) break;
}
// Expect goal to be reached via recovery
expect(vi.mocked(logAgentFinish)).toHaveBeenCalledWith(
expect.anything(),
expect.objectContaining({ terminate_reason: AgentTerminateMode.GOAL }),
);
});
});
describe('MainAgentBehavior', () => {
it('fires BeforeAgent hooks and handles blocking', async () => {
const behavior = new MainAgentBehavior(mockConfig);
const harness = new AgentHarness({ config: mockConfig, behavior });
const mockHookSystem = {
fireBeforeAgentEvent: vi.fn().mockResolvedValue({
shouldStopExecution: () => true,
isBlockingDecision: () => true,
getEffectiveReason: () => 'Blocked by hook',
systemMessage: 'Access denied',
getAdditionalContext: () => undefined,
}),
};
mockConfig.getHookSystem = vi.fn().mockReturnValue(mockHookSystem);
mockConfig.getEnableHooks = vi.fn().mockReturnValue(true);
const events: ServerGeminiStreamEvent[] = [];
const run = harness.run(
[{ text: 'Hello' }],
new AbortController().signal,
);
while (true) {
const { value, done } = await run.next();
if (done) break;
events.push(value);
}
expect(
events.some(
(e) =>
e.type === GeminiEventType.Error &&
e.value.error.message === 'Access denied',
),
).toBe(true);
expect(vi.mocked(logAgentFinish)).toHaveBeenCalledWith(
expect.anything(),
expect.objectContaining({
terminate_reason: AgentTerminateMode.ABORTED,
}),
);
});
it('syncs IDE context when IDE mode is enabled', async () => {
const behavior = new MainAgentBehavior(mockConfig);
const harness = new AgentHarness({ config: mockConfig, behavior });
mockConfig.getIdeMode = vi.fn().mockReturnValue(true);
const mockChat = {
sendMessageStream: vi.fn().mockResolvedValue(
(async function* () {
yield {
type: StreamEventType.CHUNK,
value: {
candidates: [
{
content: { parts: [{ text: 'Response' }] },
finishReason: 'STOP',
},
],
},
};
})(),
),
setTools: vi.fn(),
getHistory: vi.fn().mockReturnValue([]),
addHistory: vi.fn(),
setSystemInstruction: vi.fn(),
getLastPromptTokenCount: vi.fn().mockReturnValue(0),
} as unknown as GeminiChat;
(GeminiChat as unknown as Mock).mockReturnValue(mockChat);
const syncSpy = vi.spyOn(behavior, 'syncEnvironment');
const run = harness.run(
[{ text: 'Hello' }],
new AbortController().signal,
);
while (true) {
const { done } = await run.next();
if (done) break;
}
expect(syncSpy).toHaveBeenCalled();
});
});
});
+645
View File
@@ -0,0 +1,645 @@
/**
* @license
* Copyright 2026 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import {
type Part,
type FunctionDeclaration,
type Content,
} from '@google/genai';
import { type Config } from '../config/config.js';
import { GeminiChat } from '../core/geminiChat.js';
import {
Turn,
GeminiEventType,
type ServerGeminiStreamEvent,
CompressionStatus,
} from '../core/turn.js';
import {
AgentTerminateMode,
type AgentInputs,
DEFAULT_MAX_TURNS,
DEFAULT_MAX_TIME_MINUTES,
} from './types.js';
import { LoopDetectionService } from '../services/loopDetectionService.js';
import { ChatCompressionService } from '../services/chatCompressionService.js';
import { ToolOutputMaskingService } from '../services/toolOutputMaskingService.js';
import { resolveModel } from '../config/models.js';
import { type RoutingContext } from '../routing/routingStrategy.js';
import { ToolRegistry } from '../tools/tool-registry.js';
import { SubagentTool } from './subagent-tool.js';
import { scheduleAgentTools } from './agent-scheduler.js';
import {
type ToolCallRequestInfo,
type ToolCallResponseInfo,
ROOT_SCHEDULER_ID,
} from '../scheduler/types.js';
import { promptIdContext } from '../utils/promptIdContext.js';
import { logAgentStart, logAgentFinish } from '../telemetry/loggers.js';
import { AgentStartEvent, AgentFinishEvent } from '../telemetry/types.js';
import { DeadlineTimer } from '../utils/deadlineTimer.js';
import { type AgentBehavior } from './behavior.js';
import { debugLogger } from '../utils/debugLogger.js';
const TASK_COMPLETE_TOOL_NAME = 'complete_task';
export interface AgentHarnessOptions {
config: Config;
behavior: AgentBehavior;
/** Is this an isolated tool registry (subagents)? If not provided, uses global. */
isolatedTools?: boolean;
/** Inputs for subagent templating. */
inputs?: AgentInputs;
/** If provided, this prompt_id will be used as a prefix. */
parentPromptId?: string;
/** Existing chat history to initialize with (e.g. for main agent turns). */
history?: Content[];
}
/**
* A unified harness for executing agents (both main CLI and subagents).
* Consolidates ReAct loop logic, tool scheduling, and state management.
*
* Uses an AgentBehavior plugin to handle specific personality differences.
*/
export class AgentHarness {
private readonly config: Config;
private readonly behavior: AgentBehavior;
private readonly loopDetector: LoopDetectionService;
private readonly compressionService: ChatCompressionService;
private readonly toolOutputMaskingService: ToolOutputMaskingService;
private readonly toolRegistry: ToolRegistry;
private readonly initialHistory?: Content[];
private chat?: GeminiChat;
private currentSequenceModel: string | null = null;
private turnCounter = 0;
constructor(options: AgentHarnessOptions) {
this.config = options.config;
this.behavior = options.behavior;
this.initialHistory = options.history;
this.loopDetector = new LoopDetectionService(this.config);
this.compressionService = new ChatCompressionService();
this.toolOutputMaskingService = new ToolOutputMaskingService();
// Use an isolated tool registry for subagents, or the global one for the main agent.
this.toolRegistry = options.isolatedTools
? new ToolRegistry(this.config, this.config.getMessageBus())
: this.config.getToolRegistry();
}
/**
* Initializes the harness, creating the underlying chat object.
*/
async initialize(): Promise<void> {
await this.behavior.initialize(this.toolRegistry);
this.chat = await this.createChat();
}
private async createChat(): Promise<GeminiChat> {
const systemInstruction = await this.behavior.getSystemInstruction();
const history =
this.initialHistory ?? (await this.behavior.getInitialHistory());
const tools = this.prepareToolsList();
return new GeminiChat(
this.config,
systemInstruction,
[{ functionDeclarations: tools }],
history,
);
}
private prepareToolsList(): FunctionDeclaration[] {
const modelId = this.currentSequenceModel ?? undefined;
const baseTools = this.toolRegistry.getFunctionDeclarations(modelId);
return this.behavior.prepareTools(baseTools);
}
/**
* Runs the agent with the given request.
*/
async *run(
request: Part[],
signal: AbortSignal,
maxTurns?: number,
): AsyncGenerator<ServerGeminiStreamEvent, Turn> {
const startTime = Date.now();
const maxTurnsLimit = maxTurns ?? DEFAULT_MAX_TURNS;
const maxTimeMinutes = DEFAULT_MAX_TIME_MINUTES;
debugLogger.debug(
`[AgentHarness] [${this.behavior.name}:${this.behavior.agentId}] Starting unified ReAct loop. maxTurns: ${maxTurnsLimit}, maxTime: ${maxTimeMinutes}m`,
);
const deadlineTimer = new DeadlineTimer(
maxTimeMinutes * 60 * 1000,
'Agent timed out.',
);
// Track time spent waiting for user confirmation
const onWaitingForConfirmation = (waiting: boolean) => {
if (waiting) {
deadlineTimer.pause();
} else {
deadlineTimer.resume();
}
};
const combinedSignal = AbortSignal.any([signal, deadlineTimer.signal]);
logAgentStart(
this.config,
new AgentStartEvent(this.behavior.agentId, this.behavior.name),
);
if (!this.chat) {
await this.initialize();
}
let turn = new Turn(this.chat!, this.behavior.agentId);
let currentRequest = await this.behavior.transformRequest(request);
let terminateReason = AgentTerminateMode.ABORTED;
try {
while (this.turnCounter < maxTurnsLimit) {
const promptId = `${this.behavior.agentId}#${this.turnCounter}`;
const historySize = this.chat?.getHistory().length || 0;
debugLogger.debug(
`[AgentHarness] [${this.behavior.name}:${this.behavior.agentId}] Starting turn ${this.turnCounter} (promptId: ${promptId}). History size: ${historySize} messages.`,
);
if (combinedSignal.aborted) {
terminateReason = deadlineTimer.signal.aborted
? AgentTerminateMode.TIMEOUT
: AgentTerminateMode.ABORTED;
if (terminateReason === AgentTerminateMode.ABORTED) {
yield { type: GeminiEventType.UserCancelled };
}
break;
}
// 1. Hook: Before Agent
const beforeResult =
await this.behavior.fireBeforeAgent(currentRequest);
if (beforeResult.stop) {
terminateReason = AgentTerminateMode.ABORTED;
if (beforeResult.systemMessage) {
yield {
type: GeminiEventType.Error,
value: { error: { message: beforeResult.systemMessage } },
};
}
break;
}
if (beforeResult.additionalContext) {
currentRequest.push({
text: `<hook_context>${beforeResult.additionalContext}</hook_context>`,
});
}
// 2. Sync Environment (IDE Context etc)
const envSync = await this.behavior.syncEnvironment(
this.chat!.getHistory(),
);
if (envSync.additionalParts) {
currentRequest.push(...envSync.additionalParts);
}
// 3. Compression
const compressionResult = await this.tryCompressChat(promptId);
if (
compressionResult.compressionStatus === CompressionStatus.COMPRESSED
) {
yield {
type: GeminiEventType.ChatCompressed,
value: compressionResult,
};
}
await this.toolOutputMaskingService.mask(
this.chat!.getHistory(),
this.config,
);
// 4. Loop Detection
if (await this.loopDetector.turnStarted(combinedSignal)) {
terminateReason = AgentTerminateMode.LOOP_DETECTED;
yield { type: GeminiEventType.LoopDetected };
return turn;
}
// 5. Model Selection/Routing
const modelToUse = await this.selectModel(
currentRequest,
combinedSignal,
);
if (!this.currentSequenceModel) {
yield { type: GeminiEventType.ModelInfo, value: modelToUse };
this.currentSequenceModel = modelToUse;
}
// 6. Update tools for this model
this.chat!.setTools([
{ functionDeclarations: this.prepareToolsList() },
]);
// 7. Run the turn
const turnStream = promptIdContext.run(promptId, () =>
turn.run({ model: modelToUse }, currentRequest, combinedSignal),
);
let hasError = false;
let cumulativeResponse = '';
for await (const event of turnStream) {
yield event;
if (event.type === GeminiEventType.Error) hasError = true;
if (event.type === GeminiEventType.Content && event.value) {
cumulativeResponse += event.value;
}
// Subagent activity reporting
if (this.behavior.name !== 'main') {
const displayName =
this.behavior.definition?.displayName || this.behavior.name;
if (event.type === GeminiEventType.Thought) {
yield {
type: GeminiEventType.SubagentActivity,
value: {
agentName: displayName,
type: 'THOUGHT',
data: { subject: event.value.subject },
},
};
}
if (event.type === GeminiEventType.ToolCallRequest) {
yield {
type: GeminiEventType.SubagentActivity,
value: {
agentName: displayName,
type: 'TOOL_CALL_START',
data: { name: event.value.name, args: event.value.args },
},
};
}
}
}
if (hasError) {
terminateReason = AgentTerminateMode.ERROR;
return turn;
}
// 8. Hook: After Agent
const afterResult = await this.behavior.fireAfterAgent(
currentRequest,
cumulativeResponse,
turn,
);
if (afterResult.stop) {
terminateReason = AgentTerminateMode.GOAL;
if (afterResult.contextCleared) {
await this.initialize();
}
break;
}
if (afterResult.shouldContinue) {
currentRequest = [{ text: afterResult.reason || 'Continue' }];
this.turnCounter++;
turn = new Turn(this.chat!, this.behavior.agentId);
continue;
}
if (combinedSignal.aborted) {
terminateReason = deadlineTimer.signal.aborted
? AgentTerminateMode.TIMEOUT
: AgentTerminateMode.ABORTED;
break;
}
// 9. Handle tool calls or termination
if (turn.pendingToolCalls.length > 0) {
const toolResults = await this.executeTools(
turn.pendingToolCalls,
combinedSignal,
onWaitingForConfirmation,
);
debugLogger.debug(
`[AgentHarness] [${this.behavior.name}:${this.behavior.agentId}] Received ${toolResults.length} tool results. Names: ${toolResults.map((tr) => tr.name).join(', ')}`,
);
// Yield responses so UI knows they are done
for (const result of toolResults) {
debugLogger.debug(
`[AgentHarness] [${this.behavior.name}:${this.behavior.agentId}] Tool ${result.name} finished. Display length: ${String(result.result?.resultDisplay).length}`,
);
if (result.result) {
yield {
type: GeminiEventType.ToolCallResponse,
value: result.result,
};
// Subagent activity reporting
if (this.behavior.name !== 'main') {
yield {
type: GeminiEventType.SubagentActivity,
value: {
agentName: this.behavior.name,
type: 'TOOL_CALL_END',
data: {
name: result.name,
output: result.result.resultDisplay,
},
},
};
}
const tool = this.toolRegistry.getTool(result.name);
if (tool instanceof SubagentTool) {
yield {
type: GeminiEventType.SubagentActivity,
value: {
agentName: this.behavior.name,
type: 'TOOL_CALL_END',
data: {
name: result.name,
output: result.result.resultDisplay,
},
},
};
}
}
}
const goalReached = this.behavior.isGoalReached(toolResults);
debugLogger.debug(
`[AgentHarness] [${this.behavior.name}:${this.behavior.agentId}] isGoalReached check: ${goalReached}`,
);
if (goalReached) {
terminateReason = AgentTerminateMode.GOAL;
debugLogger.debug(
`[AgentHarness] [${this.behavior.name}:${this.behavior.agentId}] Goal reached. Processing findings for ${toolResults.length} tool results.`,
);
// Extract results from the 'complete_task' tool call arguments
for (const r of toolResults) {
const completeCall = turn.pendingToolCalls.find(
(c) => c.name === TASK_COMPLETE_TOOL_NAME,
);
let findingsText: string | undefined;
if (r.name === TASK_COMPLETE_TOOL_NAME && completeCall) {
const outputName =
this.behavior.definition?.outputConfig?.outputName ||
'result';
const args = completeCall.args;
const rawFindings = args[outputName] || args['result'];
debugLogger.debug(
`[AgentHarness] [${this.behavior.name}:${this.behavior.agentId}] Extracting from complete_task args (${outputName}). Found: ${!!rawFindings}`,
);
if (rawFindings !== undefined) {
// CAPTURE RAW DATA: Don't stringify if it's an object/array,
// we need to preserve structure for the parent model.
turn.submittedOutput = rawFindings;
findingsText =
typeof rawFindings === 'object'
? JSON.stringify(rawFindings, null, 2)
: String(rawFindings);
}
} else {
const findings =
r.result?.data?.['result'] || r.result?.resultDisplay;
if (findings !== undefined) {
findingsText = String(findings);
// Also capture as raw if not already set
if (turn.submittedOutput === undefined) {
turn.submittedOutput = findings;
}
}
}
if (findingsText) {
debugLogger.debug(
`[AgentHarness] [${this.behavior.name}:${this.behavior.agentId}] Captured findings text. Length: ${findingsText.length}`,
);
}
}
return turn;
}
currentRequest = toolResults.map((r) => r.part);
this.turnCounter++;
if (this.turnCounter >= maxTurnsLimit) {
terminateReason = AgentTerminateMode.MAX_TURNS;
debugLogger.debug(
`[AgentHarness] [${this.behavior.name}:${this.behavior.agentId}] Reached turn limit (${maxTurnsLimit}).`,
);
break;
}
turn = new Turn(this.chat!, this.behavior.agentId);
// Only yield TurnFinished if we are the main agent.
// Nested subagent turns should be internal and not trigger UI flushes in the parent.
if (this.behavior.name === 'main') {
yield { type: GeminiEventType.TurnFinished };
}
} else {
// No tool calls. Check for continuation.
const nextParts = await this.behavior.getContinuationRequest(
turn,
combinedSignal,
);
if (nextParts) {
currentRequest = nextParts;
this.turnCounter++;
if (this.turnCounter >= maxTurnsLimit) {
terminateReason = AgentTerminateMode.MAX_TURNS;
debugLogger.debug(
`[AgentHarness] [${this.behavior.name}:${this.behavior.agentId}] Reached turn limit (${maxTurnsLimit}) during continuation.`,
);
break;
}
turn = new Turn(this.chat!, this.behavior.agentId);
if (this.behavior.name === 'main') {
yield { type: GeminiEventType.TurnFinished };
}
continue;
}
if (this.behavior.name !== 'main') {
terminateReason = AgentTerminateMode.ERROR_NO_COMPLETE_TASK_CALL;
} else {
terminateReason = AgentTerminateMode.GOAL;
}
break;
}
}
// FINALIZATION & RECOVERY
if (
terminateReason !== AgentTerminateMode.GOAL &&
terminateReason !== AgentTerminateMode.ABORTED
) {
if (this.turnCounter >= maxTurnsLimit)
terminateReason = AgentTerminateMode.MAX_TURNS;
const recoverySuccess = yield* this.behavior.executeRecovery(
turn,
terminateReason,
signal,
);
if (recoverySuccess) {
terminateReason = AgentTerminateMode.GOAL;
return turn;
}
if (this.behavior.name !== 'main') {
yield {
type: GeminiEventType.Error,
value: {
error: {
message: this.behavior.getFinalFailureMessage(
terminateReason,
maxTurnsLimit,
maxTimeMinutes,
),
},
},
};
}
}
} finally {
deadlineTimer.abort();
const duration = Date.now() - startTime;
debugLogger.debug(
`[AgentHarness] [${this.behavior.name}:${this.behavior.agentId}] Finished. Outcome: ${terminateReason}, Duration: ${duration}ms, Turns: ${this.turnCounter}`,
);
logAgentFinish(
this.config,
new AgentFinishEvent(
this.behavior.agentId,
this.behavior.name,
duration,
this.turnCounter,
terminateReason,
),
);
}
return turn;
}
private async tryCompressChat(promptId: string) {
const model =
this.currentSequenceModel ?? resolveModel(this.config.getActiveModel());
const { info } = await this.compressionService.compress(
this.chat!,
promptId,
false,
model,
this.config,
false,
);
return info;
}
private async selectModel(
request: Part[],
signal: AbortSignal,
): Promise<string> {
if (this.currentSequenceModel) return this.currentSequenceModel;
const routingContext: RoutingContext = {
history: this.chat!.getHistory(true),
request,
signal,
requestedModel: this.config.getModel(),
};
const decision = await this.config
.getModelRouterService()
.route(routingContext);
return decision.model;
}
private async executeTools(
calls: ToolCallRequestInfo[],
signal: AbortSignal,
onWaitingForConfirmation?: (waiting: boolean) => void,
): Promise<
Array<{ name: string; part: Part; result: ToolCallResponseInfo }>
> {
const taskCompleteCalls = calls.filter(
(c) => c.name === TASK_COMPLETE_TOOL_NAME,
);
const otherCalls = calls.filter((c) => c.name !== TASK_COMPLETE_TOOL_NAME);
debugLogger.debug(
`[AgentHarness] [${this.behavior.name}:${this.behavior.agentId}] Executing ${calls.length} tool calls (${otherCalls.length} scheduled)`,
);
let completedCalls: Array<{
request: ToolCallRequestInfo;
response: ToolCallResponseInfo;
}> = [];
if (otherCalls.length > 0) {
const schedulerId =
this.behavior.name === 'main'
? ROOT_SCHEDULER_ID
: this.behavior.agentId;
completedCalls = await scheduleAgentTools(this.config, otherCalls, {
schedulerId,
toolRegistry: this.toolRegistry,
signal,
onWaitingForConfirmation,
});
}
const results = completedCalls.map((call) => ({
name: call.request.name,
part: call.response.responseParts[0],
result: call.response,
}));
for (const call of taskCompleteCalls) {
const response: ToolCallResponseInfo = {
callId: call.callId,
responseParts: [
{
functionResponse: {
name: TASK_COMPLETE_TOOL_NAME,
response: { result: 'Task completed locally' },
id: call.callId,
},
},
],
resultDisplay: 'Task completed locally',
error: undefined,
errorType: undefined,
contentLength: 'Task completed locally'.length,
};
results.push({
name: TASK_COMPLETE_TOOL_NAME,
part: response.responseParts[0],
result: response,
});
}
return results;
}
}
+24 -3
View File
@@ -235,6 +235,9 @@ export class LocalAgentExecutor<TOutput extends z.ZodTypeAny> {
onWaitingForConfirmation?: (waiting: boolean) => void,
): Promise<AgentTurnResult> {
const promptId = `${this.agentId}#${turnCounter}`;
debugLogger.debug(
`[LegacySubagent] [${this.definition.name}:${this.agentId}] Starting turn ${turnCounter} (promptId: ${promptId})`,
);
await this.tryCompressChat(chat, promptId);
@@ -242,6 +245,14 @@ export class LocalAgentExecutor<TOutput extends z.ZodTypeAny> {
this.callModel(chat, currentMessage, combinedSignal, promptId),
);
if (functionCalls.length > 0) {
debugLogger.debug(
`[LegacySubagent] [${this.definition.name}:${this.agentId}] Model made ${
functionCalls.length
} function calls: ${functionCalls.map((fc) => fc.name).join(', ')}`,
);
}
if (combinedSignal.aborted) {
const terminateReason = timeoutSignal.aborted
? AgentTerminateMode.TIMEOUT
@@ -296,7 +307,8 @@ export class LocalAgentExecutor<TOutput extends z.ZodTypeAny> {
reason:
| AgentTerminateMode.TIMEOUT
| AgentTerminateMode.MAX_TURNS
| AgentTerminateMode.ERROR_NO_COMPLETE_TASK_CALL,
| AgentTerminateMode.ERROR_NO_COMPLETE_TASK_CALL
| AgentTerminateMode.LOOP_DETECTED,
): string {
let explanation = '';
switch (reason) {
@@ -327,7 +339,8 @@ export class LocalAgentExecutor<TOutput extends z.ZodTypeAny> {
reason:
| AgentTerminateMode.TIMEOUT
| AgentTerminateMode.MAX_TURNS
| AgentTerminateMode.ERROR_NO_COMPLETE_TASK_CALL,
| AgentTerminateMode.ERROR_NO_COMPLETE_TASK_CALL
| AgentTerminateMode.LOOP_DETECTED,
externalSignal: AbortSignal, // The original signal passed to run()
onWaitingForConfirmation?: (waiting: boolean) => void,
): Promise<string | null> {
@@ -441,6 +454,10 @@ export class LocalAgentExecutor<TOutput extends z.ZodTypeAny> {
// Combine the external signal with the internal timeout signal.
const combinedSignal = AbortSignal.any([signal, deadlineTimer.signal]);
debugLogger.debug(
`[LocalAgentExecutor] [${this.definition.name}:${this.agentId}] Starting agent run`,
);
logAgentStart(
this.runtimeContext,
new AgentStartEvent(this.agentId, this.definition.name),
@@ -612,12 +629,16 @@ export class LocalAgentExecutor<TOutput extends z.ZodTypeAny> {
throw error; // Re-throw other errors or external aborts.
} finally {
deadlineTimer.abort();
const duration = Date.now() - startTime;
debugLogger.debug(
`[LocalAgentExecutor] [${this.definition.name}:${this.agentId}] Finished. Outcome: ${terminateReason}, Duration: ${duration}ms, Turns: ${turnCounter}`,
);
logAgentFinish(
this.runtimeContext,
new AgentFinishEvent(
this.agentId,
this.definition.name,
Date.now() - startTime,
duration,
turnCounter,
terminateReason,
),
@@ -126,6 +126,10 @@ ${output.result}
return {
llmContent: [{ text: resultContent }],
returnDisplay: displayContent,
data: {
result: output.result,
terminate_reason: output.terminate_reason,
},
};
} catch (error) {
const errorMessage =
@@ -13,6 +13,7 @@ import {
import type { Config } from '../config/config.js';
import type { AgentDefinition, AgentInputs } from './types.js';
import { LocalSubagentInvocation } from './local-invocation.js';
import { HarnessSubagentInvocation } from './harness-invocation.js';
import { RemoteAgentInvocation } from './remote-invocation.js';
import type { MessageBus } from '../confirmation-bus/message-bus.js';
@@ -79,6 +80,17 @@ export class SubagentToolWrapper extends BaseDeclarativeTool<
);
}
if (this.config.isAgentHarnessEnabled()) {
return new HarnessSubagentInvocation(
definition,
this.config,
params,
effectiveMessageBus,
_toolName,
_toolDisplayName,
);
}
return new LocalSubagentInvocation(
definition,
this.config,
+2 -1
View File
@@ -25,6 +25,7 @@ export enum AgentTerminateMode {
MAX_TURNS = 'MAX_TURNS',
ABORTED = 'ABORTED',
ERROR_NO_COMPLETE_TASK_CALL = 'ERROR_NO_COMPLETE_TASK_CALL',
LOOP_DETECTED = 'LOOP_DETECTED',
}
/**
@@ -43,7 +44,7 @@ export const DEFAULT_QUERY_STRING = 'Get Started!';
/**
* The default maximum number of conversational turns for an agent.
*/
export const DEFAULT_MAX_TURNS = 15;
export const DEFAULT_MAX_TURNS = 40;
/**
* The default maximum execution time for an agent in minutes.
@@ -58,7 +58,7 @@ describe('Fallback Integration', () => {
);
});
it('should NOT fallback if config is NOT in AUTO mode', () => {
it('should fallback for Gemini 3 models even if config is NOT in AUTO mode', () => {
// 1. Config is explicitly set to Pro, not Auto
vi.spyOn(config, 'getModel').mockReturnValue(PREVIEW_GEMINI_MODEL);
@@ -71,7 +71,7 @@ describe('Fallback Integration', () => {
// 4. Apply model selection
const result = applyModelSelection(config, { model: requestedModel });
// 5. Expect it to stay on Pro (because single model chain)
expect(result.model).toBe(PREVIEW_GEMINI_MODEL);
// 5. Expect it to fallback to Flash (because Gemini 3 uses PREVIEW_CHAIN)
expect(result.model).toBe(PREVIEW_GEMINI_FLASH_MODEL);
});
});
@@ -115,6 +115,19 @@ describe('policyHelpers', () => {
expect(chain[0]?.model).toBe('gemini-2.5-flash');
expect(chain[1]?.model).toBe('gemini-2.5-pro');
});
it('proactively returns Gemini 2.5 chain if Gemini 3 requested but user lacks access', () => {
const config = createMockConfig({
getModel: () => 'auto-gemini-3',
getHasAccessToPreviewModel: () => false,
});
const chain = resolvePolicyChain(config);
// Should downgrade to [Pro 2.5, Flash 2.5]
expect(chain).toHaveLength(2);
expect(chain[0]?.model).toBe('gemini-2.5-pro');
expect(chain[1]?.model).toBe('gemini-2.5-flash');
});
});
describe('buildFallbackPolicyContext', () => {
@@ -24,6 +24,7 @@ import {
DEFAULT_GEMINI_MODEL,
PREVIEW_GEMINI_MODEL_AUTO,
isAutoModel,
isGemini3Model,
resolveModel,
} from '../config/models.js';
import type { ModelSelectionResult } from './modelAvailabilityService.js';
@@ -46,17 +47,32 @@ export function resolvePolicyChain(
const resolvedModel = resolveModel(modelFromConfig);
const isAutoPreferred = preferredModel ? isAutoModel(preferredModel) : false;
const isAutoConfigured = isAutoModel(configuredModel);
const hasAccessToPreview = config.getHasAccessToPreviewModel?.() ?? true;
if (resolvedModel === DEFAULT_GEMINI_FLASH_LITE_MODEL) {
chain = getFlashLitePolicyChain();
} else if (isAutoPreferred || isAutoConfigured) {
const previewEnabled =
preferredModel === PREVIEW_GEMINI_MODEL_AUTO ||
configuredModel === PREVIEW_GEMINI_MODEL_AUTO;
chain = getModelPolicyChain({
previewEnabled,
userTier: config.getUserTier(),
});
} else if (
isGemini3Model(resolvedModel) ||
isAutoPreferred ||
isAutoConfigured
) {
if (hasAccessToPreview) {
const previewEnabled =
isGemini3Model(resolvedModel) ||
preferredModel === PREVIEW_GEMINI_MODEL_AUTO ||
configuredModel === PREVIEW_GEMINI_MODEL_AUTO;
chain = getModelPolicyChain({
previewEnabled,
userTier: config.getUserTier(),
});
} else {
// User requested Gemini 3 but has no access. Proactively downgrade
// to the stable Gemini 2.5 chain.
return getModelPolicyChain({
previewEnabled: false,
userTier: config.getUserTier(),
});
}
} else {
chain = createSingleModelChain(modelFromConfig);
}
+12 -1
View File
@@ -470,6 +470,7 @@ export interface ConfigParameters {
disabledHooks?: string[];
projectHooks?: { [K in HookEventName]?: HookDefinition[] };
enableAgents?: boolean;
enableAgentHarness?: boolean;
enableEventDrivenScheduler?: boolean;
skillsSupport?: boolean;
disabledSkills?: string[];
@@ -654,6 +655,7 @@ export class Config {
| undefined;
private readonly enableAgents: boolean;
private readonly enableAgentHarness: boolean;
private agents: AgentSettings;
private readonly enableEventDrivenScheduler: boolean;
private readonly skillsSupport: boolean;
@@ -748,6 +750,7 @@ export class Config {
this.disableLoopDetection = params.disableLoopDetection ?? false;
this._activeModel = params.model;
this.enableAgents = params.enableAgents ?? false;
this.enableAgentHarness = params.enableAgentHarness ?? false;
this.agents = params.agents ?? {};
this.disableLLMCorrection = params.disableLLMCorrection ?? true;
this.planEnabled = params.plan ?? false;
@@ -758,7 +761,7 @@ export class Config {
this.modelAvailabilityService = new ModelAvailabilityService();
this.experimentalJitContext = params.experimentalJitContext ?? false;
this.toolOutputMasking = {
enabled: params.toolOutputMasking?.enabled ?? false,
enabled: params.toolOutputMasking?.enabled ?? true,
toolProtectionThreshold:
params.toolOutputMasking?.toolProtectionThreshold ??
DEFAULT_TOOL_PROTECTION_THRESHOLD,
@@ -905,6 +908,10 @@ export class Config {
);
}
isInitialized(): boolean {
return this.initialized;
}
/**
* Must only be called once, throws if called again.
*/
@@ -1965,6 +1972,10 @@ export class Config {
return this.enableAgents;
}
isAgentHarnessEnabled(): boolean {
return this.enableAgentHarness;
}
isEventDrivenSchedulerEnabled(): boolean {
return this.enableEventDrivenScheduler;
}
@@ -96,6 +96,12 @@ export const DEFAULT_MODEL_CONFIGS: ModelConfigServiceConfig = {
model: 'gemini-2.5-flash',
},
},
'gemini-3-flash-base': {
extends: 'base',
modelConfig: {
model: 'gemini-3-flash-preview',
},
},
classifier: {
extends: 'base',
modelConfig: {
@@ -151,7 +157,7 @@ export const DEFAULT_MODEL_CONFIGS: ModelConfigServiceConfig = {
},
},
'web-search': {
extends: 'gemini-2.5-flash-base',
extends: 'gemini-3-flash-base',
modelConfig: {
generateContentConfig: {
tools: [{ googleSearch: {} }],
@@ -159,7 +165,7 @@ export const DEFAULT_MODEL_CONFIGS: ModelConfigServiceConfig = {
},
},
'web-fetch': {
extends: 'gemini-2.5-flash-base',
extends: 'gemini-3-flash-base',
modelConfig: {
generateContentConfig: {
tools: [{ urlContext: {} }],
@@ -168,25 +174,25 @@ export const DEFAULT_MODEL_CONFIGS: ModelConfigServiceConfig = {
},
// TODO(joshualitt): During cleanup, make modelConfig optional.
'web-fetch-fallback': {
extends: 'gemini-2.5-flash-base',
extends: 'gemini-3-flash-base',
modelConfig: {},
},
'loop-detection': {
extends: 'gemini-2.5-flash-base',
extends: 'gemini-3-flash-base',
modelConfig: {},
},
'loop-detection-double-check': {
extends: 'base',
modelConfig: {
model: 'gemini-2.5-pro',
model: 'gemini-3-pro-preview',
},
},
'llm-edit-fixer': {
extends: 'gemini-2.5-flash-base',
extends: 'gemini-3-flash-base',
modelConfig: {},
},
'next-speaker-checker': {
extends: 'gemini-2.5-flash-base',
extends: 'gemini-3-flash-base',
modelConfig: {},
},
'chat-compression-3-pro': {
@@ -216,7 +222,7 @@ export const DEFAULT_MODEL_CONFIGS: ModelConfigServiceConfig = {
},
'chat-compression-default': {
modelConfig: {
model: 'gemini-2.5-pro',
model: 'gemini-3-pro-preview',
},
},
},
@@ -42,7 +42,10 @@ export class MessageBus extends EventEmitter {
async publish(message: Message): Promise<void> {
if (this.debug) {
debugLogger.debug(`[MESSAGE_BUS] publish: ${safeJsonStringify(message)}`);
const json = safeJsonStringify(message);
debugLogger.debug(
`[MESSAGE_BUS] publish: ${json.length > 500 ? json.substring(0, 500) + '...' : json}`,
);
}
try {
if (!this.isValidMessage(message)) {
+12 -1
View File
@@ -19,10 +19,20 @@ export enum MessageBusType {
TOOL_EXECUTION_FAILURE = 'tool-execution-failure',
UPDATE_POLICY = 'update-policy',
TOOL_CALLS_UPDATE = 'tool-calls-update',
SUBAGENT_ACTIVITY = 'subagent-activity',
ASK_USER_REQUEST = 'ask-user-request',
ASK_USER_RESPONSE = 'ask-user-response',
}
export interface SubagentActivityMessage {
type: MessageBusType.SUBAGENT_ACTIVITY;
activity: {
agentName: string;
type: 'THOUGHT' | 'TOOL_CALL_START';
data: Record<string, unknown>;
};
}
export interface ToolCallsUpdateMessage {
type: MessageBusType.TOOL_CALLS_UPDATE;
toolCalls: ToolCall[];
@@ -180,4 +190,5 @@ export type Message =
| UpdatePolicy
| AskUserRequest
| AskUserResponse
| ToolCallsUpdateMessage;
| ToolCallsUpdateMessage
| SubagentActivityMessage;
@@ -519,6 +519,10 @@ exports[`Core System Prompt (prompts.ts) > should append userMemory with separat
- **Credential Protection:** Never log, print, or commit secrets, API keys, or sensitive credentials. Rigorously protect \`.env\` files, \`.git\`, and system configuration folders.
- **Source Control:** Do not stage or commit changes unless specifically requested by the user.
## Context Efficiency:
- Always scope and limit your searches to avoid context window exhaustion and ensure high-signal results. Use include to target relevant files and strictly limit results using total_max_matches and max_matches_per_file, especially during the research phase.
- For broad discovery, use names_only=true or max_matches_per_file=1 to identify files without retrieving their context.
## Engineering Standards
- **Contextual Precedence:** Instructions found in \`GEMINI.md\` files are foundational mandates. They take absolute precedence over the general workflows and tool defaults described in this system prompt.
- **Conventions & Style:** Rigorously adhere to existing workspace conventions, architectural patterns, and style (naming, formatting, typing, commenting). During the research phase, analyze surrounding files, tests, and configuration to ensure your changes are seamless, idiomatic, and consistent with the local context. Never compromise idiomatic quality or completeness (e.g., proper declarations, type safety, documentation) to minimize tool calls; all supporting changes required by local conventions are part of a surgical update.
@@ -646,6 +650,10 @@ exports[`Core System Prompt (prompts.ts) > should handle CodebaseInvestigator wi
- **Credential Protection:** Never log, print, or commit secrets, API keys, or sensitive credentials. Rigorously protect \`.env\` files, \`.git\`, and system configuration folders.
- **Source Control:** Do not stage or commit changes unless specifically requested by the user.
## Context Efficiency:
- Always scope and limit your searches to avoid context window exhaustion and ensure high-signal results. Use include to target relevant files and strictly limit results using total_max_matches and max_matches_per_file, especially during the research phase.
- For broad discovery, use names_only=true or max_matches_per_file=1 to identify files without retrieving their context.
## Engineering Standards
- **Contextual Precedence:** Instructions found in \`GEMINI.md\` files are foundational mandates. They take absolute precedence over the general workflows and tool defaults described in this system prompt.
- **Conventions & Style:** Rigorously adhere to existing workspace conventions, architectural patterns, and style (naming, formatting, typing, commenting). During the research phase, analyze surrounding files, tests, and configuration to ensure your changes are seamless, idiomatic, and consistent with the local context. Never compromise idiomatic quality or completeness (e.g., proper declarations, type safety, documentation) to minimize tool calls; all supporting changes required by local conventions are part of a surgical update.
@@ -738,6 +746,10 @@ exports[`Core System Prompt (prompts.ts) > should handle CodebaseInvestigator wi
- **Credential Protection:** Never log, print, or commit secrets, API keys, or sensitive credentials. Rigorously protect \`.env\` files, \`.git\`, and system configuration folders.
- **Source Control:** Do not stage or commit changes unless specifically requested by the user.
## Context Efficiency:
- Always scope and limit your searches to avoid context window exhaustion and ensure high-signal results. Use include to target relevant files and strictly limit results using total_max_matches and max_matches_per_file, especially during the research phase.
- For broad discovery, use names_only=true or max_matches_per_file=1 to identify files without retrieving their context.
## Engineering Standards
- **Contextual Precedence:** Instructions found in \`GEMINI.md\` files are foundational mandates. They take absolute precedence over the general workflows and tool defaults described in this system prompt.
- **Conventions & Style:** Rigorously adhere to existing workspace conventions, architectural patterns, and style (naming, formatting, typing, commenting). During the research phase, analyze surrounding files, tests, and configuration to ensure your changes are seamless, idiomatic, and consistent with the local context. Never compromise idiomatic quality or completeness (e.g., proper declarations, type safety, documentation) to minimize tool calls; all supporting changes required by local conventions are part of a surgical update.
@@ -1299,6 +1311,10 @@ exports[`Core System Prompt (prompts.ts) > should include available_skills with
- **Credential Protection:** Never log, print, or commit secrets, API keys, or sensitive credentials. Rigorously protect \`.env\` files, \`.git\`, and system configuration folders.
- **Source Control:** Do not stage or commit changes unless specifically requested by the user.
## Context Efficiency:
- Always scope and limit your searches to avoid context window exhaustion and ensure high-signal results. Use include to target relevant files and strictly limit results using total_max_matches and max_matches_per_file, especially during the research phase.
- For broad discovery, use names_only=true or max_matches_per_file=1 to identify files without retrieving their context.
## Engineering Standards
- **Contextual Precedence:** Instructions found in \`GEMINI.md\` files are foundational mandates. They take absolute precedence over the general workflows and tool defaults described in this system prompt.
- **Conventions & Style:** Rigorously adhere to existing workspace conventions, architectural patterns, and style (naming, formatting, typing, commenting). During the research phase, analyze surrounding files, tests, and configuration to ensure your changes are seamless, idiomatic, and consistent with the local context. Never compromise idiomatic quality or completeness (e.g., proper declarations, type safety, documentation) to minimize tool calls; all supporting changes required by local conventions are part of a surgical update.
@@ -1422,6 +1438,10 @@ exports[`Core System Prompt (prompts.ts) > should include correct sandbox instru
- **Credential Protection:** Never log, print, or commit secrets, API keys, or sensitive credentials. Rigorously protect \`.env\` files, \`.git\`, and system configuration folders.
- **Source Control:** Do not stage or commit changes unless specifically requested by the user.
## Context Efficiency:
- Always scope and limit your searches to avoid context window exhaustion and ensure high-signal results. Use include to target relevant files and strictly limit results using total_max_matches and max_matches_per_file, especially during the research phase.
- For broad discovery, use names_only=true or max_matches_per_file=1 to identify files without retrieving their context.
## Engineering Standards
- **Contextual Precedence:** Instructions found in \`GEMINI.md\` files are foundational mandates. They take absolute precedence over the general workflows and tool defaults described in this system prompt.
- **Conventions & Style:** Rigorously adhere to existing workspace conventions, architectural patterns, and style (naming, formatting, typing, commenting). During the research phase, analyze surrounding files, tests, and configuration to ensure your changes are seamless, idiomatic, and consistent with the local context. Never compromise idiomatic quality or completeness (e.g., proper declarations, type safety, documentation) to minimize tool calls; all supporting changes required by local conventions are part of a surgical update.
@@ -1536,6 +1556,10 @@ exports[`Core System Prompt (prompts.ts) > should include correct sandbox instru
- **Credential Protection:** Never log, print, or commit secrets, API keys, or sensitive credentials. Rigorously protect \`.env\` files, \`.git\`, and system configuration folders.
- **Source Control:** Do not stage or commit changes unless specifically requested by the user.
## Context Efficiency:
- Always scope and limit your searches to avoid context window exhaustion and ensure high-signal results. Use include to target relevant files and strictly limit results using total_max_matches and max_matches_per_file, especially during the research phase.
- For broad discovery, use names_only=true or max_matches_per_file=1 to identify files without retrieving their context.
## Engineering Standards
- **Contextual Precedence:** Instructions found in \`GEMINI.md\` files are foundational mandates. They take absolute precedence over the general workflows and tool defaults described in this system prompt.
- **Conventions & Style:** Rigorously adhere to existing workspace conventions, architectural patterns, and style (naming, formatting, typing, commenting). During the research phase, analyze surrounding files, tests, and configuration to ensure your changes are seamless, idiomatic, and consistent with the local context. Never compromise idiomatic quality or completeness (e.g., proper declarations, type safety, documentation) to minimize tool calls; all supporting changes required by local conventions are part of a surgical update.
@@ -1650,6 +1674,10 @@ exports[`Core System Prompt (prompts.ts) > should include correct sandbox instru
- **Credential Protection:** Never log, print, or commit secrets, API keys, or sensitive credentials. Rigorously protect \`.env\` files, \`.git\`, and system configuration folders.
- **Source Control:** Do not stage or commit changes unless specifically requested by the user.
## Context Efficiency:
- Always scope and limit your searches to avoid context window exhaustion and ensure high-signal results. Use include to target relevant files and strictly limit results using total_max_matches and max_matches_per_file, especially during the research phase.
- For broad discovery, use names_only=true or max_matches_per_file=1 to identify files without retrieving their context.
## Engineering Standards
- **Contextual Precedence:** Instructions found in \`GEMINI.md\` files are foundational mandates. They take absolute precedence over the general workflows and tool defaults described in this system prompt.
- **Conventions & Style:** Rigorously adhere to existing workspace conventions, architectural patterns, and style (naming, formatting, typing, commenting). During the research phase, analyze surrounding files, tests, and configuration to ensure your changes are seamless, idiomatic, and consistent with the local context. Never compromise idiomatic quality or completeness (e.g., proper declarations, type safety, documentation) to minimize tool calls; all supporting changes required by local conventions are part of a surgical update.
@@ -1760,6 +1788,10 @@ exports[`Core System Prompt (prompts.ts) > should include planning phase suggest
- **Credential Protection:** Never log, print, or commit secrets, API keys, or sensitive credentials. Rigorously protect \`.env\` files, \`.git\`, and system configuration folders.
- **Source Control:** Do not stage or commit changes unless specifically requested by the user.
## Context Efficiency:
- Always scope and limit your searches to avoid context window exhaustion and ensure high-signal results. Use include to target relevant files and strictly limit results using total_max_matches and max_matches_per_file, especially during the research phase.
- For broad discovery, use names_only=true or max_matches_per_file=1 to identify files without retrieving their context.
## Engineering Standards
- **Contextual Precedence:** Instructions found in \`GEMINI.md\` files are foundational mandates. They take absolute precedence over the general workflows and tool defaults described in this system prompt.
- **Conventions & Style:** Rigorously adhere to existing workspace conventions, architectural patterns, and style (naming, formatting, typing, commenting). During the research phase, analyze surrounding files, tests, and configuration to ensure your changes are seamless, idiomatic, and consistent with the local context. Never compromise idiomatic quality or completeness (e.g., proper declarations, type safety, documentation) to minimize tool calls; all supporting changes required by local conventions are part of a surgical update.
@@ -1870,6 +1902,10 @@ exports[`Core System Prompt (prompts.ts) > should include sub-agents in XML for
- **Credential Protection:** Never log, print, or commit secrets, API keys, or sensitive credentials. Rigorously protect \`.env\` files, \`.git\`, and system configuration folders.
- **Source Control:** Do not stage or commit changes unless specifically requested by the user.
## Context Efficiency:
- Always scope and limit your searches to avoid context window exhaustion and ensure high-signal results. Use include to target relevant files and strictly limit results using total_max_matches and max_matches_per_file, especially during the research phase.
- For broad discovery, use names_only=true or max_matches_per_file=1 to identify files without retrieving their context.
## Engineering Standards
- **Contextual Precedence:** Instructions found in \`GEMINI.md\` files are foundational mandates. They take absolute precedence over the general workflows and tool defaults described in this system prompt.
- **Conventions & Style:** Rigorously adhere to existing workspace conventions, architectural patterns, and style (naming, formatting, typing, commenting). During the research phase, analyze surrounding files, tests, and configuration to ensure your changes are seamless, idiomatic, and consistent with the local context. Never compromise idiomatic quality or completeness (e.g., proper declarations, type safety, documentation) to minimize tool calls; all supporting changes required by local conventions are part of a surgical update.
@@ -2219,6 +2255,10 @@ exports[`Core System Prompt (prompts.ts) > should return the base prompt when us
- **Credential Protection:** Never log, print, or commit secrets, API keys, or sensitive credentials. Rigorously protect \`.env\` files, \`.git\`, and system configuration folders.
- **Source Control:** Do not stage or commit changes unless specifically requested by the user.
## Context Efficiency:
- Always scope and limit your searches to avoid context window exhaustion and ensure high-signal results. Use include to target relevant files and strictly limit results using total_max_matches and max_matches_per_file, especially during the research phase.
- For broad discovery, use names_only=true or max_matches_per_file=1 to identify files without retrieving their context.
## Engineering Standards
- **Contextual Precedence:** Instructions found in \`GEMINI.md\` files are foundational mandates. They take absolute precedence over the general workflows and tool defaults described in this system prompt.
- **Conventions & Style:** Rigorously adhere to existing workspace conventions, architectural patterns, and style (naming, formatting, typing, commenting). During the research phase, analyze surrounding files, tests, and configuration to ensure your changes are seamless, idiomatic, and consistent with the local context. Never compromise idiomatic quality or completeness (e.g., proper declarations, type safety, documentation) to minimize tool calls; all supporting changes required by local conventions are part of a surgical update.
@@ -2329,6 +2369,10 @@ exports[`Core System Prompt (prompts.ts) > should return the base prompt when us
- **Credential Protection:** Never log, print, or commit secrets, API keys, or sensitive credentials. Rigorously protect \`.env\` files, \`.git\`, and system configuration folders.
- **Source Control:** Do not stage or commit changes unless specifically requested by the user.
## Context Efficiency:
- Always scope and limit your searches to avoid context window exhaustion and ensure high-signal results. Use include to target relevant files and strictly limit results using total_max_matches and max_matches_per_file, especially during the research phase.
- For broad discovery, use names_only=true or max_matches_per_file=1 to identify files without retrieving their context.
## Engineering Standards
- **Contextual Precedence:** Instructions found in \`GEMINI.md\` files are foundational mandates. They take absolute precedence over the general workflows and tool defaults described in this system prompt.
- **Conventions & Style:** Rigorously adhere to existing workspace conventions, architectural patterns, and style (naming, formatting, typing, commenting). During the research phase, analyze surrounding files, tests, and configuration to ensure your changes are seamless, idiomatic, and consistent with the local context. Never compromise idiomatic quality or completeness (e.g., proper declarations, type safety, documentation) to minimize tool calls; all supporting changes required by local conventions are part of a surgical update.
@@ -2550,6 +2594,10 @@ exports[`Core System Prompt (prompts.ts) > should use chatty system prompt for p
- **Credential Protection:** Never log, print, or commit secrets, API keys, or sensitive credentials. Rigorously protect \`.env\` files, \`.git\`, and system configuration folders.
- **Source Control:** Do not stage or commit changes unless specifically requested by the user.
## Context Efficiency:
- Always scope and limit your searches to avoid context window exhaustion and ensure high-signal results. Use include to target relevant files and strictly limit results using total_max_matches and max_matches_per_file, especially during the research phase.
- For broad discovery, use names_only=true or max_matches_per_file=1 to identify files without retrieving their context.
## Engineering Standards
- **Contextual Precedence:** Instructions found in \`GEMINI.md\` files are foundational mandates. They take absolute precedence over the general workflows and tool defaults described in this system prompt.
- **Conventions & Style:** Rigorously adhere to existing workspace conventions, architectural patterns, and style (naming, formatting, typing, commenting). During the research phase, analyze surrounding files, tests, and configuration to ensure your changes are seamless, idiomatic, and consistent with the local context. Never compromise idiomatic quality or completeness (e.g., proper declarations, type safety, documentation) to minimize tool calls; all supporting changes required by local conventions are part of a surgical update.
@@ -2660,6 +2708,10 @@ exports[`Core System Prompt (prompts.ts) > should use chatty system prompt for p
- **Credential Protection:** Never log, print, or commit secrets, API keys, or sensitive credentials. Rigorously protect \`.env\` files, \`.git\`, and system configuration folders.
- **Source Control:** Do not stage or commit changes unless specifically requested by the user.
## Context Efficiency:
- Always scope and limit your searches to avoid context window exhaustion and ensure high-signal results. Use include to target relevant files and strictly limit results using total_max_matches and max_matches_per_file, especially during the research phase.
- For broad discovery, use names_only=true or max_matches_per_file=1 to identify files without retrieving their context.
## Engineering Standards
- **Contextual Precedence:** Instructions found in \`GEMINI.md\` files are foundational mandates. They take absolute precedence over the general workflows and tool defaults described in this system prompt.
- **Conventions & Style:** Rigorously adhere to existing workspace conventions, architectural patterns, and style (naming, formatting, typing, commenting). During the research phase, analyze surrounding files, tests, and configuration to ensure your changes are seamless, idiomatic, and consistent with the local context. Never compromise idiomatic quality or completeness (e.g., proper declarations, type safety, documentation) to minimize tool calls; all supporting changes required by local conventions are part of a surgical update.
+1
View File
@@ -243,6 +243,7 @@ describe('Gemini Client (client.ts)', () => {
getShowModelInfoInChat: vi.fn().mockReturnValue(false),
getContinueOnFailedApiCall: vi.fn(),
getProjectRoot: vi.fn().mockReturnValue('/test/project/root'),
isAgentHarnessEnabled: vi.fn().mockReturnValue(false),
storage: {
getProjectTempDir: vi.fn().mockReturnValue('/test/temp'),
},
+53 -1
View File
@@ -7,6 +7,7 @@
import type {
GenerateContentConfig,
PartListUnion,
Part,
Content,
Tool,
GenerateContentResponse,
@@ -62,8 +63,10 @@ import {
} from '../availability/policyHelpers.js';
import { resolveModel } from '../config/models.js';
import type { RetryAvailabilityContext } from '../utils/retry.js';
import { partToString } from '../utils/partUtils.js';
import { partToString, toPartArray } from '../utils/partUtils.js';
import { coreEvents, CoreEvent } from '../utils/events.js';
import { AgentFactory } from '../agents/agent-factory.js';
import { type AgentHarness } from '../agents/harness.js';
const MAX_TURNS = 100;
@@ -90,6 +93,7 @@ export class GeminiClient {
private currentSequenceModel: string | null = null;
private lastSentIdeContext: IdeContext | undefined;
private forceFullIdeContext = true;
private harness?: AgentHarness;
/**
* At any point in this conversation, was compression triggered without
@@ -556,6 +560,9 @@ export class GeminiClient {
let turn = new Turn(this.getChat(), prompt_id);
this.sessionTurnCount++;
debugLogger.debug(
`[LegacyLoop] processTurn started. sessionTurnCount: ${this.sessionTurnCount}, prompt_id: ${prompt_id}`,
);
if (
this.config.getMaxSessionTurns() > 0 &&
this.sessionTurnCount > this.config.getMaxSessionTurns()
@@ -788,10 +795,55 @@ export class GeminiClient {
isInvalidStreamRetry: boolean = false,
displayContent?: PartListUnion,
): AsyncGenerator<ServerGeminiStreamEvent, Turn> {
debugLogger.debug(
`[LegacyLoop] sendMessageStream started. prompt_id: ${prompt_id}, turns left: ${turns}`,
);
if (!isInvalidStreamRetry) {
this.config.resetTurn();
}
if (this.config.isAgentHarnessEnabled()) {
debugLogger.debug(
'[GeminiClient] Using AgentHarness for message execution.',
);
this.sessionTurnCount++;
if (
this.config.getMaxSessionTurns() > 0 &&
this.sessionTurnCount > this.config.getMaxSessionTurns()
) {
yield { type: GeminiEventType.MaxSessionTurns };
return new Turn(this.getChat(), prompt_id);
}
if (!this.harness || this.lastPromptId !== prompt_id) {
this.harness = AgentFactory.createHarness(this.config, undefined, {
parentPromptId: prompt_id,
history: this.getChat().getHistory(),
});
this.lastPromptId = prompt_id;
}
const requestParts: Part[] = toPartArray(request);
const stream = this.harness.run(requestParts, signal, turns);
let turn: Turn | undefined;
while (true) {
const { value, done } = await stream.next();
if (done) {
turn = value;
break;
}
yield value;
}
if (turn) {
// Sync history back to GeminiClient's chat for transcript persistence
this.getChat().setHistory(turn.chat.getHistory());
return turn;
}
return new Turn(this.getChat(), prompt_id);
}
const hooksEnabled = this.config.getEnableHooks();
const messageBus = this.config.getMessageBus();
@@ -18,6 +18,7 @@ import { LoggingContentGenerator } from './loggingContentGenerator.js';
import { loadApiKey } from './apiKeyCredentialStorage.js';
import { FakeContentGenerator } from './fakeContentGenerator.js';
import { RecordingContentGenerator } from './recordingContentGenerator.js';
import { resetVersionCache } from '../utils/version.js';
vi.mock('../code_assist/codeAssist.js');
vi.mock('@google/genai');
@@ -35,6 +36,7 @@ const mockConfig = {
describe('createContentGenerator', () => {
beforeEach(() => {
resetVersionCache();
vi.clearAllMocks();
});
+20 -2
View File
@@ -68,8 +68,23 @@ export enum GeminiEventType {
ModelInfo = 'model_info',
AgentExecutionStopped = 'agent_execution_stopped',
AgentExecutionBlocked = 'agent_execution_blocked',
SubagentActivity = 'subagent_activity',
TurnFinished = 'turn_finished',
}
export type ServerGeminiSubagentActivityEvent = {
type: GeminiEventType.SubagentActivity;
value: {
agentName: string;
type: string;
data: Record<string, unknown>;
};
};
export type ServerGeminiTurnFinishedEvent = {
type: GeminiEventType.TurnFinished;
};
export type ServerGeminiRetryEvent = {
type: GeminiEventType.Retry;
};
@@ -229,7 +244,9 @@ export type ServerGeminiStreamEvent =
| ServerGeminiInvalidStreamEvent
| ServerGeminiModelInfoEvent
| ServerGeminiAgentExecutionStoppedEvent
| ServerGeminiAgentExecutionBlockedEvent;
| ServerGeminiAgentExecutionBlockedEvent
| ServerGeminiSubagentActivityEvent
| ServerGeminiTurnFinishedEvent;
// A turn manages the agentic loop turn within the server context.
export class Turn {
@@ -239,9 +256,10 @@ export class Turn {
private debugResponses: GenerateContentResponse[] = [];
private pendingCitations = new Set<string>();
finishReason: FinishReason | undefined = undefined;
submittedOutput: unknown;
constructor(
private readonly chat: GeminiChat,
readonly chat: GeminiChat,
private readonly prompt_id: string,
) {}
+1
View File
@@ -138,6 +138,7 @@ export * from './prompts/mcp-prompts.js';
// Export agent definitions
export * from './agents/types.js';
export * from './agents/agent-factory.js';
export * from './agents/agentLoader.js';
export * from './agents/local-executor.js';
+103
View File
@@ -951,4 +951,107 @@ name = "invalid-name"
vi.doUnmock('node:fs/promises');
});
it('should allow overriding Plan Mode deny with user policy', async () => {
const actualFs =
await vi.importActual<typeof import('node:fs/promises')>(
'node:fs/promises',
);
const mockReaddir = vi.fn(
async (
path: string | Buffer | URL,
options?: Parameters<typeof actualFs.readdir>[1],
) => {
const normalizedPath = nodePath.normalize(path.toString());
if (normalizedPath.includes(nodePath.normalize('.gemini/policies'))) {
return [
{
name: 'user-plan.toml',
isFile: () => true,
isDirectory: () => false,
},
] as unknown as Awaited<ReturnType<typeof actualFs.readdir>>;
}
return actualFs.readdir(
path,
options as Parameters<typeof actualFs.readdir>[1],
);
},
);
const mockReadFile = vi.fn(
async (
path: Parameters<typeof actualFs.readFile>[0],
options: Parameters<typeof actualFs.readFile>[1],
) => {
const normalizedPath = nodePath.normalize(path.toString());
if (normalizedPath.includes('user-plan.toml')) {
return `
[[rule]]
toolName = "run_shell_command"
commandPrefix = ["git status", "git diff"]
decision = "allow"
priority = 100
modes = ["plan"]
[[rule]]
toolName = "codebase_investigator"
decision = "allow"
priority = 100
modes = ["plan"]
`;
}
return actualFs.readFile(path, options);
},
);
vi.doMock('node:fs/promises', () => ({
...actualFs,
default: { ...actualFs, readFile: mockReadFile, readdir: mockReaddir },
readFile: mockReadFile,
readdir: mockReaddir,
}));
vi.resetModules();
const { createPolicyEngineConfig } = await import('./config.js');
const settings: PolicySettings = {};
const config = await createPolicyEngineConfig(
settings,
ApprovalMode.PLAN,
nodePath.join(__dirname, 'policies'),
);
const shellRules = config.rules?.filter(
(r) =>
r.toolName === 'run_shell_command' &&
r.decision === PolicyDecision.ALLOW &&
r.modes?.includes(ApprovalMode.PLAN) &&
r.argsPattern,
);
expect(shellRules).toHaveLength(2);
expect(
shellRules?.some((r) => r.argsPattern?.test('{"command":"git status"}')),
).toBe(true);
expect(
shellRules?.some((r) => r.argsPattern?.test('{"command":"git diff"}')),
).toBe(true);
expect(
shellRules?.every(
(r) => !r.argsPattern?.test('{"command":"git commit"}'),
),
).toBe(true);
const subagentRule = config.rules?.find(
(r) =>
r.toolName === 'codebase_investigator' &&
r.decision === PolicyDecision.ALLOW &&
r.modes?.includes(ApprovalMode.PLAN),
);
expect(subagentRule).toBeDefined();
expect(subagentRule?.priority).toBeCloseTo(2.1, 5);
vi.doUnmock('node:fs/promises');
});
});
+2 -2
View File
@@ -31,12 +31,12 @@
decision = "deny"
priority = 60
modes = ["plan"]
deny_message = "You are in Plan Mode - adjust your prompt to only use read and search tools."
deny_message = "You are in Plan Mode with access to read-only tools. Execution of scripts (including those from skills) is blocked."
# Explicitly Allow Read-Only Tools in Plan mode.
[[rule]]
toolName = ["glob", "grep_search", "list_directory", "read_file", "google_web_search"]
toolName = ["glob", "grep_search", "list_directory", "read_file", "google_web_search", "activate_skill"]
decision = "allow"
priority = 70
modes = ["plan"]
@@ -2086,4 +2086,44 @@ describe('PolicyEngine', () => {
expect(result.decision).toBe(PolicyDecision.ALLOW);
});
});
describe('Plan Mode', () => {
it('should allow activate_skill but deny shell commands in Plan Mode', async () => {
const rules: PolicyRule[] = [
{
decision: PolicyDecision.DENY,
priority: 60,
modes: [ApprovalMode.PLAN],
denyMessage:
'You are in Plan Mode with access to read-only tools. Execution of scripts (including those from skills) is blocked.',
},
{
toolName: 'activate_skill',
decision: PolicyDecision.ALLOW,
priority: 70,
modes: [ApprovalMode.PLAN],
},
];
engine = new PolicyEngine({
rules,
approvalMode: ApprovalMode.PLAN,
});
const skillResult = await engine.check(
{ name: 'activate_skill', args: { name: 'test' } },
undefined,
);
expect(skillResult.decision).toBe(PolicyDecision.ALLOW);
const shellResult = await engine.check(
{ name: 'run_shell_command', args: { command: 'ls' } },
undefined,
);
expect(shellResult.decision).toBe(PolicyDecision.DENY);
expect(shellResult.rule?.denyMessage).toContain(
'Execution of scripts (including those from skills) is blocked',
);
});
});
});
+41 -21
View File
@@ -164,6 +164,10 @@ export function renderCoreMandates(options?: CoreMandatesOptions): string {
- **Credential Protection:** Never log, print, or commit secrets, API keys, or sensitive credentials. Rigorously protect \`.env\` files, \`.git\`, and system configuration folders.
- **Source Control:** Do not stage or commit changes unless specifically requested by the user.
## Context Efficiency:
- Always scope and limit your searches to avoid context window exhaustion and ensure high-signal results. Use include to target relevant files and strictly limit results using total_max_matches and max_matches_per_file, especially during the research phase.
- For broad discovery, use names_only=true or max_matches_per_file=1 to identify files without retrieving their context.
## Engineering Standards
- **Contextual Precedence:** Instructions found in ${formattedFilenames} files are foundational mandates. They take absolute precedence over the general workflows and tool defaults described in this system prompt.
- **Conventions & Style:** Rigorously adhere to existing workspace conventions, architectural patterns, and style (naming, formatting, typing, commenting). During the research phase, analyze surrounding files, tests, and configuration to ensure your changes are seamless, idiomatic, and consistent with the local context. Never compromise idiomatic quality or completeness (e.g., proper declarations, type safety, documentation) to minimize tool calls; all supporting changes required by local conventions are part of a surgical update.
@@ -428,34 +432,50 @@ ${options.planModeToolsList}
- You are restricted to writing files within this directory while in Plan Mode.
- Use descriptive filenames: \`feature-name.md\` or \`bugfix-description.md\`
## Workflow Rules
1. Sequential Execution: Complete ONE phase at a time. Do NOT skip ahead or combine phases.
2. User Confirmation: Wait for user input/approval before proceeding to the next phase.
3. Step Back Protocol: If new information discovered during Exploration or Design invalidates previous assumptions or requirements, you MUST pause, inform the user, and request to return to the appropriate previous phase.
## Workflow Phases
**IMPORTANT: Complete ONE phase at a time. Do NOT skip ahead or combine phases. Wait for user input before proceeding to the next phase.**
### Phase 1: Requirements
- Analyze the user's request to identify core requirements and constraints.
- Proactively identify ambiguities, implicit assumptions, and edge cases.
- Categorize questions: functional requirements, non-functional constraints (performance, compatibility), and scope boundaries.
- Use the ${formatToolName(ASK_USER_TOOL_NAME)} tool with well-structured options to clarify ambiguities. Prefer providing multiple-choice options for the user to select from when possible.
### Phase 1: Requirements Understanding
- Analyze the user's request to identify core requirements and constraints
- If critical information is missing or ambiguous, ask clarifying questions using the ${formatToolName(ASK_USER_TOOL_NAME)} tool
- When using ${formatToolName(ASK_USER_TOOL_NAME)}, prefer providing multiple-choice options for the user to select from when possible
- Do NOT explore the project or create a plan yet
### Phase 2: Exploration
- Only begin this phase after requirements are clear.
- Use the available read-only tools to explore the project.
- Map relevant code paths, dependencies, and architectural patterns.
- Identify existing utilities, patterns, and abstractions that can be reused.
- Note potential constraints (e.g., existing conventions, test infrastructure).
- Output: Summarize key findings to the user before proceeding to design.
### Phase 2: Project Exploration
- Only begin this phase after requirements are clear
- Use the available read-only tools to explore the project
- Identify existing patterns, conventions, and architectural decisions
### Phase 3: Design
- Only begin this phase after exploration is complete.
- **Identify Approaches:**
- For Complex Tasks: Identify at least 2 viable implementation approaches. Document the approach summary, pros, cons, complexity estimate, and risk factors for each.
- For Canonical Tasks: If there is only one reasonable, standard approach (e.g., a standard library pattern or specific bug fix), detail it and explicitly explain why no other viable alternatives were considered.
- Mandatory User Interaction: Present the analysis to the user via ${formatToolName(ASK_USER_TOOL_NAME)} and recommend a preferred approach.
- Wait for Selection: You MUST pause and wait for the user to select an approach before proceeding. Do NOT assume the user will agree with your recommendation.
### Phase 3: Design & Planning
- Only begin this phase after exploration is complete
- Create a detailed implementation plan with clear steps
- The plan MUST include:
- Iterative development steps (e.g., "Implement X, then verify with test Y")
- Specific verification steps (unit tests, manual checks, build commands)
- File paths, function signatures, and code snippets where helpful
- Save the implementation plan to the designated plans directory
### Phase 4: Planning
- Pre-requisite: You MUST have a user-selected approach from Phase 3 before generating the plan.
- Create a detailed implementation plan and save it to the designated plans directory.
- **Document Structure:** The plan MUST be a structured Markdown document (focused on implementation guidance, not workflow logging) using exactly these H2 headings:
- \`## Problem Statement\` - Describe the problem or need this change addresses.
- \`## Proposed Solution\` - Provide technical details of the implementation.
- \`## Implementation Plan\` - List ordered steps with specific file paths and the nature of each change.
- \`## Verification Plan\` - Define specific tests or manual steps to verify the change works and breaks nothing else.
- \`## Risks & Mitigations\` - Identify potential failure modes and mitigation strategies.
- \`## Alternatives Considered\` - Provide a brief analysis of other approaches considered and why they were rejected.
### Phase 4: Review & Approval
### Phase 5: Approval
- Present the plan and request approval for the finalized plan using the ${formatToolName(EXIT_PLAN_MODE_TOOL_NAME)} tool
- If plan is approved, you can begin implementation
- If plan is rejected, address the feedback and iterate on the plan
- If plan is approved, you can begin implementation.
- If plan is rejected, address the feedback and iterate on the plan.
${renderApprovedPlanSection(options.approvedPlanPath)}
@@ -16,6 +16,7 @@ import {
} from 'vitest';
import { EventEmitter } from 'node:events';
import { awaitConfirmation, resolveConfirmation } from './confirmation.js';
import * as EditorUtils from '../utils/editor.js';
import {
MessageBusType,
type ToolConfirmationResponse,
@@ -34,6 +35,8 @@ import type { Config } from '../config/config.js';
import type { EditorType } from '../utils/editor.js';
import { randomUUID } from 'node:crypto';
import { randomUUID } from 'node:crypto';
// Mock Dependencies
vi.mock('node:crypto', () => ({
randomUUID: vi.fn(),
@@ -123,6 +126,7 @@ describe('confirmation.ts', () => {
let toolMock: Mocked<AnyDeclarativeTool>;
beforeEach(() => {
vi.spyOn(EditorUtils, 'resolveEditorAsync').mockResolvedValue('vim');
signal = new AbortController().signal;
mockState = {
@@ -219,7 +219,11 @@ describe('Scheduler (Orchestrator)', () => {
let capturedTerminalHandler: TerminalCallHandler | undefined;
vi.mocked(SchedulerStateManager).mockImplementation(
(_messageBus, _schedulerId, onTerminalCall) => {
(
_messageBus: MessageBus | undefined,
_schedulerId: string | undefined,
onTerminalCall: TerminalCallHandler | undefined,
) => {
capturedTerminalHandler = onTerminalCall;
return mockStateManager as unknown as SchedulerStateManager;
},
+13 -9
View File
@@ -47,7 +47,7 @@ interface SchedulerQueueItem {
export interface SchedulerOptions {
config: Config;
messageBus: MessageBus;
messageBus?: MessageBus;
getPreferredEditor: () => EditorType | undefined;
schedulerId: string;
parentCallId?: string;
@@ -87,7 +87,7 @@ export class Scheduler {
private readonly executor: ToolExecutor;
private readonly modifier: ToolModificationHandler;
private readonly config: Config;
private readonly messageBus: MessageBus;
private readonly messageBus?: MessageBus;
private readonly getPreferredEditor: () => EditorType | undefined;
private readonly schedulerId: string;
private readonly parentCallId?: string;
@@ -112,11 +112,13 @@ export class Scheduler {
this.executor = new ToolExecutor(this.config);
this.modifier = new ToolModificationHandler();
this.setupMessageBusListener(this.messageBus);
if (this.messageBus) {
this.setupMessageBusListener(this.messageBus);
}
}
private setupMessageBusListener(messageBus: MessageBus): void {
if (Scheduler.subscribedMessageBuses.has(messageBus)) {
if (!messageBus || Scheduler.subscribedMessageBuses.has(messageBus)) {
return;
}
@@ -432,7 +434,7 @@ export class Scheduler {
let outcome = ToolConfirmationOutcome.ProceedOnce;
let lastDetails: SerializableConfirmationDetails | undefined;
if (decision === PolicyDecision.ASK_USER) {
if (decision === PolicyDecision.ASK_USER && this.messageBus) {
const result = await resolveConfirmation(toolCall, signal, {
config: this.config,
messageBus: this.messageBus,
@@ -449,10 +451,12 @@ export class Scheduler {
}
// Handle Policy Updates
await updatePolicy(toolCall.tool, outcome, lastDetails, {
config: this.config,
messageBus: this.messageBus,
});
if (this.messageBus) {
await updatePolicy(toolCall.tool, outcome, lastDetails, {
config: this.config,
messageBus: this.messageBus,
});
}
// Handle cancellation (cascades to entire batch)
if (outcome === ToolConfirmationOutcome.Cancel) {
+5 -1
View File
@@ -46,7 +46,7 @@ export class SchedulerStateManager {
private _completedBatch: CompletedToolCall[] = [];
constructor(
private readonly messageBus: MessageBus,
private readonly messageBus: MessageBus | undefined,
private readonly schedulerId: string = ROOT_SCHEDULER_ID,
private readonly onTerminalCall?: TerminalCallHandler,
) {}
@@ -210,6 +210,10 @@ export class SchedulerStateManager {
}
private emitUpdate() {
if (!this.messageBus) {
return;
}
const snapshot = this.getSnapshot();
// Fire and forget - The message bus handles the publish and error handling.
@@ -46,9 +46,6 @@ describe('sanitizeEnvironment', () => {
CLIENT_ID: 'sensitive-id',
DB_URI: 'sensitive-uri',
DATABASE_URL: 'sensitive-url',
GEMINI_API_KEY: 'sensitive-gemini-key',
GOOGLE_API_KEY: 'sensitive-google-key',
GOOGLE_APPLICATION_CREDENTIALS: '/path/to/creds.json',
SAFE_VAR: 'is-safe',
};
const sanitized = sanitizeEnvironment(env, EMPTY_OPTIONS);
@@ -103,9 +103,6 @@ export const NEVER_ALLOWED_ENVIRONMENT_VARIABLES: ReadonlySet<string> = new Set(
'GOOGLE_CLOUD_PROJECT',
'GOOGLE_CLOUD_ACCOUNT',
'FIREBASE_PROJECT_ID',
'GEMINI_API_KEY',
'GOOGLE_API_KEY',
'GOOGLE_APPLICATION_CREDENTIALS',
],
);
@@ -104,6 +104,13 @@
"topP": 1
}
},
"gemini-3-flash-base": {
"model": "gemini-3-flash-preview",
"generateContentConfig": {
"temperature": 0,
"topP": 1
}
},
"classifier": {
"model": "gemini-2.5-flash-lite",
"generateContentConfig": {
@@ -153,7 +160,7 @@
}
},
"web-search": {
"model": "gemini-2.5-flash",
"model": "gemini-3-flash-preview",
"generateContentConfig": {
"temperature": 0,
"topP": 1,
@@ -165,7 +172,7 @@
}
},
"web-fetch": {
"model": "gemini-2.5-flash",
"model": "gemini-3-flash-preview",
"generateContentConfig": {
"temperature": 0,
"topP": 1,
@@ -177,35 +184,35 @@
}
},
"web-fetch-fallback": {
"model": "gemini-2.5-flash",
"model": "gemini-3-flash-preview",
"generateContentConfig": {
"temperature": 0,
"topP": 1
}
},
"loop-detection": {
"model": "gemini-2.5-flash",
"model": "gemini-3-flash-preview",
"generateContentConfig": {
"temperature": 0,
"topP": 1
}
},
"loop-detection-double-check": {
"model": "gemini-2.5-pro",
"model": "gemini-3-pro-preview",
"generateContentConfig": {
"temperature": 0,
"topP": 1
}
},
"llm-edit-fixer": {
"model": "gemini-2.5-flash",
"model": "gemini-3-flash-preview",
"generateContentConfig": {
"temperature": 0,
"topP": 1
}
},
"next-speaker-checker": {
"model": "gemini-2.5-flash",
"model": "gemini-3-flash-preview",
"generateContentConfig": {
"temperature": 0,
"topP": 1
@@ -232,7 +239,7 @@
"generateContentConfig": {}
},
"chat-compression-default": {
"model": "gemini-2.5-pro",
"model": "gemini-3-pro-preview",
"generateContentConfig": {}
}
}
@@ -104,6 +104,13 @@
"topP": 1
}
},
"gemini-3-flash-base": {
"model": "gemini-3-flash-preview",
"generateContentConfig": {
"temperature": 0,
"topP": 1
}
},
"classifier": {
"model": "gemini-2.5-flash-lite",
"generateContentConfig": {
@@ -153,7 +160,7 @@
}
},
"web-search": {
"model": "gemini-2.5-flash",
"model": "gemini-3-flash-preview",
"generateContentConfig": {
"temperature": 0,
"topP": 1,
@@ -165,7 +172,7 @@
}
},
"web-fetch": {
"model": "gemini-2.5-flash",
"model": "gemini-3-flash-preview",
"generateContentConfig": {
"temperature": 0,
"topP": 1,
@@ -177,35 +184,35 @@
}
},
"web-fetch-fallback": {
"model": "gemini-2.5-flash",
"model": "gemini-3-flash-preview",
"generateContentConfig": {
"temperature": 0,
"topP": 1
}
},
"loop-detection": {
"model": "gemini-2.5-flash",
"model": "gemini-3-flash-preview",
"generateContentConfig": {
"temperature": 0,
"topP": 1
}
},
"loop-detection-double-check": {
"model": "gemini-2.5-pro",
"model": "gemini-3-pro-preview",
"generateContentConfig": {
"temperature": 0,
"topP": 1
}
},
"llm-edit-fixer": {
"model": "gemini-2.5-flash",
"model": "gemini-3-flash-preview",
"generateContentConfig": {
"temperature": 0,
"topP": 1
}
},
"next-speaker-checker": {
"model": "gemini-2.5-flash",
"model": "gemini-3-flash-preview",
"generateContentConfig": {
"temperature": 0,
"topP": 1
@@ -232,7 +239,7 @@
"generateContentConfig": {}
},
"chat-compression-default": {
"model": "gemini-2.5-pro",
"model": "gemini-3-pro-preview",
"generateContentConfig": {}
}
}
+5 -1
View File
@@ -207,7 +207,11 @@ export class AskUserInvocation extends BaseToolInvocation<
.map(([index, answer]) => {
const question = this.params.questions[parseInt(index, 10)];
const category = question?.header ?? `Q${index}`;
return ` ${category}${answer}`;
const prefix = ` ${category}`;
const indent = ' '.repeat(prefix.length);
const lines = answer.split('\n');
return prefix + lines.join('\n' + indent);
})
.join('\n')}`
: 'User submitted without answering questions.';
@@ -45,14 +45,32 @@ exports[`coreTools snapshots for specific models > Model: gemini-2.5-pro > snaps
"description": "Optional: The absolute path to the directory to search within. If omitted, searches the current working directory.",
"type": "string",
},
"exclude_pattern": {
"description": "Optional: A regular expression pattern to exclude from the search results. If a line matches both the pattern and the exclude_pattern, it will be omitted.",
"type": "string",
},
"include": {
"description": "Optional: A glob pattern to filter which files are searched (e.g., '*.js', '*.{ts,tsx}', 'src/**'). If omitted, searches all files (respecting potential global ignores).",
"type": "string",
},
"max_matches_per_file": {
"description": "Optional: Maximum number of matches to return per file. Use this to prevent being overwhelmed by repetitive matches in large files.",
"minimum": 1,
"type": "integer",
},
"names_only": {
"description": "Optional: If true, only the file paths of the matches will be returned, without the line content or line numbers. This is useful for gathering a list of files.",
"type": "boolean",
},
"pattern": {
"description": "The regular expression (regex) pattern to search for within file contents (e.g., 'function\\s+myFunction', 'import\\s+\\{.*\\}\\s+from\\s+.*').",
"type": "string",
},
"total_max_matches": {
"description": "Optional: Maximum number of total matches to return. Use this to limit the overall size of the response. Defaults to 100 if omitted.",
"minimum": 1,
"type": "integer",
},
},
"required": [
"pattern",
@@ -244,14 +262,32 @@ exports[`coreTools snapshots for specific models > Model: gemini-3-pro-preview >
"description": "Optional: The absolute path to the directory to search within. If omitted, searches the current working directory.",
"type": "string",
},
"exclude_pattern": {
"description": "Optional: A regular expression pattern to exclude from the search results. If a line matches both the pattern and the exclude_pattern, it will be omitted.",
"type": "string",
},
"include": {
"description": "Optional: A glob pattern to filter which files are searched (e.g., '*.js', '*.{ts,tsx}', 'src/**'). If omitted, searches all files (respecting potential global ignores).",
"type": "string",
},
"max_matches_per_file": {
"description": "Optional: Maximum number of matches to return per file. Use this to prevent being overwhelmed by repetitive matches in large files.",
"minimum": 1,
"type": "integer",
},
"names_only": {
"description": "Optional: If true, only the file paths of the matches will be returned, without the line content or line numbers. This is useful for gathering a list of files.",
"type": "boolean",
},
"pattern": {
"description": "The regular expression (regex) pattern to search for within file contents (e.g., 'function\\s+myFunction', 'import\\s+\\{.*\\}\\s+from\\s+.*').",
"type": "string",
},
"total_max_matches": {
"description": "Optional: Maximum number of total matches to return. Use this to limit the overall size of the response. Defaults to 100 if omitted.",
"minimum": 1,
"type": "integer",
},
},
"required": [
"pattern",

Some files were not shown because too many files have changed in this diff Show More