Migrate MqttIO to HiveMQ Mqtt client#39180
Conversation
|
Tested that StackOverflowError is resolved by waiting for 1.5h and publish a few messages (Dataflow job ID |
Summary of ChangesHello, 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 migrates the Apache Beam MqttIO connector from the deprecated Fusesource MQTT client to the HiveMQ MQTT client. This change modernizes the underlying messaging infrastructure, ensuring better compatibility and support for MQTT standards. The update encompasses modifications to the core IO logic, test suites, and build dependencies to align with the new client's API patterns. Highlights
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 AssistThe 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
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 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
|
|
R: @tkaymak |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request migrates the MQTT IO connector from the deprecated Fusesource MQTT client to the HiveMQ MQTT client library, updating both the implementation in MqttIO and its corresponding tests. The review feedback highlights three critical reliability improvements: preventing a potential NullPointerException when getPassword() is null during authentication setup, and addressing two potential connection leaks in UnboundedMqttReader during startup failure and resource teardown.
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.
| if (getUsername() != null) { | ||
| LOG.debug("MQTT client uses username {}", getUsername()); | ||
| builder = | ||
| builder | ||
| .simpleAuth() | ||
| .username(getUsername()) | ||
| .password(getPassword().getBytes(StandardCharsets.UTF_8)) | ||
| .applySimpleAuth(); | ||
| } |
There was a problem hiding this comment.
If getPassword() is null, calling getPassword().getBytes(StandardCharsets.UTF_8) will throw a NullPointerException. We should check if the password is non-null before attempting to set it on the client builder.
if (getUsername() != null) {
LOG.debug("MQTT client uses username {}", getUsername());
if (getPassword() != null) {
builder =
builder
.simpleAuth()
.username(getUsername())
.password(getPassword().getBytes(StandardCharsets.UTF_8))
.applySimpleAuth();
} else {
builder = builder.simpleAuth().username(getUsername()).applySimpleAuth();
}
}| client.connect(); | ||
|
|
||
| // Subscribe and get the publishes stream with manual acks enabled | ||
| publishes = client.publishes(MqttGlobalPublishFilter.ALL, true); | ||
|
|
||
| client | ||
| .subscribeWith() | ||
| .topicFilter(spec.connectionConfiguration().getTopic()) | ||
| .qos(MqttQos.AT_LEAST_ONCE) | ||
| .send(); |
There was a problem hiding this comment.
If an exception occurs after client.connect() succeeds (e.g., during subscription or getting the publishes stream), the client connection is leaked because it is never disconnected. We should catch exceptions after connection and disconnect the client before rethrowing.
client.connect();
try {
// Subscribe and get the publishes stream with manual acks enabled
publishes = client.publishes(MqttGlobalPublishFilter.ALL, true);
client
.subscribeWith()
.topicFilter(spec.connectionConfiguration().getTopic())
.qos(MqttQos.AT_LEAST_ONCE)
.send();
} catch (Exception e) {
try {
client.disconnect();
} catch (Exception disconnectEx) {
e.addSuppressed(disconnectEx);
}
throw e;
}| if (publishes != null) { | ||
| publishes.close(); | ||
| } | ||
| if (client != null) { | ||
| client.disconnect(); | ||
| } |
There was a problem hiding this comment.
If publishes.close() throws an exception, client.disconnect() will not be called, which can lead to connection leaks. We should ensure both resources are closed/disconnected even if one of them fails.
if (publishes != null) {
try {
publishes.close();
} catch (Exception e) {
LOG.warn("Error closing publishes stream", e);
}
}
if (client != null) {
client.disconnect();
}
|
Stopping reviewer notifications for this pull request: review requested by someone other than the bot, ceding control. If you'd like to restart, comment |
1 participant
Fix #39179
Please add a meaningful description for your change here
Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
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, commentfixes #<ISSUE NUMBER>instead.CHANGES.mdwith noteworthy changes.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)
See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.