[AI-FSSDK] [FSSDK-12262] Exclude CMAB from UserProfileService

Author: jaeopt

lib/optimizely/decision_service.rb

@@ -99,8 +99,15 @@ def get_variation(project_config, experiment_id, user_context, user_profile_trac
       return VariationResult.new(nil, false, decide_reasons, whitelisted_variation_id) if whitelisted_variation_id
 
       should_ignore_user_profile_service = decide_options.include? Optimizely::Decide::OptimizelyDecideOption::IGNORE_USER_PROFILE_SERVICE
-      # Check for saved bucketing decisions if decide_options do not include ignoreUserProfileService
-      unless should_ignore_user_profile_service && user_profile_tracker
+      # CMAB experiments are excluded from UPS because CMAB decisions are dynamic
+      # and should not use sticky bucketing.
+      is_cmab_experiment = experiment.key?('cmab')
+      if is_cmab_experiment
+        message = format(Optimizely::Helpers::Constants::CMAB_UPS_EXCLUDED, experiment_key)
+        @logger.log(Logger::INFO, message)
+        decide_reasons.push(message)
+      elsif !(should_ignore_user_profile_service && user_profile_tracker)
+        # Check for saved bucketing decisions if decide_options do not include ignoreUserProfileService
         saved_variation_id, reasons_received = get_saved_variation_id(project_config, experiment_id, user_profile_tracker.user_profile)
         decide_reasons.push(*reasons_received)
         if saved_variation_id
@@ -155,7 +162,8 @@ def get_variation(project_config, experiment_id, user_context, user_profile_trac
       decide_reasons.push(message) if message
 
       # Persist bucketing decision
-      user_profile_tracker.update_user_profile(experiment_id, variation_id) unless should_ignore_user_profile_service && user_profile_tracker
+      # CMAB experiments are excluded from UPS - do not save their decisions
+      user_profile_tracker.update_user_profile(experiment_id, variation_id) unless should_ignore_user_profile_service && user_profile_tracker || is_cmab_experiment
       VariationResult.new(cmab_uuid, false, decide_reasons, variation_id)
     end
 

lib/optimizely/helpers/constants.rb

@@ -500,6 +500,7 @@ module Constants
 
       CMAB_FETCH_FAILED = 'CMAB decision fetch failed (%s).'
       INVALID_CMAB_FETCH_RESPONSE = 'Invalid CMAB fetch response'
+      CMAB_UPS_EXCLUDED = "Skipping user profile service for CMAB experiment '%s'. CMAB decisions should not use UPS for sticky bucketing."
     end
   end
 end

spec/decision_service_spec.rb

@@ -1121,6 +1121,108 @@
       end
     end
 
+    describe 'CMAB UPS exclusion' do
+      it 'should skip UPS lookup for CMAB experiments' do
+        cmab_experiment = {
+          'id' => '111150',
+          'key' => 'cmab_experiment',
+          'status' => 'Running',
+          'layerId' => '111150',
+          'audienceIds' => [],
+          'forcedVariations' => {},
+          'variations' => [
+            {'id' => '111151', 'key' => 'variation_1'},
+            {'id' => '111152', 'key' => 'variation_2'}
+          ],
+          'trafficAllocation' => [
+            {'entityId' => '111151', 'endOfRange' => 5000},
+            {'entityId' => '111152', 'endOfRange' => 10_000}
+          ],
+          'cmab' => {'trafficAllocation' => 5000}
+        }
+        user_context = project_instance.create_user_context('test_user', {})
+        user_profile_tracker = Optimizely::UserProfileTracker.new('test_user', spy_user_profile_service, spy_logger)
+
+        allow(config).to receive(:get_experiment_from_id).with('111150').and_return(cmab_experiment)
+        allow(config).to receive(:experiment_running?).with(cmab_experiment).and_return(true)
+        allow(Optimizely::Audience).to receive(:user_meets_audience_conditions?).and_return([true, []])
+        allow(decision_service.bucketer).to receive(:bucket_to_entity_id)
+          .with(config, cmab_experiment, 'test_user', 'test_user')
+          .and_return(['$', []])
+        allow(spy_cmab_service).to receive(:get_decision)
+          .with(config, user_context, '111150', [])
+          .and_return(Optimizely::CmabDecision.new(variation_id: '111151', cmab_uuid: 'test-cmab-uuid'))
+        allow(config).to receive(:get_variation_from_id_by_experiment_id)
+          .with('111150', '111151')
+          .and_return({'id' => '111151', 'key' => 'variation_1'})
+
+        # UPS lookup should not be called for CMAB experiments
+        expect(decision_service).not_to receive(:get_saved_variation_id)
+
+        variation_result = decision_service.get_variation(config, '111150', user_context, user_profile_tracker)
+
+        expect(variation_result.variation_id).to eq('111151')
+        expect(variation_result.cmab_uuid).to eq('test-cmab-uuid')
+        expect(variation_result.reasons).to include(
+          "Skipping user profile service for CMAB experiment 'cmab_experiment'. CMAB decisions should not use UPS for sticky bucketing."
+        )
+      end
+
+      it 'should skip UPS save for CMAB experiments' do
+        cmab_experiment = {
+          'id' => '111150',
+          'key' => 'cmab_experiment',
+          'status' => 'Running',
+          'layerId' => '111150',
+          'audienceIds' => [],
+          'forcedVariations' => {},
+          'variations' => [
+            {'id' => '111151', 'key' => 'variation_1'},
+            {'id' => '111152', 'key' => 'variation_2'}
+          ],
+          'trafficAllocation' => [
+            {'entityId' => '111151', 'endOfRange' => 5000},
+            {'entityId' => '111152', 'endOfRange' => 10_000}
+          ],
+          'cmab' => {'trafficAllocation' => 5000}
+        }
+        user_context = project_instance.create_user_context('test_user', {})
+        user_profile_tracker = Optimizely::UserProfileTracker.new('test_user', spy_user_profile_service, spy_logger)
+
+        allow(config).to receive(:get_experiment_from_id).with('111150').and_return(cmab_experiment)
+        allow(config).to receive(:experiment_running?).with(cmab_experiment).and_return(true)
+        allow(Optimizely::Audience).to receive(:user_meets_audience_conditions?).and_return([true, []])
+        allow(decision_service.bucketer).to receive(:bucket_to_entity_id)
+          .with(config, cmab_experiment, 'test_user', 'test_user')
+          .and_return(['$', []])
+        allow(spy_cmab_service).to receive(:get_decision)
+          .with(config, user_context, '111150', [])
+          .and_return(Optimizely::CmabDecision.new(variation_id: '111151', cmab_uuid: 'test-cmab-uuid'))
+        allow(config).to receive(:get_variation_from_id_by_experiment_id)
+          .with('111150', '111151')
+          .and_return({'id' => '111151', 'key' => 'variation_1'})
+
+        # UPS save should not be called for CMAB experiments
+        expect(user_profile_tracker).not_to receive(:update_user_profile)
+
+        decision_service.get_variation(config, '111150', user_context, user_profile_tracker)
+      end
+
+      it 'should still use UPS for non-CMAB experiments' do
+        experiment = config.get_experiment_from_key('test_experiment')
+        experiment_id = experiment['id']
+        user_context = project_instance.create_user_context('test_user', {})
+        user_profile_tracker = Optimizely::UserProfileTracker.new('test_user', spy_user_profile_service, spy_logger)
+
+        allow(config).to receive(:experiment_running?).with(experiment).and_return(true)
+
+        # UPS lookup should be called for non-CMAB experiments
+        expect(decision_service).to receive(:get_saved_variation_id).and_call_original
+
+        decision_service.get_variation(config, experiment_id, user_context, user_profile_tracker)
+      end
+    end
+
     describe 'when user has whitelisted variation' do
       it 'should return whitelisted variation and skip CMAB service call' do
         # Create a CMAB experiment with whitelisted users