fix: error type of modeled service errors (#331)

wooj2 · web-flow · commit 62f20cc852ec · 2021-08-19T21:56:09.000-07:00
diff --git a/codegen/smithy-aws-swift-codegen/src/main/kotlin/software/amazon/smithy/aws/swift/codegen/AWSClientRuntimeTypes.kt b/codegen/smithy-aws-swift-codegen/src/main/kotlin/software/amazon/smithy/aws/swift/codegen/AWSClientRuntimeTypes.kt
@@ -21,6 +21,7 @@ object AWSClientRuntimeTypes {
 
     object RestXML {
         val RestXMLError = runtimeSymbol("RestXMLError")
+        val ErrorResponseContainer = runtimeSymbol("ErrorResponseContainer")
     }
 
     object Signing {
diff --git a/codegen/smithy-aws-swift-codegen/src/main/kotlin/software/amazon/smithy/aws/swift/codegen/ec2query/httpResponse/AWSEc2QueryHttpResponseBindingErrorInitGeneratorFactory.kt b/codegen/smithy-aws-swift-codegen/src/main/kotlin/software/amazon/smithy/aws/swift/codegen/ec2query/httpResponse/AWSEc2QueryHttpResponseBindingErrorInitGeneratorFactory.kt
@@ -5,7 +5,6 @@
 
 package software.amazon.smithy.aws.swift.codegen.ec2query.httpResponse
 
-import software.amazon.smithy.codegen.core.Symbol
 import software.amazon.smithy.model.shapes.StructureShape
 import software.amazon.smithy.model.traits.TimestampFormatTrait
 import software.amazon.smithy.swift.codegen.SwiftWriter
@@ -24,14 +23,12 @@ class AWSEc2QueryHttpResponseBindingErrorInitGeneratorFactory : HttpResponseBind
         ctx: ProtocolGenerator.GenerationContext,
         structureShape: StructureShape,
         httpBindingResolver: HttpBindingResolver,
-        serviceErrorProtocolSymbol: Symbol,
         defaultTimestampFormat: TimestampFormatTrait.Format,
     ): HttpResponseBindingRenderable {
         return HttpResponseBindingErrorInitGenerator(
             ctx,
             structureShape,
             httpBindingResolver,
-            serviceErrorProtocolSymbol,
             defaultTimestampFormat,
             AWSEc2QueryHttpResponseTraitPayloadFactory()
         )
diff --git a/codegen/smithy-aws-swift-codegen/src/main/kotlin/software/amazon/smithy/aws/swift/codegen/restxml/httpResponse/AWSXMLHttpResponseBindingErrorInitGeneratorFactory.kt b/codegen/smithy-aws-swift-codegen/src/main/kotlin/software/amazon/smithy/aws/swift/codegen/restxml/httpResponse/AWSXMLHttpResponseBindingErrorInitGeneratorFactory.kt
@@ -6,7 +6,6 @@
 package software.amazon.smithy.aws.swift.codegen.restxml
 
 import software.amazon.smithy.aws.swift.codegen.restxml.httpResponse.AWSXMLHttpResponseTraitWithoutPayload
-import software.amazon.smithy.codegen.core.Symbol
 import software.amazon.smithy.model.shapes.StructureShape
 import software.amazon.smithy.model.traits.TimestampFormatTrait
 import software.amazon.smithy.swift.codegen.SwiftWriter
@@ -25,14 +24,12 @@ class AWSXMLHttpResponseBindingErrorInitGeneratorFactory : HttpResponseBindingEr
         ctx: ProtocolGenerator.GenerationContext,
         structureShape: StructureShape,
         httpBindingResolver: HttpBindingResolver,
-        serviceErrorProtocolSymbol: Symbol,
         defaultTimestampFormat: TimestampFormatTrait.Format,
     ): HttpResponseBindingRenderable {
         return HttpResponseBindingErrorInitGenerator(
             ctx,
             structureShape,
             httpBindingResolver,
-            serviceErrorProtocolSymbol,
             defaultTimestampFormat,
             AWSXMLHttpResponseTraitPayloadFactory()
         )
diff --git a/codegen/smithy-aws-swift-codegen/src/main/kotlin/software/amazon/smithy/aws/swift/codegen/restxml/httpResponse/AWSXMLHttpResponseTraitWithoutPayload.kt b/codegen/smithy-aws-swift-codegen/src/main/kotlin/software/amazon/smithy/aws/swift/codegen/restxml/httpResponse/AWSXMLHttpResponseTraitWithoutPayload.kt
@@ -5,6 +5,7 @@
 
 package software.amazon.smithy.aws.swift.codegen.restxml.httpResponse
 
+import software.amazon.smithy.aws.swift.codegen.AWSClientRuntimeTypes.RestXML.ErrorResponseContainer
 import software.amazon.smithy.aws.traits.protocols.RestXmlTrait
 import software.amazon.smithy.model.knowledge.HttpBinding
 import software.amazon.smithy.model.shapes.BooleanShape
@@ -82,7 +83,8 @@ class AWSXMLHttpResponseTraitWithoutPayload(
     }
 
     fun renderWithErrorResponseContainer(outputShapeName: String, bodyMembersWithoutQueryTrait: Set<String>) {
-        writer.write("let output: ErrorResponseContainer<${outputShapeName}Body> = try responseDecoder.decode(responseBody: data)")
+        writer.addImport(ErrorResponseContainer)
+        writer.write("let output: \$N<${outputShapeName}Body> = try responseDecoder.decode(responseBody: data)", ErrorResponseContainer)
         bodyMembersWithoutQueryTrait.sorted().forEach {
             writer.write("self.$it = output.error.$it")
         }
diff --git a/codegen/smithy-aws-swift-codegen/src/test/kotlin/software/amazon/smithy/aws/swift/codegen/ec2query/Ec2QueryHttpResponseBindingErrorGeneratorTests.kt b/codegen/smithy-aws-swift-codegen/src/test/kotlin/software/amazon/smithy/aws/swift/codegen/ec2query/Ec2QueryHttpResponseBindingErrorGeneratorTests.kt
@@ -64,7 +64,7 @@ class Ec2QueryHttpResponseBindingErrorGeneratorTests {
         contents.shouldSyntacticSanityCheck()
         val expectedContents =
             """
-            extension ComplexError: AWSClientRuntime.AWSHttpServiceError {
+            extension ComplexError {
                 public init (httpResponse: ClientRuntime.HttpResponse, decoder: ClientRuntime.ResponseDecoder? = nil, message: Swift.String? = nil, requestID: Swift.String? = nil) throws {
                     if case .stream(let reader) = httpResponse.body,
                         let responseDecoder = decoder {
@@ -86,6 +86,36 @@ class Ec2QueryHttpResponseBindingErrorGeneratorTests {
         contents.shouldContainOnlyOnce(expectedContents)
     }
 
+    @Test
+    fun `004 ComplexError constructor conforms to AWSHttpServiceError`() {
+        val context = setupTests("ec2query/query-error.smithy", "aws.protocoltests.ec2#AwsEc2")
+        val contents = TestContextGenerator.getFileContents(context.manifest, "/Example/models/ComplexError.swift")
+        contents.shouldSyntacticSanityCheck()
+        val expectedContents =
+            """
+            public struct ComplexError: AWSClientRuntime.AWSHttpServiceError, Swift.Equatable {
+                public var _headers: ClientRuntime.Headers?
+                public var _statusCode: ClientRuntime.HttpStatusCode?
+                public var _message: Swift.String?
+                public var _requestID: Swift.String?
+                public var _retryable: Swift.Bool = false
+                public var _isThrottling: Swift.Bool = false
+                public var _type: ClientRuntime.ErrorType = .client
+                public var nested: AwsEc2ClientTypes.ComplexNestedErrorData?
+                public var topLevel: Swift.String?
+            
+                public init (
+                    nested: AwsEc2ClientTypes.ComplexNestedErrorData? = nil,
+                    topLevel: Swift.String? = nil
+                )
+                {
+                    self.nested = nested
+                    self.topLevel = topLevel
+                }
+            }
+            """.trimIndent()
+        contents.shouldContainOnlyOnce(expectedContents)
+    }
     private fun setupTests(smithyFile: String, serviceShapeId: String): TestContext {
         val context =
             TestContextGenerator.initContextFrom(smithyFile, serviceShapeId, Ec2QueryTrait.ID, "ec2query", "ec2query")
diff --git a/codegen/smithy-aws-swift-codegen/src/test/kotlin/software/amazon/smithy/aws/swift/codegen/restxml/AWSRestXMLHttpResponseBindingErrorGeneratorTests.kt b/codegen/smithy-aws-swift-codegen/src/test/kotlin/software/amazon/smithy/aws/swift/codegen/restxml/AWSRestXMLHttpResponseBindingErrorGeneratorTests.kt
@@ -64,7 +64,7 @@ class AWSRestXMLHttpResponseBindingErrorGeneratorTests {
         contents.shouldSyntacticSanityCheck()
         val expectedContents =
             """            
-            extension ComplexXMLError: AWSClientRuntime.AWSHttpServiceError {
+            extension ComplexXMLError {
                 public init (httpResponse: ClientRuntime.HttpResponse, decoder: ClientRuntime.ResponseDecoder? = nil, message: Swift.String? = nil, requestID: Swift.String? = nil) throws {
                     if let headerHeaderValue = httpResponse.headers.value(for: "X-Header") {
                         self.header = headerHeaderValue
@@ -74,7 +74,7 @@ class AWSRestXMLHttpResponseBindingErrorGeneratorTests {
                     if case .stream(let reader) = httpResponse.body,
                         let responseDecoder = decoder {
                         let data = reader.toBytes().toData()
-                        let output: ErrorResponseContainer<ComplexXMLErrorBody> = try responseDecoder.decode(responseBody: data)
+                        let output: AWSClientRuntime.ErrorResponseContainer<ComplexXMLErrorBody> = try responseDecoder.decode(responseBody: data)
                         self.nested = output.error.nested
                         self.topLevel = output.error.topLevel
                     } else {
@@ -90,15 +90,47 @@ class AWSRestXMLHttpResponseBindingErrorGeneratorTests {
             """.trimIndent()
         contents.shouldContainOnlyOnce(expectedContents)
     }
-
     @Test
-    fun `004 ComplexXMLErrorNoErrorWrapping Init renders without container`() {
+    fun `004 ComplexXMLError extends from AWSHttpServiceError`() {
+        val context = setupTests("restxml/xml-errors.smithy", "aws.protocoltests.restxml#RestXml")
+        val contents = getFileContents(context.manifest, "/Example/models/ComplexXMLError.swift")
+        contents.shouldSyntacticSanityCheck()
+        val expectedContents =
+            """            
+            public struct ComplexXMLError: AWSClientRuntime.AWSHttpServiceError, Swift.Equatable {
+                public var _headers: ClientRuntime.Headers?
+                public var _statusCode: ClientRuntime.HttpStatusCode?
+                public var _message: Swift.String?
+                public var _requestID: Swift.String?
+                public var _retryable: Swift.Bool = false
+                public var _isThrottling: Swift.Bool = false
+                public var _type: ClientRuntime.ErrorType = .client
+                public var header: Swift.String?
+                public var nested: RestXmlClientTypes.ComplexXMLNestedErrorData?
+                public var topLevel: Swift.String?
+            
+                public init (
+                    header: Swift.String? = nil,
+                    nested: RestXmlClientTypes.ComplexXMLNestedErrorData? = nil,
+                    topLevel: Swift.String? = nil
+                )
+                {
+                    self.header = header
+                    self.nested = nested
+                    self.topLevel = topLevel
+                }
+            }
+            """.trimIndent()
+        contents.shouldContainOnlyOnce(expectedContents)
+    }
+    @Test
+    fun `005 ComplexXMLErrorNoErrorWrapping Init renders without container`() {
         val context = setupTests("restxml/xml-errors-noerrorwrapping.smithy", "aws.protocoltests.restxml#RestXml")
         val contents = getFileContents(context.manifest, "/Example/models/ComplexXMLErrorNoErrorWrapping+Init.swift")
         contents.shouldSyntacticSanityCheck()
         val expectedContents =
             """
-            extension ComplexXMLErrorNoErrorWrapping: AWSClientRuntime.AWSHttpServiceError {
+            extension ComplexXMLErrorNoErrorWrapping {
                 public init (httpResponse: ClientRuntime.HttpResponse, decoder: ClientRuntime.ResponseDecoder? = nil, message: Swift.String? = nil, requestID: Swift.String? = nil) throws {
                     if let headerHeaderValue = httpResponse.headers.value(for: "X-Header") {
                         self.header = headerHeaderValue

Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,7 @@ object AWSClientRuntimeTypes {`
`21`	`21`
`22`	`22`	`object RestXML {`
`23`	`23`	`val RestXMLError = runtimeSymbol("RestXMLError")`
	`24`	`+ val ErrorResponseContainer = runtimeSymbol("ErrorResponseContainer")`
`24`	`25`	`}`
`25`	`26`
`26`	`27`	`object Signing {`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@`
`5`	`5`
`6`	`6`	`package software.amazon.smithy.aws.swift.codegen.restxml.httpResponse`
`7`	`7`
	`8`	`+import software.amazon.smithy.aws.swift.codegen.AWSClientRuntimeTypes.RestXML.ErrorResponseContainer`
`8`	`9`	`import software.amazon.smithy.aws.traits.protocols.RestXmlTrait`
`9`	`10`	`import software.amazon.smithy.model.knowledge.HttpBinding`
`10`	`11`	`import software.amazon.smithy.model.shapes.BooleanShape`
`@@ -82,7 +83,8 @@ class AWSXMLHttpResponseTraitWithoutPayload(`
`82`	`83`	`}`
`83`	`84`
`84`	`85`	`fun renderWithErrorResponseContainer(outputShapeName: String, bodyMembersWithoutQueryTrait: Set<String>) {`
`85`		`- writer.write("let output: ErrorResponseContainer<${outputShapeName}Body> = try responseDecoder.decode(responseBody: data)")`
	`86`	`+ writer.addImport(ErrorResponseContainer)`
	`87`	`+ writer.write("let output: \$N<${outputShapeName}Body> = try responseDecoder.decode(responseBody: data)", ErrorResponseContainer)`
`86`	`88`	`bodyMembersWithoutQueryTrait.sorted().forEach {`
`87`	`89`	`writer.write("self.$it = output.error.$it")`
`88`	`90`	`}`