ClickHouseIO - Improve user agent by BentsiLeviav · Pull Request #37815 · apache/beam

BentsiLeviav · 2026-03-10T16:42:45Z

Description

Updated the user agent setting name from product_name (deprecated) to client_name
Create a shared logic for building the user agent
Make sure we concat any external client_name to the base user agent
Rename the original test class to IT
Create a new test class for unit tests
Add unit tests for the new user agent logic

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)

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 · 2026-03-10T16:43:05Z

Summary of Changes

Hello, I'm Gemini Code Assist¹! 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 refactors the user agent handling within the ClickHouseIO connector to align with modern practices and improve testability. It deprecates an older user agent property in favor of a more current one and introduces a centralized mechanism for constructing the user agent string, allowing for better extensibility and consistency. Furthermore, the testing suite has been reorganized to clearly separate unit tests from integration tests, enhancing the clarity and maintainability of the test codebase.

Highlights

User Agent Update: Updated the user agent property from "product_name" to "client_name" in ClickHouseIO.java, aligning with modern practices.
Shared User Agent Logic: Implemented a shared "buildClientName" method to standardize user agent string construction, ensuring proper concatenation with existing client names.
Test Class Refactoring: Refactored the existing "ClickHouseIOTest" class into "ClickHouseIOIT" to specifically house integration tests.
New Unit Test Class: Created a new "ClickHouseIOTest" class dedicated to unit tests, particularly for the new user agent logic.

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

Changelog

sdks/java/io/clickhouse/src/main/java/org/apache/beam/sdk/io/clickhouse/ClickHouseIO.java
- Replaced the deprecated "product_name" property with "client_name" when setting the user agent.
- Introduced a new static method "buildClientName" to encapsulate the logic for creating the user agent string, including appending any pre-existing client names.
- Updated all relevant "setClientName" calls to utilize the new "buildClientName" method.
sdks/java/io/clickhouse/src/test/java/org/apache/beam/sdk/io/clickhouse/ClickHouseIOIT.java
- Added a new file, which is an integration test class for ClickHouseIO.
- Included comprehensive tests for various data types (Int64, Nullable Int64, Array of Array of Int64, Primitive Types, Array of Primitive Types) and complex schema types (TupleType, Complex TupleType), ensuring robust interaction with a ClickHouse instance.
sdks/java/io/clickhouse/src/test/java/org/apache/beam/sdk/io/clickhouse/ClickHouseIOTest.java
- Modified the existing test file to remove all integration tests, moving them to ClickHouseIOIT.java.
- Added new unit tests for the "buildClientName" method, covering scenarios with no existing client name, an empty client name, and an existing client name.

Activity

No human activity (comments, reviews, etc.) was found in the provided context.

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.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

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 · 2026-03-10T18:22:28Z

Assigning reviewers:

R: @Abacn 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).

mzitnik · 2026-03-15T16:57:11Z

      set(properties, "insert_distributed_sync", insertDistributedSync());
      set(properties, "insert_deduplication", insertDeduplicate());
-      set(properties, "product_name", userAgent);
+      set(properties, "client_name", buildClientName(properties));


Can we add it to documentation

Added a section about it to the auto generated docs

mzitnik · 2026-03-15T17:16:11Z

+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.beam.sdk.io.clickhouse;


I have started to make Product Name integration tests

added a test named testUserAgentInQueryLog to ClickHouseIOIT

mzitnik

LGTM

Abacn · 2026-03-26T14:22:31Z

+
+test {
+  // Include integration tests (Testcontainers-based *IT classes) alongside unit tests
+  include "**/*IT.class"


test is for unit tests. Integration test should locates in integrationTest task. To do so, add

provideIntegrationTestingDependencies() enableJavaPerformanceTesting()

(see https://github.com/apache/beam/blob/master/sdks/java/io/jdbc/build.gradle for example)
then add the target to

beam/.github/workflows/beam_PreCommit_Java_Clickhouse_IO_Direct.yml

Line 91 in f8dbba1

gradle-command: :sdks:java:io:clickhouse:build

@Abacn Tnx! moved it

github-actions · 2026-04-03T12:27:19Z

Reminder, please take a look at this pr: @Abacn

Abacn · 2026-04-07T17:26:34Z

+
+/** Tests for {@link ClickHouseIO}. */
+@RunWith(JUnit4.class)
+public class ClickHouseIOIT extends BaseClickHouseTest {


I realize previously unit test runs both unit test and integration test. We can now move the integration test (running against real test container) into IT. This involves the following,

BaseClickHouseTest is a test fixture and does not contain an actual test. Consider name it "ClickHouseTestBase"

rename AtomicInsertTest to AtomicInsertIT

github-actions · 2026-04-10T12:29:47Z

Assigning new set of reviewers because Pr has gone too long without review. If you would like to opt out of this review, comment assign to next reviewer:

R: @ahmedabu98 for label java.

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)

github-actions · 2026-04-17T12:35:24Z

Reminder, please take a look at this pr: @ahmedabu98

Abacn

Thank you!

BentsiLeviav added 3 commits March 10, 2026 18:34

product name is deprecated, changing to client name

3c6f657

create a share method + append external client name

2be2292

add unittests and rename original test file to IT

af866bf

github-actions Bot added java io clickhouse labels Mar 10, 2026

github-actions Bot added the Next Action: Reviewers label Mar 10, 2026

reuse the same properties

8b2de9e

mzitnik reviewed Mar 15, 2026

View reviewed changes

BentsiLeviav added 4 commits March 22, 2026 08:42

add user agent logic to the generated documentation

1de0d9f

fix query log targeted column

4d21bab

add integration test to verify user agent is correct

6af1683

make sure integration tests are included

1e80b23

BentsiLeviav requested a review from mzitnik March 22, 2026 10:35

mzitnik approved these changes Mar 26, 2026

View reviewed changes

Abacn requested changes Mar 26, 2026

View reviewed changes

github-actions Bot added the slow-review label Apr 3, 2026

move IT out of test task

6905257

github-actions Bot added the build label Apr 5, 2026

BentsiLeviav requested a review from Abacn April 5, 2026 09:03

github-actions Bot removed the build label Apr 5, 2026

Abacn reviewed Apr 7, 2026

View reviewed changes

github-actions Bot added reassigned-reviewers and removed slow-review labels Apr 10, 2026

github-actions Bot added the slow-review label Apr 17, 2026

Abacn approved these changes Apr 17, 2026

View reviewed changes

Abacn merged commit f300e59 into apache:master Apr 17, 2026
21 checks passed

Conversation

BentsiLeviav commented Mar 10, 2026

Description

GitHub Actions Tests Status (on master branch)

Uh oh!

gemini-code-assist Bot commented Mar 10, 2026

Summary of Changes

Highlights

Footnotes

Uh oh!

github-actions Bot commented Mar 10, 2026

Uh oh!

mzitnik Mar 15, 2026

Choose a reason for hiding this comment

Uh oh!

BentsiLeviav Mar 22, 2026

Choose a reason for hiding this comment

Uh oh!

mzitnik Mar 15, 2026

Choose a reason for hiding this comment

Uh oh!

BentsiLeviav Mar 22, 2026

Choose a reason for hiding this comment

Uh oh!

mzitnik left a comment

Choose a reason for hiding this comment

Uh oh!

Abacn Mar 26, 2026

Choose a reason for hiding this comment

Uh oh!

BentsiLeviav Apr 5, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Apr 3, 2026

Uh oh!

Abacn Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Apr 10, 2026

Uh oh!

github-actions Bot commented Apr 17, 2026

Uh oh!

Abacn left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants