[Java Harness] Reapply optimization to use Caches.weigh on objects within cached blocks

[scwhittle]

Weighing the lists directly ends up remeasuring all of the objects using measureDeep even if those objects are of a Weighted class.

This was previously done with #36897 but was reverted because it used ImmutableList which doesn't allow null elements and null values are supported otherwise in Beam. Changed to using a array backed list instead and added a unit test for null values.

removed nullness suppression in the file while at it.

Should help #37905

---

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)

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]

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 re-enables a critical optimization for cache weighing within the Java Harness, which was previously rolled back. The core improvement involves refactoring the underlying data structures to properly handle null values, a limitation of the prior implementation. This change enhances the efficiency of cache management and improves the robustness of state fetching iterators by ensuring correct weight calculations and null safety.

Highlights

• Reapplied Cache Optimization: Reintroduced an optimization to use Caches.weigh on objects within cached blocks, which was previously reverted due to issues with ImmutableList not supporting null elements.
• Null Value Support: Resolved the ImmutableList issue by switching to an array-backed list for Block values, allowing null elements, and added a dedicated unit test to ensure null values are correctly handled.
• Improved Weight Calculation: Replaced custom arithmetic overflow handling with LongMath::saturatedAdd for weight accumulation in WeightedList and BlocksPrefix, preventing ArithmeticException and ensuring weights cap at Long.MAX_VALUE.
• Nullness Annotations and Suppressions: Cleaned up nullness suppressions and added @Nullable annotations across Caches.java and StateFetchingIterators.java for improved type safety and clarity.
• Refactored Block Class: Converted the StateFetchingIterators.Block from an AutoValue class to a concrete class with a builder pattern, providing more control over its construction and weight calculation.

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

[github-actions]

Checks are failing. Will not request review until checks are succeeding. If you'd like to override that behavior, comment assign set of reviewers

[scwhittle]

Verified that with this change and a Weighted object in state fields, there are no more measureDeep calls.

Here is the fromBlocks stacks with the change:

compared to without the change:

The weighing overhead would be worse for larger objects

[scwhittle]

failures appear unrelated direct runner tests

[scwhittle]

assign set of reviewers

[github-actions]

Assigning reviewers:

R: @kennknowles for label java.

Note: If you would like to opt out of this review, comment assign to next reviewer.

Available commands:

• stop reviewer notifications - opt out of the automated review tooling
• remind me after tests pass - tag the comment author after tests pass
• waiting on author - shift the attention set back to the author (any comment or push by the author will return the attention set to the reviewers)

The PR bot will only process comments in the main thread (not review comments).

[scwhittle]

R: @arunpandianp

[github-actions]

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

[arunpandianp]

Will it be useful to move this logic inside Caches.weigh? Caches.weigh could check if the object is an list/collection and compute weights using this logic.

[scwhittle]

It seems a little safer just here since we know the lists. A possible concern with it in Caches.weigh is that it could remove counting of bytes for custom lists/collections which are more expensive than when iterated.