update to load the user profile service asynch and synch. remove inva… (#196)

* update to load the user profile service asynch and synch. remove invalid experiments if started asynch (latest datafile) or used cached datafile.

* use a worker thread to clean up the user profile service

* add try catch, cleanup unused imports in OptimizelyClient

Author: thomaszurkan-optimizely

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

@@ -25,13 +25,10 @@
 import com.optimizely.ab.config.Experiment;
 import com.optimizely.ab.config.ProjectConfig;
 import com.optimizely.ab.config.Variation;
-import com.optimizely.ab.internal.ReservedEventKey;
 import com.optimizely.ab.notification.NotificationCenter;
-import com.optimizely.ab.notification.NotificationListener;
 
 import org.slf4j.Logger;
 
-import java.util.Collections;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;

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

@@ -39,6 +39,7 @@
 import com.optimizely.ab.android.event_handler.EventIntentService;
 import com.optimizely.ab.android.user_profile.DefaultUserProfileService;
 import com.optimizely.ab.bucketing.UserProfileService;
+import com.optimizely.ab.config.ProjectConfig;
 import com.optimizely.ab.config.parser.ConfigParseException;
 import com.optimizely.ab.error.ErrorHandler;
 import com.optimizely.ab.event.EventHandler;
@@ -50,6 +51,8 @@
 
 import java.io.IOException;
 import java.io.InputStream;
+import java.util.Map;
+import java.util.Set;
 
 /**
  * Handles loading the Optimizely data file
@@ -156,10 +159,16 @@ protected OptimizelyClient initialize(@NonNull Context context,@Nullable String
             return optimizelyClient;
         }
         try {
-            if(datafile!=null)
+            if(datafile!=null) {
+                if (getUserProfileService() instanceof DefaultUserProfileService) {
+                    DefaultUserProfileService defaultUserProfileService = (DefaultUserProfileService) getUserProfileService();
+                    defaultUserProfileService.start();
+                }
                 optimizelyClient = buildOptimizely(context, datafile);
-            else
+            }
+            else {
                 logger.error("Invalid datafile");
+            }
         } catch (ConfigParseException e) {
             logger.error("Unable to parse compiled data file", e);
         } catch (Exception e) {
@@ -192,8 +201,13 @@ public OptimizelyClient initialize(@NonNull Context context, @RawRes Integer dat
         try {
 
             String datafile;
+            Boolean datafileInCache = isDatafileCached(context);
             datafile = getDatafile(context, datafileRes);
+
             optimizelyClient = initialize(context, datafile, true);
+            if (datafileInCache) {
+                cleanupUserProfileCache(getUserProfileService());
+            }
         }catch (NullPointerException e){
             logger.error("Unable to find compiled data file in raw resource",e);
         }
@@ -202,6 +216,36 @@ public OptimizelyClient initialize(@NonNull Context context, @RawRes Integer dat
         return optimizelyClient;
     }
 
+    private void cleanupUserProfileCache(UserProfileService userProfileService) {
+        final DefaultUserProfileService defaultUserProfileService;
+        if (userProfileService instanceof DefaultUserProfileService) {
+            defaultUserProfileService = (DefaultUserProfileService)userProfileService;
+        }
+        else {
+            return;
+        }
+
+        final ProjectConfig config = optimizelyClient.getProjectConfig();
+        if (config == null) {
+            return;
+        }
+
+        new Thread(new Runnable() {
+            @Override
+            public void run() {
+                try {
+                    Set<String> experimentIds = config.getExperimentIdMapping().keySet();
+
+                    defaultUserProfileService.removeInvalidExperiments(experimentIds);
+                }
+                catch (Exception e) {
+                    logger.error("Error removing invalid experiments from default user profile service.", e);
+                }
+            }
+        }).start();
+
+    }
+
     /** This function will first try to get datafile from Cache, if file is not cached yet
      * than it will read from Raw file
      * @param context
@@ -366,6 +410,7 @@ void injectOptimizely(@NonNull final Context context, final @NonNull UserProfile
                 ((DefaultUserProfileService) userProfileService).startInBackground(new DefaultUserProfileService.StartCallback() {
                     @Override
                     public void onStartComplete(UserProfileService userProfileService) {
+                        cleanupUserProfileCache(userProfileService);
                         if (optimizelyStartListener != null) {
                             logger.info("Sending Optimizely instance to listener");
                             notifyStartListener();

user-profile/src/main/java/com/optimizely/ab/android/user_profile/DefaultUserProfileService.java

@@ -30,6 +30,7 @@
 import org.slf4j.LoggerFactory;
 
 import java.util.Map;
+import java.util.Set;
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.Executors;
 
@@ -140,6 +141,14 @@ public void remove(String userId) {
         userProfileCache.remove(userId);
     }
 
+    public void removeInvalidExperiments(Set<String> validExperiments) {
+        try {
+            userProfileCache.removeInvalidExperiments(validExperiments);
+        }
+        catch (Exception e) {
+            logger.error("Error calling userProfileCache to remove invalid experiments", e);
+        }
+    }
     /**
      * Remove a decision from a user profile.
      *

user-profile/src/main/java/com/optimizely/ab/android/user_profile/UserProfileCache.java

@@ -31,6 +31,7 @@
 
 import java.util.Iterator;
 import java.util.Map;
+import java.util.Set;
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.Executor;
 
@@ -175,6 +176,23 @@ void remove(String userId, String experimentId) {
         }
     }
 
+    /**
+     * Remove experiments that are no longer valid
+     * @param validExperimentIds list of valid experiment ids.
+     */
+    public void removeInvalidExperiments(Set<String> validExperimentIds) {
+        for (String userId : memoryCache.keySet()) {
+            Map<String, Object> maps = memoryCache.get(userId);
+            Map<String, Map<String, String>> experimentBucketMap =
+                    (ConcurrentHashMap<String, Map<String, String>>) maps.get(experimentBucketMapKey);
+            for (String experimentId : experimentBucketMap.keySet()){
+                if (!validExperimentIds.contains(experimentId)) {
+                    experimentBucketMap.remove(experimentId);
+                }
+            }
+        }
+        diskCache.save(memoryCache);
+    }
     /**
      * Add a decision to a user profile.
      *