fix: RPCv2CBOR query compatible support (#927)

Author: jbelkins

Sources/ClientRuntime/protocols/rpcv2cbor/RpcV2CborError.swift

@@ -19,12 +19,13 @@ public struct RpcV2CborError: BaseError {
 
     @_spi(SmithyReadWrite)
     public init(httpResponse: HTTPResponse, responseReader: Reader, noErrorWrapping: Bool, code: String? = nil) throws {
+        let sanitizedCode = code.map { sanitizeErrorType($0) }
         switch responseReader.cborValue {
         case .map(let errorDetails):
             if case let .text(errorCode) = errorDetails["__type"] {
-                self.code = sanitizeErrorType(errorCode)
+                self.code = sanitizedCode ?? sanitizeErrorType(errorCode)
             } else {
-                self.code = "UnknownError"
+                self.code = sanitizedCode ?? "UnknownError"
             }
 
             if case let .text(errorMessage) = errorDetails["Message"] {
@@ -33,7 +34,7 @@ public struct RpcV2CborError: BaseError {
                 self.message = nil
             }
         default:
-            self.code = "UnknownError"
+            self.code = sanitizedCode ?? "UnknownError"
             self.message = nil
         }
 

Sources/ClientRuntime/protocols/rpcv2cbor/RpcV2CborQueryCompatible.swift

@@ -0,0 +1,31 @@
+//
+// Copyright Amazon.com Inc. or its affiliates.
+// All Rights Reserved.
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+
+@_spi(SmithyReadWrite) import class SmithyCBOR.Reader
+import class SmithyHTTPAPI.HTTPResponse
+
+@_spi(SmithyReadWrite)
+public enum RpcV2CborQueryCompatibleUtils {
+
+    // This function returns a standard RpcV2Cbor base error
+    // without the passed error details.
+    //
+    // QueryCompatibleUtils with error parsing are implemented
+    // in AWS SDK for Swift.
+    public static func makeQueryCompatibleError(
+        httpResponse: HTTPResponse,
+        responseReader: SmithyCBOR.Reader,
+        noErrorWrapping: Bool,
+        errorDetails: String?
+    ) throws -> RpcV2CborError {
+        return try RpcV2CborError(
+            httpResponse: httpResponse,
+            responseReader: responseReader,
+            noErrorWrapping: noErrorWrapping
+        )
+    }
+}

Tests/ClientRuntimeTests/RpcV2CborErrorTests/RpcV2CborErrorTests.swift

@@ -0,0 +1,45 @@
+//
+// Copyright Amazon.com Inc. or its affiliates.
+// All Rights Reserved.
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+
+import XCTest
+@_spi(SmithyReadWrite) import struct ClientRuntime.RpcV2CborError
+import class SmithyHTTPAPI.HTTPResponse
+@_spi(SmithyReadWrite) import class SmithyCBOR.Reader
+
+final class RpcV2CborErrorTests: XCTestCase {
+    let cborCode = "abc-def"
+    let passedCode = "ghi-jkl"
+
+    func test_init_usesCodeInCborMap() throws {
+        let reader = Reader(nodeInfo: "", cborValue: .map(["__type": .text(cborCode)]))
+        let httpResponse = HTTPResponse(body: .data(Data()), statusCode: .ok)
+        let subject = try RpcV2CborError(httpResponse: httpResponse, responseReader: reader, noErrorWrapping: false)
+        XCTAssertEqual(subject.code, cborCode)
+    }
+
+    func test_init_usesUnknownErrorCodeWhenCborMapIsEmpty() throws {
+        let reader = Reader(nodeInfo: "", cborValue: .map([:]))
+        let httpResponse = HTTPResponse(body: .data(Data()), statusCode: .ok)
+        let subject = try RpcV2CborError(httpResponse: httpResponse, responseReader: reader, noErrorWrapping: false)
+        XCTAssertEqual(subject.code, "UnknownError")
+    }
+
+
+    func test_init_usesUnknownErrorCodeWhenDataIsNotCborMap() throws {
+        let reader = Reader(nodeInfo: "", cborValue: .array([]))
+        let httpResponse = HTTPResponse(body: .data(Data()), statusCode: .ok)
+        let subject = try RpcV2CborError(httpResponse: httpResponse, responseReader: reader, noErrorWrapping: false)
+        XCTAssertEqual(subject.code, "UnknownError")
+    }
+
+    func test_init_overridesCodeWithPassedCodeWhenNonNil() throws {
+        let reader = Reader(nodeInfo: "", cborValue: .map(["__type": .text(cborCode)]))
+        let httpResponse = HTTPResponse(body: .data(Data()), statusCode: .ok)
+        let subject = try RpcV2CborError(httpResponse: httpResponse, responseReader: reader, noErrorWrapping: false, code: passedCode)
+        XCTAssertEqual(subject.code, passedCode)
+    }
+}

smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/integration/DefaultHTTPProtocolCustomizations.kt

@@ -42,6 +42,8 @@ abstract class DefaultHTTPProtocolCustomizations : HTTPProtocolCustomizable {
 
     override val baseErrorSymbol: Symbol = SmithyTestUtilTypes.TestBaseError
 
+    override val queryCompatibleUtilsSymbol: Symbol = ClientRuntimeTypes.RpcV2Cbor.RpcV2CborQueryCompatibleUtils
+
     override val unknownServiceErrorSymbol: Symbol = ClientRuntimeTypes.Http.UnknownHttpServiceError
 
     override val defaultTimestampFormat = TimestampFormatTrait.Format.EPOCH_SECONDS

smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/integration/HTTPProtocolCustomizable.kt

@@ -55,6 +55,8 @@ interface HTTPProtocolCustomizable {
 
     val baseErrorSymbol: Symbol
 
+    val queryCompatibleUtilsSymbol: Symbol
+
     val unknownServiceErrorSymbol: Symbol
 
     val defaultTimestampFormat: TimestampFormatTrait.Format

smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/integration/httpResponse/HTTPResponseBindingErrorGenerator.kt

@@ -103,8 +103,9 @@ class HTTPResponseBindingErrorGenerator(
                     if (ctx.service.hasTrait<AwsQueryCompatibleTrait>()) {
                         writer.write("let errorDetails = httpResponse.headers.value(for: \"x-amzn-query-error\")")
                         writer.write(
-                            "let baseError = try \$N.makeQueryCompatibleError(httpResponse: httpResponse, responseReader: responseReader, noErrorWrapping: \$L, errorDetails: errorDetails)",
+                            "let baseError: \$N = try \$N.makeQueryCompatibleError(httpResponse: httpResponse, responseReader: responseReader, noErrorWrapping: \$L, errorDetails: errorDetails)",
                             customizations.baseErrorSymbol,
+                            customizations.queryCompatibleUtilsSymbol,
                             noErrorWrapping,
                         )
                     } else {

smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/swiftmodules/ClientRuntimeTypes.kt

@@ -98,6 +98,8 @@ object ClientRuntimeTypes {
 
     object RpcV2Cbor {
         val RpcV2CborError = runtimeSymbol("RpcV2CborError", SwiftDeclaration.STRUCT, emptyList(), listOf("SmithyReadWrite"))
+        val RpcV2CborQueryCompatibleUtils =
+            runtimeSymbol("RpcV2CborQueryCompatibleUtils", SwiftDeclaration.ENUM, emptyList(), listOf("SmithyReadWrite"))
         val CborValidateResponseHeaderMiddleware = runtimeSymbol("CborValidateResponseHeaderMiddleware", SwiftDeclaration.STRUCT)
     }
 }