Skip to content

Pipe Valuekind through DoFn and output builders#38490

Open
ahmedabu98 wants to merge 12 commits into
apache:masterfrom
ahmedabu98:valuekind_dofn
Open

Pipe Valuekind through DoFn and output builders#38490
ahmedabu98 wants to merge 12 commits into
apache:masterfrom
ahmedabu98:valuekind_dofn

Conversation

@ahmedabu98
Copy link
Copy Markdown
Contributor

@ahmedabu98 ahmedabu98 commented May 13, 2026

Allows DoFns to output elements with a ValueKind, and receive elements with a ValueKind parameter in the @ProcessElement method

Part of #38278

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
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 enables ValueKind metadata support throughout the Apache Beam pipeline. By allowing DoFns to output elements with specific ValueKind tags and receive them as parameters in @ProcessElement, this change provides greater flexibility for metadata-aware data processing. The implementation spans core SDKs, runner-specific overrides, and the Java harness, ensuring consistent behavior across different execution environments.

Highlights

  • ValueKind Support: Introduced ValueKind support in DoFn output and processing, allowing elements to carry specific metadata.
  • API Enhancements: Added outputWithKind methods to OutputReceiver and MultiOutputReceiver, and enabled ValueKind parameters in @ProcessElement methods.
  • Runner Integration: Updated Direct and Dataflow runners to handle ValueKind metadata, including necessary updates to WindowedValueCoder.
  • Testing: Added comprehensive tests in ValueKindTest and updated existing utility tests to verify ValueKind propagation and serialization.
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.

Copy link
Copy Markdown
Contributor

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

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 comprehensive support for ValueKind (e.g., INSERT, UPDATE, DELETE) across the Beam Java SDK and several runners, including Direct and Dataflow. Key changes include adding outputWithKind methods to DoFn contexts, allowing ValueKind as a parameter in @ProcessElement methods, and ensuring its propagation through transforms like Reshuffle and Reify. Review feedback identified critical bugs in SimpleDoFnRunner where variables were undefined and the ValueKind parameter was ignored in new method implementations. Additionally, an improvement was suggested for DoFnTester to ensure OpenTelemetry context is correctly propagated.

@github-actions github-actions Bot removed the direct label May 13, 2026
@ahmedabu98
Copy link
Copy Markdown
Contributor Author

/gemini review

Copy link
Copy Markdown
Contributor

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

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 ValueKind support to the Apache Beam Java SDK and runners, enabling elements to carry metadata such as INSERT, UPDATE_BEFORE, UPDATE_AFTER, or DELETE. Key changes include adding outputWithKind methods to DoFn contexts, updating WindowedValue to store ValueKind, and implementing the necessary logic in SimpleDoFnRunner, FnApiDoFnRunner, and the Dataflow runner. Review feedback identifies critical compilation errors in SimpleDoFnRunner where the timestamp variable is undefined in new methods, as well as a missing static import for assumeFalse in DataflowRunnerTest that will cause build failures.


@Override
public <T> void outputWithKind(TupleTag<T> tag, T output, ValueKind kind) {
checkTimestamp(timestamp(), timestamp);
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.

high

The variable timestamp is not defined in the scope of the outputWithKind method, which will lead to a compilation error. This appears to be a copy-paste error from the outputWithTimestamp method. Since the output timestamp is implicitly the context's firing timestamp (timestamp()), this check is redundant and should be removed.


@Override
public <T> void outputWithKind(TupleTag<T> tag, T output, ValueKind kind) {
checkTimestamp(this.timestamp, timestamp);
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.

high

The variable timestamp is not defined in this method, likely due to a copy-paste error from outputWithTimestamp. In this context, the output timestamp is fixed to this.timestamp, making this check redundant. It should be removed to avoid compilation issues.

}
// Skipp runner v2 because its Create uses a splittable DoFn, which contains a shuffle.
// ValueKind is not supported in Dataflow shuffle yet
assumeFalse(isRunnerV2);
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.

high

The method assumeFalse is used here but the required static import import static org.junit.Assume.assumeFalse; is missing from the imports section, which will cause a build failure in the tests.

@ahmedabu98 ahmedabu98 mentioned this pull request May 13, 2026
3 tasks
@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

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.

1 participant