From 1e4f5a65cb33f406ec51694a52d4b5cc0cb66680 Mon Sep 17 00:00:00 2001 From: Jae Kim Date: Tue, 10 Feb 2026 10:59:30 -0800 Subject: [PATCH] [AI-FSSDK] [FSSDK-12262] Exclude CMAB from UserProfileService --- optimizely/decision_service.py | 16 ++- tests/test_decision_service.py | 178 +++++++++++++++++++++++++++++++++ 2 files changed, 192 insertions(+), 2 deletions(-) diff --git a/optimizely/decision_service.py b/optimizely/decision_service.py index 28275ef..de3c141 100644 --- a/optimizely/decision_service.py +++ b/optimizely/decision_service.py @@ -457,7 +457,18 @@ 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: + # CMAB experiments are excluded from UPS because UPS maintains decisions + # across the experiment lifetime without considering TTL or user attributes, + # which contradicts CMAB's dynamic nature. + if experiment.cmab: + if user_profile_tracker is not None and not ignore_user_profile: + message = ( + f'Skipping user profile service lookup for CMAB experiment "{experiment.key}". ' + 'CMAB decisions are excluded from UPS.' + ) + self.logger.debug(message) + decide_reasons.append(message) + elif user_profile_tracker is not None and not ignore_user_profile: 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 +540,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: + # CMAB experiments are excluded from UPS to preserve dynamic decision-making + 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..e27001e 100644 --- a/tests/test_decision_service.py +++ b/tests/test_decision_service.py @@ -1074,6 +1074,184 @@ 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_skips_user_profile_lookup(self): + """Test that get_variation skips UPS lookup for CMAB experiments even when + user_profile_tracker is provided, and adds appropriate decision reason.""" + + user = optimizely_user_context.OptimizelyUserContext( + optimizely_client=None, + logger=None, + user_id="test_user", + user_attributes={} + ) + + 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} + ) + + 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.project_config, 'get_variation_from_id', + return_value=entities.Variation('111151', 'variation_1')), \ + mock.patch( + 'optimizely.decision_service.DecisionService.get_stored_variation' + ) as mock_get_stored_variation, \ + mock.patch.object(self.decision_service, 'logger') as mock_logger: + + mock_cmab_service.get_decision.return_value = ( + { + 'variation_id': '111151', + 'cmab_uuid': 'test-cmab-uuid-123' + }, + [] + ) + + variation_result = self.decision_service.get_variation( + self.project_config, + cmab_experiment, + user, + user_profile_tracker + ) + + # Verify get_stored_variation was NOT called for CMAB experiment + mock_get_stored_variation.assert_not_called() + + # Verify the decision reason includes UPS exclusion message + reasons = variation_result['reasons'] + self.assertTrue( + any('Skipping user profile service lookup for CMAB experiment' in r for r in reasons), + 'Expected UPS exclusion reason in decide_reasons' + ) + + # Verify variation is still returned correctly + self.assertEqual(entities.Variation('111151', 'variation_1'), variation_result['variation']) + self.assertEqual('test-cmab-uuid-123', variation_result['cmab_uuid']) + self.assertStrictFalse(variation_result['error']) + + def test_get_variation_cmab_experiment_skips_user_profile_save(self): + """Test that get_variation does NOT save to UPS for CMAB experiments.""" + + user = optimizely_user_context.OptimizelyUserContext( + optimizely_client=None, + logger=None, + user_id="test_user", + user_attributes={} + ) + + 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} + ) + + 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.project_config, 'get_variation_from_id', + return_value=entities.Variation('111151', 'variation_1')), \ + mock.patch.object(user_profile_tracker, 'update_user_profile') as mock_update_profile, \ + mock.patch.object(self.decision_service, 'logger'): + + mock_cmab_service.get_decision.return_value = ( + { + 'variation_id': '111151', + 'cmab_uuid': 'test-cmab-uuid-123' + }, + [] + ) + + variation_result = self.decision_service.get_variation( + self.project_config, + cmab_experiment, + user, + user_profile_tracker + ) + + # Verify update_user_profile was NOT called for CMAB experiment + mock_update_profile.assert_not_called() + + # Verify variation is still returned correctly + self.assertEqual(entities.Variation('111151', 'variation_1'), variation_result['variation']) + self.assertEqual('test-cmab-uuid-123', variation_result['cmab_uuid']) + + def test_get_variation_non_cmab_experiment_still_uses_user_profile(self): + """Test that non-CMAB experiments still use UPS for lookup and save.""" + + user = optimizely_user_context.OptimizelyUserContext( + optimizely_client=None, + logger=None, + user_id="test_user", + user_attributes={} + ) + user_profile_service = user_profile.UserProfileService() + user_profile_tracker = user_profile.UserProfileTracker(user.user_id, user_profile_service) + experiment = self.project_config.get_experiment_from_key("test_experiment") + + stored_variation = entities.Variation("111129", "variation") + + with mock.patch.object(self.decision_service, 'logger'), \ + mock.patch( + 'optimizely.decision_service.DecisionService.get_forced_variation', + return_value=[None, []] + ), \ + mock.patch( + 'optimizely.decision_service.DecisionService.get_whitelisted_variation', + return_value=[None, []] + ), \ + mock.patch( + 'optimizely.decision_service.DecisionService.get_stored_variation', + return_value=stored_variation + ) as mock_get_stored_variation: + + variation_result = self.decision_service.get_variation( + self.project_config, experiment, user, user_profile_tracker + ) + + # Verify get_stored_variation WAS called for non-CMAB experiment + mock_get_stored_variation.assert_called_once_with( + self.project_config, experiment, user_profile_tracker.get_user_profile() + ) + + # Verify stored variation is returned + self.assertEqual(stored_variation, variation_result['variation']) + class FeatureFlagDecisionTests(base.BaseTest): def setUp(self):