Merge branch 'master' into copilot/check-for-pr-errors

Author: Mat001

.github/workflows/java.yml

@@ -49,17 +49,18 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        jdk: [8, 9]
+        # github not support JVM 8 anymore
+        jdk: [11, 17]
         optimizely_default_parser: [GSON_CONFIG_PARSER, JACKSON_CONFIG_PARSER, JSON_CONFIG_PARSER, JSON_SIMPLE_CONFIG_PARSER]
     steps:
       - name: checkout
         uses: actions/checkout@v4
 
       - name: set up JDK ${{ matrix.jdk }}
-        uses: AdoptOpenJDK/install-jdk@v1
+        uses: actions/setup-java@v4
         with:
-          version: ${{ matrix.jdk }}
-          architecture: x64
+          java-version: ${{ matrix.jdk }}
+          distribution: 'temurin'
 
       - name: Grant execute permission for gradlew
         run: chmod +x gradlew

CHANGELOG.md

@@ -1,5 +1,28 @@
 # Optimizely Java X SDK Changelog
 
+## [4.3.0]
+Dec 10th, 2025
+
+### New Features
+- **CMAB (Contextual Multi-Armed Bandit) Support**: Added support for CMAB experiments with new configuration options and cache control ([#577](https://github.com/optimizely/java-sdk/pull/577), [#578](https://github.com/optimizely/java-sdk/pull/578), [#579](https://github.com/optimizely/java-sdk/pull/579), [#582](https://github.com/optimizely/java-sdk/pull/582), [#583](https://github.com/optimizely/java-sdk/pull/583), [#584](https://github.com/optimizely/java-sdk/pull/584), [#585](https://github.com/optimizely/java-sdk/pull/585), [#590](https://github.com/optimizely/java-sdk/pull/590), [#593](https://github.com/optimizely/java-sdk/pull/593))
+- **Add Holdouts Feature**: Add Holdout support for feature experimentation ([#572](https://github.com/optimizely/java-sdk/pull/572), [#576](https://github.com/optimizely/java-sdk/pull/576))
+- **Multi-Region Support for Data Hosting**: Added SDK support for multi-region data hosting ([#573](https://github.com/optimizely/java-sdk/pull/573))
+
+### API Changes
+- **OptimizelyUserContext**: New asynchronous decision-making methods
+  - `decideAsync()`: Asynchronous method to make a decision for a single flag with CMAB support
+  - `decideAllAsync()`: Asynchronous method to make decisions for all flags
+  - `decideForKeysAsync()`: Asynchronous method to make decisions for multiple flag keys
+
+- **Client Initialization**:
+  - `CmabClientConfig` can be injected when initializing the client for custom CMAB configuration
+  - `CmabService` can be provided to `OptimizelyFactory` for custom CMAB service implementation
+
+- **New Decide Options**: Added cache control options for CMAB
+  - `IGNORE_CMAB_CACHE`: Skip reading from CMAB cache
+  - `RESET_CMAB_CACHE`: Clear and reset CMAB cache before decision
+  - `INVALIDATE_USER_CMAB_CACHE`: Invalidate cache entries for specific user
+
 ## [4.2.2]
 May 28th, 2025
 

README.md

@@ -44,9 +44,9 @@ dependencies {
   compile 'com.optimizely.ab:core-api:{VERSION}'
   compile 'com.optimizely.ab:core-httpclient-impl:{VERSION}'
   // The SDK integrates with multiple JSON parsers, here we use Jackson.
-  compile 'com.fasterxml.jackson.core:jackson-core:2.7.1'
-  compile 'com.fasterxml.jackson.core:jackson-annotations:2.7.1'
-  compile 'com.fasterxml.jackson.core:jackson-databind:2.7.1'
+  compile 'com.fasterxml.jackson.core:jackson-core:2.13.5'
+  compile 'com.fasterxml.jackson.core:jackson-annotations:2.13.5'
+  compile 'com.fasterxml.jackson.core:jackson-databind:2.13.5'
 }
 ```
 

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

@@ -318,7 +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.
+     * @param cmabUuid           The cmabUuid if the experiment is a cmab experiment.
      */
     private boolean sendImpression(@Nonnull ProjectConfig projectConfig,
                                    @Nullable ExperimentCore experiment,
@@ -328,7 +328,7 @@ private boolean sendImpression(@Nonnull ProjectConfig projectConfig,
                                    @Nonnull String flagKey,
                                    @Nonnull String ruleType,
                                    @Nonnull boolean enabled,
-                                   @Nullable String cmabUUID) {
+                                   @Nullable String cmabUuid) {
 
         UserEvent userEvent = UserEventFactory.createImpressionEvent(
             projectConfig,
@@ -339,11 +339,12 @@ private boolean sendImpression(@Nonnull ProjectConfig projectConfig,
             flagKey,
             ruleType,
             enabled,
-            cmabUUID);
+            cmabUuid);
 
         if (userEvent == null) {
             return false;
         }
+        eventProcessor.getClass().getName();
         eventProcessor.process(userEvent);
         if (experiment != null) {
             logger.info("Activating user \"{}\" in experiment \"{}\".", userId, experiment.getKey());
@@ -501,7 +502,7 @@ private Boolean isFeatureEnabled(@Nonnull ProjectConfig projectConfig,
         if (featureDecision.decisionSource != null) {
             decisionSource = featureDecision.decisionSource;
         }
-        String cmabUUID = featureDecision.cmabUUID;
+        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.
@@ -524,7 +525,7 @@ private Boolean isFeatureEnabled(@Nonnull ProjectConfig projectConfig,
             featureKey,
             decisionSource.toString(),
             featureEnabled,
-            cmabUUID);
+            cmabUuid);
 
         DecisionNotification decisionNotification = DecisionNotification.newFeatureDecisionNotificationBuilder()
             .withUserId(userId)
@@ -1339,7 +1340,7 @@ private OptimizelyDecision createOptimizelyDecision(
         Map<String, Object> attributes = user.getAttributes();
         Map<String, ?> copiedAttributes = new HashMap<>(attributes);
 
-        String cmabUUID =  flagDecision.cmabUUID;
+        String cmabUuid =  flagDecision.cmabUuid;
 
         if (!allOptions.contains(OptimizelyDecideOption.DISABLE_DECISION_EVENT)) {
             decisionEventDispatched = sendImpression(
@@ -1351,7 +1352,7 @@ private OptimizelyDecision createOptimizelyDecision(
                 flagKey,
                 decisionSource.toString(),
                 flagEnabled,
-                cmabUUID);
+                cmabUuid);
         }
 
         DecisionNotification decisionNotification = DecisionNotification.newFlagDecisionNotificationBuilder()

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

@@ -169,7 +169,7 @@ public DecisionResponse<Variation> getVariation(@Nonnull Experiment experiment,
         reasons.merge(decisionMeetAudience.getReasons());
         if (decisionMeetAudience.getResult()) {
             String bucketingId = getBucketingId(user.getUserId(), user.getAttributes());
-            String cmabUUID = null;
+            String cmabUuid = 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  
@@ -185,7 +185,7 @@ public DecisionResponse<Variation> getVariation(@Nonnull Experiment experiment,
                 CmabDecision cmabResult = cmabDecision.getResult();
                 if (cmabResult != null) {
                     String variationId = cmabResult.getVariationId();
-                    cmabUUID = cmabResult.getCmabUUID();
+                    cmabUuid = cmabResult.getCmabUuid();
                     variation = experiment.getVariationIdToVariationMap().get(variationId);
                 }
             } else {
@@ -202,7 +202,7 @@ public DecisionResponse<Variation> getVariation(@Nonnull Experiment experiment,
                 }
             }
 
-            return new DecisionResponse<>(variation, reasons, false, cmabUUID);
+            return new DecisionResponse<>(variation, reasons, false, cmabUuid);
         }
 
         String message = reasons.addInfo("User \"%s\" does not meet conditions to be in experiment \"%s\".", user.getUserId(), experiment.getKey());
@@ -337,7 +337,7 @@ public  List<DecisionResponse<FeatureDecision>> getVariationsForFeatureList(@Non
             boolean error = decisionVariationResponse.isError();
 
             if (decision != null) {
-                decisions.add(new DecisionResponse(decision, reasons, error, decision.cmabUUID));
+                decisions.add(new DecisionResponse(decision, reasons, error, decision.cmabUuid));
                 continue;
             }
 
@@ -396,21 +396,21 @@ DecisionResponse<FeatureDecision> getVariationFromExperiment(@Nonnull ProjectCon
                     getVariationFromExperimentRule(projectConfig, featureFlag.getKey(), experiment, user, options, userProfileTracker, decisionPath);
                 reasons.merge(decisionVariation.getReasons());
                 Variation variation = decisionVariation.getResult();
-                String cmabUUID = decisionVariation.getCmabUUID();
+                String cmabUuid = decisionVariation.getCmabUuid();
                 boolean error = decisionVariation.isError();
                 if (error) {
                     return new DecisionResponse(
-                        new FeatureDecision(experiment, variation, FeatureDecision.DecisionSource.FEATURE_TEST, cmabUUID),
+                        new FeatureDecision(experiment, variation, FeatureDecision.DecisionSource.FEATURE_TEST, cmabUuid),
                         reasons,
                         decisionVariation.isError(),
-                        cmabUUID);
+                        cmabUuid);
                 }
                 if (variation != null) {
                     return new DecisionResponse(
-                        new FeatureDecision(experiment, variation, FeatureDecision.DecisionSource.FEATURE_TEST, cmabUUID),
+                        new FeatureDecision(experiment, variation, FeatureDecision.DecisionSource.FEATURE_TEST, cmabUuid),
                         reasons,
                         decisionVariation.isError(),
-                        cmabUUID);
+                        cmabUuid);
                 }
             }
         } else {
@@ -845,7 +845,7 @@ private DecisionResponse<Variation> getVariationFromExperimentRule(@Nonnull Proj
 
         variation = decisionResponse.getResult();
 
-        return new DecisionResponse<>(variation, reasons, decisionResponse.isError(), decisionResponse.getCmabUUID());
+        return new DecisionResponse<>(variation, reasons, decisionResponse.isError(), decisionResponse.getCmabUuid());
     }
 
     /**

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

@@ -43,7 +43,7 @@ public class FeatureDecision {
      * The CMAB UUID for Contextual Multi-Armed Bandit experiments.
      */
     @Nullable
-    public String cmabUUID;
+    public String cmabUuid;
 
     public enum DecisionSource {
         FEATURE_TEST("feature-test"),
@@ -74,7 +74,7 @@ public FeatureDecision(@Nullable ExperimentCore experiment, @Nullable Variation
         this.experiment = experiment;
         this.variation = variation;
         this.decisionSource = decisionSource;
-        this.cmabUUID = null;
+        this.cmabUuid = null;
     }
 
     /**
@@ -83,14 +83,14 @@ public FeatureDecision(@Nullable ExperimentCore experiment, @Nullable Variation
      * @param experiment     The {@link ExperimentCore} the Feature is associated with.
      * @param variation      The {@link Variation} the user was bucketed into.
      * @param decisionSource The source of the variation.
-     * @param cmabUUID       The CMAB UUID for Contextual Multi-Armed Bandit experiments.
+     * @param cmabUuid       The CMAB UUID for Contextual Multi-Armed Bandit experiments.
      */
     public FeatureDecision(@Nullable ExperimentCore experiment, @Nullable Variation variation,
-                           @Nullable DecisionSource decisionSource, @Nullable String cmabUUID) {
+                           @Nullable DecisionSource decisionSource, @Nullable String cmabUuid) {
         this.experiment = experiment;
         this.variation = variation;
         this.decisionSource = decisionSource;
-        this.cmabUUID = cmabUUID;
+        this.cmabUuid = cmabUuid;
     }
 
     @Override
@@ -103,14 +103,14 @@ public boolean equals(Object o) {
         if (variation != null ? !variation.equals(that.variation) : that.variation != null)
             return false;
         if (decisionSource != that.decisionSource) return false;
-        return cmabUUID != null ? cmabUUID.equals(that.cmabUUID) : that.cmabUUID == null;
+        return cmabUuid != null ? cmabUuid.equals(that.cmabUuid) : that.cmabUuid == null;
     }
 
     @Override
     public int hashCode() {
         int result = variation != null ? variation.hashCode() : 0;
         result = 31 * result + (decisionSource != null ? decisionSource.hashCode() : 0);
-        result = 31 * result + (cmabUUID != null ? cmabUUID.hashCode() : 0);
+        result = 31 * result + (cmabUuid != null ? cmabUuid.hashCode() : 0);
         return result;
     }
 }

core-api/src/main/java/com/optimizely/ab/cmab/client/CmabClient.java

@@ -24,8 +24,8 @@ public interface CmabClient {
      * @param ruleId     The rule/experiment ID
      * @param userId     The user ID
      * @param attributes User attributes
-     * @param cmabUUID   The CMAB UUID
+     * @param cmabUuid   The CMAB UUID
      * @return CompletableFuture containing the variation ID as a String
      */
-    String fetchDecision(String ruleId, String userId, Map<String, Object> attributes, String cmabUUID);
+    String fetchDecision(String ruleId, String userId, Map<String, Object> attributes, String cmabUuid);
 }

core-api/src/main/java/com/optimizely/ab/cmab/service/CmabCacheValue.java

@@ -20,12 +20,12 @@
 public class CmabCacheValue {
     private final String attributesHash;
     private final String variationId;
-    private final String cmabUUID;
+    private final String cmabUuid;
 
-    public CmabCacheValue(String attributesHash, String variationId, String cmabUUID) {
+    public CmabCacheValue(String attributesHash, String variationId, String cmabUuid) {
         this.attributesHash = attributesHash;
         this.variationId = variationId;
-        this.cmabUUID = cmabUUID;
+        this.cmabUuid = cmabUuid;
     }
 
     public String getAttributesHash() {
@@ -37,15 +37,15 @@ public String getVariationId() {
     }
 
     public String getCmabUuid() {
-        return cmabUUID;
+        return cmabUuid;
     }
 
     @Override
     public String toString() {
         return "CmabCacheValue{" +
             "attributesHash='" + attributesHash + '\'' +
             ", variationId='" + variationId + '\'' +
-            ", cmabUuid='" + cmabUUID + '\'' +
+            ", cmabUuid='" + cmabUuid + '\'' +
             '}';
     }
 
@@ -56,11 +56,11 @@ public boolean equals(Object o) {
         CmabCacheValue that = (CmabCacheValue) o;
         return Objects.equals(attributesHash, that.attributesHash) &&
             Objects.equals(variationId, that.variationId) &&
-            Objects.equals(cmabUUID, that.cmabUUID);
+            Objects.equals(cmabUuid, that.cmabUuid);
     }
 
     @Override
     public int hashCode() {
-        return Objects.hash(attributesHash, variationId, cmabUUID);
+        return Objects.hash(attributesHash, variationId, cmabUuid);
     }
 }

core-api/src/main/java/com/optimizely/ab/cmab/service/CmabDecision.java

@@ -19,26 +19,26 @@
 
 public class CmabDecision {
     private final String variationId;
-    private final String cmabUUID;
+    private final String cmabUuid;
 
-    public CmabDecision(String variationId, String cmabUUID) {
+    public CmabDecision(String variationId, String cmabUuid) {
         this.variationId = variationId;
-        this.cmabUUID = cmabUUID;
+        this.cmabUuid = cmabUuid;
     }
 
     public String getVariationId() {
         return variationId;
     }
 
-    public String getCmabUUID() {
-        return cmabUUID;
+    public String getCmabUuid() {
+        return cmabUuid;
     }
 
     @Override
     public String toString() {
         return "CmabDecision{" +
             "variationId='" + variationId + '\'' +
-            ", cmabUUID='" + cmabUUID + '\'' +
+            ", cmabUuid='" + cmabUuid + '\'' +
             '}';
     }
 
@@ -48,11 +48,11 @@ public boolean equals(Object o) {
         if (o == null || getClass() != o.getClass()) return false;
         CmabDecision that = (CmabDecision) o;
         return Objects.equals(variationId, that.variationId) &&
-            Objects.equals(cmabUUID, that.cmabUUID);
+            Objects.equals(cmabUuid, that.cmabUuid);
     }
 
     @Override
     public int hashCode() {
-        return Objects.hash(variationId, cmabUUID);
+        return Objects.hash(variationId, cmabUuid);
     }
 }

core-api/src/main/java/com/optimizely/ab/cmab/service/DefaultCmabService.java

@@ -22,7 +22,6 @@
 import java.util.TreeMap;
 import java.util.concurrent.locks.ReentrantLock;
 
-import com.optimizely.ab.event.internal.ClientEngineInfo;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -32,6 +31,7 @@
 import com.optimizely.ab.config.Attribute;
 import com.optimizely.ab.config.Experiment;
 import com.optimizely.ab.config.ProjectConfig;
+import com.optimizely.ab.event.internal.ClientEngineInfo;
 import com.optimizely.ab.internal.Cache;
 import com.optimizely.ab.internal.DefaultLRUCache;
 import com.optimizely.ab.optimizelydecision.OptimizelyDecideOption;
@@ -107,7 +107,7 @@ public CmabDecision getDecision(ProjectConfig projectConfig, OptimizelyUserConte
             CmabDecision cmabDecision = fetchDecision(ruleId, userId, filteredAttributes);
             logger.debug("CMAB decision is {}", cmabDecision);
 
-            cmabCache.save(cacheKey, new CmabCacheValue(attributesHash, cmabDecision.getVariationId(), cmabDecision.getCmabUUID()));
+            cmabCache.save(cacheKey, new CmabCacheValue(attributesHash, cmabDecision.getVariationId(), cmabDecision.getCmabUuid()));
 
             return cmabDecision;
         } finally {