Merge branch 'farhan-anjum/FSSDK-11175-add-decision-service-methods-for-cmab' into farhan-anjum/FSSDK-11184-update-impression-event-for-cmab

Author: FarhanAnjum-opti

optimizely/optimizely.py

@@ -30,7 +30,7 @@
 from .decision.optimizely_decide_option import OptimizelyDecideOption
 from .decision.optimizely_decision import OptimizelyDecision
 from .decision.optimizely_decision_message import OptimizelyDecisionMessage
-from .decision_service import Decision, VariationResult
+from .decision_service import Decision
 from .error_handler import NoOpErrorHandler, BaseErrorHandler
 from .event import event_factory, user_event_factory
 from .event.event_processor import BatchEventProcessor, BaseEventProcessor
@@ -538,13 +538,8 @@ def activate(self, experiment_key: str, user_id: str, attributes: Optional[UserA
             self.logger.error(enums.Errors.INVALID_PROJECT_CONFIG.format('activate'))
             return None
 
-        variation_result = self.get_variation(experiment_key, user_id, attributes)
-        variation_key = None
-        cmab_uuid = None
-        if variation_result and variation_result['variation']:
-            variation_key = variation_result['variation'].key
-        if variation_result and variation_result['cmab_uuid']:
-            cmab_uuid = variation_result['cmab_uuid']
+        variation_key = self.get_variation(experiment_key, user_id, attributes)
+
         if not variation_key:
             self.logger.info(f'Not activating user "{user_id}".')
             return None
@@ -558,7 +553,7 @@ def activate(self, experiment_key: str, user_id: str, attributes: Optional[UserA
         # Create and dispatch impression event
         self.logger.info(f'Activating user "{user_id}" in experiment "{experiment.key}".')
         self._send_impression_event(project_config, experiment, variation, '', experiment.key,
-                                    enums.DecisionSources.EXPERIMENT, True, user_id, attributes, cmab_uuid)
+                                    enums.DecisionSources.EXPERIMENT, True, user_id, attributes)
 
         return variation.key
 
@@ -620,18 +615,17 @@ def track(
 
     def get_variation(
         self, experiment_key: str, user_id: str, attributes: Optional[UserAttributes] = None
-    ) -> Optional[VariationResult]:
-        """
-        Returns the variation result for the given user in the specified experiment.
+    ) -> Optional[str]:
+        """ Gets variation where user will be bucketed.
 
         Args:
-            experiment_key: The key identifying the experiment.
-            user_id: The user ID.
-            attributes: Optional dictionary of user attributes.
+          experiment_key: Experiment for which user variation needs to be determined.
+          user_id: ID for user.
+          attributes: Dict representing user attributes.
 
         Returns:
-            A VariationResult object containing the variation assigned to the user, or None if the user is not
-            bucketed into any variation or the experiment is not running.
+          Variation key representing the variation the user will be bucketed in.
+          None if user is not in experiment or if experiment is not Running.
         """
 
         if not self.is_valid:
@@ -684,7 +678,7 @@ def get_variation(
             {'experiment_key': experiment_key, 'variation_key': variation_key},
         )
 
-        return variation_result
+        return variation_key
 
     def is_feature_enabled(self, feature_key: str, user_id: str, attributes: Optional[UserAttributes] = None) -> bool:
         """ Returns true if the feature is enabled for the given user.

tests/test_optimizely.py

@@ -1852,7 +1852,7 @@ def test_get_variation(self):
                 'optimizely.decision_service.DecisionService.get_variation',
                 return_value=variation_result,
         ), mock.patch('optimizely.notification_center.NotificationCenter.send_notifications') as mock_broadcast:
-            variation = self.optimizely.get_variation('test_experiment', 'test_user')['variation'].key
+            variation = self.optimizely.get_variation('test_experiment', 'test_user')
             self.assertEqual(
                 'variation', variation,
             )
@@ -1885,7 +1885,7 @@ def test_get_variation_lookup_and_save_is_called(self):
         ) as mock_load_user_profile, mock.patch(
             'optimizely.user_profile.UserProfileTracker.save_user_profile'
         ) as mock_save_user_profile:
-            variation = self.optimizely.get_variation('test_experiment', 'test_user')['variation'].key
+            variation = self.optimizely.get_variation('test_experiment', 'test_user')
             self.assertEqual(
                 'variation', variation,
             )
@@ -1917,7 +1917,7 @@ def test_get_variation_with_experiment_in_feature(self):
                 'optimizely.decision_service.DecisionService.get_variation',
                 return_value=variation_result,
         ), mock.patch('optimizely.notification_center.NotificationCenter.send_notifications') as mock_broadcast:
-            variation = opt_obj.get_variation('test_experiment', 'test_user')['variation'].key
+            variation = opt_obj.get_variation('test_experiment', 'test_user')
             self.assertEqual('variation', variation)
 
         self.assertEqual(mock_broadcast.call_count, 1)
@@ -1946,7 +1946,7 @@ def test_get_variation__returns_none(self):
                 None,
                 self.optimizely.get_variation(
                     'test_experiment', 'test_user', attributes={'test_attribute': 'test_value'},
-                )['variation'],
+                ),
             )
 
         self.assertEqual(mock_broadcast.call_count, 1)
@@ -5283,7 +5283,7 @@ def test_get_variation__forced_bucketing(self):
         )
         variation_key = self.optimizely.get_variation(
             'test_experiment', 'test_user', attributes={'test_attribute': 'test_value'}
-        )['variation'].key
+        )
         self.assertEqual('variation', variation_key)
 
     def test_get_variation__experiment_not_running__forced_bucketing(self):
@@ -5298,7 +5298,7 @@ def test_get_variation__experiment_not_running__forced_bucketing(self):
             )
             variation_key = self.optimizely.get_variation(
                 'test_experiment', 'test_user', attributes={'test_attribute': 'test_value'},
-            )['variation']
+            )
             self.assertIsNone(variation_key)
             mock_is_experiment_running.assert_called_once_with(
                 self.project_config.get_experiment_from_key('test_experiment')
@@ -5312,7 +5312,7 @@ def test_get_variation__whitelisted_user_forced_bucketing(self):
         self.assertEqual('group_exp_1_variation', forced_variation)
         variation_key = self.optimizely.get_variation(
             'group_exp_1', 'user_1', attributes={'test_attribute': 'test_value'}
-        )['variation'].key
+        )
         self.assertEqual('group_exp_1_variation', variation_key)
 
     def test_get_variation__user_profile__forced_bucketing(self):
@@ -5327,7 +5327,7 @@ def test_get_variation__user_profile__forced_bucketing(self):
             )
             variation_key = self.optimizely.get_variation(
                 'test_experiment', 'test_user', attributes={'test_attribute': 'test_value'},
-            )['variation'].key
+            )
             self.assertEqual('variation', variation_key)
 
     def test_get_variation__invalid_attributes__forced_bucketing(self):
@@ -5339,7 +5339,8 @@ def test_get_variation__invalid_attributes__forced_bucketing(self):
         )
         variation_key = self.optimizely.get_variation(
             'test_experiment', 'test_user', attributes={'test_attribute': 'test_value_invalid'},
-        )['variation'].key
+        )
+        variation_key = variation_key
         self.assertEqual('variation', variation_key)
 
     def test_set_forced_variation__invalid_object(self):