Preventing events from being sent when user is part of a rollout (#85)

Author: aliabbasrizvi

optimizely/decision_service.py

@@ -22,7 +22,9 @@
 from .user_profile import UserProfile
 
 
-Decision = namedtuple('Decision', 'experiment variation')
+Decision = namedtuple('Decision', 'experiment variation source')
+DECISION_SOURCE_EXPERIMENT = 'experiment'
+DECISION_SOURCE_ROLLOUT = 'rollout'
 
 
 class DecisionService(object):
@@ -190,7 +192,7 @@ def get_variation_for_rollout(self, rollout, user_id, attributes=None):
         if variation:
           self.logger.log(enums.LogLevels.DEBUG,
                           'User "%s" is in variation %s of experiment %s.' % (user_id, variation.key, experiment.key))
-          return Decision(experiment, variation)
+          return Decision(experiment, variation, DECISION_SOURCE_ROLLOUT)
         else:
           # Evaluate no further rules
           self.logger.log(enums.LogLevels.DEBUG,
@@ -207,9 +209,9 @@ def get_variation_for_rollout(self, rollout, user_id, attributes=None):
         if variation:
           self.logger.log(enums.LogLevels.DEBUG,
                           'User "%s" meets conditions for targeting rule "Everyone Else".' % user_id)
-          return Decision(everyone_else_experiment, variation)
+          return Decision(everyone_else_experiment, variation, DECISION_SOURCE_ROLLOUT)
 
-    return Decision(None, None)
+    return Decision(None, None, DECISION_SOURCE_ROLLOUT)
 
   def get_variation_for_feature(self, feature, user_id, attributes=None):
     """ Returns the experiment/variation the user is bucketed in for the given feature.
@@ -256,7 +258,7 @@ def get_variation_for_feature(self, feature, user_id, attributes=None):
       rollout = self.config.get_rollout_from_id(feature.rolloutId)
       return self.get_variation_for_rollout(rollout, user_id, attributes)
 
-    return Decision(experiment, variation)
+    return Decision(experiment, variation, DECISION_SOURCE_EXPERIMENT)
 
   def get_experiment_in_group(self, group, user_id):
     """ Determine which experiment in the group the user is bucketed into.

optimizely/optimizely.py

@@ -377,10 +377,12 @@ def is_feature_enabled(self, feature_key, user_id, attributes=None):
     decision = self.decision_service.get_variation_for_feature(feature, user_id, attributes)
     if decision.variation:
       self.logger.log(enums.LogLevels.INFO, 'Feature "%s" is enabled for user "%s".' % (feature_key, user_id))
-      self._send_impression_event(decision.experiment,
-                                  decision.variation,
-                                  user_id,
-                                  attributes)
+      # Send event if Decision came from an experiment.
+      if decision.source == decision_service.DECISION_SOURCE_EXPERIMENT:
+        self._send_impression_event(decision.experiment,
+                                    decision.variation,
+                                    user_id,
+                                    attributes)
       return True
 
     self.logger.log(enums.LogLevels.INFO, 'Feature "%s" is not enabled for user "%s".' % (feature_key, user_id))

tests/test_decision_service.py

@@ -344,7 +344,7 @@ def test_get_variation_for_rollout__returns_none_if_no_experiments(self, mock_lo
     """ Test that get_variation_for_rollout returns None if there are no experiments (targeting rules). """
 
     no_experiment_rollout = self.project_config.get_rollout_from_id('201111')
-    self.assertEqual(decision_service.Decision(None, None),
+    self.assertEqual(decision_service.Decision(None, None, decision_service.DECISION_SOURCE_ROLLOUT),
                      self.decision_service.get_variation_for_rollout(no_experiment_rollout, 'test_user'))
 
     # Assert no log messages were generated
@@ -358,7 +358,7 @@ def test_get_variation_for_rollout__skips_to_everyone_else_rule(self, mock_loggi
 
     with mock.patch('optimizely.helpers.audience.is_user_in_experiment', return_value=True) as mock_audience_check,\
       mock.patch('optimizely.bucketer.Bucketer.bucket', return_value=None):
-      self.assertEqual(decision_service.Decision(None, None),
+      self.assertEqual(decision_service.Decision(None, None, decision_service.DECISION_SOURCE_ROLLOUT),
                        self.decision_service.get_variation_for_rollout(rollout, 'test_user'))
 
     # Check that after first experiment, it skips to the last experiment to check
@@ -381,7 +381,7 @@ def test_get_variation_for_rollout__returns_none_for_user_not_in_rollout(self, m
     rollout = self.project_config.get_rollout_from_id('211111')
 
     with mock.patch('optimizely.helpers.audience.is_user_in_experiment', return_value=False) as mock_audience_check:
-      self.assertEqual(decision_service.Decision(None, None),
+      self.assertEqual(decision_service.Decision(None, None, decision_service.DECISION_SOURCE_ROLLOUT),
                        self.decision_service.get_variation_for_rollout(rollout, 'test_user'))
 
     # Check that all experiments in rollout layer were checked
@@ -407,7 +407,9 @@ def test_get_variation_for_feature__returns_variation_for_feature_in_experiment(
     expected_variation = self.project_config.get_variation_from_id('test_experiment', '111129')
     with mock.patch('optimizely.decision_service.DecisionService.get_variation',
                     return_value=expected_variation) as mock_decision:
-      self.assertEqual(decision_service.Decision(expected_experiment, expected_variation),
+      self.assertEqual(decision_service.Decision(expected_experiment,
+                                                 expected_variation,
+                                                 decision_service.DECISION_SOURCE_EXPERIMENT),
                        self.decision_service.get_variation_for_feature(feature, 'user1'))
 
     mock_decision.assert_called_once_with(
@@ -447,7 +449,9 @@ def test_get_variation_for_feature__returns_variation_if_user_not_in_experiment_
       'optimizely.helpers.audience.is_user_in_experiment',
       side_effect=[False, True]) as mock_audience_check, \
       mock.patch('optimizely.bucketer.Bucketer.bucket', return_value=expected_variation):
-      self.assertEqual(decision_service.Decision(expected_experiment, expected_variation),
+      self.assertEqual(decision_service.Decision(expected_experiment,
+                                                 expected_variation,
+                                                 decision_service.DECISION_SOURCE_ROLLOUT),
                        self.decision_service.get_variation_for_feature(feature, 'user1'))
 
     self.assertEqual(2, mock_audience_check.call_count)
@@ -469,7 +473,9 @@ def test_get_variation_for_feature__returns_variation_for_feature_in_group(self,
       return_value=self.project_config.get_experiment_from_key('group_exp_1')) as mock_get_experiment_in_group, \
       mock.patch('optimizely.decision_service.DecisionService.get_variation',
                  return_value=expected_variation) as mock_decision:
-      self.assertEqual(decision_service.Decision(expected_experiment, expected_variation),
+      self.assertEqual(decision_service.Decision(expected_experiment,
+                                                 expected_variation,
+                                                 decision_service.DECISION_SOURCE_EXPERIMENT),
                        self.decision_service.get_variation_for_feature(feature, 'user1'))
 
     mock_get_experiment_in_group.assert_called_once_with(self.project_config.get_group('19228'), 'user1')
@@ -484,7 +490,7 @@ def test_get_variation_for_feature__returns_none_for_user_not_in_group(self, _):
     with mock.patch('optimizely.decision_service.DecisionService.get_experiment_in_group',
                     return_value=None) as mock_get_experiment_in_group, \
       mock.patch('optimizely.decision_service.DecisionService.get_variation') as mock_decision:
-      self.assertEqual(decision_service.Decision(None, None),
+      self.assertEqual(decision_service.Decision(None, None, decision_service.DECISION_SOURCE_EXPERIMENT),
                        self.decision_service.get_variation_for_feature(feature, 'user1'))
 
     mock_get_experiment_in_group.assert_called_once_with(self.project_config.get_group('19228'), 'user1')
@@ -497,7 +503,9 @@ def test_get_variation_for_feature__returns_none_for_user_not_in_experiment(self
     expected_experiment = self.project_config.get_experiment_from_key('test_experiment')
 
     with mock.patch('optimizely.decision_service.DecisionService.get_variation', return_value=None) as mock_decision:
-      self.assertEqual(decision_service.Decision(expected_experiment, None),
+      self.assertEqual(decision_service.Decision(expected_experiment,
+                                                 None,
+                                                 decision_service.DECISION_SOURCE_EXPERIMENT),
                        self.decision_service.get_variation_for_feature(feature, 'user1'))
 
     mock_decision.assert_called_once_with(
@@ -513,7 +521,9 @@ def test_get_variation_for_feature__returns_none_for_user_in_group_experiment_no
 
     with mock.patch('optimizely.decision_service.DecisionService.get_experiment_in_group',
                     return_value=self.project_config.get_experiment_from_key('group_exp_2')) as mock_decision:
-      self.assertEqual(decision_service.Decision(expected_experiment, None),
+      self.assertEqual(decision_service.Decision(expected_experiment,
+                                                 None,
+                                                 decision_service.DECISION_SOURCE_EXPERIMENT),
                        self.decision_service.get_variation_for_feature(feature, 'user_1'))
 
     mock_decision.assert_called_once_with(self.project_config.get_group('19228'), 'user_1')