Change beacon id from 128 bit UUID to 64 bit hex string

Author: Hongyan Jiang

Changelog.md

@@ -4,6 +4,7 @@
 - Fix client side crash symbolication for arm64e architecture
 - Fix unit test cases that failed in command line execution
 - Fix unit test cases that failed in Xcode 15
+- Change beacon id from 128 bit UUID to 64 bit hex string
 
 ## 1.6.5
 - Add crash to mobile feature list and send to Instana backend

Sources/InstanaAgent/Beacons/Beacons Types/Beacon.swift

@@ -6,7 +6,7 @@ import Foundation
 
 /// Base class for Beacon.
 class Beacon: Identifiable {
-    let id = UUID()
+    let id = Beacon.generateUniqueIdImpl()
     var timestamp: Instana.Types.Milliseconds = Date().millisecondsSince1970
     let viewName: String?
 
@@ -15,6 +15,17 @@ class Beacon: Identifiable {
         self.timestamp = timestamp
         self.viewName = InstanaProperties.validate(view: viewName)
     }
+
+    // A hex encoded 64 bit random ID.
+    static func generateUniqueIdImpl() -> String {
+        let validIdCharacters = Array("0123456789abcdef")
+        var result: String = ""
+        for _ in 0 ..< 16 {
+            let idx = Int.random(in: 0 ... 15)
+            result += String(validIdCharacters[idx])
+        }
+        return result
+    }
 }
 
 enum BeaconResult {

Sources/InstanaAgent/Beacons/CoreBeacon/CoreBeaconFactory.swift

@@ -183,7 +183,7 @@ extension CoreBeacon {
                               timestamp: Instana.Types.Milliseconds,
                               sid: UUID,
                               usi: UUID?,
-                              id: UUID,
+                              id: String,
                               mobileFeatures: String?,
                               connection: NetworkUtility.ConnectionType = InstanaSystemUtils.networkUtility.connectionType,
                               ect: NetworkUtility.CellularType? = nil)
@@ -193,7 +193,7 @@ extension CoreBeacon {
                    ti: String(timestamp),
                    sid: sid.uuidString,
                    usi: usi?.uuidString,
-                   bid: id.uuidString,
+                   bid: id,
                    uf: mobileFeatures,
                    bi: InstanaSystemUtils.applicationBundleIdentifier,
                    ul: Locale.current.languageCode,

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

@@ -28,4 +28,12 @@ class BeaconTests: InstanaTestCase {
         // Then
         AssertEqualAndNotNil(sut.viewName, given.cleanEscapeAndTruncate(at: InstanaProperties.viewMaxLength))
     }
+
+    func test_beacon_id() {
+        // Given
+        let beaconID = Beacon.generateUniqueIdImpl()
+
+        // Then
+        AssertEqualAndNotNil(beaconID.count, 16)
+    }
 }

Tests/InstanaAgentTests/Beacons/CoreBeacon/CoreBeaconTests.swift

@@ -11,11 +11,11 @@ class CoreBeaconTests: InstanaTestCase {
     var coreBeacon: CoreBeacon!
     var wifiCoreBeacon: CoreBeacon!
     var timestamp: Int64!
-    var beaconID: UUID!
+    var beaconID: String = ""
 
     override func setUp() {
         super.setUp()
-        beaconID = UUID()
+        beaconID = Beacon.generateUniqueIdImpl()
         timestamp = Date().millisecondsSince1970
 
         user = InstanaProperties.User(id: sessionID.uuidString , email: "ex@example.com", name: "John Appleseed")
@@ -56,7 +56,7 @@ class CoreBeaconTests: InstanaTestCase {
         AssertEqualAndNotNil(sut.ti, String(timestamp))
         AssertEqualAndNotNil(sut.sid, sessionID.uuidString)
         XCTAssertNotNil(sut.usi)
-        AssertEqualAndNotNil(sut.bid, beaconID.uuidString)
+        AssertEqualAndNotNil(sut.bid, beaconID)
         AssertEqualAndNotNil(sut.bi, InstanaSystemUtils.applicationBundleIdentifier)
         AssertEqualAndNotNil(sut.uf, "c")
         AssertEqualAndNotNil(sut.ul, Locale.current.languageCode)

Tests/InstanaAgentTests/Beacons/ReporterTests.swift

@@ -200,7 +200,7 @@ class ReporterTests: InstanaTestCase {
         // Then
         AssertTrue(reporter.queue.items.count == 1)
         AssertTrue(sendCount == 0)
-        AssertEqualAndNotNil(reporter.queue.items.randomElement()?.bid, givenBeacon.id.uuidString)
+        AssertEqualAndNotNil(reporter.queue.items.randomElement()?.bid, givenBeacon.id)
 
         // Wait for final flush
         wait(for: [finalExp], timeout: 5.0)
@@ -828,7 +828,7 @@ class ReporterTests: InstanaTestCase {
         AssertTrue(reporter.preQueue.isEmpty)
         AssertTrue(expectedResult == .success)
         AssertTrue(sendQueue.addedItems.count == 1)
-        AssertEqualAndNotNil(sendQueue.addedItems.first?.bid, beacon.id.uuidString)
+        AssertEqualAndNotNil(sendQueue.addedItems.first?.bid, beacon.id)
         AssertEqualAndNotNil(sendQueue.addedItems.first?.v, viewName)
         AssertEqualAndNotNil(sendQueue.addedItems.first?.ue, "e@e.com")
         AssertEqualAndNotNil(sendQueue.addedItems.first?.un, "John")
@@ -872,8 +872,8 @@ class ReporterTests: InstanaTestCase {
         // Then
         AssertEqualAndNotNil(sendCount, 2) // The prequeue has been flushed only
         AssertTrue(sendQueue.addedItems.count == 2)
-        AssertTrue(sendQueue.addedItems.map {$0.bid}.contains(beaconPreQueue.id.uuidString))
-        AssertTrue(sendQueue.addedItems.map {$0.bid}.contains(beaconAfterQueue.id.uuidString))
+        AssertTrue(sendQueue.addedItems.map {$0.bid}.contains(beaconPreQueue.id))
+        AssertTrue(sendQueue.addedItems.map {$0.bid}.contains(beaconAfterQueue.id))
         AssertTrue(reporter.preQueue.isEmpty)
     }
 
@@ -902,7 +902,7 @@ class ReporterTests: InstanaTestCase {
 
         // Then
         AssertEqualAndNotNil(resultError, givenError)
-        AssertEqualAndNotNil(reporter.queue.items.randomElement()?.bid, givenBeacon.id.uuidString)
+        AssertEqualAndNotNil(reporter.queue.items.randomElement()?.bid, givenBeacon.id)
     }
 
     func test_DO_NOT_remove_from_after_http_client_error() {
@@ -923,7 +923,7 @@ class ReporterTests: InstanaTestCase {
         wait(for: [waitForSend], timeout: 20.0)
 
         // Then
-        AssertTrue(reporter.queue.items.contains(where: {$0.bid == beacon.id.uuidString}))
+        AssertTrue(reporter.queue.items.contains(where: {$0.bid == beacon.id}))
         AssertTrue(mockQueue.removedItems.isEmpty)
     }
 

Tests/InstanaAgentTests/Monitors/HTTP/HTTPMarkerTests.swift

@@ -287,7 +287,7 @@ class HTTPMarkerTests: InstanaTestCase {
         }
 
         // Then
-        XCTAssertTrue(beacon.id.uuidString.count > 0)
+        XCTAssertTrue(beacon.id.count > 0)
         XCTAssertEqual(beacon.timestamp, marker.startTime)
         XCTAssertEqual(beacon.duration, 0)
         XCTAssertEqual(beacon.method, "c")
@@ -327,7 +327,7 @@ class HTTPMarkerTests: InstanaTestCase {
 
         // Then
         XCTAssertEqual(beacon.viewName, viewName)
-        XCTAssertTrue(beacon.id.uuidString.count > 0)
+        XCTAssertTrue(beacon.id.count > 0)
         XCTAssertEqual(beacon.timestamp, marker.startTime)
         XCTAssertEqual(beacon.duration, marker.duration)
         XCTAssertEqual(beacon.method, "m")
@@ -352,7 +352,7 @@ class HTTPMarkerTests: InstanaTestCase {
         }
 
         // Then
-        XCTAssertTrue(beacon.id.uuidString.count > 0)
+        XCTAssertTrue(beacon.id.count > 0)
         XCTAssertEqual(beacon.timestamp, marker.startTime)
         XCTAssertEqual(beacon.duration, marker.duration)
         XCTAssertEqual(beacon.method, "t")
@@ -377,7 +377,7 @@ class HTTPMarkerTests: InstanaTestCase {
         }
 
         // Then
-        XCTAssertTrue(beacon.id.uuidString.count > 0)
+        XCTAssertTrue(beacon.id.count > 0)
         XCTAssertEqual(beacon.timestamp, marker.startTime)
         XCTAssertEqual(beacon.duration, marker.duration)
         XCTAssertEqual(beacon.method, "c")

Tests/InstanaAgentTests/Utils_Tests/InstanaPersistableQueueTests.swift

@@ -47,7 +47,7 @@ class InstanaPersistableQueueTests: InstanaTestCase {
     func test_add_Queue_ignore_dups() {
         // Given
         let sessionID = UUID()
-        let id = 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")
         let beacon2 = CoreBeacon.createDefault(viewName: "View_2", key: "Key_2", timestamp: 0,
@@ -71,15 +71,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: UUID(), mobileFeatures: "c")]
+        let oldBeacons = [CoreBeacon.createDefault(viewName: "V", key: "K", timestamp: 1, sid: UUID(),
+                          usi: session.usi, id: Beacon.generateUniqueIdImpl(), mobileFeatures: "c")]
         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: UUID(), mobileFeatures: "c")]
+        let newBeacons = [CoreBeacon.createDefault(viewName: "V", key: "K", timestamp: 2, sid: UUID(),
+                          usi: session.usi, id: Beacon.generateUniqueIdImpl(), mobileFeatures: "c")]
         queueHandler = InstanaPersistableQueue<CoreBeacon>(identifier: "queue", maxItems: 100)
         queueHandler.add(newBeacons) {result in
             AssertTrue(result.error == nil)
@@ -95,7 +95,7 @@ class InstanaPersistableQueueTests: InstanaTestCase {
     //
     func test_persisted_beacons_avoid_dups() {
         // Given
-        let id = UUID()
+        let id = Beacon.generateUniqueIdImpl()
         let oldBeacons = [CoreBeacon.createDefault(viewName: "V", key: "K", timestamp: 1,
                                      sid: UUID(), usi: session.usi, id: id, mobileFeatures: "c")]
         var queueHandler = InstanaPersistableQueue<CoreBeacon>(identifier: "queue", maxItems: 100)