feat!: Closure-based reader-writer serde for JSON, FormURL

AWSSDKSwiftCLI/Sources/AWSSDKSwiftCLI/Resources/Package.Base.swift

@@ -191,11 +191,13 @@ func addProtocolTests() {
         let name: String
         let sourcePath: String
         let testPath: String?
+        let buildOnly: Bool
 
-        init(name: String, sourcePath: String, testPath: String? = nil) {
+        init(name: String, sourcePath: String, testPath: String? = nil, buildOnly: Bool = false) {
             self.name = name
             self.sourcePath = sourcePath
             self.testPath = testPath
+            self.buildOnly = buildOnly
         }
     }
 
@@ -217,21 +219,22 @@ func addProtocolTests() {
         .init(name: "S3TestSDK", sourcePath: "\(baseDir)/s3"),
         .init(name: "rest_json_extras", sourcePath: "\(baseDirLocal)/rest_json_extras"),
         .init(name: "AwsQueryExtras", sourcePath: "\(baseDirLocal)/AwsQueryExtras"),
+        .init(name: "EventStream", sourcePath: "\(baseDirLocal)/EventStream", buildOnly: true),
+        .init(name: "RPCEventStream", sourcePath: "\(baseDirLocal)/RPCEventStream", buildOnly: true),
         .init(name: "Waiters", sourcePath: "\(baseDirLocal)/Waiters", testPath: "codegen/protocol-test-codegen-local/Tests"),
     ]
     for protocolTest in protocolTests {
-        package.targets += [
-            .target(
-                name: protocolTest.name,
-                dependencies: [.clientRuntime, .awsClientRuntime],
-                path: "\(protocolTest.sourcePath)/swift-codegen/\(protocolTest.name)"
-            ),
-            .testTarget(
-                name: "\(protocolTest.name)Tests",
-                dependencies: [.smithyTestUtils, .byNameItem(name: protocolTest.name, condition: nil)],
-                path: "\(protocolTest.testPath ?? protocolTest.sourcePath)/swift-codegen/\(protocolTest.name)Tests"
-            )
-        ]
+        let target = Target.target(
+            name: protocolTest.name,
+            dependencies: [.clientRuntime, .awsClientRuntime],
+            path: "\(protocolTest.sourcePath)/swift-codegen/\(protocolTest.name)"
+        )
+        let testTarget = protocolTest.buildOnly ? nil : Target.testTarget(
+            name: "\(protocolTest.name)Tests",
+            dependencies: [.smithyTestUtils, .byNameItem(name: protocolTest.name, condition: nil)],
+            path: "\(protocolTest.testPath ?? protocolTest.sourcePath)/swift-codegen/\(protocolTest.name)Tests"
+        )
+        package.targets += [target, testTarget].compactMap { $0 }
     }
 }
 

Package.swift

@@ -191,11 +191,13 @@ func addProtocolTests() {
         let name: String
         let sourcePath: String
         let testPath: String?
+        let buildOnly: Bool
 
-        init(name: String, sourcePath: String, testPath: String? = nil) {
+        init(name: String, sourcePath: String, testPath: String? = nil, buildOnly: Bool = false) {
             self.name = name
             self.sourcePath = sourcePath
             self.testPath = testPath
+            self.buildOnly = buildOnly
         }
     }
 
@@ -217,21 +219,22 @@ func addProtocolTests() {
         .init(name: "S3TestSDK", sourcePath: "\(baseDir)/s3"),
         .init(name: "rest_json_extras", sourcePath: "\(baseDirLocal)/rest_json_extras"),
         .init(name: "AwsQueryExtras", sourcePath: "\(baseDirLocal)/AwsQueryExtras"),
+        .init(name: "EventStream", sourcePath: "\(baseDirLocal)/EventStream", buildOnly: true),
+        .init(name: "RPCEventStream", sourcePath: "\(baseDirLocal)/RPCEventStream", buildOnly: true),
         .init(name: "Waiters", sourcePath: "\(baseDirLocal)/Waiters", testPath: "codegen/protocol-test-codegen-local/Tests"),
     ]
     for protocolTest in protocolTests {
-        package.targets += [
-            .target(
-                name: protocolTest.name,
-                dependencies: [.clientRuntime, .awsClientRuntime],
-                path: "\(protocolTest.sourcePath)/swift-codegen/\(protocolTest.name)"
-            ),
-            .testTarget(
-                name: "\(protocolTest.name)Tests",
-                dependencies: [.smithyTestUtils, .byNameItem(name: protocolTest.name, condition: nil)],
-                path: "\(protocolTest.testPath ?? protocolTest.sourcePath)/swift-codegen/\(protocolTest.name)Tests"
-            )
-        ]
+        let target = Target.target(
+            name: protocolTest.name,
+            dependencies: [.clientRuntime, .awsClientRuntime],
+            path: "\(protocolTest.sourcePath)/swift-codegen/\(protocolTest.name)"
+        )
+        let testTarget = protocolTest.buildOnly ? nil : Target.testTarget(
+            name: "\(protocolTest.name)Tests",
+            dependencies: [.smithyTestUtils, .byNameItem(name: protocolTest.name, condition: nil)],
+            path: "\(protocolTest.testPath ?? protocolTest.sourcePath)/swift-codegen/\(protocolTest.name)Tests"
+        )
+        package.targets += [target, testTarget].compactMap { $0 }
     }
 }
 

codegen/protocol-test-codegen-local/build.gradle.kts

@@ -41,8 +41,12 @@ val codegenTests = listOf(
         "Waiters"
     ),
     CodegenTest(
-        "aws.protocoltests.restjson#TestService",
+        "aws.protocoltests.eventstream#TestService",
         "EventStream"
+    ),
+    CodegenTest(
+        "aws.protocoltests.eventstream#RPCTestService",
+        "RPCEventStream"
     )
 )
 

codegen/protocol-test-codegen-local/model/eventstream-rpc.smithy

@@ -0,0 +1,83 @@
+namespace aws.protocoltests.eventstream
+
+use aws.protocols#awsJson1_1
+use aws.api#service
+use aws.auth#sigv4
+
+@awsJson1_1
+@sigv4(name: "rpc-event-stream-test")
+@service(sdkId: "RPCEventStreamTest")
+service RPCTestService { version: "123", operations: [TestStreamOp] }
+
+@http(method: "POST", uri: "/test")
+operation TestStreamOp {
+    input: TestStreamInputOutput,
+    output: TestStreamInputOutput,
+    errors: [SomeError],
+}
+
+structure TestStreamInputOutput {
+    @httpPayload
+    @required
+    value: TestStream
+}
+
+@error("client")
+structure SomeError {
+    Message: String,
+}
+
+union TestUnion {
+    Foo: String,
+    Bar: Integer,
+}
+
+structure TestStruct {
+    someString: String,
+    someInt: Integer,
+}
+
+structure MessageWithBlob { @eventPayload data: Blob }
+
+structure MessageWithString { @eventPayload data: String }
+
+structure MessageWithStruct { @eventPayload someStruct: TestStruct }
+
+structure MessageWithUnion { @eventPayload someUnion: TestUnion }
+
+structure MessageWithHeaders {
+    @eventHeader blob: Blob,
+    @eventHeader boolean: Boolean,
+    @eventHeader byte: Byte,
+    @eventHeader int: Integer,
+    @eventHeader long: Long,
+    @eventHeader short: Short,
+    @eventHeader string: String,
+    @eventHeader timestamp: Timestamp,
+}
+structure MessageWithHeaderAndPayload {
+    @eventHeader header: String,
+    @eventPayload payload: Blob,
+}
+structure MessageWithNoHeaderPayloadTraits {
+    someInt: Integer,
+    someString: String,
+}
+
+structure MessageWithUnboundPayloadTraits {
+    @eventHeader header: String,
+    unboundString: String,
+}
+
+@streaming
+union TestStream {
+    MessageWithBlob: MessageWithBlob,
+    MessageWithString: MessageWithString,
+    MessageWithStruct: MessageWithStruct,
+    MessageWithUnion: MessageWithUnion,
+    MessageWithHeaders: MessageWithHeaders,
+    MessageWithHeaderAndPayload: MessageWithHeaderAndPayload,
+    MessageWithNoHeaderPayloadTraits: MessageWithNoHeaderPayloadTraits,
+    MessageWithUnboundPayloadTraits: MessageWithUnboundPayloadTraits,
+    SomeError: SomeError,
+}

codegen/protocol-test-codegen-local/model/eventstream.smithy

@@ -1,4 +1,4 @@
-namespace aws.protocoltests.restjson
+namespace aws.protocoltests.eventstream
 
 use aws.protocols#restJson1
 use aws.api#service

codegen/smithy-aws-swift-codegen/src/main/kotlin/software/amazon/smithy/aws/swift/codegen/message/MessageMarshallableGenerator.kt

@@ -3,7 +3,6 @@ package software.amazon.smithy.aws.swift.codegen.message
 import software.amazon.smithy.codegen.core.CodegenException
 import software.amazon.smithy.codegen.core.Symbol
 import software.amazon.smithy.model.shapes.MemberShape
-import software.amazon.smithy.model.shapes.Shape
 import software.amazon.smithy.model.shapes.ShapeType
 import software.amazon.smithy.model.shapes.UnionShape
 import software.amazon.smithy.model.traits.EventHeaderTrait
@@ -14,6 +13,7 @@ import software.amazon.smithy.swift.codegen.SwiftWriter
 import software.amazon.smithy.swift.codegen.integration.ProtocolGenerator
 import software.amazon.smithy.swift.codegen.integration.serde.readwrite.NodeInfoUtils
 import software.amazon.smithy.swift.codegen.integration.serde.readwrite.WritingClosureUtils
+import software.amazon.smithy.swift.codegen.integration.serde.readwrite.requestWireProtocol
 import software.amazon.smithy.swift.codegen.integration.serde.readwrite.responseWireProtocol
 import software.amazon.smithy.swift.codegen.integration.serde.struct.writerSymbol
 import software.amazon.smithy.swift.codegen.model.eventStreamEvents
@@ -70,7 +70,19 @@ class MessageMarshallableGenerator(
                                     eventPayloadBinding != null -> renderSerializeEventPayload(ctx, eventPayloadBinding, writer)
                                     unbound.isNotEmpty() -> {
                                         writer.addStringHeader(":content-type", payloadContentType)
-                                        renderPayloadSerialization(ctx, writer, variant)
+                                        writer.addImport(ctx.service.writerSymbol.namespace)
+                                        val nodeInfo = NodeInfoUtils(ctx, writer, ctx.service.requestWireProtocol).nodeInfo(member, true)
+                                        writer.write("let writer = \$N(nodeInfo: \$L)", ctx.service.writerSymbol, nodeInfo)
+                                        unbound.forEach {
+                                            val writingClosure = WritingClosureUtils(ctx, writer).writingClosure(ctx.model.expectShape(it.target))
+                                            writer.write(
+                                                "try writer[\$S].write(value.\$L, with: \$L)",
+                                                it.memberName,
+                                                ctx.symbolProvider.toMemberName(it),
+                                                writingClosure,
+                                            )
+                                        }
+                                        writer.write("payload = try writer.data()")
                                     }
                                 }
                                 writer.dedent()
@@ -108,7 +120,7 @@ class MessageMarshallableGenerator(
             }
             ShapeType.STRUCTURE, ShapeType.UNION -> {
                 writer.addStringHeader(":content-type", payloadContentType)
-                renderPayloadSerialization(ctx, writer, target)
+                renderPayloadSerialization(ctx, writer, member)
             }
             else -> throw CodegenException("unsupported shape type `${target.type}` for target: $target; expected blob, string, structure, or union for eventPayload member: $member")
         }
@@ -175,14 +187,16 @@ class MessageMarshallableGenerator(
         write("headers.append(.init(name: \$S, value: .string(\$S)))", name, value)
     }
 
-    private fun renderPayloadSerialization(ctx: ProtocolGenerator.GenerationContext, writer: SwiftWriter, shape: Shape) {
+    private fun renderPayloadSerialization(ctx: ProtocolGenerator.GenerationContext, writer: SwiftWriter, memberShape: MemberShape) {
         // get a payload serializer for the given members of the variant
         val nodeInfoUtils = NodeInfoUtils(ctx, writer, ctx.service.responseWireProtocol)
-        val rootNodeInfo = nodeInfoUtils.nodeInfo(shape)
-        val valueWritingClosure = WritingClosureUtils(ctx, writer).writingClosure(shape)
+        val rootNodeInfo = nodeInfoUtils.nodeInfo(memberShape, true)
+        val valueWritingClosure = WritingClosureUtils(ctx, writer).writingClosure(memberShape)
+        writer.addImport(ctx.service.writerSymbol.namespace)
         writer.write(
-            "payload = try \$N.write(value, rootNodeInfo: \$L, with: \$L)",
+            "payload = try \$N.write(value.\$L, rootNodeInfo: \$L, with: \$L)",
             ctx.service.writerSymbol,
+            ctx.symbolProvider.toMemberName(memberShape),
             rootNodeInfo,
             valueWritingClosure,
         )

codegen/smithy-aws-swift-codegen/src/main/kotlin/software/amazon/smithy/aws/swift/codegen/message/MessageUnmarshallableGenerator.kt

@@ -73,7 +73,7 @@ class MessageUnmarshallableGenerator(val ctx: ProtocolGenerator.GenerationContex
                             writer.indent {
                                 writer.write("switch params.exceptionType {")
                                 streamShape.eventStreamErrors(ctx.model).forEach { member ->
-                                    writer.write("case \"${member.memberName}\":")
+                                    writer.write("case \$S:", member.memberName)
                                     writer.indent {
                                         renderReadToValue(writer, member)
                                         writer.write("return value")
@@ -170,7 +170,7 @@ class MessageUnmarshallableGenerator(val ctx: ProtocolGenerator.GenerationContex
                     // and then assign each deserialized payload member to the current builder instance
                     unbound.forEach {
                         renderReadToValue(writer, it)
-                        writer.write("event.\$L = value", memberName)
+                        writer.write("event.\$L = value", ctx.symbolProvider.toMemberName(it))
                     }
                 }
             }
@@ -190,13 +190,14 @@ class MessageUnmarshallableGenerator(val ctx: ProtocolGenerator.GenerationContex
             ShapeType.STRING -> writer.write("event.\$L = String(data: message.payload, encoding: .utf8)", memberName)
             ShapeType.STRUCTURE, ShapeType.UNION -> {
                 renderReadToValue(writer, member)
-                writer.write("event.\$L = value", memberName)
+                writer.write("event.\$L = value", ctx.symbolProvider.toMemberName(member))
             }
             else -> throw CodegenException("unsupported shape type `${target.type}` for target: $target; expected blob, string, structure, or union for eventPayload member: $member")
         }
     }
 
     private fun renderReadToValue(writer: SwiftWriter, memberShape: MemberShape) {
+        writer.addImport(ctx.service.readerSymbol.namespace)
         val readingClosure = ReadingClosureUtils(ctx, writer).readingClosure(memberShape)
         writer.write(
             "let value = try \$N.readFrom(message.payload, with: \$L)",

codegen/smithy-aws-swift-codegen/src/test/kotlin/software/amazon/smithy/aws/swift/codegen/EventStreamTests.kt

@@ -29,11 +29,11 @@ extension EventStreamTestClientTypes.TestStream {
             case .messagewithstruct(let value):
                 headers.append(.init(name: ":event-type", value: .string("MessageWithStruct")))
                 headers.append(.init(name: ":content-type", value: .string("application/json")))
-                payload = try SmithyJSON.Writer.write(value, rootNodeInfo: "TestStruct", with: EventStreamTestClientTypes.TestStruct.write(value:to:))
+                payload = try SmithyJSON.Writer.write(value.someStruct, rootNodeInfo: "", with: EventStreamTestClientTypes.TestStruct.write(value:to:))
             case .messagewithunion(let value):
                 headers.append(.init(name: ":event-type", value: .string("MessageWithUnion")))
                 headers.append(.init(name: ":content-type", value: .string("application/json")))
-                payload = try SmithyJSON.Writer.write(value, rootNodeInfo: "TestUnion", with: EventStreamTestClientTypes.TestUnion.write(value:to:))
+                payload = try SmithyJSON.Writer.write(value.someUnion, rootNodeInfo: "", with: EventStreamTestClientTypes.TestUnion.write(value:to:))
             case .messagewithheaders(let value):
                 headers.append(.init(name: ":event-type", value: .string("MessageWithHeaders")))
                 if let headerValue = value.blob {
@@ -70,14 +70,19 @@ extension EventStreamTestClientTypes.TestStream {
             case .messagewithnoheaderpayloadtraits(let value):
                 headers.append(.init(name: ":event-type", value: .string("MessageWithNoHeaderPayloadTraits")))
                 headers.append(.init(name: ":content-type", value: .string("application/json")))
-                payload = try SmithyJSON.Writer.write(value, rootNodeInfo: "MessageWithNoHeaderPayloadTraits", with: EventStreamTestClientTypes.MessageWithNoHeaderPayloadTraits.write(value:to:))
+                let writer = SmithyJSON.Writer(nodeInfo: "")
+                try writer["someInt"].write(value.someInt, with: Swift.Int.write(value:to:))
+                try writer["someString"].write(value.someString, with: Swift.String.write(value:to:))
+                payload = try writer.data()
             case .messagewithunboundpayloadtraits(let value):
                 headers.append(.init(name: ":event-type", value: .string("MessageWithUnboundPayloadTraits")))
                 if let headerValue = value.header {
                     headers.append(.init(name: "header", value: .string(headerValue)))
                 }
                 headers.append(.init(name: ":content-type", value: .string("application/json")))
-                payload = try SmithyJSON.Writer.write(value, rootNodeInfo: "MessageWithUnboundPayloadTraits", with: EventStreamTestClientTypes.MessageWithUnboundPayloadTraits.write(value:to:))
+                let writer = SmithyJSON.Writer(nodeInfo: "")
+                try writer["unboundString"].write(value.unboundString, with: Swift.String.write(value:to:))
+                payload = try writer.data()
             case .sdkUnknown(_):
                 throw ClientRuntime.ClientError.unknownError("cannot serialize the unknown event type!")
             }
@@ -161,7 +166,7 @@ extension EventStreamTestClientTypes.TestStream {
                         event.header = value
                     }
                     let value = try SmithyJSON.Reader.readFrom(message.payload, with: Swift.String.read(from:))
-                    event.messagewithunboundpayloadtraits = value
+                    event.unboundString = value
                     return .messagewithunboundpayloadtraits(event)
                 default:
                     return .sdkUnknown("error processing event stream, unrecognized event: \(params.eventType)")

codegen/smithy-aws-swift-codegen/src/test/kotlin/software/amazon/smithy/aws/swift/codegen/awsjson/AWSJsonHttpInitialRequestTests.kt

@@ -54,7 +54,7 @@ extension InitialRequestTestClientTypes.TestStream {
         )
         contents.shouldSyntacticSanityCheck()
         val expectedContents = """
-        let initialRequestMessage = try input.makeInitialRequestMessage(encoder: encoder)
+        let initialRequestMessage = try input.makeInitialRequestMessage()
         operation.serializeStep.intercept(position: .after, middleware: ClientRuntime.EventStreamBodyMiddleware<EventStreamOpInput, EventStreamOpOutput, InitialRequestTestClientTypes.TestStream>(keyPath: \.eventStream, defaultBody: "{}", marshalClosure: InitialRequestTestClientTypes.TestStream.marshal, initialRequestMessage: initialRequestMessage))
 """
         contents.shouldContainOnlyOnce(expectedContents)
@@ -97,9 +97,9 @@ extension EventStreamOpInput {
         contents.shouldSyntacticSanityCheck()
         val expectedContents = """
 extension EventStreamOpInput {
-    func makeInitialRequestMessage(encoder: ClientRuntime.RequestEncoder) throws -> EventStream.Message {
+    func makeInitialRequestMessage() throws -> EventStream.Message {
         let writer = SmithyJSON.Writer(nodeInfo: "")
-        try writer.write(self, writingClosure: EventStreamOpInput.write(value:to:))
+        try writer.write(self, with: EventStreamOpInput.write(value:to:))
         let initialRequestPayload = try writer.data()
         let initialRequestMessage = EventStream.Message(
             headers: [

codegen/smithy-aws-swift-codegen/src/test/kotlin/software/amazon/smithy/aws/swift/codegen/restxml/AWSRestXMLEventStreamTests.kt

@@ -54,7 +54,7 @@ extension EventStreamTestClientTypes.TestEvents {
                     headers.append(.init(name: "exampleHeader", value: .string(headerValue)))
                 }
                 headers.append(.init(name: ":content-type", value: .string("application/xml")))
-                payload = try SmithyXML.Writer.write(value, rootNodeInfo: "Audio", with: EventStreamTestClientTypes.Audio.write(value:to:))
+                payload = try SmithyXML.Writer.write(value.audio, rootNodeInfo: "Audio", with: EventStreamTestClientTypes.Audio.write(value:to:))
             case .sdkUnknown(_):
                 throw ClientRuntime.ClientError.unknownError("cannot serialize the unknown event type!")
             }