update for android o after device tests. updated the change log and … (#160)

* update for android o after device tests.  updated the change log
* fix raw datafile name
* cleanup javadoc and testapp examples
* move the register of the event rescheduler

Author: thomaszurkan-optimizely

CHANGELOG.md

@@ -1,6 +1,6 @@
 # Optimizely Android X SDK Changelog
 ### 1.5.0
-September 26, 2017
+October 30, 2017
 
 - Release 1.5.0
 
@@ -24,6 +24,8 @@ September 26, 2017
 
 - Same as 1.4.0 see below.
 - Need to add permissions to both receivers in your manifest if you plan on using the EventRescheduler or the DatafileRescheduler (see test_app manifest for example) https://github.com/optimizely/android-sdk/blob/master/test-app/src/main/AndroidManifest.xml
+- Updated build tools and target to API 26
+- Also for Android O, you must register for the SUPPLICANT_CONNECTION_CHANGE_ACTION intent filter in code (see the test-app for an example).
 
 ### 1.4.0
 August 9, 2017

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

@@ -120,13 +120,15 @@ private void notifyStartListener() {
     }
 
     /**
-     * Initialize Optimizely Synchronously
+     * Initialize Optimizely Synchronously using the datafile passed in while downloading the latest datafile in the background from the CDN to cache.
+     * It should be noted that even though it initiates a download of the datafile to cache, this method does not use that cached datafile.
+     * You can always test if a datafile exists in cache with {@link #isDatafileCached(Context)}.
      * <p>
-     * Instantiates and returns an {@link OptimizelyClient} instance. Will also cache the instance
+     * Instantiates and returns an {@link OptimizelyClient} instance. It will also cache the instance
      * for future lookups via getClient
      *
      * @param context  any {@link Context} instance
-     * @param datafile the datafile
+     * @param datafile the datafile used to initialize the OptimizelyClient.
      * @return an {@link OptimizelyClient} instance
      */
     public OptimizelyClient initialize(@NonNull Context context, @NonNull String datafile) {
@@ -150,7 +152,10 @@ public OptimizelyClient initialize(@NonNull Context context, @NonNull String dat
     }
 
     /**
-     * Initialize Optimizely Synchronously
+     * Initialize Optimizely Synchronously by loading the resource, use it to initialize Optimizely,
+     * and downloading the latest datafile from the CDN in the background to cache.
+     * It should be noted that even though it initiates a download of the datafile to cache, this method does not use that cached datafile.
+     * You can always test if a datafile exists in cache with {@link #isDatafileCached(Context)}.
      * <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.
@@ -173,7 +178,8 @@ public OptimizelyClient initialize(@NonNull Context context, @RawRes int datafil
     }
 
     /**
-     * Initialize Optimizely Synchronously
+     * Initialize Optimizely Synchronously. This one uses the cached datafile and expects it to exist.
+     * You can use {@link #isDatafileCached(Context)} to see if the datafile exists in cache prior to this call.
      * <p>
      * Instantiates and returns an {@link OptimizelyClient} instance using the datafile cached on disk
      * if not available then it will return a dummy instance.

test-app/src/main/AndroidManifest.xml

@@ -23,6 +23,7 @@
     <uses-permission android:name="android.permission.DISABLE_KEYGUARD" />
     <uses-permission android:name="android.permission.WAKE_LOCK" />
     <uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED"/>
+    <uses-permission android:name="android.permission.ACCESS_WIFI_STATE"/>
 
     <application
         android:name=".MyApplication"

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

@@ -16,10 +16,13 @@
 package com.optimizely.ab.android.test_app;
 
 import android.content.Intent;
+import android.content.IntentFilter;
+import android.net.wifi.WifiManager;
 import android.support.annotation.Nullable;
 import android.support.v7.app.AppCompatActivity;
 import android.os.Bundle;
 
+import com.optimizely.ab.android.event_handler.EventRescheduler;
 import com.optimizely.ab.android.sdk.OptimizelyClient;
 import com.optimizely.ab.android.sdk.OptimizelyManager;
 import com.optimizely.ab.android.sdk.OptimizelyStartListener;
@@ -49,57 +52,57 @@ protected void onCreate(Bundle savedInstanceState) {
     protected void onStart() {
         super.onStart();
 
-//        if (optimizelyManager.isDatafileCached(this) == true) {
-//            optimizelyManager.initialize(this);
-//            String userId = myApplication.getAnonUserId();
-//            Variation backgroundVariation = optimizelyManager.getOptimizely().activate("background_experiment", userId);
-//            Intent intent = null;
-//            // variation is nullable so we should check for null values
-//            if (backgroundVariation != null) {
-//                // Show activity based on the variation the user got bucketed into
-//                if (backgroundVariation.getKey().equals("variation_a")) {
-//                    intent = new Intent(myApplication.getBaseContext(), VariationAActivity.class);
-//                } else if (backgroundVariation.getKey().equals("variation_b")) {
-//                    intent = new Intent(myApplication.getBaseContext(), VariationBActivity.class);
-//                }
-//            }
-//
-//            startActivity(intent);
-//
-//            return;
-//        }
-
-        // Initialize Optimizely asynchronously
-        optimizelyManager.initialize(this, new OptimizelyStartListener() {
-
-            @Override
-            public void onStart(OptimizelyClient optimizely) {
-                // this is the control variation, it will show if we are not able to determine which variation to bucket the user into
-                Intent intent = new Intent(myApplication.getBaseContext(), ActivationErrorActivity.class);
-
-                // Activate user and start activity based on the variation we get.
-                // You can pass in any string for the user ID. In this example we just use a convenience method to generate a random one.
-                String userId = myApplication.getAnonUserId();
-                Variation backgroundVariation = optimizelyManager.getOptimizely().activate("background_experiment", userId);
-
-                // Utility method for verifying event dispatches in our automated tests
-                CountingIdlingResourceManager.increment(); // increment for impression event
-
-                // variation is nullable so we should check for null values
-                if (backgroundVariation != null) {
-                    // Show activity based on the variation the user got bucketed into
-                    if (backgroundVariation.getKey().equals("variation_a")) {
-                        intent = new Intent(myApplication.getBaseContext(), VariationAActivity.class);
-                    } else if (backgroundVariation.getKey().equals("variation_b")) {
-                        intent = new Intent(myApplication.getBaseContext(), VariationBActivity.class);
+        boolean INITIALIZE_ASYNCHRONOUSLY = true;
+
+        // with the new Android O differences, you need to register the service for the intent filter you desire in code instead of
+        // in the manifest.
+        EventRescheduler eventRescheduler = new EventRescheduler();
+
+        getApplicationContext().registerReceiver(eventRescheduler, new IntentFilter(WifiManager.SUPPLICANT_CONNECTION_CHANGE_ACTION));
+
+        // Example of initialize from raw file and use cached file after that.
+        if (!INITIALIZE_ASYNCHRONOUSLY) {
+
+            if (optimizelyManager.isDatafileCached(myApplication)) {
+                optimizelyManager.initialize(myApplication);
+            } else {
+                optimizelyManager.initialize(myApplication, R.raw.datafile);
+            }
+        } else {
+            // Initialize Optimizely asynchronously
+            optimizelyManager.initialize(this, new OptimizelyStartListener() {
+
+                @Override
+                public void onStart(OptimizelyClient optimizely) {
+                    // this is the control variation, it will show if we are not able to determine which variation to bucket the user into
+                    Intent intent = new Intent(myApplication.getBaseContext(), ActivationErrorActivity.class);
+
+                    // Activate user and start activity based on the variation we get.
+                    // You can pass in any string for the user ID. In this example we just use a convenience method to generate a random one.
+                    String userId = myApplication.getAnonUserId();
+                    Variation backgroundVariation = optimizelyManager.getOptimizely().activate("background_experiment", userId);
+
+                    // Utility method for verifying event dispatches in our automated tests
+                    CountingIdlingResourceManager.increment(); // increment for impression event
+
+                    // variation is nullable so we should check for null values
+                    if (backgroundVariation != null) {
+                        // Show activity based on the variation the user got bucketed into
+                        if (backgroundVariation.getKey().equals("variation_a")) {
+                            intent = new Intent(myApplication.getBaseContext(), VariationAActivity.class);
+                        } else if (backgroundVariation.getKey().equals("variation_b")) {
+                            intent = new Intent(myApplication.getBaseContext(), VariationBActivity.class);
+                        }
                     }
+
+                    startActivity(intent);
+
+                    //call this method if you set an interval but want to now stop doing bakcground updates.
+                    //optimizelyManager.getDatafileHandler().stopBackgroundUpdates(myApplication.getApplicationContext(), optimizelyManager.getProjectId());
                 }
+            });
+        }
 
-                startActivity(intent);
 
-                //call this method if you set an interval but want to now stop doing bakcground updates.
-                //optimizelyManager.getDatafileHandler().stopBackgroundUpdates(myApplication.getApplicationContext(), optimizelyManager.getProjectId());
-            }
-        });
     }
 }