fix: typechecks added

Author: FarhanAnjum-opti

optimizely/decision_service.py

@@ -35,7 +35,7 @@ class Decision(NamedTuple):
     None if no experiment/variation was selected."""
     experiment: Optional[entities.Experiment]
     variation: Optional[entities.Variation]
-    source: str
+    source: Optional[str]
 
 
 class DecisionService:
@@ -247,7 +247,7 @@ def get_variation(
         project_config: ProjectConfig,
         experiment: entities.Experiment,
         user_context: OptimizelyUserContext,
-        user_profile_tracker: UserProfileTracker,
+        user_profile_tracker: Optional[UserProfileTracker],
         reasons: list[str] = [],
         options: Optional[Sequence[str]] = None
     ) -> tuple[Optional[entities.Variation], list[str]]:
@@ -341,7 +341,8 @@ def get_variation(
             if user_profile_tracker is not None and not ignore_user_profile:
                 try:
                     user_profile_tracker.update_user_profile(experiment, variation)
-                    self.user_profile_service.save(user_profile_tracker.get_user_profile().__dict__)
+                    if self.user_profile_service is not None:
+                        self.user_profile_service.save(user_profile_tracker.get_user_profile().__dict__)
                 except:
                     self.logger.exception(f'Unable to save user profile for user "{user_id}".')
             return variation, decide_reasons
@@ -561,15 +562,15 @@ def get_variations_for_feature_list(
         Returns:
             List of Decision namedtuple consisting of experiment and variation for the user.
         """
-        decide_reasons = []
+        decide_reasons: list[str] = []
 
         if options:
             ignore_ups = OptimizelyDecideOption.IGNORE_USER_PROFILE_SERVICE in options
         else:
             ignore_ups = False
 
 
-        user_profile_tracker: UserProfileTracker = None
+        user_profile_tracker: Optional[UserProfileTracker] = None
         if self.user_profile_service is not None and not ignore_ups:
             user_profile_tracker = UserProfileTracker(user_context.user_id, self.user_profile_service, self.logger)
             user_profile_tracker.load_user_profile(decide_reasons, None)
@@ -611,16 +612,16 @@ def get_variations_for_feature_list(
             # Only process rollout if no experiment decision was found
             if not experiment_decision_found:
                 rollout_decision, rollout_reasons = self.get_variation_for_rollout(project_config, feature, user_context)
-                feature_reasons.append(rollout_reasons)
-                
+                if rollout_reasons:
+                    feature_reasons.extend(rollout_reasons)
                 if rollout_decision:
                     self.logger.debug(f'User "{user_context.user_id}" bucketed into rollout for feature "{feature.key}".')
                 else:
                     self.logger.debug(f'User "{user_context.user_id}" not bucketed into any rollout for feature "{feature.key}".')
 
                 decisions.append((rollout_decision, feature_reasons))
 
-        if self.user_profile_service is not None and ignore_ups is False:
+        if self.user_profile_service is not None and user_profile_tracker is not None and ignore_ups is False:
             user_profile_tracker.save_user_profile()
 
         return decisions

optimizely/user_profile.py

@@ -12,11 +12,11 @@
 # limitations under the License.
 
 from __future__ import annotations
-from typing import Any, Optional
+from typing import Any, Optional, Union
 from sys import version_info
 from . import logger as _logging
 from . import decision_service
-
+from .helpers import enums
 if version_info < (3, 8):
     from typing_extensions import Final
 else:
@@ -46,7 +46,7 @@ class UserProfile:
     def __init__(
         self,
         user_id: str,
-        experiment_bucket_map: Optional[dict[str, Decision]] = None,
+        experiment_bucket_map: Optional[dict[str, Union[Decision, dict[str, str]]]] = None,
         **kwargs: Any
     ):
         self.user_id = user_id
@@ -64,8 +64,14 @@ def get_variation_for_experiment(self, experiment_id: str) -> Optional[str]:
     Returns:
       Variation ID corresponding to the experiment. None if no decision available.
     """
+        experiment_data = self.experiment_bucket_map.get(experiment_id)
+
+        if isinstance(experiment_data, decision_service.Decision):
+            return experiment_data.variation.id if experiment_data.variation is not None else None
+        elif isinstance(experiment_data, dict):
+            return experiment_data.get(self.VARIATION_ID_KEY)
 
-        return self.experiment_bucket_map.get(experiment_id, {self.VARIATION_ID_KEY: None}).get(self.VARIATION_ID_KEY)
+        return None
 
     def save_variation_for_experiment(self, experiment_id: str, variation_id: str) -> None:
         """ Helper method to save new experiment/variation as part of the user's profile.
@@ -74,7 +80,6 @@ def save_variation_for_experiment(self, experiment_id: str, variation_id: str) -
       experiment_id: ID for experiment for which the decision is to be stored.
       variation_id: ID for variation that the user saw.
     """
-
         self.experiment_bucket_map.update({experiment_id: {self.VARIATION_ID_KEY: variation_id}})
 
 
@@ -107,16 +112,18 @@ def __init__(self, user_id: str, user_profile_service: UserProfileService, logge
         self.user_profile_service = user_profile_service
         self.logger = _logging.adapt_logger(logger or _logging.NoOpLogger())
         self.profile_updated = False
-        self.user_profile = None
+        self.user_profile = UserProfile(user_id, {})
 
     def get_user_profile(self):
         return self.user_profile
 
     def load_user_profile(self, reasons: Optional[list[str]]=[], error_handler: Optional[BaseErrorHandler]=None):
+        reasons = reasons if reasons else []
         try:
             user_profile = self.user_profile_service.lookup(self.user_id)
             if user_profile is None:
-                message = reasons.append("Unable to get a user profile from the UserProfileService.")
+                message = "Unable to get a user profile from the UserProfileService."
+                reasons.append(message)
                 self.logger.info(message)
             else:
                 if 'user_id' in user_profile and 'experiment_bucket_map' in user_profile:
@@ -130,7 +137,8 @@ def load_user_profile(self, reasons: Optional[list[str]]=[], error_handler: Opti
                     message = f"User profile is missing keys: {', '.join(missing_keys)}"
                     reasons.append(message)
         except Exception as exception:
-            message = reasons.append(str(exception))
+            message = str(exception)
+            reasons.append(message)
             self.logger.exception(f'Unable to retrieve user profile for user "{self.user_id}"as lookup failed.')
             # Todo: add error handler
             # error_handler.handle_error()
@@ -139,10 +147,14 @@ def load_user_profile(self, reasons: Optional[list[str]]=[], error_handler: Opti
             self.user_profile = UserProfile(self.user_id, {})
 
     def update_user_profile(self, experiment: Experiment, variation: Variation):
-        decision:Decision = None
         if experiment.id in self.user_profile.experiment_bucket_map:
             decision = self.user_profile.experiment_bucket_map[experiment.id]
-            decision.variation = variation
+            if isinstance(decision, decision_service.Decision):
+                decision = decision_service.Decision(
+                    experiment=decision.experiment,
+                    variation=variation,
+                    source=decision.source
+                )
         else:
             decision = decision_service.Decision(experiment=None, variation=variation, source=None)
 
@@ -154,9 +166,8 @@ def update_user_profile(self, experiment: Experiment, variation: Variation):
     def save_user_profile(self, error_handler: Optional[BaseErrorHandler] = None):
         if not self.profile_updated:
             return
-
         try:
-            self.user_profile_service.save(self.user_profile)
+            self.user_profile_service.save(self.user_profile.__dict__)
             self.logger.info(f'Saved user profile of user "{self.user_profile.user_id}".')
         except Exception as exception:
             self.logger.warning(f'Failed to save user profile of user "{self.user_profile.user_id}".')

tests/test_decision_service.py

@@ -1495,7 +1495,7 @@ def test_get_variation_for_feature__returns_none_for_user_not_in_experiment(self
             self.project_config.get_experiment_from_key("test_experiment"),
             user,
             None,
-            [[]],
+            [],
             None
         )
 
@@ -1523,7 +1523,7 @@ def test_get_variation_for_feature__returns_none_for_user_in_group_experiment_no
             )
 
         mock_decision.assert_called_once_with(
-            self.project_config, self.project_config.get_experiment_from_id("32222"), user, None, [[]], False
+            self.project_config, self.project_config.get_experiment_from_id("32222"), user, None, [], False
         )
 
     def test_get_variation_for_feature__returns_variation_for_feature_in_mutex_group_bucket_less_than_2500(