Add vuid optln feature

Author: muzahidul-opti

Sources/ODP/OdpManager.swift

@@ -18,6 +18,7 @@ import Foundation
 
 public class OdpManager {
     var enabled: Bool
+    var enableVuid: Bool
     var vuidManager: OdpVuidManager
 
     var odpConfig: OdpConfig!
@@ -42,6 +43,7 @@ public class OdpManager {
     ///   - eventManager: ODPEventManager
     public init(sdkKey: String,
                 disable: Bool,
+                enableVuid: Bool,
                 cacheSize: Int,
                 cacheTimeoutInSecs: Int,
                 timeoutForSegmentFetchInSecs: Int? = nil,
@@ -50,7 +52,8 @@ public class OdpManager {
                 eventManager: OdpEventManager? = nil) {
 
         self.enabled = !disable
-        self.vuidManager = OdpVuidManager.shared
+        self.enableVuid = enableVuid
+        self.vuidManager = OdpVuidManager(enabled: enableVuid)
 
         guard enabled else {
             logger.i(.odpNotEnabled)
@@ -65,8 +68,10 @@ public class OdpManager {
         self.odpConfig = OdpConfig()
         self.segmentManager.odpConfig = odpConfig
         self.eventManager.odpConfig = odpConfig
+        if enableVuid {
+            self.eventManager.registerVUID(vuid: self.vuidManager.vuid)
+        }
 
-        self.eventManager.registerVUID(vuid: self.vuidManager.vuid)
     }
 
     func fetchQualifiedSegments(userId: String,
@@ -97,15 +102,17 @@ 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
+        if enableVuid {
+            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: vuid, userId: fsUserId)
         }
 
-        eventManager.identifyUser(vuid: vuid, userId: fsUserId)
     }
 
     /// Send an event to the ODP server.
@@ -125,13 +132,19 @@ 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
+        
+        if enableVuid {
+            // add vuid to all events by default
+            if identifiers[Constants.ODP.keyForVuid] == nil {
+                identifiersUpdated[Constants.ODP.keyForVuid] = vuidManager.vuid
+            }
+        } else {
+            // remove vuid events
+            identifiersUpdated[Constants.ODP.keyForVuid] = nil
         }
 
+        
         // replace aliases (fs-user-id, FS_USER_ID, FS-USER-ID) with "fs_user_id".
 
         for (idKey, idValue) in identifiersUpdated {

Sources/ODP/OdpVuidManager.swift

@@ -17,14 +17,17 @@
 import Foundation
 
 class OdpVuidManager {
-    var vuid: String = ""
+    private var _vuid: String = ""
+    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 {
@@ -45,6 +48,13 @@ class OdpVuidManager {
 // MARK: - VUID Store
 
 extension OdpVuidManager {
+    var vuid: String {
+        if enabled {
+            return _vuid
+        } else {
+            return ""
+        }
+    }
 
     private var keyForVuid: String {
         return "optimizely-vuid"
@@ -59,7 +69,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 sdkSettings.enableVuid else {
+            logger.e("Vuid is not enabled. User context creation failed.")
+            return nil
+        }
         return OptimizelyUserContext(optimizely: self, userId: vuid, attributes: attributes)
     }
 

Sources/Optimizely/OptimizelyClient.swift

@@ -94,6 +94,7 @@ open class OptimizelyClient: NSObject {
 
         self.odpManager = odpManager ?? OdpManager(sdkKey: sdkKey,
                                                    disable: sdkSettings.disableOdp,
+                                                   enableVuid: sdkSettings.enableVuid,
                                                    cacheSize: sdkSettings.segmentsCacheSize,
                                                    cacheTimeoutInSecs: sdkSettings.segmentsCacheTimeoutInSecs,
                                                    timeoutForSegmentFetchInSecs: sdkSettings.timeoutForSegmentFetchInSecs,