Skip to content

HTTPCLIENT-1074: Hard request timeout (requestTimeout) for async & classic clients #710

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

Closed
arturobernalg wants to merge 1 commit into from
+624 −35
Closed

HTTPCLIENT-1074: Hard request timeout (requestTimeout) for async & classic clients #710

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
194 changes: 194 additions & 0 deletions ...5-testing/src/test/java/org/apache/hc/client5/testing/sync/TestRequestTimeoutClassic.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,194 @@
/*
* ====================================================================
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
*/
package org.apache.hc.client5.testing.sync;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;

import java.io.IOException;
import java.util.concurrent.TimeUnit;

import org.apache.hc.client5.http.classic.methods.HttpGet;
import org.apache.hc.client5.http.config.ConnectionConfig;
import org.apache.hc.client5.http.config.RequestConfig;
import org.apache.hc.client5.http.impl.classic.CloseableHttpClient;
import org.apache.hc.client5.http.impl.classic.HttpClients;
import org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManager;
import org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManagerBuilder;
import org.apache.hc.core5.http.ContentType;
import org.apache.hc.core5.http.HttpHost;
import org.apache.hc.core5.http.impl.bootstrap.HttpServer;
import org.apache.hc.core5.http.impl.bootstrap.ServerBootstrap;
import org.apache.hc.core5.http.io.HttpRequestHandler;
import org.apache.hc.core5.http.io.entity.StringEntity;
import org.apache.hc.core5.net.URIBuilder;
import org.apache.hc.core5.util.Timeout;
import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

class TestRequestTimeoutClassic {

private static HttpServer server;
private static HttpHost target;

private CloseableHttpClient client;

private static final HttpRequestHandler DELAY_HANDLER = (request, response, context) -> {
int seconds = 1;
final String path = request.getPath(); // e.g. /delay/5
final int idx = path.lastIndexOf('/');
if (idx >= 0 && idx + 1 < path.length()) {
try {
seconds = Integer.parseInt(path.substring(idx + 1));
} catch (final NumberFormatException ignore) { /* default 1s */ }
}
try {
TimeUnit.SECONDS.sleep(seconds);
} catch (final InterruptedException ie) {
Thread.currentThread().interrupt();
}
response.setCode(200);
response.setEntity(new StringEntity("{\"ok\":true}", ContentType.APPLICATION_JSON));
};

@BeforeAll
static void startServer() throws Exception {
server = ServerBootstrap.bootstrap()
.setCanonicalHostName("localhost")
.register("/delay/*", DELAY_HANDLER)
.create();
server.start();
target = new HttpHost("http", "localhost", server.getLocalPort());
}

@AfterAll
static void stopServer() {
if (server != null) {
server.stop();
}
}

@BeforeEach
void createClient() {
final PoolingHttpClientConnectionManager cm =
PoolingHttpClientConnectionManagerBuilder.create()
.setDefaultConnectionConfig(ConnectionConfig.custom()
.setConnectTimeout(Timeout.ofSeconds(5))
.setSocketTimeout(Timeout.ofSeconds(5))
.build())
.build();

client = HttpClients.custom()
.setConnectionManager(cm)
.build();
}

@AfterEach
void closeClient() throws IOException {
if (client != null) {
client.close();
}
}

@Test
@org.junit.jupiter.api.Timeout(value = 10, unit = TimeUnit.SECONDS)
void timesOutHard() throws Exception {
final HttpGet req = new HttpGet(new URIBuilder()
.setScheme(target.getSchemeName())
.setHost(target.getHostName())
.setPort(target.getPort())
.setPath("/delay/5")
.build());
req.setConfig(RequestConfig.custom()
.setRequestTimeout(Timeout.ofSeconds(1)) // hard end-to-end deadline
.setConnectionRequestTimeout(Timeout.ofSeconds(2)) // pool lease cap
.build());

final IOException ex = assertThrows(IOException.class,
() -> client.execute(req, resp -> resp.getCode()));
assertTrue(ex instanceof java.io.InterruptedIOException,
"Expected InterruptedIOException, got: " + ex.getClass());
}

@Test
@org.junit.jupiter.api.Timeout(value = 10, unit = TimeUnit.SECONDS)
void succeedsWithinBudget() throws Exception {
final HttpGet req = new HttpGet(new URIBuilder()
.setScheme(target.getSchemeName())
.setHost(target.getHostName())
.setPort(target.getPort())
.setPath("/delay/1")
.build());
req.setConfig(RequestConfig.custom()
.setRequestTimeout(Timeout.ofSeconds(5)) // enough for lease+connect+1s delay
.setConnectionRequestTimeout(Timeout.ofSeconds(2))
.build());

final int code = client.execute(req, resp -> resp.getCode());
assertEquals(200, code);
}

@Test
@org.junit.jupiter.api.Timeout(value = 10, unit = TimeUnit.SECONDS)
void immediateExpirationFailsBeforeSend() throws Exception {
final HttpGet req = new HttpGet(new URIBuilder()
.setScheme(target.getSchemeName())
.setHost(target.getHostName())
.setPort(target.getPort())
.setPath("/delay/1")
.build());
req.setConfig(RequestConfig.custom()
.setRequestTimeout(Timeout.ofMilliseconds(1)) // near-immediate expiry
.setConnectionRequestTimeout(Timeout.ofSeconds(1))
.build());

assertThrows(java.io.InterruptedIOException.class,
() -> client.execute(req, resp -> resp.getCode()));
}

@Test
@org.junit.jupiter.api.Timeout(value = 10, unit = TimeUnit.SECONDS)
void largeBudgetStillHonorsPerOpTimeouts() throws Exception {
final HttpGet req = new HttpGet(new URIBuilder()
.setScheme(target.getSchemeName())
.setHost(target.getHostName())
.setPort(target.getPort())
.setPath("/delay/1")
.build());
req.setConfig(RequestConfig.custom()
.setRequestTimeout(Timeout.ofSeconds(30))
.setConnectionRequestTimeout(Timeout.ofSeconds(2))
.build());

final int code = client.execute(req, resp -> resp.getCode());
assertEquals(200, code);
}
}
56 changes: 52 additions & 4 deletions httpclient5/src/main/java/org/apache/hc/client5/http/config/RequestConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,13 +72,16 @@ public class RequestConfig implements Cloneable {
*/
private final PriorityValue h2Priority;


private final Timeout requestTimeout;

/**
* Intended for CDI compatibility
*/
protected RequestConfig() {
this(false, null, null, false, false, 0, false, null, null,
DEFAULT_CONNECTION_REQUEST_TIMEOUT, null, null, DEFAULT_CONN_KEEP_ALIVE, false, false, false, null,
null);
null,null);
}

RequestConfig(
Expand All @@ -99,7 +102,8 @@ protected RequestConfig() {
final boolean hardCancellationEnabled,
final boolean protocolUpgradeEnabled,
final Path unixDomainSocket,
final PriorityValue h2Priority) {
final PriorityValue h2Priority,
final Timeout requestTimeout) {
super();
this.expectContinueEnabled = expectContinueEnabled;
this.proxy = proxy;
Expand All @@ -119,6 +123,7 @@ protected RequestConfig() {
this.protocolUpgradeEnabled = protocolUpgradeEnabled;
this.unixDomainSocket = unixDomainSocket;
this.h2Priority = h2Priority;
this.requestTimeout = requestTimeout;
}

/**
Expand Down Expand Up @@ -252,6 +257,22 @@ public PriorityValue getH2Priority() {
return h2Priority;
}

/**
* Returns the hard end-to-end request timeout (call timeout / request deadline).
* The entire exchange must complete within this budget or the execution is aborted.
* <p>
* This timeout is independent of {@linkplain #getConnectTimeout() connect} and
* {@linkplain #getResponseTimeout() response} timeouts. Pass
* {@link org.apache.hc.core5.util.Timeout#DISABLED} to disable.
* </p>
*
* @return the configured request timeout, or {@code null} if not explicitly set
* @since 5.6
*/
public Timeout getRequestTimeout() {
return requestTimeout;
}

@Override
protected RequestConfig clone() throws CloneNotSupportedException {
return (RequestConfig) super.clone();
Expand Down Expand Up @@ -279,6 +300,7 @@ public String toString() {
builder.append(", protocolUpgradeEnabled=").append(protocolUpgradeEnabled);
builder.append(", unixDomainSocket=").append(unixDomainSocket);
builder.append(", h2Priority=").append(h2Priority);
builder.append(", requestTimeout=").append(requestTimeout);
builder.append("]");
return builder.toString();
}
Expand Down Expand Up @@ -306,7 +328,9 @@ public static RequestConfig.Builder copy(final RequestConfig config) {
.setHardCancellationEnabled(config.isHardCancellationEnabled())
.setProtocolUpgradeEnabled(config.isProtocolUpgradeEnabled())
.setUnixDomainSocket(config.getUnixDomainSocket())
.setH2Priority(config.getH2Priority());
.setH2Priority(config.getH2Priority())
.setRequestTimeout(config.getRequestTimeout());

}

public static class Builder {
Expand All @@ -329,6 +353,7 @@ public static class Builder {
private boolean protocolUpgradeEnabled;
private Path unixDomainSocket;
private PriorityValue h2Priority;
private Timeout requestTimeout;

Builder() {
super();
Expand Down Expand Up @@ -696,6 +721,28 @@ public Builder setH2Priority(final PriorityValue priority) {
return this;
}

/**
* Sets the hard end-to-end request timeout (also known as call timeout or request
* deadline). When set, the entire request execution — from connection leasing
* through connection establishment, request write, and response processing —
* must complete within this time budget or the execution will be aborted.
* <p>
* Pass {@link Timeout#DISABLED} to turn this feature off. If this value is
* left unset ({@code null}), no hard request timeout is applied unless a higher
* layer provides one. A non-positive timeout value is treated as an immediate
* expiry.
* </p>
*
* @param requestTimeout the request timeout to apply; use {@code Timeout.DISABLED} to disable
* @return this builder
* @since 5.6
*/
public Builder setRequestTimeout(final Timeout requestTimeout) {
this.requestTimeout = requestTimeout;
return this;
}


public RequestConfig build() {
return new RequestConfig(
expectContinueEnabled,
Expand All @@ -715,7 +762,8 @@ public RequestConfig build() {
hardCancellationEnabled,
protocolUpgradeEnabled,
unixDomainSocket,
h2Priority);
h2Priority,
requestTimeout);
}

}
Expand Down
Loading