PlzNavigate: Add tests to check WebUI navigations.

content/browser/frame_host/render_frame_host_manager_unittest.cc

 // Copyright 2013 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 "base/command_line.h"
 #include "base/files/file_path.h"
 #include "base/strings/utf_string_conversions.h"
 #include "base/test/histogram_tester.h"
 #include "base/time/time.h"
 #include "content/browser/compositor/test/no_transport_image_transport_factory.h"
@@ skipping 19 matching lines @@
 #include "content/public/browser/web_contents_observer.h"
 #include "content/public/browser/web_ui_controller.h"
 #include "content/public/common/bindings_policy.h"
 #include "content/public/common/content_switches.h"
 #include "content/public/common/javascript_message_type.h"
 #include "content/public/common/url_constants.h"
 #include "content/public/common/url_utils.h"
 #include "content/public/test/mock_render_process_host.h"
 #include "content/public/test/test_notification_tracker.h"
 #include "content/public/test/test_utils.h"
+#include "content/test/browser_side_navigation_test_utils.h"
 #include "content/test/test_content_browser_client.h"
 #include "content/test/test_content_client.h"
 #include "content/test/test_render_frame_host.h"
 #include "content/test/test_render_view_host.h"
 #include "content/test/test_web_contents.h"
 #include "net/base/load_flags.h"
 #include "testing/gtest/include/gtest/gtest.h"
 #include "third_party/WebKit/public/web/WebSandboxFlags.h"
 #include "ui/base/page_transition_types.h"
 
 namespace content {
 namespace {
 
 class RenderFrameHostManagerTestWebUIControllerFactory
     : public WebUIControllerFactory {
  public:
   RenderFrameHostManagerTestWebUIControllerFactory()
-    : should_create_webui_(false) {
+      : should_create_webui_(false), type_(1) {
+    CHECK_NE(reinterpret_cast<void*>(type_), WebUI::kNoWebUI);

[clamy, 2015/10/22 15:37:10]

Since WebUI::TypeID is actually a void*, could we cast to a WebUI::TypeID
instead of a void*. I think it will be more readable. Same below.

[carlosk, 2015/10/22 16:23:48]

Done.

   }
   ~RenderFrameHostManagerTestWebUIControllerFactory() override {}
 
   void set_should_create_webui(bool should_create_webui) {
     should_create_webui_ = should_create_webui;
   }
 
+  void set_webui_type(uintptr_t type) {

[clamy, 2015/10/22 15:37:10]

nit: add a comment explaining that this allows to create WebUIs of different
types for testing?

[carlosk, 2015/10/22 16:23:48]

Done. I then also moved the comment below to here.

+    CHECK_NE(reinterpret_cast<void*>(type), WebUI::kNoWebUI);
+    type_ = type;
+  }
+
   // WebUIFactory implementation.
   WebUIController* CreateWebUIControllerForURL(WebUI* web_ui,
                                                const GURL& url) const override {
     // If WebUI creation is enabled for the test and this is a WebUI URL,
     // returns a new instance.
     if (should_create_webui_ && HasWebUIScheme(url))
       return new WebUIController(web_ui);
     return nullptr;
   }
 
   WebUI::TypeID GetWebUIType(BrowserContext* browser_context,
                              const GURL& url) const override {
     // If WebUI creation is enabled for the test and this is a WebUI URL,
     // returns a mock WebUI type.
     if (should_create_webui_ && HasWebUIScheme(url)) {
-      return const_cast<RenderFrameHostManagerTestWebUIControllerFactory*>(
-          this);
+      // WebUI::TypeID values are void pointers to structures each factory knows
+      // are unique to their respective cases. So these return values should be
+      // safe if very low values are used (just above zero).
+      return reinterpret_cast<void*>(type_);
     }
     return WebUI::kNoWebUI;
   }
 
   bool UseWebUIForURL(BrowserContext* browser_context,
                       const GURL& url) const override {
     return HasWebUIScheme(url);
   }
 
   bool UseWebUIBindingsForURL(BrowserContext* browser_context,
                               const GURL& url) const override {
     return HasWebUIScheme(url);
   }
 
  private:
   bool should_create_webui_;
+  uintptr_t type_;
 
   DISALLOW_COPY_AND_ASSIGN(RenderFrameHostManagerTestWebUIControllerFactory);
 };
 
 class BeforeUnloadFiredWebContentsDelegate : public WebContentsDelegate {
  public:
   BeforeUnloadFiredWebContentsDelegate() {}
   ~BeforeUnloadFiredWebContentsDelegate() override {}
 
   void BeforeUnloadFired(WebContents* web_contents,
@@ skipping 157 matching lines @@
     // RenderWidgetHostView holds on to a reference to SurfaceManager, so it
     // must be shut down before the ImageTransportFactory.
     ImageTransportFactory::Terminate();
 #endif
   }
 
   void set_should_create_webui(bool should_create_webui) {
     factory_.set_should_create_webui(should_create_webui);
   }
 
+  void set_webui_type(int type) { factory_.set_webui_type(type); }
+
   void NavigateActiveAndCommit(const GURL& url) {
     // Note: we navigate the active RenderFrameHost because previous navigations
     // won't have committed yet, so NavigateAndCommit does the wrong thing
     // for us.
     controller().LoadURL(
         url, Referrer(), ui::PAGE_TRANSITION_LINK, std::string());
     int entry_id = controller().GetPendingEntry()->GetUniqueID();
 
     // Simulate the BeforeUnload_ACK that is received from the current renderer
     // for a cross-site navigation.
@@ skipping 117 matching lines @@
     // Tests currently only navigate using main frame FrameNavigationEntries.
     FrameNavigationEntry* frame_entry = entry.root_node()->frame_entry.get();
     if (base::CommandLine::ForCurrentProcess()->HasSwitch(
         switches::kEnableBrowserSideNavigation)) {
       scoped_ptr<NavigationRequest> navigation_request =
           NavigationRequest::CreateBrowserInitiated(
               manager->frame_tree_node_, frame_entry->url(),
               frame_entry->referrer(), *frame_entry, entry,
               FrameMsg_Navigate_Type::NORMAL, false, base::TimeTicks::Now(),
               static_cast<NavigationControllerImpl*>(&controller()));
+
+      // Simulates request creation that triggers the 1st internal call to
+      // GetFrameHostForNavigation.
+      manager->DidCreateNavigationRequest(*navigation_request);
+
+      // And also simulates the 2nd and final call to GetFrameHostForNavigation
+      // that determines the final frame that will commit the navigation.
       TestRenderFrameHost* frame_host = static_cast<TestRenderFrameHost*>(
           manager->GetFrameHostForNavigation(*navigation_request));
       CHECK(frame_host);
       frame_host->set_pending_commit(true);
       return frame_host;
     }
 
     return manager->Navigate(frame_entry->url(), *frame_entry, entry);
   }
 
@@ skipping 679 matching lines @@
 
   // It's important that the SiteInstance get set on the Web UI page as soon
   // as the navigation starts, rather than lazily after it commits, so we don't
   // try to re-use the SiteInstance/process for non Web UI things that may
   // get loaded in between.
   EXPECT_TRUE(host->GetSiteInstance()->HasSite());
   EXPECT_EQ(kUrl, host->GetSiteInstance()->GetSiteURL());
 
   // The Web UI is committed immediately because the RenderViewHost has not been
   // used yet. UpdateStateForNavigate() took the short cut path.
+  EXPECT_TRUE(manager->web_ui());
   if (base::CommandLine::ForCurrentProcess()->HasSwitch(
           switches::kEnableBrowserSideNavigation)) {
-    EXPECT_FALSE(manager->speculative_web_ui());
+    // For PlzNavigate as GetFrameHostForNavigation is called twice in a row, a
+    // speculative WebUI will exist because of the 2nd call but it should just
+    // be the re-using of the current one that has been committed.
+    EXPECT_TRUE(manager->speculative_web_ui());
+    EXPECT_EQ(manager->web_ui(), manager->speculative_web_ui());
   } else {
     EXPECT_FALSE(manager->pending_web_ui());
   }
-  EXPECT_TRUE(manager->web_ui());
 
   // Commit.
   manager->DidNavigateFrame(host, true);
   EXPECT_TRUE(
       host->render_view_host()->GetEnabledBindings() & BINDINGS_POLICY_WEB_UI);
 }
 
 // Tests that we can open a WebUI link in a new tab from a WebUI page and still
 // grant the correct bindings.  http://crbug.com/189101.
 TEST_F(RenderFrameHostManagerTest, WebUIInNewTab) {
@@ skipping 1353 matching lines @@
   EXPECT_EQ(tree3, opener_frame_trees[2]);
   EXPECT_EQ(tree4, opener_frame_trees[3]);
 
   EXPECT_EQ(2U, nodes_with_back_links.size());
   EXPECT_TRUE(nodes_with_back_links.find(root1->child_at(1)) !=
               nodes_with_back_links.end());
   EXPECT_TRUE(nodes_with_back_links.find(root4->child_at(0)) !=
               nodes_with_back_links.end());
 }
 
+class RenderFrameHostManagerTestWithBrowserSideNavigation
+    : public RenderFrameHostManagerTest {
+ public:
+  void SetUp() override {
+    EnableBrowserSideNavigation();
+    RenderFrameHostManagerTest::SetUp();
+  }
+};
+
+TEST_F(RenderFrameHostManagerTestWithBrowserSideNavigation,

[clamy, 2015/10/22 15:37:10]

nit: add a comment describing what the test does.

Also there seem to be 3 main part in the test, would it make sense to break it
into 3 independent tests?

[carlosk, 2015/10/22 16:23:48]

Done. And indeed this looks much better now that it's broken down to 3 tests.

+       NavigateBetweenWebUIs) {
+  set_should_create_webui(true);
+  RenderViewHostChangedObserver change_observer(contents());
+  RenderFrameHostManager* manager = contents()->GetRenderManagerForTesting();
+
+  // 1) The first navigation to a WebUI. --------------------------
+  {
+    RenderFrameHostImpl* initial_host = manager->current_frame_host();
+    ASSERT_TRUE(initial_host);
+    EXPECT_FALSE(initial_host->IsRenderFrameLive());
+
+    const GURL kUrl("chrome://foo");
+    NavigationEntryImpl entry(NULL /* instance */, -1 /* page_id */, kUrl,
+                              Referrer(), base::string16() /* title */,
+                              ui::PAGE_TRANSITION_TYPED,
+                              false /* is_renderer_init */);
+    FrameNavigationEntry* frame_entry = entry.root_node()->frame_entry.get();
+    scoped_ptr<NavigationRequest> navigation_request =
+        NavigationRequest::CreateBrowserInitiated(
+            contents()->GetFrameTree()->root(), frame_entry->url(),
+            frame_entry->referrer(), *frame_entry, entry,
+            FrameMsg_Navigate_Type::NORMAL, false, base::TimeTicks::Now(),
+            static_cast<NavigationControllerImpl*>(&controller()));
+    // Navigation request
+    manager->DidCreateNavigationRequest(*navigation_request);
+    EXPECT_FALSE(GetPendingFrameHost(manager));
+    // As the initial renderer was not be live, the new RenderFrameHost should
+    // be made immediately active at request time.
+    EXPECT_TRUE(change_observer.DidHostChange());
+    TestRenderFrameHost* host =
+        static_cast<TestRenderFrameHost*>(manager->current_frame_host());
+    ASSERT_TRUE(host);
+    EXPECT_NE(host, initial_host);
+    EXPECT_TRUE(host->IsRenderFrameLive());
+    WebUIImpl* web_ui = host->web_ui();
+    EXPECT_TRUE(web_ui);
+    EXPECT_FALSE(manager->speculative_web_ui());
+
+    // Preparing to commit, updates the navigating RenderFrameHost
+    EXPECT_EQ(host, manager->GetFrameHostForNavigation(*navigation_request));
+    host->set_pending_commit(true);
+
+    // No pending RenderFrameHost as the current should be reused
+    EXPECT_FALSE(GetPendingFrameHost(manager));
+    // But now there will be a pending WebUI set to re-using the current one.
+    EXPECT_EQ(web_ui, host->web_ui());
+    EXPECT_EQ(web_ui, manager->speculative_web_ui());
+    EXPECT_EQ(web_ui, host->pending_web_ui());
+
+    // Commit.
+    manager->DidNavigateFrame(host, true);
+    EXPECT_FALSE(change_observer.DidHostChange());
+    EXPECT_EQ(host, manager->current_frame_host());
+    EXPECT_FALSE(GetPendingFrameHost(manager));
+    EXPECT_EQ(web_ui, host->web_ui());
+    EXPECT_FALSE(manager->speculative_web_ui());
+    EXPECT_FALSE(host->pending_web_ui());
+  }
+
+  // 2) Navigate to next WebUI. -------------------------
+  {
+    // Same-site navigation and to a different WebUI.
+    set_webui_type(2);
+    const GURL kUrl("chrome://foo/bar");
+    // Navigation request
+    NavigationEntryImpl entry(NULL /* instance */, -1 /* page_id */, kUrl,
+                              Referrer(), base::string16() /* title */,
+                              ui::PAGE_TRANSITION_TYPED,
+                              false /* is_renderer_init */);
+    FrameNavigationEntry* frame_entry = entry.root_node()->frame_entry.get();
+    scoped_ptr<NavigationRequest> navigation_request =
+        NavigationRequest::CreateBrowserInitiated(
+            contents()->GetFrameTree()->root(), frame_entry->url(),
+            frame_entry->referrer(), *frame_entry, entry,
+            FrameMsg_Navigate_Type::NORMAL, false, base::TimeTicks::Now(),
+            static_cast<NavigationControllerImpl*>(&controller()));
+    manager->DidCreateNavigationRequest(*navigation_request);
+
+    EXPECT_FALSE(GetPendingFrameHost(manager));
+    TestRenderFrameHost* host =
+        static_cast<TestRenderFrameHost*>(manager->current_frame_host());
+    // Current WebUI should still be in place and a new one should be pending
+    // from the current RenderFrameHost.
+    EXPECT_TRUE(host->web_ui());
+    WebUIImpl* next_web_ui = manager->speculative_web_ui();
+    EXPECT_TRUE(next_web_ui);
+    EXPECT_NE(next_web_ui, host->web_ui());
+    EXPECT_EQ(next_web_ui, host->pending_web_ui());
+
+    // Preparing to commit, updates the navigating RenderFrameHost
+    EXPECT_EQ(host, manager->GetFrameHostForNavigation(*navigation_request));
+    host->set_pending_commit(true);
+
+    EXPECT_FALSE(GetPendingFrameHost(manager));
+    EXPECT_TRUE(host->web_ui());
+    EXPECT_NE(next_web_ui, host->web_ui());
+    EXPECT_EQ(next_web_ui, manager->speculative_web_ui());
+    EXPECT_EQ(next_web_ui, host->pending_web_ui());
+
+    // Commit.
+    manager->DidNavigateFrame(host, true);
+    EXPECT_FALSE(change_observer.DidHostChange());
+    EXPECT_EQ(next_web_ui, host->web_ui());
+    EXPECT_FALSE(manager->speculative_web_ui());
+    EXPECT_FALSE(host->pending_web_ui());
+  }
+
+  // 3) Navigate to yet another WebUI. -------------------------
+  {
+    // Cross-site navigation and to (forcefully) a different WebUI.
+    set_webui_type(3);  // Not really necessary; just for consistency.
+    const GURL kUrl("chrome://boo");
+    // Navigation request
+    NavigationEntryImpl entry(NULL /* instance */, -1 /* page_id */, kUrl,
+                              Referrer(), base::string16() /* title */,
+                              ui::PAGE_TRANSITION_TYPED,
+                              false /* is_renderer_init */);
+    FrameNavigationEntry* frame_entry = entry.root_node()->frame_entry.get();
+    scoped_ptr<NavigationRequest> navigation_request =
+        NavigationRequest::CreateBrowserInitiated(
+            contents()->GetFrameTree()->root(), frame_entry->url(),
+            frame_entry->referrer(), *frame_entry, entry,
+            FrameMsg_Navigate_Type::NORMAL, false, base::TimeTicks::Now(),
+            static_cast<NavigationControllerImpl*>(&controller()));
+    manager->DidCreateNavigationRequest(*navigation_request);
+
+    TestRenderFrameHost* speculative_host =
+        static_cast<TestRenderFrameHost*>(GetPendingFrameHost(manager));
+    EXPECT_TRUE(speculative_host);
+    // Current WebUI should still be in place and a new one should be pending
+    // from the speculative RenderFrameHost.
+    EXPECT_TRUE(manager->current_frame_host()->web_ui());
+    WebUIImpl* next_web_ui = manager->speculative_web_ui();
+    EXPECT_TRUE(next_web_ui);
+    EXPECT_NE(next_web_ui, manager->current_frame_host()->web_ui());
+    EXPECT_EQ(next_web_ui, speculative_host->web_ui());
+
+    // Preparing to commit, updates the navigating RenderFrameHost
+    EXPECT_EQ(speculative_host,
+              manager->GetFrameHostForNavigation(*navigation_request));
+    speculative_host->set_pending_commit(true);
+
+    EXPECT_EQ(speculative_host, GetPendingFrameHost(manager));
+    EXPECT_TRUE(manager->current_frame_host()->web_ui());
+    EXPECT_NE(next_web_ui, manager->current_frame_host()->web_ui());
+    EXPECT_EQ(next_web_ui, manager->speculative_web_ui());
+    EXPECT_EQ(next_web_ui, speculative_host->web_ui());
+
+    // Commit.
+    manager->DidNavigateFrame(speculative_host, true);
+    EXPECT_EQ(speculative_host, manager->current_frame_host());
+    EXPECT_TRUE(change_observer.DidHostChange());
+    EXPECT_EQ(next_web_ui, manager->current_frame_host()->web_ui());
+    EXPECT_FALSE(manager->speculative_web_ui());
+    EXPECT_FALSE(speculative_host->pending_web_ui());
+  }
+}
+
 }  // namespace content