Skip to content

[KafkaIO] Remove build support for Kafka clients before 3.9.2#39284

Open
sjvanrossum wants to merge 7 commits into
apache:masterfrom
sjvanrossum:kafkaio-remove-obsolete-clients
Open

[KafkaIO] Remove build support for Kafka clients before 3.9.2#39284
sjvanrossum wants to merge 7 commits into
apache:masterfrom
sjvanrossum:kafkaio-remove-obsolete-clients

Conversation

@sjvanrossum

Copy link
Copy Markdown
Contributor

Remove build support for legacy Kafka clients. The Kafka protocol implementation in Kafka client version 3.9.2 still allows users to connect to legacy Kafka brokers. See KIP-896 for details on protocol compatibility.

This PR was split from #36834 and enables opportunities to improve KafkaIO performance by leveraging new client features.


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 KafkaIO module by standardizing on Kafka client version 3.9.2. By removing support for older client versions, the project reduces maintenance overhead and enables the adoption of newer Kafka features. The changes involve updating Gradle build configurations, removing deprecated sub-projects, and adjusting test infrastructure to align with the updated Kafka server APIs.

Highlights

  • Kafka Client Upgrade: Upgraded the Kafka client version to 3.9.2 across the project, removing support for older legacy versions.
  • Build Configuration Cleanup: Removed legacy Kafka version build modules and updated build dependencies to use the new Kafka 3.9.2 artifacts.
  • Code Refactoring: Updated internal Kafka test utilities to accommodate API changes in Kafka 3.9.2, specifically replacing KafkaServerStartable with KafkaServer.
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.

@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 upgrades the Kafka dependency version from 2.4.1 to 3.9.2, cleans up several legacy Kafka integration test modules, and adapts the codebase to Kafka's updated APIs (such as replacing KafkaServerStartable with KafkaServer and updating consumer close signatures). The reviewer's feedback highlights a critical improvement: instead of using fragile, Scala-compiler-generated default argument methods (like $lessinit$greater$default$2()) directly in Java when initializing KafkaServer, the code should explicitly pass standard Scala/Java instances to ensure stability across compiler versions.

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 +125 to +130
KafkaServer server =
new KafkaServer(
new KafkaConfig(props),
KafkaServer.$lessinit$greater$default$2(),
KafkaServer.$lessinit$greater$default$3(),
KafkaServer.$lessinit$greater$default$4());

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

Using Scala compiler-generated default argument methods (like $lessinit$greater$default$2()) directly in Java is fragile and highly discouraged. These synthetic methods are internal implementation details of the Scala compiler and can change across Scala compiler versions or if the constructor parameters are reordered/modified in future Kafka releases.

Instead, pass explicit, standard Scala/Java instances such as org.apache.kafka.common.utils.Time.SYSTEM, scala.Option.empty(), and scala.collection.immutable.List$.MODULE$.empty().

Suggested change
KafkaServer server =
new KafkaServer(
new KafkaConfig(props),
KafkaServer.$lessinit$greater$default$2(),
KafkaServer.$lessinit$greater$default$3(),
KafkaServer.$lessinit$greater$default$4());
KafkaServer server =
new KafkaServer(
new KafkaConfig(props),
org.apache.kafka.common.utils.Time.SYSTEM,
scala.Option.empty(),
scala.collection.immutable.List$.MODULE$.empty());

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.

Using Scala compiler-generated default argument methods (like $lessinit$greater$default$2()) directly in Java is fragile and highly discouraged.

Needs citation?

Jokes aside, that last argument is supposed to be a Boolean so this is not exactly the right suggestion.
I don't feel strongly about this, Kafka itself instantiates KafkaServer as follows in main:

new KafkaServer(
  config,
  Time.SYSTEM,
  threadNamePrefix = None,
  enableForwarding = enableApiForwarding(config)
)

Other than readability I don't see a good reason not to use the generated methods to access default arguments.
If the signature were to change due to argument reordering as mentioned, then the suggested change would break at compile time whereas the generated methods would return the expected type because their definition depends on the signature definition itself.

Comment on lines +34 to +39
server =
new KafkaServer(
KafkaConfig.fromProps(kafkaProperties),
KafkaServer.$lessinit$greater$default$2(),
KafkaServer.$lessinit$greater$default$3(),
KafkaServer.$lessinit$greater$default$4());

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

Using Scala compiler-generated default argument methods (like $lessinit$greater$default$2()) directly in Java is fragile and highly discouraged. These synthetic methods are internal implementation details of the Scala compiler and can change across Scala compiler versions or if the constructor parameters are reordered/modified in future Kafka releases.

Instead, pass explicit, standard Scala/Java instances such as org.apache.kafka.common.utils.Time.SYSTEM, scala.Option.empty(), and scala.collection.immutable.List$.MODULE$.empty().

Suggested change
server =
new KafkaServer(
KafkaConfig.fromProps(kafkaProperties),
KafkaServer.$lessinit$greater$default$2(),
KafkaServer.$lessinit$greater$default$3(),
KafkaServer.$lessinit$greater$default$4());
server =
new KafkaServer(
KafkaConfig.fromProps(kafkaProperties),
org.apache.kafka.common.utils.Time.SYSTEM,
scala.Option.empty(),
scala.collection.immutable.List$.MODULE$.empty());

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.

Using Scala compiler-generated default argument methods (like $lessinit$greater$default$2()) directly in Java is fragile and highly discouraged.

Needs citation?

Jokes aside, that last argument is supposed to be a Boolean so this is not exactly the right suggestion.
I don't feel strongly about this, Kafka itself instantiates KafkaServer as follows in main:

new KafkaServer(
  config,
  Time.SYSTEM,
  threadNamePrefix = None,
  enableForwarding = enableApiForwarding(config)
)

Other than readability I don't see a good reason not to use the generated methods to access default arguments.
If the signature were to change due to argument reordering as mentioned, then the suggested change would break at compile time whereas the generated methods would return the expected type because their definition depends on the signature definition itself.

@sjvanrossum sjvanrossum force-pushed the kafkaio-remove-obsolete-clients branch from 8e1389c to 4da22b0 Compare July 10, 2026 23:12
@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