Adding attempt count to error message

.changes/next-release/feature-AWSSDKforJavav2-6db3e90.json

@@ -0,0 +1,6 @@
+{
+    "type": "feature",
+    "category": "AWS SDK for Java v2",
+    "contributor": "",
+    "description": "Add retry attempt count to exception messages to improve debugging visibility."
+}

codegen/src/main/java/software/amazon/awssdk/codegen/poet/model/ExceptionProperties.java

@@ -34,7 +34,9 @@ public static List<MethodSpec> builderInterfaceMethods(ClassName className) {
                 builderMethod(className, "requestId", String.class),
                 builderMethod(className, "statusCode", int.class),
                 builderMethod(className, "cause", Throwable.class),
-                builderMethod(className, "writableStackTrace", Boolean.class));
+                builderMethod(className, "writableStackTrace", Boolean.class),
+                builderMethod(className, "numAttempts", Integer.class));
+
     }
 
     public static List<MethodSpec> builderImplMethods(ClassName className) {
@@ -44,7 +46,8 @@ public static List<MethodSpec> builderImplMethods(ClassName className) {
                 builderImplMethods(className, "requestId", String.class),
                 builderImplMethods(className, "statusCode", int.class),
                 builderImplMethods(className, "cause", Throwable.class),
-                builderImplMethods(className, "writableStackTrace", Boolean.class));
+                builderImplMethods(className, "writableStackTrace", Boolean.class),
+                builderImplMethods(className, "numAttempts", Integer.class));
     }
 
     private static MethodSpec builderMethod(ClassName className, String name, Class clazz) {

codegen/src/main/resources/software/amazon/awssdk/codegen/rules/SourceException.java.resource

@@ -23,6 +23,9 @@ public class SourceException extends SdkException {
 
         @Override
         SourceException build();
+
+        @Override
+        Builder numAttempts(Integer numAttempts);
     }
 
     public static class BuilderImpl extends SdkException.BuilderImpl implements Builder {
@@ -48,5 +51,11 @@ public class SourceException extends SdkException {
         public SourceException build() {
             return new SourceException(this);
         }
+
+        @Override
+        public Builder numAttempts(Integer numAttempts) {
+            super.numAttempts(numAttempts);
+            return this;
+        }
     }
 }

codegen/src/test/resources/software/amazon/awssdk/codegen/poet/model/baseserviceexception.java

@@ -40,6 +40,9 @@ public interface Builder extends AwsServiceException.Builder {
 
         @Override
         Builder writableStackTrace(Boolean writableStackTrace);
+
+        @Override
+        Builder numAttempts(Integer numAttempts);
     }
 
     protected static class BuilderImpl extends AwsServiceException.BuilderImpl implements Builder {
@@ -86,6 +89,12 @@ public BuilderImpl writableStackTrace(Boolean writableStackTrace) {
             return this;
         }
 
+        @Override
+        public BuilderImpl numAttempts(Integer numAttempts) {
+            this.numAttempts = numAttempts;
+            return this;
+        }
+
         @Override
         public JsonProtocolTestsException build() {
             return new JsonProtocolTestsException(this);

codegen/src/test/resources/software/amazon/awssdk/codegen/poet/model/emptymodeledexception.java

@@ -70,6 +70,9 @@ public interface Builder extends SdkPojo, CopyableBuilder<Builder, EmptyModeledE
 
         @Override
         Builder writableStackTrace(Boolean writableStackTrace);
+
+        @Override
+        Builder numAttempts(Integer numAttempts);
     }
 
     static final class BuilderImpl extends JsonProtocolTestsException.BuilderImpl implements Builder {
@@ -116,6 +119,12 @@ public BuilderImpl writableStackTrace(Boolean writableStackTrace) {
             return this;
         }
 
+        @Override
+        public BuilderImpl numAttempts(Integer numAttempts) {
+            this.numAttempts = numAttempts;
+            return this;
+        }
+
         @Override
         public EmptyModeledException build() {
             return new EmptyModeledException(this);

codegen/src/test/resources/software/amazon/awssdk/codegen/poet/model/exceptions/jsonserviceinternalservererrorexception.java

@@ -79,6 +79,9 @@ public interface Builder extends SdkPojo, CopyableBuilder<Builder, JsonServiceIn
 
         @Override
         Builder writableStackTrace(Boolean writableStackTrace);
+
+        @Override
+        Builder numAttempts(Integer numAttempts);
     }
 
     static final class BuilderImpl extends JsonException.BuilderImpl implements Builder {
@@ -125,6 +128,12 @@ public BuilderImpl writableStackTrace(Boolean writableStackTrace) {
             return this;
         }
 
+        @Override
+        public BuilderImpl numAttempts(Integer numAttempts) {
+            this.numAttempts = numAttempts;
+            return this;
+        }
+
         @Override
         public JsonServiceInternalServerErrorException build() {
             return new JsonServiceInternalServerErrorException(this);

codegen/src/test/resources/software/amazon/awssdk/codegen/poet/model/exceptions/jsonserviceinvalidinputexception.java

@@ -73,6 +73,9 @@ public interface Builder extends SdkPojo, CopyableBuilder<Builder, JsonServiceIn
 
         @Override
         Builder writableStackTrace(Boolean writableStackTrace);
+
+        @Override
+        Builder numAttempts(Integer numAttempts);
     }
 
     static final class BuilderImpl extends JsonException.BuilderImpl implements Builder {
@@ -119,6 +122,12 @@ public BuilderImpl writableStackTrace(Boolean writableStackTrace) {
             return this;
         }
 
+        @Override
+        public BuilderImpl numAttempts(Integer numAttempts) {
+            this.numAttempts = numAttempts;
+            return this;
+        }
+
         @Override
         public JsonServiceInvalidInputException build() {
             return new JsonServiceInvalidInputException(this);

codegen/src/test/resources/software/amazon/awssdk/codegen/poet/model/exceptions/jsonservicethrottlingexception.java

@@ -83,6 +83,9 @@ public interface Builder extends SdkPojo, CopyableBuilder<Builder, JsonServiceTh
 
         @Override
         Builder writableStackTrace(Boolean writableStackTrace);
+
+        @Override
+        Builder numAttempts(Integer numAttempts);
     }
 
     static final class BuilderImpl extends JsonException.BuilderImpl implements Builder {
@@ -129,6 +132,12 @@ public BuilderImpl writableStackTrace(Boolean writableStackTrace) {
             return this;
         }
 
+        @Override
+        public BuilderImpl numAttempts(Integer numAttempts) {
+            this.numAttempts = numAttempts;
+            return this;
+        }
+
         @Override
         public JsonServiceThrottlingException build() {
             return new JsonServiceThrottlingException(this);

core/aws-core/src/main/java/software/amazon/awssdk/awscore/exception/AwsServiceException.java

@@ -22,6 +22,7 @@
 import software.amazon.awssdk.annotations.SdkPublicApi;
 import software.amazon.awssdk.awscore.internal.AwsErrorCode;
 import software.amazon.awssdk.awscore.internal.AwsStatusCode;
+import software.amazon.awssdk.core.exception.SdkDiagnostics;
 import software.amazon.awssdk.core.exception.SdkServiceException;
 import software.amazon.awssdk.core.retry.ClockSkew;
 import software.amazon.awssdk.http.SdkHttpResponse;
@@ -60,25 +61,36 @@ public AwsErrorDetails awsErrorDetails() {
 
     @Override
     public String getMessage() {
+        StringJoiner joiner = new StringJoiner(" ");
+        String primaryMessage = rawMessage();
+        if (primaryMessage == null && awsErrorDetails != null) {
+            primaryMessage = awsErrorDetails.errorMessage();
+        }
+        if (primaryMessage != null) {
+            joiner.add(primaryMessage);
+        }
+
         if (awsErrorDetails != null) {
-            StringJoiner details = new StringJoiner(", ", "(", ")");
-            details.add("Service: " + awsErrorDetails().serviceName());
-            details.add("Status Code: " + statusCode());
-            details.add("Request ID: " + requestId());
-            if (extendedRequestId() != null) {
-                details.add("Extended Request ID: " + extendedRequestId());
-            }
-            String message = super.getMessage();
-            if (message == null) {
-                message = awsErrorDetails().errorMessage();
-            }
-            if (message == null) {
-                return details.toString();
-            }
-            return message + " " + details;
+            joiner.add(serviceDiagnostics());
         }
 
-        return super.getMessage();
+        if (numAttempts() != null) {
+            SdkDiagnostics diagnostics = SdkDiagnostics.builder().numAttempts(numAttempts()).build();
+            joiner.add(diagnostics.toString());
+        }
+
+        return joiner.toString();
+    }
+
+    private String serviceDiagnostics() {
+        StringJoiner details = new StringJoiner(", ", "(", ")");
+        details.add("Service: " + awsErrorDetails().serviceName());
+        details.add("Status Code: " + statusCode());
+        details.add("Request ID: " + requestId());
+        if (extendedRequestId() != null) {
+            details.add("Extended Request ID: " + extendedRequestId());
+        }
+        return details.toString();
     }
 
     @Override
@@ -116,9 +128,9 @@ public boolean isClockSkewException() {
     @Override
     public boolean isThrottlingException() {
         return super.isThrottlingException() ||
-                Optional.ofNullable(awsErrorDetails)
-                        .map(a -> AwsErrorCode.isThrottlingErrorCode(a.errorCode()))
-                        .orElse(false);
+               Optional.ofNullable(awsErrorDetails)
+                       .map(a -> AwsErrorCode.isThrottlingErrorCode(a.errorCode()))
+                       .orElse(false);
     }
 
     /**
@@ -173,6 +185,9 @@ public interface Builder extends SdkServiceException.Builder {
         @Override
         Builder message(String message);
 
+        @Override
+        Builder numAttempts(Integer numAttempts);
+
         @Override
         Builder cause(Throwable t);
 
@@ -238,6 +253,12 @@ public Builder message(String message) {
             return this;
         }
 
+        @Override
+        public Builder numAttempts(Integer numAttempts) {
+            this.numAttempts = numAttempts;
+            return this;
+        }
+
         @Override
         public Builder cause(Throwable cause) {
             this.cause = cause;
@@ -273,4 +294,4 @@ public AwsServiceException build() {
             return new AwsServiceException(this);
         }
     }
-}
+}

core/aws-core/src/test/java/software/amazon/awssdk/awscore/exception/AwsServiceExceptionSerializationTest.java

@@ -31,48 +31,32 @@
 public class AwsServiceExceptionSerializationTest {
 
     @Test
-    public void serializeServiceException() throws Exception {
+    public void serializeBasicServiceException() throws Exception {
         AwsServiceException expectedException = createException();
-
-        ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
-        ObjectOutputStream objectOutputStream = new ObjectOutputStream(outputStream);
-        objectOutputStream.writeObject(expectedException);
-        objectOutputStream.flush();
-        objectOutputStream.close();
-
-        ObjectInputStream ois = new ObjectInputStream(new ByteArrayInputStream(outputStream.toByteArray()));
-        AwsServiceException resultException = (AwsServiceException) ois.readObject();
-
+        AwsServiceException resultException = serializeServiceException(expectedException);
         assertSameValues(resultException, expectedException);
     }
 
-    private void assertSameValues(AwsServiceException resultException, AwsServiceException expectedException) {
-        assertThat(resultException.getMessage()).isEqualTo(expectedException.getMessage());
-        assertThat(resultException.requestId()).isEqualTo(expectedException.requestId());
-        assertThat(resultException.extendedRequestId()).isEqualTo(expectedException.extendedRequestId());
-        assertThat(resultException.toBuilder().clockSkew()).isEqualTo(expectedException.toBuilder().clockSkew());
-        assertThat(resultException.toBuilder().cause().getMessage()).isEqualTo(expectedException.toBuilder().cause().getMessage());
-        assertThat(resultException.awsErrorDetails()).isEqualTo(expectedException.awsErrorDetails());
+    @Test
+    public void serializeRetryableServiceException() throws Exception {
+        AwsServiceException expectedException = createRetryableServiceException();
+        AwsServiceException resultException = serializeServiceException(expectedException);
+        assertSameValues(resultException, expectedException);
     }
 
+    private void assertSameValues(AwsServiceException result, AwsServiceException expected) {
+        assertThat(result.getMessage()).isEqualTo(expected.getMessage());
+        assertThat(result.requestId()).isEqualTo(expected.requestId());
+        assertThat(result.extendedRequestId()).isEqualTo(expected.extendedRequestId());
+        assertThat(result.toBuilder().clockSkew()).isEqualTo(expected.toBuilder().clockSkew());
+        assertThat(result.toBuilder().cause().getMessage()).isEqualTo(expected.toBuilder().cause().getMessage());
+        assertThat(result.awsErrorDetails()).isEqualTo(expected.awsErrorDetails());
+        assertThat(result.numAttempts()).isEqualTo(expected.numAttempts());
+    }
 
     private AwsServiceException createException() {
-        AbortableInputStream contentStream = AbortableInputStream.create(new StringInputStream("some content"));
-        SdkHttpResponse httpResponse = SdkHttpFullResponse.builder()
-                                                          .statusCode(403)
-                                                          .statusText("SomeText")
-                                                          .content(contentStream)
-                                                          .build();
-
-        AwsErrorDetails errorDetails = AwsErrorDetails.builder()
-                                                      .errorCode("someCode")
-                                                      .errorMessage("message")
-                                                      .serviceName("someService")
-                                                      .sdkHttpResponse(httpResponse)
-                                                      .build();
-
         return AwsServiceException.builder()
-                                  .awsErrorDetails(errorDetails)
+                                  .awsErrorDetails(createErrorDetails(403, "SomeText"))
                                   .statusCode(403)
                                   .cause(new RuntimeException("someThrowable"))
                                   .clockSkew(Duration.ofSeconds(2))
@@ -81,4 +65,44 @@ private AwsServiceException createException() {
                                   .message("message")
                                   .build();
     }
+
+    private AwsServiceException createRetryableServiceException() {
+        return AwsServiceException.builder()
+                                  .awsErrorDetails(createErrorDetails(429, "Throttling"))
+                                  .statusCode(429)
+                                  .cause(new RuntimeException("someThrowable"))
+                                  .clockSkew(Duration.ofSeconds(2))
+                                  .requestId("requestId")
+                                  .extendedRequestId("extendedRequestId")
+                                  .message("message")
+                                  .numAttempts(3)
+                                  .build();
+    }
+
+    private AwsErrorDetails createErrorDetails(int statusCode, String statusText) {
+        AbortableInputStream contentStream = AbortableInputStream.create(new StringInputStream("some content"));
+        SdkHttpResponse httpResponse = SdkHttpFullResponse.builder()
+                                                          .statusCode(statusCode)
+                                                          .statusText(statusText)
+                                                          .content(contentStream)
+                                                          .build();
+
+        return AwsErrorDetails.builder()
+                              .errorCode("someCode")
+                              .errorMessage("message")
+                              .serviceName("someService")
+                              .sdkHttpResponse(httpResponse)
+                              .build();
+    }
+
+    private AwsServiceException serializeServiceException(AwsServiceException exception) throws Exception {
+        ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
+        ObjectOutputStream objectOutputStream = new ObjectOutputStream(outputStream);
+        objectOutputStream.writeObject(exception);
+        objectOutputStream.flush();
+        objectOutputStream.close();
+
+        ObjectInputStream ois = new ObjectInputStream(new ByteArrayInputStream(outputStream.toByteArray()));
+        return (AwsServiceException) ois.readObject();
+    }
 }