Skip to content

Bug fix: corrected sleep time calculation in IdleConnectionEvictor #789

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
ok2c merged 1 commit into from
Jan 19, 2026
+25 −16
Merged

Bug fix: corrected sleep time calculation in IdleConnectionEvictor #789

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
17 changes: 15 additions & 2 deletions httpclient5/src/main/java/org/apache/hc/client5/http/impl/IdleConnectionEvictor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
package org.apache.hc.client5.http.impl;

import java.util.concurrent.ThreadFactory;
import java.util.concurrent.TimeUnit;

import org.apache.hc.core5.annotation.Contract;
import org.apache.hc.core5.annotation.ThreadingBehavior;
Expand All @@ -46,14 +47,17 @@
@Contract(threading = ThreadingBehavior.SAFE_CONDITIONAL)
public final class IdleConnectionEvictor {

private static final TimeValue ONE_SECOND = TimeValue.ofSeconds(1L);
private static final TimeValue ONE_MINUTE = TimeValue.ofMinutes(1L);

private final ThreadFactory threadFactory;
private final Thread thread;

public IdleConnectionEvictor(final ConnPoolControl<?> connectionManager, final ThreadFactory threadFactory,
final TimeValue sleepTime, final TimeValue maxIdleTime) {
Args.notNull(connectionManager, "Connection manager");
this.threadFactory = threadFactory != null ? threadFactory : new DefaultThreadFactory("idle-connection-evictor", true);
final TimeValue localSleepTime = sleepTime != null ? sleepTime : TimeValue.ofSeconds(5);
final TimeValue localSleepTime = sleepTime != null ? sleepTime : calculateSleepTime(maxIdleTime);
this.thread = this.threadFactory.newThread(() -> {
try {
while (!Thread.currentThread().isInterrupted()) {
Expand All @@ -76,7 +80,7 @@ public IdleConnectionEvictor(final ConnPoolControl<?> connectionManager, final T
}

public IdleConnectionEvictor(final ConnPoolControl<?> connectionManager, final TimeValue maxIdleTime) {
this(connectionManager, null, maxIdleTime, maxIdleTime);
this(connectionManager, null, null, maxIdleTime);
}

public void start() {
Expand All @@ -95,4 +99,13 @@ public void awaitTermination(final Timeout timeout) throws InterruptedException
thread.join(timeout != null ? timeout.toMilliseconds() : Long.MAX_VALUE);
}

static TimeValue calculateSleepTime(final TimeValue maxIdleTime) {
if (maxIdleTime == null) {
return ONE_MINUTE;
} else {
final TimeValue sleepTime = maxIdleTime.divide(10, TimeUnit.NANOSECONDS);
return sleepTime.compareTo(ONE_SECOND) < 0 ? ONE_SECOND : sleepTime;
}
}

}
8 changes: 1 addition & 7 deletions httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/HttpAsyncClientBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@
import java.util.LinkedList;
import java.util.List;
import java.util.concurrent.ThreadFactory;
import java.util.concurrent.TimeUnit;
import java.util.function.Function;
import java.util.function.UnaryOperator;

Expand Down Expand Up @@ -159,8 +158,6 @@
*/
public class HttpAsyncClientBuilder {

private static final TimeValue ONE_SECOND = TimeValue.ofSeconds(1L);

private static class RequestInterceptorEntry {

enum Position { FIRST, LAST }
Expand Down Expand Up @@ -1177,11 +1174,8 @@ public CloseableHttpAsyncClient build() {
}
if (evictExpiredConnections || evictIdleConnections) {
if (connManagerCopy instanceof ConnPoolControl) {
final TimeValue maxIdleTimeCopy = evictIdleConnections ? maxIdleTime : null;
TimeValue sleepTime = maxIdleTimeCopy != null ? maxIdleTimeCopy.divide(10, TimeUnit.NANOSECONDS) : ONE_SECOND;
sleepTime = sleepTime.compareTo(ONE_SECOND) < 0 ? ONE_SECOND : sleepTime;
final IdleConnectionEvictor connectionEvictor = new IdleConnectionEvictor((ConnPoolControl<?>) connManagerCopy,
sleepTime, maxIdleTimeCopy);
null, evictIdleConnections ? maxIdleTime : null);
closeablesCopy.add(connectionEvictor::shutdown);
connectionEvictor.start();
}
Expand Down
8 changes: 1 addition & 7 deletions httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/HttpClientBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.concurrent.TimeUnit;
import java.util.function.Function;
import java.util.function.UnaryOperator;

Expand Down Expand Up @@ -143,8 +142,6 @@
*/
public class HttpClientBuilder {

private static final TimeValue ONE_SECOND = TimeValue.ofSeconds(1L);

private static class RequestInterceptorEntry {

enum Position { FIRST, LAST }
Expand Down Expand Up @@ -1117,11 +1114,8 @@ public CloseableHttpClient build() {
}
if (evictExpiredConnections || evictIdleConnections) {
if (connManagerCopy instanceof ConnPoolControl) {
final TimeValue maxIdleTimeCopy = evictIdleConnections ? maxIdleTime : null;
TimeValue sleepTime = maxIdleTimeCopy != null ? maxIdleTimeCopy.divide(10, TimeUnit.NANOSECONDS) : ONE_SECOND;
sleepTime = sleepTime.compareTo(ONE_SECOND) < 0 ? ONE_SECOND : sleepTime;
final IdleConnectionEvictor connectionEvictor = new IdleConnectionEvictor((ConnPoolControl<?>) connManagerCopy,
sleepTime, maxIdleTimeCopy);
null, evictIdleConnections ? maxIdleTime : null);
closeablesCopy.add(() -> {
connectionEvictor.shutdown();
try {
Expand Down
8 changes: 8 additions & 0 deletions httpclient5/src/test/java/org/apache/hc/client5/http/impl/TestIdleConnectionEvictor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,4 +78,12 @@ void testEvictExpiredOnly() throws Exception {
Assertions.assertFalse(connectionEvictor.isRunning());
}

@Test
void testCalculateSleepTime() throws Exception {
Assertions.assertEquals(TimeValue.ofMinutes(1), IdleConnectionEvictor.calculateSleepTime(null));
Assertions.assertEquals(TimeValue.ofSeconds(3), IdleConnectionEvictor.calculateSleepTime(TimeValue.ofSeconds(30)));
Assertions.assertEquals(TimeValue.ofSeconds(1), IdleConnectionEvictor.calculateSleepTime(TimeValue.ofSeconds(10)));
Assertions.assertEquals(TimeValue.ofSeconds(1), IdleConnectionEvictor.calculateSleepTime(TimeValue.ofMilliseconds(125)));
}

}