fix: Correct serde for restJson1 event streams that contain errors (#596)

jbelkins · web-flow · commit a8aea3c6fe93 · 2023-10-02T15:12:02.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
@@ -173,7 +173,8 @@ abstract class HttpBindingProtocolGenerator : ProtocolGenerator {
                             generateCodingKeysForMembers(ctx, writer, httpBodyMembers)
                             writer.write("")
                         }
-                        renderStructEncode(ctx, shape, shapeMetadata, httpBodyMembers, writer, defaultTimestampFormat, "")
+                        val path = "properties.".takeIf { shape.hasTrait<ErrorTrait>() } ?: null
+                        renderStructEncode(ctx, shape, shapeMetadata, httpBodyMembers, writer, defaultTimestampFormat, path)
                     }
                 }
             }
@@ -462,7 +463,7 @@ abstract class HttpBindingProtocolGenerator : ProtocolGenerator {
         members: List<MemberShape>,
         writer: SwiftWriter,
         defaultTimestampFormat: TimestampFormatTrait.Format,
-        path: String
+        path: String? = null
     )
     protected abstract fun renderStructDecode(
         ctx: ProtocolGenerator.GenerationContext,
diff --git a/smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/integration/serde/json/MemberShapeEncodeGenerator.kt b/smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/integration/serde/json/MemberShapeEncodeGenerator.kt
@@ -107,7 +107,8 @@ abstract class MemberShapeEncodeGenerator(
         memberName: String,
         containerName: String,
         codingKey: String?,
-        isBoxed: Boolean
+        isBoxed: Boolean,
+        path: String? = null
     ) {
         val targetShape = when (memberShape) {
             is MemberShape -> ctx.model.expectShape(memberShape.target)
@@ -236,15 +237,16 @@ abstract class MemberShapeEncodeGenerator(
     fun renderSimpleEncodeMember(
         target: Shape,
         member: MemberShape,
-        containerName: String
+        containerName: String,
+        path: String? = null
     ) {
         val symbol = ctx.symbolProvider.toSymbol(member)
         val memberName = ctx.symbolProvider.toMemberName(member)
         val isBoxed = symbol.isBoxed()
         val memberWithExtension = getShapeExtension(member, memberName, isBoxed, true)
         if (isBoxed) {
-            writer.openBlock("if let $memberName = self.$memberName {", "}") {
-                renderSimpleShape(member, memberName, containerName, ".$memberName", isBoxed)
+            writer.openBlock("if let $memberName = self.${path ?: ""}$memberName {", "}") {
+                renderSimpleShape(member, memberName, containerName, ".$memberName", isBoxed, path)
             }
         } else {
             val primitiveSymbols: MutableSet<ShapeType> = hashSetOf(
@@ -254,10 +256,10 @@ abstract class MemberShapeEncodeGenerator(
             if (primitiveSymbols.contains(target.type)) {
                 val defaultValue = getDefaultValueOfShapeType(target.type)
                 writer.openBlock("if $memberName != $defaultValue {", "}") {
-                    renderSimpleShape(member, memberName, containerName, ".$memberName", isBoxed)
+                    renderSimpleShape(member, memberName, containerName, ".$memberName", isBoxed, path)
                 }
             } else
-                renderSimpleShape(member, memberName, containerName, ".$memberName", isBoxed)
+                renderSimpleShape(member, memberName, containerName, ".$memberName", isBoxed, path)
         }
     }
 
diff --git a/smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/integration/serde/json/StructEncodeGenerator.kt b/smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/integration/serde/json/StructEncodeGenerator.kt
@@ -45,7 +45,8 @@ class StructEncodeGenerator(
     private val ctx: ProtocolGenerator.GenerationContext,
     private val members: List<MemberShape>,
     private val writer: SwiftWriter,
-    private val defaultTimestampFormat: TimestampFormatTrait.Format
+    private val defaultTimestampFormat: TimestampFormatTrait.Format,
+    private val path: String? = null
 ) : MemberShapeEncodeGenerator(ctx, writer, defaultTimestampFormat) {
     override fun render() {
         val containerName = "encodeContainer"
@@ -58,18 +59,18 @@ class StructEncodeGenerator(
                     val memberName = ctx.symbolProvider.toMemberName(member)
                     when (target) {
                         is CollectionShape -> {
-                            writer.openBlock("if let $memberName = $memberName {", "}") {
+                            writer.openBlock("if let $memberName = ${path ?: ""}$memberName {", "}") {
                                 renderEncodeListMember(target, memberName, containerName)
                             }
                         }
                         is MapShape -> {
-                            writer.openBlock("if let $memberName = $memberName {", "}") {
+                            writer.openBlock("if let $memberName = ${path ?: ""}$memberName {", "}") {
                                 renderEncodeMapMember(target, memberName, containerName)
                             }
                         }
                         else -> {
                             renderSimpleEncodeMember(
-                                target, member, containerName
+                                target, member, containerName, path
                             )
                         }
                     }
diff --git a/smithy-swift-codegen/src/test/kotlin/mocks/MockHttpAWSJson11ProtocolGenerator.kt b/smithy-swift-codegen/src/test/kotlin/mocks/MockHttpAWSJson11ProtocolGenerator.kt
@@ -96,9 +96,9 @@ class MockHttpAWSJson11ProtocolGenerator : HttpBindingProtocolGenerator() {
         members: List<MemberShape>,
         writer: SwiftWriter,
         defaultTimestampFormat: TimestampFormatTrait.Format,
-        path: String
+        path: String?
     ) {
-        val encodeGenerator = StructEncodeGenerator(ctx, members, writer, defaultTimestampFormat)
+        val encodeGenerator = StructEncodeGenerator(ctx, members, writer, defaultTimestampFormat, path)
         encodeGenerator.render()
     }
     override fun renderStructDecode(
diff --git a/smithy-swift-codegen/src/test/kotlin/mocks/MockHttpEC2QueryProtocolGenerator.kt b/smithy-swift-codegen/src/test/kotlin/mocks/MockHttpEC2QueryProtocolGenerator.kt
@@ -88,7 +88,7 @@ class MockHttpEC2QueryProtocolGenerator : HttpBindingProtocolGenerator() {
         members: List<MemberShape>,
         writer: SwiftWriter,
         defaultTimestampFormat: TimestampFormatTrait.Format,
-        path: String
+        path: String?
     ) {
         val customizations = MockEc2QueryFormURLEncodeCustomizations()
         val encodeGenerator = StructEncodeFormURLGenerator(ctx, customizations, shapeContainingMembers, shapeMetadata, members, writer, defaultTimestampFormat)
diff --git a/smithy-swift-codegen/src/test/kotlin/mocks/MockHttpRestJsonProtocolGenerator.kt b/smithy-swift-codegen/src/test/kotlin/mocks/MockHttpRestJsonProtocolGenerator.kt
@@ -77,9 +77,9 @@ class MockHttpRestJsonProtocolGenerator : HttpBindingProtocolGenerator() {
         members: List<MemberShape>,
         writer: SwiftWriter,
         defaultTimestampFormat: TimestampFormatTrait.Format,
-        path: String
+        path: String?
     ) {
-        val encodeGenerator = StructEncodeGenerator(ctx, members, writer, defaultTimestampFormat)
+        val encodeGenerator = StructEncodeGenerator(ctx, members, writer, defaultTimestampFormat, path)
         encodeGenerator.render()
     }
     override fun renderStructDecode(
diff --git a/smithy-swift-codegen/src/test/kotlin/mocks/MockHttpRestXMLProtocolGenerator.kt b/smithy-swift-codegen/src/test/kotlin/mocks/MockHttpRestXMLProtocolGenerator.kt
@@ -54,7 +54,7 @@ class MockHttpRestXMLProtocolGenerator : HttpBindingProtocolGenerator() {
         members: List<MemberShape>,
         writer: SwiftWriter,
         defaultTimestampFormat: TimestampFormatTrait.Format,
-        path: String
+        path: String?
     ) {
         val encoder = StructEncodeXMLGenerator(ctx, shapeContainingMembers, members, writer, defaultTimestampFormat)
         encoder.render()

Original file line number	Diff line number	Diff line change
`@@ -173,7 +173,8 @@ abstract class HttpBindingProtocolGenerator : ProtocolGenerator {`
`173`	`173`	`generateCodingKeysForMembers(ctx, writer, httpBodyMembers)`
`174`	`174`	`writer.write("")`
`175`	`175`	`}`
`176`		`- renderStructEncode(ctx, shape, shapeMetadata, httpBodyMembers, writer, defaultTimestampFormat, "")`
	`176`	`+ val path = "properties.".takeIf { shape.hasTrait<ErrorTrait>() } ?: null`
	`177`	`+ renderStructEncode(ctx, shape, shapeMetadata, httpBodyMembers, writer, defaultTimestampFormat, path)`
`177`	`178`	`}`
`178`	`179`	`}`
`179`	`180`	`}`
`@@ -462,7 +463,7 @@ abstract class HttpBindingProtocolGenerator : ProtocolGenerator {`
`462`	`463`	`members: List<MemberShape>,`
`463`	`464`	`writer: SwiftWriter,`
`464`	`465`	`defaultTimestampFormat: TimestampFormatTrait.Format,`
`465`		`- path: String`
	`466`	`+ path: String? = null`
`466`	`467`	`)`
`467`	`468`	`protected abstract fun renderStructDecode(`
`468`	`469`	`ctx: ProtocolGenerator.GenerationContext,`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,8 @@ class StructEncodeGenerator(`
`45`	`45`	`private val ctx: ProtocolGenerator.GenerationContext,`
`46`	`46`	`private val members: List<MemberShape>,`
`47`	`47`	`private val writer: SwiftWriter,`
`48`		`- private val defaultTimestampFormat: TimestampFormatTrait.Format`
	`48`	`+ private val defaultTimestampFormat: TimestampFormatTrait.Format,`
	`49`	`+ private val path: String? = null`
`49`	`50`	`) : MemberShapeEncodeGenerator(ctx, writer, defaultTimestampFormat) {`
`50`	`51`	`override fun render() {`
`51`	`52`	`val containerName = "encodeContainer"`
`@@ -58,18 +59,18 @@ class StructEncodeGenerator(`
`58`	`59`	`val memberName = ctx.symbolProvider.toMemberName(member)`
`59`	`60`	`when (target) {`
`60`	`61`	`is CollectionShape -> {`
`61`		`- writer.openBlock("if let $memberName = $memberName {", "}") {`
	`62`	`+ writer.openBlock("if let $memberName = ${path ?: ""}$memberName {", "}") {`
`62`	`63`	`renderEncodeListMember(target, memberName, containerName)`
`63`	`64`	`}`
`64`	`65`	`}`
`65`	`66`	`is MapShape -> {`
`66`		`- writer.openBlock("if let $memberName = $memberName {", "}") {`
	`67`	`+ writer.openBlock("if let $memberName = ${path ?: ""}$memberName {", "}") {`
`67`	`68`	`renderEncodeMapMember(target, memberName, containerName)`
`68`	`69`	`}`
`69`	`70`	`}`
`70`	`71`	`else -> {`
`71`	`72`	`renderSimpleEncodeMember(`
`72`		`- target, member, containerName`
	`73`	`+ target, member, containerName, path`
`73`	`74`	`)`
`74`	`75`	`}`
`75`	`76`	`}`