Skip to content

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

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 #21

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
10 changes: 8 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,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 for CMAB experiments as they use dynamic decision-making
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 ' \
Expand All @@ -472,6 +473,10 @@ def get_variation(
}
else:
self.logger.warning('User profile has invalid format.')
elif user_profile_tracker is not None and not ignore_user_profile and 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()
Expand Down Expand Up @@ -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 use 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:
Expand Down
168 changes: 168 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 @@ -1074,6 +1074,174 @@ 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 exclude user profile service for sticky bucketing."""

# 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, 'attributeIds': []}
)

# Create a mock user profile service with a stored decision
mock_ups = mock.MagicMock()
mock_ups.lookup.return_value = {
'user_id': 'test_user',
'experiment_bucket_map': {
'111150': {
'variation_id': '111152' # Different from what CMAB will return
}
}
}

# Use the existing decision service and temporarily set UPS
original_ups = self.decision_service.user_profile_service
self.decision_service.user_profile_service = mock_ups

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, 'get_decision',
return_value=({'variation_id': '111151', 'cmab_uuid': 'test-uuid'}, [])), \
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.object(self.decision_service, 'get_stored_variation') as mock_get_stored:

# Create user profile tracker
user_profile_tracker = user_profile.UserProfileTracker(
user.user_id,
mock_ups,
mock_logger
)

# Call get_variation with CMAB experiment and user profile tracker
variation_result = self.decision_service.get_variation(
self.project_config,
cmab_experiment,
user,
user_profile_tracker
)

# Restore original UPS
self.decision_service.user_profile_service = original_ups

variation = variation_result['variation']
cmab_uuid = variation_result['cmab_uuid']
reasons = variation_result['reasons']
error = variation_result['error']

# Verify CMAB decision was used (variation_1) instead of UPS stored decision (variation_2)
self.assertEqual('variation_1', variation.key)
self.assertEqual('test-uuid', cmab_uuid)
self.assertStrictFalse(error)

# Verify UPS was NOT queried for stored variation for CMAB experiment
mock_get_stored.assert_not_called()

# Verify UPS exclusion reason was added
self.assertIn('Skipping user profile service for CMAB experiment "cmab_experiment".', reasons)

# Verify logger debug 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_experiment_does_not_save_to_user_profile_service(self):
"""Test that CMAB experiments do not save decisions to 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 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, 'attributeIds': []}
)

# Create a mock user profile service
mock_ups = mock.MagicMock()
mock_ups.lookup.return_value = None

# Use the existing decision service and temporarily set UPS
original_ups = self.decision_service.user_profile_service
self.decision_service.user_profile_service = mock_ups

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, 'get_decision',
return_value=({'variation_id': '111151', 'cmab_uuid': 'test-uuid'}, [])), \
mock.patch.object(self.project_config, 'get_variation_from_id',
return_value=entities.Variation('111151', 'variation_1')):

# Create user profile tracker
user_profile_tracker = user_profile.UserProfileTracker(
user.user_id,
mock_ups,
mock.MagicMock()
)

# Call get_variation with CMAB experiment
variation_result = self.decision_service.get_variation(
self.project_config,
cmab_experiment,
user,
user_profile_tracker
)

# Restore original UPS
self.decision_service.user_profile_service = original_ups

variation = variation_result['variation']

# Verify variation was returned
self.assertEqual('variation_1', variation.key)

# Verify UPS save was NOT called for CMAB experiment
mock_ups.save.assert_not_called()


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