Skip to content

Updated All Externally Visible Logs/Docs from Runner V2 to Portable Runner#38532

Open
TongruiLi wants to merge 8 commits into
apache:masterfrom
TongruiLi:portable_runner_doc
Open

Updated All Externally Visible Logs/Docs from Runner V2 to Portable Runner#38532
TongruiLi wants to merge 8 commits into
apache:masterfrom
TongruiLi:portable_runner_doc

Conversation

@TongruiLi
Copy link
Copy Markdown
Contributor

All runner v2 references have been updated to portable runner, all runner v1 references have been updated to streaming java runner.


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.

@TongruiLi
Copy link
Copy Markdown
Contributor Author

R: @shunping R: @scwhittle

@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 standardizes the terminology used for Dataflow runners across the entire Apache Beam repository. By renaming 'Runner V2' to 'Portable Runner' and 'runner v1' to 'Streaming Java Runner', the changes improve consistency in logs, documentation, and error reporting. These updates affect multiple components, including Gradle build scripts, Go and Python SDKs, and internal protocol definitions, ensuring that the naming conventions are uniform throughout the system.

Highlights

  • Terminology Standardization: Renamed all instances of 'Runner V2' to 'Portable Runner' and 'runner v1' to 'Streaming Java Runner' across the codebase, including logs, documentation, and comments.
  • Validation and Error Messaging: Updated error messages and validation logic in both Java and Python SDKs to reflect the new naming conventions, ensuring consistency in user-facing feedback.
  • Documentation Updates: Updated README files and docstrings to align with the new terminology, improving clarity for developers and users.
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.

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

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 renames 'Runner V2' to 'Portable Runner' and 'Runner V1' to 'Streaming Java Runner' across the Java, Go, and Python SDKs, including documentation and build scripts. It also updates logic to prevent disabling the Portable Runner and adds tests for these cases. Feedback identifies a redundant word in a Java build file comment and an inconsistent error message in the Go SDK that still uses the old terminology.

// TODO(https://github.com/apache/beam/issues/21472)
'org.apache.beam.sdk.transforms.GroupByKeyTest$BasicTests.testAfterProcessingTimeContinuationTriggerUsingState',
// GroupIntoBatches.withShardedKey not supported on streaming runner v1
// GroupIntoBatches.withShardedKey not supported on streaming Streaming Java Runner
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

The word "streaming" is redundant here as "Streaming Java Runner" already includes it.

    // GroupIntoBatches.withShardedKey not supported on Streaming Java Runner

return nil, errors.New("detected one of the following experiments: disable_runner_v2 | disable_runner_v2_until_2023 | disable_prime_runner_v2. Disabling runner v2 is no longer supported as of Beam version 2.45.0+")
// enable_portable_runner is not documented and hence wont be set by default. This will be fixed in later versions.
if strings.Contains(e, "disable_runner_v2") || strings.Contains(e, "disable_runner_v2_until_2023") || strings.Contains(e, "disable_prime_runner_v2") || strings.Contains(e, "disable_portable_runner") || strings.Contains(e, "enable_streaming_java_runner") {
return nil, errors.New("detected one of the following experiments: disable_runner_v2 | disable_runner_v2_until_2023 | disable_prime_runner_v2 | disable_portable_runner | enable_streaming_java_runner. Disabling runner v2 is no longer supported as of Beam version 2.45.0+")
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

For consistency with the rest of the changes in this PR and the Python SDK implementation, "runner v2" in the error message should be updated to "Portable Runner".

Suggested change
return nil, errors.New("detected one of the following experiments: disable_runner_v2 | disable_runner_v2_until_2023 | disable_prime_runner_v2 | disable_portable_runner | enable_streaming_java_runner. Disabling runner v2 is no longer supported as of Beam version 2.45.0+")
return nil, errors.New("detected one of the following experiments: disable_runner_v2 | disable_runner_v2_until_2023 | disable_prime_runner_v2 | disable_portable_runner | enable_streaming_java_runner. Disabling Portable Runner is no longer supported as of Beam version 2.45.0+")

@shunping
Copy link
Copy Markdown
Collaborator

Portable runner in Beam has a wider meaning (https://beam.apache.org/roadmap/portability/). Like Prism is a portable runner, the FnAPI Python runner is also a portable runner, etc.

Is it better if we emphasize Runner V2 as Dataflow Portable Runner? @TongruiLi

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