Refactor initialization API to conform to shared design with iOS SDK. (#44)

Author: mikeproeng37

.travis.yml

@@ -4,10 +4,10 @@ android:
     - tools
     - platform-tools
     - build-tools-24.0.3
-    - android-23
-    - doc-23
+    - android-24
+    - doc-24
     - extra-android-m2repository
-    - sys-img-armeabi-v7a-android-23
+    - sys-img-armeabi-v7a-android-24
 jdk:
   - oraclejdk8
 before_cache:
@@ -19,11 +19,11 @@ cache:
 before_script:
   - echo $TRAVIS_BRANCH
   - echo $TRAVIS_TAG
-  - echo no | android create avd --force -n test -t android-23 --abi default/armeabi-v7a
+  - echo no | android create avd --force -n test -t android-24 --abi default/armeabi-v7a
   - emulator -avd test -no-audio -no-window &
   - android-wait-for-emulator
   - adb shell input keyevent 82 &
 script:
+  - ./gradlew cleanAllModules
   - ./gradlew testAllModules
-  - if [[ -n $TRAVIS_TAG ]]; then ./gradlew ship; fi
-
+  - if [[ -n $TRAVIS_TAG ]]; then ./gradlew ship; fi

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

@@ -19,22 +19,27 @@
 import android.content.Intent;
 import android.os.Build;
 import android.support.annotation.RequiresApi;
+import android.support.test.InstrumentationRegistry;
 import android.support.test.espresso.core.deps.guava.util.concurrent.ListeningExecutorService;
 import android.support.test.espresso.core.deps.guava.util.concurrent.MoreExecutors;
 import android.support.test.runner.AndroidJUnit4;
 
+import com.optimizely.ab.android.shared.Cache;
 import com.optimizely.ab.android.shared.ServiceScheduler;
 import com.optimizely.ab.android.user_experiment_record.AndroidUserExperimentRecord;
 
+import org.junit.After;
 import org.junit.Before;
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.mockito.ArgumentCaptor;
+import org.mockito.Mock;
 import org.slf4j.Logger;
 
 import java.util.concurrent.TimeUnit;
 
 import static junit.framework.Assert.assertEquals;
+import static junit.framework.Assert.assertFalse;
 import static junit.framework.Assert.assertNotNull;
 import static junit.framework.Assert.assertNull;
 import static junit.framework.Assert.assertTrue;
@@ -71,20 +76,21 @@ public class OptimizelyManagerTest {
     public void setup() {
         logger = mock(Logger.class);
         executor = MoreExecutors.newDirectExecutorService();
-        optimizelyManager = new OptimizelyManager("1", 1L, TimeUnit.HOURS, 1L, TimeUnit.HOURS, executor, logger);
+        optimizelyManager = new OptimizelyManager("7595190003", 1L, TimeUnit.HOURS, 1L, TimeUnit.HOURS, executor, logger);
     }
 
+
     @SuppressWarnings("WrongConstant")
     @Test
-    public void start() {
+    public void initialize() {
         OptimizelyStartListener startListener = mock(OptimizelyStartListener.class);
         Context context = mock(Context.class);
         Context appContext = mock(Context.class);
         when(context.getApplicationContext()).thenReturn(appContext);
         when(appContext.getPackageName()).thenReturn("com.optly");
         ArgumentCaptor<Intent> captor = ArgumentCaptor.forClass(Intent.class);
 
-        optimizelyManager.start(context, startListener);
+        optimizelyManager.initialize(context, startListener);
 
         assertNotNull(optimizelyManager.getOptimizelyStartListener());
         assertNotNull(optimizelyManager.getDataFileServiceConnection());

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

@@ -18,6 +18,7 @@
 
 import android.support.annotation.NonNull;
 import android.support.annotation.Nullable;
+import android.support.annotation.VisibleForTesting;
 
 import com.optimizely.ab.android.shared.Cache;
 
@@ -31,7 +32,7 @@
 /*
  * Abstracts the actual data "file" {@link java.io.File}
  */
-class DataFileCache {
+public class DataFileCache {
 
     private static final String OPTLY_DATA_FILE_NAME = "optly-data-file-%s.json";
 

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

@@ -88,6 +88,14 @@ public class OptimizelyClient {
         }
     }
 
+    /**
+     * Check that this is a valid instance
+     * @return True if the OptimizelyClient instance was instantiated correctly
+     */
+    public boolean isValid() {
+        return optimizely != null;
+    }
+
     /**
      * Track an event for a user
      * @param eventName the name of the event

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

@@ -46,6 +46,7 @@
 import com.optimizely.ab.event.internal.payload.Event;
 import com.optimizely.ab.android.user_experiment_record.AndroidUserExperimentRecord;
 
+import org.json.JSONObject;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -117,6 +118,91 @@ void setOptimizelyStartListener(@Nullable OptimizelyStartListener optimizelyStar
         this.optimizelyStartListener = optimizelyStartListener;
     }
 
+    /**
+     * Initialize Optimizely Synchronously
+     * <p>
+     * Instantiates and returns an {@link OptimizelyClient} instance. Will also cache the instance
+     * for future lookups via getClient
+     * @param context  any {@link Context} instance
+     * @param datafile the datafile
+     * @return an {@link OptimizelyClient} instance
+     */
+    public OptimizelyClient initialize(@NonNull Context context, @NonNull String datafile) {
+        if (!isAndroidVersionSupported()) {
+            return optimizelyClient;
+        }
+
+        AndroidUserExperimentRecord userExperimentRecord =
+                (AndroidUserExperimentRecord) AndroidUserExperimentRecord.newInstance(getProjectId(), context);
+        // The User Experiment Record is started on the main thread on an asynchronous start.
+        // Starting simply creates the file if it doesn't exist so it's not
+        // terribly expensive. Blocking the UI thread prevents touch input...
+        userExperimentRecord.start();
+        try {
+            optimizelyClient = buildOptimizely(context, datafile, userExperimentRecord);
+        } catch (ConfigParseException e) {
+            logger.error("Unable to parse compiled data file", e);
+        }
+
+
+        // After instantiating the OptimizelyClient, we will begin the datafile sync so that next time
+        // the user can instantiate with the latest datafile
+        final Intent intent = new Intent(context.getApplicationContext(), DataFileService.class);
+        if (dataFileServiceConnection == null) {
+            this.dataFileServiceConnection = new DataFileServiceConnection(this);
+            context.getApplicationContext().bindService(intent, dataFileServiceConnection, Context.BIND_AUTO_CREATE);
+        }
+
+        return optimizelyClient;
+    }
+
+    /**
+     * Initialize Optimizely Synchronously
+     * <p>
+     * Instantiates and returns an {@link OptimizelyClient} instance. Will also cache the instance
+     * for future lookups via getClient. The datafile should be stored in res/raw.
+     *
+     * @param context    any {@link Context} instance
+     * @param dataFileRes the R id that the data file is located under.
+     * @return an {@link OptimizelyClient} instance
+     */
+    @NonNull
+    public OptimizelyClient initialize(@NonNull Context context, @RawRes int dataFileRes) {
+        try {
+            String datafile = loadRawResource(context, dataFileRes);
+            return initialize(context, datafile);
+        } catch (IOException e) {
+            logger.error("Unable to load compiled data file", e);
+        }
+
+        // return dummy client if not able to initialize a valid one
+        return optimizelyClient;
+    }
+
+    /**
+     * Initialize Optimizely Synchronously
+     * <p>
+     * Instantiates and returns an {@link OptimizelyClient} instance using the datafile cached on disk
+     * if not available then it will return a dummy instance.
+     * @param context any {@link Context} instance
+     * @return an {@link OptimizelyClient} instance
+     */
+    public OptimizelyClient initialize(@NonNull Context context) {
+        DataFileCache dataFileCache = new DataFileCache(
+            projectId,
+            new Cache(context, LoggerFactory.getLogger(Cache.class)),
+            LoggerFactory.getLogger(DataFileCache.class)
+        );
+
+        JSONObject datafile = dataFileCache.load();
+        if (datafile != null) {
+            return initialize(context, datafile.toString());
+        }
+
+        // return dummy client if not able to initialize a valid one
+        return optimizelyClient;
+    }
+
     /**
      * Starts Optimizely asynchronously
      * <p>
@@ -130,30 +216,32 @@ void setOptimizelyStartListener(@Nullable OptimizelyStartListener optimizelyStar
      * @param optimizelyStartListener callback that {@link OptimizelyClient} instances are sent to.
      */
     @TargetApi(Build.VERSION_CODES.ICE_CREAM_SANDWICH)
-    public void start(@NonNull Activity activity, @NonNull OptimizelyStartListener optimizelyStartListener) {
+    public void initialize(@NonNull Activity activity, @NonNull OptimizelyStartListener optimizelyStartListener) {
         if (!isAndroidVersionSupported()) {
             return;
         }
         activity.getApplication().registerActivityLifecycleCallbacks(new OptlyActivityLifecycleCallbacks(this));
-        start(activity.getApplication(), optimizelyStartListener);
+        initialize(activity.getApplicationContext(), optimizelyStartListener);
     }
 
     /**
      * @param context                 any type of context instance
      * @param optimizelyStartListener callback that {@link OptimizelyClient} instances are sent to.
-     * @see #start(Activity, OptimizelyStartListener)
+     * @see #initialize(Activity, OptimizelyStartListener)
      * <p>
      * This method does the same thing except it can be used with a generic {@link Context}.
      * When using this method be sure to call {@link #stop(Context)} to unbind {@link DataFileService}.
      */
-    public void start(@NonNull Context context, @NonNull OptimizelyStartListener optimizelyStartListener) {
+    public void initialize(@NonNull Context context, @NonNull OptimizelyStartListener optimizelyStartListener) {
         if (!isAndroidVersionSupported()) {
             return;
         }
         this.optimizelyStartListener = optimizelyStartListener;
-        this.dataFileServiceConnection = new DataFileServiceConnection(this);
         final Intent intent = new Intent(context.getApplicationContext(), DataFileService.class);
-        context.getApplicationContext().bindService(intent, dataFileServiceConnection, Context.BIND_AUTO_CREATE);
+        if (dataFileServiceConnection == null) {
+            this.dataFileServiceConnection = new DataFileServiceConnection(this);
+            context.getApplicationContext().bindService(intent, dataFileServiceConnection, Context.BIND_AUTO_CREATE);
+        }
     }
 
     @TargetApi(Build.VERSION_CODES.ICE_CREAM_SANDWICH)
@@ -165,7 +253,7 @@ void stop(@NonNull Activity activity, @NonNull OptlyActivityLifecycleCallbacks o
     /**
      * Unbinds {@link DataFileService}
      * <p>
-     * Calling this is not necessary if using {@link #start(Activity, OptimizelyStartListener)} which
+     * Calling this is not necessary if using {@link #initialize(Activity, OptimizelyStartListener)} which
      * handles unbinding implicitly.
      *
      * @param context any {@link Context} instance
@@ -185,12 +273,11 @@ public void stop(@NonNull Context context) {
     /**
      * Gets a cached Optimizely instance
      * <p>
-     * If {@link #start(Activity, OptimizelyStartListener)} or {@link #start(Context, OptimizelyStartListener)}
+     * If {@link #initialize(Activity, OptimizelyStartListener)} or {@link #initialize(Context, OptimizelyStartListener)}
      * has not been called yet the returned {@link OptimizelyClient} instance will be a dummy instance
      * that logs warnings in order to prevent {@link NullPointerException}.
      * <p>
-     * If {@link #getOptimizely(Context, int)} was used the built {@link OptimizelyClient} instance
-     * will be updated.  Using {@link #start(Activity, OptimizelyStartListener)} or {@link #start(Context, OptimizelyStartListener)}
+     * Using {@link #initialize(Activity, OptimizelyStartListener)} or {@link #initialize(Context, OptimizelyStartListener)}
      * will update the cached instance with a new {@link OptimizelyClient} built from a cached local
      * datafile on disk or a remote datafile on the CDN.
      *
@@ -202,41 +289,6 @@ public OptimizelyClient getOptimizely() {
         return optimizelyClient;
     }
 
-    /**
-     * Create an instance of {@link OptimizelyClient} from a compiled in datafile
-     * <p>
-     * After using this method successfully {@link #getOptimizely()} will contain a
-     * cached instance built from the compiled in datafile.  The datafile should be
-     * stored in res/raw.
-     *
-     * @param context     any {@link Context} instance
-     * @param dataFileRes the R id that the data file is located under.
-     * @return an {@link OptimizelyClient} instance
-     */
-    @NonNull
-    public OptimizelyClient getOptimizely(@NonNull Context context, @RawRes int dataFileRes) {
-        if (!isAndroidVersionSupported()) {
-            return optimizelyClient;
-        }
-
-        AndroidUserExperimentRecord userExperimentRecord =
-                (AndroidUserExperimentRecord) AndroidUserExperimentRecord.newInstance(getProjectId(), context);
-        // Blocking File I/O is necessary here in order to provide a synchronous API
-        // The User Experiment Record is started off the of the main thread when starting
-        // asynchronously.  Starting simply creates the file if it doesn't exist so it's not
-        // terribly expensive. Blocking the UI the thread prevents touch input...
-        userExperimentRecord.start();
-        try {
-            optimizelyClient = buildOptimizely(context, loadRawResource(context, dataFileRes), userExperimentRecord);
-        } catch (ConfigParseException e) {
-            logger.error("Unable to parse compiled data file", e);
-        } catch (IOException e) {
-            logger.error("Unable to load compiled data file", e);
-        }
-
-        return optimizelyClient;
-    }
-
     private String loadRawResource(Context context, @RawRes int rawRes) throws IOException {
         Resources res = context.getResources();
         InputStream in = res.openRawResource(rawRes);
@@ -249,6 +301,21 @@ private String loadRawResource(Context context, @RawRes int rawRes) throws IOExc
         }
     }
 
+    /**
+     * Check if the datafile is cached on the disk
+     * @param context any {@link Context} instance
+     * @return True if the datafile is cached on the disk
+     */
+    public boolean isDatafileCached(Context context) {
+        DataFileCache dataFileCache = new DataFileCache(
+                projectId,
+                new Cache(context, LoggerFactory.getLogger(Cache.class)),
+                LoggerFactory.getLogger(DataFileCache.class)
+        );
+
+        return dataFileCache.exists();
+    }
+
     @NonNull
     String getProjectId() {
         return projectId;

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

@@ -26,6 +26,8 @@
 
 import java.util.HashMap;
 
+import static junit.framework.Assert.assertTrue;
+import static junit.framework.Assert.assertFalse;
 import static org.mockito.Mockito.verify;
 
 /**
@@ -163,4 +165,16 @@ public void testBadGetVariation3() {
         verify(logger).warn("Optimizely is not initialized, could not get variation for experiment {} " +
                 "for user {} with attributes", "1", "1");
     }
+
+    @Test
+    public void testIsValid() {
+        OptimizelyClient optimizelyClient = new OptimizelyClient(optimizely, logger);
+        assertTrue(optimizelyClient.isValid());
+    }
+
+    @Test
+    public void testIsInvalid() {
+        OptimizelyClient optimizelyClient = new OptimizelyClient(null, logger);
+        assertFalse(optimizelyClient.isValid());
+    }
 }

build.gradle

@@ -73,6 +73,13 @@ task ship() {
             'event-handler:uploadArchives', 'user-experiment-record:uploadArchives')
 }
 
+task cleanAllModules << {
+    logger.info("Running clena for all modules")
+}
+
+cleanAllModules.dependsOn(':android-sdk:clean', ':event-handler:clean',
+        ':user-experiment-record:clean', ':shared:clean')
+
 task testAllModules << {
     logger.info("Running android tests for all modules")
 }

test-app/src/main/java/com/optimizely/ab/android/test_app/MainActivity.java

@@ -47,7 +47,7 @@ protected void onCreate(Bundle savedInstanceState) {
         optimizelyManager = myApplication.getOptimizelyManager();
 
         // Load Optimizely from a compiled in data file
-        final OptimizelyClient optimizely = optimizelyManager.getOptimizely(this, R.raw.data_file);
+        final OptimizelyClient optimizely = optimizelyManager.initialize(this, R.raw.data_file);
         CountingIdlingResourceManager.increment(); // For impression event
         Variation variation = optimizely.activate("experiment_0", myApplication.getAnonUserId(), myApplication.getAttributes());
         if (variation != null) {
@@ -79,7 +79,7 @@ protected void onStart() {
         super.onStart();
 
         CountingIdlingResourceManager.increment(); // For Optimizely starting
-        optimizelyManager.start(this, new OptimizelyStartListener() {
+        optimizelyManager.initialize(this, new OptimizelyStartListener() {
             @Override
             public void onStart(OptimizelyClient optimizely) {
                 CountingIdlingResourceManager.decrement(); // For Optimizely starting