Skip to content

[Java] Add ByteStringOutputStream.isEmpty() and reduce ByteStringOutputStream.size() calls#37947

Open
scwhittle wants to merge 3 commits intoapache:masterfrom
scwhittle:size_opt
Open

[Java] Add ByteStringOutputStream.isEmpty() and reduce ByteStringOutputStream.size() calls#37947
scwhittle wants to merge 3 commits intoapache:masterfrom
scwhittle:size_opt

Conversation

@scwhittle
Copy link
Contributor

This is cheaper than size() which would have to iterate through ByteString trees.
size() was showing up as .5% of CPU in a test pipeline.


Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:

  • Mention the appropriate issue in your description (for example: 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, comment fixes #<ISSUE NUMBER> instead.
  • Update CHANGES.md with noteworthy changes.
  • If this contribution is large, please file an Apache Individual Contributor License Agreement.

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)

Build python source distribution and wheels
Python tests
Java tests
Go tests

See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.

@gemini-code-assist
Copy link
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 focuses on a performance improvement by introducing a new isEmpty() method to ByteStringOutputStream. This method provides a more efficient way to check if a stream is empty compared to the existing size() method, which can be computationally expensive due to iterating through ByteString trees. The changes replace size() calls with isEmpty() where appropriate, leading to reduced CPU usage in critical paths, and also include minor corrections to byte counting logic in related stream implementations.

Highlights

  • New API for checking emptiness: Introduced a new isEmpty() method in ByteStringOutputStream to efficiently check if the stream contains any data without incurring the cost of calculating its total size.
  • Performance Optimization: Replaced existing stream.size() == 0 or stream.size() > 0 checks with the new isEmpty() method across various components (PubsubSink, WindmillSink, BeamFnDataOutboundAggregator, DataStreams, BagUserState) to reduce CPU overhead, as size() can be expensive for ByteString trees.
  • Improved Byte Counting Logic: Corrected the byte counting logic in BeamFnDataOutboundAggregator.Receiver and DataStreams.ElementDelimitedOutputStream to properly account for zero-byte encodings and ensure accurate delta calculations.
  • Stream Reset Optimization: Optimized the reset() method in ByteStringOutputStream for simpler and more direct state clearing.
  • Test Updates: Updated relevant unit tests to utilize the new hasBufferedOutput() method and added a test case for the isEmpty() method.

🧠 New Feature in Public Preview: You can now enable Memory 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 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.

@scwhittle
Copy link
Contributor Author

R: @arunpandianp

@github-actions
Copy link
Contributor

Stopping reviewer notifications for this pull request: review requested by someone other than the bot, ceding control. If you'd like to restart, comment assign set of reviewers

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants