[FSSDK-11136] add cmab support

android-sdk/src/androidTest/java/com/optimizely/ab/android/sdk/ODPIntegrationUpdateConfigTest.java

@@ -117,6 +117,7 @@ public void setup() throws Exception {
             notificationCenter,
             null,
             odpManager,
+            null,
             "test-vuid",
             null,
             null);

android-sdk/src/androidTest/java/com/optimizely/ab/android/sdk/OptimizelyClientTest.java

@@ -2249,7 +2249,9 @@ public void testDecide() {
         assertEquals(decision.getVariables().toMap(), variablesExpected.toMap());
         assertEquals(decision.getRuleKey(), FEATURE_MULTI_VARIATE_EXPERIMENT_KEY);
         assertEquals(decision.getFlagKey(), flagKey);
-        assertEquals(decision.getUserContext(), userContext);
+        OptimizelyUserContext decisionUserContext = decision.getUserContext();
+        assertEquals(decisionUserContext.getUserId(), userContext.getUserId());
+        assertEquals(decisionUserContext.getAttributes(), userContext.getAttributes());
         assertTrue(decision.getReasons().isEmpty());
     }
 

android-sdk/src/androidTest/java/com/optimizely/ab/android/sdk/OptimizelyManagerTest.java

@@ -163,7 +163,7 @@ public void initializeSyncWithEnvironment() {
         EventHandler eventHandler = mock(DefaultEventHandler.class);
         EventProcessor eventProcessor = mock(EventProcessor.class);
         OptimizelyManager optimizelyManager = new OptimizelyManager(testProjectId, testSdkKey, null, logger, 3600L, datafileHandler, null, 3600L,
-                eventHandler, eventProcessor, null, null, null, null, null, null, null);
+                eventHandler, eventProcessor, null, null, null, null, null, null, null, null);
         /*
          * Scenario#1: when datafile is not Empty
          * Scenario#2: when datafile is Empty
@@ -222,7 +222,7 @@ public void initializeAsyncWithEnvironment() {
         EventHandler eventHandler = mock(DefaultEventHandler.class);
         EventProcessor eventProcessor = mock(EventProcessor.class);
         final OptimizelyManager optimizelyManager = new OptimizelyManager(testProjectId, testSdkKey, null, logger, 3600L, datafileHandler, null, 3600L,
-                eventHandler, eventProcessor, null, null, null, null, null, null, null);
+                eventHandler, eventProcessor, null, null, null, null, null, null, null, null);
 
         /*
          * Scenario#1: when datafile is not Empty
@@ -494,7 +494,7 @@ public void initializeSyncWithUpdateOnNewDatafileDisabled() {
         Context context = InstrumentationRegistry.getInstrumentation().getTargetContext();
 
         OptimizelyManager manager = new OptimizelyManager(testProjectId, testSdkKey, null, logger, pollingInterval, datafileHandler, null, 0,
-                null, null, null, null, null, null, null, null, null);
+                null, null, null, null, null, null, null, null, null, null);
 
         ArgumentCaptor<Context> contextCaptor = ArgumentCaptor.forClass(Context.class);
         ArgumentCaptor<DatafileConfig> configCaptor = ArgumentCaptor.forClass(DatafileConfig.class);
@@ -533,7 +533,7 @@ public void initializeSyncWithUpdateOnNewDatafileEnabled() {
         Context context = InstrumentationRegistry.getInstrumentation().getTargetContext();
 
         OptimizelyManager manager = new OptimizelyManager(testProjectId, testSdkKey, null, logger, pollingInterval, datafileHandler, null, 0,
-                null, null, null, null, null, null, null, null, null);
+                null, null, null, null, null, null, null, null, null, null);
 
         ArgumentCaptor<Context> contextCaptor = ArgumentCaptor.forClass(Context.class);
         ArgumentCaptor<DatafileConfig> configCaptor = ArgumentCaptor.forClass(DatafileConfig.class);
@@ -572,7 +572,7 @@ public void initializeSyncWithDownloadToCacheDisabled() {
         Context context = InstrumentationRegistry.getInstrumentation().getTargetContext();
 
         OptimizelyManager manager = new OptimizelyManager(testProjectId, testSdkKey, null, logger, pollingInterval, datafileHandler, null, 0,
-                null, null, null, null, null, null, null, null, null);
+                null, null, null, null, null, null, null, null, null, null);
 
         ArgumentCaptor<Context> contextCaptor = ArgumentCaptor.forClass(Context.class);
         ArgumentCaptor<DatafileConfig> configCaptor = ArgumentCaptor.forClass(DatafileConfig.class);
@@ -611,7 +611,7 @@ public void initializeSyncWithUpdateOnNewDatafileDisabledWithPeriodicPollingEnab
         Context context = InstrumentationRegistry.getInstrumentation().getTargetContext();
 
         OptimizelyManager manager = new OptimizelyManager(testProjectId, testSdkKey, null, logger, pollingInterval, datafileHandler, null, 0,
-                null, null, null, null, null, null, null, null, null);
+                null, null, null, null, null, null, null, null, null, null);
 
         ArgumentCaptor<Context> contextCaptor = ArgumentCaptor.forClass(Context.class);
         ArgumentCaptor<DatafileConfig> configCaptor = ArgumentCaptor.forClass(DatafileConfig.class);
@@ -651,7 +651,7 @@ public void initializeSyncWithUpdateOnNewDatafileEnabledWithPeriodicPollingEnabl
         Context context = InstrumentationRegistry.getInstrumentation().getTargetContext();
 
         OptimizelyManager manager = new OptimizelyManager(testProjectId, testSdkKey, null, logger, pollingInterval, datafileHandler, null, 0,
-                null, null, null, null, null, null, null, null, null);
+                null, null, null, null, null, null, null, null, null, null);
 
         ArgumentCaptor<Context> contextCaptor = ArgumentCaptor.forClass(Context.class);
         ArgumentCaptor<DatafileConfig> configCaptor = ArgumentCaptor.forClass(DatafileConfig.class);
@@ -690,7 +690,7 @@ public void initializeSyncWithUpdateOnNewDatafileDisabledWithPeriodicPollingDisa
         Context context = InstrumentationRegistry.getInstrumentation().getTargetContext();
 
         OptimizelyManager manager = new OptimizelyManager(testProjectId, testSdkKey, null, logger, pollingInterval, datafileHandler, null, 0,
-                null, null, null, null, null, null, null, null, null);
+                null, null, null, null, null, null, null, null, null, null);
 
         ArgumentCaptor<Context> contextCaptor = ArgumentCaptor.forClass(Context.class);
         ArgumentCaptor<DatafileConfig> configCaptor = ArgumentCaptor.forClass(DatafileConfig.class);
@@ -706,7 +706,7 @@ public void initializeSyncWithUpdateOnNewDatafileDisabledWithPeriodicPollingDisa
 
             return datafileHandler;
         }).when(manager.getDatafileHandler()).downloadDatafile(contextCaptor.capture(), configCaptor.capture(), listenerCaptor.capture());
-        
+
         OptimizelyClient client = manager.initialize(context, defaultDatafile, downloadToCache, updateConfigOnNewDatafile);
 
         try {
@@ -730,7 +730,7 @@ public void initializeSyncWithUpdateOnNewDatafileEnabledWithPeriodicPollingDisab
         Context context = InstrumentationRegistry.getInstrumentation().getTargetContext();
 
         OptimizelyManager manager = new OptimizelyManager(testProjectId, testSdkKey, null, logger, pollingInterval, datafileHandler, null, 0,
-                null, null, null, null, null, null, null, null, null);
+                null, null, null, null, null, null, null, null, null, null);
 
         ArgumentCaptor<Context> contextCaptor = ArgumentCaptor.forClass(Context.class);
         ArgumentCaptor<DatafileConfig> configCaptor = ArgumentCaptor.forClass(DatafileConfig.class);
@@ -769,7 +769,7 @@ public void initializeSyncWithResourceDatafileNoCache() {
         Context context = InstrumentationRegistry.getInstrumentation().getTargetContext();
 
         OptimizelyManager manager = spy(new OptimizelyManager(testProjectId, testSdkKey, null, logger, pollingInterval, datafileHandler, null, 0,
-                null, null, null, null, null, null, null, null, null));
+                null, null, null, null, null, null, null, null, null, null));
 
         datafileHandler.removeSavedDatafile(context, manager.getDatafileConfig());
         OptimizelyClient client = manager.initialize(context, R.raw.datafile, downloadToCache, updateConfigOnNewDatafile);
@@ -786,7 +786,7 @@ public void initializeSyncWithResourceDatafileNoCacheWithDefaultParams() {
         Context context = InstrumentationRegistry.getInstrumentation().getTargetContext();
 
         OptimizelyManager manager = spy(new OptimizelyManager(testProjectId, testSdkKey, null, logger, pollingInterval, datafileHandler, null, 0,
-                null, null, null, null, null, null, null, null, null));
+                null, null, null, null, null, null, null, null, null, null));
 
         datafileHandler.removeSavedDatafile(context, manager.getDatafileConfig());
         OptimizelyClient client = manager.initialize(context, R.raw.datafile);

android-sdk/src/main/java/com/optimizely/ab/android/sdk/OptimizelyClient.java

@@ -816,28 +816,33 @@ public OptimizelyConfig getOptimizelyConfig() {
      * @return An OptimizelyUserContext associated with this OptimizelyClient.
      */
     @Nullable
-    public OptimizelyUserContext createUserContext(@NonNull String userId,
-                                                   @NonNull Map<String, Object> attributes) {
-        if (optimizely != null) {
-            return optimizely.createUserContext(userId, attributes);
-        } else {
+    public OptimizelyUserContextAndroid createUserContext(@NonNull String userId,
+                                                          @NonNull Map<String, Object> attributes) {
+        if (optimizely == null) {
             logger.warn("Optimizely is not initialized, could not create a user context");
             return null;
         }
+
+        if (userId == null) {
+            logger.warn("The userId parameter must be nonnull.");
+            return null;
+        }
+
+        return new OptimizelyUserContextAndroid(optimizely, userId, attributes);
     }
 
     @Nullable
-    public OptimizelyUserContext createUserContext(@NonNull String userId) {
+    public OptimizelyUserContextAndroid createUserContext(@NonNull String userId) {
         return createUserContext(userId, Collections.emptyMap());
     }
 
     @Nullable
-    public OptimizelyUserContext createUserContext() {
+    public OptimizelyUserContextAndroid createUserContext() {
         return createUserContext(Collections.emptyMap());
     }
 
     @Nullable
-    public OptimizelyUserContext createUserContext(@NonNull Map<String, Object> attributes) {
+    public OptimizelyUserContextAndroid createUserContext(@NonNull Map<String, Object> attributes) {
         if (vuid == null) {
             logger.warn("Optimizely vuid is not available. A userId is required to create a user context.");
             return null;

android-sdk/src/main/java/com/optimizely/ab/android/sdk/OptimizelyManager.java

@@ -39,9 +39,15 @@
 import com.optimizely.ab.android.event_handler.EventDispatcher;
 import com.optimizely.ab.android.odp.DefaultODPApiManager;
 import com.optimizely.ab.android.odp.VuidManager;
+import com.optimizely.ab.android.sdk.cmab.DefaultCmabClient;
+import com.optimizely.ab.android.shared.Client;
 import com.optimizely.ab.android.shared.DatafileConfig;
+import com.optimizely.ab.android.shared.OptlyStorage;
 import com.optimizely.ab.android.user_profile.DefaultUserProfileService;
 import com.optimizely.ab.bucketing.UserProfileService;
+import com.optimizely.ab.cmab.client.CmabClient;
+import com.optimizely.ab.cmab.service.CmabService;
+import com.optimizely.ab.cmab.service.DefaultCmabService;
 import com.optimizely.ab.config.ProjectConfig;
 import com.optimizely.ab.config.parser.ConfigParseException;
 import com.optimizely.ab.error.ErrorHandler;
@@ -90,6 +96,7 @@ public class OptimizelyManager {
     @NonNull private UserProfileService userProfileService;
     @Nullable private ODPManager odpManager;
     @Nullable private final String vuid;
+    @Nullable private CmabService cmabService;
 
     @Nullable private OptimizelyStartListener optimizelyStartListener;
     private boolean returnInMainThreadFromAsyncInit = true;
@@ -112,6 +119,7 @@ public class OptimizelyManager {
                       @NonNull NotificationCenter notificationCenter,
                       @Nullable List<OptimizelyDecideOption> defaultDecideOptions,
                       @Nullable ODPManager odpManager,
+                      @Nullable CmabService cmabService,
                       @Nullable String vuid,
                       @Nullable String clientEngineName,
                       @Nullable String clientVersion) {
@@ -137,6 +145,7 @@ public class OptimizelyManager {
         this.userProfileService = userProfileService;
         this.vuid = vuid;
         this.odpManager = odpManager;
+        this.cmabService = cmabService;
         this.notificationCenter = notificationCenter;
         this.defaultDecideOptions = defaultDecideOptions;
 
@@ -646,6 +655,7 @@ private OptimizelyClient buildOptimizely(@NonNull Context context, @NonNull Stri
         builder.withNotificationCenter(notificationCenter);
         builder.withDefaultDecideOptions(defaultDecideOptions);
         builder.withODPManager(odpManager);
+        builder.withCmabService(cmabService);
         Optimizely optimizely = builder.build();
 
         return new OptimizelyClient(optimizely, LoggerFactory.getLogger(OptimizelyClient.class), vuid);
@@ -781,15 +791,19 @@ public static class Builder {
         @Nullable private List<OptimizelyDecideOption> defaultDecideOptions = null;
         @Nullable private ODPEventManager odpEventManager;
         @Nullable private ODPSegmentManager odpSegmentManager;
+        @Nullable private CmabClient cmabClient;
 
         private int odpSegmentCacheSize = 100;
-        private int odpSegmentCacheTimeoutInSecs = 600;
+        private int odpSegmentCacheTimeoutInSecs = 10*60;
         private int timeoutForODPSegmentFetchInSecs = 10;
         private int timeoutForODPEventDispatchInSecs = 10;
         private boolean odpEnabled = true;
         private boolean vuidEnabled = false;
         private String vuid = null;
 
+        private int cmabCacheSize = 100;
+        private int cmabCacheTimeoutInSecs = 30*60;
+
         private String customSdkName = null;
         private String customSdkVersion = null;
 
@@ -1058,6 +1072,33 @@ public Builder withClientInfo(@Nullable String clientEngineName, @Nullable Strin
             this.customSdkVersion = clientVersion;
             return this;
         }
+
+        /**
+         * Override the default Cmab cache size (100).
+         * @param size the size
+         * @return this {@link Builder} instance
+         */
+        public Builder withCmabCacheSize(int size) {
+            this.cmabCacheSize = size;
+            return this;
+        }
+
+        /**
+         * Override the default Cmab cache timeout (30 minutes).
+         * @param interval the interval
+         * @param timeUnit the time unit of the timeout argument
+         * @return this {@link Builder} instance
+         */
+        public Builder withCmabCacheTimeout(int interval, TimeUnit timeUnit) {
+            this.cmabCacheTimeoutInSecs = (int) timeUnit.toSeconds(interval);
+            return this;
+        }
+
+        public Builder withCmabClient(CmabClient cmabClient) {
+            this.cmabClient = cmabClient;
+            return this;
+        }
+
         /**
          * Get a new {@link Builder} instance to create {@link OptimizelyManager} with.
          * @param  context the application context used to create default service if not provided.
@@ -1160,6 +1201,15 @@ public OptimizelyManager build(Context context) {
                         .build();
             }
 
+            DefaultCmabService.Builder cmabBuilder = DefaultCmabService.builder();
+            if (cmabClient == null) {
+                cmabClient = new DefaultCmabClient(context);
+            }
+            cmabBuilder.withClient(cmabClient);
+            cmabBuilder.withCmabCacheSize(cmabCacheSize);
+            cmabBuilder.withCmabCacheTimeoutInSecs(cmabCacheTimeoutInSecs);
+            CmabService cmabService = cmabBuilder.build();
+
             return new OptimizelyManager(projectId, sdkKey,
                     datafileConfig,
                     logger,
@@ -1173,6 +1223,7 @@ public OptimizelyManager build(Context context) {
                     notificationCenter,
                     defaultDecideOptions,
                     odpManager,
+                    cmabService,
                     vuid,
                     customSdkName,
                     customSdkVersion