fix: Fixes user.id not set to installationId if no user is set (#7005)

* fix: Fixes `user.id` not set to installationId if no user is set

* Update changelog

* Add cached only method to `SentryInstallation`

* Fix tests

Author: itaybre

CHANGELOG.md

@@ -11,6 +11,7 @@
 
 - Disabled automatic session tracking in system extensions to prevent extension blocking and unwanted dock icon behavior (#6962) (#6962)
 - Fixes crash when null values are passed to `UIApplication sendAction:to:from:forEvent:` (#6970)
+- Fixes `user.id` not set to installationId if no user is set (#7005)
 
 ## 9.0.0
 

Sources/Sentry/SentryInstallation.m

@@ -83,6 +83,13 @@ + (NSString *)installationFilePath:(NSString *)cacheDirectoryPath
     return [cacheDirectoryPath stringByAppendingPathComponent:@"INSTALLATION"];
 }
 
++ (nullable NSString *)cachedIdWithCacheDirectoryPath:(NSString *)cacheDirectoryPath
+{
+    @synchronized(self) {
+        return self.installationStringsByCacheDirectoryPaths[cacheDirectoryPath];
+    }
+}
+
 @end
 
 NS_ASSUME_NONNULL_END

Sources/Sentry/include/SentryInstallation.h

@@ -12,6 +12,8 @@ NS_ASSUME_NONNULL_BEGIN
 
 + (void)cacheIDAsyncWithCacheDirectoryPath:(NSString *)cacheDirectoryPath;
 
++ (nullable NSString *)cachedIdWithCacheDirectoryPath:(NSString *)cacheDirectoryPath;
+
 @end
 
 NS_ASSUME_NONNULL_END

Sources/Sentry/include/SentryPrivate.h

@@ -51,6 +51,7 @@
 #import "SentryDeviceContextKeys.h"
 #import "SentryFileIOTrackerHelper.h"
 #import "SentryFileManagerHelper.h"
+#import "SentryInstallation.h"
 #import "SentryMeta.h"
 #import "SentryMsgPackSerializer.h"
 #import "SentryNSDictionarySanitize.h"

Sources/Swift/Tools/SentryLogBatcher.swift

@@ -91,6 +91,7 @@ import Foundation
         addUserAttributes(to: &log.attributes, scope: scope)
         addReplayAttributes(to: &log.attributes, scope: scope)
         addScopeAttributes(to: &log.attributes, scope: scope)
+        addDefaultUserIdIfNeeded(to: &log.attributes, scope: scope, options: options)
 
         let propagationContextTraceIdString = scope.propagationContextTraceIdString
         log.traceId = SentryId(uuidString: propagationContextTraceIdString)
@@ -195,6 +196,18 @@ import Foundation
             attributes[key] = .init(value: value)
         }
     }
+    
+    private func addDefaultUserIdIfNeeded(to attributes: inout [String: SentryLog.Attribute], scope: Scope, options: Options) {
+        guard attributes["user.id"] == nil && attributes["user.name"] == nil && attributes["user.email"] == nil else {
+            return
+        }
+        
+        if let installationId = SentryInstallation.cachedId(withCacheDirectoryPath: options.cacheDirectoryPath) {
+            // We only want to set the id if the customer didn't set a user so we at least set something to
+            // identify the user.
+            attributes["user.id"] = .init(value: installationId)
+        }
+    }
 
     // Only ever call this from the serial dispatch queue.
     private func encodeAndBuffer(log: SentryLog) {

Tests/SentryTests/SentryLogBatcherTests.swift

@@ -414,8 +414,9 @@ final class SentryLogBatcherTests: XCTestCase {
         XCTAssertNil(attributes["user.email"])
     }
 
-    func testAddLog_DoesNotAddUserAttributesWhenNoUser() throws {
+    func testAddLog_NoUserAtributesAreSetIfInstallationIdIsNotCached() throws {
         // No user set on scope
+        // InstallationId not cached
 
         let log = createTestLog(body: "Test log message without user")
         sut.addLog(log, scope: scope)
@@ -430,6 +431,25 @@ final class SentryLogBatcherTests: XCTestCase {
         XCTAssertNil(attributes["user.email"])
     }
 
+    func testAddLog_OnlySetsUserIdToInstallationIdWhenNoUserIsSet() throws {
+        // No user set on scope
+        // Create and cache installationId
+        _ = SentryInstallation.id(withCacheDirectoryPath: options.cacheDirectoryPath)
+        
+        let log = createTestLog(body: "Test log message without user")
+        sut.addLog(log, scope: scope)
+        sut.captureLogs()
+        
+        let capturedLogs = testDelegate.getCapturedLogs()
+        let capturedLog = try XCTUnwrap(capturedLogs.first)
+        let attributes = capturedLog.attributes
+        
+        XCTAssertNotNil(attributes["user.id"])
+        XCTAssertEqual(attributes["user.id"]?.value as? String, SentryInstallation.id(withCacheDirectoryPath: options.cacheDirectoryPath))
+        XCTAssertNil(attributes["user.name"])
+        XCTAssertNil(attributes["user.email"])
+    }
+    
     func testAddLog_AddsOSAndDeviceAttributes() throws {
         let osContext = ["name": "iOS", "version": "16.0.1"]
         let deviceContext = ["family": "iOS", "model": "iPhone14,4"]

Tests/SentryTests/State/SentryInstallationTests.swift

@@ -72,4 +72,17 @@ final class SentryInstallationTests: XCTestCase {
         XCTAssertEqual(cachedID, nonCachedID)
 
     }
+    
+    func testCachedIDIsNilWhenNoInstallationIsFound() {
+        let cachedID = SentryInstallation.cachedId(withCacheDirectoryPath: basePath)
+        XCTAssertNil(cachedID)
+    }
+    
+    func testCachedID_returnsActuallyCachedId() {
+        let id1 = SentryInstallation.id(withCacheDirectoryPath: basePath)
+        
+        let cachedID = SentryInstallation.cachedId(withCacheDirectoryPath: basePath)
+        
+        XCTAssertEqual(id1, cachedID)
+    }
 }