Skip to content

feat(core): introduce AgentSession and rename stream events to agent events#23159

Merged
adamfweidman merged 6 commits intomainfrom
mb/agent-protocol
Mar 20, 2026
Merged

feat(core): introduce AgentSession and rename stream events to agent events#23159
adamfweidman merged 6 commits intomainfrom
mb/agent-protocol

Conversation

@mbleigh
Copy link
Copy Markdown
Contributor

@mbleigh mbleigh commented Mar 19, 2026

Summary

This PR updates the AgentProtocol interface to use a subscription-based model and introduces AgentSession, a wrapper that provides an AsyncIterable API (sendStream) for consuming agent events. It also renames stream_start and stream_end events to agent_start and agent_end to better reflect their role in indicating agent activity.

Details

  • Refactored AgentProtocol to replace the stream() method with a subscribe() method.
  • Added AgentSession in packages/core/src/agent/agent-session.ts to provide a higher-level AsyncIterable interface.
  • Updated MockAgentProtocol to support the new interface and ensure correct event ordering (e.g., streamId is returned before agent_start is emitted).
  • Renamed events: StreamStart -> AgentStart, StreamEnd -> AgentEnd.
  • Updated all related tests and added new tests for AgentSession.

Related Issues

Related to #20995

How to Validate

  • Run npm test -w @google/gemini-cli-core to verify agent and session tests.
  • Run npm run preflight to ensure no regressions across the monorepo.

Pre-Merge Checklist

  • Updated relevant documentation and README (if needed)
  • Added/updated tests (if needed)
  • Noted breaking changes (if any)
  • Validated on MacOS:
    • npm run

@mbleigh mbleigh requested a review from a team as a code owner March 19, 2026 21:08
@gemini-cli
Copy link
Copy Markdown
Contributor

gemini-cli bot commented Mar 19, 2026

Hi @mbleigh, thank you so much for your contribution to Gemini CLI! We really appreciate the time and effort you've put into this.

We're making some updates to our contribution process to improve how we track and review changes. Please take a moment to review our recent discussion post: Improving Our Contribution Process & Introducing New Guidelines.

Key Update: Starting January 26, 2026, the Gemini CLI project will require all pull requests to be associated with an existing issue. Any pull requests not linked to an issue by that date will be automatically closed.

Thank you for your understanding and for being a part of our community!

@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the agent event handling mechanism by introducing a new AgentSession class, which provides an AsyncIterable interface for event consumption. It also refactors the underlying AgentProtocol to a more modern subscription-based model and renames key event types for clarity. These changes aim to improve the developer experience when interacting with agent events, making asynchronous event processing more intuitive and robust.

Highlights

  • New AgentSession Class: Introduced a new AgentSession class that wraps the AgentProtocol to provide a more convenient AsyncIterable API for consuming agent events via its sendStream method.
  • AgentProtocol Refactoring: The core AgentProtocol interface was refactored from a stream() method to a subscription-based subscribe() method, allowing for a more flexible event consumption model.
  • Event Renaming: The stream_start and stream_end events have been renamed to agent_start and agent_end respectively, to better reflect their role in indicating agent activity.
  • Mock Agent Protocol Updates: The MockAgentProtocol (formerly MockAgentSession) was updated to support the new subscription interface and ensure correct event ordering, particularly that streamId is returned before agent_start is emitted.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@mbleigh mbleigh requested a review from adamfweidman March 19, 2026 21:09
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request is a significant and well-executed refactoring of the agent communication protocol. The transition from a stateful stream() method to a subscription-based AgentProtocol is a solid architectural improvement, and the new AgentSession provides a convenient AsyncIterable wrapper for consumers. The code is well-structured, and the tests have been thoroughly updated to reflect the changes. I have one suggestion regarding a potential performance issue in the event queue processing logic, which could be important for streams with a high volume of events.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 19, 2026

Size Change: -4 B (0%)

Total Size: 26.3 MB

Filename Size Change
./bundle/chunk-DKFC5IX2.js 0 B -13.5 MB (removed) 🏆
./bundle/chunk-GCHT4CEF.js 0 B -3.64 MB (removed) 🏆
./bundle/core-42X6JVUH.js 0 B -41.8 kB (removed) 🏆
./bundle/devtoolsService-7BGWANK4.js 0 B -27.7 kB (removed) 🏆
./bundle/interactiveCli-UDWRXC7S.js 0 B -1.61 MB (removed) 🏆
./bundle/oauth2-provider-TPYNICWX.js 0 B -9.19 kB (removed) 🏆
./bundle/chunk-EBXZJDKB.js 13.5 MB +13.5 MB (new file) 🆕
./bundle/chunk-V37XEM2C.js 3.64 MB +3.64 MB (new file) 🆕
./bundle/core-KMD3PLV2.js 41.8 kB +41.8 kB (new file) 🆕
./bundle/devtoolsService-BZEBKFTT.js 27.7 kB +27.7 kB (new file) 🆕
./bundle/interactiveCli-RZABCUSG.js 1.61 MB +1.61 MB (new file) 🆕
./bundle/oauth2-provider-AEJVJZHT.js 9.19 kB +9.19 kB (new file) 🆕
ℹ️ View Unchanged
Filename Size
./bundle/chunk-34MYV7JD.js 2.45 kB
./bundle/chunk-37ZTTFQF.js 966 kB
./bundle/chunk-5AUYMPVF.js 858 B
./bundle/chunk-664ZODQF.js 124 kB
./bundle/chunk-DAHVX5MI.js 206 kB
./bundle/chunk-IUUIT4SU.js 56.5 kB
./bundle/chunk-ODOPE5C4.js 1.95 MB
./bundle/chunk-RJTRUG2J.js 39.8 kB
./bundle/devtools-36NN55EP.js 696 kB
./bundle/dist-T73EYRDX.js 356 B
./bundle/gemini.js 697 kB
./bundle/getMachineId-bsd-TXG52NKR.js 1.55 kB
./bundle/getMachineId-darwin-7OE4DDZ6.js 1.55 kB
./bundle/getMachineId-linux-SHIFKOOX.js 1.34 kB
./bundle/getMachineId-unsupported-5U5DOEYY.js 1.06 kB
./bundle/getMachineId-win-6KLLGOI4.js 1.72 kB
./bundle/memoryDiscovery-O7D6SNBO.js 922 B
./bundle/multipart-parser-KPBZEGQU.js 11.7 kB
./bundle/node_modules/@google/gemini-cli-devtools/dist/client/main.js 221 kB
./bundle/node_modules/@google/gemini-cli-devtools/dist/src/_client-assets.js 227 kB
./bundle/node_modules/@google/gemini-cli-devtools/dist/src/index.js 11.5 kB
./bundle/node_modules/@google/gemini-cli-devtools/dist/src/types.js 132 B
./bundle/sandbox-macos-permissive-open.sb 890 B
./bundle/sandbox-macos-permissive-proxied.sb 1.31 kB
./bundle/sandbox-macos-restrictive-open.sb 3.36 kB
./bundle/sandbox-macos-restrictive-proxied.sb 3.56 kB
./bundle/sandbox-macos-strict-open.sb 4.82 kB
./bundle/sandbox-macos-strict-proxied.sb 5.02 kB
./bundle/src-QVCVGIUX.js 47 kB
./bundle/tree-sitter-7U6MW5PS.js 274 kB
./bundle/tree-sitter-bash-34ZGLXVX.js 1.84 MB
./bundle/undici-4X2YZID5.js 360 B

compressed-size-action

@gemini-cli gemini-cli bot added area/agent Issues related to Core Agent, Tools, Memory, Sub-Agents, Hooks, Agent Quality 🔒 maintainer only ⛔ Do not contribute. Internal roadmap item. labels Mar 19, 2026
@mbleigh mbleigh added this pull request to the merge queue Mar 20, 2026
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Mar 20, 2026
@mbleigh mbleigh added this pull request to the merge queue Mar 20, 2026
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Mar 20, 2026
@adamfweidman adamfweidman added this pull request to the merge queue Mar 20, 2026
Merged via the queue into main with commit b9c87c1 Mar 20, 2026
27 checks passed
@adamfweidman adamfweidman deleted the mb/agent-protocol branch March 20, 2026 13:52
ProthamD pushed a commit to ProthamD/gemini-cli that referenced this pull request Mar 29, 2026
warrenzhu25 pushed a commit to warrenzhu25/gemini-cli that referenced this pull request Apr 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/agent Issues related to Core Agent, Tools, Memory, Sub-Agents, Hooks, Agent Quality 🔒 maintainer only ⛔ Do not contribute. Internal roadmap item.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants