feat: expose ability to set framework in useragent (#494)

wooj2 · web-flow · commit e3e4097b1a34 · 2021-11-12T13:18:27.000-08:00
diff --git a/AWSClientRuntime/Sources/AWSClientConfiguration.swift b/AWSClientRuntime/Sources/AWSClientConfiguration.swift
@@ -11,6 +11,7 @@ public protocol AWSRuntimeConfiguration {
     var signingRegion: String? {get set}
     var endpointResolver: EndpointResolver {get set}
     var regionResolver: RegionResolver {get set}
+    var frameworkMetadata: FrameworkMetadata? {get set}
 }
 
 public typealias AWSClientConfiguration = SDKRuntimeConfiguration & AWSRuntimeConfiguration
diff --git a/AWSClientRuntime/Sources/Http/AWSUserAgentMetadata.swift b/AWSClientRuntime/Sources/Http/AWSUserAgentMetadata.swift
@@ -59,7 +59,7 @@ public struct AWSUserAgentMetadata {
         self.frameworkMetadata = frameworkMetadata
     }
     
-    public static func fromEnv(apiMetadata: APIMetadata) -> AWSUserAgentMetadata {
+    public static func fromEnv(apiMetadata: APIMetadata, frameworkMetadata: FrameworkMetadata? = nil) -> AWSUserAgentMetadata {
         let sdkMetadata = SDKMetadata(name: "swift", version: apiMetadata.version)
         // TODO: figure out a better way to get both current OS and version of that OS
         let osMetadata = OSMetadata(family: currentOS, version: nil)
@@ -68,6 +68,7 @@ public struct AWSUserAgentMetadata {
                                     apiMetadata: apiMetadata,
                                     osMetadata: osMetadata,
                                     languageMetadata: langMetadata,
-                                    executionEnvMetadata: ExecutionEnvMetadata.detectExecEnv())
+                                    executionEnvMetadata: ExecutionEnvMetadata.detectExecEnv(),
+                                    frameworkMetadata: frameworkMetadata)
     }
 }
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
@@ -39,6 +39,7 @@ object AWSClientRuntimeTypes {
         val RetryerMiddleware = runtimeSymbol("RetryerMiddleware")
         val EndpointResolverMiddleware = runtimeSymbol("EndpointResolverMiddleware")
         val EndpointResolver = runtimeSymbol("EndpointResolver")
+        val FrameworkMetadata = runtimeSymbol("FrameworkMetadata")
         val CredentialsProvider = runtimeSymbol("CredentialsProvider")
         val AWSCredentialsProvider = runtimeSymbol("AWSCredentialsProvider")
         val AWSClientConfiguration = runtimeSymbol("AWSClientConfiguration")
diff --git a/codegen/smithy-aws-swift-codegen/src/main/kotlin/software/amazon/smithy/aws/swift/codegen/AWSServiceConfig.kt b/codegen/smithy-aws-swift-codegen/src/main/kotlin/software/amazon/smithy/aws/swift/codegen/AWSServiceConfig.kt
@@ -12,11 +12,12 @@ import software.amazon.smithy.swift.codegen.SwiftWriter
 import software.amazon.smithy.swift.codegen.integration.ConfigField
 import software.amazon.smithy.swift.codegen.integration.ServiceConfig
 
-const val REGION_CONFIG_NAME = "region"
 const val CREDENTIALS_PROVIDER_CONFIG_NAME = "credentialsProvider"
-const val SIGNING_REGION_CONFIG_NAME = "signingRegion"
 const val ENDPOINT_RESOLVER = "endpointResolver"
+const val FRAMEWORK_METADATA = "frameworkMetadata"
+const val REGION_CONFIG_NAME = "region"
 const val REGION_RESOLVER = "regionResolver"
+const val SIGNING_REGION_CONFIG_NAME = "signingRegion"
 
 class AWSServiceConfig(writer: SwiftWriter, serviceName: String) : ServiceConfig(writer, serviceName) {
     override val typesToConformConfigTo: List<Symbol>
@@ -41,6 +42,7 @@ class AWSServiceConfig(writer: SwiftWriter, serviceName: String) : ServiceConfig
         }
         writer.indent().write("self.credentialsProvider = try \$N.fromChain()", AWSClientRuntimeTypes.Core.AWSCredentialsProvider)
         writer.dedent().write("}")
+        writer.write("self.frameworkMetadata = frameworkMetadata")
         val runtimeTimeConfigFields = sdkRuntimeConfigProperties()
         runtimeTimeConfigFields.forEach {
             writer.write("self.${it.memberName} = runtimeConfig.${it.memberName}")
@@ -68,22 +70,28 @@ class AWSServiceConfig(writer: SwiftWriter, serviceName: String) : ServiceConfig
 
     override fun otherRuntimeConfigProperties(): List<ConfigField> {
         return listOf(
-            ConfigField(
-                REGION_CONFIG_NAME,
-                SwiftTypes.String,
-                "\$T",
-                "The region to send requests to. (Required)"
-            ),
             ConfigField(
                 CREDENTIALS_PROVIDER_CONFIG_NAME, AWSClientRuntimeTypes.Core.CredentialsProvider,
                 documentation = "The credentials provider to use to authenticate requests."
             ),
-            ConfigField(SIGNING_REGION_CONFIG_NAME, SwiftTypes.String, "\$T", "The region to sign requests in. (Required)"),
             ConfigField(
                 ENDPOINT_RESOLVER, AWSClientRuntimeTypes.Core.EndpointResolver,
                 documentation = "The endpoint resolver used to resolve endpoints."
             ),
-            ConfigField(REGION_RESOLVER, AWSClientRuntimeTypes.Core.RegionResolver, documentation = "The region resolver uses an array of region providers to resolve the region.")
+            ConfigField(
+                FRAMEWORK_METADATA,
+                AWSClientRuntimeTypes.Core.FrameworkMetadata,
+                formatter = "\$T",
+                documentation = "Contains information to inject lib/ into user-agent"
+            ),
+            ConfigField(
+                REGION_CONFIG_NAME,
+                SwiftTypes.String,
+                "\$T",
+                "The region to send requests to. (Required)"
+            ),
+            ConfigField(REGION_RESOLVER, AWSClientRuntimeTypes.Core.RegionResolver, documentation = "The region resolver uses an array of region providers to resolve the region."),
+            ConfigField(SIGNING_REGION_CONFIG_NAME, SwiftTypes.String, "\$T", "The region to sign requests in. (Required)")
         ).sortedBy { it.memberName }
     }
 }
diff --git a/codegen/smithy-aws-swift-codegen/src/main/kotlin/software/amazon/smithy/aws/swift/codegen/middleware/UserAgentMiddleware.kt b/codegen/smithy-aws-swift-codegen/src/main/kotlin/software/amazon/smithy/aws/swift/codegen/middleware/UserAgentMiddleware.kt
@@ -22,10 +22,11 @@ class UserAgentMiddleware(val settings: SwiftSettings) : MiddlewareRenderable {
     override val position = MiddlewarePosition.BEFORE
 
     override fun render(writer: SwiftWriter, op: OperationShape, operationStackName: String) {
+        writer.write("let apiMetadata = \$N(serviceId: serviceName, version: \"${settings.moduleVersion}\")", AWSClientRuntimeTypes.Core.APIMetadata)
         writer.write("$operationStackName.${middlewareStep.stringValue()}.intercept(position: ${position.stringValue()}, middleware: \$N(${middlewareParamsString()}))", AWSClientRuntimeTypes.Core.UserAgentMiddleware)
     }
 
     private fun middlewareParamsString(): String {
-        return "metadata: ${AWSClientRuntimeTypes.Core.AWSUserAgentMetadata}.fromEnv(apiMetadata: ${AWSClientRuntimeTypes.Core.APIMetadata}(serviceId: serviceName, version: \"${settings.moduleVersion}\"))"
+        return "metadata: ${AWSClientRuntimeTypes.Core.AWSUserAgentMetadata}.fromEnv(apiMetadata: apiMetadata, frameworkMetadata: config.frameworkMetadata)"
     }
 }
diff --git a/codegen/smithy-aws-swift-codegen/src/test/kotlin/software/amazon/smithy/aws/swift/codegen/PresignerGeneratorTests.kt b/codegen/smithy-aws-swift-codegen/src/test/kotlin/software/amazon/smithy/aws/swift/codegen/PresignerGeneratorTests.kt
@@ -44,7 +44,8 @@ class PresignerGeneratorTests {
                     operation.initializeStep.intercept(position: .after, middleware: GetFooInputURLPathMiddleware())
                     operation.initializeStep.intercept(position: .after, middleware: GetFooInputURLHostMiddleware())
                     operation.buildStep.intercept(position: .before, middleware: AWSClientRuntime.EndpointResolverMiddleware(endpointResolver: config.endpointResolver, serviceId: serviceName))
-                    operation.buildStep.intercept(position: .before, middleware: AWSClientRuntime.UserAgentMiddleware(metadata: AWSClientRuntime.AWSUserAgentMetadata.fromEnv(apiMetadata: AWSClientRuntime.APIMetadata(serviceId: serviceName, version: "1.0.0"))))
+                    let apiMetadata = AWSClientRuntime.APIMetadata(serviceId: serviceName, version: "1.0.0")
+                    operation.buildStep.intercept(position: .before, middleware: AWSClientRuntime.UserAgentMiddleware(metadata: AWSClientRuntime.AWSUserAgentMetadata.fromEnv(apiMetadata: apiMetadata, frameworkMetadata: config.frameworkMetadata)))
                     operation.serializeStep.intercept(position: .after, middleware: GetFooInputHeadersMiddleware())
                     operation.serializeStep.intercept(position: .after, middleware: GetFooInputQueryItemMiddleware())
                     operation.finalizeStep.intercept(position: .after, middleware: AWSClientRuntime.RetryerMiddleware(retryer: config.retryer))
@@ -99,7 +100,8 @@ class PresignerGeneratorTests {
                     operation.initializeStep.intercept(position: .after, middleware: PostFooInputURLPathMiddleware())
                     operation.initializeStep.intercept(position: .after, middleware: PostFooInputURLHostMiddleware())
                     operation.buildStep.intercept(position: .before, middleware: AWSClientRuntime.EndpointResolverMiddleware(endpointResolver: config.endpointResolver, serviceId: serviceName))
-                    operation.buildStep.intercept(position: .before, middleware: AWSClientRuntime.UserAgentMiddleware(metadata: AWSClientRuntime.AWSUserAgentMetadata.fromEnv(apiMetadata: AWSClientRuntime.APIMetadata(serviceId: serviceName, version: "1.0.0"))))
+                    let apiMetadata = AWSClientRuntime.APIMetadata(serviceId: serviceName, version: "1.0.0")
+                    operation.buildStep.intercept(position: .before, middleware: AWSClientRuntime.UserAgentMiddleware(metadata: AWSClientRuntime.AWSUserAgentMetadata.fromEnv(apiMetadata: apiMetadata, frameworkMetadata: config.frameworkMetadata)))
                     operation.serializeStep.intercept(position: .after, middleware: PostFooInputHeadersMiddleware())
                     operation.serializeStep.intercept(position: .after, middleware: PostFooInputQueryItemMiddleware())
                     operation.serializeStep.intercept(position: .after, middleware: ContentTypeMiddleware<PostFooInput, PostFooOutputResponse, PostFooOutputError>(contentType: "application/json"))
@@ -157,7 +159,8 @@ class PresignerGeneratorTests {
                     operation.initializeStep.intercept(position: .after, middleware: PutFooInputURLPathMiddleware())
                     operation.initializeStep.intercept(position: .after, middleware: PutFooInputURLHostMiddleware())
                     operation.buildStep.intercept(position: .before, middleware: AWSClientRuntime.EndpointResolverMiddleware(endpointResolver: config.endpointResolver, serviceId: serviceName))
-                    operation.buildStep.intercept(position: .before, middleware: AWSClientRuntime.UserAgentMiddleware(metadata: AWSClientRuntime.AWSUserAgentMetadata.fromEnv(apiMetadata: AWSClientRuntime.APIMetadata(serviceId: serviceName, version: "1.0.0"))))
+                    let apiMetadata = AWSClientRuntime.APIMetadata(serviceId: serviceName, version: "1.0.0")
+                    operation.buildStep.intercept(position: .before, middleware: AWSClientRuntime.UserAgentMiddleware(metadata: AWSClientRuntime.AWSUserAgentMetadata.fromEnv(apiMetadata: apiMetadata, frameworkMetadata: config.frameworkMetadata)))
                     operation.serializeStep.intercept(position: .after, middleware: PutFooInputHeadersMiddleware())
                     operation.serializeStep.intercept(position: .after, middleware: PutFooInputQueryItemMiddleware())
                     operation.serializeStep.intercept(position: .after, middleware: ContentTypeMiddleware<PutFooInput, PutFooOutputResponse, PutFooOutputError>(contentType: "application/json"))
diff --git a/codegen/smithy-aws-swift-codegen/src/test/kotlin/software/amazon/smithy/aws/swift/codegen/RestJsonProtocolGeneratorTests.kt b/codegen/smithy-aws-swift-codegen/src/test/kotlin/software/amazon/smithy/aws/swift/codegen/RestJsonProtocolGeneratorTests.kt
@@ -119,13 +119,15 @@ class RestJsonProtocolGeneratorTests {
             
                     public var credentialsProvider: AWSClientRuntime.CredentialsProvider
                     public var endpointResolver: AWSClientRuntime.EndpointResolver
+                    public var frameworkMetadata: AWSClientRuntime.FrameworkMetadata?
                     public var region: Swift.String?
                     public var regionResolver: AWSClientRuntime.RegionResolver
                     public var signingRegion: Swift.String?
             
                     public init(
                         credentialsProvider: AWSClientRuntime.CredentialsProvider? = nil,
                         endpointResolver: AWSClientRuntime.EndpointResolver? = nil,
+                        frameworkMetadata: AWSClientRuntime.FrameworkMetadata? = nil,
                         region: Swift.String? = nil,
                         regionResolver: AWSClientRuntime.RegionResolver? = nil,
                         signingRegion: Swift.String? = nil,
@@ -141,6 +143,7 @@ class RestJsonProtocolGeneratorTests {
                         } else {
                             self.credentialsProvider = try AWSClientRuntime.AWSCredentialsProvider.fromChain()
                         }
+                        self.frameworkMetadata = frameworkMetadata
                         self.clientLogMode = runtimeConfig.clientLogMode
                         self.decoder = runtimeConfig.decoder
                         self.encoder = runtimeConfig.encoder
@@ -154,12 +157,13 @@ class RestJsonProtocolGeneratorTests {
                     public convenience init(
                         credentialsProvider: AWSClientRuntime.CredentialsProvider? = nil,
                         endpointResolver: AWSClientRuntime.EndpointResolver? = nil,
+                        frameworkMetadata: AWSClientRuntime.FrameworkMetadata? = nil,
                         region: Swift.String? = nil,
                         regionResolver: AWSClientRuntime.RegionResolver? = nil,
                         signingRegion: Swift.String? = nil
                     ) throws {
                         let defaultRuntimeConfig = try ClientRuntime.DefaultSDKRuntimeConfiguration("ExampleClient")
-                        try self.init(credentialsProvider: credentialsProvider, endpointResolver: endpointResolver, region: region, regionResolver: regionResolver, signingRegion: signingRegion, runtimeConfig: defaultRuntimeConfig)
+                        try self.init(credentialsProvider: credentialsProvider, endpointResolver: endpointResolver, frameworkMetadata: frameworkMetadata, region: region, regionResolver: regionResolver, signingRegion: signingRegion, runtimeConfig: defaultRuntimeConfig)
                     }
                 }
             }

Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@ public protocol AWSRuntimeConfiguration {`
`11`	`11`	`var signingRegion: String? {get set}`
`12`	`12`	`var endpointResolver: EndpointResolver {get set}`
`13`	`13`	`var regionResolver: RegionResolver {get set}`
	`14`	`+ var frameworkMetadata: FrameworkMetadata? {get set}`
`14`	`15`	`}`
`15`	`16`
`16`	`17`	`public typealias AWSClientConfiguration = SDKRuntimeConfiguration & AWSRuntimeConfiguration`
Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@ public struct AWSUserAgentMetadata {`
`59`	`59`	`self.frameworkMetadata = frameworkMetadata`
`60`	`60`	`}`
`61`	`61`
`62`		`- public static func fromEnv(apiMetadata: APIMetadata) -> AWSUserAgentMetadata {`
	`62`	`+ public static func fromEnv(apiMetadata: APIMetadata, frameworkMetadata: FrameworkMetadata? = nil) -> AWSUserAgentMetadata {`
`63`	`63`	`let sdkMetadata = SDKMetadata(name: "swift", version: apiMetadata.version)`
`64`	`64`	`// TODO: figure out a better way to get both current OS and version of that OS`
`65`	`65`	`let osMetadata = OSMetadata(family: currentOS, version: nil)`
`@@ -68,6 +68,7 @@ public struct AWSUserAgentMetadata {`
`68`	`68`	`apiMetadata: apiMetadata,`
`69`	`69`	`osMetadata: osMetadata,`
`70`	`70`	`languageMetadata: langMetadata,`
`71`		`- executionEnvMetadata: ExecutionEnvMetadata.detectExecEnv())`
	`71`	`+ executionEnvMetadata: ExecutionEnvMetadata.detectExecEnv(),`
	`72`	`+ frameworkMetadata: frameworkMetadata)`
`72`	`73`	`}`
`73`	`74`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,10 +22,11 @@ class UserAgentMiddleware(val settings: SwiftSettings) : MiddlewareRenderable {`
`22`	`22`	`override val position = MiddlewarePosition.BEFORE`
`23`	`23`
`24`	`24`	`override fun render(writer: SwiftWriter, op: OperationShape, operationStackName: String) {`
	`25`	`+ writer.write("let apiMetadata = \$N(serviceId: serviceName, version: \"${settings.moduleVersion}\")", AWSClientRuntimeTypes.Core.APIMetadata)`
`25`	`26`	`writer.write("$operationStackName.${middlewareStep.stringValue()}.intercept(position: ${position.stringValue()}, middleware: \$N(${middlewareParamsString()}))", AWSClientRuntimeTypes.Core.UserAgentMiddleware)`
`26`	`27`	`}`
`27`	`28`
`28`	`29`	`private fun middlewareParamsString(): String {`
`29`		`- return "metadata: ${AWSClientRuntimeTypes.Core.AWSUserAgentMetadata}.fromEnv(apiMetadata: ${AWSClientRuntimeTypes.Core.APIMetadata}(serviceId: serviceName, version: \"${settings.moduleVersion}\"))"`
	`30`	`+ return "metadata: ${AWSClientRuntimeTypes.Core.AWSUserAgentMetadata}.fromEnv(apiMetadata: apiMetadata, frameworkMetadata: config.frameworkMetadata)"`
`30`	`31`	`}`
`31`	`32`	`}`