feat: enhance exception messages with request IDs and metadata (#1248)

Author: ianbotsf

.changes/8571dd20-b6a8-4cab-9e2a-567e273a016f.json

@@ -0,0 +1,8 @@
+{
+    "id": "8571dd20-b6a8-4cab-9e2a-567e273a016f",
+    "type": "feature",
+    "description": "Add request IDs to exception messages where available",
+    "issues": [
+        "awslabs/aws-sdk-kotlin#1212"
+    ]
+}

.changes/de403702-531d-4f43-bc33-aa5bc2fc000f.json

@@ -0,0 +1,8 @@
+{
+    "id": "de403702-531d-4f43-bc33-aa5bc2fc000f",
+    "type": "feature",
+    "description": "Add error metadata to ServiceException messages when a service-provided message isn't available",
+    "issues": [
+        "awslabs/aws-sdk-kotlin#1212"
+    ]
+}

codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/customization/s3/S3ErrorMetadataIntegration.kt

@@ -48,8 +48,16 @@ class S3ErrorMetadataIntegration : KotlinIntegration {
         }
     }
 
-    // SectionWriter to override the default sdkErrorMetadata for S3's version
+    // SectionWriter to override the default sdkErrorMetadata and displayMetadata for S3's version
     private val addSdkErrorMetadataWriter = AppendingSectionWriter { writer ->
-        writer.write("override val sdkErrorMetadata: S3ErrorMetadata = S3ErrorMetadata()")
+        writer
+            .write("override val sdkErrorMetadata: S3ErrorMetadata = S3ErrorMetadata()")
+            .write("")
+            .withBlock("override val displayMetadata: List<String>", "") {
+                withBlock("get() =", "") {
+                    write("super.displayMetadata + ")
+                    write("""listOfNotNull(sdkErrorMetadata.requestId2?.let { "Extended request ID: ${'$'}it" })""")
+                }
+            }
     }
 }

gradle/libs.versions.toml

@@ -9,8 +9,8 @@ coroutines-version = "1.7.3"
 atomicfu-version = "0.23.1"
 
 # smithy-kotlin codegen and runtime are versioned separately
-smithy-kotlin-runtime-version = "1.0.16"
-smithy-kotlin-codegen-version = "0.30.17"
+smithy-kotlin-runtime-version = "1.0.17"
+smithy-kotlin-codegen-version = "0.30.18"
 
 # codegen
 smithy-version = "1.42.0"

services/s3/common/test/aws/sdk/kotlin/services/s3/internal/GetBucketLocationOperationDeserializerTest.kt

@@ -67,6 +67,6 @@ class GetBucketLocationOperationDeserializerTest {
             }
         }
 
-        assertEquals("Some message", exception.message)
+        assertEquals("Some message, Request ID: Some request ID", exception.message)
     }
 }

services/s3/common/test/aws/sdk/kotlin/services/s3/internal/Handle200ErrorsInterceptorTest.kt

@@ -20,6 +20,9 @@ import kotlin.test.Test
 import kotlin.test.assertEquals
 import kotlin.test.assertFailsWith
 
+private const val REQUEST_ID = "K2H6N7ZGQT6WHCEG"
+private const val EXT_REQUEST_ID = "WWoZlnK4pTjKCYn6eNV7GgOurabfqLkjbSyqTvDMGBaI9uwzyNhSaDhOCPs8paFGye7S6b/AB3A="
+
 class Handle200ErrorsInterceptorTest {
 
     object TestCredentialsProvider : CredentialsProvider {
@@ -29,8 +32,8 @@ class Handle200ErrorsInterceptorTest {
             <Error>
                 <Code>SlowDown</Code>
                 <Message>Please reduce your request rate.</Message>
-                <RequestId>K2H6N7ZGQT6WHCEG</RequestId>
-                <HostId>WWoZlnK4pTjKCYn6eNV7GgOurabfqLkjbSyqTvDMGBaI9uwzyNhSaDhOCPs8paFGye7S6b/AB3A=</HostId>
+                <RequestId>$REQUEST_ID</RequestId>
+                <HostId>$EXT_REQUEST_ID</HostId>
             </Error>
     """.trimIndent().encodeToByteArray()
 
@@ -53,9 +56,9 @@ class Handle200ErrorsInterceptorTest {
         val expectedMessage = "Please reduce your request rate."
         assertEquals("SlowDown", ex.sdkErrorMetadata.errorCode)
         assertEquals(expectedMessage, ex.sdkErrorMetadata.errorMessage)
-        assertEquals(expectedMessage, ex.message)
-        assertEquals("K2H6N7ZGQT6WHCEG", ex.sdkErrorMetadata.requestId)
-        assertEquals("WWoZlnK4pTjKCYn6eNV7GgOurabfqLkjbSyqTvDMGBaI9uwzyNhSaDhOCPs8paFGye7S6b/AB3A=", ex.sdkErrorMetadata.requestId2)
+        assertEquals("$expectedMessage, Request ID: $REQUEST_ID, Extended request ID: $EXT_REQUEST_ID", ex.message)
+        assertEquals(REQUEST_ID, ex.sdkErrorMetadata.requestId)
+        assertEquals(EXT_REQUEST_ID, ex.sdkErrorMetadata.requestId2)
     }
 
     @Test
@@ -107,7 +110,7 @@ class Handle200ErrorsInterceptorTest {
             s3.deleteObjects { bucket = "test" }
         }
         val expectedMessage = "Please use less foos."
-        assertEquals(expectedMessage, ex.message)
+        assertEquals("$expectedMessage, Request ID: rid, Extended request ID: rid2", ex.message)
         assertEquals(expectedMessage, ex.sdkErrorMetadata.errorMessage)
         assertEquals("FooError", ex.sdkErrorMetadata.errorCode)
         assertEquals("rid", ex.sdkErrorMetadata.requestId)