Skip to content

Moves finalize ids out of WorkItem proto and into AssembledWorkItem class.#37954

Open
acrites wants to merge 2 commits intoapache:masterfrom
acrites:finalize-ids
Open

Moves finalize ids out of WorkItem proto and into AssembledWorkItem class.#37954
acrites wants to merge 2 commits intoapache:masterfrom
acrites:finalize-ids

Conversation

@acrites
Copy link
Contributor

@acrites acrites commented Mar 25, 2026

Moves applied finalize ids out of windmill WorkItem proto since that field isn't present in the internal version of that proto. Instead, we move it to the AssembledWorkItem class. Instead of queuing the finalize ids in the call to process(), we instead do it as a separate method before calling scheduleWork().

Also adds GetWorkResponse.applied_finalize_ids, which already exists internally, and is used by Appliance, so now validates runner tests should pass.


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.

…field isn't present in internal version. Moves it to AssembledWorkItem. Also adds internal GetWorkResponse.applied_finalize_ids, which is used by Appliance, so now validates runner tests pass.
@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 refactors the handling of 'applied finalize IDs' within the Dataflow worker, particularly for streaming pipelines. It shifts the responsibility of carrying these IDs from a protobuf message to an internal Java class, AssembledWorkItem, and introduces a distinct step for queuing them. This modification ensures consistency between internal and external representations of work items, specifically by adding the applied_finalize_ids field to the GetWorkResponse proto, which is critical for the Appliance component and resolves issues preventing certain bundle finalizer tests from executing successfully.

Highlights

  • Refactoring of applied_finalize_ids: The applied_finalize_ids field has been moved out of the Windmill.WorkItem proto and into the AssembledWorkItem class. This change addresses the absence of this field in the internal version of the WorkItem proto.
  • Revised Finalization Process: Instead of queuing finalize IDs directly within the process() call, they are now queued via a dedicated queueAppliedFinalizeIds() method, which is invoked separately before scheduleWork().
  • Proto Definition Update: The GetWorkResponse proto has been updated to include applied_finalize_ids. This field, which already existed internally, is now exposed externally, ensuring compatibility with Appliance and enabling relevant runner tests to pass.
  • Enabled Bundle Finalizer Tests: The exclusion of UsesBundleFinalizer tests for streaming appliance in the build.gradle file has been removed, indicating that these tests are now expected to pass with the implemented changes.

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

Assigning reviewers:

R: @jrmccluskey 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).

// present, this field includes metadata associated with any hot key.
optional HotKeyInfo hot_key_info = 11;

repeated int64 applied_finalize_ids = 16;
Copy link
Contributor

Choose a reason for hiding this comment

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

reserve it, just in case something is already depending on it?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done. I also triggered a run of the post submits, which should test bundle finalizers on appliance and engine. Let's see how they do.

Copy link
Contributor

Choose a reason for hiding this comment

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

this is best practice for protos anyway, field numbers should never be re-used even if the field is deprecated

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