refactor(core): Add support for useragent to add platform info (#722)

Author: royjit

AmplifyPlugins/Core/AWSPluginsCore/ServiceConfiguration/AmplifyAWSServiceConfiguration.swift

@@ -9,15 +9,16 @@ import Foundation
 import AWSCore
 
 public class AmplifyAWSServiceConfiguration: AWSServiceConfiguration {
+    private static let version = "1.1.0"
+
     override public class func baseUserAgent() -> String! {
         //TODO: Retrieve this version from a centralized location:
         //https://github.com/aws-amplify/amplify-ios/issues/276
-        let version = "1.1.0"
-        let sdkName = "amplify-iOS"
+        let platformInfo = AmplifyAWSServiceConfiguration.platformInformation()
         let systemName = UIDevice.current.systemName.replacingOccurrences(of: " ", with: "-")
         let systemVersion = UIDevice.current.systemVersion
         let localeIdentifier = Locale.current.identifier
-        return "\(sdkName)/\(version) \(systemName)/\(systemVersion) \(localeIdentifier)"
+        return "\(platformInfo) \(systemName)/\(systemVersion) \(localeIdentifier)"
     }
 
     override public var userAgent: String {
@@ -41,3 +42,22 @@ public class AmplifyAWSServiceConfiguration: AWSServiceConfiguration {
         super.init(region: regionType, credentialsProvider: nil)
     }
 }
+
+extension AmplifyAWSServiceConfiguration {
+
+    static var platformMapping: [Platform: String] = [:]
+
+    public static func addUserAgentPlatform(_ platform: Platform, version: String) {
+        platformMapping[platform] = version
+    }
+
+    public enum Platform: String {
+        case flutter = "amplify-flutter"
+    }
+
+    static func platformInformation() -> String {
+        var platformTokens = platformMapping.map { "\($0.rawValue)/\($1)" }
+        platformTokens.append("amplify-iOS/\(version)")
+        return platformTokens.joined(separator: " ")
+    }
+}

AmplifyPlugins/Core/AWSPluginsCoreTests/ServiceConfiguration/AmplifyAWSServiceConfigurationTests.swift

@@ -10,14 +10,26 @@ import XCTest
 
 class AmplifyAWSServiceConfigurationTests: XCTestCase {
     let credentialProvider = AWSAuthService().getCredentialsProvider()
+
+    override func tearDown() {
+        AmplifyAWSServiceConfiguration.platformMapping = [:]
+    }
+
+    /// Test initiating AmplifyAWSServiceConfiguration
+    ///
+    /// - Given: Amplify library
+    /// - When:
+    ///    - I call AmplifyAWSServiceConfiguration with credential provider
+    /// - Then:
+    ///    - AmplifyAWSServiceConfiguration should be configured properly
+    ///
     func testInstantiation() {
         let currentSystemName = UIDevice.current.systemName.replacingOccurrences(of: " ", with: "-")
         let currentSystemVersion = UIDevice.current.systemVersion
         let expectedLocale = Locale.current.identifier
         let expectedSystem = "\(currentSystemName)/\(currentSystemVersion)"
 
-        let configuration = AmplifyAWSServiceConfiguration(region: .USEast1,
-                                                           credentialsProvider: credentialProvider)
+        let configuration = AmplifyAWSServiceConfiguration(region: .USEast1, credentialsProvider: credentialProvider)
 
         XCTAssertNotNil(configuration.userAgent)
         let userAgentParts = configuration.userAgent.components(separatedBy: " ")
@@ -26,4 +38,30 @@ class AmplifyAWSServiceConfigurationTests: XCTestCase {
         XCTAssertEqual(expectedSystem, userAgentParts[1])
         XCTAssertEqual(expectedLocale, userAgentParts[2])
     }
+
+    /// Test adding a new platform to AmplifyAWSServiceConfiguration
+    ///
+    /// - Given: Amplify library
+    /// - When:
+    ///    - I add a new platform to the AmplifyAWSServiceConfiguration
+    /// - Then:
+    ///    - AmplifyAWSServiceConfiguration should be configured properly with the new platform added.
+    ///
+    func testAddNewPlatform() {
+        AmplifyAWSServiceConfiguration.addUserAgentPlatform(.flutter, version: "1.1")
+        let currentSystemName = UIDevice.current.systemName.replacingOccurrences(of: " ", with: "-")
+        let currentSystemVersion = UIDevice.current.systemVersion
+        let expectedLocale = Locale.current.identifier
+        let expectedSystem = "\(currentSystemName)/\(currentSystemVersion)"
+        let expectedPlatform = "\(AmplifyAWSServiceConfiguration.Platform.flutter.rawValue)/1.1"
+        let configuration = AmplifyAWSServiceConfiguration()
+
+        XCTAssertNotNil(configuration.userAgent)
+        let userAgentParts = configuration.userAgent.components(separatedBy: " ")
+        XCTAssertEqual(4, userAgentParts.count)
+        XCTAssertEqual(expectedPlatform, userAgentParts[0])
+        XCTAssert(userAgentParts[1].starts(with: "amplify-iOS/"))
+        XCTAssertEqual(expectedSystem, userAgentParts[2])
+        XCTAssertEqual(expectedLocale, userAgentParts[3])
+    }
 }