Push API: test that default notification is shown on Android when needed.

chrome/android/javatests/src/org/chromium/chrome/browser/push_messaging/PushMessagingTest.java

Index: chrome/android/javatests/src/org/chromium/chrome/browser/push_messaging/PushMessagingTest.java
diff --git a/chrome/android/javatests/src/org/chromium/chrome/browser/push_messaging/PushMessagingTest.java b/chrome/android/javatests/src/org/chromium/chrome/browser/push_messaging/PushMessagingTest.java
index e7270ff76b6628b8e8e0bb1c804e5c23f12ee997..41a2bba9747db0e6e4b587e8ab990d832faa42bf 100644
--- a/chrome/android/javatests/src/org/chromium/chrome/browser/push_messaging/PushMessagingTest.java
+++ b/chrome/android/javatests/src/org/chromium/chrome/browser/push_messaging/PushMessagingTest.java
@@ -4,32 +4,77 @@
 
 package org.chromium.chrome.browser.push_messaging;
 
+import static org.chromium.base.test.util.ScalableTimeout.scaleTimeout;
+
 import android.annotation.SuppressLint;
 import android.app.Notification;
 import android.content.Context;
 import android.os.Bundle;
+import android.test.MoreAsserts;
+import android.test.suitebuilder.annotation.LargeTest;
 import android.test.suitebuilder.annotation.MediumTest;
 
 import org.chromium.base.ThreadUtils;
 import org.chromium.base.test.util.Feature;
 import org.chromium.chrome.browser.notifications.NotificationTestBase;
 import org.chromium.chrome.browser.preferences.website.ContentSetting;
+import org.chromium.chrome.browser.tab.Tab;
 import org.chromium.chrome.test.util.TestHttpServerClient;
 import org.chromium.chrome.test.util.browser.TabTitleObserver;
 import org.chromium.chrome.test.util.browser.notifications.MockNotificationManagerProxy.NotificationEntry;
 import org.chromium.components.gcm_driver.FakeGoogleCloudMessagingSubscriber;
 import org.chromium.components.gcm_driver.GCMDriver;
+import org.chromium.content.browser.test.util.CallbackHelper;
+import org.chromium.content.browser.test.util.JavaScriptUtils;
+
+import java.util.concurrent.TimeoutException;
 
 /**
  * Instrumentation tests for the Push API and the integration with the Notifications API on Android.
  */
 // TODO(mvanouwerkerk): remove @SuppressLint once crbug.com/501900 is fixed.
 @SuppressLint("NewApi")
-public class PushMessagingTest extends NotificationTestBase {
+public class PushMessagingTest
+        extends NotificationTestBase implements PushMessagingServiceObserver.Listener {
     private static final String PUSH_TEST_PAGE = TestHttpServerClient.getUrl(
             "chrome/test/data/push_messaging/push_messaging_test_android.html");
+    private static final String ABOUT_BLANK = "about:blank";
     private static final String SENDER_ID_BUNDLE_KEY = "from";
-    private static final int TITLE_UPDATE_TIMEOUT_SECONDS = 5;
+    private static final int TITLE_UPDATE_TIMEOUT_SECONDS = (int) scaleTimeout(5);
+
+    private final CallbackHelper mMessageHandledHelper;
+
+    public PushMessagingTest() {
+        mMessageHandledHelper = new CallbackHelper();
+    }
+
+    @Override
+    protected void setUp() throws Exception {
+        super.setUp();
+        final PushMessagingServiceObserver.Listener listener = this;
+        ThreadUtils.runOnUiThreadBlocking(new Runnable() {

[Peter Beverloo, 2015/12/10 18:47:51]

Why is it significant to run this on the UI thread? We know when setUp() and
tearDown() execute relative to the test.

[Michael van Ouwerkerk, 2015/12/11 11:23:54]

It modifies state in UI thread-only code. While we can reason about why and when
it is safe to violate that rule and call it from the test thread, this seems
like an inadvisable habit to get into.

It would be  nice to have lambdas, the Runnable verbosity is distracting:
ThreadUtils.runOnUiThreadBlocking((Void v) ->
PushMessagingServiceObserver.setListenerForTesting(this));

+            @Override
+            public void run() {
+                PushMessagingServiceObserver.setListenerForTesting(listener);
+            }
+        });
+    }
+
+    @Override
+    protected void tearDown() throws Exception {
+        ThreadUtils.runOnUiThreadBlocking(new Runnable() {
+            @Override
+            public void run() {
+                PushMessagingServiceObserver.setListenerForTesting(null);
+            }
+        });
+        super.tearDown();
+    }
+
+    @Override
+    public void onMessageHandled() {
+        mMessageHandledHelper.notifyCalled();
+    }
 
     /**
      * Verifies that a notification can be shown from a push event handler in the service worker.
@@ -44,24 +89,82 @@ public void testPushAndShowNotification() throws Exception {
         setNotificationContentSettingForCurrentOrigin(ContentSetting.ALLOW);
         runScriptAndWaitForTitle("subscribePush()", "subscribe ok");
 
-        sendPushMessage(subscriber.getLastSubscribeSubtype(), subscriber.getLastSubscribeSource());
+        sendPushAndWaitForCallback(
+                subscriber.getLastSubscribeSubtype(), subscriber.getLastSubscribeSource());
         NotificationEntry notificationEntry = waitForNotification();
-        assertEquals("push notification",
+        assertEquals("push notification 1",
+                notificationEntry.notification.extras.getString(Notification.EXTRA_TITLE));
+    }
+
+    /**
+     * Verifies that the default notification is shown when no notification is shown from the push
+     * event handler while no tab is visible for the origin, and grace has been exceeded.
+     */
+    @LargeTest
+    @Feature({"Browser", "PushMessaging"})
+    public void testDefaultNotification() throws Exception {
+        FakeGoogleCloudMessagingSubscriber subscriber = new FakeGoogleCloudMessagingSubscriber();
+        GCMDriver.overrideSubscriberForTesting(subscriber);
+
+        // Load the push test page into the first tab.
+        loadUrl(PUSH_TEST_PAGE);
+        assertEquals(1, getActivity().getCurrentTabModel().getCount());
+        Tab tab = getActivity().getActivityTab();
+        assertEquals(PUSH_TEST_PAGE, tab.getUrl());
+        assertFalse(tab.isHidden());
+
+        // Set up the push subscription and capture its details.
+        setNotificationContentSettingForCurrentOrigin(ContentSetting.ALLOW);
+        runScriptAndWaitForTitle("subscribePush()", "subscribe ok");
+        String appId = subscriber.getLastSubscribeSubtype();
+        String senderId = subscriber.getLastSubscribeSource();
+
+        // Make the tab invisible by opening another one with a different origin.
+        loadUrlInNewTab(ABOUT_BLANK);
+        assertEquals(2, getActivity().getCurrentTabModel().getCount());
+        assertEquals(ABOUT_BLANK, getActivity().getActivityTab().getUrl());
+        assertTrue(tab.isHidden());
+
+        // The first time a push event is fired and no notification is shown from the service
+        // worker, grace permits it so no default notification is shown.
+        runScriptAndWaitForTitle("setNotifyOnPush(false)", "setNotifyOnPush false ok", tab);
+        sendPushAndWaitForCallback(appId, senderId);
+
+        // After grace runs out a default notification will be shown.
+        sendPushAndWaitForCallback(appId, senderId);
+        NotificationEntry notificationEntry = waitForNotification();
+        MoreAsserts.assertContainsRegex("user_visible_auto_notification", notificationEntry.tag);
+
+        // When another push does show a notification, the default notification is automatically
+        // dismissed (an additional mutation) so there is only one left in the end.
+        runScriptAndWaitForTitle("setNotifyOnPush(true)", "setNotifyOnPush true ok", tab);
+        sendPushAndWaitForCallback(appId, senderId);
+        waitForNotificationManagerMutation();
+        notificationEntry = waitForNotification();
+        assertEquals("push notification 1",
                 notificationEntry.notification.extras.getString(Notification.EXTRA_TITLE));
     }
 
     /**
      * Runs {@code script} in the current tab and waits for the tab title to change to
-     * {@code expectedResult}.
+     * {@code expectedTitle}.
      */
-    private void runScriptAndWaitForTitle(String script, String expectedResult) throws Exception {
-        runJavaScriptCodeInCurrentTab(script);
-        TabTitleObserver titleObserver =
-                new TabTitleObserver(getActivity().getActivityTab(), expectedResult);
-        titleObserver.waitForTitleUpdate(TITLE_UPDATE_TIMEOUT_SECONDS);
+    private void runScriptAndWaitForTitle(String script, String expectedTitle) throws Exception {
+        runScriptAndWaitForTitle(script, expectedTitle, getActivity().getActivityTab());
     }
 
-    private void sendPushMessage(final String appId, final String senderId) {
+    /**
+     * Runs {@code script} in {@code tab} and waits for the tab title to change to
+     * {@code expectedTitle}.
+     */
+    private void runScriptAndWaitForTitle(String script, String expectedTitle, Tab tab)
+            throws Exception {
+        JavaScriptUtils.executeJavaScript(tab.getWebContents(), script);
+        waitForTitle(tab, expectedTitle);
+    }
+
+    private void sendPushAndWaitForCallback(final String appId, final String senderId)
+            throws Exception {
         ThreadUtils.runOnUiThreadBlocking(new Runnable() {
             @Override
             public void run() {
@@ -71,5 +174,16 @@ public void run() {
                 GCMDriver.onMessageReceived(context, appId, extras);
             }
         });
+        mMessageHandledHelper.waitForCallback(mMessageHandledHelper.getCallCount());
+    }
+
+    private void waitForTitle(Tab tab, String expectedTitle) throws Exception {
+        TabTitleObserver titleObserver = new TabTitleObserver(tab, expectedTitle);
+        try {
+            titleObserver.waitForTitleUpdate(TITLE_UPDATE_TIMEOUT_SECONDS);
+        } catch (TimeoutException e) {
+            // The title is not as expected, this assertion neatly logs what the difference is.
+            assertEquals(expectedTitle, tab.getTitle());
+        }
     }
 }