Merge pull request #53 from Iterable/bugfix/ITBL-5899-inapp-display-fix

[ITBL-5899] Only show one in-app message at a time

Author: vbabenkoru

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

@@ -897,13 +897,13 @@ public void execute(String payload) {
                             Rect padding = IterableInAppManager.getPaddingFromPayload(paddingOptions);
 
                             double backgroundAlpha = message.optDouble("backgroundAlpha", 0);
-                            IterableInAppManager.showIterableNotificationHTML(context, html, messageId, clickCallback, backgroundAlpha, padding);
+                            if (IterableInAppManager.showIterableNotificationHTML(context, html, messageId, clickCallback, backgroundAlpha, padding)) {
+                                IterableApi.sharedInstance.inAppConsume(messageId);
+                            }
                         } else {
                             IterableLogger.w(TAG, "No href tag in found in the in-app html payload: "+ html);
+                            IterableApi.sharedInstance.inAppConsume(messageId);
                         }
-
-                        IterableApi.sharedInstance.inAppConsume(messageId);
-
                     }
                 }
             }

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

@@ -52,6 +52,14 @@ public static IterableInAppHTMLNotification createInstance(Context context, Stri
         return notification;
     }
 
+    /**
+     * Returns the notification instance currently being shown
+     * @return notification instance
+     */
+    public static IterableInAppHTMLNotification getInstance() {
+        return notification;
+    }
+
     /**
      * HTML In-App Notification
      * @param context
@@ -161,6 +169,7 @@ public void run() {
     @Override
     protected void onStop() {
         orientationListener.disable();
+        notification = null;
     }
 
     /**

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

@@ -39,21 +39,28 @@ public class IterableInAppManager {
      * @param backgroundAlpha
      * @param padding
      */
-    public static void showIterableNotificationHTML(Context context, String htmlString, String messageId, IterableHelper.IterableActionHandler clickCallback, double backgroundAlpha, Rect padding) {
+    public static boolean showIterableNotificationHTML(Context context, String htmlString, String messageId, IterableHelper.IterableActionHandler clickCallback, double backgroundAlpha, Rect padding) {
         if (context instanceof Activity) {
             Activity currentActivity = (Activity) context;
             if (htmlString != null) {
+                if (IterableInAppHTMLNotification.getInstance() != null) {
+                    IterableLogger.w(TAG, "Skipping the in-app notification: another notification is already being displayed");
+                    return false;
+                }
+
                 IterableInAppHTMLNotification notification = IterableInAppHTMLNotification.createInstance(context, htmlString);
                 notification.setTrackParams(messageId);
                 notification.setCallback(clickCallback);
                 notification.setBackgroundAlpha(backgroundAlpha);
                 notification.setPadding(padding);
                 notification.setOwnerActivity(currentActivity);
                 notification.show();
+                return true;
             }
         } else {
             IterableLogger.w(TAG, "To display in-app notifications, the context must be of an instance of: Activity");
         }
+        return false;
     }
 
     /**

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

@@ -0,0 +1,52 @@
+package com.iterable.iterableapi;
+
+import android.app.Activity;
+import android.graphics.Rect;
+
+import com.iterable.iterableapi.unit.BaseTest;
+
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+import org.powermock.core.classloader.annotations.PrepareForTest;
+import org.robolectric.Robolectric;
+import org.robolectric.RuntimeEnvironment;
+import org.robolectric.android.controller.ActivityController;
+
+import java.io.IOException;
+
+import okhttp3.mockwebserver.MockWebServer;
+
+import static junit.framework.Assert.assertFalse;
+import static junit.framework.Assert.assertTrue;
+
+@PrepareForTest(IterableUtil.class)
+public class IterableInAppManagerTest extends BaseTest {
+
+    private MockWebServer server;
+
+    @Before
+    public void setUp() {
+        server = new MockWebServer();
+        IterableApi.overrideURLEndpointPath(server.url("").toString());
+        IterableApi.sharedInstance = new IterableApi();
+    }
+
+    @After
+    public void tearDown() throws IOException {
+        server.shutdown();
+        server = null;
+    }
+
+    @Test
+    public void testDoNotShowMultipleTimes() throws Exception {
+        ActivityController<Activity> controller = Robolectric.buildActivity(Activity.class).create().start();
+        Activity activity = controller.get();
+
+        boolean shownFirstTime = IterableInAppManager.showIterableNotificationHTML(activity, "", "", null, 0.0, new Rect());
+        boolean shownSecondTime = IterableInAppManager.showIterableNotificationHTML(activity, "", "", null, 0.0, new Rect());
+        assertTrue(shownFirstTime);
+        assertFalse(shownSecondTime);
+    }
+
+}

iterableapi/src/test/java/com/iterable/iterableapi/unit/BaseTest.java

@@ -17,6 +17,8 @@
         "android.*",
         "okhttp3.*",
         "javax.net.ssl.*",
+        "javax.xml.parsers.*",
+        "com.sun.org.apache.xerces.internal.jaxp.*",
         "com.squareup.*",
         "okio.*"
 })