fix: Correct serde for errors in event streams (#585)

jbelkins · web-flow · commit d0269d26e308 · 2023-09-12T23:19:23.000-05:00
diff --git a/smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/integration/HttpBindingProtocolGenerator.kt b/smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/integration/HttpBindingProtocolGenerator.kt
@@ -22,6 +22,7 @@ import software.amazon.smithy.model.shapes.StructureShape
 import software.amazon.smithy.model.shapes.TimestampShape
 import software.amazon.smithy.model.shapes.UnionShape
 import software.amazon.smithy.model.traits.EnumTrait
+import software.amazon.smithy.model.traits.ErrorTrait
 import software.amazon.smithy.model.traits.HttpHeaderTrait
 import software.amazon.smithy.model.traits.HttpLabelTrait
 import software.amazon.smithy.model.traits.HttpPayloadTrait
@@ -172,7 +173,7 @@ abstract class HttpBindingProtocolGenerator : ProtocolGenerator {
                             generateCodingKeysForMembers(ctx, writer, httpBodyMembers)
                             writer.write("")
                         }
-                        renderStructEncode(ctx, shape, shapeMetadata, httpBodyMembers, writer, defaultTimestampFormat)
+                        renderStructEncode(ctx, shape, shapeMetadata, httpBodyMembers, writer, defaultTimestampFormat, "")
                     }
                 }
             }
@@ -232,9 +233,10 @@ abstract class HttpBindingProtocolGenerator : ProtocolGenerator {
                         val httpBodyMembers = members.filter { it.isInHttpBody() }
                         generateCodingKeysForMembers(ctx, writer, httpBodyMembers)
                         writer.write("")
-                        renderStructEncode(ctx, shape, mapOf(), httpBodyMembers, writer, defaultTimestampFormat)
+                        val path = "properties.".takeIf { shape.hasTrait<ErrorTrait>() } ?: ""
+                        renderStructEncode(ctx, shape, mapOf(), httpBodyMembers, writer, defaultTimestampFormat, path)
                         writer.write("")
-                        renderStructDecode(ctx, mapOf(), httpBodyMembers, writer, defaultTimestampFormat)
+                        renderStructDecode(ctx, mapOf(), httpBodyMembers, writer, defaultTimestampFormat, path)
                     }
                     is UnionShape -> {
                         // get all members of the union shape
@@ -275,7 +277,7 @@ abstract class HttpBindingProtocolGenerator : ProtocolGenerator {
                 writer.addImport(SwiftDependency.CLIENT_RUNTIME.target)
                 generateCodingKeysForMembers(ctx, writer, httpBodyMembers)
                 writer.write("")
-                renderStructDecode(ctx, metadata, httpBodyMembers, writer, defaultTimestampFormat)
+                renderStructDecode(ctx, metadata, httpBodyMembers, writer, defaultTimestampFormat, "")
             }
         }
     }
@@ -440,14 +442,16 @@ abstract class HttpBindingProtocolGenerator : ProtocolGenerator {
         shapeMetaData: Map<ShapeMetadata, Any>,
         members: List<MemberShape>,
         writer: SwiftWriter,
-        defaultTimestampFormat: TimestampFormatTrait.Format
+        defaultTimestampFormat: TimestampFormatTrait.Format,
+        path: String
     )
     protected abstract fun renderStructDecode(
         ctx: ProtocolGenerator.GenerationContext,
         shapeMetaData: Map<ShapeMetadata, Any>,
         members: List<MemberShape>,
         writer: SwiftWriter,
-        defaultTimestampFormat: TimestampFormatTrait.Format
+        defaultTimestampFormat: TimestampFormatTrait.Format,
+        path: String
     )
     protected abstract fun addProtocolSpecificMiddleware(ctx: ProtocolGenerator.GenerationContext, operation: OperationShape)
 
diff --git a/smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/integration/serde/json/MemberShapeDecodeGenerator.kt b/smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/integration/serde/json/MemberShapeDecodeGenerator.kt
@@ -34,7 +34,8 @@ Includes functions to help render conformance to Decodable protocol for shapes
 abstract class MemberShapeDecodeGenerator(
     private val ctx: ProtocolGenerator.GenerationContext,
     private val writer: SwiftWriter,
-    private val defaultTimestampFormat: TimestampFormatTrait.Format
+    private val defaultTimestampFormat: TimestampFormatTrait.Format,
+    private val path: String
 ) : MemberShapeDecodeGeneratable {
     fun renderDecodeForTimestamp(ctx: ProtocolGenerator.GenerationContext, target: Shape, member: MemberShape, containerName: String) {
         val memberName = ctx.symbolProvider.toMemberName(member)
@@ -154,7 +155,7 @@ abstract class MemberShapeDecodeGenerator(
      */
     open fun renderAssigningDecodedMember(topLevelMember: MemberShape, decodedMemberName: String) {
         val topLevelMemberName = ctx.symbolProvider.toMemberName(topLevelMember)
-        writer.write("\$L = \$L", topLevelMemberName, decodedMemberName)
+        writer.write("\$L\$L = \$L", path, topLevelMemberName, decodedMemberName)
     }
 
     private fun renderDecodeListTarget(shape: Shape, decodedMemberName: String, collectionName: String, insertMethod: String, topLevelMember: MemberShape, parentMember: Shape, level: Int = 0) {
diff --git a/smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/integration/serde/json/StructDecodeGenerator.kt b/smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/integration/serde/json/StructDecodeGenerator.kt
@@ -46,8 +46,9 @@ class StructDecodeGenerator(
     private val ctx: ProtocolGenerator.GenerationContext,
     private val members: List<MemberShape>,
     private val writer: SwiftWriter,
-    private val defaultTimestampFormat: TimestampFormatTrait.Format
-) : MemberShapeDecodeGenerator(ctx, writer, defaultTimestampFormat) {
+    private val defaultTimestampFormat: TimestampFormatTrait.Format,
+    private val path: String
+) : MemberShapeDecodeGenerator(ctx, writer, defaultTimestampFormat, path) {
     override fun render() {
         val containerName = "containerValues"
         writer.openBlock("public init(from decoder: \$N) throws {", "}", SwiftTypes.Decoder) {
diff --git a/smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/integration/serde/json/UnionDecodeGenerator.kt b/smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/integration/serde/json/UnionDecodeGenerator.kt
@@ -18,7 +18,7 @@ class UnionDecodeGenerator(
     private val members: List<MemberShape>,
     private val writer: SwiftWriter,
     private val defaultTimestampFormat: TimestampFormatTrait.Format
-) : MemberShapeDecodeGenerator(ctx, writer, defaultTimestampFormat) {
+) : MemberShapeDecodeGenerator(ctx, writer, defaultTimestampFormat, "") {
     override fun render() {
         val containerName = "values"
         writer.openBlock("public init(from decoder: \$N) throws {", "}", SwiftTypes.Decoder) {
diff --git a/smithy-swift-codegen/src/test/kotlin/mocks/MockHttpAWSJson11ProtocolGenerator.kt b/smithy-swift-codegen/src/test/kotlin/mocks/MockHttpAWSJson11ProtocolGenerator.kt
@@ -96,6 +96,7 @@ class MockHttpAWSJson11ProtocolGenerator : HttpBindingProtocolGenerator() {
         members: List<MemberShape>,
         writer: SwiftWriter,
         defaultTimestampFormat: TimestampFormatTrait.Format,
+        path: String
     ) {
         val encodeGenerator = StructEncodeGenerator(ctx, members, writer, defaultTimestampFormat)
         encodeGenerator.render()
@@ -106,8 +107,9 @@ class MockHttpAWSJson11ProtocolGenerator : HttpBindingProtocolGenerator() {
         members: List<MemberShape>,
         writer: SwiftWriter,
         defaultTimestampFormat: TimestampFormatTrait.Format,
+        path: String
     ) {
-        val decodeGenerator = StructDecodeGenerator(ctx, members, writer, defaultTimestampFormat)
+        val decodeGenerator = StructDecodeGenerator(ctx, members, writer, defaultTimestampFormat, path)
         decodeGenerator.render()
     }
 
diff --git a/smithy-swift-codegen/src/test/kotlin/mocks/MockHttpEC2QueryProtocolGenerator.kt b/smithy-swift-codegen/src/test/kotlin/mocks/MockHttpEC2QueryProtocolGenerator.kt
@@ -88,6 +88,7 @@ class MockHttpEC2QueryProtocolGenerator : HttpBindingProtocolGenerator() {
         members: List<MemberShape>,
         writer: SwiftWriter,
         defaultTimestampFormat: TimestampFormatTrait.Format,
+        path: String
     ) {
         val customizations = MockEc2QueryFormURLEncodeCustomizations()
         val encodeGenerator = StructEncodeFormURLGenerator(ctx, customizations, shapeContainingMembers, shapeMetadata, members, writer, defaultTimestampFormat)
@@ -99,6 +100,7 @@ class MockHttpEC2QueryProtocolGenerator : HttpBindingProtocolGenerator() {
         members: List<MemberShape>,
         writer: SwiftWriter,
         defaultTimestampFormat: TimestampFormatTrait.Format,
+        path: String
     ) {
         val decodeGenerator = StructDecodeXMLGenerator(ctx, members, mapOf(), writer, defaultTimestampFormat)
         decodeGenerator.render()
diff --git a/smithy-swift-codegen/src/test/kotlin/mocks/MockHttpRestJsonProtocolGenerator.kt b/smithy-swift-codegen/src/test/kotlin/mocks/MockHttpRestJsonProtocolGenerator.kt
@@ -77,6 +77,7 @@ class MockHttpRestJsonProtocolGenerator : HttpBindingProtocolGenerator() {
         members: List<MemberShape>,
         writer: SwiftWriter,
         defaultTimestampFormat: TimestampFormatTrait.Format,
+        path: String
     ) {
         val encodeGenerator = StructEncodeGenerator(ctx, members, writer, defaultTimestampFormat)
         encodeGenerator.render()
@@ -87,8 +88,9 @@ class MockHttpRestJsonProtocolGenerator : HttpBindingProtocolGenerator() {
         members: List<MemberShape>,
         writer: SwiftWriter,
         defaultTimestampFormat: TimestampFormatTrait.Format,
+        path: String
     ) {
-        val decodeGenerator = StructDecodeGenerator(ctx, members, writer, defaultTimestampFormat)
+        val decodeGenerator = StructDecodeGenerator(ctx, members, writer, defaultTimestampFormat, path)
         decodeGenerator.render()
     }
 
diff --git a/smithy-swift-codegen/src/test/kotlin/mocks/MockHttpRestXMLProtocolGenerator.kt b/smithy-swift-codegen/src/test/kotlin/mocks/MockHttpRestXMLProtocolGenerator.kt
@@ -54,6 +54,7 @@ class MockHttpRestXMLProtocolGenerator : HttpBindingProtocolGenerator() {
         members: List<MemberShape>,
         writer: SwiftWriter,
         defaultTimestampFormat: TimestampFormatTrait.Format,
+        path: String
     ) {
         val encoder = StructEncodeXMLGenerator(ctx, shapeContainingMembers, members, writer, defaultTimestampFormat)
         encoder.render()
@@ -66,6 +67,7 @@ class MockHttpRestXMLProtocolGenerator : HttpBindingProtocolGenerator() {
         members: List<MemberShape>,
         writer: SwiftWriter,
         defaultTimestampFormat: TimestampFormatTrait.Format,
+        path: String
     ) {
         val decodeGenerator = StructDecodeXMLGenerator(ctx, members, shapeMetadata, writer, defaultTimestampFormat)
         decodeGenerator.render()

Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,7 @@ import software.amazon.smithy.model.shapes.StructureShape`
`22`	`22`	`import software.amazon.smithy.model.shapes.TimestampShape`
`23`	`23`	`import software.amazon.smithy.model.shapes.UnionShape`
`24`	`24`	`import software.amazon.smithy.model.traits.EnumTrait`
	`25`	`+import software.amazon.smithy.model.traits.ErrorTrait`
`25`	`26`	`import software.amazon.smithy.model.traits.HttpHeaderTrait`
`26`	`27`	`import software.amazon.smithy.model.traits.HttpLabelTrait`
`27`	`28`	`import software.amazon.smithy.model.traits.HttpPayloadTrait`
`@@ -172,7 +173,7 @@ abstract class HttpBindingProtocolGenerator : ProtocolGenerator {`
`172`	`173`	`generateCodingKeysForMembers(ctx, writer, httpBodyMembers)`
`173`	`174`	`writer.write("")`
`174`	`175`	`}`
`175`		`- renderStructEncode(ctx, shape, shapeMetadata, httpBodyMembers, writer, defaultTimestampFormat)`
	`176`	`+ renderStructEncode(ctx, shape, shapeMetadata, httpBodyMembers, writer, defaultTimestampFormat, "")`
`176`	`177`	`}`
`177`	`178`	`}`
`178`	`179`	`}`
`@@ -232,9 +233,10 @@ abstract class HttpBindingProtocolGenerator : ProtocolGenerator {`
`232`	`233`	`val httpBodyMembers = members.filter { it.isInHttpBody() }`
`233`	`234`	`generateCodingKeysForMembers(ctx, writer, httpBodyMembers)`
`234`	`235`	`writer.write("")`
`235`		`- renderStructEncode(ctx, shape, mapOf(), httpBodyMembers, writer, defaultTimestampFormat)`
	`236`	`+ val path = "properties.".takeIf { shape.hasTrait<ErrorTrait>() } ?: ""`
	`237`	`+ renderStructEncode(ctx, shape, mapOf(), httpBodyMembers, writer, defaultTimestampFormat, path)`
`236`	`238`	`writer.write("")`
`237`		`- renderStructDecode(ctx, mapOf(), httpBodyMembers, writer, defaultTimestampFormat)`
	`239`	`+ renderStructDecode(ctx, mapOf(), httpBodyMembers, writer, defaultTimestampFormat, path)`
`238`	`240`	`}`
`239`	`241`	`is UnionShape -> {`
`240`	`242`	`// get all members of the union shape`
`@@ -275,7 +277,7 @@ abstract class HttpBindingProtocolGenerator : ProtocolGenerator {`
`275`	`277`	`writer.addImport(SwiftDependency.CLIENT_RUNTIME.target)`
`276`	`278`	`generateCodingKeysForMembers(ctx, writer, httpBodyMembers)`
`277`	`279`	`writer.write("")`
`278`		`- renderStructDecode(ctx, metadata, httpBodyMembers, writer, defaultTimestampFormat)`
	`280`	`+ renderStructDecode(ctx, metadata, httpBodyMembers, writer, defaultTimestampFormat, "")`
`279`	`281`	`}`
`280`	`282`	`}`
`281`	`283`	`}`
`@@ -440,14 +442,16 @@ abstract class HttpBindingProtocolGenerator : ProtocolGenerator {`
`440`	`442`	`shapeMetaData: Map<ShapeMetadata, Any>,`
`441`	`443`	`members: List<MemberShape>,`
`442`	`444`	`writer: SwiftWriter,`
`443`		`- defaultTimestampFormat: TimestampFormatTrait.Format`
	`445`	`+ defaultTimestampFormat: TimestampFormatTrait.Format,`
	`446`	`+ path: String`
`444`	`447`	`)`
`445`	`448`	`protected abstract fun renderStructDecode(`
`446`	`449`	`ctx: ProtocolGenerator.GenerationContext,`
`447`	`450`	`shapeMetaData: Map<ShapeMetadata, Any>,`
`448`	`451`	`members: List<MemberShape>,`
`449`	`452`	`writer: SwiftWriter,`
`450`		`- defaultTimestampFormat: TimestampFormatTrait.Format`
	`453`	`+ defaultTimestampFormat: TimestampFormatTrait.Format,`
	`454`	`+ path: String`
`451`	`455`	`)`
`452`	`456`	`protected abstract fun addProtocolSpecificMiddleware(ctx: ProtocolGenerator.GenerationContext, operation: OperationShape)`
`453`	`457`