Fix a memory leak in the failed instruction id cache.#39405
Conversation
…d inadvertently capturing the content of stack frames in the heap and limit RAM growth due to cache size.
Summary of ChangesHello, 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 addresses a potential memory leak in the SDK worker's failed instruction cache. By capping the cache size and sanitizing the stored exception information—specifically by truncating excessively long error messages and tracebacks—the change ensures more stable memory usage during instruction failures. Highlights
New Features🧠 You can now enable Memory (public preview) to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe 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
Customization To customize the 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 Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counterproductive. 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
|
There was a problem hiding this comment.
Code Review
This pull request improves the memory management of the BundleProcessorCache by reducing the maximum number of stored failed instructions and implementing truncation for exception tracebacks. Unit tests were added to verify the cache size limits and traceback truncation logic. A valid review comment identified a potential compatibility issue with traceback.format_exception in Python versions prior to 3.10, providing a necessary fix to ensure backward compatibility.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
| processor = None | ||
| with self._lock: | ||
| self.failed_instruction_ids[instruction_id] = exception | ||
| tb_str = "".join(traceback.format_exception(exception)) |
There was a problem hiding this comment.
In Python versions prior to 3.10, traceback.format_exception does not accept a single exception object as a positional argument and will raise a TypeError (missing value and tb arguments). Since Apache Beam supports Python 3.8 and 3.9, you should pass type(exception), exception, exception.__traceback__ to maintain backward compatibility.
tb_str = "".join(
traceback.format_exception(
type(exception), exception, exception.__traceback__))|
R: @damccorm |
|
Stopping reviewer notifications for this pull request: review requested by someone other than the bot, ceding control. If you'd like to restart, comment |
Sanitize the exception message stored for failed instructions to limit RAM growth.
Storing the original exception in the cache inadvertently captures stack frames and local variables, such as BundleProcessor objects, in the heap.
Drive by: decrease failed instruction ID cache size, and cap its growth by limiting exception message length.
fixes: #39406
internal reference: b/531440331
Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
addresses #123), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, commentfixes #<ISSUE NUMBER>instead.CHANGES.mdwith noteworthy changes.See the Contributor Guide for more tips on how to make review process smoother.
To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md
GitHub Actions Tests Status (on master branch)
See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.