[FSSDK-11179] Update: Send CMAB uuid in impression events

core-api/src/main/java/com/optimizely/ab/Optimizely.java

@@ -43,7 +43,6 @@
 import com.optimizely.ab.event.internal.UserEvent;
 import com.optimizely.ab.event.internal.UserEventFactory;
 import com.optimizely.ab.event.internal.payload.EventBatch;
-import com.optimizely.ab.internal.DefaultLRUCache;
 import com.optimizely.ab.internal.NotificationRegistry;
 import com.optimizely.ab.notification.ActivateNotification;
 import com.optimizely.ab.notification.DecisionNotification;
@@ -306,7 +305,7 @@ private void sendImpression(@Nonnull ProjectConfig projectConfig,
                                 @Nonnull Map<String, ?> filteredAttributes,
                                 @Nonnull Variation variation,
                                 @Nonnull String ruleType) {
-        sendImpression(projectConfig, experiment, userId, filteredAttributes, variation, "", ruleType, true);
+        sendImpression(projectConfig, experiment, userId, filteredAttributes, variation, "", ruleType, true, null);
     }
 
     /**
@@ -319,6 +318,7 @@ private void sendImpression(@Nonnull ProjectConfig projectConfig,
      * @param variation          the variation that was returned from activate.
      * @param flagKey            It can either be empty if ruleType is experiment or it's feature key in case ruleType is feature-test or rollout
      * @param ruleType           It can either be experiment in case impression event is sent from activate or it's feature-test or rollout
+     * @param cmabUUID           The cmabUUID if the experiment is a cmab experiment.
      */
     private boolean sendImpression(@Nonnull ProjectConfig projectConfig,
                                    @Nullable ExperimentCore experiment,
@@ -327,7 +327,8 @@ private boolean sendImpression(@Nonnull ProjectConfig projectConfig,
                                    @Nullable Variation variation,
                                    @Nonnull String flagKey,
                                    @Nonnull String ruleType,
-                                   @Nonnull boolean enabled) {
+                                   @Nonnull boolean enabled,
+                                   @Nullable String cmabUUID) {
 
         UserEvent userEvent = UserEventFactory.createImpressionEvent(
             projectConfig,
@@ -337,7 +338,8 @@ private boolean sendImpression(@Nonnull ProjectConfig projectConfig,
             filteredAttributes,
             flagKey,
             ruleType,
-            enabled);
+            enabled,
+            cmabUUID);
 
         if (userEvent == null) {
             return false;
@@ -499,7 +501,7 @@ private Boolean isFeatureEnabled(@Nonnull ProjectConfig projectConfig,
         if (featureDecision.decisionSource != null) {
             decisionSource = featureDecision.decisionSource;
         }
-
+        String cmabUUID = featureDecision.cmabUUID;
         if (featureDecision.variation != null) {
             // This information is only necessary for feature tests.
             // For rollouts experiments and variations are an implementation detail only.
@@ -521,7 +523,8 @@ private Boolean isFeatureEnabled(@Nonnull ProjectConfig projectConfig,
             featureDecision.variation,
             featureKey,
             decisionSource.toString(),
-            featureEnabled);
+            featureEnabled,
+            cmabUUID);
 
         DecisionNotification decisionNotification = DecisionNotification.newFeatureDecisionNotificationBuilder()
             .withUserId(userId)
@@ -1336,6 +1339,8 @@ private OptimizelyDecision createOptimizelyDecision(
         Map<String, Object> attributes = user.getAttributes();
         Map<String, ?> copiedAttributes = new HashMap<>(attributes);
 
+        String cmabUUID =  flagDecision.cmabUUID;
+
         if (!allOptions.contains(OptimizelyDecideOption.DISABLE_DECISION_EVENT)) {
             decisionEventDispatched = sendImpression(
                 projectConfig,
@@ -1345,7 +1350,8 @@ private OptimizelyDecision createOptimizelyDecision(
                 flagDecision.variation,
                 flagKey,
                 decisionSource.toString(),
-                flagEnabled);
+                flagEnabled,
+                cmabUUID);
         }
 
         DecisionNotification decisionNotification = DecisionNotification.newFlagDecisionNotificationBuilder()

core-api/src/main/java/com/optimizely/ab/bucketing/Bucketer.java

@@ -16,6 +16,7 @@
  */
 package com.optimizely.ab.bucketing;
 
+import java.util.Collections;
 import java.util.List;
 
 import javax.annotation.Nonnull;
@@ -97,7 +98,8 @@ private Experiment bucketToExperiment(@Nonnull Group group,
 
     @Nonnull
     private DecisionResponse<Variation> bucketToVariation(@Nonnull ExperimentCore experiment,
-                                                          @Nonnull String bucketingId) {
+                                                          @Nonnull String bucketingId,
+                                                          @Nonnull DecisionPath decisionPath) {
         DecisionReasons reasons = DefaultDecisionReasons.newInstance();
 
         // "salt" the bucket id using the experiment id
@@ -111,8 +113,25 @@ private DecisionResponse<Variation> bucketToVariation(@Nonnull ExperimentCore ex
         int bucketValue = generateBucketValue(hashCode);
         logger.debug("Assigned bucket {} to user with bucketingId \"{}\" when bucketing to a variation.", bucketValue, bucketingId);
 
+        // Only apply CMAB traffic allocation logic if decision path is WITH_CMAB
+        if (decisionPath == DecisionPath.WITH_CMAB && experiment instanceof Experiment && ((Experiment) experiment).getCmab() != null) {
+            // For CMAB experiments, the original trafficAllocation is kept empty for backward compatibility.
+            // Use the traffic allocation defined in the CMAB block for bucketing instead.
+            String message = reasons.addInfo("Using CMAB traffic allocation for experiment \"%s\"", experimentKey);
+            logger.info(message);
+            trafficAllocations = Collections.singletonList(
+                new TrafficAllocation("$", ((Experiment) experiment).getCmab().getTrafficAllocation())
+            );
+        }
+
         String bucketedVariationId = bucketToEntity(bucketValue, trafficAllocations);
-        if (bucketedVariationId != null) {
+        if (decisionPath == DecisionPath.WITH_CMAB && "$".equals(bucketedVariationId)) {
+            // for cmab experiments
+            String message = reasons.addInfo("User with bucketingId \"%s\" is bucketed into CMAB for experiment \"%s\"", bucketingId, experimentKey);
+            logger.info(message);
+            return new DecisionResponse(new Variation("$", "$"), reasons);
+        }
+        else if (bucketedVariationId != null) {
             Variation bucketedVariation = experiment.getVariationIdToVariationMap().get(bucketedVariationId);
             String variationKey = bucketedVariation.getKey();
             String message = reasons.addInfo("User with bucketingId \"%s\" is in variation \"%s\" of experiment \"%s\".", bucketingId, variationKey,
@@ -134,12 +153,14 @@ private DecisionResponse<Variation> bucketToVariation(@Nonnull ExperimentCore ex
      * @param experiment  The Experiment in which the user is to be bucketed.
      * @param bucketingId string A customer-assigned value used to create the key for the murmur hash.
      * @param projectConfig      The current projectConfig
+     * @param decisionPath      enum for decision making logic
      * @return A {@link DecisionResponse} including the {@link Variation} that user is bucketed into (or null) and the decision reasons
      */
     @Nonnull
     public DecisionResponse<Variation> bucket(@Nonnull ExperimentCore experiment,
                                               @Nonnull String bucketingId,
-                                              @Nonnull ProjectConfig projectConfig) {
+                                              @Nonnull ProjectConfig projectConfig,
+                                              @Nonnull DecisionPath decisionPath) {
         DecisionReasons reasons = DefaultDecisionReasons.newInstance();
 
         // ---------- Bucket User ----------
@@ -154,8 +175,6 @@ public DecisionResponse<Variation> bucket(@Nonnull ExperimentCore experiment,
                     String message = reasons.addInfo("User with bucketingId \"%s\" is not in any experiment of group %s.", bucketingId, experimentGroup.getId());
                     logger.info(message);
                     return new DecisionResponse(null, reasons);
-                } else {
-
                 }
                 // if the experiment a user is bucketed in within a group isn't the same as the experiment provided,
                 // don't perform further bucketing within the experiment
@@ -172,11 +191,26 @@ public DecisionResponse<Variation> bucket(@Nonnull ExperimentCore experiment,
             }
         }
 
-        DecisionResponse<Variation> decisionResponse = bucketToVariation(experiment, bucketingId);
+        DecisionResponse<Variation> decisionResponse = bucketToVariation(experiment, bucketingId, decisionPath);
         reasons.merge(decisionResponse.getReasons());
         return new DecisionResponse<>(decisionResponse.getResult(), reasons);
     }
 
+    /**
+     * Assign a {@link Variation} of an {@link Experiment} to a user based on hashed value from murmurhash3.
+     *
+     * @param experiment  The Experiment in which the user is to be bucketed.
+     * @param bucketingId string A customer-assigned value used to create the key for the murmur hash.
+     * @param projectConfig      The current projectConfig
+     * @return A {@link DecisionResponse} including the {@link Variation} that user is bucketed into (or null) and the decision reasons
+     */
+    @Nonnull
+    public DecisionResponse<Variation> bucket(@Nonnull ExperimentCore experiment,
+                                              @Nonnull String bucketingId,
+                                              @Nonnull ProjectConfig projectConfig) {
+        return bucket(experiment, bucketingId, projectConfig, DecisionPath.WITHOUT_CMAB);
+    }
+
     //======== Helper methods ========//
 
     /**

core-api/src/main/java/com/optimizely/ab/bucketing/DecisionService.java

@@ -170,8 +170,8 @@ public DecisionResponse<Variation> getVariation(@Nonnull Experiment experiment,
         if (decisionMeetAudience.getResult()) {
             String bucketingId = getBucketingId(user.getUserId(), user.getAttributes());
             String cmabUUID = null;
-            decisionVariation = bucketer.bucket(experiment, bucketingId, projectConfig);
-            if (decisionPath == DecisionPath.WITH_CMAB && isCmabExperiment(experiment) && decisionVariation.getResult() != null) {  
+            decisionVariation = bucketer.bucket(experiment, bucketingId, projectConfig, decisionPath);
+            if (decisionPath == DecisionPath.WITH_CMAB && isCmabExperiment(experiment) && decisionVariation.getResult() != null) {
                 // group-allocation and traffic-allocation checking passed for cmab  
                 // we need server decision overruling local bucketing for cmab  
                 DecisionResponse<CmabDecision> cmabDecision = getDecisionForCmabExperiment(projectConfig, experiment, user, bucketingId, options);

core-api/src/main/java/com/optimizely/ab/event/internal/UserEventFactory.java

@@ -41,7 +41,8 @@ public static ImpressionEvent createImpressionEvent(@Nonnull ProjectConfig proje
                                                         @Nonnull Map<String, ?> attributes,
                                                         @Nonnull String flagKey,
                                                         @Nonnull String ruleType,
-                                                        @Nonnull boolean enabled) {
+                                                        @Nonnull boolean enabled,
+                                                        @Nullable String cmabUUID) {
 
         if ((FeatureDecision.DecisionSource.ROLLOUT.toString().equals(ruleType)  || variation == null) && !projectConfig.getSendFlagDecisions())
         {
@@ -68,13 +69,18 @@ public static ImpressionEvent createImpressionEvent(@Nonnull ProjectConfig proje
             .withProjectConfig(projectConfig)
             .build();
 
-        DecisionMetadata metadata = new DecisionMetadata.Builder()
+        DecisionMetadata.Builder metadataBuilder = new DecisionMetadata.Builder()
             .setFlagKey(flagKey)
             .setRuleKey(experimentKey)
             .setRuleType(ruleType)
             .setVariationKey(variationKey)
-            .setEnabled(enabled)
-            .build();
+            .setEnabled(enabled);
+
+        if (cmabUUID != null) {
+            metadataBuilder.setCmabUUID(cmabUUID);
+        }
+
+        DecisionMetadata metadata = metadataBuilder.build();
 
         return new ImpressionEvent.Builder()
             .withUserContext(userContext)

core-api/src/main/java/com/optimizely/ab/event/internal/payload/DecisionMetadata.java

@@ -33,17 +33,20 @@ public class DecisionMetadata {
     String variationKey;
     @JsonProperty("enabled")
     boolean enabled;
+    @JsonProperty("cmab_uuid")
+    String cmabUUID;
 
     @VisibleForTesting
     public DecisionMetadata() {
     }
 
-    public DecisionMetadata(String flagKey, String ruleKey, String ruleType, String variationKey, boolean enabled) {
+    public DecisionMetadata(String flagKey, String ruleKey, String ruleType, String variationKey, boolean enabled, String cmabUUID) {
         this.flagKey = flagKey;
         this.ruleKey = ruleKey;
         this.ruleType = ruleType;
         this.variationKey = variationKey;
         this.enabled = enabled;
+        this.cmabUUID = cmabUUID;
     }
 
     public String getRuleType() {
@@ -66,6 +69,10 @@ public String getVariationKey() {
         return variationKey;
     }
 
+    public String getCmabUUID() {
+        return cmabUUID;
+    }
+
     @Override
     public boolean equals(Object o) {
         if (this == o) return true;
@@ -77,6 +84,7 @@ public boolean equals(Object o) {
         if (!ruleKey.equals(that.ruleKey)) return false;
         if (!flagKey.equals(that.flagKey)) return false;
         if (enabled != that.enabled) return false;
+        if (!java.util.Objects.equals(cmabUUID, that.cmabUUID)) return false;
         return variationKey.equals(that.variationKey);
     }
 
@@ -86,6 +94,7 @@ public int hashCode() {
         result = 31 * result + flagKey.hashCode();
         result = 31 * result + ruleKey.hashCode();
         result = 31 * result + variationKey.hashCode();
+        result = 31 * result + (cmabUUID != null ? cmabUUID.hashCode() : 0);
         return result;
     }
 
@@ -97,6 +106,7 @@ public String toString() {
             .add("ruleType='" + ruleType + "'")
             .add("variationKey='" + variationKey + "'")
             .add("enabled=" + enabled)
+            .add("cmabUUID='" + cmabUUID + "'")
             .toString();
     }
 
@@ -108,6 +118,7 @@ public static class Builder {
         private String flagKey;
         private String variationKey;
         private boolean enabled;
+        private String cmabUUID;
 
         public Builder setEnabled(boolean enabled) {
             this.enabled = enabled;
@@ -134,8 +145,13 @@ public Builder setVariationKey(String variationKey) {
             return this;
         }
 
+        public Builder setCmabUUID(String cmabUUID){
+            this.cmabUUID = cmabUUID;
+            return this;
+        }
+
         public DecisionMetadata build() {
-            return new DecisionMetadata(flagKey, ruleKey, ruleType, variationKey, enabled);
+            return new DecisionMetadata(flagKey, ruleKey, ruleType, variationKey, enabled, cmabUUID);
         }
     }
 }