make Current App State configurable and default to true (#90)

Author: Hongyan Jiang

.swiftpm/xcode/xcshareddata/xcschemes/InstanaAgent.xcscheme

@@ -26,7 +26,8 @@
       buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
-      shouldUseLaunchSchemeArgsEnv = "YES">
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      codeCoverageEnabled = "YES">
       <Testables>
          <TestableReference
             skipped = "NO">

Changelog.md

@@ -1,6 +1,7 @@
 # Changelog
 
 ## 1.9.2
+- enableAppStateDetection for performance configuration is default to true
 - send screen rendering time along with viewChange beacon if autoCaptureScreenNames is set to true
 
 ## 1.9.1

Dev/InstanaAgentExample/AppDelegate.swift

@@ -31,7 +31,7 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
 //        options.dropBeaconReporting = true
 //        options.rateLimits = .MID_LIMITS
 //        options.trustDeviceTiming = true
-//        options.perfConfig = InstanaPerformanceConfig(enableAnrReport: true, anrThreshold: 5.0, enableLowMemoryReport: true)
+//        options.perfConfig = InstanaPerformanceConfig(enableAppStartTimeReport: false, enableAnrReport: true, anrThreshold: 5.0, enableLowMemoryReport: true, enableAppStateDetection: false)
 //        options.enableW3CHeaders = true
         if !Instana.setup(key: InstanaKey, reportingURL: InstanaURL, options: options) {
             os_log("Instana setup failed", log: myLog, type: .error)

Sources/InstanaAgent/Beacons/CoreBeacon/CoreBeaconFactory.swift

@@ -47,7 +47,8 @@ class CoreBeaconFactory {
                                                id: beacon.id, mobileFeatures: mobileFeatures,
                                                trustDeviceTiming: conf.trustDeviceTiming,
                                                hybridAgentId: conf.hybridAgentId,
-                                               hybridAgentVersion: conf.hybridAgentVersion)
+                                               hybridAgentVersion: conf.hybridAgentVersion,
+                                               enableAppStateDetection: conf.enableAppStateDetection)
         cbeacon.append(properties)
         switch beacon {
         case let item as HTTPBeacon:
@@ -292,32 +293,34 @@ extension CoreBeacon {
                               hybridAgentId: String?,
                               hybridAgentVersion: String?,
                               connection: NetworkUtility.ConnectionType = InstanaSystemUtils.networkUtility.connectionType,
-                              ect: NetworkUtility.CellularType? = nil)
+                              ect: NetworkUtility.CellularType? = nil,
+                              enableAppStateDetection: Bool? = nil)
         -> CoreBeacon {
-        CoreBeacon(v: viewName,
-                   k: key,
-                   ti: String(timestamp),
-                   sid: sid.uuidString,
-                   usi: usi?.uuidString,
-                   bid: id,
-                   uf: mobileFeatures,
-                   bi: InstanaSystemUtils.applicationBundleIdentifier,
-                   ul: Locale.current.languageCode,
-                   ab: InstanaSystemUtils.applicationBuildNumber,
-                   av: InstanaSystemUtils.applicationVersion,
-                   p: InstanaSystemUtils.systemName,
-                   osn: InstanaSystemUtils.systemName,
-                   osv: InstanaSystemUtils.systemVersion,
-                   dmo: InstanaSystemUtils.deviceModel,
-                   agv: CoreBeacon.getInstanaAgentVersion(hybridAgentId: hybridAgentId,
-                                                          hybridAgentVersion: hybridAgentVersion),
-                   ro: String(InstanaSystemUtils.isDeviceJailbroken),
-                   vw: String(Int(InstanaSystemUtils.screenSize.width)),
-                   vh: String(Int(InstanaSystemUtils.screenSize.height)),
-                   cn: connection.cellular.carrierName,
-                   ct: connection.description,
-                   ect: ect?.description ?? connection.cellular.description,
-                   tdt: trustDeviceTiming.map { $0 ? "1" : nil } ?? nil,
-                   cas: InstanaApplicationStateHandler.shared.getAppStateForBeacon())
+        let cas = (enableAppStateDetection != false) ? InstanaApplicationStateHandler.shared.getAppStateForBeacon() : nil
+        return CoreBeacon(v: viewName,
+                          k: key,
+                          ti: String(timestamp),
+                          sid: sid.uuidString,
+                          usi: usi?.uuidString,
+                          bid: id,
+                          uf: mobileFeatures,
+                          bi: InstanaSystemUtils.applicationBundleIdentifier,
+                          ul: Locale.current.languageCode,
+                          ab: InstanaSystemUtils.applicationBuildNumber,
+                          av: InstanaSystemUtils.applicationVersion,
+                          p: InstanaSystemUtils.systemName,
+                          osn: InstanaSystemUtils.systemName,
+                          osv: InstanaSystemUtils.systemVersion,
+                          dmo: InstanaSystemUtils.deviceModel,
+                          agv: CoreBeacon.getInstanaAgentVersion(hybridAgentId: hybridAgentId,
+                                                                 hybridAgentVersion: hybridAgentVersion),
+                          ro: String(InstanaSystemUtils.isDeviceJailbroken),
+                          vw: String(Int(InstanaSystemUtils.screenSize.width)),
+                          vh: String(Int(InstanaSystemUtils.screenSize.height)),
+                          cn: connection.cellular.carrierName,
+                          ct: connection.description,
+                          ect: ect?.description ?? connection.cellular.description,
+                          tdt: trustDeviceTiming.map { $0 ? "1" : nil } ?? nil,
+                          cas: cas)
     }
 }

Sources/InstanaAgent/Configuration/InstanaConfiguraton.swift

@@ -75,6 +75,7 @@ class InstanaConfiguration {
     var anrThreshold: Double?
     var trustDeviceTiming: Bool?
     var enableW3CHeaders: Bool?
+    var enableAppStateDetection: Bool?
     var reporterSendDebounce: Instana.Types.Seconds
     var reporterSendLowBatteryDebounce: Instana.Types.Seconds
     var maxRetries: Int
@@ -113,6 +114,9 @@ class InstanaConfiguration {
             anrThreshold = perfConfig!.anrThreshold
             monitorTypes.insert(.alertApplicationNotResponding(threshold: anrThreshold!))
         }
+        if perfConfig?.enableAppStateDetection != nil {
+            enableAppStateDetection = perfConfig!.enableAppStateDetection
+        }
 
         if enableCrashReporting {
             monitorTypes.insert(.crash)

Sources/InstanaAgent/InstanaSetupOptions.swift

@@ -87,14 +87,17 @@ import Foundation
     var enableAnrReport: Bool = false
     var anrThreshold: Double = 3.0 // in seconds
     var enableLowMemoryReport: Bool = false
+    var enableAppStateDetection: Bool = true
 
     @objc public
     init(enableAppStartTimeReport: Bool = true, enableAnrReport: Bool = true,
-         anrThreshold: Double = 3.0, enableLowMemoryReport: Bool = false) {
+         anrThreshold: Double = 3.0, enableLowMemoryReport: Bool = false,
+         enableAppStateDetection: Bool = true) {
         self.enableAppStartTimeReport = enableAppStartTimeReport
         self.enableAnrReport = enableAnrReport
         self.anrThreshold = anrThreshold
         self.enableLowMemoryReport = enableLowMemoryReport
+        self.enableAppStateDetection = enableAppStateDetection
         super.init()
     }
 
@@ -120,6 +123,11 @@ import Foundation
     func setEnableLowMemoryReport(_ enableLowMemoryReport: Bool) {
         self.enableLowMemoryReport = enableLowMemoryReport
     }
+
+    @objc public
+    func setEnableAppStateDetection(_ enableAppStateDetection: Bool) {
+        self.enableAppStateDetection = enableAppStateDetection
+    }
 }
 
 // Hybrid Agent options for setup

Tests/InstanaAgentTests/InstanaSetupOptionsTest.swift

@@ -65,6 +65,18 @@ class InstanaPerformanceConfigTests: XCTestCase {
         AssertFalse(pfConfig.enableLowMemoryReport)
     }
 
+    func test_setEnableAppStateDetection() {
+        // Given
+        let pfConfig = InstanaPerformanceConfig()
+        AssertTrue(pfConfig.enableAppStateDetection)
+
+        // When
+        pfConfig.setEnableAppStateDetection(false)
+
+        // Then
+        AssertFalse(pfConfig.enableAppStateDetection)
+    }
+
     func testInit_full() {
         let pfConfig = InstanaPerformanceConfig(enableAppStartTimeReport: true,
                                                 enableAnrReport: true, anrThreshold: 2.0,