[client-v2] Fix settings mutability #2550
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Client V2 CoverageCoverage Report
Class Coverage
|
JDBC V2 CoverageCoverage Report
Class Coverage
|
JDBC V1 CoverageCoverage Report
Class Coverage
|
Client V1 CoverageCoverage Report
Class Coverage
|
There was a problem hiding this comment.
Pull Request Overview
This PR addresses settings mutability issues by implementing a defensive copy pattern for user settings before adjustment. The change prevents side effects when settings are used concurrently for different operations, specifically addressing issue #2543.
- Creates copies of settings objects to prevent unintended mutations of user-provided settings
- Refactors settings classes to use a common
CommonSettingsclass for shared functionality - Adds comprehensive test coverage to verify settings immutability
Reviewed Changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| client-v2/src/main/java/com/clickhouse/client/api/internal/CommonSettings.java | New shared settings implementation with copy/merge functionality |
| client-v2/src/main/java/com/clickhouse/client/api/query/QuerySettings.java | Refactored to use CommonSettings with defensive copying |
| client-v2/src/main/java/com/clickhouse/client/api/insert/InsertSettings.java | Refactored to use CommonSettings with defensive copying |
| client-v2/src/main/java/com/clickhouse/client/api/Client.java | Updated to create defensive copies of settings before operations |
| client-v2/src/test/java/com/clickhouse/client/SettingsTests.java | Added comprehensive tests for settings functionality |
| client-v2/src/test/java/com/clickhouse/client/query/QueryTests.java | Added test to verify settings are not mutated during query operations |
| client-v2/src/test/java/com/clickhouse/client/insert/InsertTests.java | Added test to verify settings are not mutated during insert operations |
| jdbc-v2/src/test/java/com/clickhouse/jdbc/PreparedStatementTest.java | Removed test for internal method that no longer exists |
| client-v2/pom.xml | Added Mockito dependency for testing |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Contributor Author
| @mzitnik Sonar shows low coverage because of failing because of "low free space" error. |
mzitnik approved these changes Aug 23, 2025
| */ | ||
| public boolean isClientRequestEnabled() { | ||
| return (Boolean) rawSettings.get("decompress"); | ||
| Boolean flag = (Boolean) settings.getOption(ClientConfigProperties.COMPRESS_CLIENT_REQUEST.getKey()); |
Contributor
There was a problem hiding this comment.
Maybe we should have a method getOptionWithDefault
|
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
Summary
Makes a copy of user settings before adjustment to prevent side effects when settings used concurrently for different operations.
Closes #2543
Checklist
Delete items not relevant to your PR: