feat: add iOS model parser (#12)

zhu-xiaowei · xiaoweii · web-flow · commit 974c4bac650e · 2023-05-30T14:54:11.000+08:00
Co-authored-by: xiaoweii &lt;xiaoweii@amazom.com&gt;
diff --git a/Sources/Clickstream/Dependency/Clickstream/System/SystemInfo.swift b/Sources/Clickstream/Dependency/Clickstream/System/SystemInfo.swift
@@ -33,7 +33,7 @@ class SystemInfo {
             if idfa == "00000000-0000-0000-0000-000000000000" {
                 self.idfa = ""
             }
-            self.model = UIDevice.current.name
+            self.model = Self.getModel(identifier: Self.identifier)
             self.osVersion = UIDevice.current.systemVersion
             self.screenWidth = Int(UIScreen.main.bounds.size.width * UIScreen.main.scale)
             self.screenHeight = Int(UIScreen.main.bounds.size.height * UIScreen.main.scale)
@@ -60,4 +60,81 @@ class SystemInfo {
             return "UNKNOWN"
         #endif
     }
+
+    private(set) static var identifier: String = {
+        var systemInfo = utsname()
+        uname(&systemInfo)
+        let mirror = Mirror(reflecting: systemInfo.machine)
+        let identifier = mirror.children.reduce("") { identifier, element in
+            guard let value = element.value as? Int8, value != 0 else { return identifier }
+            return identifier + String(UnicodeScalar(UInt8(value)))
+        }
+        return identifier
+    }()
+
+    // swiftlint:disable cyclomatic_complexity
+    static func getModel(identifier: String) -> String {
+        switch identifier {
+        case "iPod9,1": return "iPod touch (7th generation)"
+        case "iPhone8,1": return "iPhone 6s"
+        case "iPhone8,2": return "iPhone 6s Plus"
+        case "iPhone9,1", "iPhone9,3": return "iPhone 7"
+        case "iPhone9,2", "iPhone9,4": return "iPhone 7 Plus"
+        case "iPhone8,4": return "iPhone SE"
+        case "iPhone10,1", "iPhone10,4": return "iPhone 8"
+        case "iPhone10,2", "iPhone10,5": return "iPhone 8 Plus"
+        case "iPhone10,3", "iPhone10,6": return "iPhone X"
+        case "iPhone11,2": return "iPhone Xs"
+        case "iPhone11,4", "iPhone11,6": return "iPhone Xs Max"
+        case "iPhone11,8": return "iPhone XR"
+        case "iPhone12,1": return "iPhone 11"
+        case "iPhone12,3": return "iPhone 11 Pro"
+        case "iPhone12,5": return "iPhone 11 Pro Max"
+        case "iPhone12,8": return "iPhone SE (2nd generation)"
+        case "iPhone13,2": return "iPhone 12"
+        case "iPhone13,1": return "iPhone 12 mini"
+        case "iPhone13,3": return "iPhone 12 Pro"
+        case "iPhone13,4": return "iPhone 12 Pro Max"
+        case "iPhone14,5": return "iPhone 13"
+        case "iPhone14,4": return "iPhone 13 mini"
+        case "iPhone14,2": return "iPhone 13 Pro"
+        case "iPhone14,3": return "iPhone 13 Pro Max"
+        case "iPhone14,6": return "iPhone SE (3rd generation)"
+        case "iPhone14,7": return "iPhone 14"
+        case "iPhone14,8": return "iPhone 14 Plus"
+        case "iPhone15,2": return "iPhone 14 Pro"
+        case "iPhone15,3": return "iPhone 14 Pro Max"
+        case "iPad5,3", "iPad5,4": return "iPad Air 2"
+        case "iPad6,11", "iPad6,12": return "iPad (5th generation)"
+        case "iPad7,5", "iPad7,6": return "iPad (6th generation)"
+        case "iPad11,3", "iPad11,4": return "iPad Air (3rd generation)"
+        case "iPad7,11", "iPad7,12": return "iPad (7th generation)"
+        case "iPad11,6", "iPad11,7": return "iPad (8th generation)"
+        case "iPad12,1", "iPad12,2": return "iPad (9th generation)"
+        case "iPad13,18", "iPad13,19": return "iPad (10th generation)"
+        case "iPad13,1", "iPad13,2": return "iPad Air (4th generation)"
+        case "iPad13,16", "iPad13,17": return "iPad Air (5th generation)"
+        case "iPad4,7", "iPad4,8", "iPad4,9": return "iPad Mini 3"
+        case "iPad5,1", "iPad5,2": return "iPad Mini 4"
+        case "iPad11,1", "iPad11,2": return "iPad Mini (5th generation)"
+        case "iPad14,1", "iPad14,2": return "iPad Mini (6th generation)"
+        case "iPad6,3", "iPad6,4": return "iPad Pro (9.7-inch)"
+        case "iPad6,7", "iPad6,8": return "iPad Pro (12.9-inch)"
+        case "iPad7,1", "iPad7,2": return "iPad Pro (12.9-inch) (2nd generation)"
+        case "iPad7,3", "iPad7,4": return "iPad Pro (10.5-inch)"
+        case "iPad8,1", "iPad8,2", "iPad8,3", "iPad8,4": return "iPad Pro (11-inch)"
+        case "iPad8,5", "iPad8,6", "iPad8,7", "iPad8,8": return "iPad Pro (12.9-inch) (3rd generation)"
+        case "iPad8,9", "iPad8,10": return "iPad Pro (11-inch) (2nd generation)"
+        case "iPad8,11", "iPad8,12": return "iPad Pro (12.9-inch) (4th generation)"
+        case "iPad13,4", "iPad13,5", "iPad13,6", "iPad13,7": return "iPad Pro (11-inch) (3rd generation)"
+        case "iPad13,8", "iPad13,9", "iPad13,10", "iPad13,11": return "iPad Pro (12.9-inch) (5th generation)"
+        case "iPad14,3", "iPad14,4": return "iPad Pro (11-inch) (4th generation)"
+        case "iPad14,5", "iPad14,6": return "iPad Pro (12.9-inch) (6th generation)"
+        case "i386", "x86_64", "arm64": return getModel(identifier:
+                ProcessInfo().environment["SIMULATOR_MODEL_IDENTIFIER"] ?? "iOS")
+        default:
+            return identifier
+        }
+    }
+    // swiftlint:enable cyclomatic_complexity
 }
diff --git a/Sources/Clickstream/PackageInfo.swift b/Sources/Clickstream/PackageInfo.swift
@@ -8,5 +8,5 @@
 enum PackageInfo {
     /// the clickstream analytics iOS sdk version
     /// note: update and align the version with new tag version before committing new tag
-    static let version = "0.4.1"
+    static let version = "0.4.2"
 }
diff --git a/Tests/ClickstreamTests/Clickstream/SystemInfoTest.swift b/Tests/ClickstreamTests/Clickstream/SystemInfoTest.swift
@@ -0,0 +1,122 @@
+//
+// Copyright Amazon.com Inc. or its affiliates.
+// All Rights Reserved.
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+
+@testable import Clickstream
+import XCTest
+
+class SystemInfoTest: XCTestCase {
+    func testGetIdentifierNotNil() {
+        XCTAssertNotNil(SystemInfo.identifier)
+    }
+
+    func testGetModelForSimulator() {
+        XCTAssertTrue(SystemInfo.getModel(identifier: "arm64").starts(with: "iPhone"))
+    }
+
+    func testGetModelFor_iPhone() {
+        XCTAssertEqual("iPhone 7", SystemInfo.getModel(identifier: "iPhone9,1"))
+        XCTAssertEqual("iPhone 7", SystemInfo.getModel(identifier: "iPhone9,3"))
+        XCTAssertEqual("iPhone 7 Plus", SystemInfo.getModel(identifier: "iPhone9,2"))
+        XCTAssertEqual("iPhone 7 Plus", SystemInfo.getModel(identifier: "iPhone9,4"))
+        XCTAssertEqual("iPhone SE", SystemInfo.getModel(identifier: "iPhone8,4"))
+        XCTAssertEqual("iPhone 8", SystemInfo.getModel(identifier: "iPhone10,1"))
+        XCTAssertEqual("iPhone 8", SystemInfo.getModel(identifier: "iPhone10,4"))
+        XCTAssertEqual("iPhone X", SystemInfo.getModel(identifier: "iPhone10,3"))
+        XCTAssertEqual("iPhone X", SystemInfo.getModel(identifier: "iPhone10,6"))
+        XCTAssertEqual("iPhone Xs", SystemInfo.getModel(identifier: "iPhone11,2"))
+        XCTAssertEqual("iPhone Xs Max", SystemInfo.getModel(identifier: "iPhone11,4"))
+        XCTAssertEqual("iPhone Xs Max", SystemInfo.getModel(identifier: "iPhone11,6"))
+        XCTAssertEqual("iPhone XR", SystemInfo.getModel(identifier: "iPhone11,8"))
+        XCTAssertEqual("iPhone 11", SystemInfo.getModel(identifier: "iPhone12,1"))
+        XCTAssertEqual("iPhone 11 Pro", SystemInfo.getModel(identifier: "iPhone12,3"))
+        XCTAssertEqual("iPhone 11 Pro Max", SystemInfo.getModel(identifier: "iPhone12,5"))
+        XCTAssertEqual("iPhone SE (2nd generation)", SystemInfo.getModel(identifier: "iPhone12,8"))
+        XCTAssertEqual("iPhone 12", SystemInfo.getModel(identifier: "iPhone13,2"))
+        XCTAssertEqual("iPhone 12 mini", SystemInfo.getModel(identifier: "iPhone13,1"))
+        XCTAssertEqual("iPhone 12 Pro", SystemInfo.getModel(identifier: "iPhone13,3"))
+        XCTAssertEqual("iPhone 12 Pro Max", SystemInfo.getModel(identifier: "iPhone13,4"))
+        XCTAssertEqual("iPhone 13", SystemInfo.getModel(identifier: "iPhone14,5"))
+        XCTAssertEqual("iPhone 13 mini", SystemInfo.getModel(identifier: "iPhone14,4"))
+        XCTAssertEqual("iPhone 13 Pro", SystemInfo.getModel(identifier: "iPhone14,2"))
+        XCTAssertEqual("iPhone 13 Pro Max", SystemInfo.getModel(identifier: "iPhone14,3"))
+        XCTAssertEqual("iPhone SE (3rd generation)", SystemInfo.getModel(identifier: "iPhone14,6"))
+        XCTAssertEqual("iPhone 14", SystemInfo.getModel(identifier: "iPhone14,7"))
+        XCTAssertEqual("iPhone 14 Plus", SystemInfo.getModel(identifier: "iPhone14,8"))
+        XCTAssertEqual("iPhone 14 Pro", SystemInfo.getModel(identifier: "iPhone15,2"))
+        XCTAssertEqual("iPhone 14 Pro Max", SystemInfo.getModel(identifier: "iPhone15,3"))
+    }
+
+    func testGetModelFor_iPad() {
+        XCTAssertEqual("iPad Air 2", SystemInfo.getModel(identifier: "iPad5,3"))
+        XCTAssertEqual("iPad Air 2", SystemInfo.getModel(identifier: "iPad5,4"))
+        XCTAssertEqual("iPad (5th generation)", SystemInfo.getModel(identifier: "iPad6,11"))
+        XCTAssertEqual("iPad (5th generation)", SystemInfo.getModel(identifier: "iPad6,12"))
+        XCTAssertEqual("iPad (6th generation)", SystemInfo.getModel(identifier: "iPad7,5"))
+        XCTAssertEqual("iPad (6th generation)", SystemInfo.getModel(identifier: "iPad7,6"))
+        XCTAssertEqual("iPad Air (3rd generation)", SystemInfo.getModel(identifier: "iPad11,3"))
+        XCTAssertEqual("iPad Air (3rd generation)", SystemInfo.getModel(identifier: "iPad11,4"))
+        XCTAssertEqual("iPad (7th generation)", SystemInfo.getModel(identifier: "iPad7,11"))
+        XCTAssertEqual("iPad (7th generation)", SystemInfo.getModel(identifier: "iPad7,12"))
+        XCTAssertEqual("iPad (8th generation)", SystemInfo.getModel(identifier: "iPad11,6"))
+        XCTAssertEqual("iPad (8th generation)", SystemInfo.getModel(identifier: "iPad11,7"))
+        XCTAssertEqual("iPad (9th generation)", SystemInfo.getModel(identifier: "iPad12,1"))
+        XCTAssertEqual("iPad (9th generation)", SystemInfo.getModel(identifier: "iPad12,2"))
+        XCTAssertEqual("iPad (10th generation)", SystemInfo.getModel(identifier: "iPad13,18"))
+        XCTAssertEqual("iPad (10th generation)", SystemInfo.getModel(identifier: "iPad13,19"))
+        XCTAssertEqual("iPad Air (4th generation)", SystemInfo.getModel(identifier: "iPad13,1"))
+        XCTAssertEqual("iPad Air (4th generation)", SystemInfo.getModel(identifier: "iPad13,2"))
+        XCTAssertEqual("iPad Air (5th generation)", SystemInfo.getModel(identifier: "iPad13,16"))
+        XCTAssertEqual("iPad Air (5th generation)", SystemInfo.getModel(identifier: "iPad13,17"))
+        XCTAssertEqual("iPad Mini 3", SystemInfo.getModel(identifier: "iPad4,7"))
+        XCTAssertEqual("iPad Mini 3", SystemInfo.getModel(identifier: "iPad4,8"))
+        XCTAssertEqual("iPad Mini 3", SystemInfo.getModel(identifier: "iPad4,9"))
+        XCTAssertEqual("iPad Mini (5th generation)", SystemInfo.getModel(identifier: "iPad11,1"))
+        XCTAssertEqual("iPad Mini (5th generation)", SystemInfo.getModel(identifier: "iPad11,2"))
+        XCTAssertEqual("iPad Mini (6th generation)", SystemInfo.getModel(identifier: "iPad14,1"))
+        XCTAssertEqual("iPad Mini (6th generation)", SystemInfo.getModel(identifier: "iPad14,2"))
+        XCTAssertEqual("iPad Pro (9.7-inch)", SystemInfo.getModel(identifier: "iPad6,3"))
+        XCTAssertEqual("iPad Pro (9.7-inch)", SystemInfo.getModel(identifier: "iPad6,4"))
+        XCTAssertEqual("iPad Pro (12.9-inch)", SystemInfo.getModel(identifier: "iPad6,7"))
+        XCTAssertEqual("iPad Pro (12.9-inch)", SystemInfo.getModel(identifier: "iPad6,8"))
+        XCTAssertEqual("iPad Pro (12.9-inch) (2nd generation)", SystemInfo.getModel(identifier: "iPad7,1"))
+        XCTAssertEqual("iPad Pro (12.9-inch) (2nd generation)", SystemInfo.getModel(identifier: "iPad7,2"))
+        XCTAssertEqual("iPad Pro (10.5-inch)", SystemInfo.getModel(identifier: "iPad7,3"))
+        XCTAssertEqual("iPad Pro (10.5-inch)", SystemInfo.getModel(identifier: "iPad7,4"))
+        XCTAssertEqual("iPad Pro (11-inch)", SystemInfo.getModel(identifier: "iPad8,1"))
+        XCTAssertEqual("iPad Pro (11-inch)", SystemInfo.getModel(identifier: "iPad8,2"))
+        XCTAssertEqual("iPad Pro (11-inch)", SystemInfo.getModel(identifier: "iPad8,3"))
+        XCTAssertEqual("iPad Pro (11-inch)", SystemInfo.getModel(identifier: "iPad8,4"))
+        XCTAssertEqual("iPad Pro (12.9-inch) (3rd generation)", SystemInfo.getModel(identifier: "iPad8,5"))
+        XCTAssertEqual("iPad Pro (12.9-inch) (3rd generation)", SystemInfo.getModel(identifier: "iPad8,6"))
+        XCTAssertEqual("iPad Pro (12.9-inch) (3rd generation)", SystemInfo.getModel(identifier: "iPad8,7"))
+        XCTAssertEqual("iPad Pro (12.9-inch) (3rd generation)", SystemInfo.getModel(identifier: "iPad8,8"))
+        XCTAssertEqual("iPad Pro (11-inch) (2nd generation)", SystemInfo.getModel(identifier: "iPad8,9"))
+        XCTAssertEqual("iPad Pro (11-inch) (2nd generation)", SystemInfo.getModel(identifier: "iPad8,10"))
+        XCTAssertEqual("iPad Pro (12.9-inch) (4th generation)", SystemInfo.getModel(identifier: "iPad8,11"))
+        XCTAssertEqual("iPad Pro (12.9-inch) (4th generation)", SystemInfo.getModel(identifier: "iPad8,12"))
+        XCTAssertEqual("iPad Pro (11-inch) (3rd generation)", SystemInfo.getModel(identifier: "iPad13,4"))
+        XCTAssertEqual("iPad Pro (11-inch) (3rd generation)", SystemInfo.getModel(identifier: "iPad13,5"))
+        XCTAssertEqual("iPad Pro (11-inch) (3rd generation)", SystemInfo.getModel(identifier: "iPad13,6"))
+        XCTAssertEqual("iPad Pro (11-inch) (3rd generation)", SystemInfo.getModel(identifier: "iPad13,7"))
+        XCTAssertEqual("iPad Pro (12.9-inch) (5th generation)", SystemInfo.getModel(identifier: "iPad13,8"))
+        XCTAssertEqual("iPad Pro (12.9-inch) (5th generation)", SystemInfo.getModel(identifier: "iPad13,9"))
+        XCTAssertEqual("iPad Pro (12.9-inch) (5th generation)", SystemInfo.getModel(identifier: "iPad13,10"))
+        XCTAssertEqual("iPad Pro (12.9-inch) (5th generation)", SystemInfo.getModel(identifier: "iPad13,11"))
+        XCTAssertEqual("iPad Pro (11-inch) (4th generation)", SystemInfo.getModel(identifier: "iPad14,3"))
+        XCTAssertEqual("iPad Pro (11-inch) (4th generation)", SystemInfo.getModel(identifier: "iPad14,4"))
+        XCTAssertEqual("iPad Pro (12.9-inch) (6th generation)", SystemInfo.getModel(identifier: "iPad14,5"))
+        XCTAssertEqual("iPad Pro (12.9-inch) (6th generation)", SystemInfo.getModel(identifier: "iPad14,6"))
+    }
+
+    func testGetModelFor_iPod() {
+        XCTAssertEqual("iPod touch (7th generation)", SystemInfo.getModel(identifier: "iPod9,1"))
+    }
+
+    func testGetModelFor_UnKnow() {
+        XCTAssertEqual("iPhone100,1", SystemInfo.getModel(identifier: "iPhone100,1"))
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -8,5 +8,5 @@`
`8`	`8`	`enum PackageInfo {`
`9`	`9`	`/// the clickstream analytics iOS sdk version`
`10`	`10`	`/// note: update and align the version with new tag version before committing new tag`
`11`		`- static let version = "0.4.1"`
	`11`	`+ static let version = "0.4.2"`
`12`	`12`	`}`