Skip to content

Changes cleanup thread to forceExecute. #38073

Open
acrites wants to merge 3 commits intoapache:masterfrom
acrites:master
Open

Changes cleanup thread to forceExecute. #38073
acrites wants to merge 3 commits intoapache:masterfrom
acrites:master

Conversation

@acrites
Copy link
Copy Markdown
Contributor

@acrites acrites commented Apr 4, 2026

Otherwise, we can deadlock if all finalization threads are running. This can happen if e.g. a worker starts up and the pipeline has already been running. It then first gets a bunch of ids to execute and then gets gets a callback to register, which starts up the cleanup thread.

This PR also moves cleanups to a separate ScheduledExecutorService to simplify the cleanup logic as well as prevent it from blocking WorkItem processing.


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
Copy Markdown
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 modifies the initialization of the cleanup thread within the StreamingCommitFinalizer to ensure it starts reliably. By switching to a forced execution strategy, the change avoids deadlock scenarios that can occur when all finalization threads are occupied during worker startup.

Highlights

  • Thread Execution Strategy: Updated the cleanup thread initialization to use forceExecute instead of execute to prevent potential deadlocks during finalization.

🧠 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
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 4, 2026

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

// and some tests.
cleanUpThreadStarted = true;
finalizationExecutor.execute(this::cleanupThreadBody, 0);
finalizationExecutor.forceExecute(this::cleanupThreadBody, 0);
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

can we move the forceExecute to after releasing the lock lock.unlock?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Similar to how it is done in finalizeCommits below.

…to not queue cleanup thread while holding the lock.
} finally {
lock.unlock();
if (shouldStartCleanupThread) {
finalizationExecutor.forceExecute(this::cleanupThreadBody, 0);
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

cleanupThreadBody won't ever terminate unless the worker is shutdown right? If so, running cleanupThreadBody in finalizationExecutor will take away a harness thread. Worker will deadlock when run with harnessThreads set to 1. Can we create a separate cleanupThread/threadpool?

We could use a ScheduledThreadPoolExecutor + the schedule methods and remove the custom expiry logic.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I think this is a great idea!

@codecov
Copy link
Copy Markdown

codecov bot commented Apr 7, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 58.62%. Comparing base (60723cd) to head (19b704f).
⚠️ Report is 28 commits behind head on master.

Additional details and impacted files
@@             Coverage Diff              @@
##             master   #38073      +/-   ##
============================================
+ Coverage     56.89%   58.62%   +1.72%     
- Complexity     3427    15415   +11988     
============================================
  Files          1178     2845    +1667     
  Lines        187542   278719   +91177     
  Branches       3593    12323    +8730     
============================================
+ Hits         106698   163386   +56688     
- Misses        77449   108910   +31461     
- Partials       3395     6423    +3028     
Flag Coverage Δ
java 64.58% <ø> (-7.38%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 7, 2026

Assigning reviewers:

R: @tvalentyn added as fallback since no labels match configuration

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

@tvalentyn
Copy link
Copy Markdown
Contributor

waiting on author

…ice to simplify logic and prevent it from blocking work item processing. Adds an integration test at StreamingDataflowWorker level.
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