fix for datafile download start when datafile has not changed or when… (#199)

* fix for datafile download start when datafile has not changed or when starting synchronously

* to avoid multiple starts, stop any service that is running before starting.

* added some unit tests to make sure that backgrounding is started when interval is set

Author: thomaszurkan-optimizely

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

@@ -29,6 +29,7 @@
 import android.support.test.runner.AndroidJUnit4;
 
 import com.optimizely.ab.android.datafile_handler.DatafileHandler;
+import com.optimizely.ab.android.datafile_handler.DatafileLoadedListener;
 import com.optimizely.ab.android.datafile_handler.DatafileService;
 import com.optimizely.ab.android.datafile_handler.DefaultDatafileHandler;
 import com.optimizely.ab.android.event_handler.DefaultEventHandler;
@@ -44,6 +45,8 @@
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.mockito.ArgumentCaptor;
+import org.mockito.invocation.InvocationOnMock;
+import org.mockito.stubbing.Answer;
 import org.slf4j.Logger;
 
 import java.util.concurrent.TimeUnit;
@@ -56,6 +59,7 @@
 import static junit.framework.Assert.fail;
 import static org.mockito.Matchers.any;
 import static org.mockito.Matchers.eq;
+import static org.mockito.Mockito.doAnswer;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
@@ -112,6 +116,7 @@ public void initializeInt() {
 
         assertEquals(optimizelyManager.getDatafileUrl("1"), "https://cdn.optimizely.com/json/1.json" );
 
+        verify(optimizelyManager.getDatafileHandler()).startBackgroundUpdates(eq(InstrumentationRegistry.getTargetContext()), eq(testProjectId), eq(3600L));
         assertNotNull(optimizelyManager.getOptimizely());
         assertNotNull(optimizelyManager.getDatafileHandler());
 
@@ -174,14 +179,28 @@ public void initializeAsync() {
          * Scenario#1: when datafile is not Empty
          * Scenario#2: when datafile is Empty
         */
-        optimizelyManager.initialize(InstrumentationRegistry.getContext(), R.raw.datafile, new OptimizelyStartListener() {
+
+        doAnswer(
+                new Answer<Object>() {
+                    public Object answer(InvocationOnMock invocation) {
+                        ((DatafileLoadedListener) invocation.getArguments()[2]).onDatafileLoaded(null);
+                        return null;
+                    }
+                }).when(optimizelyManager.getDatafileHandler()).downloadDatafile(any(Context.class), any(String.class),
+                any(DatafileLoadedListener.class));
+
+        OptimizelyStartListener listener = new OptimizelyStartListener() {
             @Override
             public void onStart(OptimizelyClient optimizely) {
                 assertNotNull(optimizelyManager.getOptimizely());
                 assertNotNull(optimizelyManager.getDatafileHandler());
                 assertNull(optimizelyManager.getOptimizelyStartListener());
             }
-        });
+        };
+        optimizelyManager.initialize(InstrumentationRegistry.getContext(), R.raw.datafile, listener);
+
+        verify(optimizelyManager.getDatafileHandler()).startBackgroundUpdates(any(Context.class), eq(testProjectId), eq(3600L));
+
 
         assertEquals(optimizelyManager.isDatafileCached(InstrumentationRegistry.getTargetContext()), false);
 
@@ -271,6 +290,28 @@ public void injectOptimizely() {
 
         verify(logger).info("Sending Optimizely instance to listener");
         verify(startListener).onStart(any(OptimizelyClient.class));
+        verify(optimizelyManager.getDatafileHandler()).startBackgroundUpdates(eq(context), eq(testProjectId), eq(3600L));
+
+    }
+
+    @RequiresApi(api = Build.VERSION_CODES.HONEYCOMB)
+    @Test
+    public void injectOptimizelyWithDatafileLisener() {
+        Context context = mock(Context.class);
+        UserProfileService userProfileService = mock(UserProfileService.class);
+        OptimizelyStartListener startListener = mock(OptimizelyStartListener.class);
+
+        optimizelyManager.setOptimizelyStartListener(startListener);
+        optimizelyManager.injectOptimizely(context, userProfileService, minDatafile);
+        try {
+            executor.awaitTermination(5, TimeUnit.SECONDS);
+        } catch (InterruptedException e) {
+            fail("Timed out");
+        }
+
+        verify(optimizelyManager.getDatafileHandler()).startBackgroundUpdates(eq(context), eq(testProjectId), eq(3600L));
+        verify(logger).info("Sending Optimizely instance to listener");
+        verify(startListener).onStart(any(OptimizelyClient.class));
     }
 
     @Test

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

@@ -69,6 +69,7 @@ public class OptimizelyManager {
     @Nullable private ErrorHandler errorHandler;
     @NonNull private Logger logger;
     @NonNull private final String projectId;
+
     @NonNull private UserProfileService userProfileService;
 
     @Nullable private OptimizelyStartListener optimizelyStartListener;
@@ -165,6 +166,11 @@ protected OptimizelyClient initialize(@NonNull Context context,@Nullable String
                     defaultUserProfileService.start();
                 }
                 optimizelyClient = buildOptimizely(context, datafile);
+
+                if (datafileDownloadInterval > 0 && datafileHandler != null) {
+                    datafileHandler.startBackgroundUpdates(context, projectId, datafileDownloadInterval);
+                }
+
             }
             else {
                 logger.error("Invalid datafile");
@@ -303,8 +309,7 @@ public void onDatafileLoaded(@Nullable String datafile) {
                 } else {
                     //if datafile is null than it should be able to take from cache and if not present
                     //in Cache than should be able to get from raw data file
-                    optimizelyClient = initialize(context,getDatafile(context,datafileRes),false);
-                    notifyStartListener();
+                    injectOptimizely(context, userProfileService, getDatafile(context,datafileRes));
                 }
             }
 
@@ -384,7 +389,6 @@ public boolean isDatafileCached(Context context) {
     public @NonNull String getDatafileUrl(String projectId) {
         return DatafileService.getDatafileUrl(projectId);
     }
-
     @NonNull
     public String getProjectId() {
         return projectId;
@@ -584,6 +588,7 @@ public static class Builder {
         @Nullable private EventHandler eventHandler = null;
         @Nullable private ErrorHandler errorHandler = null;
         @Nullable private UserProfileService userProfileService = null;
+
         Builder(@NonNull String projectId) {
             this.projectId = projectId;
         }

datafile-handler/src/main/java/com/optimizely/ab/android/datafile_handler/DefaultDatafileHandler.java

@@ -103,6 +103,10 @@ public void onStop(Context context) {
      * @param updateInterval frequency of updates in seconds
      */
     public void startBackgroundUpdates(Context context, String projectId, Long updateInterval) {
+
+        // if already running, stop it
+        stopBackgroundUpdates(context, projectId);
+
         enableBackgroundCache(context, projectId);
 
         ServiceScheduler.PendingIntentFactory pendingIntentFactory = new ServiceScheduler