add to mobile feature list if autoCaptureScreenNames is enabled (#45)

Hongyan Jiang · GitHub Enterprise · commit 22532b444812 · 2024-04-15T22:42:36.000-07:00
diff --git a/Changelog.md b/Changelog.md
@@ -1,5 +1,8 @@
 # Changelog
 
+## 1.7.1
+- add to mobile feature list if `autoCaptureScreenNames` is enabled
+
 ## 1.7.0
 - introduce `autoCaptureScreenNames` to auto capture view names and `debugAllScreenNames` to debug all screen names
 
diff --git a/InstanaAgent.podspec b/InstanaAgent.podspec
@@ -16,7 +16,7 @@ Pod::Spec.new do |s|
   #
 
   s.name         = "InstanaAgent"
-  s.version      = "1.7.0"
+  s.version      = "1.7.1"
   s.summary      = "Instana iOS agent."
 
   # This description is used to generate tags and improve search results.
diff --git a/Sources/InstanaAgent/Beacons/CoreBeacon/CoreBeaconFactory.swift b/Sources/InstanaAgent/Beacons/CoreBeacon/CoreBeaconFactory.swift
@@ -8,8 +8,15 @@ class CoreBeaconFactory {
     private let session: InstanaSession
     private var conf: InstanaConfiguration { session.configuration }
     private var properties: InstanaProperties { session.propertyHandler.properties }
-    private var mobileFeatures: String? {
-        if conf.monitorTypes.contains(.crash) { return "c" } else { return nil }
+    internal var mobileFeatures: String? {
+        var array: [String] = []
+        if conf.monitorTypes.contains(.crash) {
+            array.append(mobileFeatureCrash)
+        }
+        if session.autoCaptureScreenNames {
+            array.append(mobileFeatureAutoScreenNameCapture)
+        }
+        return array.isEmpty ? nil : array.joined(separator: ",")
     }
 
     init(_ session: InstanaSession) {
diff --git a/Sources/InstanaAgent/Configuration/Defines.swift b/Sources/InstanaAgent/Configuration/Defines.swift
@@ -55,3 +55,9 @@ let maxSecondsToKeepCrashLog = (maxDaysToKeepCrashLog * 60 * 60 * 24)
 let internalMetaDataKeyView_accbltyLabel = "view.accLabel" // accessibilityLabel
 let internalMetaDataKeyView_navItemTitle = "view.navItemTitle" // navigationItemTitle
 let internalMetaDataKeyView_className = "view.clsName" // className
+
+///
+/// Mobile Features
+///
+let mobileFeatureCrash = "c"
+let mobileFeatureAutoScreenNameCapture = "sn"
diff --git a/Sources/InstanaAgent/Configuration/VersionConfig.swift b/Sources/InstanaAgent/Configuration/VersionConfig.swift
@@ -1,3 +1,3 @@
 struct VersionConfig {
-    static let agentVersion = "1.7.0"
+    static let agentVersion = "1.7.1"
 }
diff --git a/Tests/InstanaAgentTests/Beacons/CoreBeacon/CoreBeaconFactoryTests.swift b/Tests/InstanaAgentTests/Beacons/CoreBeacon/CoreBeaconFactoryTests.swift
@@ -22,6 +22,30 @@ class CoreBeaconFactoryTests: InstanaTestCase {
         }
     }
 
+    func test_mobileFeatures_autoCaptureScreenNames_enabled() {
+        // Given
+        let mfSession = InstanaSession(configuration: config, propertyHandler: InstanaPropertyHandler(),
+                                     collectionEnabled: true, autoCaptureScreenNames: true)
+
+        // When
+        let mfs = CoreBeaconFactory(mfSession)
+
+        // Then
+        AssertEqualAndNotNil(mfs.mobileFeatures!, "\(mobileFeatureCrash),\(mobileFeatureAutoScreenNameCapture)")
+    }
+
+    func test_mobileFeatures_autoCaptureScreenNames_disabled() {
+        // Given
+        let mfSession = InstanaSession(configuration: config, propertyHandler: InstanaPropertyHandler(),
+                                     collectionEnabled: true)
+
+        // When
+        let mfs = CoreBeaconFactory(mfSession)
+
+        // Then
+        AssertEqualAndNotNil(mfs.mobileFeatures!, "\(mobileFeatureCrash)")
+    }
+
     func test_map_beacon() {
         // Given
         let timestamp = Date().millisecondsSince1970
@@ -41,7 +65,7 @@ class CoreBeaconFactoryTests: InstanaTestCase {
         AssertEqualAndNotNil(sut.k, key)
         AssertEqualAndNotNil(sut.ti, "\(beacon.timestamp)")
         AssertEqualAndNotNil(sut.bid, "\(beacon.id)")
-        AssertEqualAndNotNil(sut.uf, "c")
+        AssertEqualAndNotNil(sut.uf, mobileFeatureCrash)
         AssertEqualAndNotNil(sut.bi, "\(InstanaSystemUtils.applicationBundleIdentifier)")
         AssertEqualAndNotNil(sut.ul, "en")
         AssertEqualAndNotNil(sut.agv, InstanaSystemUtils.agentVersion)
@@ -144,7 +168,7 @@ class CoreBeaconFactoryTests: InstanaTestCase {
         AssertEqualAndNotNil(sut.sid, "70BED140-D947-4EC7-ADE9-8F1F7C6955D0")
         AssertEqualAndNotNil(sut.usi, "70BED140-D947-4EC7-ADE9-8F1F7C6955D0")
         AssertEqualAndNotNil(sut.ti, "1578569955952")
-        AssertEqualAndNotNil(sut.uf, "c")
+        AssertEqualAndNotNil(sut.uf, mobileFeatureCrash)
         AssertEqualAndNotNil(sut.ul, "en")
         AssertEqualAndNotNil(sut.vh, "1792")
         AssertEqualAndNotNil(sut.vw, "828")
diff --git a/Tests/InstanaAgentTests/Beacons/CoreBeacon/CoreBeaconTests.swift b/Tests/InstanaAgentTests/Beacons/CoreBeacon/CoreBeaconTests.swift
@@ -33,7 +33,7 @@ class CoreBeaconTests: InstanaTestCase {
                                               sid: sessionID,
                                               usi: session.usi,
                                               id: beaconID,
-                                              mobileFeatures: "c",
+                                              mobileFeatures: mobileFeatureCrash,
                                               hybridAgentId: nil,
                                               hybridAgentVersion: nil)
         coreBeacon.append(props)
@@ -43,7 +43,7 @@ class CoreBeaconTests: InstanaTestCase {
                                                   sid: sessionID,
                                                   usi: session.usi,
                                                   id: beaconID,
-                                                  mobileFeatures: "c",
+                                                  mobileFeatures: mobileFeatureCrash,
                                                   hybridAgentId: "f",
                                                   hybridAgentVersion: "3.0.6",
                                                   connection: .wifi,
@@ -62,7 +62,7 @@ class CoreBeaconTests: InstanaTestCase {
         XCTAssertNotNil(sut.usi)
         AssertEqualAndNotNil(sut.bid, beaconID)
         AssertEqualAndNotNil(sut.bi, InstanaSystemUtils.applicationBundleIdentifier)
-        AssertEqualAndNotNil(sut.uf, "c")
+        AssertEqualAndNotNil(sut.uf, mobileFeatureCrash)
         AssertEqualAndNotNil(sut.ul, Locale.current.languageCode)
         AssertEqualAndNotNil(sut.ab, InstanaSystemUtils.applicationBuildNumber)
         AssertEqualAndNotNil(sut.av, InstanaSystemUtils.applicationVersion)
@@ -153,7 +153,7 @@ class CoreBeaconTests: InstanaTestCase {
                                       sid: sessionID,
                                       usi: sessionUsi.usi,
                                       id: beaconID,
-                                      mobileFeatures: "c",
+                                      mobileFeatures: mobileFeatureCrash,
                                       hybridAgentId: "nil",
                                       hybridAgentVersion: nil,
                                       connection: .wifi,
diff --git a/Tests/InstanaAgentTests/Configuration/InstanaSystemUtilsTests.swift b/Tests/InstanaAgentTests/Configuration/InstanaSystemUtilsTests.swift
@@ -5,7 +5,7 @@ class InstanaSystemUtilsTests: InstanaTestCase {
 
     func test_AgentVersion() {
         // Then
-        AssertTrue(InstanaSystemUtils.agentVersion == "1.7.0")
+        AssertTrue(InstanaSystemUtils.agentVersion == "1.7.1")
     }
 
     func test_systemVersion() {
diff --git a/Tests/InstanaAgentTests/Utils_Tests/InstanaPersistableQueueTests.swift b/Tests/InstanaAgentTests/Utils_Tests/InstanaPersistableQueueTests.swift
@@ -49,10 +49,10 @@ class InstanaPersistableQueueTests: InstanaTestCase {
         let sessionID = UUID()
         let id = Beacon.generateUniqueIdImpl()
         let beacon1 = CoreBeacon.createDefault(viewName: "View_1", key: "Key_1", timestamp: 0,
-                                 sid: sessionID, usi: session.usi, id: id, mobileFeatures: "c",
+                                 sid: sessionID, usi: session.usi, id: id, mobileFeatures: mobileFeatureCrash,
                                  hybridAgentId: "f", hybridAgentVersion: "3.0.6")
         let beacon2 = CoreBeacon.createDefault(viewName: "View_2", key: "Key_2", timestamp: 0,
-                                 sid: sessionID, usi: session.usi, id: id, mobileFeatures: "c",
+                                 sid: sessionID, usi: session.usi, id: id, mobileFeatures: mobileFeatureCrash,
                                  hybridAgentId: "r", hybridAgentVersion: "2.0.3")
         let queueHandler = InstanaPersistableQueue<CoreBeacon>(identifier: "queue", maxItems: 100)
         queueHandler.removeAll()
@@ -74,15 +74,15 @@ class InstanaPersistableQueueTests: InstanaTestCase {
     func test_persisted_beacons_plus_new() {
         // Given
         let oldBeacons = [CoreBeacon.createDefault(viewName: "V", key: "K", timestamp: 1, sid: UUID(),
-                          usi: session.usi, id: Beacon.generateUniqueIdImpl(), mobileFeatures: "c",
+                          usi: session.usi, id: Beacon.generateUniqueIdImpl(), mobileFeatures: mobileFeatureCrash,
                           hybridAgentId: "f", hybridAgentVersion: "3.0.6"),]
         var queueHandler = InstanaPersistableQueue<CoreBeacon>(identifier: "queue", maxItems: 100)
         queueHandler.removeAll()
         queueHandler.add(oldBeacons) {_ in}
 
         // When
         let newBeacons = [CoreBeacon.createDefault(viewName: "V", key: "K", timestamp: 2, sid: UUID(),
-                          usi: session.usi, id: Beacon.generateUniqueIdImpl(), mobileFeatures: "c",
+                          usi: session.usi, id: Beacon.generateUniqueIdImpl(), mobileFeatures: mobileFeatureCrash,
                           hybridAgentId: "f", hybridAgentVersion: "3.0.6")]
         queueHandler = InstanaPersistableQueue<CoreBeacon>(identifier: "queue", maxItems: 100)
         queueHandler.add(newBeacons) {result in
@@ -101,15 +101,15 @@ class InstanaPersistableQueueTests: InstanaTestCase {
         // Given
         let id = Beacon.generateUniqueIdImpl()
         let oldBeacons = [CoreBeacon.createDefault(viewName: "V", key: "K", timestamp: 1,
-                                     sid: UUID(), usi: session.usi, id: id, mobileFeatures: "c",
+                                     sid: UUID(), usi: session.usi, id: id, mobileFeatures: mobileFeatureCrash,
                                      hybridAgentId: "f", hybridAgentVersion: "3.0.6")]
         var queueHandler = InstanaPersistableQueue<CoreBeacon>(identifier: "queue", maxItems: 100)
         queueHandler.removeAll()
         queueHandler.add(oldBeacons) {_ in}
 
         // When
         let newBeacon = CoreBeacon.createDefault(viewName: "V", key: "K", timestamp: 2,
-                                   sid: UUID(), usi: session.usi, id: id, mobileFeatures: "c",
+                                   sid: UUID(), usi: session.usi, id: id, mobileFeatures: mobileFeatureCrash,
                                    hybridAgentId: "r", hybridAgentVersion: "2.0.3")
         queueHandler = InstanaPersistableQueue<CoreBeacon>(identifier: "queue", maxItems: 100)
         queueHandler.add(newBeacon) {result in

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ Pod::Spec.new do \|s\|`
`16`	`16`	`#`
`17`	`17`
`18`	`18`	`s.name = "InstanaAgent"`
`19`		`- s.version = "1.7.0"`
	`19`	`+ s.version = "1.7.1"`
`20`	`20`	`s.summary = "Instana iOS agent."`
`21`	`21`
`22`	`22`	`# This description is used to generate tags and improve search results.`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`struct VersionConfig {`
`2`		`- static let agentVersion = "1.7.0"`
	`2`	`+ static let agentVersion = "1.7.1"`
`3`	`3`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ class InstanaSystemUtilsTests: InstanaTestCase {`
`5`	`5`
`6`	`6`	`func test_AgentVersion() {`
`7`	`7`	`// Then`
`8`		`- AssertTrue(InstanaSystemUtils.agentVersion == "1.7.0")`
	`8`	`+ AssertTrue(InstanaSystemUtils.agentVersion == "1.7.1")`
`9`	`9`	`}`
`10`	`10`
`11`	`11`	`func test_systemVersion() {`