Skip to content

[AI-FSSDK] (DO NOT REVIEW) [FSSDK-12262] Exclude CMAB from UserProfileService #34

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jaeopt wants to merge 1 commit into from
Closed

[AI-FSSDK] (DO NOT REVIEW) [FSSDK-12262] Exclude CMAB from UserProfileService #34

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions optimizely/decision_service.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -457,7 +457,11 @@ 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.
is_cmab_experiment = bool(experiment.cmab)
if user_profile_tracker is not None and not ignore_user_profile and not is_cmab_experiment:
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 ' \
Expand All @@ -472,6 +476,11 @@ def get_variation(
}
else:
self.logger.warning('User profile has invalid format.')
elif is_cmab_experiment and user_profile_tracker is not None and not ignore_user_profile:
message = f'Skipping user profile service for CMAB experiment "{experiment.key}". ' \
'CMAB decisions are excluded from UPS.'
self.logger.debug(message)
decide_reasons.append(message)

# Check audience conditions
audience_conditions = experiment.get_audience_conditions_or_ids()
Expand Down Expand Up @@ -529,7 +538,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 is_cmab_experiment:
try:
user_profile_tracker.update_user_profile(experiment, variation)
except:
Expand Down
180 changes: 180 additions & 0 deletions tests/test_decision_service.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1075,6 +1075,186 @@ def test_get_variation_cmab_experiment_with_whitelisted_variation(self):
mock_cmab_decision.assert_not_called()


def test_get_variation_cmab_experiment_skips_ups_lookup(self):
"""Test that get_variation skips UPS lookup for CMAB experiments."""

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',
[],
{},
[
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(self.decision_service,
'logger') as mock_logger, \
mock.patch(
'optimizely.decision_service.DecisionService.get_stored_variation'
) as mock_get_stored_variation:

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
)
reasons = variation_result['reasons']

# Verify UPS lookup was NOT called for CMAB experiment
mock_get_stored_variation.assert_not_called()

# Verify the UPS exclusion reason is included
self.assertTrue(
any('Skipping user profile service for CMAB experiment' in r for r in reasons),
f'Expected UPS exclusion reason in reasons, got: {reasons}'
)

# Verify the variation was still assigned correctly
self.assertIsNotNone(variation_result['variation'])
self.assertEqual('test-cmab-uuid-123', variation_result['cmab_uuid'])

def test_get_variation_cmab_experiment_skips_ups_save(self):
"""Test that get_variation skips UPS save for CMAB experiments."""

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',
[],
{},
[
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(self.decision_service,
'logger'), \
mock.patch.object(
user_profile_tracker, 'update_user_profile'
) as mock_update_profile:

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 UPS save was NOT called for CMAB experiment
mock_update_profile.assert_not_called()

# Verify the variation was still assigned correctly
self.assertIsNotNone(variation_result['variation'])
self.assertEqual('test-cmab-uuid-123', variation_result['cmab_uuid'])

def test_get_variation_non_cmab_experiment_uses_ups(self):
"""Test that get_variation still uses UPS for non-CMAB experiments."""

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")

with mock.patch(
"optimizely.decision_service.DecisionService.get_forced_variation",
return_value=[None, []],
), mock.patch(
"optimizely.decision_service.DecisionService.get_stored_variation",
return_value=entities.Variation("111128", "control"),
) as mock_get_stored_variation, mock.patch(
"optimizely.helpers.audience.does_user_meet_audience_conditions"
) as mock_audience_check, mock.patch(
"optimizely.bucketer.Bucketer.bucket"
) as mock_bucket:
variation_result = self.decision_service.get_variation(
self.project_config, experiment, user, user_profile_tracker
)

# Verify UPS lookup WAS called for non-CMAB experiment
mock_get_stored_variation.assert_called_once()

# Verify we got the stored variation back
self.assertEqual(entities.Variation("111128", "control"), variation_result['variation'])

# Verify audience check and bucketing were NOT called (stored variation returned early)
mock_audience_check.assert_not_called()
mock_bucket.assert_not_called()


class FeatureFlagDecisionTests(base.BaseTest):
def setUp(self):
base.BaseTest.setUp(self)
Expand Down
Loading