Fix races in tests waiting for beforeunload dialogs.

chrome/test/base/ui_test_utils.cc

 // Copyright (c) 2012 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 "chrome/test/base/ui_test_utils.h"
 
 #include <stddef.h>
 
 #include <memory>
 
@@ skipping 23 matching lines @@
 #include "chrome/browser/ui/browser_window.h"
 #include "chrome/browser/ui/find_bar/find_notification_details.h"
 #include "chrome/browser/ui/find_bar/find_tab_helper.h"
 #include "chrome/browser/ui/location_bar/location_bar.h"
 #include "chrome/browser/ui/tabs/tab_strip_model.h"
 #include "chrome/common/chrome_paths.h"
 #include "chrome/common/pref_names.h"
 #include "chrome/test/base/find_in_page_observer.h"
 #include "components/app_modal/app_modal_dialog.h"
 #include "components/app_modal/app_modal_dialog_queue.h"
+#include "components/app_modal/javascript_app_modal_dialog.h"
 #include "components/bookmarks/browser/bookmark_model.h"
 #include "components/history/core/browser/history_service_observer.h"
 #include "components/omnibox/browser/autocomplete_controller.h"
 #include "components/omnibox/browser/omnibox_edit_model.h"
 #include "components/prefs/pref_service.h"
 #include "content/public/browser/download_item.h"
 #include "content/public/browser/download_manager.h"
 #include "content/public/browser/navigation_controller.h"
 #include "content/public/browser/navigation_entry.h"
 #include "content/public/browser/notification_service.h"
+#include "content/public/browser/render_frame_host.h"
 #include "content/public/browser/render_process_host.h"
 #include "content/public/browser/storage_partition.h"
 #include "content/public/browser/web_contents.h"
 #include "content/public/browser/web_contents_observer.h"
 #include "content/public/common/resource_request_body.h"
 #include "content/public/test/browser_test_utils.h"
 #include "content/public/test/download_test_observer.h"
 #include "content/public/test/test_navigation_observer.h"
 #include "content/public/test/test_utils.h"
 #include "device/geolocation/geolocation_provider.h"
@@ skipping 32 matching lines @@
     BrowserAddedObserver observer;
     new_browser = observer.WaitForSingleNewBrowser();
     // The new browser should never be in |excluded_browsers|.
     DCHECK(!base::ContainsKey(excluded_browsers, new_browser));
   }
   return new_browser;
 }
 
 class AppModalDialogWaiter : public app_modal::AppModalDialogObserver {
  public:
-  AppModalDialogWaiter()
-      : dialog_(NULL) {
-  }
-  ~AppModalDialogWaiter() override {
-  }
+  AppModalDialogWaiter() : dialog_(nullptr) {}
+  ~AppModalDialogWaiter() override {}
 
   app_modal::AppModalDialog* Wait() {
     if (dialog_)
       return dialog_;
     message_loop_runner_ = new content::MessageLoopRunner;
     message_loop_runner_->Run();
     EXPECT_TRUE(dialog_);
     return dialog_;
   }
 
-  // AppModalDialogWaiter:
+  // AppModalDialogObserver:
   void Notify(app_modal::AppModalDialog* dialog) override {
     DCHECK(!dialog_);
     dialog_ = dialog;
+    CheckForHangMonitorDisabling(dialog);
     if (message_loop_runner_.get() && message_loop_runner_->loop_running())
       message_loop_runner_->Quit();
   }
 
+  static void CheckForHangMonitorDisabling(app_modal::AppModalDialog* dialog) {
+    // If a test waits for a beforeunload dialog but hasn't disabled the
+    // beforeunload hang timer before triggering it, there will be a race
+    // between the dialog and the timer and the test will be flaky. We can't
+    // disable the timer here, as it's too late, but we can tell when we've won
+    // a race that we shouldn't have been in.
+    if (!dialog->IsJavaScriptModalDialog())
+      return;
+
+    auto* js_dialog = static_cast<app_modal::JavaScriptAppModalDialog*>(dialog);
+    if (!js_dialog->is_before_unload_dialog())
+      return;
+
+    // Unfortunately we don't know which frame spawned this dialog and should
+    // have the hang monitor disabled, so we cheat a bit and search for *a*
+    // frame with the hang monitor disabled. The failure case that's worrisome
+    // is someone who doesn't know the requirement to disable the hang monitor,
+    // and this will catch that case.
+    auto* contents = dialog->web_contents();
+    for (auto* frame : contents->GetAllFrames())
+      if (frame->IsBeforeUnloadHangMonitorDisabledForTesting())
+        return;
+
+    FAIL() << "If waiting for a beforeunload dialog, the beforeunload timer "
+              "must be disabled on the spawning frame to avoid flakiness.";
+  }
+
  private:
   app_modal::AppModalDialog* dialog_;
   scoped_refptr<content::MessageLoopRunner> message_loop_runner_;
 
   DISALLOW_COPY_AND_ASSIGN(AppModalDialogWaiter);
 };
 
 }  // namespace
 
 bool GetCurrentTabTitle(const Browser* browser, base::string16* title) {
@@ skipping 163 matching lines @@
   for (size_t tmp_itr = match; tmp_itr < src_size; ++tmp_itr)
     *build_dir = build_dir->Append(FILE_PATH_LITERAL(".."));
   for (; match < exe_size; ++match)
     *build_dir = build_dir->Append(exe_parts[match]);
   return true;
 }
 
 app_modal::AppModalDialog* WaitForAppModalDialog() {
   app_modal::AppModalDialogQueue* dialog_queue =
       app_modal::AppModalDialogQueue::GetInstance();
-  if (dialog_queue->HasActiveDialog())
+  if (dialog_queue->HasActiveDialog()) {
+    AppModalDialogWaiter::CheckForHangMonitorDisabling(
+        dialog_queue->active_dialog());
     return dialog_queue->active_dialog();
+  }
   AppModalDialogWaiter waiter;
   return waiter.Wait();
 }
 
 int FindInPage(WebContents* tab,
                const base::string16& search_string,
                bool forward,
                bool match_case,
                int* ordinal,
                gfx::Rect* selection_rect) {
@@ skipping 238 matching lines @@
   if (browser != browser_)
     return;
 
   observed_ = true;
   BrowserList::RemoveObserver(this);
   if (message_loop_runner_.get() && message_loop_runner_->loop_running())
     message_loop_runner_->Quit();
 }
 
 }  // namespace ui_test_utils