Merge pull request #21 from instana/feature/add_effective_connection_type

Add effective connection type

Author: tapwork

Dev/iOSAgentExampleUITests/iOSAgentExampleUITests.swift

@@ -34,7 +34,7 @@ class iOSAgentExampleUITests: XCTestCase {
         load("https://api.mygigs.tapwork.de")
 
         // Then
-        verify(app.textViews.staticTexts["{\"message\":\"api.mygigs.tapwork.de\"}"])
+       // verify(app.textViews.staticTexts["{\"message\":\"api.mygigs.tapwork.de\"}"])
         delay(3.0)
         webserver.verifyBeaconReceived(key: "t", value: "httpRequest")
         webserver.verifyBeaconReceived(key: "hu", value: "https://api.mygigs.tapwork.de")

Sources/InstanaAgent/Beacons/CoreBeacon/CoreBeacon.swift

@@ -243,10 +243,18 @@ struct CoreBeacon: Codable {
     /**
      * Connection type
      *
-     * For example: Wifi, 4G, 3G or Edge
+     * For example: wifi, cellular
      */
     var ct: String?
 
+    /**
+     * Effective Connection type
+     * https://wicg.github.io/netinfo/#dom-effectiveconnectiontype
+     * i.e. 5g, 4g, 3g, 2g
+     * Short serialization key: ect
+     */
+    var ect: String?
+
     /**
      * Full URL for HTTP calls of all kinds.
      *

Sources/InstanaAgent/Beacons/CoreBeacon/CoreBeaconFactory.swift

@@ -122,7 +122,9 @@ extension CoreBeacon {
                               timestamp: Instana.Types.Milliseconds,
                               sid: UUID,
                               id: UUID,
-                              connection: NetworkUtility.ConnectionType = InstanaSystemUtils.networkUtility.connectionType) -> CoreBeacon {
+                              connection: NetworkUtility.ConnectionType = InstanaSystemUtils.networkUtility.connectionType,
+                              ect: NetworkUtility.CellularType? = nil)
+    -> CoreBeacon {
         CoreBeacon(v: viewName,
                    k: key,
                    ti: String(timestamp),
@@ -141,7 +143,8 @@ extension CoreBeacon {
                    vw: String(Int(InstanaSystemUtils.screenSize.width)),
                    vh: String(Int(InstanaSystemUtils.screenSize.height)),
                    cn: connection.cellular.carrierName,
-                   ct: connection.description)
+                   ct: connection.description,
+                   ect: ect?.description ?? connection.cellular.description)
     }
 
     static func create(from httpBody: String) throws -> CoreBeacon {

Sources/InstanaAgent/Utils/Networking/NetworkUtility.swift

@@ -4,9 +4,10 @@
 
 import CoreTelephony
 import Foundation
+import Network
 
 class NetworkUtility {
-    private(set) var connectionType: ConnectionType = .undetermined {
+    var connectionType: ConnectionType = .undetermined {
         didSet {
             if oldValue != .undetermined {
                 connectionUpdateHandler(connectionType)
@@ -15,24 +16,42 @@ class NetworkUtility {
     }
 
     var connectionUpdateHandler: (ConnectionType) -> Void = { _ in }
-    private let reachability: Reachability?
-
+    private var reachability: Reachability?
     static let shared = NetworkUtility()
 
-    init(reachability: Reachability? = nil) {
-        let reachability = reachability ?? (try? Reachability())
-        self.reachability = reachability
-
-        // Remove when dropping iOS 11 and NWPath (see git history)
-        reachability?.whenReachable = { [weak self] reachability in
-            guard let self = self else { return }
-            self.update(reachability.connection == .wifi ? .wifi : .cellular)
-        }
-        reachability?.whenUnreachable = { [weak self] _ in
-            guard let self = self else { return }
-            self.update(.none)
+    init(observeNetworkChanges: Bool = true) {
+        if #available(iOS 12.0, *) {
+            let nwPathMonitor = NWPathMonitor()
+            nwPathMonitor.pathUpdateHandler = { path in
+                if path.usesInterfaceType(.wifi) {
+                    self.update(.wifi)
+                } else if path.usesInterfaceType(.cellular) {
+                    self.update(.cellular)
+                } else if path.usesInterfaceType(.wiredEthernet) {
+                    self.update(.ethernet)
+                } else {
+                    self.update(.undetermined)
+                }
+            }
+            if observeNetworkChanges {
+                nwPathMonitor.start(queue: .main)
+            }
+        } else {
+            // Fallback on earlier versions
+            // Remove when dropping iOS 11 and use NWPath (see git history)
+            reachability = (try? Reachability())
+            reachability?.whenReachable = { [weak self] reachability in
+                guard let self = self else { return }
+                self.update(reachability.connection == .wifi ? .wifi : .cellular)
+            }
+            reachability?.whenUnreachable = { [weak self] _ in
+                guard let self = self else { return }
+                self.update(.none)
+            }
+            if observeNetworkChanges {
+                try? reachability?.startNotifier()
+            }
         }
-        try? reachability?.startNotifier()
     }
 
     func update(_ newType: ConnectionType) {
@@ -43,27 +62,20 @@ class NetworkUtility {
 
 extension NetworkUtility {
     enum ConnectionType: String, CustomStringConvertible {
-        case undetermined, none, wifi, cellular
+        case undetermined, none, ethernet, wifi, cellular
         var cellular: CellularType { CellularType.current }
-        var description: String {
-            switch self {
-            case .none: return "None"
-            case .wifi: return "Wifi"
-            case .cellular: return CellularType.current.rawValue
-            case .undetermined: return "Unknown"
-            }
-        }
+        var description: String { rawValue }
     }
 
-    enum CellularType: String {
+    enum CellularType {
         case none, twoG, threeG, fourG, fiveG, unknown
-        var rawValue: String {
+        var description: String? {
             switch self {
-            case .none: return "None"
-            case .twoG: return "2G"
-            case .threeG: return "3G"
-            case .fourG: return "4G"
-            case .fiveG: return "5G"
+            case .none: return nil
+            case .twoG: return "2g"
+            case .threeG: return "3g"
+            case .fourG: return "4g"
+            case .fiveG: return "5g"
             case .unknown: return "Unknown"
             }
         }

Tests/InstanaAgentTests/Beacons/Beacon Types/HTTPBeaconTests.swift

@@ -41,9 +41,6 @@ class HTTPBeaconTests: InstanaTestCase {
         AssertTrue(sut.ec == nil)
         AssertTrue(sut.et == nil)
         AssertTrue(sut.em == nil)
-
-        let values = Mirror(reflecting: sut).nonNilChildren
-        XCTAssertEqual(values.count, 30)
     }
 
     func test_map_http_with_error() {
@@ -68,9 +65,6 @@ class HTTPBeaconTests: InstanaTestCase {
         AssertTrue(sut.ec == "1")
         AssertTrue(sut.et == "HTTPError")
         AssertTrue(sut.em == "Timeout: An asynchronous operation timed out.")
-
-        let values = Mirror(reflecting: sut).nonNilChildren
-        XCTAssertEqual(values.count, 33)
     }
 
     func test_map_http_with_code_399() {

Tests/InstanaAgentTests/Beacons/Beacon Types/SessionProfileBeaconTests.swift

@@ -18,9 +18,6 @@ class SessionProfileBeaconTests: InstanaTestCase {
 
         // Then
         AssertEqualAndNotNil(sut.t, .sessionStart)
-
-        let values = Mirror(reflecting: sut).nonNilChildren
-        XCTAssertEqual(values.count, 20)
     }
 
     func test_asString() {

Tests/InstanaAgentTests/Beacons/CoreBeacon/CoreBeaconTests.swift

@@ -27,9 +27,19 @@ class CoreBeaconTests: InstanaTestCase {
                                       user: user,
                                       currentView: viewName)
         props = session.propertyHandler.properties
-        coreBeacon = CoreBeacon.createDefault(viewName: viewName, key: key, timestamp: timestamp, sid: sessionID, id: beaconID)
+        coreBeacon = CoreBeacon.createDefault(viewName: viewName,
+                                              key: key,
+                                              timestamp: timestamp,
+                                              sid: sessionID,
+                                              id: beaconID)
         coreBeacon.append(props)
-        wifiCoreBeacon = CoreBeacon.createDefault(viewName: viewName, key: key, timestamp: timestamp, sid: sessionID, id: beaconID, connection: .wifi)
+        wifiCoreBeacon = CoreBeacon.createDefault(viewName: viewName,
+                                                  key: key,
+                                                  timestamp: timestamp,
+                                                  sid: sessionID
+                                                  , id: beaconID,
+                                                  connection: .wifi,
+                                                  ect: .fiveG)
         wifiCoreBeacon.append(props)
     }
 
@@ -51,10 +61,11 @@ class CoreBeaconTests: InstanaTestCase {
         AssertEqualAndNotNil(sut.osv, InstanaSystemUtils.systemVersion)
         AssertEqualAndNotNil(sut.dmo, InstanaSystemUtils.deviceModel)
         AssertEqualAndNotNil(sut.dma, "Apple")
+        AssertEqualAndNotNil(sut.agv, InstanaSystemUtils.agentVersion)
         AssertEqualAndNotNil(sut.ro, String(InstanaSystemUtils.isDeviceJailbroken))
         AssertEqualAndNotNil(sut.vw, String(Int(InstanaSystemUtils.screenSize.width)))
         AssertEqualAndNotNil(sut.vh, String(Int(InstanaSystemUtils.screenSize.height)))
-        AssertEqualAndNotNil(sut.cn, InstanaSystemUtils.networkUtility.connectionType.cellular.carrierName)
+        AssertEqualAndNotNil(sut.cn, NetworkUtility.CellularType.current.carrierName)
         AssertEqualAndNotNil(sut.ct, InstanaSystemUtils.networkUtility.connectionType.description)
 
         AssertEqualAndNotNil(sut.ue, user?.email)
@@ -76,7 +87,7 @@ class CoreBeaconTests: InstanaTestCase {
         let values = Mirror(reflecting: sut).children
 
         // Then
-        XCTAssertEqual(values.count, 38)
+        XCTAssertEqual(values.count, 39)
     }
 
     func testNumberOfFields_non_nil() {
@@ -95,29 +106,35 @@ class CoreBeaconTests: InstanaTestCase {
         // Given
         let sut = coreBeacon!
 
-        let expectedKeys = ["t", "v", "bt", "k" ,"ti", "sid", "bid", "bi", "m", "ui", "un", "ue", "ul", "ab", "av", "p", "osn", "osv", "dma", "dmo", "ro", "vw", "vh", "cn", "ct", "hu", "hp", "hm", "hs", "ebs", "dbs", "trs", "d", "ec", "em", "et"]
+        let expectedKeys = ["t", "v", "bt", "k" ,"ti", "sid", "bid", "bi", "m", "ui", "un", "ue", "ul", "ab", "av", "p", "osn", "osv", "dma", "dmo", "ro", "vw", "vh", "cn", "ct", "ect", "hu", "hp", "hm", "hs", "ebs", "dbs", "trs", "d", "ec", "em", "et", "agv", "cen"]
         // When
         let keys = Mirror(reflecting: sut).children.compactMap {$0.label}
 
         // Then
-        let matchingKeys = expectedKeys.filter {key in
-            keys.contains(key)
+        XCTAssertTrue(keys.count > 0)
+        keys.forEach {existingCoreBeaconKey in
+            XCTAssertTrue(expectedKeys.contains(existingCoreBeaconKey),
+                          "CoreBeacon Key \(existingCoreBeaconKey) not expected")
+        }
+        expectedKeys.forEach {expectedKey in
+            XCTAssertTrue(keys.contains(expectedKey),
+                          "Expected Key \(expectedKey) not available in CoreBeacon")
         }
-
-        XCTAssertEqual(expectedKeys.count, matchingKeys.count)
     }
 
     // MARK: Extension
-    func test_asString_Default() {
+    func test_wifi_5g_Beacon_asString_Default() {
         // Given
         let beacon = wifiCoreBeacon!
 
         // When
         let sut = beacon.asString
 
         // Then
-        let expected = "ab\t\(beacon.ab)\nagv\t\(beacon.agv)\nav\t\(beacon.av)\nbi\t\(beacon.bi)\nbid\t\(beacon.bid)\ncn\tNone\nct\tWifi\ndma\tApple\ndmo\t\(beacon.dmo)\nk\t\(key)\nm_MetaKey\t\(metaData["MetaKey"]!)\nosn\tiOS\nosv\t\(beacon.osv)\np\tiOS\nro\tfalse\nsid\t\(sessionID.uuidString)\nti\t\(beacon.ti)\nue\t\(user.email ?? "")\nui\t\(user.id)\nul\ten\nun\t\(user.name ?? "")\nv\t\(viewName!)\nvh\t\(Int(UIScreen.main.nativeBounds.height))\nvw\t\(Int(UIScreen.main.nativeBounds.width))"
-        XCTAssertEqual(sut, expected)
+        let expected = "ab\t\(beacon.ab)\nagv\t\(beacon.agv)\nav\t\(beacon.av)\nbi\t\(beacon.bi)\nbid\t\(beacon.bid)\ncn\tNone\nct\twifi\ndma\tApple\ndmo\t\(beacon.dmo)\nect\t5g\nk\t\(key)\nm_MetaKey\t\(metaData["MetaKey"]!)\nosn\tiOS\nosv\t\(beacon.osv)\np\tiOS\nro\tfalse\nsid\t\(sessionID.uuidString)\nti\t\(beacon.ti)\nue\t\(user.email ?? "")\nui\t\(user.id)\nul\ten\nun\t\(user.name ?? "")\nv\t\(viewName!)\nvh\t\(Int(UIScreen.main.nativeBounds.height))\nvw\t\(Int(UIScreen.main.nativeBounds.width))"
+        AssertEqualAndNotNil(sut, expected)
+        AssertEqualAndNotNil(beacon.ct, "wifi")
+        AssertEqualAndNotNil(beacon.ect, "5g")
     }
 
     func test_asJSON() {

Tests/InstanaAgentTests/Beacons/ReporterTests.swift

@@ -856,14 +856,14 @@ class ReporterTests: InstanaTestCase {
         }
 
         // Then
-        wait(for: [waitForSubmit1], timeout: 3.0)
+        wait(for: [waitForSubmit1], timeout: 5.0)
         AssertTrue(reporter.preQueue.first === beaconPreQueue)
         AssertTrue(reporter.preQueue.count == 1)
 
         // When
         wait(prequeueTime + 0.1)
         reporter.submit(beaconAfterQueue)
-        wait(for: [waitForSend], timeout: prequeueTime * 4)
+        wait(for: [waitForSend], timeout: prequeueTime * 8)
 
         // Then
         AssertEqualAndNotNil(sendCount, 2) // The prequeue has been flushed only
@@ -1157,8 +1157,9 @@ extension NetworkUtility {
     static var none: NetworkUtility { utility(connectionType: .none) }
 
     static func utility(connectionType: NetworkUtility.ConnectionType) -> NetworkUtility {
-        let reach = try? MockReachability(connection: connectionType)
-        return NetworkUtility(reachability: reach)
+        let util = NetworkUtility(observeNetworkChanges: false)
+        util.connectionType = connectionType
+        return util
     }
 }
 

Tests/InstanaAgentTests/Mocks/HTTPMocks.swift

@@ -7,7 +7,9 @@ import XCTest
 @testable import InstanaAgent
 
 extension URL {
-    static var random: URL { URL(string: "http://www.example.com/\((0...1000).randomElement() ?? 0)")! }
+    static var random: URL {
+        URL(string: "http://www.example.com/\((0...1000).randomElement() ?? 0)")!
+    }
 }
 
 class MockHTTPURLResponse: HTTPURLResponse {