feat: Schema-based AWS JSON 1.0 / 1.1, RPCv2CBOR (#1071)

Author: jbelkins

.github/workflows/continuous-integration.yml

@@ -68,6 +68,8 @@ jobs:
         run: xcrun simctl list
       - name: Build & Run smithy-swift Kotlin Unit Tests
         run: ./gradlew build
+      - name: Generate test SDKs
+        run: ./scripts/codegen.sh
       - name: Build & Run smithy-swift Swift Unit Tests
         run: |
           set -o pipefail && \
@@ -206,6 +208,8 @@ jobs:
         uses: ./.github/actions/setup-common-tools-composite-action
       - name: Build & Run Kotlin Unit Tests
         run: ./gradlew build
+      - name: Generate test SDKs
+        run: ./scripts/codegen.sh
       - name: Build & Run Swift Unit Tests
         run: swift test
 

.github/workflows/lint.yml

@@ -32,6 +32,8 @@ jobs:
           swiftlint --version
       - name: Run swiftlint
         run: swiftlint --strict --reporter github-actions-logging
+      - name: Generate smithy-swift test SDK
+        run: ./scripts/codegen.sh
       - name: Compile project with Xcode
         timeout-minutes: 20
         run: xcodebuild -scheme smithy-swift-Package -destination platform=macOS > xcodebuild.log

.github/workflows/swift6-compatibility.yml

@@ -23,6 +23,8 @@ jobs:
         run: sudo xcode-select -s /Applications/Xcode_26.4.app
       - name: Setup common tools
         uses: ./.github/actions/setup-common-tools-composite-action
+      - name: Generate test SDKs
+        run: ./scripts/codegen.sh
       - name: Build on swift-tools-version 6.0
         run: |
           swift package tools-version --set 6.0

.gitignore

@@ -31,6 +31,7 @@ xcuserdata
 
 # Codegen build products
 build/
+smithy-build.json
 
 # VS Code config files
 .vscode

.swiftlint.yml

@@ -2,6 +2,7 @@ excluded:
   - .build
   - Sources/SmithyTestUtil/*
   - Tests/*
+  - test-sdks/*
 
 analyzer_rules:
   - unused_import

Package.swift

@@ -31,6 +31,8 @@ let package = Package(
     products: [
         .library(name: "Smithy", targets: ["Smithy"]),
         .library(name: "SmithySerialization", targets: ["SmithySerialization"]),
+        .library(name: "SmithyAWSJSON", targets: ["SmithyAWSJSON"]),
+        .library(name: "SmithyRPCv2CBOR", targets: ["SmithyRPCv2CBOR"]),
         .library(name: "ClientRuntime", targets: ["ClientRuntime"]),
         .library(name: "SmithyRetriesAPI", targets: ["SmithyRetriesAPI"]),
         .library(name: "SmithyRetries", targets: ["SmithyRetries"]),
@@ -51,16 +53,17 @@ let package = Package(
         .library(name: "SmithyStreams", targets: ["SmithyStreams"]),
         .library(name: "SmithyChecksumsAPI", targets: ["SmithyChecksumsAPI"]),
         .library(name: "SmithyChecksums", targets: ["SmithyChecksums"]),
-        .library(name: "SmithyCBOR", targets: ["SmithyCBOR"]),
         .library(name: "SmithyWaitersAPI", targets: ["SmithyWaitersAPI"]),
         .library(name: "SmithyTestUtil", targets: ["SmithyTestUtil"]),
         .library(name: "SmithySwiftNIO", targets: ["SmithySwiftNIO"]),
         .library(name: "SmithyTelemetryAPI", targets: ["SmithyTelemetryAPI"]),
         .library(name: "SmithyHTTPClientAPI", targets: ["SmithyHTTPClientAPI"]),
+        .plugin(name: "SmithyCodeGeneratorPlugin", targets: ["SmithyCodeGeneratorPlugin"]),
     ],
     dependencies: {
         var dependencies: [Package.Dependency] = [
             .package(url: "https://github.com/awslabs/aws-crt-swift.git", exact: "0.58.1"),
+            .package(url: "https://github.com/apple/swift-argument-parser.git", from: "1.1.0"),
             .package(url: "https://github.com/apple/swift-log.git", from: "1.0.0"),
             .package(url: "https://github.com/swift-server/async-http-client.git", from: "1.22.0"),
         ]
@@ -118,6 +121,7 @@ let package = Package(
                 "SmithyChecksumsAPI",
                 "SmithyChecksums",
                 "SmithyCBOR",
+                "SmithySerialization",
                 .product(name: "AwsCommonRuntimeKit", package: "aws-crt-swift"),
             ],
             resources: [
@@ -231,6 +235,7 @@ let package = Package(
             name: "SmithyEventStreams",
             dependencies: [
                 "Smithy",
+                "SmithySerialization",
                 "SmithyEventStreamsAPI",
                 "SmithyEventStreamsAuthAPI",
                 .product(name: "AwsCommonRuntimeKit", package: "aws-crt-swift")
@@ -261,14 +266,55 @@ let package = Package(
         .target(
             name: "SmithyCBOR",
             dependencies: [
-                "SmithyReadWrite",
-                "SmithyTimestamps",
+                "Smithy",
+                "SmithySerialization",
                 .product(name: "AwsCommonRuntimeKit", package: "aws-crt-swift")
             ]
         ),
         .target(
             name: "SmithyWaitersAPI"
         ),
+        .plugin(
+            name: "SmithyCodeGeneratorPlugin",
+            capability: .buildTool(),
+            dependencies: [
+                "SmithyCodegenCLI",
+            ]
+        ),
+        .executableTarget(
+            name: "SmithyCodegenCLI",
+            dependencies: [
+                "SmithyCodegenCore",
+                .product(name: "ArgumentParser", package: "swift-argument-parser"),
+            ]
+        ),
+        .target(
+            name: "SmithyCodegenCore",
+            dependencies: [
+                "Smithy",
+                "SmithySerialization",
+            ],
+            resources: [ .process("Resources") ]
+        ),
+        .target(
+            name: "SmithyAWSJSON",
+            dependencies: [
+                "ClientRuntime",
+                "Smithy",
+                "SmithySerialization",
+                "SmithyJSON",
+                "SmithyEventStreams",
+            ]
+        ),
+        .target(
+            name: "SmithyRPCv2CBOR",
+            dependencies: [
+                "ClientRuntime",
+                "Smithy",
+                "SmithySerialization",
+                "SmithyCBOR",
+            ]
+        ),
         .testTarget(
             name: "ClientRuntimeTests",
             dependencies: [
@@ -279,17 +325,17 @@ let package = Package(
             ],
             resources: [ .process("Resources") ]
         ),
+        .testTarget(
+            name: "SmithyTests",
+            dependencies: ["Smithy"]
+        ),
         .testTarget(
             name: "SmithySwiftNIOTests",
             dependencies: [
                 "SmithySwiftNIO",
                 "SmithyTestUtil",
             ]
         ),
-        .testTarget(
-            name: "SmithyCBORTests",
-            dependencies: ["SmithyCBOR", "ClientRuntime", "SmithyTestUtil"]
-        ),
         .testTarget(
             name: "SmithyHTTPClientTests",
             dependencies: [
@@ -352,5 +398,28 @@ let package = Package(
             name: "SmithyStreamsTests",
             dependencies: ["SmithyStreams", "Smithy"]
         ),
+        .testTarget(
+            name: "SmithyCodegenCoreTests",
+            dependencies: ["SmithyCodegenCore"],
+            resources: [ .process("Resources") ]
+        ),
+        .target(
+            name: "RPCv2CBORTestSDK",
+            dependencies: [
+                "ClientRuntime",
+                "SmithyHTTPAPI",
+                "SmithyHTTPAuthAPI",
+                "SmithyIdentity",
+                "SmithyRPCv2CBOR",
+                "SmithyRetries",
+                "SmithyRetriesAPI",
+            ],
+            path: "test-sdks/build/smithyprojections/test-sdks/rpcv2cbor/swift-codegen/Sources/RPCv2CBORTestSDK",
+            plugins: ["SmithyCodeGeneratorPlugin"]
+        ),
+        .testTarget(
+            name: "SmithySerializationTests",
+            dependencies: ["SmithySerialization", "RPCv2CBORTestSDK"]
+        ),
     ].compactMap { $0 }
 )

Plugins/SmithyCodeGeneratorPlugin/SmithyCodeGeneratorPlugin.swift

@@ -0,0 +1,129 @@
+//
+// Copyright Amazon.com Inc. or its affiliates.
+// All Rights Reserved.
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+
+import struct Foundation.Data
+import class Foundation.FileManager
+import class Foundation.JSONDecoder
+import struct Foundation.URL
+import PackagePlugin
+
+@main
+struct SmithyCodeGeneratorPlugin: BuildToolPlugin {
+
+    func createBuildCommands(context: PluginContext, target: Target) throws -> [Command] {
+        // This plugin only runs for package targets that can have source files.
+        guard let sourceFiles = target.sourceModule?.sourceFiles else { return [] }
+
+        // Retrieve the `SmithyCodegenCLI` tool from the plugin's tools.
+        let smithyCodegenCLITool = try context.tool(named: "SmithyCodegenCLI")
+
+        // Construct a build command for each source file with a particular suffix.
+        return try sourceFiles.map(\.path).compactMap {
+            try createBuildCommand(
+                name: target.name,
+                for: $0,
+                in: context.pluginWorkDirectory,
+                with: smithyCodegenCLITool.path
+            )
+        }
+    }
+
+    private func createBuildCommand(
+        name: String,
+        for inputPath: Path,
+        in outputDirectoryPath: Path,
+        with generatorToolPath: Path
+    ) throws -> Command? {
+        // Skip any file that isn't the swift-settings.json for this service.
+        guard inputPath.lastComponent == "swift-settings.json" else { return nil }
+
+        let currentWorkingDirectoryFileURL = URL(fileURLWithPath: FileManager.default.currentDirectoryPath)
+
+        // Get the smithy-model-info.json file contents.
+        let modelInfoData = try Data(contentsOf: URL(fileURLWithPath: inputPath.string))
+        let smithyModelInfo = try JSONDecoder().decode(SmithyModelInfo.self, from: modelInfoData)
+
+        // Get the fields from smithy-model-info.
+        let service = smithyModelInfo.service
+        let sdkId = smithyModelInfo.sdkId
+        let modelPathURL = if let modelPath = smithyModelInfo.modelPath {
+            currentWorkingDirectoryFileURL.appendingPathComponent(modelPath)
+        } else {
+            URL(fileURLWithPath: inputPath.removingLastComponent().appending(["model.json"]).string)
+        }
+        let modelPath = Path(modelPathURL.path)
+        let internalClient = smithyModelInfo.internalClient
+        let operations = smithyModelInfo.operations.joined(separator: ",")
+
+        // Construct the Schemas.swift path.
+        let schemasSwiftPath = outputDirectoryPath.appending("\(name)Schemas.swift")
+
+        // Construct the Serialize.swift path.
+        let serializeSwiftPath = outputDirectoryPath.appending("\(name)Serialize.swift")
+
+        // Construct the Deserialize.swift path.
+        let deserializeSwiftPath = outputDirectoryPath.appending("\(name)Deserialize.swift")
+
+        // Construct the TypeRegistry.swift path.
+        let typeRegistrySwiftPath = outputDirectoryPath.appending("\(name)TypeRegistry.swift")
+
+        // Construct the Operations.swift path.
+        let operationsSwiftPath = outputDirectoryPath.appending("\(name)Operations.swift")
+
+        var arguments: [any CustomStringConvertible] = [
+            service,
+            modelPath,
+            "--internal", "\(internalClient)",
+            "--sdk-id", sdkId,
+            "--schemas-path", schemasSwiftPath,
+            "--serialize-path", serializeSwiftPath,
+            "--deserialize-path", deserializeSwiftPath,
+            "--type-registry-path", typeRegistrySwiftPath,
+            "--operations-path", operationsSwiftPath,
+        ]
+
+        if !operations.isEmpty {
+            arguments.append(contentsOf: ["--operations", operations])
+        }
+
+        // Construct the build command that invokes SmithyCodegenCLI.
+        return .buildCommand(
+            displayName: "Generating Swift source files from model file \(modelPath)",
+            executable: generatorToolPath,
+            arguments: arguments,
+            inputFiles: [inputPath, modelPath],
+            outputFiles: [
+                schemasSwiftPath,
+                serializeSwiftPath,
+                deserializeSwiftPath,
+                typeRegistrySwiftPath,
+                operationsSwiftPath,
+            ]
+        )
+    }
+}
+
+/// Decodable structure for reading the contents of `smithy-model-info.json`
+private struct SmithyModelInfo: Decodable {
+    /// The shape ID of the service being generated.  Must exist in the model.
+    let service: String
+
+    /// The name to be used for the enclosing module.
+    let module: String
+
+    /// The `sdkId` used by the Smithy-based code generator.
+    let sdkId: String
+
+    /// Set to `true` if the client should be rendered for internal use.
+    let internalClient: Bool
+
+    /// A list of operations to be included in the client.  If omitted or empty, all operations are included.
+    let operations: [String]
+
+    /// The path to the model, from the root of the target's project.
+    let modelPath: String?
+}

Sources/ClientRuntime/Interceptor/DefaultInterceptorContext.swift

@@ -70,6 +70,7 @@ extension DefaultInterceptorContext: BeforeDeserialization {
 }
 
 extension DefaultInterceptorContext: MutableResponse {
+
     public func updateResponse(updated: ResponseType) {
         self.response = updated
     }
@@ -93,9 +94,14 @@ extension DefaultInterceptorContext: AfterAttempt {
 }
 
 extension DefaultInterceptorContext: MutableOutputAfterAttempt {
+
     public func updateOutput(updated: OutputType) {
         self.result = .success(updated)
     }
+
+    public func updateError(updated: any Error) {
+        self.result = .failure(updated)
+    }
 }
 
 extension DefaultInterceptorContext: Finalization {

Sources/ClientRuntime/Interceptor/InterceptorContext.swift

@@ -141,6 +141,10 @@ public protocol MutableOutputAfterAttempt<InputType, OutputType, RequestType, Re
     /// Mutates the operation output.
     /// - Parameter updated: The updated output.
     func updateOutput(updated: OutputType)
+
+    /// Mutates the operation error.
+    /// - Parameter updated: The updated error.
+    func updateError(updated: any Error)
 }
 
 /// Context given to interceptor hooks called after execution.
@@ -179,4 +183,8 @@ public protocol MutableOutputFinalization<InputType, OutputType, RequestType, Re
     /// Mutates the operation output.
     /// - Parameter updated: The updated output.
     func updateOutput(updated: OutputType)
+
+    /// Mutates the operation error.
+    /// - Parameter updated: The updated error.
+    func updateError(updated: any Error)
 }

Sources/ClientRuntime/Networking/Http/HTTPError.swift

@@ -12,5 +12,5 @@ import class SmithyHTTPAPI.HTTPResponse
 public protocol HTTPError {
 
     /// The HTTP/HTTPS response that resulted in this error.
-    var httpResponse: HTTPResponse { get }
+    var httpResponse: HTTPResponse { get set }
 }