Merge branch 'master' into jae/FSSDK-11986-jackson-2

Author: jaeopt

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

@@ -16,18 +16,26 @@
  */
 package com.optimizely.ab;
 
-import com.optimizely.ab.config.ProjectConfig;
-import com.optimizely.ab.odp.ODPManager;
-import com.optimizely.ab.odp.ODPSegmentCallback;
-import com.optimizely.ab.odp.ODPSegmentOption;
-import com.optimizely.ab.optimizelydecision.*;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.LinkedList;
+import java.util.List;
+import java.util.Map;
+import java.util.concurrent.ConcurrentHashMap;
 
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
-import java.util.*;
-import java.util.concurrent.ConcurrentHashMap;
+
+import com.optimizely.ab.annotations.VisibleForTesting;
+import com.optimizely.ab.optimizelydecision.OptimizelyDecisionCallback;
+import com.optimizely.ab.optimizelydecision.OptimizelyDecisionsCallback;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import com.optimizely.ab.odp.ODPSegmentCallback;
+import com.optimizely.ab.odp.ODPSegmentOption;
+import com.optimizely.ab.optimizelydecision.OptimizelyDecideOption;
+import com.optimizely.ab.optimizelydecision.OptimizelyDecision;
 
 public class OptimizelyUserContext {
     // OptimizelyForcedDecisionsKey mapped to variationKeys
@@ -42,7 +50,7 @@ public class OptimizelyUserContext {
     private List<String> qualifiedSegments;
 
     @Nonnull
-    private final Optimizely optimizely;
+    final Optimizely optimizely;
 
     private static final Logger logger = LoggerFactory.getLogger(OptimizelyUserContext.class);
 
@@ -390,4 +398,44 @@ public String toString() {
             ", attributes='" + attributes + '\'' +
             '}';
     }
+
+    // sync decision support for android-sdk backward compatibility only
+
+    @VisibleForTesting  // protected, open for testing only
+    public OptimizelyDecision decideSync(@Nonnull String key,
+                                     @Nonnull List<OptimizelyDecideOption> options) {
+        return optimizely.decideSync(copy(), key, options);
+    }
+
+    @VisibleForTesting  // protected, open for testing only
+    public Map<String, OptimizelyDecision> decideForKeysSync(@Nonnull List<String> keys,
+                                                         @Nonnull List<OptimizelyDecideOption> options) {
+        return optimizely.decideForKeysSync(copy(), keys, options);
+    }
+
+    @VisibleForTesting  // protected, open for testing only
+    public Map<String, OptimizelyDecision> decideAllSync(@Nonnull List<OptimizelyDecideOption> options) {
+        return optimizely.decideAllSync(copy(), options);
+    }
+
+    @VisibleForTesting  // protected, open for testing only
+    public void decideAsync(@Nonnull String key,
+                                          @Nonnull List<OptimizelyDecideOption> options,
+                                          @Nonnull OptimizelyDecisionCallback callback) {
+        optimizely.decideAsync(copy(), key, options, callback);
+    }
+
+    @VisibleForTesting  // protected, open for testing only
+    public void decideForKeysAsync(@Nonnull List<String> keys,
+                                                              @Nonnull List<OptimizelyDecideOption> options,
+                                                              @Nonnull OptimizelyDecisionsCallback callback) {
+        optimizely.decideForKeysAsync(copy(), keys, options, callback);
+    }
+
+    @VisibleForTesting  // protected, open for testing only
+    public void decideAllAsync(@Nonnull List<OptimizelyDecideOption> options,
+                                                          @Nonnull OptimizelyDecisionsCallback callback) {
+        optimizely.decideAllAsync(copy(), options, callback);
+    }
+
 }

core-api/src/main/java/com/optimizely/ab/OptimizelyUserContext.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/Bucketer.java

@@ -0,0 +1,21 @@
+/****************************************************************************
+ * Copyright 2025 Optimizely, Inc. and contributors                        *
+ *                                                                          *
+ * Licensed under the Apache License, Version 2.0 (the "License");          *
+ * you may not use this file except in compliance with the License.         *
+ * You may obtain a copy of the License at                                  *
+ *                                                                          *
+ *    http://www.apache.org/licenses/LICENSE-2.0                            *
+ *                                                                          *
+ * Unless required by applicable law or agreed to in writing, software      *
+ * distributed under the License is distributed on an "AS IS" BASIS,        *
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
+ * See the License for the specific language governing permissions and      *
+ * limitations under the License.                                           *
+ ***************************************************************************/
+package com.optimizely.ab.bucketing;
+
+public enum DecisionPath {
+    WITH_CMAB,      // Use CMAB logic
+    WITHOUT_CMAB    // Skip CMAB logic (traditional A/B testing)
+}