From d2cb7753bb651943ee9688addac263ab889e06b0 Mon Sep 17 00:00:00 2001 From: Jae Kim Date: Thu, 5 Feb 2026 16:10:28 -0800 Subject: [PATCH] [AI-FSSDK] [FSSDK-12262] Exclude CMAB from UserProfileService --- optimizely/decision_service.py | 10 +- tests/test_decision_service.py | 183 +++++++++++++++++++++++++++++++++ 2 files changed, 191 insertions(+), 2 deletions(-) diff --git a/optimizely/decision_service.py b/optimizely/decision_service.py index 28275ef..cf40b1b 100644 --- a/optimizely/decision_service.py +++ b/optimizely/decision_service.py @@ -457,7 +457,8 @@ 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: + # Skip UPS lookup for CMAB experiments as they require dynamic decisions + 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 ' \ @@ -472,6 +473,10 @@ def get_variation( } else: self.logger.warning('User profile has invalid format.') + elif experiment.cmab: + message = f'Skipping User Profile Service for CMAB experiment "{experiment.key}".' + self.logger.debug(message) + decide_reasons.append(message) # Check audience conditions audience_conditions = experiment.get_audience_conditions_or_ids() @@ -529,7 +534,8 @@ 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: + # Skip UPS update for CMAB experiments as they require dynamic decisions + 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..d659478 100644 --- a/tests/test_decision_service.py +++ b/tests/test_decision_service.py @@ -1074,6 +1074,189 @@ 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_excludes_ups_lookup(self): + """Test that CMAB experiments skip User Profile Service lookup.""" + + # Create a user context + user = optimizely_user_context.OptimizelyUserContext( + optimizely_client=None, + logger=None, + user_id="test_user", + user_attributes={} + ) + + # Create a CMAB experiment + cmab_experiment = entities.Experiment( + '111150', + 'cmab_experiment', + 'Running', + '111150', + [], # No audience IDs + {}, + [ + entities.Variation('111151', 'variation_1'), + entities.Variation('111152', 'variation_2') + ], + [ + {'entityId': '111151', 'endOfRange': 5000}, + {'entityId': '111152', 'endOfRange': 10000} + ], + cmab={'trafficAllocation': 5000} + ) + + # Create user profile service and tracker + user_profile_service = user_profile.UserProfileService() + user_profile_tracker = user_profile.UserProfileTracker(user.user_id, user_profile_service) + + 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.decision_service, 'get_stored_variation') as mock_get_stored_variation, \ + mock.patch.object(self.decision_service, 'logger') as mock_logger, \ + mock.patch.object(self.project_config, 'get_variation_from_id', + return_value=entities.Variation('111151', 'variation_1')): + + # Setup CMAB service to return a decision + mock_cmab_service.get_decision.return_value = ( + {'variation_id': '111151', 'cmab_uuid': 'test-cmab-uuid-123'}, + [] + ) + + # Call get_variation with the CMAB experiment and UPS tracker + variation_result = self.decision_service.get_variation( + self.project_config, + cmab_experiment, + user, + user_profile_tracker + ) + variation = variation_result['variation'] + reasons = variation_result['reasons'] + + # Verify we get a variation + self.assertEqual(entities.Variation('111151', 'variation_1'), variation) + + # Verify UPS lookup was NOT called for CMAB + mock_get_stored_variation.assert_not_called() + + # Verify decision reason includes UPS exclusion message + self.assertIn('Skipping User Profile Service for CMAB experiment "cmab_experiment".', reasons) + + # Verify logger was called with UPS exclusion message + mock_logger.debug.assert_any_call('Skipping User Profile Service for CMAB experiment "cmab_experiment".') + + def test_get_variation_cmab_excludes_ups_update(self): + """Test that CMAB experiments skip User Profile Service updates.""" + + # Create a user context + user = optimizely_user_context.OptimizelyUserContext( + optimizely_client=None, + logger=None, + user_id="test_user", + user_attributes={} + ) + + # Create a CMAB experiment + cmab_experiment = entities.Experiment( + '111150', + 'cmab_experiment', + 'Running', + '111150', + [], # No audience IDs + {}, + [ + entities.Variation('111151', 'variation_1'), + entities.Variation('111152', 'variation_2') + ], + [ + {'entityId': '111151', 'endOfRange': 5000}, + {'entityId': '111152', 'endOfRange': 10000} + ], + cmab={'trafficAllocation': 5000} + ) + + # Create user profile service and tracker + user_profile_service = user_profile.UserProfileService() + user_profile_tracker = user_profile.UserProfileTracker(user.user_id, user_profile_service) + + 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(user_profile_tracker, 'update_user_profile') as mock_update_profile, \ + mock.patch.object(self.project_config, 'get_variation_from_id', + return_value=entities.Variation('111151', 'variation_1')): + + # Setup CMAB service to return a decision + mock_cmab_service.get_decision.return_value = ( + {'variation_id': '111151', 'cmab_uuid': 'test-cmab-uuid-123'}, + [] + ) + + # Call get_variation with the CMAB experiment and UPS tracker + variation_result = self.decision_service.get_variation( + self.project_config, + cmab_experiment, + user, + user_profile_tracker + ) + variation = variation_result['variation'] + + # Verify we get a variation + self.assertEqual(entities.Variation('111151', 'variation_1'), variation) + + # Verify UPS update was NOT called for CMAB + mock_update_profile.assert_not_called() + + def test_get_variation_non_cmab_uses_ups(self): + """Test that non-CMAB experiments still use User Profile Service.""" + + # Create a user context + user = optimizely_user_context.OptimizelyUserContext( + optimizely_client=None, + logger=None, + user_id="test_user", + user_attributes={} + ) + + # Create a regular (non-CMAB) experiment + regular_experiment = self.project_config.get_experiment_from_key("test_experiment") + + # Create user profile service and tracker + user_profile_service = user_profile.UserProfileService() + user_profile_tracker = user_profile.UserProfileTracker(user.user_id, user_profile_service) + + with mock.patch.object(self.decision_service, 'get_forced_variation', + return_value=[None, []]), \ + mock.patch.object(self.decision_service, 'get_whitelisted_variation', + return_value=[None, []]), \ + mock.patch.object(self.decision_service, 'get_stored_variation', + return_value=None) as mock_get_stored_variation, \ + mock.patch('optimizely.helpers.audience.does_user_meet_audience_conditions', return_value=[True, []]), \ + mock.patch.object(self.decision_service.bucketer, 'bucket', + return_value=[entities.Variation('211129', 'variation'), []]), \ + mock.patch.object(user_profile_tracker, 'update_user_profile') as mock_update_profile: + + # Call get_variation with regular experiment and UPS tracker + variation_result = self.decision_service.get_variation( + self.project_config, + regular_experiment, + user, + user_profile_tracker + ) + variation = variation_result['variation'] + + # Verify we get a variation + self.assertIsNotNone(variation) + + # Verify UPS lookup WAS called for non-CMAB + mock_get_stored_variation.assert_called_once() + + # Verify UPS update WAS called for non-CMAB + mock_update_profile.assert_called_once_with(regular_experiment, variation) + class FeatureFlagDecisionTests(base.BaseTest): def setUp(self):