diff --git a/optimizely/decision_service.py b/optimizely/decision_service.py index 28275ef..5dfec76 100644 --- a/optimizely/decision_service.py +++ b/optimizely/decision_service.py @@ -457,7 +457,10 @@ def get_variation( } # Check to see if user has a decision available for the given experiment - if user_profile_tracker is not None and not ignore_user_profile: + # Note: CMAB experiments are excluded from User Profile Service (UPS) because UPS maintains + # decisions across the experiment lifetime without considering TTL or user attributes, + # which contradicts CMAB's dynamic nature. + if user_profile_tracker is not None and not ignore_user_profile and not experiment.cmab: variation = self.get_stored_variation(project_config, experiment, user_profile_tracker.get_user_profile()) if variation: message = f'Returning previously activated variation ID "{variation}" of experiment ' \ @@ -529,7 +532,10 @@ def get_variation( self.logger.info(message) decide_reasons.append(message) # Store this new decision and return the variation for the user - if user_profile_tracker is not None and not ignore_user_profile: + # Note: CMAB experiments are excluded from User Profile Service (UPS) because UPS maintains + # decisions across the experiment lifetime without considering TTL or user attributes, + # which contradicts CMAB's dynamic nature. + if user_profile_tracker is not None and not ignore_user_profile and not experiment.cmab: try: user_profile_tracker.update_user_profile(experiment, variation) except: diff --git a/tests/test_decision_service.py b/tests/test_decision_service.py index dbcb743..e06e852 100644 --- a/tests/test_decision_service.py +++ b/tests/test_decision_service.py @@ -1074,6 +1074,95 @@ def test_get_variation_cmab_experiment_with_whitelisted_variation(self): mock_bucket.assert_not_called() mock_cmab_decision.assert_not_called() + def test_get_variation_cmab_experiment_excludes_user_profile_service(self): + """Test that CMAB experiments do not use User Profile Service for sticky bucketing. + + CMAB decisions should be dynamic and not rely on UPS, which maintains decisions + across the experiment lifetime without considering TTL or user attributes. + """ + + # Create a user context + user = optimizely_user_context.OptimizelyUserContext( + optimizely_client=None, + logger=None, + user_id="test_user", + user_attributes={} + ) + + # Create a user profile service and tracker + user_profile_service = user_profile.UserProfileService() + user_profile_tracker = user_profile.UserProfileTracker(user.user_id, user_profile_service) + + # Pre-populate the user profile with a stored decision (simulating previous bucketing) + user_profile_tracker.update_user_profile( + entities.Experiment('111150', 'cmab_experiment', 'Running', '111150', [], {}, + [entities.Variation('111151', 'variation_1')], + [{'entityId': '111151', 'endOfRange': 10000}], + cmab={'trafficAllocation': 5000}), + entities.Variation('111151', 'variation_1') + ) + + # Create a CMAB experiment + cmab_experiment = entities.Experiment( + '111150', + 'cmab_experiment', + 'Running', + '111150', + [], + {}, + [ + entities.Variation('111151', 'variation_1'), + entities.Variation('111152', 'variation_2') + ], + [ + {'entityId': '111151', 'endOfRange': 5000}, + {'entityId': '111152', 'endOfRange': 10000} + ], + cmab={'trafficAllocation': 5000} + ) + + with mock.patch('optimizely.helpers.experiment.is_experiment_running', return_value=True), \ + mock.patch('optimizely.helpers.audience.does_user_meet_audience_conditions', return_value=[True, []]), \ + mock.patch.object(self.decision_service.bucketer, 'bucket_to_entity_id', + return_value=['$', []]), \ + mock.patch.object(self.decision_service, 'cmab_service') as mock_cmab_service, \ + mock.patch.object(self.project_config, 'get_variation_from_id', + return_value=entities.Variation('111152', 'variation_2')), \ + mock.patch.object(self.decision_service, 'get_stored_variation') as mock_get_stored_variation, \ + mock.patch.object(user_profile_tracker, 'update_user_profile') as mock_update_profile: + + # Configure CMAB service to return a different variation than what's stored + mock_cmab_service.get_decision.return_value = ( + { + 'variation_id': '111152', + 'cmab_uuid': 'test-cmab-uuid-456' + }, + [] + ) + + # Call get_variation with user profile tracker + variation_result = self.decision_service.get_variation( + self.project_config, + cmab_experiment, + user, + user_profile_tracker + ) + variation = variation_result['variation'] + cmab_uuid = variation_result['cmab_uuid'] + + # Verify that get_stored_variation was NOT called (UPS retrieval skipped for CMAB) + mock_get_stored_variation.assert_not_called() + + # Verify that update_user_profile was NOT called (UPS storage skipped for CMAB) + mock_update_profile.assert_not_called() + + # Verify that CMAB decision was used (variation_2, not the stored variation_1) + self.assertEqual(entities.Variation('111152', 'variation_2'), variation) + self.assertEqual('test-cmab-uuid-456', cmab_uuid) + + # Verify CMAB service was called + mock_cmab_service.get_decision.assert_called_once() + class FeatureFlagDecisionTests(base.BaseTest): def setUp(self):