Skip to content

Changes cleanup thread to forceExecute. (#38073)#38169

Open
acrites wants to merge 1 commit intoapache:release-2.73from
acrites:cherrypick_pr_38073
Open

Changes cleanup thread to forceExecute. (#38073)#38169
acrites wants to merge 1 commit intoapache:release-2.73from
acrites:cherrypick_pr_38073

Conversation

@acrites
Copy link
Copy Markdown
Contributor

@acrites acrites commented Apr 13, 2026

Runs cleanup thread in its own executor.

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.

This is part of a fix of changes in PR #37723.

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.

* Changes cleanup thread to forceExecute. Otherwise, we can deadlock if all finalization threads are running.

* Changes cacheCommitFinalizers loop to only acquire the lock once and to not queue cleanup thread while holding the lock.

* Changes bundle finalizers to run in a dedicated ScheduledExecutorService to simplify logic and prevent it from blocking work item processing. Adds an integration test at StreamingDataflowWorker level.

* Changes thread pool to a single thread and moves scheduling cleanup under the lock to prevent race with adding to commitFinalizationCallbacks.

* Uses other applied_finalize_ids after merging in apache#37954
@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 refactors the cleanup mechanism for bundle finalization in the StreamingDataflowWorker. By moving cleanup tasks to a dedicated ScheduledExecutorService, the changes prevent potential deadlocks that could occur when finalization threads are exhausted. This architectural shift simplifies the cleanup logic and ensures that cleanup tasks do not interfere with critical WorkItem processing.

Highlights

  • Executor Separation: Moved cleanup tasks to a dedicated ScheduledExecutorService to prevent blocking WorkItem processing and avoid potential deadlocks.
  • Cleanup Logic Refactoring: Replaced the manual cleanup thread and priority queue with scheduled tasks, simplifying the finalization logic.
  • Testing Improvements: Added a new test case to verify bundle finalizers are correctly called and updated existing tests to reflect the new architecture.

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

@Abacn Abacn added this to the 2.73.0 Release milestone Apr 13, 2026
@github-actions
Copy link
Copy Markdown
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

+ " }"
+ " }"
+ "}"
+ "applied_finalize_ids: "
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.

org.apache.beam.vendor.grpc.v1p69p0.com.google.protobuf.TextFormat$ParseException: 1:276: Input contains unknown fields and/or extensions:
1:276:	windmill.GetWorkResponse.applied_finalize_ids
	at app//org.apache.beam.vendor.grpc.v1p69p0.com.google.protobuf.TextFormat$Parser.checkUnknownFields(TextFormat.java:1761)
	at app//org.apache.beam.vendor.grpc.v1p69p0.com.google.protobuf.TextFormat$Parser.merge(TextFormat.java:1780)
	at app//org.apache.beam.vendor.grpc.v1p69p0.com.google.protobuf.TextFormat$Parser.merge(TextFormat.java:1670)
	at app//org.apache.beam.vendor.grpc.v1p69p0.com.google.protobuf.TextFormat.merge(TextFormat.java:1450)
	at app//org.apache.beam.runners.dataflow.worker.StreamingDataflowWorkerTest.buildInput(StreamingDataflowWorkerTest.java:570)
	at app//org.apache.beam.runners.dataflow.worker.StreamingDataflowWorkerTest.makeInput(StreamingDataflowWorkerTest.java:673)
	at app//org.apache.beam.runners.dataflow.worker.StreamingDataflowWorkerTest.testBundleFinalizersAreCalled(StreamingDataflowWorkerTest.java:4344)

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 also cherry-picked #38168, which might have just gone in out of order and should fix this.

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.

retriggered the tests

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