Added support for multiple user contexts for single sdkKey.

Author: yasirfolio3

ios/Classes/HelperClasses/Constants.swift

@@ -50,6 +50,7 @@ struct DecideOption {
 struct RequestParameterKey {
     static let sdkKey = "sdkKey"
     static let userId = "userID"
+    static let userContextId = "userContextId"
     static let notificationId = "id"
     static let notificationType = "type"
     static let notificationPayload = "payload"

ios/Classes/SwiftOptimizelyFlutterSdkPlugin.swift

@@ -26,11 +26,16 @@ public class SwiftOptimizelyFlutterSdkPlugin: NSObject, FlutterPlugin {
     // to keep track of optimizely clients against their sdkKeys
     var optimizelyClientsTracker = [String: OptimizelyClient?]()
     // to keep track of optimizely user contexts against their sdkKeys
-    var userContextsTracker = [String: OptimizelyUserContext?]()
+    var userContextsTracker = [String: [String: OptimizelyUserContext?]]()
 
     // to communicate with optimizely flutter sdk
     static var channel: FlutterMethodChannel!
 
+    // to track each unique userContext
+    var uuid: String {
+        return UUID().uuidString
+    }
+    
     /// Registers optimizely_flutter_sdk channel to communicate with the flutter sdk to receive requests and send responses
     public static func register(with registrar: FlutterPluginRegistrar) {
         channel = FlutterMethodChannel(name: "optimizely_flutter_sdk", binaryMessenger: registrar.messenger())
@@ -91,7 +96,7 @@ public class SwiftOptimizelyFlutterSdkPlugin: NSObject, FlutterPlugin {
 
         let datafileHandler = DefaultDatafileHandler()
         if let datafileHostPrefix = parameters[RequestParameterKey.datafileHostPrefix] as? String, let datafileHostSuffix = parameters[RequestParameterKey.datafileHostSuffix] as? String {
-            datafileHandler.endPointStringFormat = String(format: datafileHostPrefix + datafileHostSuffix, sdkKey)
+            datafileHandler.endPointStringFormat = String(format: "\(datafileHostPrefix)\(datafileHostSuffix)", sdkKey)
         }
 
         // Delete old user context
@@ -195,12 +200,14 @@ public class SwiftOptimizelyFlutterSdkPlugin: NSObject, FlutterPlugin {
             return
         }
 
-        if let attributes = Utils.getTypedMap(arguments: parameters[RequestParameterKey.attributes] as? Any) {
-            userContextsTracker[sdkKey] = optimizelyClient.createUserContext(userId: userId, attributes: attributes)
+        let userContextId = uuid
+        let userContext = optimizelyClient.createUserContext(userId: userId, attributes: Utils.getTypedMap(arguments: parameters[RequestParameterKey.attributes] as? Any))
+        if userContextsTracker[sdkKey] != nil {
+            userContextsTracker[sdkKey]![userContextId] = userContext
         } else {
-            userContextsTracker[sdkKey] = optimizelyClient.createUserContext(userId: userId)
+            userContextsTracker[sdkKey] = [userContextId: userContext]
         }
-        result(self.createResponse(success: true, reason: SuccessMessage.userContextCreated))
+        result(self.createResponse(success: true,result: [RequestParameterKey.userContextId: userContextId], reason: SuccessMessage.userContextCreated))
     }
 
     /// Sets attributes for the user context.
@@ -379,10 +386,10 @@ public class SwiftOptimizelyFlutterSdkPlugin: NSObject, FlutterPlugin {
 
     /// Returns saved user context
     func getUserContext(arguments: Any?) -> OptimizelyUserContext? {
-        guard let parameters = arguments as? Dictionary<String, Any?>, let sdkKey = parameters[RequestParameterKey.sdkKey] as? String else {
+        guard let parameters = arguments as? Dictionary<String, Any?>, let sdkKey = parameters[RequestParameterKey.sdkKey] as? String, let userContextId = parameters[RequestParameterKey.userContextId] as? String else {
             return nil
         }
-        return userContextsTracker[sdkKey] ?? nil
+        return userContextsTracker[sdkKey]?[userContextId] ?? nil
     }
 
     func createResponse(success: Bool, result: Any? = nil, reason: String? = nil) -> [String: Any] {

lib/src/optimizely_client_wrapper.dart

@@ -105,8 +105,12 @@ class OptimizelyClientWrapper {
       Constants.userID: userId,
       Constants.attributes: Utils.convertToTypedMap(attributes)
     }));
+
     if (result[Constants.responseSuccess] == true) {
-      return OptimizelyUserContext(sdkKey, _channel);
+      final response =
+          Map<String, dynamic>.from(result[Constants.responseResult]);
+      return OptimizelyUserContext(
+          sdkKey, response[Constants.userContextId], _channel);
     }
     return null;
   }

lib/src/user_context/optimizely_user_context.dart

@@ -45,15 +45,17 @@ enum OptimizelyDecideOption {
 ///
 class OptimizelyUserContext {
   final String _sdkKey;
+  final String _userContextId;
   final MethodChannel _channel;
 
-  OptimizelyUserContext(this._sdkKey, this._channel);
+  OptimizelyUserContext(this._sdkKey, this._userContextId, this._channel);
 
   /// Sets attributes for the user context.
   Future<BaseResponse> setAttributes(Map<String, dynamic> attributes) async {
     final result = Map<String, dynamic>.from(
         await _channel.invokeMethod(Constants.setAttributesMethod, {
       Constants.sdkKey: _sdkKey,
+      Constants.userContextId: _userContextId,
       Constants.attributes: Utils.convertToTypedMap(attributes)
     }));
     return BaseResponse(result);
@@ -65,6 +67,7 @@ class OptimizelyUserContext {
     final result = Map<String, dynamic>.from(
         await _channel.invokeMethod(Constants.trackEventMethod, {
       Constants.sdkKey: _sdkKey,
+      Constants.userContextId: _userContextId,
       Constants.eventKey: eventKey,
       Constants.eventTags: Utils.convertToTypedMap(eventTags)
     }));
@@ -101,6 +104,7 @@ class OptimizelyUserContext {
     var result = Map<String, dynamic>.from(
         await _channel.invokeMethod(Constants.decideMethod, {
       Constants.sdkKey: _sdkKey,
+      Constants.userContextId: _userContextId,
       Constants.keys: keys,
       Constants.optimizelyDecideOption: convertedOptions,
     }));
@@ -112,6 +116,7 @@ class OptimizelyUserContext {
       OptimizelyForcedDecision decision) async {
     Map<String, dynamic> request = {
       Constants.sdkKey: _sdkKey,
+      Constants.userContextId: _userContextId,
       Constants.flagKey: context.flagKey,
       Constants.variationKey: decision.variationKey
     };
@@ -128,6 +133,7 @@ class OptimizelyUserContext {
       OptimizelyDecisionContext context) async {
     Map<String, dynamic> request = {
       Constants.sdkKey: _sdkKey,
+      Constants.userContextId: _userContextId,
       Constants.flagKey: context.flagKey,
     };
     if (context.ruleKey != null) {
@@ -144,6 +150,7 @@ class OptimizelyUserContext {
       OptimizelyDecisionContext context) async {
     Map<String, dynamic> request = {
       Constants.sdkKey: _sdkKey,
+      Constants.userContextId: _userContextId,
       Constants.flagKey: context.flagKey,
     };
     if (context.ruleKey != null) {
@@ -159,6 +166,7 @@ class OptimizelyUserContext {
     final result = Map<String, dynamic>.from(
         await _channel.invokeMethod(Constants.removeAllForcedDecisions, {
       Constants.sdkKey: _sdkKey,
+      Constants.userContextId: _userContextId,
     }));
     return BaseResponse(result);
   }

lib/src/utils/constants.dart

@@ -40,6 +40,7 @@ class Constants {
   // Request parameter keys
   static const String id = "id";
   static const String sdkKey = "sdkKey";
+  static const String userContextId = "userContextId";
   static const String userContext = "userContext";
   static const String userID = "userID";
   static const String attributes = "attributes";

test/optimizely_flutter_sdk_test.dart

@@ -92,6 +92,7 @@ void main() {
           return {
             Constants.responseSuccess: true,
             Constants.responseReason: Constants.userContextCreated,
+            Constants.responseResult: {Constants.userContextId: "123"},
           };
         case Constants.setAttributesMethod:
           return {