fix duplicated beacon issue for slow network (#93)

Author: Hongyan Jiang

Changelog.md

@@ -1,6 +1,7 @@
 # Changelog
 
 ## 1.9.3
+- address dulpicated beacon issue for slow network
 - crash beacon improvement
 
 ## 1.9.2

Sources/InstanaAgent/Beacons/Reporter.swift

@@ -151,7 +151,7 @@ public class Reporter {
             return true
         }
 
-        let maxFlushingTimeAllowed = 10.0 // in seconds
+        let maxFlushingTimeAllowed = 100.0 // in seconds
 
         let diff = Date().timeIntervalSince1970 - lastFlushStartTime!
         if diff > maxFlushingTimeAllowed {
@@ -193,7 +193,7 @@ public class Reporter {
             beacon.updateMetaDataWithSlowSendStartTime(slowSendStartTime)
             beacons.insert(beacon)
         } else {
-            debounce = queue.isFull ? 0.0 : flushDebounce
+            debounce = calcDebounceTime()
             beacons = queue.items
         }
         let flusher = BeaconFlusher(reporter: self, items: beacons, debounce: debounce,
@@ -207,7 +207,20 @@ public class Reporter {
         }
         flusher.schedule()
         self.flusher = flusher
-        lastFlushStartTime = Date().timeIntervalSince1970
+        lastFlushStartTime = Date().timeIntervalSince1970 + debounce
+    }
+
+    internal func calcDebounceTime() -> TimeInterval {
+        var debounce: TimeInterval = flushDebounce
+        let itemsCount = queue.items.count
+        if itemsCount >= (queue.maxItems * 4 / 5) {
+            // if queue 80% full then flush immediately
+            debounce = 0
+        } else if itemsCount >= (queue.maxItems / 2) {
+            // if queue 50% full then flush quicker than default waiting time
+            debounce /= 2.0
+        }
+        return debounce
     }
 
     func runBackgroundFlush() {

Sources/InstanaAgent/Utils/Extensions/UI.swift

@@ -111,7 +111,7 @@ extension UIViewController {
             let duration = (CACurrentMediaTime() - startTime) * 1000.0
             let classType = type(of: self)
             #if DEBUG
-                print("DEBUG: \(Bundle(for: classType).bundleIdentifier!) classType=\(classType) viewDidAppear() \(duration) milliseconds")
+//                print("DEBUG: \(Bundle(for: classType).bundleIdentifier!) classType=\(classType) viewDidAppear() \(duration) milliseconds")
             #endif
             objc_setAssociatedObject(self, &AssociatedKeys.viewLoadStartTime, nil, .OBJC_ASSOCIATION_RETAIN_NONATOMIC)
 

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

@@ -41,7 +41,7 @@ class DiagnosticBeaconTests: InstanaTestCase {
         // Then
         AssertEqualAndNotNil(beacon.cti, "\(crashBeacon.crashTime)")
         AssertEqualAndNotNil(beacon.d, "\(crashBeacon.duration)")
-        AssertEqualAndNotNil(beacon.ast, crashBeacon.crashPayload)
+//        AssertEqualAndNotNil(beacon.ast, crashBeacon.crashPayload) // not sent since version 1.9.3
         AssertEqualAndNotNil(beacon.st, crashBeacon.formatted)
         AssertEqualAndNotNil(beacon.et, crashBeacon.errorType)
         AssertEqualAndNotNil(beacon.em, crashBeacon.errorMessage)
@@ -72,7 +72,7 @@ class DiagnosticBeaconTests: InstanaTestCase {
         let sut = beacon.asString
         // When
         let conn = InstanaSystemUtils.networkUtility.connectionType
-        let expected = "ab\t\(beacon.ab)\nagv\t\(beacon.agv)\nast\tmockCrashPayload\nav\t\(beacon.av)\nbi\t\(beacon.bi)\nbid\t\(beacon.bid)\ncn\tmockCarrier\nct\tmockConnectionType\ncti\t\(crashTime)\nd\t0\ndma\tApple\ndmo\t\(beacon.dmo)\nem\tmockErrorType - crash terminationReason\net\tmockErrorType\nk\t\(key)\nm_cn\t\(conn.cellular.carrierName)\nm_ct\t\(conn.description)\nm_id\t\(mockSession.id)\nm_mg\t\(crashGroupID.uuidString)\nm_mt\tcrash\nm_sym\ttrue\nm_ver\t\(currentInstanaCrashPayloadVersion)\nosn\tiOS\nosv\t\(beacon.osv)\np\tiOS\nro\t\(String(InstanaSystemUtils.isDeviceJailbroken))\nsid\t\(crashSession.id)\nst\tmockSymbolicated\nt\tcrash\nti\t\(crashBeacon.timestamp)\nue\tmockEmail\nuf\tc,lm\nui\tmockUserID\nul\ten\nun\tmockUserName\nusi\t\(mockSession.usi!.uuidString)\nv\tmockViewName\nvh\t\(Int(UIScreen.main.bounds.height))\nvw\t\(Int(UIScreen.main.bounds.width))"
+        let expected = "ab\t\(beacon.ab)\nagv\t\(beacon.agv)\nav\t\(beacon.av)\nbi\t\(beacon.bi)\nbid\t\(beacon.bid)\ncn\tmockCarrier\nct\tmockConnectionType\ncti\t\(crashTime)\nd\t0\ndma\tApple\ndmo\t\(beacon.dmo)\nem\tmockErrorType - crash terminationReason\net\tmockErrorType\nk\t\(key)\nm_cn\t\(conn.cellular.carrierName)\nm_ct\t\(conn.description)\nm_id\t\(mockSession.id)\nm_mg\t\(crashGroupID.uuidString)\nm_mt\tcrash\nm_sym\ttrue\nm_ver\t\(currentInstanaCrashPayloadVersion)\nosn\tiOS\nosv\t\(beacon.osv)\np\tiOS\nro\t\(String(InstanaSystemUtils.isDeviceJailbroken))\nsid\t\(crashSession.id)\nst\tmockSymbolicated\nt\tcrash\nti\t\(crashBeacon.timestamp)\nue\tmockEmail\nuf\tc,lm\nui\tmockUserID\nul\ten\nun\tmockUserName\nusi\t\(mockSession.usi!.uuidString)\nv\tmockViewName\nvh\t\(Int(UIScreen.main.bounds.height))\nvw\t\(Int(UIScreen.main.bounds.width))"
         XCTAssertEqual(sut, expected)
     }
 }

Tests/InstanaAgentTests/Beacons/ReporterTests.swift

@@ -1077,6 +1077,22 @@ class ReporterTests: InstanaTestCase {
         XCTAssertTrue(reporter.canScheduleFlush())
     }
 
+    func test_calcDebounceTime_moreThanHalf() {
+        // Given
+        session.configuration.reporterSendDebounce = 2.0
+        let reporter = Reporter(session, batterySafeForNetworking: { true }, networkUtility: .wifi)
+
+        let beacons: [HTTPBeacon] = (0..<reporter.queue.maxItems/2 + 1).map { _ in HTTPBeacon.createMock() }
+        let corebeacons = try! CoreBeaconFactory(session).map(beacons)
+        reporter.queue.add(corebeacons)
+
+        // When
+        let debounce = reporter.calcDebounceTime()
+
+        // Then
+        XCTAssertTrue(debounce == 1.0)
+    }
+
     func test_submit_and_flush_shouldNotCause_RetainCycle() {
         // Given
         let waitForCompletion = expectation(description: "waitForSend")