fix: update user agent values to be consistent across plugins (#3178)

* fix: update user agent for Geo, Logging, and API plugins

* chore: code cleanup

* chore: resolve per review comment

* chore: code cleanup

Author: phantumcode

AmplifyPlugins/API/Sources/AWSAPIPlugin/AWSAPIPluginsCore.swift

@@ -11,6 +11,7 @@ import Foundation
 
 struct APIKeyURLRequestInterceptor: URLRequestInterceptor {
 
+    private let userAgent = AmplifyAWSServiceConfiguration.frameworkMetaData().description
     let apiKeyProvider: APIKeyProvider
 
     init(apiKeyProvider: APIKeyProvider) {
@@ -20,10 +21,8 @@ struct APIKeyURLRequestInterceptor: URLRequestInterceptor {
     func intercept(_ request: URLRequest) -> URLRequest {
         var modifiedRequest = request
         let apiKey = apiKeyProvider.getAPIKey()
-        modifiedRequest.addValue(apiKey,
-                                 forHTTPHeaderField: URLRequestConstants.Header.xApiKey)
-        modifiedRequest.setValue(AWSAPIPluginsCore.baseUserAgent(),
-                                 forHTTPHeaderField: URLRequestConstants.Header.userAgent)
+        modifiedRequest.addValue(apiKey, forHTTPHeaderField: URLRequestConstants.Header.xApiKey)
+        modifiedRequest.setValue(userAgent, forHTTPHeaderField: URLRequestConstants.Header.userAgent)
 
         return modifiedRequest
     }

AmplifyPlugins/API/Sources/AWSAPIPlugin/Interceptor/RequestInterceptor/APIKeyURLRequestInterceptor.swift

@@ -10,7 +10,10 @@ import AWSPluginsCore
 import Foundation
 
 struct AuthTokenURLRequestInterceptor: URLRequestInterceptor {
-
+    
+    static let AWSDateISO8601DateFormat2 = "yyyyMMdd'T'HHmmss'Z'"
+    
+    private let userAgent = AmplifyAWSServiceConfiguration.frameworkMetaData().description
     let authTokenProvider: AuthTokenProvider
 
     init(authTokenProvider: AuthTokenProvider) {
@@ -24,14 +27,14 @@ struct AuthTokenURLRequestInterceptor: URLRequestInterceptor {
         }
         let date = Date()
         let dateFormatter = DateFormatter()
-        dateFormatter.dateFormat = AWSAPIPluginsCore.AWSDateISO8601DateFormat2
+        dateFormatter.dateFormat = Self.AWSDateISO8601DateFormat2
         let amzDate = dateFormatter.string(from: date)
 
         mutableRequest.setValue(amzDate,
                                 forHTTPHeaderField: URLRequestConstants.Header.xAmzDate)
         mutableRequest.setValue(URLRequestConstants.ContentType.applicationJson,
                                 forHTTPHeaderField: URLRequestConstants.Header.contentType)
-        mutableRequest.setValue(AWSAPIPluginsCore.baseUserAgent(),
+        mutableRequest.setValue(userAgent,
                                 forHTTPHeaderField: URLRequestConstants.Header.userAgent)
 
         let token: String

AmplifyPlugins/API/Sources/AWSAPIPlugin/Interceptor/RequestInterceptor/AuthTokenURLRequestInterceptor.swift

@@ -16,7 +16,8 @@ struct IAMURLRequestInterceptor: URLRequestInterceptor {
     let iamCredentialsProvider: IAMCredentialsProvider
     let region: AWSRegionType
     let endpointType: AWSAPICategoryPluginEndpointType
-
+    private let userAgent = AmplifyAWSServiceConfiguration.frameworkMetaData().description
+    
     init(iamCredentialsProvider: IAMCredentialsProvider,
          region: AWSRegionType,
          endpointType: AWSAPICategoryPluginEndpointType) {
@@ -37,7 +38,7 @@ struct IAMURLRequestInterceptor: URLRequestInterceptor {
 
         request.setValue(URLRequestConstants.ContentType.applicationJson, forHTTPHeaderField: URLRequestConstants.Header.contentType)
         request.setValue(host, forHTTPHeaderField: "host")
-        request.setValue(AWSAPIPluginsCore.baseUserAgent(), forHTTPHeaderField: URLRequestConstants.Header.userAgent)
+        request.setValue(userAgent, forHTTPHeaderField: URLRequestConstants.Header.userAgent)
 
         let httpMethod = (request.httpMethod?.uppercased())
             .flatMap(HttpMethodType.init(rawValue:)) ?? .get

AmplifyPlugins/API/Sources/AWSAPIPlugin/Interceptor/RequestInterceptor/IAMURLRequestInterceptor.swift

@@ -21,6 +21,7 @@ public class AWSGraphQLSubscriptionTaskRunner<R: Decodable>: InternalTaskRunner,
     let subscriptionConnectionFactory: SubscriptionConnectionFactory
     let authService: AWSAuthServiceBehavior
     var apiAuthProviderFactory: APIAuthProviderFactory
+    private let userAgent = AmplifyAWSServiceConfiguration.frameworkMetaData().description
 
     var subscriptionConnection: SubscriptionConnection?
     var subscriptionItem: SubscriptionItem?
@@ -112,7 +113,7 @@ public class AWSGraphQLSubscriptionTaskRunner<R: Decodable>: InternalTaskRunner,
         from endpointConfig: AWSAPICategoryPluginConfiguration.EndpointConfig
     ) -> URLRequest {
         var urlRequest = URLRequest(url: endpointConfig.baseURL)
-        urlRequest.setValue(AWSAPIPluginsCore.baseUserAgent(), forHTTPHeaderField: URLRequestConstants.Header.userAgent)
+        urlRequest.setValue(userAgent, forHTTPHeaderField: URLRequestConstants.Header.userAgent)
         return urlRequest
     }
 
@@ -202,7 +203,8 @@ final public class AWSGraphQLSubscriptionOperation<R: Decodable>: GraphQLSubscri
     let pluginConfig: AWSAPICategoryPluginConfiguration
     let subscriptionConnectionFactory: SubscriptionConnectionFactory
     let authService: AWSAuthServiceBehavior
-
+    private let userAgent = AmplifyAWSServiceConfiguration.frameworkMetaData().description
+    
     var subscriptionConnection: SubscriptionConnection?
     var subscriptionItem: SubscriptionItem?
     var apiAuthProviderFactory: APIAuthProviderFactory
@@ -311,7 +313,7 @@ final public class AWSGraphQLSubscriptionOperation<R: Decodable>: GraphQLSubscri
         from endpointConfig: AWSAPICategoryPluginConfiguration.EndpointConfig
     ) -> URLRequest {
         var urlRequest = URLRequest(url: endpointConfig.baseURL)
-        urlRequest.setValue(AWSAPIPluginsCore.baseUserAgent(), forHTTPHeaderField: URLRequestConstants.Header.userAgent)
+        urlRequest.setValue(userAgent, forHTTPHeaderField: URLRequestConstants.Header.userAgent)
         return urlRequest
     }
 

AmplifyPlugins/API/Sources/AWSAPIPlugin/Operation/AWSGraphQLSubscriptionTaskRunner.swift

@@ -32,6 +32,7 @@ extension AWSLocationGeoPlugin {
         let region = configuration.regionName
         let serviceConfiguration = try LocationClient.LocationClientConfiguration(
             credentialsProvider: credentialsProvider,
+            frameworkMetadata: AmplifyAWSServiceConfiguration.frameworkMetaData(),
             region: region)
 
         let location = LocationClient(config: serviceConfiguration)

AmplifyPlugins/Geo/Sources/AWSLocationGeoPlugin/AWSLocationGeoPlugin+Configure.swift

@@ -104,6 +104,7 @@ final class AWSCloudWatchLoggingSessionController {
         if self.client == nil {
             let configuration = try CloudWatchLogsClient.CloudWatchLogsClientConfiguration(
                 credentialsProvider: credentialsProvider,
+                frameworkMetadata: AmplifyAWSServiceConfiguration.frameworkMetaData(),
                 region: region
             )
             self.client = CloudWatchLogsClient(config: configuration)