Skip to content

Ensure proper closure of httpResponse in error scenarios during retries #2497

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chernser merged 2 commits into from
Jul 17, 2025
Merged

Ensure proper closure of httpResponse in error scenarios during retries #2497

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
190983e
Ensure proper closure of `httpResponse` in error scenarios during ret…
orsondmc Jul 14, 2025
115bd12
Refactor `httpResponse` handling with `closeQuietly` to ensure consis…
orsondmc Jul 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions client-v2/src/main/java/com/clickhouse/client/api/Client.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@
import java.io.InputStream;
import java.io.OutputStream;
import java.lang.reflect.InvocationTargetException;
import java.net.MalformedURLException;
import java.net.URL;
import java.nio.charset.StandardCharsets;
import java.time.Duration;
Expand Down Expand Up @@ -121,7 +122,7 @@ public class Client implements AutoCloseable {
private final Map<String, Object> configuration;

private final Map<String, String> readOnlyConfig;

private final POJOSerDe pojoSerDe;

private final ExecutorService sharedOperationExecutor;
Expand Down Expand Up @@ -291,7 +292,7 @@ public Builder() {
*/
public Builder addEndpoint(String endpoint) {
try {
URL endpointURL = new java.net.URL(endpoint);
URL endpointURL = new URL(endpoint);

if (endpointURL.getProtocol().equalsIgnoreCase("https")) {
addEndpoint(Protocol.HTTP, endpointURL.getHost(), endpointURL.getPort(), true);
Expand All @@ -300,7 +301,7 @@ public Builder addEndpoint(String endpoint) {
} else {
throw new IllegalArgumentException("Only HTTP and HTTPS protocols are supported");
}
} catch (java.net.MalformedURLException e) {
} catch (MalformedURLException e) {
throw new IllegalArgumentException("Endpoint should be a valid URL string, but was " + endpoint, e);
}
return this;
Expand Down Expand Up @@ -380,7 +381,7 @@ public Builder setAccessToken(String accessToken) {

/**
* Makes client to use SSL Client Certificate to authenticate with server.
* Client certificate should be set as well. {@link Client.Builder#setClientCertificate(String)}
* Client certificate should be set as well. {@link Builder#setClientCertificate(String)}
* @param useSSLAuthentication
* @return
*/
Expand Down Expand Up @@ -1583,8 +1584,9 @@ public CompletableFuture<QueryResponse> query(String sqlQuery, Map<String, Objec
Endpoint selectedEndpoint = getNextAliveNode();
RuntimeException lastException = null;
for (int i = 0; i <= retries; i++) {
ClassicHttpResponse httpResponse = null;
Copy link

Copilot AI Jul 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] Consider using a try-with-resources statement for ClassicHttpResponse to ensure it's always closed automatically, simplifying the error-handling logic.

Copilot uses AI. Check for mistakes.
try {
ClassicHttpResponse httpResponse =
httpResponse =
httpClientHelper.executeRequest(selectedEndpoint, finalSettings.getAllSettings(), lz4Factory, output -> {
output.write(sqlQuery.getBytes(StandardCharsets.UTF_8));
output.close();
Expand Down Expand Up @@ -1614,6 +1616,7 @@ public CompletableFuture<QueryResponse> query(String sqlQuery, Map<String, Objec
return new QueryResponse(httpResponse, responseFormat, finalSettings, metrics);

} catch (Exception e) {
httpClientHelper.closeQuietly(httpResponse);
lastException = httpClientHelper.wrapException(String.format("Query request failed (Attempt: %s/%s - Duration: %s)",
(i + 1), (retries + 1), System.nanoTime() - startTime), e);
if (httpClientHelper.shouldRetry(e, finalSettings.getAllSettings())) {
Expand Down
15 changes: 14 additions & 1 deletion client-v2/src/main/java/com/clickhouse/client/api/internal/HttpAPIClientHelper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -428,8 +428,9 @@ public ClassicHttpResponse executeRequest(Endpoint server, Map<String, Object> r

HttpClientContext context = HttpClientContext.create();

ClassicHttpResponse httpResponse = null;
try {
ClassicHttpResponse httpResponse = httpClient.executeOpen(null, req, context);
httpResponse = httpClient.executeOpen(null, req, context);
boolean serverCompression = ClientConfigProperties.COMPRESS_SERVER_RESPONSE.getOrDefault(requestConfig);
httpResponse.setEntity(wrapResponseEntity(httpResponse.getEntity(), httpResponse.getCode(), serverCompression, useHttpCompression, lz4Factory, requestConfig));

Expand All @@ -448,14 +449,26 @@ public ClassicHttpResponse executeRequest(Endpoint server, Map<String, Object> r
return httpResponse;

} catch (UnknownHostException e) {
closeQuietly(httpResponse);
LOG.warn("Host '{}' unknown", server.getBaseURL());
throw e;
} catch (ConnectException | NoRouteToHostException e) {
closeQuietly(httpResponse);
LOG.warn("Failed to connect to '{}': {}", server.getBaseURL(), e.getMessage());
throw e;
}
}

public void closeQuietly(ClassicHttpResponse httpResponse) {
if (httpResponse != null) {
try {
httpResponse.close();
} catch (IOException e) {
LOG.warn("Failed to close response");
}
}
}

private static final ContentType CONTENT_TYPE = ContentType.create(ContentType.TEXT_PLAIN.getMimeType(), "UTF-8");

private void addHeaders(HttpPost req, Map<String, Object> requestConfig) {
Expand Down
Loading