update: add Javadoc comments for async decision methods and config creation in CMAB client

Author: FarhanAnjum-opti

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

@@ -313,13 +313,19 @@ public void decideForKeysAsync(@Nonnull List<String> keys,
 
     /**
      * Returns decision results asynchronously for multiple flag keys.
+     * 
+     * @param keys A list of flag keys for which decisions will be made.
+     * @param callback A callback to invoke when decisions are available.
      */
     public void decideForKeysAsync(@Nonnull List<String> keys, @Nonnull OptimizelyDecisionsCallback callback) {
         decideForKeysAsync(keys, callback, Collections.emptyList());
     }
 
     /**
      * Returns decision results asynchronously for all active flag keys.
+     *
+     * @param callback A callback to invoke when decisions are available.
+     * @param options A list of options for decision-making.
      */
     public void decideAllAsync(@Nonnull OptimizelyDecisionsCallback callback,
                                @Nonnull List<OptimizelyDecideOption> options) {
@@ -329,6 +335,8 @@ public void decideAllAsync(@Nonnull OptimizelyDecisionsCallback callback,
 
     /**
      * Returns decision results asynchronously for all active flag keys.
+     * 
+     * @param callback A callback to invoke when decisions are available.
      */
     public void decideAllAsync(@Nonnull OptimizelyDecisionsCallback callback) {
         decideAllAsync(callback, Collections.emptyList());

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

@@ -106,6 +106,7 @@ public DecisionService(@Nonnull Bucketer bucketer,
      * @param options              An array of decision options
      * @param userProfileTracker   tracker for reading and updating user profile of the user
      * @param reasons              Decision reasons
+     * @param useCmab              Boolean flag to determine if cmab service is to be used
      * @return A {@link DecisionResponse} including the {@link Variation} that user is bucketed into (or null) and the decision reasons
      */
     @Nonnull

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

@@ -35,13 +35,17 @@ public RetryConfig getRetryConfig() {
 
     /**
      * Creates a config with default retry settings.
+     * 
+     * @return A default cmab client config
      */
     public static CmabClientConfig withDefaultRetry() {
         return new CmabClientConfig(RetryConfig.defaultConfig());
     }
 
     /**
      * Creates a config with no retry.
+     * 
+     * @return A cmab client config with no retry
      */
     public static CmabClientConfig withNoRetry() {
         return new CmabClientConfig(null);

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

@@ -62,13 +62,17 @@ public RetryConfig(int maxRetries) {
 
     /**
      * Creates a default RetryConfig with 3 retries and exponential backoff.
+     * 
+     * @return Retry config with default settings
      */
     public static RetryConfig defaultConfig() {
         return new RetryConfig(3);
     }
 
     /**
      * Creates a RetryConfig with no retries (single attempt only).
+     * 
+     * @return Retry config with no retries
      */
     public static RetryConfig noRetry() {
         return new RetryConfig(0, 0, 1.0, 0);

core-api/src/test/java/com/optimizely/ab/bucketing/DecisionServiceTest.java

@@ -566,7 +566,7 @@ public void getVariationsForFeatureListBatchesUpsLoadAndSave() throws Exception
         ErrorHandler mockErrorHandler = mock(ErrorHandler.class);
         UserProfileService mockUserProfileService = mock(UserProfileService.class);
 
-        DecisionService decisionService = new DecisionService(bucketer, mockErrorHandler, mockUserProfileService, null);
+        DecisionService decisionService = new DecisionService(bucketer, mockErrorHandler, mockUserProfileService, mockCmabService);
 
         FeatureFlag featureFlag1 = FEATURE_FLAG_MULTI_VARIATE_FEATURE;
         FeatureFlag featureFlag2 = FEATURE_FLAG_MULTI_VARIATE_FUTURE_FEATURE;
@@ -626,7 +626,7 @@ public void getVariationForFeatureInRolloutReturnsNullWhenUserIsExcludedFromAllT
             mockBucketer,
             mockErrorHandler,
             null,
-            null
+            mockCmabService
         );
 
         FeatureDecision featureDecision = decisionService.getVariationForFeatureInRollout(
@@ -653,7 +653,7 @@ public void getVariationForFeatureInRolloutReturnsNullWhenUserFailsAllAudiencesA
         Bucketer mockBucketer = mock(Bucketer.class);
         when(mockBucketer.bucket(any(Experiment.class), anyString(), any(ProjectConfig.class))).thenReturn(DecisionResponse.nullNoReasons());
 
-        DecisionService decisionService = new DecisionService(mockBucketer, mockErrorHandler, null, null);
+        DecisionService decisionService = new DecisionService(mockBucketer, mockErrorHandler, null, mockCmabService);
 
         FeatureDecision featureDecision = decisionService.getVariationForFeatureInRollout(
             FEATURE_FLAG_MULTI_VARIATE_FEATURE,
@@ -684,7 +684,7 @@ public void getVariationForFeatureInRolloutReturnsVariationWhenUserFailsAllAudie
             mockBucketer,
             mockErrorHandler,
             null,
-            null
+            mockCmabService
         );
 
         FeatureDecision featureDecision = decisionService.getVariationForFeatureInRollout(
@@ -726,7 +726,7 @@ public void getVariationForFeatureInRolloutReturnsVariationWhenUserFailsTrafficI
             mockBucketer,
             mockErrorHandler,
             null,
-            null
+            mockCmabService
         );
 
         FeatureDecision featureDecision = decisionService.getVariationForFeatureInRollout(
@@ -767,7 +767,7 @@ public void getVariationForFeatureInRolloutReturnsVariationWhenUserFailsTrafficI
             mockBucketer,
             mockErrorHandler,
             null,
-            null
+            mockCmabService
         );
 
         FeatureDecision featureDecision = decisionService.getVariationForFeatureInRollout(
@@ -806,7 +806,7 @@ public void getVariationForFeatureInRolloutReturnsVariationWhenUserFailsTargetin
         when(mockBucketer.bucket(eq(everyoneElseRule), anyString(), any(ProjectConfig.class))).thenReturn(DecisionResponse.responseNoReasons(everyoneElseVariation));
         when(mockBucketer.bucket(eq(englishCitizensRule), anyString(), any(ProjectConfig.class))).thenReturn(DecisionResponse.responseNoReasons(englishCitizenVariation));
 
-        DecisionService decisionService = new DecisionService(mockBucketer, mockErrorHandler, null, null);
+        DecisionService decisionService = new DecisionService(mockBucketer, mockErrorHandler, null, mockCmabService);
 
         FeatureDecision featureDecision = decisionService.getVariationForFeatureInRollout(
             FEATURE_FLAG_MULTI_VARIATE_FEATURE,
@@ -959,7 +959,7 @@ public void bucketReturnsVariationStoredInUserProfile() throws Exception {
         when(userProfileService.lookup(userProfileId)).thenReturn(userProfile.toMap());
 
         Bucketer bucketer = new Bucketer();
-        DecisionService decisionService = new DecisionService(bucketer, mockErrorHandler, userProfileService, null);
+        DecisionService decisionService = new DecisionService(bucketer, mockErrorHandler, userProfileService, mockCmabService);
 
         logbackVerifier.expectMessage(Level.INFO,
             "Returning previously activated variation \"" + variation.getKey() + "\" of experiment \"" + experiment.getKey() + "\""
@@ -985,7 +985,7 @@ public void getStoredVariationLogsWhenLookupReturnsNull() throws Exception {
         UserProfile userProfile = new UserProfile(userProfileId, Collections.<String, Decision>emptyMap());
         when(userProfileService.lookup(userProfileId)).thenReturn(userProfile.toMap());
 
-        DecisionService decisionService = new DecisionService(bucketer, mockErrorHandler, userProfileService, null);
+        DecisionService decisionService = new DecisionService(bucketer, mockErrorHandler, userProfileService, mockCmabService);
 
         logbackVerifier.expectMessage(Level.INFO, "No previously activated variation of experiment " +
             "\"" + experiment.getKey() + "\" for user \"" + userProfileId + "\" found in user profile.");
@@ -1012,7 +1012,7 @@ public void getStoredVariationReturnsNullWhenVariationIsNoLongerInConfig() throw
         UserProfileService userProfileService = mock(UserProfileService.class);
         when(userProfileService.lookup(userProfileId)).thenReturn(storedUserProfile.toMap());
 
-        DecisionService decisionService = new DecisionService(bucketer, mockErrorHandler, userProfileService, null);
+        DecisionService decisionService = new DecisionService(bucketer, mockErrorHandler, userProfileService, mockCmabService);
 
         logbackVerifier.expectMessage(Level.INFO,
             "User \"" + userProfileId + "\" was previously bucketed into variation with ID \"" + storedVariationId + "\" for " +
@@ -1043,7 +1043,7 @@ public void getVariationSavesBucketedVariationIntoUserProfile() throws Exception
         Bucketer mockBucketer = mock(Bucketer.class);
         when(mockBucketer.bucket(eq(experiment), eq(userProfileId), eq(noAudienceProjectConfig))).thenReturn(DecisionResponse.responseNoReasons(variation));
 
-        DecisionService decisionService = new DecisionService(mockBucketer, mockErrorHandler, userProfileService, null);
+        DecisionService decisionService = new DecisionService(mockBucketer, mockErrorHandler, userProfileService, mockCmabService);
 
         assertEquals(variation, decisionService.getVariation(
             experiment, optimizely.createUserContext(userProfileId, Collections.emptyMap()), noAudienceProjectConfig).getResult()
@@ -1105,7 +1105,7 @@ public void getVariationSavesANewUserProfile() throws Exception {
 
         Bucketer bucketer = mock(Bucketer.class);
         UserProfileService userProfileService = mock(UserProfileService.class);
-        DecisionService decisionService = new DecisionService(bucketer, mockErrorHandler, userProfileService, null);
+        DecisionService decisionService = new DecisionService(bucketer, mockErrorHandler, userProfileService, mockCmabService);
 
         when(bucketer.bucket(eq(experiment), eq(userProfileId), eq(noAudienceProjectConfig))).thenReturn(DecisionResponse.responseNoReasons(variation));
         when(userProfileService.lookup(userProfileId)).thenReturn(null);
@@ -1117,7 +1117,7 @@ public void getVariationSavesANewUserProfile() throws Exception {
     @Test
     public void getVariationBucketingId() throws Exception {
         Bucketer bucketer = mock(Bucketer.class);
-        DecisionService decisionService = spy(new DecisionService(bucketer, mockErrorHandler, null, null));
+        DecisionService decisionService = spy(new DecisionService(bucketer, mockErrorHandler, null, mockCmabService));
         Experiment experiment = validProjectConfig.getExperiments().get(0);
         Variation expectedVariation = experiment.getVariations().get(0);
 
@@ -1152,7 +1152,7 @@ public void getVariationForRolloutWithBucketingId() {
             bucketer,
             mockErrorHandler,
             null,
-            null
+            mockCmabService
         ));
 
         FeatureDecision expectedFeatureDecision = new FeatureDecision(
@@ -1307,7 +1307,7 @@ public void getVariationForFeatureReturnHoldoutDecisionForGlobalHoldout() {
 
         Bucketer mockBucketer = new Bucketer();
 
-        DecisionService decisionService = new DecisionService(mockBucketer, mockErrorHandler, null, null);
+        DecisionService decisionService = new DecisionService(mockBucketer, mockErrorHandler, null, mockCmabService);
 
         Map<String, Object> attributes = new HashMap<>();
         attributes.put("$opt_bucketing_id", "ppid160000");
@@ -1353,7 +1353,7 @@ public void excludedFlagsHoldoutAppliesToAllExceptSpecified() {
 
         Bucketer mockBucketer = new Bucketer();
 
-        DecisionService decisionService = new DecisionService(mockBucketer, mockErrorHandler, null, null);
+        DecisionService decisionService = new DecisionService(mockBucketer, mockErrorHandler, null, mockCmabService);
 
         Map<String, Object> attributes = new HashMap<>();
         attributes.put("$opt_bucketing_id", "ppid300002");
@@ -1384,7 +1384,7 @@ public void userMeetsHoldoutAudienceConditions() {
 
         Bucketer mockBucketer = new Bucketer();
 
-        DecisionService decisionService = new DecisionService(mockBucketer, mockErrorHandler, null, null);
+        DecisionService decisionService = new DecisionService(mockBucketer, mockErrorHandler, null, mockCmabService);
 
         Map<String, Object> attributes = new HashMap<>();
         attributes.put("$opt_bucketing_id", "ppid543400");