Skip to content

Fix/add experiment refactor#38252

Open
ash6898 wants to merge 4 commits into
apache:masterfrom
ash6898:fix/add-experiment-refactor
Open

Fix/add experiment refactor#38252
ash6898 wants to merge 4 commits into
apache:masterfrom
ash6898:fix/add-experiment-refactor

Conversation

@ash6898

@ash6898 ash6898 commented Apr 21, 2026

Copy link
Copy Markdown

addresses #19347

Summary

Replace manual experiment list manipulation with the existing helper methods:

  • Python: Convert experiments.append(...) to debug_options.add_experiment(...) in 5 files
  • Java: Replace getExperiments()/modify/setExperiments() pattern with ExperimentalOptions.addExperiment(...) in 3 files

This is a pure refactor — no behavior change. The helper methods already handle null-init and deduplication internally.

Files changed

Python:

  • sdks/python/apache_beam/pipeline.py
  • sdks/python/apache_beam/runners/portability/fn_api_runner/fn_runner.py
  • sdks/python/apache_beam/io/iobase_test.py
  • sdks/python/apache_beam/io/external/xlang_parquetio_test.py
  • sdks/python/apache_beam/runners/dataflow/internal/apiclient.py

Java:

  • runners/google-cloud-dataflow-java/src/main/java/.../DataflowPipelineTranslator.java
  • runners/google-cloud-dataflow-java/src/main/java/.../DataflowRunner.java
  • runners/google-cloud-dataflow-java/worker/src/main/.../GrpcWindmillServer.java

@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 performs a clean refactor of how pipeline experiments are managed in the codebase. By migrating from manual list operations to established helper methods, the implementation becomes more concise and robust, ensuring consistent handling of experiment flags without altering existing behavior.

Highlights

  • Refactoring Experiment Management: Replaced manual list manipulation of pipeline experiments with centralized helper methods across both Python and Java SDKs.
  • Improved Robustness: Utilized existing helper methods that inherently handle null-initialization and deduplication, reducing boilerplate and potential bugs.

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

@ash6898

ash6898 commented Apr 28, 2026

Copy link
Copy Markdown
Author

CI Analysis

The Python CI failure (test_streaming_sentiment_analysis_yaml) is unrelated to this PR:

  • Failing test location: apache_beam/yaml/examples/testing/examples_test.py (NOT in my changes)
  • Root cause: gRPC subprocess server timeout in subprocess_server.py (infrastructure/environmental issue)
  • My changes: Pure refactor of add_experiment() calls - zero behavioral impact
  • Files modified:
    • sdks/python/apache_beam/pipeline.py
    • sdks/python/apache_beam/runners/dataflow/internal/apiclient.py
    • sdks/python/apache_beam/runners/portability/fn_api_runner/fn_runner.py
    • sdks/python/apache_beam/io/iobase_test.py
    • sdks/python/apache_beam/io/external/xlang_parquetio_test.py

None of these appear in the error trace. This is a pre-existing test infrastructure issue.

@damccorm

Copy link
Copy Markdown
Contributor

assign set of reviewers

@github-actions

Copy link
Copy Markdown
Contributor

Assigning reviewers:

R: @shunping for label python.

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

@github-actions

Copy link
Copy Markdown
Contributor

Reminder, please take a look at this pr: @shunping

@shunping

Copy link
Copy Markdown
Collaborator

Hi! Could you rebase your PR to the current master? Hopefully, that will reduce the number of failed tests.

@ash6898 ash6898 force-pushed the fix/add-experiment-refactor branch from bf53c7f to 86063e1 Compare June 1, 2026 02:41
@github-actions

github-actions Bot commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

Reminder, please take a look at this pr: @shunping

@github-actions

Copy link
Copy Markdown
Contributor

Assigning new set of reviewers because Pr has gone too long without review. If you would like to opt out of this review, comment assign to next reviewer:

R: @tvalentyn for label python.

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)

@tvalentyn

Copy link
Copy Markdown
Contributor

@ash6898 thanks for the contribuion. could you resolve the conflict please? thanks!

@tvalentyn

Copy link
Copy Markdown
Contributor

apologies for the delays and us asking you again to rebase, looks like this fell trough the cracks due to some tooling issues and OOO's

ash6898 added 4 commits June 12, 2026 17:46
Replaces manual list manipulation pattern with DebugOptions.add_experiment()
which handles null-init and deduplication internally.

Resolves apache#19347
… Java

Replaces getExperiments()/modify/setExperiments() boilerplate with
ExperimentalOptions.addExperiment() which handles null-init and deduplication.

Resolves apache#19347
@ash6898 ash6898 force-pushed the fix/add-experiment-refactor branch from 86063e1 to 13549dc Compare June 12, 2026 22:07
@tvalentyn

Copy link
Copy Markdown
Contributor

/gemini review

@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 refactors how pipeline experiments are added across both the Java and Python SDKs by replacing manual list manipulation and copying with helper methods (ExperimentalOptions.addExperiment in Java and DebugOptions.add_experiment in Python). The review feedback correctly points out that several pre-emptive copies of the experiments list to a mutable ArrayList in the Java codebase are redundant, as ExperimentalOptions.addExperiment already handles null-initialization and list copying internally. Removing these redundant blocks will further clean up the code.

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.

Comment on lines +406 to 410
// Ensure the experiments list is mutable before any experiments are added.
if (options.getExperiments() != null) {
options.setExperiments(new ArrayList<>(options.getExperiments()));
}
job.setName(options.getJobName().toLowerCase());

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.

medium

This pre-emptive copy of the experiments list to an ArrayList is redundant. ExperimentalOptions.addExperiment already handles null-initialization and copies the existing list into a new mutable ArrayList internally before adding any new experiments. You can safely remove this block.

Suggested change
// Ensure the experiments list is mutable before any experiments are added.
if (options.getExperiments() != null) {
options.setExperiments(new ArrayList<>(options.getExperiments()));
}
job.setName(options.getJobName().toLowerCase());
job.setName(options.getJobName().toLowerCase());

Comment on lines +1246 to 1250
// Ensure the experiments list is mutable before any experiments are added.
if (options.getExperiments() != null) {
options.setExperiments(new ArrayList<>(options.getExperiments()));
}
// Multi-language pipelines and pipelines that include upgrades should automatically be upgraded

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.

medium

This pre-emptive copy of the experiments list to an ArrayList is redundant. ExperimentalOptions.addExperiment already handles null-initialization and copies the existing list into a new mutable ArrayList internally before adding any new experiments. You can safely remove this block.

Suggested change
// Ensure the experiments list is mutable before any experiments are added.
if (options.getExperiments() != null) {
options.setExperiments(new ArrayList<>(options.getExperiments()));
}
// Multi-language pipelines and pipelines that include upgrades should automatically be upgraded
// Multi-language pipelines and pipelines that include upgrades should automatically be upgraded

Comment on lines +114 to 118
// Ensure the experiments list is mutable before any experiments are added.
if (options.getExperiments() != null) {
options.setExperiments(new ArrayList<>(options.getExperiments()));
}
options.setProject("project");

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.

medium

This pre-emptive copy of the experiments list to an ArrayList is redundant. ExperimentalOptions.addExperiment already handles null-initialization and copies the existing list into a new mutable ArrayList internally before adding any new experiments. You can safely remove this block.

Suggested change
// Ensure the experiments list is mutable before any experiments are added.
if (options.getExperiments() != null) {
options.setExperiments(new ArrayList<>(options.getExperiments()));
}
options.setProject("project");
options.setProject("project");

@tvalentyn tvalentyn Jun 13, 2026

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.

here and in other places: why was this copy necessary?

ImmutableList.<String>builder().addAll(experiments).add("upload_graph").build());
if (jobGraphByteSize >= CREATE_JOB_REQUEST_LIMIT_BYTES && !useUnifiedWorker(options)) {
ExperimentalOptions.addExperiment(options, "upload_graph");
LOG.info(

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.

nit: looks like this log line will now be printed regardless even if the experiment was already enabled.
let's add && !hasExperiment(options, "upload_graph") back?

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.

4 participants