Skip to content

[Java FnApi] Improve FinalizeCallbackManager to cleanup timeout queue and use recommended ReentrantLock+Condition#37304

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

[Java FnApi] Improve FinalizeCallbackManager to cleanup timeout queue and use recommended ReentrantLock+Condition#37304
scwhittle wants to merge 3 commits intoapache:masterfrom
scwhittle:finalization_nullness

Conversation

@scwhittle
Copy link
Contributor

I thought there was an issue with nullness with the previous code after awaiting. However since we aren't removing from the cleanupQueue that can't occur. However we might as well clean this up to use better concurrency primitives than notify/await.


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.

…t/notify to recommended ReentrantLock/Condition.
@github-actions github-actions bot added the java label Jan 14, 2026
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @scwhittle, 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 concurrency management within the FinalizeBundleHandler by migrating from traditional await/notify mechanisms to modern ReentrantLock/Condition constructs. This change aims to improve the reliability and maintainability of the bundle finalization process, alongside introducing better nullness checking for increased code safety.

Highlights

  • Concurrency Primitives Update: The FinalizeBundleHandler has been refactored to replace the use of Object.wait() and Object.notify() with the more robust java.util.concurrent.locks.ReentrantLock and java.util.concurrent.locks.Condition for managing concurrent access to the cleanup queue.
  • Nullness Checking Improvements: The @SuppressWarnings("nullness") annotation has been removed, and @Nullable annotations have been added where appropriate, improving the code's null-safety and clarity regarding potential null values.
  • Cleanup Logic Encapsulation: The core cleanup loop logic, previously inline within the FinalizeBundleHandler constructor, has been extracted into a dedicated private method cleanupThreadBody() for better organization and readability.

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

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.

@github-actions
Copy link
Contributor

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
Copy link
Contributor Author

assign set of reviewers

@scwhittle
Copy link
Contributor Author

failures appear unrelated

@scwhittle
Copy link
Contributor Author

Run Java PreCommit

@github-actions
Copy link
Contributor

Assigning reviewers:

R: @ahmedabu98 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
Copy link
Contributor Author

Run Java PreCommit

@scwhittle
Copy link
Contributor Author

Run Java PreCommit

@damccorm
Copy link
Contributor

@ahmedabu98 could you please take a look?

Copy link
Contributor

@ahmedabu98 ahmedabu98 left a comment

Choose a reason for hiding this comment

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

Sorry for the long wait @scwhittle. Left a couple comments

// The minimum element has an expiry time before now.
// It may or may not actually be present in the map if the finalization has already been
// completed.
bundleFinalizationCallbacks.remove(minValue.getValue());
Copy link
Contributor

Choose a reason for hiding this comment

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

This loop doesn't remove the item from the queue, we should make a cleanUpQueue.poll() call somewhere. otherwise it may run forever

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ouch, yeah that's bad. I'm guessing the tests for this class need to be improved then too. I will update and get back to you.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed the problem and added a better test. I also changed to start removing things from the cleanup queue as if we have arbitrary timeouts they could be large and we would be wasting memory on things that completed.

@github-actions
Copy link
Contributor

github-actions bot commented Feb 5, 2026

Reminder, please take a look at this pr: @ahmedabu98

@scwhittle scwhittle changed the title Cleanup use of await/notify to recommended ReentrantLock/Condition and add nullness checking. [Java FnApi] Improve FinalizeCallbackManager to cleanup timeout queue and use recommended ReentrantLock+Condition Feb 6, 2026
@scwhittle scwhittle force-pushed the finalization_nullness branch from 00d52a6 to 0d085b5 Compare February 6, 2026 14:12
Copy link
Contributor

@ahmedabu98 ahmedabu98 left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks for cleaning this up

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.

3 participants