[FSSDK-10761] feat: make vuid as opt-in

Sources/ODP/OdpEventManager.swift

@@ -49,7 +49,7 @@ open class OdpEventManager {
 
     // MARK: - events
 
-    func registerVUID(vuid: String) {
+    func sendInitializedEvent(vuid: String) {
         sendEvent(type: Constants.ODP.eventType,
                   action: "client_initialized",
                   identifiers: [

Sources/ODP/OdpManager.swift

@@ -18,17 +18,13 @@ import Foundation
 
 public class OdpManager {
     var enabled: Bool
-    var vuidManager: OdpVuidManager
-
     var odpConfig: OdpConfig!
     var segmentManager: OdpSegmentManager!
     var eventManager: OdpEventManager!
 
     let logger = OPTLoggerFactory.getLogger()
 
-    var vuid: String {
-        return vuidManager.vuid
-    }
+    var vuid: String?
 
     /// OdpManager init
     /// - Parameters:
@@ -42,6 +38,7 @@ public class OdpManager {
     ///   - eventManager: ODPEventManager
     public init(sdkKey: String,
                 disable: Bool,
+                vuid: String? = nil,
                 cacheSize: Int,
                 cacheTimeoutInSecs: Int,
                 timeoutForSegmentFetchInSecs: Int? = nil,
@@ -50,8 +47,7 @@ public class OdpManager {
                 eventManager: OdpEventManager? = nil) {
 
         self.enabled = !disable
-        self.vuidManager = OdpVuidManager.shared
-
+        self.vuid = vuid
         guard enabled else {
             logger.i(.odpNotEnabled)
             return
@@ -65,8 +61,9 @@ public class OdpManager {
         self.odpConfig = OdpConfig()
         self.segmentManager.odpConfig = odpConfig
         self.eventManager.odpConfig = odpConfig
-
-        self.eventManager.registerVUID(vuid: self.vuidManager.vuid)
+        if let vuid = vuid, OdpVuidManager.isVuid(vuid) {
+            self.eventManager.sendInitializedEvent(vuid: vuid)
+        }
     }
 
     func fetchQualifiedSegments(userId: String,
@@ -97,15 +94,13 @@ public class OdpManager {
             return
         }
 
-        var vuid = vuidManager.vuid
-        var fsUserId: String? = userId
         if OdpVuidManager.isVuid(userId) {
             // overwrite if userId is vuid (when userContext is created with vuid)
-            vuid = userId
-            fsUserId = nil
+            eventManager.identifyUser(vuid: userId, userId: nil)
+        } else if let _vuid = vuid {
+            eventManager.identifyUser(vuid: _vuid, userId: userId)
         }
 
-        eventManager.identifyUser(vuid: vuid, userId: fsUserId)
     }
 
     /// Send an event to the ODP server.
@@ -125,15 +120,13 @@ public class OdpManager {
 
         let typeUpdated = (type ?? "").isEmpty ? Constants.ODP.eventType : type!
 
-        // add vuid to all events by default
-
         var identifiersUpdated = identifiers
-        if identifiers[Constants.ODP.keyForVuid] == nil {
-            identifiersUpdated[Constants.ODP.keyForVuid] = vuidManager.vuid
+        let _vuid = vuid ?? ""
+        if identifiers[Constants.ODP.keyForVuid] == nil, OdpVuidManager.isVuid(_vuid) {
+            identifiersUpdated[Constants.ODP.keyForVuid] = _vuid
         }
 
         // replace aliases (fs-user-id, FS_USER_ID, FS-USER-ID) with "fs_user_id".
-
         for (idKey, idValue) in identifiersUpdated {
             if idKey == Constants.ODP.keyForUserId { break }
 

Sources/ODP/OdpVuidManager.swift

@@ -17,14 +17,17 @@
 import Foundation
 
 class OdpVuidManager {
-    var vuid: String = ""
+    private var _vuid: String = ""
+    private(set) var enabled: Bool
     let logger = OPTLoggerFactory.getLogger()
-
-    // a single vuid should be shared for all SDK instances
-    static let shared = OdpVuidManager()
 
-    init() {
-        self.vuid = load()
+    init(enabled: Bool) {
+        self.enabled = enabled
+        if enabled {
+            self._vuid = load()
+        } else {
+            self.remove()
+        }
     }
 
     static var newVuid: String {
@@ -35,7 +38,7 @@ class OdpVuidManager {
         let vuid = (vuidFull.count <= maxLength) ? vuidFull : String(vuidFull.prefix(maxLength))
         return vuid
     }
-    
+
     static func isVuid(_ visitorId: String) -> Bool {
         return visitorId.starts(with: "vuid_")
     }
@@ -45,6 +48,14 @@ class OdpVuidManager {
 // MARK: - VUID Store
 
 extension OdpVuidManager {
+    var vuid: String {
+        if enabled {
+            return _vuid
+        } else {
+            logger.w("VUID is not enabled.")
+            return ""
+        }
+    }
 
     private var keyForVuid: String {
         return "optimizely-vuid"
@@ -59,7 +70,12 @@ extension OdpVuidManager {
         save(vuid: vuid)
         return vuid
     }
-
+
+    private func remove() {
+        UserDefaults.standard.set(nil, forKey: keyForVuid)
+        UserDefaults.standard.synchronize()
+    }
+
     private func save(vuid: String) {
         UserDefaults.standard.set(vuid, forKey: keyForVuid)
         UserDefaults.standard.synchronize()

Sources/ODP/OptimizelySdkSettings.swift

@@ -27,6 +27,8 @@ public struct OptimizelySdkSettings {
     let timeoutForOdpEventInSecs: Int
     /// ODP features are disabled if this is set to true.
     let disableOdp: Bool
+    /// VUID is enabled if this is set to true.
+    let enableVuid: Bool
 
     /// Optimizely SDK Settings
     ///
@@ -43,13 +45,15 @@ public struct OptimizelySdkSettings {
                 timeoutForSegmentFetchInSecs: Int = 10,
                 timeoutForOdpEventInSecs: Int = 10,
                 disableOdp: Bool = false,
+                enabledVuid: Bool = false,
                 sdkName: String? = nil,
                 sdkVersion: String? = nil) {
         self.segmentsCacheSize = segmentsCacheSize
         self.segmentsCacheTimeoutInSecs = segmentsCacheTimeoutInSecs
         self.timeoutForSegmentFetchInSecs = timeoutForSegmentFetchInSecs
         self.timeoutForOdpEventInSecs = timeoutForOdpEventInSecs
         self.disableOdp = disableOdp
+        self.enableVuid = enabledVuid
         if let _sdkName = sdkName, _sdkName != "" {
             Utils.swiftSdkClientName = _sdkName
         }

Sources/Optimizely+Decide/OptimizelyClient+Decide.swift

@@ -35,7 +35,11 @@ extension OptimizelyClient {
     ///
     /// - Parameter attributes: A map of attribute names to current user attribute values.
     /// - Returns: An OptimizelyUserContext associated with this OptimizelyClient
-    public func createUserContext(attributes: [String: Any]? = nil) -> OptimizelyUserContext {
+    public func createUserContext(attributes: [String: Any]? = nil) -> OptimizelyUserContext? {
+        guard enableVuid, OdpVuidManager.isVuid(vuid) else {
+            logger.e("Vuid is not enabled or invalid VUID. User context not created.")
+            return nil
+        }
         return OptimizelyUserContext(optimizely: self, userId: vuid, attributes: attributes)
     }
 

Sources/Optimizely+Decide/OptimizelyUserContext.swift

@@ -84,7 +84,6 @@ public class OptimizelyUserContext {
         self.atomicAttributes = AtomicProperty(property: attributes, lock: lock)
         self.atomicForcedDecisions = AtomicProperty(property: nil, lock: lock)
         self.atomicQualifiedSegments = AtomicProperty(property: nil, lock: lock)
-
         if identify {
             // async call so event building overhead is not blocking context creation
             lock.async {

Sources/Optimizely/OptimizelyClient.swift

@@ -60,6 +60,7 @@ open class OptimizelyClient: NSObject {
     var decisionService: OPTDecisionService!
     public var notificationCenter: OPTNotificationCenter?
     public var odpManager: OdpManager!
+    private var vuidManager: OdpVuidManager!
     let sdkSettings: OptimizelySdkSettings
 
     // MARK: - Public interfaces
@@ -91,13 +92,15 @@ open class OptimizelyClient: NSObject {
         self.defaultDecideOptions = defaultDecideOptions ?? []
 
         super.init()
-
+        self.vuidManager = OdpVuidManager(enabled: sdkSettings.enableVuid) 
         self.odpManager = odpManager ?? OdpManager(sdkKey: sdkKey,
                                                    disable: sdkSettings.disableOdp,
+                                                   vuid: vuidManager.vuid,
                                                    cacheSize: sdkSettings.segmentsCacheSize,
                                                    cacheTimeoutInSecs: sdkSettings.segmentsCacheTimeoutInSecs,
                                                    timeoutForSegmentFetchInSecs: sdkSettings.timeoutForSegmentFetchInSecs,
                                                    timeoutForEventDispatchInSecs: sdkSettings.timeoutForOdpEventInSecs)
+
         let userProfileService = userProfileService ?? DefaultUserProfileService()
         let logger = logger ?? DefaultLogger()
         type(of: logger).logLevel = defaultLogLevel ?? .info
@@ -972,7 +975,11 @@ extension OptimizelyClient {
 
     /// the device vuid (read only)
     public var vuid: String {
-        return odpManager.vuid
+        return self.vuidManager.vuid
+    }
+
+    public var enableVuid: Bool {
+        return self.vuidManager.enabled
     }
 
     func identifyUserToOdp(userId: String) {

Tests/OptimizelyTests-APIs/OptimizelyClientTests_Decide.swift

@@ -24,7 +24,9 @@ class OptimizelyClientTests_Decide: XCTestCase {
         super.setUp()
 
         let datafile = OTUtils.loadJSONDatafile("api_datafile")!
-        optimizely = OptimizelyClient(sdkKey: OTUtils.randomSdkKey)
+        let settings = OptimizelySdkSettings(enabledVuid: true)
+        optimizely = OptimizelyClient(sdkKey: OTUtils.randomSdkKey, settings: settings)
+
         try! optimizely.start(datafile: datafile)
     }
 
@@ -54,11 +56,11 @@ class OptimizelyClientTests_Decide: XCTestCase {
 
         let user = optimizely.createUserContext(attributes: attributes)
 
-        XCTAssert(user.optimizely == optimizely)
-        XCTAssert(user.userId == optimizely.vuid, "vuid should be used as the default userId when not given")
-        XCTAssert(user.attributes["country"] as! String == "us")
-        XCTAssert(user.attributes["age"] as! Int == 100)
-        XCTAssert(user.attributes["old"] as! Bool == true)
+        XCTAssert(user?.optimizely == optimizely)
+        XCTAssert(user?.userId == optimizely.vuid, "vuid should be used as the default userId when not given")
+        XCTAssert(user?.attributes["country"] as! String == "us")
+        XCTAssert(user?.attributes["age"] as! Int == 100)
+        XCTAssert(user?.attributes["old"] as! Bool == true)
     }
 
     func testCreateUserContext_multiple() {

Tests/OptimizelyTests-APIs/OptimizelyClientTests_ODP.swift

@@ -187,10 +187,19 @@ class OptimizelyClientTests_ODP: XCTestCase {
 
     // MARK: - vuid
 
-    func testVuid() {
+    func testVuidEnabled() {
+        let settings = OptimizelySdkSettings(enabledVuid: true)
+        optimizely = OptimizelyClient(sdkKey: OTUtils.randomSdkKey, settings: settings)
+        XCTAssertTrue(optimizely.enableVuid)
         XCTAssert(optimizely.vuid.starts(with: "vuid_"))
     }
 
+    func testVuidDiabled() {
+        // Default client vuid diabled
+        XCTAssertFalse(optimizely.enableVuid)
+        XCTAssert(optimizely.vuid.isEmpty)
+    }
+
     // MARK: - OdpConfig Update
 
     func testUpdateOpdConfigCalled_wheneverProjectConfigUpdated_initialOrPolling() {

Tests/OptimizelyTests-Common/OdpEventManagerTests.swift

@@ -89,7 +89,7 @@ class OdpEventManagerTests: XCTestCase {
     }
 
     func testRegisterVUID_noApiKey() {
-        manager.registerVUID(vuid: "v1")
+        manager.sendInitializedEvent(vuid: "v1")
 
         XCTAssertEqual(1, manager.eventQueue.count)
 
@@ -149,7 +149,7 @@ class OdpEventManagerTests: XCTestCase {
 
         XCTAssertTrue(manager.odpConfig.eventQueueingAllowed, "initially datafile not ready and assumed queueing is allowed")
 
-        manager.registerVUID(vuid: "v1")    // each of these will try to flush
+        manager.sendInitializedEvent(vuid: "v1")    // each of these will try to flush
         manager.identifyUser(vuid: "v1", userId: "u1")
         manager.sendEvent(type: "t1", action: "a1", identifiers: [:], data: [:])
 
@@ -184,7 +184,7 @@ class OdpEventManagerTests: XCTestCase {
 
         XCTAssertTrue(manager.odpConfig.eventQueueingAllowed, "initially datafile not ready and assumed queueing is allowed")
 
-        manager.registerVUID(vuid: "v1")    // each of these will try to flush
+        manager.sendInitializedEvent(vuid: "v1")    // each of these will try to flush
         manager.identifyUser(vuid: "v1", userId: "u1")
         manager.sendEvent(type: "t1", action: "a1", identifiers: [:], data: [:])
 
@@ -215,7 +215,7 @@ class OdpEventManagerTests: XCTestCase {
     func testFlush_maxSize() {
         manager.maxQueueSize = 2
 
-        manager.registerVUID(vuid: "v1")    // each of these will try to flush
+        manager.sendInitializedEvent(vuid: "v1")    // each of these will try to flush
         manager.identifyUser(vuid: "v1", userId: "u1")
         manager.sendEvent(type: "t1", action: "a1", identifiers: [:], data: [:])