robustness(core): static checks to validate history is immutable

[jacob314]

Follow up to:

• perf(core): fix OOM crash in long-running sessions

that makes it safe by enforcing readonly items using the type system.

[gemini-code-assist]

Summary of Changes

Hello, I'm Gemini Code Assist¹! 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 primarily focuses on enhancing the stability and type safety of the application by addressing potential OOM issues and enforcing immutability for chat history data. By leveraging TypeScript's readonly keyword, the codebase now explicitly prevents unintended modifications to critical data structures, leading to more predictable behavior and allowing for performance optimizations in history handling. Additionally, a caching mechanism was introduced for response text to reduce computational overhead.

Highlights

• Performance Improvement: Addressed a potential Out-Of-Memory (OOM) crash in long-running sessions, likely by optimizing how chat history is handled.
• Type Safety Enhancement: Enforced immutability for chat history arrays across various parts of the codebase by utilizing TypeScript's readonly type modifier. This prevents accidental modification of history data.
• History Copying Optimization: Removed deep cloning of chat history in GeminiChat.getHistory and replaced it with a shallow copy, as the readonly type enforcement now guarantees that the returned array's contents will not be mutated externally.
• Response Text Caching: Implemented caching for the concatenated response text within a Turn object to improve performance by avoiding redundant computations.

Changelog

• packages/cli/src/ui/utils/historyExportUtils.ts
  • Updated serializeHistoryToMarkdown function and ExportHistoryOptions interface to use readonly Content[] for history parameters, ensuring immutability.
• packages/core/src/commands/types.ts
  • Modified LoadHistoryActionReturn interface to declare clientHistory as readonly Content[], enforcing its read-only nature.
• packages/core/src/core/client.ts
  • Updated getHistory, setHistory, and tryMaskToolOutputs methods to use readonly Content[] for history parameters and return types, promoting immutability.
• packages/core/src/core/geminiChat.ts
  • Changed makeApiCallAndProcessStream parameter requestContents to readonly Content[].
  • Ensured lastContentsToUse and contentsToUse are explicitly shallow-copied using the spread operator to prevent direct mutation of original arrays.
  • Modified getHistory method to return readonly Content[] and replaced structuredClone with a shallow copy [...history].
  • Updated setHistory method to accept readonly Content[] and shallow-copy the input to this.history.
  • Adjusted ensureActiveLoopHasThoughtSignatures parameters and return type to readonly Content[].
• packages/core/src/core/logger.ts
  • Updated the Checkpoint interface to mark the history property as readonly Content[].
• packages/core/src/core/turn.ts
  • Added a cachedResponseText property to cache the result of getResponseText.
  • Implemented caching logic within getResponseText to compute and store the concatenated response text only once per turn.
• packages/core/src/routing/routingStrategy.ts
  • Modified the RoutingContext interface to define history as readonly Content[].
• packages/core/src/safety/context-builder.ts
  • Updated convertHistoryToTurns method to accept readonly Content[] for the history parameter.
• packages/core/src/services/chatCompressionService.ts
  • Changed truncateHistoryToBudget function to accept readonly Content[] for the history parameter.
• packages/core/src/services/chatRecordingService.ts
  • Updated updateMessagesFromHistory method to accept readonly Content[] for the history parameter.
• packages/core/src/services/toolOutputMaskingService.ts
  • Modified MaskingResult interface and the mask method to use readonly Content[] for history-related properties and parameters.
• packages/core/src/utils/checkpointUtils.ts
  • Updated ToolCallData interface to specify clientHistory as readonly Content[].
• packages/sdk/src/session.ts
  • Modified the transcript variable in GeminiCliSession to be of type readonly Content[].
• packages/sdk/src/types.ts
  • Updated the SessionContext interface to declare transcript as readonly Content[].

Activity

• No specific activity (comments, reviews, or progress updates) has been recorded for this pull request yet.

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.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

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. ↩

[gemini-code-assist]

Code Review

This pull request introduces performance improvements to prevent OOM crashes in long-running sessions and enforces stricter immutability through the type system by using readonly. The changes include caching the response text in Turn.getResponseText and updating various types to use readonly Content[].

One significant change is replacing structuredClone with a shallow copy [...history] in GeminiChat.getHistory. While this addresses the performance issue, it introduces a risk of state mutation, as the readonly modifier on the array does not prevent modification of the objects within it. I've added a comment to highlight this potential issue.

The rest of the changes correctly propagate the readonly type and are well-aligned with the PR's goals.

[github-actions]

Size Change: -8.82 kB (-0.03%)

Total Size: 26 MB

Filename	Size	Change
./bundle/gemini.js	25.5 MB	-8.82 kB (-0.03%)

ℹ️ View Unchanged

Filename	Size
./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

_{compressed-size-action}

[gemini-cli]

Hi there! Thank you for your contribution to Gemini CLI.

To improve our contribution process and better track changes, we now require all pull requests to be associated with an existing issue, as announced in our recent discussion and as detailed in our CONTRIBUTING.md.

This pull request is being closed because it is not currently linked to an issue. Once you have updated the description of this PR to link an issue (e.g., by adding Fixes #123 or Related to #123), it will be automatically reopened.

How to link an issue:
Add a keyword followed by the issue number (e.g., Fixes #123) in the description of your pull request. For more details on supported keywords and how linking works, please refer to the GitHub Documentation on linking pull requests to issues.

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

[gsquared94]

lgtm!