map AWS_IO_SOCKET_TIMEOUT HttpException to java.net.ConnectException when acquiring connection (#5940)

Co-authored-by: Zoe Wang <[email protected]>

Author: thomasjinlo

.changes/next-release/feature-AWSCRTHTTPClient-8cb2d05.json

@@ -0,0 +1,6 @@
+{
+    "category": "AWS CRT HTTP Client", 
+    "contributor": "thomasjinlo", 
+    "type": "feature", 
+    "description": "Map AWS_IO_SOCKET_TIMEOUT to ConnectException when acquiring a connection to improve error handling"
+}

http-clients/aws-crt-client/src/main/java/software/amazon/awssdk/http/crt/internal/CrtUtils.java

@@ -23,6 +23,7 @@
 import static software.amazon.awssdk.utils.NumericUtils.saturatedCast;
 
 import java.io.IOException;
+import java.net.ConnectException;
 import java.time.Duration;
 import javax.net.ssl.SSLHandshakeException;
 import software.amazon.awssdk.annotations.SdkInternalApi;
@@ -35,6 +36,7 @@
 @SdkInternalApi
 public final class CrtUtils {
     public static final int CRT_TLS_NEGOTIATION_ERROR_CODE = 1029;
+    public static final int CRT_SOCKET_TIMEOUT = 1048;
 
     private CrtUtils() {
     }
@@ -54,9 +56,12 @@ public static Throwable wrapConnectionFailureException(Throwable throwable) {
         Throwable toThrow = new IOException("An exception occurred when acquiring a connection", throwable);
         if (throwable instanceof HttpException) {
             HttpException httpException = (HttpException) throwable;
+            int httpErrorCode = httpException.getErrorCode();
 
-            if (httpException.getErrorCode() == CRT_TLS_NEGOTIATION_ERROR_CODE) {
+            if (httpErrorCode == CRT_TLS_NEGOTIATION_ERROR_CODE) {
                 toThrow = new SSLHandshakeException(httpException.getMessage());
+            } else if (httpErrorCode == CRT_SOCKET_TIMEOUT) {
+                toThrow = new ConnectException(httpException.getMessage());
             }
         }
 

http-clients/aws-crt-client/src/test/java/software/amazon/awssdk/http/crt/internal/CrtAsyncRequestExecutorTest.java

@@ -21,12 +21,19 @@
 import static software.amazon.awssdk.http.crt.CrtHttpClientTestUtils.createRequest;
 
 import java.io.IOException;
+import java.net.ConnectException;
 import java.net.URI;
+import javax.net.ssl.SSLHandshakeException;
 import java.util.concurrent.CompletableFuture;
+import java.util.stream.Stream;
+import java.util.AbstractMap.SimpleEntry;
+import java.util.Map.Entry;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.MethodSource;
 import org.mockito.ArgumentCaptor;
 import org.mockito.Mock;
 import org.mockito.Mockito;
@@ -56,6 +63,13 @@ public class CrtAsyncRequestExecutorTest {
     @Mock
     private HttpClientConnection httpClientConnection;
 
+    public static Stream<Entry<Integer, Class<? extends Throwable>>> mappedExceptions() {
+        return Stream.of(
+            new SimpleEntry<>(0x0405, SSLHandshakeException.class), // For AWS_IO_TLS_ERROR_NEGOTIATION_FAILURE (1029)
+            new SimpleEntry<>(0x0418, ConnectException.class) // For AWS_IO_SOCKET_TIMEOUT (1048)
+        );
+    }
+
     @BeforeEach
     public void setup() {
         requestExecutor = new CrtAsyncRequestExecutor();
@@ -149,6 +163,23 @@ public void execute_AcquireConnectionFailure_shouldAlwaysWrapIOException() {
         assertThatThrownBy(executeFuture::join).hasCauseInstanceOf(IOException.class).hasRootCause(exception);
     }
 
+    @ParameterizedTest
+    @MethodSource("mappedExceptions")
+    public void execute_AcquireConnectionFailure_shouldAlwaysBeInstanceOfIOException(Entry<Integer, Class<? extends Throwable>> entry) {
+        int errorCode = entry.getKey();
+        Class<? extends Throwable> ioExceptionSubclass = entry.getValue();
+
+        CrtAsyncRequestContext context = crtAsyncRequestContext();
+        HttpException exception = new HttpException(errorCode);
+        CompletableFuture<HttpClientConnection> completableFuture = CompletableFutureUtils.failedFuture(exception);
+
+        Mockito.when(connectionManager.acquireConnection()).thenReturn(completableFuture);
+
+        CompletableFuture<Void> executeFuture = requestExecutor.execute(context);
+        assertThatThrownBy(executeFuture::join).hasCauseInstanceOf(IOException.class).hasMessageContaining(exception.getMessage());
+        assertThatThrownBy(executeFuture::join).hasCauseInstanceOf(ioExceptionSubclass);
+    }
+
     @Test
     public void executeRequest_failedOfIllegalStateException_shouldWrapIOException() {
         IllegalStateException exception = new IllegalStateException("connection closed");

http-clients/aws-crt-client/src/test/java/software/amazon/awssdk/http/crt/internal/CrtRequestExecutorTest.java

@@ -20,9 +20,13 @@
 import static software.amazon.awssdk.http.crt.CrtHttpClientTestUtils.createRequest;
 
 import java.io.IOException;
+import java.net.ConnectException;
 import java.net.URI;
+import javax.net.ssl.SSLHandshakeException;
 import java.util.concurrent.CompletableFuture;
 import java.util.stream.Stream;
+import java.util.AbstractMap.SimpleEntry;
+import java.util.Map.Entry;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
@@ -59,6 +63,13 @@ public static Stream<Throwable> retryableExceptions() {
             "connection closed"));
     }
 
+    public static Stream<Entry<Integer, Class<? extends Throwable>>> mappedExceptions() {
+        return Stream.of(
+            new SimpleEntry<>(0x0405, SSLHandshakeException.class), // For AWS_IO_TLS_ERROR_NEGOTIATION_FAILURE (1029)
+            new SimpleEntry<>(0x0418, ConnectException.class) // For AWS_IO_SOCKET_TIMEOUT (1048)
+        );
+    }
+
     @BeforeEach
     public void setup() {
         requestExecutor = new CrtRequestExecutor();
@@ -111,6 +122,23 @@ public void execute_AcquireConnectionFailure_shouldAlwaysWrapIOException() {
         assertThatThrownBy(executeFuture::join).hasCauseInstanceOf(IOException.class).hasRootCause(exception);
     }
 
+    @ParameterizedTest
+    @MethodSource("mappedExceptions")
+    public void execute_AcquireConnectionFailure_shouldAlwaysBeInstanceOfIOException(Entry<Integer, Class<? extends Throwable>> entry) {
+        int errorCode = entry.getKey();
+        Class<? extends Throwable> ioExceptionSubclass = entry.getValue();
+
+        CrtRequestContext context = crtRequestContext();
+        HttpException exception = new HttpException(errorCode);
+        CompletableFuture<HttpClientConnection> completableFuture = CompletableFutureUtils.failedFuture(exception);
+
+        Mockito.when(connectionManager.acquireConnection()).thenReturn(completableFuture);
+
+        CompletableFuture<SdkHttpFullResponse> executeFuture = requestExecutor.execute(context);
+        assertThatThrownBy(executeFuture::join).hasCauseInstanceOf(IOException.class).hasMessageContaining(exception.getMessage());
+        assertThatThrownBy(executeFuture::join).hasCauseInstanceOf(ioExceptionSubclass);
+    }
+
     @Test
     public void executeRequest_failedOfNonRetryableHttpException_shouldNotWrapIOException() {
         HttpException exception = new HttpException(0x0801); // AWS_ERROR_HTTP_HEADER_NOT_FOUND