Skip to content

Conversation

@Abacn
Copy link
Contributor

@Abacn Abacn commented Dec 12, 2025

Fix #30528

There is a pre-exisitng bug such that Dask runner passing all (non-default) pipeline options to dask client. Whenever there is a pipeline option added that is not part of DaskOptions, pipeline run will crash.

#36271 made save_main_session gets resolved before pipeline submission time and introduced a "non-default" option. It has to be resolved early (unlike other worker options can leave to None and get resolved on worker side) because it is needed as early as staging a pipeline.

Please add a meaningful description for your change here


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
Contributor

Summary of Changes

Hello @Abacn, 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 resolves a critical issue in the Dask runner where it would incorrectly attempt to process all available pipeline options, leading to runtime errors when encountering options not recognized by the Dask client. The solution involves enhancing the PipelineOptions mechanism to allow for hierarchical filtering of options, ensuring that the Dask runner only receives and processes options directly relevant to its configuration. This change significantly improves the robustness and compatibility of the Dask runner with diverse pipeline configurations.

Highlights

  • Bug Fix: Addresses a bug where the Dask runner would crash if non-Dask-specific pipeline options were passed to the Dask client, as it was attempting to process all options.
  • New hierarchy_only Parameter: Introduced a new hierarchy_only boolean parameter to the get_all_options method in PipelineOptions. When True, this parameter restricts the returned options to only those defined within the current class and its superclasses, rather than all known PipelineOptions subclasses.
  • Dask Runner Integration: The Dask runner now utilizes the hierarchy_only=True parameter when calling get_all_options for DaskOptions. This ensures that only relevant Dask-specific options are passed to the Dask client, preventing crashes caused by unrecognized options.
  • Improved Option Filtering: Updated the logic for discarding unparseable or invalid options to respect the hierarchy_only flag, providing more precise control over option processing.
  • New Test Cases: Added new test cases to pipeline_options_test.py to validate the functionality of the hierarchy_only parameter, specifically demonstrating how options are filtered based on the inheritance hierarchy.
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.

@Abacn
Copy link
Contributor Author

Abacn commented Dec 12, 2025

R: @tvalentyn @Amar3tto

@github-actions
Copy link
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

parser = _BeamArgumentParser(allow_abbrev=False)
for cls in PipelineOptions.__subclasses__():
subset.setdefault(str(cls), cls)
if not hierarchy_only:
Copy link
Contributor

Choose a reason for hiding this comment

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

i think it would read easier if we reverse the order of conditions (if hierarchy_only: ...)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

changed

known pipeline options class will still be included in the result. If
set to false, they will be discarded.
hierarchy_only: If set to true, only returns options defined in this class
and its super classes only. Otherwise, arguments that are defined in
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we have use-cases for is returning options from superclasses? would it be sufficient to return only options defined in the current class?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah for current one (DaskOptions) it is sufficient. Simplified.

@Amar3tto Amar3tto self-requested a review December 14, 2025 05:37
@Abacn Abacn merged commit 8e70cba into apache:master Dec 15, 2025
109 of 111 checks passed
@Abacn Abacn deleted the fix-dask branch December 15, 2025 20:10
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.

The Dask Runner Tests job is flaky

3 participants