Push API: Deflake PushEventEnforcesUserVisibleNotification

chrome/browser/push_messaging/push_messaging_browsertest.cc

 // Copyright 2014 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include <map>
 #include <string>
 
 #include "base/barrier_closure.h"
 #include "base/bind.h"
 #include "base/command_line.h"
@@ skipping 181 matching lines @@
                                                   script,
                                                   result);
   }
 
   void TryToRegisterSuccessfully(
       const std::string& expected_push_registration_id);
 
   PushMessagingApplicationId GetServiceWorkerAppId(
       int64 service_worker_registration_id);
 
+  void SendMessageAndWaitUntilHandled(
+      const PushMessagingApplicationId& app_id,
+      const gcm::GCMClient::IncomingMessage& message);
+
   net::SpawnedTestServer* https_server() const { return https_server_.get(); }
 
   gcm::FakeGCMProfileService* gcm_service() const { return gcm_service_; }
 
 #if defined(ENABLE_NOTIFICATIONS)
   StubNotificationUIManager* notification_manager() const {
     return notification_manager_.get();
   }
 
   PlatformNotificationServiceImpl* notification_service() const {
@@ skipping 52 matching lines @@
 
 PushMessagingApplicationId PushMessagingBrowserTest::GetServiceWorkerAppId(
     int64 service_worker_registration_id) {
   GURL origin = https_server()->GetURL(std::string()).GetOrigin();
   PushMessagingApplicationId application_id = PushMessagingApplicationId::Get(
       browser()->profile(), origin, service_worker_registration_id);
   EXPECT_TRUE(application_id.IsValid());
   return application_id;
 }
 
+void PushMessagingBrowserTest::SendMessageAndWaitUntilHandled(
+    const PushMessagingApplicationId& app_id,
+    const gcm::GCMClient::IncomingMessage& message) {
+  base::RunLoop run_loop;
+  push_service()->SetMessageCallbackForTesting(run_loop.QuitClosure());
+  push_service()->OnMessage(app_id.app_id_guid(), message);
+  run_loop.Run();
+}
+
 IN_PROC_BROWSER_TEST_F(PushMessagingBrowserTest,
                        RegisterSuccessNotificationsGranted) {
   TryToRegisterSuccessfully("1-0" /* expected_push_registration_id */);
 
   PushMessagingApplicationId app_id = GetServiceWorkerAppId(0LL);
   EXPECT_EQ(app_id.app_id_guid(), gcm_service()->last_registered_app_id());
   EXPECT_EQ("1234567890", gcm_service()->last_registered_sender_ids()[0]);
 }
 
 IN_PROC_BROWSER_TEST_F(PushMessagingBrowserTest,
@@ skipping 193 matching lines @@
   // going to run script in a background tab.
   content::WebContents* web_contents =
       browser()->tab_strip_model()->GetActiveWebContents();
 
   // If the site is visible in an active tab, we should not force a notification
   // to be shown. Try it twice, since we allow one mistake per 10 push events.
   gcm::GCMClient::IncomingMessage message;
   message.sender_id = "1234567890";
   for (int n = 0; n < 2; n++) {
     message.data["data"] = "testdata";
-    push_service()->OnMessage(app_id.app_id_guid(), message);
+    SendMessageAndWaitUntilHandled(app_id, message);
     ASSERT_TRUE(RunScript("resultQueue.pop()", &script_result));
     EXPECT_EQ("testdata", script_result);
     EXPECT_EQ(0u, notification_manager()->GetNotificationCount());
   }
 
   // Open a blank foreground tab so site is no longer visible.
   ui_test_utils::NavigateToURLWithDisposition(
       browser(), GURL("about:blank"), NEW_FOREGROUND_TAB,
       ui_test_utils::BROWSER_TEST_WAIT_FOR_TAB);
 
   // If the Service Worker push event handler does not show a notification, we
   // should show a forced one, but only on the 2nd occurrence since we allow one
   // mistake per 10 push events.
   message.data["data"] = "testdata";
-  push_service()->OnMessage(app_id.app_id_guid(), message);
+  SendMessageAndWaitUntilHandled(app_id, message);
   ASSERT_TRUE(RunScript("resultQueue.pop()", &script_result, web_contents));
   EXPECT_EQ("testdata", script_result);
   EXPECT_EQ(0u, notification_manager()->GetNotificationCount());
   message.data["data"] = "testdata";
-  push_service()->OnMessage(app_id.app_id_guid(), message);
+  SendMessageAndWaitUntilHandled(app_id, message);
   ASSERT_TRUE(RunScript("resultQueue.pop()", &script_result, web_contents));
   EXPECT_EQ("testdata", script_result);
 
   EXPECT_EQ(1u, notification_manager()->GetNotificationCount());
   const Notification& forced_notification =
       notification_manager()->GetNotificationAt(0);
 
   EXPECT_EQ(kPushMessagingForcedNotificationTag, forced_notification.tag());
   EXPECT_TRUE(forced_notification.silent());
 
   // Currently, this notification will stick around until the user or webapp
   // explicitly dismisses it (though we may change this later).
   message.data["data"] = "shownotification";
-  push_service()->OnMessage(app_id.app_id_guid(), message);
+  SendMessageAndWaitUntilHandled(app_id, message);
   ASSERT_TRUE(RunScript("resultQueue.pop()", &script_result, web_contents));
   EXPECT_EQ("shownotification", script_result);
   EXPECT_EQ(2u, notification_manager()->GetNotificationCount());
 
   notification_manager()->CancelAll();
   EXPECT_EQ(0u, notification_manager()->GetNotificationCount());
 
   // However if the Service Worker push event handler shows a notification, we
   // should not show a forced one.
   message.data["data"] = "shownotification";
   for (int n = 0; n < 9; n++) {
-    push_service()->OnMessage(app_id.app_id_guid(), message);
+    SendMessageAndWaitUntilHandled(app_id, message);
     ASSERT_TRUE(RunScript("resultQueue.pop()", &script_result, web_contents));
     EXPECT_EQ("shownotification", script_result);
     EXPECT_EQ(1u, notification_manager()->GetNotificationCount());
     EXPECT_EQ("push_test_tag",
               notification_manager()->GetNotificationAt(0).tag());
     notification_manager()->CancelAll();
   }
 
   // Now that 10 push messages in a row have shown notifications, we should
   // allow the next one to mistakenly not show a notification.
   message.data["data"] = "testdata";
-  push_service()->OnMessage(app_id.app_id_guid(), message);
+  SendMessageAndWaitUntilHandled(app_id, message);
   ASSERT_TRUE(RunScript("resultQueue.pop()", &script_result, web_contents));
   EXPECT_EQ("testdata", script_result);
   EXPECT_EQ(0u, notification_manager()->GetNotificationCount());
 }
 
 IN_PROC_BROWSER_TEST_F(PushMessagingBrowserTest,
                        PushEventNotificationWithoutEventWaitUntil) {
   std::string script_result;
   content::WebContents* web_contents =
       browser()->tab_strip_model()->GetActiveWebContents();
@@ skipping 451 matching lines @@
   browser()->profile()->GetHostContentSettingsMap()->
       ClearSettingsForOneType(CONTENT_SETTINGS_TYPE_PUSH_MESSAGING);
 
   run_loop.Run();
 
   // app_id should no longer be stored in prefs
   PushMessagingApplicationId stored_app_id2 = PushMessagingApplicationId::Get(
       browser()->profile(), app_id.app_id_guid());
   EXPECT_FALSE(stored_app_id2.IsValid());
 }