Skip to content

remove processContext usage across examples (java and kotlin)#38366

Open
stankiewicz wants to merge 1 commit intoapache:masterfrom
stankiewicz:examples_dofn_modernization
Open

remove processContext usage across examples (java and kotlin)#38366
stankiewicz wants to merge 1 commit intoapache:masterfrom
stankiewicz:examples_dofn_modernization

Conversation

@stankiewicz
Copy link
Copy Markdown
Contributor

@stankiewicz stankiewicz commented May 4, 2026

  • Remove legacy processContext usage across and replace it with argument provider
  • context_line values are updated to the main methods or beginning of class

validation:

  • executed many: MapElementsExample, FlatMapElementsExample, CreateExample, ViewExample, SumExample, MinExample, MaxExample, MeanExample, DistinctExample, ToStringExample, RegexExample, WindowExample, CountPerKeyExample,, SumPerKeyExample, MinPerKeyExample, MaxPerKeyExample, MeanPerKeyExample
  • executed some Kotlin pipelines: DebuggingWordCount, WordCount
  • cicd.py script in Playground CI Nightly - No Errors: The script did NOT throw the previous ValueError; 40 Valid Examples Found

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 modernizes the Apache Beam examples by migrating away from the deprecated ProcessContext API in favor of more explicit and type-safe parameter injection. These changes improve code clarity and align the examples with current best practices for writing DoFns in both Java and Kotlin.

Highlights

  • Legacy API Removal: Removed usage of the legacy ProcessContext API across numerous Java and Kotlin examples, replacing it with modern argument providers like @element and OutputReceiver.
  • Code Modernization: Updated DoFn implementations to use parameter-based injection for elements, side inputs, and timestamps, improving readability and maintainability.
  • Documentation Updates: Updated context_line metadata in example files to reflect changes in code structure.

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

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 updates numerous Java examples to align with the new DoFn.ProcessElement method signature, which now uses explicit annotations like @Element, @OutputReceiver, @SideInput, @Timestamp, and PaneInfo instead of ProcessContext. This refactoring affects a wide range of examples, including those demonstrating Iceberg, SQL, various core transforms, complete examples, data tokenization utilities, game examples, and cookbook examples. Additionally, the CsvConverters utility was refactored to introduce a new FailsafeElementToJsonWithHeadersFn for handling CSVs with headers, and the WriteToBigQuery and WriteToText utilities were updated to reflect the new DoFn parameter structure. Review feedback suggests removing an unused variable (headersView) in CsvConverters.java for code cleanup.

…t provider

Starting with examples for java and kotlin.
@stankiewicz stankiewicz force-pushed the examples_dofn_modernization branch from e25dd47 to 7629e32 Compare May 4, 2026 14:51
@stankiewicz stankiewicz requested a review from Abacn May 4, 2026 15:14
}
}

public static class FailsafeElementToJsonWithHeadersFn
Copy link
Copy Markdown
Contributor

@Abacn Abacn May 5, 2026

Choose a reason for hiding this comment

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

What is the consideration to branching the DoFn here? Is necessary to have a separate DoFn with/without side input under recommended OutputReceiver pattern? Ideally we can avoid duplicated codes if possible

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@kennknowles to chip in. we discussed that it's anti-pattern to have nullable side input.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 5, 2026

Assigning reviewers:

R: @chamikaramj for label java.

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

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