feat!: Modularize event streams & event streams auth (#741)

Author: jbelkins

.github/workflows/continuous-integration.yml

@@ -112,7 +112,7 @@ jobs:
           cd ../aws-sdk-swift
           set -o pipefail && \
           NSUnbufferedIO=YES xcodebuild \
-            -scheme aws-sdk-swift \
+            -scheme aws-sdk-swift-Package \
             -destination '${{ matrix.destination }}' \
             test 2>&1 \
             | xcbeautify

Package.swift

@@ -28,30 +28,51 @@ let package = Package(
         .watchOS(.v6)
     ],
     products: [
+        .library(name: "Smithy", targets: ["Smithy"]),
         .library(name: "ClientRuntime", targets: ["ClientRuntime"]),
         .library(name: "SmithyRetriesAPI", targets: ["SmithyRetriesAPI"]),
         .library(name: "SmithyRetries", targets: ["SmithyRetries"]),
         .library(name: "SmithyReadWrite", targets: ["SmithyReadWrite"]),
         .library(name: "SmithyXML", targets: ["SmithyXML"]),
         .library(name: "SmithyJSON", targets: ["SmithyJSON"]),
         .library(name: "SmithyFormURL", targets: ["SmithyFormURL"]),
+        .library(name: "SmithyIdentityAPI", targets: ["SmithyIdentityAPI"]),
+        .library(name: "SmithyHTTPAPI", targets: ["SmithyHTTPAPI"]),
+        .library(name: "SmithyHTTPAuthAPI", targets: ["SmithyHTTPAuthAPI"]),
+        .library(name: "SmithyEventStreamsAPI", targets: ["SmithyEventStreamsAPI"]),
+        .library(name: "SmithyEventStreamsAuthAPI", targets: ["SmithyEventStreamsAuthAPI"]),
+        .library(name: "SmithyEventStreams", targets: ["SmithyEventStreams"]),
+        .library(name: "SmithyChecksumsAPI", targets: ["SmithyChecksumsAPI"]),
         .library(name: "SmithyTestUtil", targets: ["SmithyTestUtil"]),
     ],
     dependencies: [
         .package(url: "https://github.com/awslabs/aws-crt-swift.git", exact: "0.30.0"),
         .package(url: "https://github.com/apple/swift-log.git", from: "1.0.0"),
     ],
     targets: [
+        .target(
+            name: "Smithy",
+            dependencies: [
+                .product(name: "Logging", package: "swift-log"),
+            ]
+        ),
         .target(
             name: "ClientRuntime",
             dependencies: [
+                "Smithy",
                 "SmithyRetriesAPI",
                 "SmithyRetries",
                 "SmithyXML",
                 "SmithyJSON",
                 "SmithyFormURL",
+                "SmithyIdentityAPI",
+                "SmithyHTTPAPI",
+                "SmithyHTTPAuthAPI",
+                "SmithyEventStreamsAPI",
+                "SmithyEventStreams",
+                "SmithyEventStreamsAuthAPI",
+                "SmithyChecksumsAPI",
                 .product(name: "AwsCommonRuntimeKit", package: "aws-crt-swift"),
-                .product(name: "Logging", package: "swift-log"),
             ],
             resources: [
                 .copy("PrivacyInfo.xcprivacy")
@@ -73,9 +94,7 @@ let package = Package(
         ),
         .target(
             name: "SmithyReadWrite",
-            dependencies: [
-                "SmithyTimestamps"
-            ]
+            dependencies: ["SmithyTimestamps"]
         ),
         .target(
             name: "SmithyXML",
@@ -107,6 +126,39 @@ let package = Package(
             name: "SmithyTestUtil",
             dependencies: ["ClientRuntime"]
         ),
+        .target(
+            name: "SmithyIdentityAPI",
+            dependencies: ["Smithy"]
+        ),
+        .target(
+            name: "SmithyHTTPAPI",
+            dependencies: ["Smithy"]
+        ),
+        .target(
+            name: "SmithyHTTPAuthAPI",
+            dependencies: ["Smithy", "SmithyHTTPAPI"]
+        ),
+        .target(
+            name: "SmithyEventStreamsAPI",
+            dependencies: ["Smithy"]
+        ),
+        .target(
+            name: "SmithyEventStreamsAuthAPI",
+            dependencies: ["Smithy", "SmithyEventStreamsAPI"]
+        ),
+        .target(
+            name: "SmithyEventStreams",
+            dependencies: [
+                "Smithy",
+                "SmithyEventStreamsAPI",
+                "SmithyEventStreamsAuthAPI",
+                .product(name: "AwsCommonRuntimeKit", package: "aws-crt-swift")
+            ]
+        ),
+        .target(
+            name: "SmithyChecksumsAPI",
+            dependencies: ["Smithy"]
+        ),
         .testTarget(
             name: "ClientRuntimeTests",
             dependencies: ["ClientRuntime", "SmithyTestUtil"],
@@ -132,6 +184,10 @@ let package = Package(
             name: "SmithyTestUtilTests",
             dependencies: ["SmithyTestUtil"]
         ),
+        .testTarget(
+            name: "SmithyEventStreamsTests",
+            dependencies: ["SmithyEventStreams"]
+        ),
     ].compactMap { $0 }
 )
 

Sources/ClientRuntime/Auth/HTTPAuth/DefaultIdentityResolverConfiguration.swift

@@ -5,14 +5,19 @@
 // SPDX-License-Identifier: Apache-2.0
 //
 
+import struct Smithy.Attributes
+import struct Smithy.AttributeKey
+import protocol SmithyIdentityAPI.IdentityResolver
+import protocol SmithyIdentityAPI.IdentityResolverConfiguration
+
 public struct DefaultIdentityResolverConfiguration: IdentityResolverConfiguration {
     let identityResolvers: Attributes
 
     public init(configuredIdResolvers: Attributes) {
         self.identityResolvers = configuredIdResolvers
     }
 
-    func getIdentityResolver(schemeID: String) throws -> (any IdentityResolver)? {
+    public func getIdentityResolver(schemeID: String) throws -> (any IdentityResolver)? {
         return self.identityResolvers.get(key: AttributeKey<any IdentityResolver>(name: schemeID))
     }
 }

Sources/ClientRuntime/Auth/HTTPAuthAPI/Signer.swift

@@ -5,6 +5,10 @@
 // SPDX-License-Identifier: Apache-2.0
 //
 
+import protocol SmithyHTTPAPI.HTTPClient
+import protocol SmithyHTTPAuthAPI.AuthScheme
+import protocol SmithyHTTPAuthAPI.AuthSchemeResolver
+
 public protocol DefaultHttpClientConfiguration: ClientConfiguration {
 
     /// The HTTP client to be used for the target platform, configured with the supplied configuration.
@@ -19,10 +23,10 @@ public protocol DefaultHttpClientConfiguration: ClientConfiguration {
     /// List of auth schemes to use for client calls.
     ///
     /// Defaults to auth schemes defined on the Smithy service model.
-    var authSchemes: [ClientRuntime.AuthScheme]? { get set }
+    var authSchemes: [AuthScheme]? { get set }
 
     /// The auth scheme resolver to use for resolving auth scheme.
     ///
     /// Defaults to a auth scheme resolver generated based on Smithy service model.
-    var authSchemeResolver: ClientRuntime.AuthSchemeResolver { get set }
+    var authSchemeResolver: AuthSchemeResolver { get set }
 }

Sources/ClientRuntime/Config/DefaultHttpClientConfiguration.swift

@@ -5,6 +5,12 @@
 // SPDX-License-Identifier: Apache-2.0
 //
 
+import class Smithy.Context
+import protocol SmithyHTTPAPI.HTTPClient
+import enum Smithy.ClientError
+import struct SmithyHTTPAuthAPI.AuthOption
+import protocol SmithyHTTPAuthAPI.AuthSchemeResolver
+import protocol SmithyHTTPAuthAPI.AuthSchemeResolverParameters
 import protocol SmithyRetriesAPI.RetryStrategy
 import protocol SmithyRetriesAPI.RetryErrorInfoProvider
 import struct SmithyRetriesAPI.RetryStrategyOptions
@@ -137,7 +143,7 @@ public class DefaultAuthSchemeResolver: AuthSchemeResolver {
         return []
     }
 
-    public func constructParameters(context: HttpContext) throws -> AuthSchemeResolverParameters {
+    public func constructParameters(context: Context) throws -> AuthSchemeResolverParameters {
         guard let opName = context.getOperation() else {
             throw ClientError.dataNotFound(
                 "Operation name not configured in middleware context for auth scheme resolver params construction.")

Sources/ClientRuntime/Config/DefaultSDKRuntimeConfiguration.swift

@@ -5,10 +5,13 @@
 // SPDX-License-Identifier: Apache-2.0
 //
 
+import enum Smithy.URIScheme
+import struct SmithyHTTPAPI.Endpoint
+
 public struct ServiceEndpointMetadata {
-    public let defaultProtocol = ProtocolType.https.rawValue
+    public let defaultProtocol = URIScheme.https.rawValue
     public let defaultSigner = "v4"
-    public let protocolPriority = ProtocolType.allCases.map { $0.rawValue }
+    public let protocolPriority = URIScheme.allCases.map { $0.rawValue }
     public let signerPriority = ["v4"]
     /**
       A URI **template** used to resolve the hostname of the endpoint.
@@ -52,7 +55,7 @@ extension ServiceEndpointMetadata {
 
         return SmithyEndpoint(endpoint: Endpoint(host: hostname,
                               path: "/",
-                              protocolType: ProtocolType(rawValue: transportProtocol)!),
+                              protocolType: URIScheme(rawValue: transportProtocol)!),
                               signingName: signingName)
     }
 

Sources/ClientRuntime/Endpoints/ServiceEndpointMetadata.swift

@@ -5,6 +5,8 @@
 // SPDX-License-Identifier: Apache-2.0
 //
 
+import struct SmithyHTTPAPI.Endpoint
+
 /**
   A structure used by the service client to determine the endpoint.
   The SDK will automatically resolve endpoints per API client using an internal resolver.

Sources/ClientRuntime/Endpoints/SmithyEndpoint.swift

@@ -0,0 +1,28 @@
+//
+// Copyright Amazon.com Inc. or its affiliates.
+// All Rights Reserved.
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+
+import struct Smithy.AttributeKey
+import class Smithy.Context
+import class Smithy.ContextBuilder
+
+extension Context {
+
+    public func getIdempotencyTokenGenerator() -> IdempotencyTokenGenerator {
+        return attributes.get(key: idempotencyTokenGeneratorKey)!
+    }
+}
+
+extension ContextBuilder {
+
+    @discardableResult
+    public func withIdempotencyTokenGenerator(value: IdempotencyTokenGenerator) -> Self {
+        self.attributes.set(key: idempotencyTokenGeneratorKey, value: value)
+        return self
+    }
+}
+
+private let idempotencyTokenGeneratorKey = AttributeKey<IdempotencyTokenGenerator>(name: "IdempotencyTokenGeneratorKey")