Skip to content

Implement custom http request timeout executor #1624

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.

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
merged 1 commit into from
Apr 11, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
package org.cloudfoundry.multiapps.controller.core.http;

import java.io.IOException;
import java.util.Timer;
import java.util.TimerTask;
import java.util.function.Function;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpUriRequest;
import org.cloudfoundry.multiapps.common.SLException;

public class TimeoutHttpExecutor {

private final HttpClient client;

public TimeoutHttpExecutor(HttpClient client) {
this.client = client;
}

public <T> T executeWithTimeout(HttpUriRequest request, long timeoutInMillis, Function<HttpResponse, T> responseHandler) {
TimerTask abortRequestTask = buildAbortRequestTimerTask(request);
Timer timeoutEnforcer = new Timer(true);
timeoutEnforcer.schedule(abortRequestTask, timeoutInMillis);
try {
final HttpResponse response = client.execute(request);
return responseHandler.apply(response);
} catch (IOException e) {
throw new SLException(e, e.getMessage());
} finally {
abortRequestTask.cancel();
timeoutEnforcer.cancel();
}
}

private TimerTask buildAbortRequestTimerTask(HttpUriRequest request) {
return new TimerTask() {
@Override
public void run() {
if (!request.isAborted()) {
request.abort();
}
}
};
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
package org.cloudfoundry.multiapps.controller.core.http;

import java.io.IOException;
import java.util.function.Function;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpUriRequest;
import org.cloudfoundry.multiapps.common.SLException;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

class TimeoutHttpExecutorTest {

private HttpClient mockHttpClient;
private HttpUriRequest mockRequest;
private HttpResponse mockResponse;
private TimeoutHttpExecutor timeoutHttpExecutor;

@BeforeEach
void setUp() {
mockHttpClient = mock(HttpClient.class);
mockRequest = mock(HttpUriRequest.class);
mockResponse = mock(HttpResponse.class);
timeoutHttpExecutor = new TimeoutHttpExecutor(mockHttpClient);
}

@Test
void testExecuteWithTimeoutSuccessfulExecution() throws IOException {
when(mockHttpClient.execute(mockRequest)).thenReturn(mockResponse);
Function<HttpResponse, String> responseHandler = response -> "Success";

String result = timeoutHttpExecutor.executeWithTimeout(mockRequest, 1000, responseHandler);

assertEquals("Success", result);
verify(mockHttpClient, times(1)).execute(mockRequest);
verify(mockRequest, never()).abort();
}

@Test
void testExecuteWithTimeoutRequestAbortedDueToTimeout() throws IOException {
when(mockHttpClient.execute(mockRequest)).thenAnswer(invocation -> {
Thread.sleep(200); // Simulate a delay
return mockResponse;
});
Function<HttpResponse, String> responseHandler = response -> "Success";

timeoutHttpExecutor.executeWithTimeout(mockRequest, 100, responseHandler);
verify(mockRequest, times(1)).abort();
}

@Test
void testExecuteWithTimeoutIOExceptionThrown() throws IOException {
when(mockHttpClient.execute(mockRequest)).thenThrow(new IOException("Connection error"));
Function<HttpResponse, String> responseHandler = response -> "Success";

SLException exception = assertThrows(SLException.class,
() -> timeoutHttpExecutor.executeWithTimeout(mockRequest, 1000, responseHandler));
assertEquals("Connection error", exception.getMessage());
verify(mockRequest, never()).abort();
}

}