feat: call UPS once during batch decideForKeys or decideAll

Author: mikechu-optimizely

OptimizelySDK/Bucketing/DecisionService.cs

@@ -1,18 +1,18 @@
 /*
-* Copyright 2017-2022, Optimizely
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* https://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*/
+ * Copyright 2017-2022, 2024 Optimizely
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 
 using System;
 using System.Collections.Generic;
@@ -43,6 +43,22 @@ public class DecisionService
         private IErrorHandler ErrorHandler;
         private UserProfileService UserProfileService;
         private ILogger Logger;
+        private UserProfile _userProfile;
+
+        private bool _decisionBatchInProgress = false;
+
+        public bool DecisionBatchInProgress
+        {
+            get => _decisionBatchInProgress;
+            set
+            {
+                _decisionBatchInProgress = value;
+                if (!_decisionBatchInProgress)
+                {
+                    SaveToUserProfileService();
+                }
+            }
+        }
 
         /// <summary>
         /// Associative array of user IDs to an associative array
@@ -60,10 +76,10 @@ public class DecisionService
         /// <summary>
         ///  Initialize a decision service for the Optimizely client.
         /// </summary>
-        /// <param name = "bucketer" > Base bucketer to allocate new users to an experiment.</param>
-        /// <param name = "errorHandler" > The error handler of the Optimizely client.</param>
-        /// <param name = "userProfileService" ></ param >
-        /// < param name= "logger" > UserProfileService implementation for storing user info.</param>
+        /// <param name="bucketer"> Base bucketer to allocate new users to an experiment.</param>
+        /// <param name="errorHandler"> The error handler of the Optimizely client.</param>
+        /// <param name="userProfileService">The injected implementation providing control over the bucketing.</param >
+        /// < param name="logger"> UserProfileService implementation for storing user info.</param>
         public DecisionService(Bucketer bucketer, IErrorHandler errorHandler,
             UserProfileService userProfileService, ILogger logger
         )
@@ -85,7 +101,7 @@ public DecisionService(Bucketer bucketer, IErrorHandler errorHandler,
         /// Get a Variation of an Experiment for a user to be allocated into.
         /// </summary>
         /// <param name = "experiment" > The Experiment the user will be bucketed into.</param>
-        /// <param name = "user" > Optimizely user context.
+        /// <param name = "user" > Optimizely user context.</param>
         /// <param name = "config" > Project config.</param>
         /// <returns>The Variation the user is allocated into.</returns>
         public virtual Result<Variation> GetVariation(Experiment experiment,
@@ -99,10 +115,10 @@ ProjectConfig config
         /// <summary>
         /// Get a Variation of an Experiment for a user to be allocated into.
         /// </summary>
-        /// <param name = "experiment" > The Experiment the user will be bucketed into.</param>
-        /// <param name = "user" > optimizely user context.
-        /// <param name = "config" > Project Config.</param>
-        /// <param name = "options" >An array of decision options.</param>
+        /// <param name="experiment">The Experiment the user will be bucketed into.</param>
+        /// <param name="user">optimizely user context.</param>
+        /// <param name="config">Project Config.</param>
+        /// <param name="options">An array of decision options.</param>
         /// <returns>The Variation the user is allocated into.</returns>
         public virtual Result<Variation> GetVariation(Experiment experiment,
             OptimizelyUserContext user,
@@ -140,35 +156,42 @@ OptimizelyDecideOption[] options
             var ignoreUPS = Array.Exists(options,
                 option => option == OptimizelyDecideOption.IGNORE_USER_PROFILE_SERVICE);
 
-            UserProfile userProfile = null;
+
             if (!ignoreUPS && UserProfileService != null)
             {
                 try
                 {
-                    var userProfileMap = UserProfileService.Lookup(user.GetUserId());
-                    if (userProfileMap != null &&
-                        UserProfileUtil.IsValidUserProfileMap(userProfileMap))
+                    if (_userProfile == null)
+                    {
+                        var userProfileMap = UserProfileService.Lookup(user.GetUserId());
+                        if (userProfileMap != null &&
+                            UserProfileUtil.IsValidUserProfileMap(userProfileMap))
+                        {
+                            _userProfile = UserProfileUtil.ConvertMapToUserProfile(userProfileMap);
+                        }
+                        else if (userProfileMap == null)
+                        {
+                            Logger.Log(LogLevel.INFO,
+                                reasons.AddInfo(
+                                    "We were unable to get a user profile map from the UserProfileService."));
+                        }
+                        else
+                        {
+                            Logger.Log(LogLevel.ERROR,
+                                reasons.AddInfo("The UserProfileService returned an invalid map."));
+                        }
+                    }
+
+                    if (_userProfile != null)
                     {
-                        userProfile = UserProfileUtil.ConvertMapToUserProfile(userProfileMap);
                         decisionVariationResult =
-                            GetStoredVariation(experiment, userProfile, config);
+                            GetStoredVariation(experiment, _userProfile, config);
                         reasons += decisionVariationResult.DecisionReasons;
                         if (decisionVariationResult.ResultObject != null)
                         {
                             return decisionVariationResult.SetReasons(reasons);
                         }
                     }
-                    else if (userProfileMap == null)
-                    {
-                        Logger.Log(LogLevel.INFO,
-                            reasons.AddInfo(
-                                "We were unable to get a user profile map from the UserProfileService."));
-                    }
-                    else
-                    {
-                        Logger.Log(LogLevel.ERROR,
-                            reasons.AddInfo("The UserProfileService returned an invalid map."));
-                    }
                 }
                 catch (Exception exception)
                 {
@@ -197,11 +220,7 @@ OptimizelyDecideOption[] options
                 {
                     if (UserProfileService != null && !ignoreUPS)
                     {
-                        var bucketerUserProfile = userProfile ??
-                                                  new UserProfile(userId,
-                                                      new Dictionary<string, Decision>());
-                        SaveVariation(experiment, decisionVariationResult.ResultObject,
-                            bucketerUserProfile);
+                        SaveVariation(experiment, decisionVariationResult.ResultObject);
                     }
                     else
                     {
@@ -454,12 +473,9 @@ ProjectConfig config
         /// <summary>
         /// Save a { @link Variation } of an { @link Experiment } for a user in the {@link UserProfileService}.
         /// </summary>
-        /// <param name = "experiment" > The experiment the user was buck</param>
-        /// <param name = "variation" > The Variation to save.</param>
-        /// <param name = "userProfile" > instance of the user information.</param>
-        public void SaveVariation(Experiment experiment, Variation variation,
-            UserProfile userProfile
-        )
+        /// <param name="experiment">The experiment the user was buck</param>
+        /// <param name="variation">The Variation to save.</param>
+        public void SaveVariation(Experiment experiment, Variation variation)
         {
             //only save if the user has implemented a user profile service
             if (UserProfileService == null)
@@ -468,28 +484,58 @@ UserProfile userProfile
             }
 
             Decision decision;
-            if (userProfile.ExperimentBucketMap.ContainsKey(experiment.Id))
+            if (_userProfile.ExperimentBucketMap.ContainsKey(experiment.Id))
             {
-                decision = userProfile.ExperimentBucketMap[experiment.Id];
+                decision = _userProfile.ExperimentBucketMap[experiment.Id];
                 decision.VariationId = variation.Id;
             }
             else
             {
                 decision = new Decision(variation.Id);
             }
 
-            userProfile.ExperimentBucketMap[experiment.Id] = decision;
+            _userProfile.ExperimentBucketMap[experiment.Id] = decision;
+
+            if (!_decisionBatchInProgress)
+            {
+                SaveToUserProfileService(experiment, variation);
+            }
+        }
 
+        private void SaveToUserProfileService(Experiment experiment = null,
+            Variation variation = null
+        )
+        {
+            var useSpecificLogEntry = experiment != null && variation != null &&
+                                       !string.IsNullOrEmpty(_userProfile?.UserId);
+            
             try
             {
-                UserProfileService.Save(userProfile.ToMap());
-                Logger.Log(LogLevel.INFO,
-                    $"Saved variation \"{variation.Id}\" of experiment \"{experiment.Id}\" for user \"{userProfile.UserId}\".");
+                if (_userProfile != null)
+                {
+                    UserProfileService.Save(_userProfile.ToMap());
+                    if (useSpecificLogEntry)
+                    {
+                        Logger.Log(LogLevel.INFO,
+                            $"Saved variation \"{variation.Id}\" of experiment \"{experiment.Id}\" for user \"{_userProfile.UserId}\".");
+                    }
+                    else
+                    {
+                        Logger.Log(LogLevel.INFO, "Saved user profile after batch decision.");
+                    }
+                }
             }
             catch (Exception exception)
             {
-                Logger.Log(LogLevel.ERROR,
-                    $"Failed to save variation \"{variation.Id}\" of experiment \"{experiment.Id}\" for user \"{userProfile.UserId}\".");
+                if (useSpecificLogEntry)
+                {
+                    Logger.Log(LogLevel.ERROR,
+                        $"Failed to save variation \"{variation.Id}\" of experiment \"{experiment.Id}\" for user \"{_userProfile.UserId}\".");
+                }
+                else
+                {
+                    Logger.Log(LogLevel.ERROR, "Failed to save user profile after batch decision.");
+                }
                 ErrorHandler.HandleError(
                     new Exceptions.OptimizelyRuntimeException(exception.Message));
             }

OptimizelySDK/Optimizely.cs

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2023, Optimizely
+ * Copyright 2017-2024, Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use file except in compliance with the License.
@@ -223,8 +223,8 @@ public Optimizely(ProjectConfigManager configManager,
 
             if (ProjectConfigManager.SdkKey != null)
             {
-                NotificationCenterRegistry.GetNotificationCenter(configManager.SdkKey, logger)
-                    ?.AddNotification(NotificationCenter.NotificationType.OptimizelyConfigUpdate,
+                NotificationCenterRegistry.GetNotificationCenter(configManager.SdkKey, logger)?.
+                    AddNotification(NotificationCenter.NotificationType.OptimizelyConfigUpdate,
                         () =>
                         {
                             projectConfig = ProjectConfigManager.CachedProjectConfig;
@@ -268,10 +268,9 @@ private void InitializeComponents(IEventDispatcher eventDispatcher = null,
                 Logger);
             DefaultDecideOptions = defaultDecideOptions ?? new OptimizelyDecideOption[] { };
 #if USE_ODP
-            OdpManager = odpManager ?? new OdpManager.Builder()
-                .WithErrorHandler(errorHandler)
-                .WithLogger(logger)
-                .Build();
+            OdpManager = odpManager ?? new OdpManager.Builder().WithErrorHandler(errorHandler).
+                WithLogger(logger).
+                Build();
 #endif
         }
 
@@ -442,8 +441,8 @@ private Variation GetVariation(string experimentKey, string userId, ProjectConfi
             userAttributes = userAttributes ?? new UserAttributes();
 
             var userContext = CreateUserContextCopy(userId, userAttributes);
-            var variation = DecisionService.GetVariation(experiment, userContext, config)
-                ?.ResultObject;
+            var variation = DecisionService.GetVariation(experiment, userContext, config)?.
+                ResultObject;
             var decisionInfo = new Dictionary<string, object>
             {
                 { "experimentKey", experimentKey }, { "variationKey", variation?.Key },
@@ -553,8 +552,8 @@ public virtual bool IsFeatureEnabled(string featureKey, string userId,
             var sourceInfo = new Dictionary<string, string>();
             var decision = DecisionService.GetVariationForFeature(featureFlag,
                     CreateUserContextCopy(userId, userAttributes),
-                    config)
-                .ResultObject;
+                    config).
+                ResultObject;
             var variation = decision?.Variation;
             var decisionSource = decision?.Source ?? FeatureDecision.DECISION_SOURCE_ROLLOUT;
 
@@ -665,8 +664,8 @@ public virtual T GetFeatureVariableValueForType<T>(string featureKey, string var
             var variableValue = featureVariable.DefaultValue;
             var decision = DecisionService.GetVariationForFeature(featureFlag,
                     CreateUserContextCopy(userId, userAttributes),
-                    config)
-                .ResultObject;
+                    config).
+                ResultObject;
 
             if (decision?.Variation != null)
             {
@@ -981,9 +980,9 @@ OptimizelyDecideOption[] options
                     featureEnabled);
             }
 
-            var reasonsToReport = decisionReasons
-                .ToReport(allOptions.Contains(OptimizelyDecideOption.INCLUDE_REASONS))
-                .ToArray();
+            var reasonsToReport = decisionReasons.
+                ToReport(allOptions.Contains(OptimizelyDecideOption.INCLUDE_REASONS)).
+                ToArray();
             var variationKey = decision?.Variation?.Key;
 
             // TODO: add ruleKey values when available later. use a copy of experimentKey until then.
@@ -1056,6 +1055,7 @@ OptimizelyDecideOption[] options
 
             var allOptions = GetAllOptions(options);
 
+            DecisionService.DecisionBatchInProgress = true;
             foreach (var key in keys)
             {
                 var decision = Decide(user, key, options);
@@ -1066,6 +1066,8 @@ OptimizelyDecideOption[] options
                 }
             }
 
+            DecisionService.DecisionBatchInProgress = false;
+
             return decisionDictionary;
         }
 
@@ -1347,7 +1349,8 @@ List<OdpSegmentOption> segmentOptions
 
             if (config == null)
             {
-                Logger.Log(LogLevel.ERROR, "Datafile has invalid format. Failing 'FetchQualifiedSegments'.");
+                Logger.Log(LogLevel.ERROR,
+                    "Datafile has invalid format. Failing 'FetchQualifiedSegments'.");
                 return null;
             }
 
@@ -1378,7 +1381,8 @@ internal void IdentifyUser(string userId)
         /// <param name="identifiers">Dictionary for identifiers. The caller must provide at least one key-value pair.</param>
         /// <param name="type">Type of event (defaults to `fullstack`)</param>
         /// <param name="data">Optional event data in a key-value pair format</param>
-        public void SendOdpEvent(string action, Dictionary<string, string> identifiers, string type = Constants.ODP_EVENT_TYPE,
+        public void SendOdpEvent(string action, Dictionary<string, string> identifiers,
+            string type = Constants.ODP_EVENT_TYPE,
             Dictionary<string, object> data = null
         )
         {