[page_load_metrics] Add a NavigationThrottle for richer abort metrics

content/public/test/browser_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 "content/public/test/browser_test_utils.h"
 
 #include <stddef.h>
 #include <tuple>
 #include <utility>
 
@@ skipping 26 matching lines @@
 #include "content/browser/web_contents/web_contents_impl.h"
 #include "content/browser/web_contents/web_contents_view.h"
 #include "content/common/input/synthetic_web_input_event_builders.h"
 #include "content/common/input_messages.h"
 #include "content/common/view_messages.h"
 #include "content/public/browser/browser_context.h"
 #include "content/public/browser/browser_plugin_guest_manager.h"
 #include "content/public/browser/browser_thread.h"
 #include "content/public/browser/histogram_fetcher.h"
 #include "content/public/browser/navigation_entry.h"
+#include "content/public/browser/navigation_handle.h"
+#include "content/public/browser/navigation_throttle.h"
 #include "content/public/browser/notification_service.h"
 #include "content/public/browser/notification_types.h"
 #include "content/public/browser/render_frame_host.h"
 #include "content/public/browser/render_process_host.h"
 #include "content/public/browser/render_view_host.h"
 #include "content/public/browser/storage_partition.h"
 #include "content/public/browser/web_contents.h"
 #include "content/public/test/test_navigation_observer.h"
 #include "content/public/test/test_utils.h"
 #include "content/test/accessibility_browser_test_utils.h"
@@ skipping 286 matching lines @@
   GURL redirect_target(redirect_server.Resolve(path));
   DCHECK(redirect_target.is_valid());
 
   std::unique_ptr<net::test_server::BasicHttpResponse> http_response(
       new net::test_server::BasicHttpResponse);
   http_response->set_code(http_status_code);
   http_response->AddCustomHeader("Location", redirect_target.spec());
   return std::move(http_response);
 }
 
+// Helper class used by the TestNavigationManager to pause navigations.
+// Note: the throttle should be added to the *end* of the list of throttles,
+// so all NavigationThrottles that should be attached observe the
+// WillStartRequest callback. RegisterThrottleForTesting has this behavior.
+class TestNavigationManagerThrottle : public NavigationThrottle {
+ public:
+  TestNavigationManagerThrottle(NavigationHandle* handle,
+                                base::Closure on_will_start_request_closure)
+      : NavigationThrottle(handle),
+        on_will_start_request_closure_(on_will_start_request_closure) {}
+  ~TestNavigationManagerThrottle() override {}
+
+ private:
+  // NavigationThrottle:
+  NavigationThrottle::ThrottleCheckResult WillStartRequest() override {
+    BrowserThread::PostTask(BrowserThread::UI, FROM_HERE,
+                            on_will_start_request_closure_);
+    return NavigationThrottle::DEFER;
+  }
+
+  base::Closure on_will_start_request_closure_;
+};
+
 }  // namespace
 
 bool NavigateIframeToURL(WebContents* web_contents,
                          std::string iframe_id,
                          const GURL& url) {
   std::string script = base::StringPrintf(
       "setTimeout(\""
       "var iframes = document.getElementById('%s');iframes.src='%s';"
       "\",0)",
       iframe_id.c_str(), url.spec().c_str());
@@ skipping 1168 matching lines @@
 FrameFocusedObserver::FrameFocusedObserver(RenderFrameHost* owner_host)
     : impl_(new FrameTreeNodeObserverImpl(
           static_cast<RenderFrameHostImpl*>(owner_host)->frame_tree_node())) {}
 
 FrameFocusedObserver::~FrameFocusedObserver() {}
 
 void FrameFocusedObserver::Wait() {
   impl_->Run();
 }
 
+TestNavigationManager::TestNavigationManager(WebContents* web_contents,
+                                             const GURL& url)
+    : WebContentsObserver(web_contents),
+      url_(url),
+      navigation_paused_(false),
+      handle_(nullptr),
+      handled_navigation_(false),
+      weak_factory_(this) {}
+
+TestNavigationManager::~TestNavigationManager() {
+  ResumeNavigation();
+}
+
+bool TestNavigationManager::WaitForWillStartRequest() {
+  DCHECK(!did_finish_loop_runner_);
+  if (!handle_ && handled_navigation_)
+    return true;
+  if (navigation_paused_)
+    return true;
+  will_start_loop_runner_ = new MessageLoopRunner();
+  will_start_loop_runner_->Run();
+  will_start_loop_runner_ = nullptr;
+
+  // This will only be false if DidFinishNavigation is called before
+  // OnWillStartRequest, which could occur if a throttle cancels the navigation
+  // before the TestNavigationManagerThrottle's method is called.
+  return !handled_navigation_;
+}
+
+void TestNavigationManager::WaitForNavigationFinished() {
+  DCHECK(!will_start_loop_runner_);
+  if (!handle_ && handled_navigation_)
+    return;
+  // Ensure the navigation is resumed if the manager paused it previously.
+  if (navigation_paused_)
+    ResumeNavigation();
+  did_finish_loop_runner_ = new MessageLoopRunner();
+  did_finish_loop_runner_->Run();
+  did_finish_loop_runner_ = nullptr;
+}
+
+void TestNavigationManager::DidStartNavigation(NavigationHandle* handle) {
+  if (!ShouldMonitorNavigation(handle))
+    return;
+
+  handle_ = handle;
+  std::unique_ptr<NavigationThrottle> throttle(
+      new TestNavigationManagerThrottle(
+          handle_, base::Bind(&TestNavigationManager::OnWillStartRequest,
+                              weak_factory_.GetWeakPtr())));
+  handle_->RegisterThrottleForTesting(std::move(throttle));
+}
+
+void TestNavigationManager::DidFinishNavigation(NavigationHandle* handle) {
+  if (handle != handle_)
+    return;
+  handle_ = nullptr;
+  handled_navigation_ = true;
+  navigation_paused_ = false;
+  if (did_finish_loop_runner_)
+    did_finish_loop_runner_->Quit();
+  if (will_start_loop_runner_)
+    will_start_loop_runner_->Quit();

[nasko, 2016/08/02 16:22:16]

Why would we have either of the two runners running? Would be good to document
in a comment.

[Charlie Harrison, 2016/08/02 16:47:13]

For |did_finish_loop_runner_|, this is the normal place to quit the run loop to
notify the navigation is finished.

For |will_start_loop_runner_|, we could still be spinning here if the navigation
is cancelled while it is deferred.

I've clarified this in a comment.

+}
+
+void TestNavigationManager::OnWillStartRequest() {
+  navigation_paused_ = true;
+  if (will_start_loop_runner_)
+    will_start_loop_runner_->Quit();
+
+  // If waiting for the navigation to finish, resume the navigation.
+  if (did_finish_loop_runner_)
+    ResumeNavigation();
+}
+
+void TestNavigationManager::ResumeNavigation() {
+  if (!navigation_paused_ || !handle_)
+    return;
+  navigation_paused_ = false;
+  handle_->Resume();
+}
+
+bool TestNavigationManager::ShouldMonitorNavigation(NavigationHandle* handle) {
+  if (handle_ || handle->GetURL() != url_)
+    return false;
+  if (handled_navigation_)
+    return false;
+  return true;
+}
+
 }  // namespace content