update: rename methods to use 'Sync' suffix for clarity in decision-making logic

Author: FarhanAnjum-opti

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

@@ -1507,7 +1507,7 @@ Map<String, OptimizelyDecision> decideAll(@Nonnull OptimizelyUserContext user,
      * @param options A list of options for decision-making.
      * @return A decision result using traditional A/B testing logic only.
      */
-    OptimizelyDecision decideWithoutCmab(@Nonnull OptimizelyUserContext user,
+    OptimizelyDecision decideSync(@Nonnull OptimizelyUserContext user,
                                         @Nonnull String key,
                                         @Nonnull List<OptimizelyDecideOption> options) {
         ProjectConfig projectConfig = getProjectConfig();
@@ -1518,7 +1518,7 @@ OptimizelyDecision decideWithoutCmab(@Nonnull OptimizelyUserContext user,
         List<OptimizelyDecideOption> allOptions = getAllOptions(options);
         allOptions.remove(OptimizelyDecideOption.ENABLED_FLAGS_ONLY);
 
-        return decideForKeysWithoutCmab(user, Arrays.asList(key), allOptions, true).get(key);
+        return decideForKeysSync(user, Arrays.asList(key), allOptions, true).get(key);
     }
 
     /**
@@ -1529,10 +1529,10 @@ OptimizelyDecision decideWithoutCmab(@Nonnull OptimizelyUserContext user,
      * @param options A list of options for decision-making.
      * @return All decision results mapped by flag keys, using traditional A/B testing logic only.
      */
-    Map<String, OptimizelyDecision> decideForKeysWithoutCmab(@Nonnull OptimizelyUserContext user,
+    Map<String, OptimizelyDecision> decideForKeysSync(@Nonnull OptimizelyUserContext user,
                                                             @Nonnull List<String> keys,
                                                             @Nonnull List<OptimizelyDecideOption> options) {
-        return decideForKeysWithoutCmab(user, keys, options, false);
+        return decideForKeysSync(user, keys, options, false);
     }
 
     /**
@@ -1542,32 +1542,32 @@ Map<String, OptimizelyDecision> decideForKeysWithoutCmab(@Nonnull OptimizelyUser
      * @param options A list of options for decision-making.
      * @return All decision results mapped by flag keys, using traditional A/B testing logic only.
      */
-    Map<String, OptimizelyDecision> decideAllWithoutCmab(@Nonnull OptimizelyUserContext user,
+    Map<String, OptimizelyDecision> decideAllSync(@Nonnull OptimizelyUserContext user,
                                                         @Nonnull List<OptimizelyDecideOption> options) {
         Map<String, OptimizelyDecision> decisionMap = new HashMap<>();
 
         ProjectConfig projectConfig = getProjectConfig();
         if (projectConfig == null) {
-            logger.error("Optimizely instance is not valid, failing decideAllWithoutCmab call.");
+            logger.error("Optimizely instance is not valid, failing decideAllSync call.");
             return decisionMap;
         }
 
         List<FeatureFlag> allFlags = projectConfig.getFeatureFlags();
         List<String> allFlagKeys = new ArrayList<>();
         for (int i = 0; i < allFlags.size(); i++) allFlagKeys.add(allFlags.get(i).getKey());
 
-        return decideForKeysWithoutCmab(user, allFlagKeys, options);
+        return decideForKeysSync(user, allFlagKeys, options);
     }
 
-    private Map<String, OptimizelyDecision> decideForKeysWithoutCmab(@Nonnull OptimizelyUserContext user,
+    private Map<String, OptimizelyDecision> decideForKeysSync(@Nonnull OptimizelyUserContext user,
                                                                     @Nonnull List<String> keys,
                                                                     @Nonnull List<OptimizelyDecideOption> options,
                                                                     boolean ignoreDefaultOptions) {
         Map<String, OptimizelyDecision> decisionMap = new HashMap<>();
 
         ProjectConfig projectConfig = getProjectConfig();
         if (projectConfig == null) {
-            logger.error("Optimizely instance is not valid, failing decideForKeysWithoutCmab call.");
+            logger.error("Optimizely instance is not valid, failing decideForKeysSync call.");
             return decisionMap;
         }
 

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

@@ -213,9 +213,9 @@ public Map<String, OptimizelyDecision> decideAll() {
      * @param options A list of options for decision-making.
      * @return A decision result.
      */
-    public OptimizelyDecision decideWithoutCmab(@Nonnull String key,
+    public OptimizelyDecision decideSync(@Nonnull String key,
                                                 @Nonnull List<OptimizelyDecideOption> options) {
-        return optimizely.decideWithoutCmab(copy(), key, options);
+        return optimizely.decideSync(copy(), key, options);
     }
 
     /**
@@ -225,8 +225,8 @@ public OptimizelyDecision decideWithoutCmab(@Nonnull String key,
      * @param key A flag key for which a decision will be made.
      * @return A decision result.
      */
-    public OptimizelyDecision decideWithoutCmab(@Nonnull String key) {
-        return decideWithoutCmab(key, Collections.emptyList());
+    public OptimizelyDecision decideSync(@Nonnull String key) {
+        return decideSync(key, Collections.emptyList());
     }
 
     /**
@@ -236,9 +236,9 @@ public OptimizelyDecision decideWithoutCmab(@Nonnull String key) {
      * @param options A list of options for decision-making.
      * @return All decision results mapped by flag keys.
      */
-    public Map<String, OptimizelyDecision> decideForKeysWithoutCmab(@Nonnull List<String> keys,
+    public Map<String, OptimizelyDecision> decideForKeysSync(@Nonnull List<String> keys,
                                                                     @Nonnull List<OptimizelyDecideOption> options) {
-        return optimizely.decideForKeysWithoutCmab(copy(), keys, options);
+        return optimizely.decideForKeysSync(copy(), keys, options);
     }
 
     /**
@@ -248,8 +248,8 @@ public Map<String, OptimizelyDecision> decideForKeysWithoutCmab(@Nonnull List<St
      * @param keys A list of flag keys for which decisions will be made.
      * @return All decision results mapped by flag keys.
      */
-    public Map<String, OptimizelyDecision> decideForKeysWithoutCmab(@Nonnull List<String> keys) {
-        return decideForKeysWithoutCmab(keys, Collections.emptyList());
+    public Map<String, OptimizelyDecision> decideForKeysSync(@Nonnull List<String> keys) {
+        return decideForKeysSync(keys, Collections.emptyList());
     }
 
     /**
@@ -259,8 +259,8 @@ public Map<String, OptimizelyDecision> decideForKeysWithoutCmab(@Nonnull List<St
      * @param options A list of options for decision-making.
      * @return All decision results mapped by flag keys.
      */
-    public Map<String, OptimizelyDecision> decideAllWithoutCmab(@Nonnull List<OptimizelyDecideOption> options) {
-        return optimizely.decideAllWithoutCmab(copy(), options);
+    public Map<String, OptimizelyDecision> decideAllSync(@Nonnull List<OptimizelyDecideOption> options) {
+        return optimizely.decideAllSync(copy(), options);
     }
 
     /**
@@ -269,8 +269,8 @@ public Map<String, OptimizelyDecision> decideAllWithoutCmab(@Nonnull List<Optimi
      *
      * @return A dictionary of all decision results, mapped by flag keys.
      */
-    public Map<String, OptimizelyDecision> decideAllWithoutCmab() {
-        return decideAllWithoutCmab(Collections.emptyList());
+    public Map<String, OptimizelyDecision> decideAllSync() {
+        return decideAllSync(Collections.emptyList());
     }
 
     /**

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

@@ -90,7 +90,7 @@ public class DecisionService {
     public DecisionService(@Nonnull Bucketer bucketer,
                            @Nonnull ErrorHandler errorHandler,
                            @Nullable UserProfileService userProfileService,
-                           @Nullable CmabService cmabService) {
+                           @Nonnull CmabService cmabService) {
         this.bucketer = bucketer;
         this.errorHandler = errorHandler;
         this.userProfileService = userProfileService;

core-api/src/test/java/com/optimizely/ab/OptimizelyUserContextTest.java

@@ -2272,7 +2272,7 @@ public void decide_all_with_holdout() throws Exception {
     }
 
     @Test
-    public void decideWithoutCmab_featureTest() {
+    public void decideSync_featureTest() {
         optimizely = new Optimizely.Builder()
             .withDatafile(datafile)
             .withEventProcessor(new ForwardingEventProcessor(eventHandler, null))
@@ -2286,7 +2286,7 @@ public void decideWithoutCmab_featureTest() {
         OptimizelyJSON variablesExpected = optimizely.getAllFeatureVariables(flagKey, userId);
 
         OptimizelyUserContext user = optimizely.createUserContext(userId);
-        OptimizelyDecision decision = user.decideWithoutCmab(flagKey);
+        OptimizelyDecision decision = user.decideSync(flagKey);
 
         assertEquals(decision.getVariationKey(), variationKey);
         assertTrue(decision.getEnabled());
@@ -2307,7 +2307,7 @@ public void decideWithoutCmab_featureTest() {
     }
 
     @Test
-    public void decideForKeysWithoutCmab_multipleFlags() {
+    public void decideForKeysSync_multipleFlags() {
         String flagKey1 = "feature_1";
         String flagKey2 = "feature_2";
 
@@ -2316,7 +2316,7 @@ public void decideForKeysWithoutCmab_multipleFlags() {
         OptimizelyJSON variablesExpected2 = optimizely.getAllFeatureVariables(flagKey2, userId);
 
         OptimizelyUserContext user = optimizely.createUserContext(userId, Collections.singletonMap("gender", "f"));
-        Map<String, OptimizelyDecision> decisions = user.decideForKeysWithoutCmab(flagKeys);
+        Map<String, OptimizelyDecision> decisions = user.decideForKeysSync(flagKeys);
 
         assertEquals(decisions.size(), 2);
 
@@ -2341,15 +2341,15 @@ public void decideForKeysWithoutCmab_multipleFlags() {
     }
 
     @Test
-    public void decideForKeysWithoutCmab_withOptions() {
+    public void decideForKeysSync_withOptions() {
         String flagKey1 = "feature_1";
         String flagKey2 = "feature_2";
 
         List<String> flagKeys = Arrays.asList(flagKey1, flagKey2);
         List<OptimizelyDecideOption> options = Arrays.asList(OptimizelyDecideOption.EXCLUDE_VARIABLES);
 
         OptimizelyUserContext user = optimizely.createUserContext(userId, Collections.singletonMap("gender", "f"));
-        Map<String, OptimizelyDecision> decisions = user.decideForKeysWithoutCmab(flagKeys, options);
+        Map<String, OptimizelyDecision> decisions = user.decideForKeysSync(flagKeys, options);
 
         assertEquals(decisions.size(), 2);
 
@@ -2364,7 +2364,7 @@ public void decideForKeysWithoutCmab_withOptions() {
     }
 
     @Test
-    public void decideAllWithoutCmab_allFlags() {
+    public void decideAllSync_allFlags() {
         EventProcessor mockEventProcessor = mock(EventProcessor.class);
 
         optimizely = new Optimizely.Builder()
@@ -2382,7 +2382,7 @@ public void decideAllWithoutCmab_allFlags() {
         OptimizelyJSON variablesExpected3 = new OptimizelyJSON(Collections.emptyMap());
 
         OptimizelyUserContext user = optimizely.createUserContext(userId, attributes);
-        Map<String, OptimizelyDecision> decisions = user.decideAllWithoutCmab();
+        Map<String, OptimizelyDecision> decisions = user.decideAllSync();
         assertEquals(decisions.size(), 3);
 
         assertEquals(
@@ -2435,12 +2435,12 @@ public void decideAllWithoutCmab_allFlags() {
     }
 
     @Test
-    public void decideAllWithoutCmab_withOptions() {
+    public void decideAllSync_withOptions() {
         String flagKey1 = "feature_1";
         OptimizelyJSON variablesExpected1 = optimizely.getAllFeatureVariables(flagKey1, userId);
 
         OptimizelyUserContext user = optimizely.createUserContext(userId, Collections.singletonMap("gender", "f"));
-        Map<String, OptimizelyDecision> decisions = user.decideAllWithoutCmab(Arrays.asList(OptimizelyDecideOption.ENABLED_FLAGS_ONLY));
+        Map<String, OptimizelyDecision> decisions = user.decideAllSync(Arrays.asList(OptimizelyDecideOption.ENABLED_FLAGS_ONLY));
 
         assertEquals(decisions.size(), 2); // Only enabled flags
 
@@ -2457,7 +2457,7 @@ public void decideAllWithoutCmab_withOptions() {
     }
 
     @Test
-    public void decideAllWithoutCmab_ups_batching() throws Exception {
+    public void decideAllSync_ups_batching() throws Exception {
         UserProfileService ups = mock(UserProfileService.class);
 
         optimizely = new Optimizely.Builder()
@@ -2468,7 +2468,7 @@ public void decideAllWithoutCmab_ups_batching() throws Exception {
         Map<String, Object> attributes = Collections.singletonMap("gender", "f");
 
         OptimizelyUserContext user = optimizely.createUserContext(userId, attributes);
-        Map<String, OptimizelyDecision> decisions = user.decideAllWithoutCmab();
+        Map<String, OptimizelyDecision> decisions = user.decideAllSync();
 
         assertEquals(decisions.size(), 3);
 
@@ -2484,12 +2484,12 @@ public void decideAllWithoutCmab_ups_batching() throws Exception {
     }
 
     @Test
-    public void decideWithoutCmab_sdkNotReady() {
+    public void decideSync_sdkNotReady() {
         String flagKey = "feature_1";
 
         Optimizely optimizely = new Optimizely.Builder().build();
         OptimizelyUserContext user = optimizely.createUserContext(userId);
-        OptimizelyDecision decision = user.decideWithoutCmab(flagKey);
+        OptimizelyDecision decision = user.decideSync(flagKey);
 
         assertNull(decision.getVariationKey());
         assertFalse(decision.getEnabled());
@@ -2502,17 +2502,17 @@ public void decideWithoutCmab_sdkNotReady() {
     }
 
     @Test
-    public void decideForKeysWithoutCmab_sdkNotReady() {
+    public void decideForKeysSync_sdkNotReady() {
         List<String> flagKeys = Arrays.asList("feature_1");
 
         Optimizely optimizely = new Optimizely.Builder().build();
         OptimizelyUserContext user = optimizely.createUserContext(userId);
-        Map<String, OptimizelyDecision> decisions = user.decideForKeysWithoutCmab(flagKeys);
+        Map<String, OptimizelyDecision> decisions = user.decideForKeysSync(flagKeys);
 
         assertEquals(decisions.size(), 0);
     }
     @Test
-    public void decideWithoutCmab_bypassUPS() throws Exception {
+    public void decideSync_bypassUPS() throws Exception {
         String flagKey = "feature_2";        // embedding experiment: "exp_no_audience"
         String experimentId = "10420810910";    // "exp_no_audience"
         String variationId1 = "10418551353";
@@ -2529,11 +2529,11 @@ public void decideWithoutCmab_bypassUPS() throws Exception {
             .build();
 
         OptimizelyUserContext user = optimizely.createUserContext(userId);
-        OptimizelyDecision decision = user.decideWithoutCmab(flagKey);
+        OptimizelyDecision decision = user.decideSync(flagKey);
         // should return variationId2 set by UPS
         assertEquals(decision.getVariationKey(), variationKey2);
 
-        decision = user.decideWithoutCmab(flagKey, Arrays.asList(OptimizelyDecideOption.IGNORE_USER_PROFILE_SERVICE));
+        decision = user.decideSync(flagKey, Arrays.asList(OptimizelyDecideOption.IGNORE_USER_PROFILE_SERVICE));
         // should ignore variationId2 set by UPS and return variationId1
         assertEquals(decision.getVariationKey(), variationKey1);
         // also should not save either