When more than one instance of the same PipelineOption subclass is detected, use the first one.

[tvalentyn]

When more than one instance of the same PipelineOption subclass is detected, use the first one instead of the last one.

This change helps to avoid a race condition where CloudPickle sometimes creates [skeleton classes] (https://github.com/apache/beam/blob/735864d4d5cd0abda9b1181c6459eb877218c16a/sdks/python/apache_beam/internal/cloudpickle/cloudpickle.py#L646C1-L647C1) and leaves then uninitiazlied, and eventually garbage collected. This happens when an initialized skeleton already exists for a given class_tracker_id. An uninitialized skeleton doesn't have an overloaded PipelineOptionSubclass._add_argparse_args bound method, and hence may cause difficult to debug error where pipeline options may not be properly parsed.

Picking the first subclass empirically reduces the risk of picking the 'wrong' subclass, but a better fix would be to avoid creating uninitialized skeletons when they are not necessary to reduce sideeffects of unpickling.

---

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)

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]

Summary of Changes

Hello @tvalentyn, I'm Gemini Code Assist¹! 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 implements a targeted fix to mitigate a race condition within Apache Beam's Python SDK, specifically concerning the handling of PipelineOption subclasses during deserialization. By adjusting the logic to prioritize the first detected instance of a subclass, the change aims to prevent issues arising from uninitialized 'skeleton classes' created by CloudPickle, which could otherwise lead to incorrect parsing of pipeline options and difficult-to-debug errors. This enhances the stability and reliability of pipeline option processing.

Highlights

• Race Condition Mitigation: This pull request addresses a race condition that could occur when CloudPickle creates uninitialized 'skeleton classes' for PipelineOption subclasses. This could lead to _add_argparse_args not being properly bound, causing pipeline option parsing errors.
• PipelineOption Subclass Handling: The change modifies the get_all_options function to ensure that when multiple instances of the same PipelineOption subclass are detected, the first encountered instance is used, rather than potentially overwriting it with a later, possibly uninitialized, instance.
• Partial Fix Acknowledged: The author notes that while this change empirically reduces the risk of picking the 'wrong' subclass, a more comprehensive fix would involve preventing the creation of unnecessary uninitialized skeletons by CloudPickle in the first place.

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

[tvalentyn]

R: @claudevdm

[github-actions]

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