Merge pull request #863 from Iterable/evan/MOB-10615-improve-criteria-update-frequency

[MOB-10615] improve criteria update frequency

Author: evantk91

iterableapi/src/main/java/com/iterable/iterableapi/AnonymousUserManager.java

@@ -7,6 +7,7 @@
 
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
+import androidx.annotation.VisibleForTesting;
 import androidx.core.app.NotificationManagerCompat;
 
 import com.google.gson.Gson;
@@ -25,10 +26,25 @@
 import java.util.List;
 import java.util.UUID;
 
-public class AnonymousUserManager {
+public class AnonymousUserManager implements IterableActivityMonitor.AppStateCallback {
 
     private static final String TAG = "AnonymousUserManager";
-    private final IterableApi iterableApi = IterableApi.sharedInstance;
+    private IterableApi iterableApi = IterableApi.sharedInstance;
+    private final IterableActivityMonitor activityMonitor;
+    long lastCriteriaFetch = 0;
+
+    AnonymousUserManager(IterableApi iterableApi) {
+        this(iterableApi,
+            IterableActivityMonitor.getInstance());
+    }
+
+    @VisibleForTesting
+    AnonymousUserManager(IterableApi iterableApi,
+                         IterableActivityMonitor activityMonitor) {
+        this.iterableApi = iterableApi;
+        this.activityMonitor = activityMonitor;
+        this.activityMonitor.addCallback(this);
+    }
 
     void updateAnonSession() {
         IterableLogger.v(TAG, "updateAnonSession");
@@ -157,6 +173,8 @@ void trackAnonUpdateCart(@NonNull List<CommerceItem> items) {
     }
 
     void getCriteria() {
+        lastCriteriaFetch = System.currentTimeMillis();
+
         iterableApi.apiClient.getCriteriaList(data -> {
             if (data != null) {
                 try {
@@ -465,4 +483,27 @@ private String getPushStatus() {
             return "";
         }
     }
+
+    @Override
+    public void onSwitchToForeground() {
+        long currentTime = System.currentTimeMillis();
+
+        // fetching anonymous user criteria on foregrounding
+        if (!iterableApi.checkSDKInitialization()
+            && iterableApi._userIdAnon == null
+            && iterableApi.config.enableAnonActivation
+            && iterableApi.getVisitorUsageTracked()
+            && iterableApi.config.enableForegroundCriteriaFetch
+            && currentTime - lastCriteriaFetch >= IterableConstants.CRITERIA_FETCHING_COOLDOWN) {
+
+            lastCriteriaFetch = currentTime;
+            this.getCriteria();
+            IterableLogger.d(TAG, "Fetching anonymous user criteria - Foreground");
+        }
+    }
+
+    @Override
+    public void onSwitchToBackground() {
+
+    }
 }

iterableapi/src/main/java/com/iterable/iterableapi/IterableApi.java

@@ -36,7 +36,7 @@ public class IterableApi {
     private String _apiKey;
     private String _email;
     private String _userId;
-    private String _userIdAnon;
+    String _userIdAnon;
     private String _authToken;
     private boolean _debugMode;
     private Bundle _payloadData;
@@ -47,8 +47,8 @@ public class IterableApi {
     private IterableHelper.FailureHandler _setUserFailureCallbackHandler;
 
     IterableApiClient apiClient = new IterableApiClient(new IterableApiAuthProvider());
-    private static final AnonymousUserManager anonymousUserManager = new AnonymousUserManager();
     private static final AnonymousUserMerge anonymousUserMerge = new AnonymousUserMerge();
+    private @Nullable AnonymousUserManager anonymousUserManager;
     private @Nullable IterableInAppManager inAppManager;
     private @Nullable IterableEmbeddedManager embeddedManager;
     private String inboxSessionId;
@@ -441,7 +441,7 @@ private boolean isInitialized() {
         return _apiKey != null && (_email != null || _userId != null);
     }
 
-    private boolean checkSDKInitialization() {
+    boolean checkSDKInitialization() {
         if (!isInitialized()) {
             IterableLogger.w(TAG, "Iterable SDK must be initialized with an API key and user email/userId before calling SDK methods");
             return false;
@@ -666,12 +666,21 @@ public static void initialize(@NonNull Context context, @NonNull String apiKey,
             );
         }
 
+        if (sharedInstance.anonymousUserManager == null) {
+            sharedInstance.anonymousUserManager = new AnonymousUserManager(
+                sharedInstance
+            );
+        }
+
         loadLastSavedConfiguration(context);
         IterablePushNotificationUtil.processPendingAction(context);
 
-        if (!sharedInstance.checkSDKInitialization() && sharedInstance._userIdAnon == null && sharedInstance.config.enableAnonActivation && sharedInstance.getVisitorUsageTracked()) {
-            anonymousUserManager.updateAnonSession();
-            anonymousUserManager.getCriteria();
+        if (!sharedInstance.checkSDKInitialization()
+            && sharedInstance._userIdAnon == null
+            && sharedInstance.config.enableAnonActivation
+            && sharedInstance.getVisitorUsageTracked()) {
+            sharedInstance.anonymousUserManager.updateAnonSession();
+            sharedInstance.anonymousUserManager.getCriteria();
         }
 
         if (DeviceInfoUtils.isFireTV(context.getPackageManager())) {

iterableapi/src/main/java/com/iterable/iterableapi/IterableConfig.java

@@ -60,7 +60,9 @@ public class IterableConfig {
      */
     final IterableAuthHandler authHandler;
 
-
+    /**
+     * Handler that can be used to retrieve the anonymous user id
+     */
     final IterableAnonUserHandler iterableAnonUserHandler;
 
     /**
@@ -92,8 +94,20 @@ public class IterableConfig {
 
     final boolean encryptionEnforced;
 
+    /**
+     * Enables anonymous user activation
+     */
     final boolean enableAnonActivation;
 
+    /**
+     * Toggles fetching of anonymous user criteria on foregrounding when set to true
+     * By default, the SDK will fetch anonymous user criteria on foregrounding.
+     */
+    final boolean enableForegroundCriteriaFetch;
+
+    /**
+     * The number of anonymous events stored in local storage
+     */
     final int eventThresholdLimit;
 
     /**
@@ -130,6 +144,7 @@ private IterableConfig(Builder builder) {
         useInMemoryStorageForInApps = builder.useInMemoryStorageForInApps;
         encryptionEnforced = builder.encryptionEnforced;
         enableAnonActivation = builder.enableAnonActivation;
+        enableForegroundCriteriaFetch = builder.enableForegroundCriteriaFetch;
         enableEmbeddedMessaging = builder.enableEmbeddedMessaging;
         eventThresholdLimit = builder.eventThresholdLimit;
         identityResolution = builder.identityResolution;
@@ -155,6 +170,7 @@ public static class Builder {
         private IterableDecryptionFailureHandler decryptionFailureHandler;
         private boolean encryptionEnforced = false;
         private boolean enableAnonActivation = false;
+        private boolean enableForegroundCriteriaFetch = true;
         private boolean enableEmbeddedMessaging = false;
         private int eventThresholdLimit = 100;
         private IterableIdentityResolution identityResolution = new IterableIdentityResolution();
@@ -310,7 +326,6 @@ public Builder setDataRegion(@NonNull IterableDataRegion dataRegion) {
          * Set whether the SDK should store in-apps only in memory, or in file storage
          * @param useInMemoryStorageForInApps `true` will have in-apps be only in memory
          */
-
         @NonNull
         public Builder setUseInMemoryStorageForInApps(boolean useInMemoryStorageForInApps) {
             this.useInMemoryStorageForInApps = useInMemoryStorageForInApps;
@@ -327,6 +342,16 @@ public Builder setEnableAnonActivation(boolean enableAnonActivation) {
             return this;
         }
 
+        /**
+         * Set whether the SDK should disable criteria fetching on foregrounding. Set this to `false`
+         * if you want criteria to only be fetched on app launch.
+         * @param enableForegroundCriteriaFetch `true` will fetch criteria only on app launch.
+         */
+        public Builder setEnableForegroundCriteriaFetch(boolean enableForegroundCriteriaFetch) {
+            this.enableForegroundCriteriaFetch = enableForegroundCriteriaFetch;
+            return this;
+        }
+
         public Builder setEventThresholdLimit(int eventThresholdLimit) {
             this.eventThresholdLimit = eventThresholdLimit;
             return this;
@@ -348,7 +373,6 @@ public Builder setEnableEmbeddedMessaging(boolean enableEmbeddedMessaging) {
          * @param identityResolution
          * @return
          */
-
         public Builder setIdentityResolution(IterableIdentityResolution identityResolution) {
             this.identityResolution = identityResolution;
             return this;

iterableapi/src/main/java/com/iterable/iterableapi/IterableConstants.java

@@ -336,7 +336,7 @@ public final class IterableConstants {
     public static final String PURCHASE_ITEM = "shoppingCartItems";
     public static final String PURCHASE_ITEM_PREFIX = PURCHASE_ITEM + ".";
     public static final String MIN_MATCH = "minMatch";
-
+    public static final Integer CRITERIA_FETCHING_COOLDOWN = 120000;
 
     //Tracking types
     public static final String TRACK_EVENT = "customEvent";