Skip to content

Add drain states to PipelineResult#39020

Open
lalitx17 wants to merge 1 commit into
apache:masterfrom
lalitx17:pipeline-result-drain-states
Open

Add drain states to PipelineResult#39020
lalitx17 wants to merge 1 commit into
apache:masterfrom
lalitx17:pipeline-result-drain-states

Conversation

@lalitx17

Copy link
Copy Markdown
Contributor

This change adds DRAINING and DRAINED to PipelineResult.State so runners can report drain lifecycle states directly instead of mapping them to RUNNING, DONE, or UNKNOWN.

Tests are updated to cover the new state mappings and runner behavior.

addresses #38771

@lalitx17 lalitx17 marked this pull request as ready for review June 18, 2026 21:11
Copilot AI review requested due to automatic review settings June 18, 2026 21:11

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@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 introduces explicit DRAINING and DRAINED states to the PipelineResult lifecycle. By adding these states, runners can now communicate the progress of a drain operation more accurately instead of overloading existing states like RUNNING or DONE. The changes span the core SDK, multiple runner implementations, and the job service, ensuring consistent state handling and preventing redundant cancellation attempts on jobs that have already finished draining.

Highlights

  • PipelineResult State Expansion: Added DRAINING and DRAINED states to the PipelineResult.State enum to provide more granular lifecycle reporting.
  • Runner Updates: Updated Flink, Dataflow, and Portability runners to correctly map and report the new drain-related states.
  • Job Service Logic: Modified JobInvocation to prevent cancellation of jobs that have already reached a DRAINED state.
  • Test Coverage: Added comprehensive unit tests across multiple modules to verify correct state transitions and behavior for the new drain states.
New Features

🧠 You can now enable Memory (public preview) 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 the 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 counterproductive. 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.

@gemini-code-assist gemini-code-assist Bot left a comment

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.

Code Review

This pull request introduces the DRAINING and DRAINED pipeline states to the Beam SDK and integrates them across various runners, including Flink, Google Cloud Dataflow, and the Portability framework. It updates state mapping, job cancellation logic, and logging to support these new states, alongside adding corresponding unit tests to verify the behavior. There are no review comments, so I have no feedback to provide.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

@lalitx17

Copy link
Copy Markdown
Contributor Author

R: @stankiewicz I've added the DRAINING and DRAINED states on the top of the drain support which was previous commit. Take a look. Thanks.

@github-actions

Copy link
Copy Markdown
Contributor

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

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.

2 participants