PlzNavigate: implement CommitNavigation on the browser side

content/common/frame_messages.h

 // 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.
 
 // IPC messages for interacting with frames.
 // Multiply-included message file, hence no include guard.
 
 #include "content/common/content_export.h"
 #include "content/common/content_param_traits.h"
 #include "content/common/frame_message_enums.h"
 #include "content/common/frame_param.h"
 #include "content/common/navigation_gesture.h"
+#include "content/common/navigation_params.h"
 #include "content/common/resource_request_body.h"
 #include "content/public/common/color_suggestion.h"
 #include "content/public/common/common_param_traits.h"
 #include "content/public/common/context_menu_params.h"
 #include "content/public/common/frame_navigate_params.h"
 #include "content/public/common/javascript_message_type.h"
 #include "content/public/common/page_state.h"
 #include "ipc/ipc_message_macros.h"
 #include "ui/gfx/ipc/gfx_param_traits.h"
 #include "url/gurl.h"
@@ skipping 139 matching lines @@
   // We need to track the RenderViewHost routing_id because of downstream
   // dependencies (crbug.com/392171 DownloadRequestHandle, SaveFileManager,
   // ResourceDispatcherHostImpl, MediaStreamUIProxy,
   // SpeechRecognitionDispatcherHost and possibly others). They look up the view
   // based on the ID stored in the resource requests. Once those dependencies
   // are unwound or moved to RenderFrameHost (crbug.com/304341) we can move the
   // client to be based on the routing_id of the RenderFrameHost.
   IPC_STRUCT_MEMBER(int, render_view_routing_id)
 IPC_STRUCT_END()
 
+IPC_STRUCT_TRAITS_BEGIN(content::CoreNavigationParams)
+  IPC_STRUCT_TRAITS_MEMBER(url)
+  IPC_STRUCT_TRAITS_MEMBER(referrer)
+  IPC_STRUCT_TRAITS_MEMBER(transition)
+  IPC_STRUCT_TRAITS_MEMBER(navigation_type)
+  IPC_STRUCT_TRAITS_MEMBER(allow_download)
+IPC_STRUCT_TRAITS_END()
+
+IPC_STRUCT_TRAITS_BEGIN(content::RequestNavigationParams)
+  IPC_STRUCT_TRAITS_MEMBER(is_post)
+  IPC_STRUCT_TRAITS_MEMBER(extra_headers)
+  IPC_STRUCT_TRAITS_MEMBER(browser_initiated_post_data)
+IPC_STRUCT_TRAITS_END()
+
+IPC_STRUCT_TRAITS_BEGIN(content::CommitNavigationParams)
+  IPC_STRUCT_TRAITS_MEMBER(page_id)
+  IPC_STRUCT_TRAITS_MEMBER(should_clear_history_list)
+  IPC_STRUCT_TRAITS_MEMBER(pending_history_list_offset)
+  IPC_STRUCT_TRAITS_MEMBER(current_history_list_offset)
+  IPC_STRUCT_TRAITS_MEMBER(current_history_list_length)
+  IPC_STRUCT_TRAITS_MEMBER(page_state)
+  IPC_STRUCT_TRAITS_MEMBER(is_overriding_user_agent)
+  IPC_STRUCT_TRAITS_MEMBER(browser_navigation_start)
+IPC_STRUCT_TRAITS_END()
+
 IPC_STRUCT_BEGIN(FrameMsg_Navigate_Params)
-  // The page_id for this navigation, or -1 if it is a new navigation.  Back,
-  // Forward, and Reload navigations should have a valid page_id.  If the load
-  // succeeds, then this page_id will be reflected in the resultant
-  // FrameHostMsg_DidCommitProvisionalLoad message.
-  IPC_STRUCT_MEMBER(int32, page_id)
+  // TODO(clamy): investigate which parameters are also needed in PlzNavigate
+  // and move them to the appropriate NavigationParams struct.
 
-  // If page_id is -1, then pending_history_list_offset will also be -1.
-  // Otherwise, it contains the offset into the history list corresponding to
-  // the current navigation.
-  IPC_STRUCT_MEMBER(int, pending_history_list_offset)
-
-  // Informs the RenderView of where its current page contents reside in
-  // session history and the total size of the session history list.
-  IPC_STRUCT_MEMBER(int, current_history_list_offset)
-  IPC_STRUCT_MEMBER(int, current_history_list_length)
-
-  // Informs the RenderView the session history should be cleared. In that
-  // case, the RenderView needs to notify the browser that the clearing was
-  // succesful when the navigation commits.
-  IPC_STRUCT_MEMBER(bool, should_clear_history_list)
-
-  // The URL to load.
-  IPC_STRUCT_MEMBER(GURL, url)
+  // These structs contain parameters shared by other navigation IPCs.
+  IPC_STRUCT_MEMBER(content::CoreNavigationParams, core_params)
+  IPC_STRUCT_MEMBER(content::RequestNavigationParams, request_params)
+  IPC_STRUCT_MEMBER(content::CommitNavigationParams, commit_params)
 
   // Base URL for use in WebKit's SubstituteData.
   // Is only used with data: URLs.
   IPC_STRUCT_MEMBER(GURL, base_url_for_data_url)
 
   // History URL for use in WebKit's SubstituteData.
   // Is only used with data: URLs.
   IPC_STRUCT_MEMBER(GURL, history_url_for_data_url)
 
-  // The URL to send in the "Referer" header field. Can be empty if there is
-  // no referrer.
-  IPC_STRUCT_MEMBER(content::Referrer, referrer)
-
   // Any redirect URLs that occurred before |url|. Useful for cross-process
   // navigations; defaults to empty.
   IPC_STRUCT_MEMBER(std::vector<GURL>, redirects)
 
-  // The type of transition.
-  IPC_STRUCT_MEMBER(content::PageTransition, transition)
-
   // Informs the RenderView the pending navigation should replace the current
   // history entry when it commits. This is used for cross-process redirects so
   // the transferred navigation can recover the navigation state.
   IPC_STRUCT_MEMBER(bool, should_replace_current_entry)
 
-  // Opaque history state (received by ViewHostMsg_UpdateState).
-  IPC_STRUCT_MEMBER(content::PageState, page_state)
-
-  // Type of navigation.
-  IPC_STRUCT_MEMBER(FrameMsg_Navigate_Type::Value, navigation_type)
-
   // The time the request was created. This is used by the old performance
   // infrastructure to set up DocumentState associated with the RenderView.
   // TODO(ppi): make it go away.
   IPC_STRUCT_MEMBER(base::Time, request_time)
 
-  // Extra headers (separated by \n) to send during the request.
-  IPC_STRUCT_MEMBER(std::string, extra_headers)
-
   // The following two members identify a previous request that has been
   // created before this navigation is being transferred to a new render view.
   // This serves the purpose of recycling the old request.
   // Unless this refers to a transferred navigation, these values are -1 and -1.
   IPC_STRUCT_MEMBER(int, transferred_request_child_id)
   IPC_STRUCT_MEMBER(int, transferred_request_request_id)
 
-  // Whether or not we should allow the url to download.
-  IPC_STRUCT_MEMBER(bool, allow_download)
-
-  // Whether or not the user agent override string should be used.
-  IPC_STRUCT_MEMBER(bool, is_overriding_user_agent)
-
-  // True if this was a post request.
-  IPC_STRUCT_MEMBER(bool, is_post)
-
-  // If is_post is true, holds the post_data information from browser. Empty
-  // otherwise.
-  IPC_STRUCT_MEMBER(std::vector<unsigned char>, browser_initiated_post_data)
-
   // Whether or not this url should be allowed to access local file://
   // resources.
   IPC_STRUCT_MEMBER(bool, can_load_local_resources)
 
   // If not empty, which frame to navigate.
   IPC_STRUCT_MEMBER(std::string, frame_to_navigate)
-
-  // The navigationStart time to expose through the Navigation Timing API to JS.
-  IPC_STRUCT_MEMBER(base::TimeTicks, browser_navigation_start)
 IPC_STRUCT_END()
 
 IPC_STRUCT_BEGIN(FrameHostMsg_OpenURL_Params)
   IPC_STRUCT_MEMBER(GURL, url)
   IPC_STRUCT_MEMBER(content::Referrer, referrer)
   IPC_STRUCT_MEMBER(WindowOpenDisposition, disposition)
   IPC_STRUCT_MEMBER(bool, should_replace_current_entry)
   IPC_STRUCT_MEMBER(bool, user_gesture)
 IPC_STRUCT_END()
 
 // PlzNavigate
 IPC_STRUCT_BEGIN(FrameHostMsg_BeginNavigation_Params)
+  // TODO(clamy): See if it possible to define acommon struct between this IPC

[Charlie Reis, 2014/09/19 23:12:32]

nits: it is, a common

[clamy, 2014/09/23 21:13:26]

Done.

+  // and ResourceMsg_Request_Params.
+
   // The request method: GET, POST, etc.
   IPC_STRUCT_MEMBER(std::string, method)
 
-  // The requested URL.
-  IPC_STRUCT_MEMBER(GURL, url)
-
-  // The referrer to use (may be empty).
-  IPC_STRUCT_MEMBER(content::Referrer, referrer)
-
   // Additional HTTP request headers.
   IPC_STRUCT_MEMBER(std::string, headers)
 
   // net::URLRequest load flags (net::LOAD_NORMAL) by default).
   IPC_STRUCT_MEMBER(int, load_flags)
 
   // Optional resource request body (may be null).
   IPC_STRUCT_MEMBER(scoped_refptr<content::ResourceRequestBody>,
                     request_body)
 
   // True if the request was user initiated.
   IPC_STRUCT_MEMBER(bool, has_user_gesture)
-
-  IPC_STRUCT_MEMBER(content::PageTransition, transition_type)
-
-  // Whether this navigation should replace the current session history entry on
-  // commit.
-  IPC_STRUCT_MEMBER(bool, should_replace_current_entry)
-
-  // Whether or not we should allow the URL to download.
-  IPC_STRUCT_MEMBER(bool, allow_download)
 IPC_STRUCT_END()
 
 #if defined(OS_MACOSX) || defined(OS_ANDROID)
 // This message is used for supporting popup menus on Mac OS X and Android using
 // native controls. See the FrameHostMsg_ShowPopup message.
 IPC_STRUCT_BEGIN(FrameHostMsg_ShowPopup_Params)
   // Position on the screen.
   IPC_STRUCT_MEMBER(gfx::Rect, bounds)
 
   // The height of each item in the menu.
@@ skipping 66 matching lines @@
 // |routing_id|. The new proxy should be created as a child of the object
 // identified by |parent_routing_id| or as top level if that is
 // MSG_ROUTING_NONE.
 IPC_MESSAGE_CONTROL3(FrameMsg_NewFrameProxy,
                      int /* routing_id */,
                      int /* parent_routing_id */,
                      int /* render_view_routing_id */)
 
 // Tells the renderer to perform the specified navigation, interrupting any
 // existing navigation.
-IPC_MESSAGE_ROUTED1(FrameMsg_Navigate, FrameMsg_Navigate_Params)
+IPC_MESSAGE_ROUTED1(FrameMsg_Navigate , FrameMsg_Navigate_Params)

[nasko, 2014/09/22 23:13:03]

nit: extra space before the comma

[clamy, 2014/09/23 21:13:26]

Done.

 
 // Instructs the renderer to invoke the frame's beforeunload event handler.
 // Expects the result to be returned via FrameHostMsg_BeforeUnload_ACK.
 IPC_MESSAGE_ROUTED0(FrameMsg_BeforeUnload)
 
 // Instructs the frame to swap out for a cross-site transition, including
 // running the unload event handler and creating a RenderFrameProxy with the
 // given |proxy_routing_id|. Expects a SwapOut_ACK message when finished.
 IPC_MESSAGE_ROUTED1(FrameMsg_SwapOut,
                     int /* proxy_routing_id */)
@@ skipping 78 matching lines @@
                     std::vector<int> /* selected indices */)
 
 #elif defined(OS_MACOSX)
 
 // External popup menus.
 IPC_MESSAGE_ROUTED1(FrameMsg_SelectPopupMenuItem,
                     int /* selected index, -1 means no selection */)
 
 #endif
 
+// PlzNavigate
+// Tells the renderer that a navigation is ready to commit.
+// The renderer should request the url to get access to the stream containing

[Charlie Reis, 2014/09/19 23:12:32]

should request |stream_url| to get

[clamy, 2014/09/23 21:13:26]

Done.

+// the body of the response.
+IPC_MESSAGE_ROUTED3(FrameMsg_CommitNavigation,
+                    GURL,

[Charlie Reis, 2014/09/19 23:12:32]

Please name these params, as in the other messages (e.g., /* stream_url */).

[clamy, 2014/09/23 21:13:26]

Done.

+                    content::CoreNavigationParams,
+                    content::CommitNavigationParams)
+
 // -----------------------------------------------------------------------------
 // Messages sent from the renderer to the browser.
 
 // Blink and JavaScript error messages to log to the console
 // or debugger UI.
 IPC_MESSAGE_ROUTED4(FrameHostMsg_AddMessageToConsole,
                     int32, /* log level */
                     base::string16, /* msg */
                     int32, /* line number */
                     base::string16 /* source id */ )
@@ skipping 256 matching lines @@
                     size_t /* endOffset */)
 
 // Notifies the browser that the renderer has a pending navigation transition.
 // The string parameters are all UTF8.
 IPC_MESSAGE_CONTROL4(FrameHostMsg_AddNavigationTransitionData,
                      int /* render_frame_id */,
                      std::string  /* allowed_destination_host_pattern */,
                      std::string  /* selector */,
                      std::string  /* markup */)
 
+// PlzNavigate
 // Tells the browser to perform a navigation.
-IPC_MESSAGE_ROUTED1(FrameHostMsg_BeginNavigation,
-                    FrameHostMsg_BeginNavigation_Params)
+IPC_MESSAGE_ROUTED2(FrameHostMsg_BeginNavigation,
+                    FrameHostMsg_BeginNavigation_Params,
+                    content::CoreNavigationParams)
 
 // Sent once a paint happens after the first non empty layout. In other words
 // after the frame has painted something.
 IPC_MESSAGE_ROUTED0(FrameHostMsg_DidFirstVisuallyNonEmptyPaint)
 
 #if defined(OS_MACOSX) || defined(OS_ANDROID)
 
 // Message to show/hide a popup menu using native controls.
 IPC_MESSAGE_ROUTED1(FrameHostMsg_ShowPopup,
                     FrameHostMsg_ShowPopup_Params)
 IPC_MESSAGE_ROUTED0(FrameHostMsg_HidePopup)
 
 #endif