Skip to content

fix: honor NetworkHttpClient RequestConfig in makeRequest #972

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

Open
arimu1 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: honor NetworkHttpClient RequestConfig in makeRequest #972

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
8 changes: 7 additions & 1 deletion src/main/java/com/twilio/http/NetworkHttpClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ public class NetworkHttpClient extends HttpClient {

protected final CloseableHttpClient client;

private final RequestConfig requestConfig;

private boolean isCustomClient;

/**
Expand All @@ -70,6 +72,7 @@ public NetworkHttpClient(final RequestConfig requestConfig) {
* @param socketConfig a SocketConfig.
*/
public NetworkHttpClient(final RequestConfig requestConfig, final SocketConfig socketConfig) {
this.requestConfig = requestConfig;
Collection<BasicHeader> headers = Arrays.asList(
new BasicHeader("X-Twilio-Client", "java-" + Twilio.VERSION),
// The Accept header is intentionally omitted to support both SCIM and JSON content types.
Expand Down Expand Up @@ -109,6 +112,7 @@ public NetworkHttpClient(final RequestConfig requestConfig, final SocketConfig s
* @param clientBuilder an HttpClientBuilder.
*/
public NetworkHttpClient(HttpClientBuilder clientBuilder) {
this.requestConfig = DEFAULT_REQUEST_CONFIG;
Collection<BasicHeader> headers = Arrays.asList(
new BasicHeader("X-Twilio-Client", "java-" + Twilio.VERSION),
new BasicHeader(HttpHeaders.ACCEPT, "application/json"),
Expand All @@ -133,7 +137,9 @@ public Response makeRequest(final Request request) {
HttpMethod method = request.getMethod();
HttpUriRequestBase httpUriRequestBase = createHttpUriRequestBase(request);

httpUriRequestBase.setConfig(DEFAULT_REQUEST_CONFIG);
if (!isCustomClient) {
httpUriRequestBase.setConfig(this.requestConfig);
}

httpUriRequestBase.setVersion(HttpVersion.HTTP_1_1);

Expand Down
47 changes: 47 additions & 0 deletions src/test/java/com/twilio/http/NetworkHttpClientTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,11 @@
import com.twilio.exception.ApiConnectionException;
import com.twilio.http.IRequest.FormParameters;
import com.twilio.http.IRequest.FormParameters.Type;
import org.apache.hc.client5.http.classic.methods.HttpUriRequestBase;
import org.apache.hc.client5.http.config.RequestConfig;
import org.apache.hc.client5.http.entity.mime.MultipartEntityBuilder;
import org.apache.hc.core5.http.HttpEntity;
import org.apache.hc.core5.util.Timeout;
import org.apache.hc.client5.http.impl.classic.CloseableHttpResponse;
import org.apache.hc.client5.http.impl.classic.CloseableHttpClient;
import org.apache.hc.client5.http.impl.classic.HttpClientBuilder;
Expand All @@ -16,6 +19,9 @@
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;
import org.mockito.Spy;
import org.mockito.ArgumentCaptor;

import java.lang.reflect.Field;

import java.io.ByteArrayInputStream;
import java.io.File;
Expand Down Expand Up @@ -374,4 +380,45 @@ public void testRequestWithMultipleHeaders() throws IOException {

}

@Test
public void testMakeRequestUsesConstructorRequestConfig() throws Exception {
RequestConfig customConfig = RequestConfig.custom()
.setResponseTimeout(Timeout.ofMilliseconds(12345))
.build();

CloseableHttpClient injectedClient = mock(CloseableHttpClient.class);
ArgumentCaptor<HttpUriRequestBase> requestCaptor = ArgumentCaptor.forClass(HttpUriRequestBase.class);
when(injectedClient.execute(requestCaptor.capture())).thenReturn(mockResponse);
when(mockEntity.isRepeatable()).thenReturn(true);
when(mockEntity.getContentLength()).thenReturn(1L);
when(mockEntity.getContent()).thenReturn(new ByteArrayInputStream("ok".getBytes("UTF-8")));
when(mockResponse.getEntity()).thenReturn(mockEntity);
when(mockResponse.getCode()).thenReturn(200);

NetworkHttpClient clientWithConfig = new NetworkHttpClient(customConfig);
Field clientField = NetworkHttpClient.class.getDeclaredField("client");
clientField.setAccessible(true);
clientField.set(clientWithConfig, injectedClient);

when(mockRequest.getMethod()).thenReturn(HttpMethod.GET);
when(mockRequest.constructURL()).thenReturn(new URL("http://foo.com/hello"));
when(mockRequest.requiresAuthentication()).thenReturn(false);
when(mockRequest.getHeaderParams()).thenReturn(new HashMap<>());

clientWithConfig.makeRequest(mockRequest);

assertEquals(customConfig, requestCaptor.getValue().getConfig());
}

@Test
public void testCustomHttpClientBuilderDoesNotSetPerRequestConfig() throws IOException {
setup(200, "frobozz", HttpMethod.GET, false);

client.makeRequest(mockRequest);

ArgumentCaptor<HttpUriRequestBase> requestCaptor = ArgumentCaptor.forClass(HttpUriRequestBase.class);
verify(mockClient).execute(requestCaptor.capture());
assertNull(requestCaptor.getValue().getConfig());
}

}