PlzNavigate: send history params at commit time to the renderer

content/renderer/render_view_browsertest.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 "base/basictypes.h"
 #include "base/bind.h"
 #include "base/callback.h"
 #include "base/memory/shared_memory.h"
 #include "base/strings/string_util.h"
 #include "base/strings/utf_string_conversions.h"
@@ skipping 345 matching lines @@
       ViewHostMsg_UpdateState::ID));
 }
 
 TEST_F(RenderViewImplTest, OnNavigationHttpPost) {
   FrameMsg_Navigate_Params nav_params;
 
   // An http url will trigger a resource load so cannot be used here.
   nav_params.common_params.url = GURL("data:text/html,<div>Page</div>");
   nav_params.common_params.navigation_type = FrameMsg_Navigate_Type::NORMAL;
   nav_params.common_params.transition = ui::PAGE_TRANSITION_TYPED;
-  nav_params.page_id = -1;
+  nav_params.history_params.page_id = -1;
   nav_params.is_post = true;
   nav_params.commit_params.browser_navigation_start =
       base::TimeTicks::FromInternalValue(1);
 
   // Set up post data.
   const unsigned char* raw_data = reinterpret_cast<const unsigned char*>(
       "post \0\ndata");
   const unsigned int length = 11;
   const std::vector<unsigned char> post_data(raw_data, raw_data + length);
   nav_params.browser_initiated_post_data = post_data;
@@ skipping 187 matching lines @@
   const IPC::Message* msg2 = render_thread_->sink().GetUniqueMessageMatching(
       FrameHostMsg_SwapOut_ACK::ID);
   ASSERT_TRUE(msg2);
 
   // If we navigate back to this RenderView, ensure we don't send a state
   // update for the swapped out URL.  (http://crbug.com/72235)
   FrameMsg_Navigate_Params nav_params;
   nav_params.common_params.url = GURL("data:text/html,<div>Page B</div>");
   nav_params.common_params.navigation_type = FrameMsg_Navigate_Type::NORMAL;
   nav_params.common_params.transition = ui::PAGE_TRANSITION_TYPED;
-  nav_params.current_history_list_length = 1;
-  nav_params.current_history_list_offset = 0;
-  nav_params.pending_history_list_offset = 1;
-  nav_params.page_id = -1;
+  nav_params.history_params.current_history_list_length = 1;
+  nav_params.history_params.current_history_list_offset = 0;
+  nav_params.history_params.pending_history_list_offset = 1;
+  nav_params.history_params.page_id = -1;
   nav_params.commit_params.browser_navigation_start =
       base::TimeTicks::FromInternalValue(1);
   frame()->OnNavigate(nav_params);
   ProcessPendingMessages();
   const IPC::Message* msg3 = render_thread_->sink().GetUniqueMessageMatching(
       ViewHostMsg_UpdateState::ID);
   EXPECT_FALSE(msg3);
 }
 
 // Ensure the RenderViewImpl reloads the previous page if a reload request
@@ skipping 14 matching lines @@
   ViewHostMsg_UpdateState::Read(msg_A, &params);
   int page_id_A = get<0>(params);
   PageState state_A = get<1>(params);
   EXPECT_EQ(1, page_id_A);
   render_thread_->sink().ClearMessages();
 
   // Back to page A (page_id 1) and commit.
   FrameMsg_Navigate_Params params_A;
   params_A.common_params.navigation_type = FrameMsg_Navigate_Type::NORMAL;
   params_A.common_params.transition = ui::PAGE_TRANSITION_FORWARD_BACK;
-  params_A.current_history_list_length = 2;
-  params_A.current_history_list_offset = 1;
-  params_A.pending_history_list_offset = 0;
-  params_A.page_id = 1;
-  params_A.commit_params.page_state = state_A;
+  params_A.history_params.current_history_list_length = 2;
+  params_A.history_params.current_history_list_offset = 1;
+  params_A.history_params.pending_history_list_offset = 0;
+  params_A.history_params.page_id = 1;
+  params_A.history_params.page_state = state_A;
   params_A.commit_params.browser_navigation_start =
       base::TimeTicks::FromInternalValue(1);
   frame()->OnNavigate(params_A);
+  EXPECT_EQ(1, view()->historyBackListCount());
+  EXPECT_EQ(2, view()->historyBackListCount() +
+      view()->historyForwardListCount() + 1);
   ProcessPendingMessages();
 
   // Respond to a swap out request.
   view()->GetMainRenderFrame()->OnSwapOut(kProxyRoutingId, true,
                                           content::FrameReplicationState());
 
   // Check for a OnSwapOutACK.
   const IPC::Message* msg = render_thread_->sink().GetUniqueMessageMatching(
       FrameHostMsg_SwapOut_ACK::ID);
   ASSERT_TRUE(msg);
   render_thread_->sink().ClearMessages();
 
   // It is possible to get a reload request at this point, containing the
   // params.page_state of the initial page (e.g., if the new page fails the
   // provisional load in the renderer process, after we unload the old page).
   // Ensure the old page gets reloaded, not swappedout://.
   FrameMsg_Navigate_Params nav_params;
   nav_params.common_params.url = GURL("data:text/html,<div>Page A</div>");
   nav_params.common_params.navigation_type = FrameMsg_Navigate_Type::RELOAD;
   nav_params.common_params.transition = ui::PAGE_TRANSITION_RELOAD;
-  nav_params.current_history_list_length = 2;
-  nav_params.current_history_list_offset = 0;
-  nav_params.pending_history_list_offset = 0;
-  nav_params.page_id = 1;
-  nav_params.commit_params.page_state = state_A;
+  nav_params.history_params.current_history_list_length = 2;
+  nav_params.history_params.current_history_list_offset = 0;
+  nav_params.history_params.pending_history_list_offset = 0;
+  nav_params.history_params.page_id = 1;
+  nav_params.history_params.page_state = state_A;
   nav_params.commit_params.browser_navigation_start =
       base::TimeTicks::FromInternalValue(1);
   frame()->OnNavigate(nav_params);
   ProcessPendingMessages();
 
   // Verify page A committed, not swappedout://.
   const IPC::Message* frame_navigate_msg =
       render_thread_->sink().GetUniqueMessageMatching(
           FrameHostMsg_DidCommitProvisionalLoad::ID);
   EXPECT_TRUE(frame_navigate_msg);
@@ skipping 94 matching lines @@
   int page_id_C = get<0>(param);
   PageState state_C = get<1>(param);
   EXPECT_EQ(3, page_id_C);
   EXPECT_NE(state_B, state_C);
   render_thread_->sink().ClearMessages();
 
   // Go back to C and commit, preparing for our real test.
   FrameMsg_Navigate_Params params_C;
   params_C.common_params.navigation_type = FrameMsg_Navigate_Type::NORMAL;
   params_C.common_params.transition = ui::PAGE_TRANSITION_FORWARD_BACK;
-  params_C.current_history_list_length = 4;
-  params_C.current_history_list_offset = 3;
-  params_C.pending_history_list_offset = 2;
-  params_C.page_id = 3;
-  params_C.commit_params.page_state = state_C;
+  params_C.history_params.current_history_list_length = 4;
+  params_C.history_params.current_history_list_offset = 3;
+  params_C.history_params.pending_history_list_offset = 2;
+  params_C.history_params.page_id = 3;
+  params_C.history_params.page_state = state_C;
   params_C.commit_params.browser_navigation_start =
       base::TimeTicks::FromInternalValue(1);
   frame()->OnNavigate(params_C);
   ProcessPendingMessages();
   render_thread_->sink().ClearMessages();
 
   // Go back twice quickly, such that page B does not have a chance to commit.
   // This leads to two changes to the back/forward list but only one change to
   // the RenderView's page ID.
 
   // Back to page B (page_id 2), without committing.
   FrameMsg_Navigate_Params params_B;
   params_B.common_params.navigation_type = FrameMsg_Navigate_Type::NORMAL;
   params_B.common_params.transition = ui::PAGE_TRANSITION_FORWARD_BACK;
-  params_B.current_history_list_length = 4;
-  params_B.current_history_list_offset = 2;
-  params_B.pending_history_list_offset = 1;
-  params_B.page_id = 2;
-  params_B.commit_params.page_state = state_B;
+  params_B.history_params.current_history_list_length = 4;
+  params_B.history_params.current_history_list_offset = 2;
+  params_B.history_params.pending_history_list_offset = 1;
+  params_B.history_params.page_id = 2;
+  params_B.history_params.page_state = state_B;
   params_B.commit_params.browser_navigation_start =
       base::TimeTicks::FromInternalValue(1);
   frame()->OnNavigate(params_B);
 
   // Back to page A (page_id 1) and commit.
   FrameMsg_Navigate_Params params;
   params.common_params.navigation_type = FrameMsg_Navigate_Type::NORMAL;
   params.common_params.transition = ui::PAGE_TRANSITION_FORWARD_BACK;
-  params_B.current_history_list_length = 4;
-  params_B.current_history_list_offset = 2;
-  params_B.pending_history_list_offset = 0;
-  params.page_id = 1;
-  params.commit_params.page_state = state_A;
+  params.history_params.current_history_list_length = 4;
+  params.history_params.current_history_list_offset = 2;
+  params.history_params.pending_history_list_offset = 0;
+  params.history_params.page_id = 1;
+  params.history_params.page_state = state_A;
   params.commit_params.browser_navigation_start =
       base::TimeTicks::FromInternalValue(1);
   frame()->OnNavigate(params);
   ProcessPendingMessages();
 
   // Now ensure that the UpdateState message we receive is consistent
   // and represents page C in both page_id and state.
   const IPC::Message* msg = render_thread_->sink().GetUniqueMessageMatching(
       ViewHostMsg_UpdateState::ID);
   ASSERT_TRUE(msg);
@@ skipping 28 matching lines @@
   ViewHostMsg_UpdateState::Read(msg_A, &param);
   int page_id_A = get<0>(param);
   PageState state_A = get<1>(param);
   EXPECT_EQ(1, page_id_A);
   render_thread_->sink().ClearMessages();
 
   // Back to page A (page_id 1) and commit.
   FrameMsg_Navigate_Params params_A;
   params_A.common_params.navigation_type = FrameMsg_Navigate_Type::NORMAL;
   params_A.common_params.transition = ui::PAGE_TRANSITION_FORWARD_BACK;
-  params_A.current_history_list_length = 2;
-  params_A.current_history_list_offset = 1;
-  params_A.pending_history_list_offset = 0;
-  params_A.page_id = 1;
-  params_A.commit_params.page_state = state_A;
+  params_A.history_params.current_history_list_length = 2;
+  params_A.history_params.current_history_list_offset = 1;
+  params_A.history_params.pending_history_list_offset = 0;
+  params_A.history_params.page_id = 1;
+  params_A.history_params.page_state = state_A;
   params_A.commit_params.browser_navigation_start =
       base::TimeTicks::FromInternalValue(1);
   frame()->OnNavigate(params_A);
   ProcessPendingMessages();
 
   // A new navigation commits, clearing the forward history.
   LoadHTML("<div>Page C</div>");
   EXPECT_EQ(2, view()->history_list_length_);
   EXPECT_EQ(1, view()->history_list_offset_);
   EXPECT_EQ(3, view()->page_id_); // page C is now page id 3
 
   // The browser then sends a stale navigation to B, which should be ignored.
   FrameMsg_Navigate_Params params_B;
   params_B.common_params.navigation_type = FrameMsg_Navigate_Type::NORMAL;
   params_B.common_params.transition = ui::PAGE_TRANSITION_FORWARD_BACK;
-  params_B.current_history_list_length = 2;
-  params_B.current_history_list_offset = 0;
-  params_B.pending_history_list_offset = 1;
-  params_B.page_id = 2;
-  params_B.commit_params.page_state =
+  params_B.history_params.current_history_list_length = 2;
+  params_B.history_params.current_history_list_offset = 0;
+  params_B.history_params.pending_history_list_offset = 1;
+  params_B.history_params.page_id = 2;
+  params_B.history_params.page_state =
       state_A;  // Doesn't matter, just has to be present.
   params_B.commit_params.browser_navigation_start =
       base::TimeTicks::FromInternalValue(1);
   frame()->OnNavigate(params_B);
 
   // State should be unchanged.
   EXPECT_EQ(2, view()->history_list_length_);
   EXPECT_EQ(1, view()->history_list_offset_);
   EXPECT_EQ(3, view()->page_id_); // page C, not page B
 
@@ skipping 696 matching lines @@
   GetMainFrame()->enableViewSourceMode(true);
   WebURLError error;
   error.domain = WebString::fromUTF8(net::kErrorDomain);
   error.reason = net::ERR_FILE_NOT_FOUND;
   error.unreachableURL = GURL("http://foo");
   WebLocalFrame* web_frame = GetMainFrame();
 
   // Start a load that will reach provisional state synchronously,
   // but won't complete synchronously.
   FrameMsg_Navigate_Params params;
-  params.page_id = -1;
+  params.history_params.page_id = -1;
   params.common_params.navigation_type = FrameMsg_Navigate_Type::NORMAL;
   params.common_params.url = GURL("data:text/html,test data");
   params.commit_params.browser_navigation_start =
       base::TimeTicks::FromInternalValue(1);
   frame()->OnNavigate(params);
 
   // An error occurred.
   view()->GetMainRenderFrame()->didFailProvisionalLoad(web_frame, error);
   // Frame should exit view-source mode.
   EXPECT_FALSE(web_frame->isViewSourceModeEnabled());
 }
 
 TEST_F(RenderViewImplTest, DidFailProvisionalLoadWithErrorForCancellation) {
   GetMainFrame()->enableViewSourceMode(true);
   WebURLError error;
   error.domain = WebString::fromUTF8(net::kErrorDomain);
   error.reason = net::ERR_ABORTED;
   error.unreachableURL = GURL("http://foo");
   WebLocalFrame* web_frame = GetMainFrame();
 
   // Start a load that will reach provisional state synchronously,
   // but won't complete synchronously.
   FrameMsg_Navigate_Params params;
-  params.page_id = -1;
+  params.history_params.page_id = -1;
   params.common_params.navigation_type = FrameMsg_Navigate_Type::NORMAL;
   params.common_params.url = GURL("data:text/html,test data");
   params.commit_params.browser_navigation_start =
       base::TimeTicks::FromInternalValue(1);
   frame()->OnNavigate(params);
 
   // A cancellation occurred.
   view()->GetMainRenderFrame()->didFailProvisionalLoad(web_frame, error);
   // Frame should stay in view-source mode.
   EXPECT_TRUE(web_frame->isViewSourceModeEnabled());
@@ skipping 175 matching lines @@
   view()->OnImeConfirmComposition(
       empty_string, gfx::Range::InvalidRange(), false);
 }
 #endif
 
 TEST_F(RenderViewImplTest, ZoomLimit) {
   const double kMinZoomLevel = ZoomFactorToZoomLevel(kMinimumZoomFactor);
   const double kMaxZoomLevel = ZoomFactorToZoomLevel(kMaximumZoomFactor);
 
   FrameMsg_Navigate_Params params;
-  params.page_id = -1;
+  params.history_params.page_id = -1;
   params.common_params.navigation_type = FrameMsg_Navigate_Type::NORMAL;
   params.commit_params.browser_navigation_start =
       base::TimeTicks::FromInternalValue(1);
 
   // Verifies navigation to a URL with preset zoom level indeed sets the level.
   // Regression test for http://crbug.com/139559, where the level was not
   // properly set when it is out of the default zoom limits of WebView.
   params.common_params.url = GURL("data:text/html,min_zoomlimit_test");
   view()->OnSetZoomLevelForLoadingURL(params.common_params.url, kMinZoomLevel);
   frame()->OnNavigate(params);
@@ skipping 62 matching lines @@
 // Test that the navigating specific frames works correctly.
 TEST_F(RenderViewImplTest, NavigateFrame) {
   // Load page A.
   LoadHTML("hello <iframe srcdoc='fail' name='frame'></iframe>");
 
   // Navigate the frame only.
   FrameMsg_Navigate_Params nav_params;
   nav_params.common_params.url = GURL("data:text/html,world");
   nav_params.common_params.navigation_type = FrameMsg_Navigate_Type::NORMAL;
   nav_params.common_params.transition = ui::PAGE_TRANSITION_TYPED;
-  nav_params.current_history_list_length = 1;
-  nav_params.current_history_list_offset = 0;
-  nav_params.pending_history_list_offset = 1;
-  nav_params.page_id = -1;
+  nav_params.history_params.current_history_list_length = 1;
+  nav_params.history_params.current_history_list_offset = 0;
+  nav_params.history_params.pending_history_list_offset = 1;
+  nav_params.history_params.page_id = -1;
   nav_params.frame_to_navigate = "frame";
   nav_params.commit_params.browser_navigation_start =
       base::TimeTicks::FromInternalValue(1);
   frame()->OnNavigate(nav_params);
   FrameLoadWaiter(
       RenderFrame::FromWebFrame(frame()->GetWebFrame()->firstChild())).Wait();
 
   // Copy the document content to std::wstring and compare with the
   // expected result.
   const int kMaxOutputCharacters = 256;
@@ skipping 98 matching lines @@
 TEST_F(SuppressErrorPageTest, MAYBE_Suppresses) {
   WebURLError error;
   error.domain = WebString::fromUTF8(net::kErrorDomain);
   error.reason = net::ERR_FILE_NOT_FOUND;
   error.unreachableURL = GURL("http://example.com/suppress");
   WebLocalFrame* web_frame = GetMainFrame();
 
   // Start a load that will reach provisional state synchronously,
   // but won't complete synchronously.
   FrameMsg_Navigate_Params params;
-  params.page_id = -1;
+  params.history_params.page_id = -1;
   params.common_params.navigation_type = FrameMsg_Navigate_Type::NORMAL;
   params.common_params.url = GURL("data:text/html,test data");
   params.commit_params.browser_navigation_start =
       base::TimeTicks::FromInternalValue(1);
   frame()->OnNavigate(params);
 
   // An error occurred.
   view()->GetMainRenderFrame()->didFailProvisionalLoad(web_frame, error);
   const int kMaxOutputCharacters = 22;
   EXPECT_EQ("",
@@ skipping 10 matching lines @@
 TEST_F(SuppressErrorPageTest, MAYBE_DoesNotSuppress) {
   WebURLError error;
   error.domain = WebString::fromUTF8(net::kErrorDomain);
   error.reason = net::ERR_FILE_NOT_FOUND;
   error.unreachableURL = GURL("http://example.com/dont-suppress");
   WebLocalFrame* web_frame = GetMainFrame();
 
   // Start a load that will reach provisional state synchronously,
   // but won't complete synchronously.
   FrameMsg_Navigate_Params params;
-  params.page_id = -1;
+  params.history_params.page_id = -1;
   params.common_params.navigation_type = FrameMsg_Navigate_Type::NORMAL;
   params.common_params.url = GURL("data:text/html,test data");
   params.commit_params.browser_navigation_start =
       base::TimeTicks::FromInternalValue(1);
   frame()->OnNavigate(params);
 
   // An error occurred.
   view()->GetMainRenderFrame()->didFailProvisionalLoad(web_frame, error);
   // The error page itself is loaded asynchronously.
   FrameLoadWaiter(frame()).Wait();
@@ skipping 188 matching lines @@
 TEST_F(RenderViewImplTest, NavigationStartOverride) {
   // Verify that a navigation that claims to have started at the earliest
   // possible TimeTicks is indeed reported as one that started before
   // OnNavigate() is called.
   base::Time before_navigation = base::Time::Now();
   FrameMsg_Navigate_Params early_nav_params;
   early_nav_params.common_params.url = GURL("data:text/html,<div>Page</div>");
   early_nav_params.common_params.navigation_type =
       FrameMsg_Navigate_Type::NORMAL;
   early_nav_params.common_params.transition = ui::PAGE_TRANSITION_TYPED;
-  early_nav_params.page_id = -1;
+  early_nav_params.history_params.page_id = -1;
   early_nav_params.is_post = true;
   early_nav_params.commit_params.browser_navigation_start =
       base::TimeTicks::FromInternalValue(1);
 
   frame()->OnNavigate(early_nav_params);
   ProcessPendingMessages();
 
   base::Time early_nav_reported_start =
       base::Time::FromDoubleT(GetMainFrame()->performance().navigationStart());
   EXPECT_LT(early_nav_reported_start, before_navigation);
 
   // Verify that a navigation that claims to have started in the future - 42
   // days from now is *not* reported as one that starts in the future; as we
   // sanitize the override allowing a maximum of ::Now().
   FrameMsg_Navigate_Params late_nav_params;
   late_nav_params.common_params.url =
       GURL("data:text/html,<div>Another page</div>");
   late_nav_params.common_params.navigation_type =
       FrameMsg_Navigate_Type::NORMAL;
   late_nav_params.common_params.transition = ui::PAGE_TRANSITION_TYPED;
-  late_nav_params.page_id = -1;
+  late_nav_params.history_params.page_id = -1;
   late_nav_params.is_post = true;
   late_nav_params.commit_params.browser_navigation_start =
       base::TimeTicks::Now() + base::TimeDelta::FromDays(42);
 
   frame()->OnNavigate(late_nav_params);
   ProcessPendingMessages();
   base::Time after_navigation =
       base::Time::Now() + base::TimeDelta::FromDays(1);
 
   base::Time late_nav_reported_start =
       base::Time::FromDoubleT(GetMainFrame()->performance().navigationStart());
   EXPECT_LE(late_nav_reported_start, after_navigation);
 }
 
 TEST_F(RenderViewImplTest, PreferredSizeZoomed) {
   LoadHTML("<body style='margin:0;'><div style='display:inline-block; "
            "width:400px; height:400px;'/></body>");
   view()->webview()->mainFrame()->setCanHaveScrollbars(false);
   EnablePreferredSizeMode();
 
   gfx::Size size = GetPreferredSize();
   EXPECT_EQ(gfx::Size(400, 400), size);
 
   SetZoomLevel(ZoomFactorToZoomLevel(2.0));
   size = GetPreferredSize();
   EXPECT_EQ(gfx::Size(800, 800), size);
 }
 
+// Ensure the RenderViewImpl history list is properly updated when starting a
+// new browser-initiated navigation.
+TEST_F(RenderViewImplTest, HistoryIsProperlyUpdatedOnNavigation) {
+  EXPECT_EQ(0, view()->historyBackListCount());
+  EXPECT_EQ(0, view()->historyBackListCount() +
+      view()->historyForwardListCount() + 1);
+
+  // Receive a Navigate message with history parameters.
+  FrameMsg_Navigate_Params params;
+  params.common_params.navigation_type = FrameMsg_Navigate_Type::NORMAL;
+  params.common_params.transition = ui::PAGE_TRANSITION_LINK;
+  params.history_params.current_history_list_length = 2;
+  params.history_params.current_history_list_offset = 1;
+  params.history_params.pending_history_list_offset = 2;
+  params.history_params.page_id = -1;
+  params.commit_params.browser_navigation_start =
+      base::TimeTicks::FromInternalValue(1);
+  frame()->OnNavigate(params);
+
+  // The history list in RenderView should have been updated.
+  EXPECT_EQ(1, view()->historyBackListCount());
+  EXPECT_EQ(2, view()->historyBackListCount() +
+      view()->historyForwardListCount() + 1);
+}
+
 }  // namespace content