Merge pull request #163 from Iterable/chore/MOB-873-only-auto-registerForPush-in-foreground

[MOB-873] Only perform automatic push registration when the app goes into foreground

Author: vbabenkoru

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

@@ -115,6 +115,12 @@ public boolean isInForeground() {
     }
 
     public void addCallback(AppStateCallback callback) {
+        // Don't insert again if the same callback already exists
+        for (WeakReference<AppStateCallback> existingCallback : callbacks) {
+            if (existingCallback.get() == callback) {
+                return;
+            }
+        }
         callbacks.add(new WeakReference<>(callback));
     }
 

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

@@ -48,6 +48,7 @@ public class IterableApi {
     private Bundle _payloadData;
     private IterableNotificationData _notificationData;
     private String _deviceId;
+    private boolean _firstForegroundHandled;
 
     private IterableInAppManager inAppManager;
 
@@ -244,10 +245,7 @@ public static void initialize(Context context, String apiKey, IterableConfig con
         sharedInstance.retrieveEmailAndUserId();
         sharedInstance.checkForDeferredDeeplink();
         IterableActivityMonitor.getInstance().registerLifecycleCallbacks(context);
-
-        if (sharedInstance.config.autoPushRegistration && sharedInstance.isInitialized()) {
-            sharedInstance.registerForPush();
-        }
+        IterableActivityMonitor.getInstance().addCallback(sharedInstance.activityMonitorListener);
     }
 
     /**
@@ -1223,6 +1221,26 @@ protected void registerDeviceToken(String email, String userId, String applicati
 //region Private Fuctions
 //---------------------------------------------------------------------------------------
 
+    private final IterableActivityMonitor.AppStateCallback activityMonitorListener = new IterableActivityMonitor.AppStateCallback() {
+        @Override
+        public void onSwitchToForeground() {
+            onForeground();
+        }
+
+        @Override
+        public void onSwitchToBackground() {}
+    };
+
+    private void onForeground() {
+        if (!_firstForegroundHandled) {
+            _firstForegroundHandled = true;
+            if (sharedInstance.config.autoPushRegistration && sharedInstance.isInitialized()) {
+                IterableLogger.d(TAG, "Performing automatic push registration");
+                sharedInstance.registerForPush();
+            }
+        }
+    }
+
     /**
      * Updates the data for the current user.
      * @param context

iterableapi/src/test/java/com/iterable/iterableapi/IterableApiTest.java

@@ -1,5 +1,6 @@
 package com.iterable.iterableapi;
 
+import android.app.Activity;
 import android.net.Uri;
 
 import org.json.JSONObject;
@@ -10,6 +11,7 @@
 import org.mockito.Mockito;
 import org.robolectric.Robolectric;
 import org.robolectric.RuntimeEnvironment;
+import org.robolectric.android.controller.ActivityController;
 import org.robolectric.shadows.ShadowApplication;
 
 import java.io.IOException;
@@ -246,14 +248,30 @@ public void testSetUserIdWithoutAutomaticPushRegistration() throws Exception {
     }
 
     @Test
-    public void testAutomaticPushRegistrationOnInit() throws Exception {
+    public void testNoAutomaticPushRegistrationOnInit() throws Exception {
         IterableApi.initialize(RuntimeEnvironment.application, "fake_key", new IterableConfig.Builder().setPushIntegrationName("pushIntegration").setAutoPushRegistration(true).build());
         IterableApi.getInstance().setEmail("[email protected]");
 
         reInitIterableApi();
         IterableApi.initialize(RuntimeEnvironment.application, "fake_key", new IterableConfig.Builder().setPushIntegrationName("pushIntegration").setAutoPushRegistration(true).build());
+        verify(IterableApi.sharedInstance, never()).registerForPush();
+        Mockito.reset(IterableApi.sharedInstance);
+    }
+
+    @Test
+    public void testAutomaticPushRegistrationOnInitAndForeground() throws Exception {
+        IterableApi.initialize(RuntimeEnvironment.application, "fake_key", new IterableConfig.Builder().setPushIntegrationName("pushIntegration").setAutoPushRegistration(true).build());
+        IterableApi.getInstance().setEmail("[email protected]");
+
+        reInitIterableApi();
+        IterableActivityMonitor.getInstance().unregisterLifecycleCallbacks(RuntimeEnvironment.application);
+        IterableActivityMonitor.instance = new IterableActivityMonitor();
+        IterableApi.initialize(RuntimeEnvironment.application, "fake_key", new IterableConfig.Builder().setPushIntegrationName("pushIntegration").setAutoPushRegistration(true).build());
+        ActivityController<Activity> activityController = Robolectric.buildActivity(Activity.class).create().start().resume();
         verify(IterableApi.sharedInstance).registerForPush();
         Mockito.reset(IterableApi.sharedInstance);
+        activityController.pause().stop().destroy();
+        IterableActivityMonitor.getInstance().unregisterLifecycleCallbacks(RuntimeEnvironment.application);
     }
 
     @Test