[DevTools] Rework RFDTAH navigation tracking with browser side navigation

content/browser/devtools/render_frame_devtools_agent_host.h

 // 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.
 
 #ifndef CONTENT_BROWSER_DEVTOOLS_RENDER_FRAME_DEVTOOLS_AGENT_HOST_H_
 #define CONTENT_BROWSER_DEVTOOLS_RENDER_FRAME_DEVTOOLS_AGENT_HOST_H_
 
 #include <map>
 #include <memory>
+#include <unordered_set>
 
 #include "base/compiler_specific.h"
 #include "base/macros.h"
 #include "build/build_config.h"
 #include "content/browser/devtools/devtools_agent_host_impl.h"
 #include "content/common/content_export.h"
 #include "content/public/browser/web_contents_observer.h"
 #include "net/base/net_errors.h"
 
 #if defined(OS_ANDROID)
 #include "ui/android/view_android.h"
 #endif  // OS_ANDROID
 
 namespace cc {
 class CompositorFrameMetadata;
 }
 
 #if defined(OS_ANDROID)
 #include "device/wake_lock/public/interfaces/wake_lock.mojom.h"
 #endif
 
 namespace content {
 
 class BrowserContext;
 class DevToolsFrameTraceRecorder;
 class FrameTreeNode;
 class NavigationHandle;
+class NavigationHandleImpl;
 class NavigationThrottle;
 class RenderFrameHostImpl;
 struct BeginNavigationParams;
 struct CommonNavigationParams;
 
 class CONTENT_EXPORT RenderFrameDevToolsAgentHost
     : public DevToolsAgentHostImpl,
       private WebContentsObserver {
  public:
   static void AddAllAgentHosts(DevToolsAgentHost::List* result);
   static scoped_refptr<DevToolsAgentHost> GetOrCreateFor(
       FrameTreeNode* frame_tree_node);
 
   static void OnCancelPendingNavigation(RenderFrameHost* pending,
                                         RenderFrameHost* current);
   static void OnBeforeNavigation(RenderFrameHost* current,
                                  RenderFrameHost* pending);
-  static void OnBeforeNavigation(NavigationHandle* navigation_handle);
   static void OnFailedNavigation(RenderFrameHost* host,
                                  const CommonNavigationParams& common_params,
                                  const BeginNavigationParams& begin_params,
                                  net::Error error_code);
   static std::unique_ptr<NavigationThrottle> CreateThrottleForNavigation(
       NavigationHandle* navigation_handle);
   static bool IsNetworkHandlerEnabled(FrameTreeNode* frame_tree_node);
   static std::string UserAgentOverride(FrameTreeNode* frame_tree_node);
 
   static void WebContentsCreated(WebContents* web_contents);
@@ skipping 28 matching lines @@
 
   // DevToolsAgentHostImpl overrides.
   void AttachSession(DevToolsSession* session) override;
   void DetachSession(int session_id) override;
   void InspectElement(DevToolsSession* session, int x, int y) override;
   bool DispatchProtocolMessage(
       DevToolsSession* session,
       const std::string& message) override;
 
   // WebContentsObserver overrides.
+  void DidStartNavigation(NavigationHandle* navigation_handle) override;
   void ReadyToCommitNavigation(NavigationHandle* navigation_handle) override;
   void DidFinishNavigation(NavigationHandle* navigation_handle) override;
   void RenderFrameHostChanged(RenderFrameHost* old_host,
                               RenderFrameHost* new_host) override;
   void FrameDeleted(RenderFrameHost* rfh) override;
   void RenderFrameDeleted(RenderFrameHost* rfh) override;
   void RenderProcessGone(base::TerminationStatus status) override;
   bool OnMessageReceived(const IPC::Message& message,
                          RenderFrameHost* render_frame_host) override;
   void DidAttachInterstitialPage() override;
   void DidDetachInterstitialPage() override;
   void WasShown() override;
   void WasHidden() override;
   void DidReceiveCompositorFrame() override;
 
   void AboutToNavigateRenderFrame(RenderFrameHost* old_host,
                                   RenderFrameHost* new_host);
-  void AboutToNavigate(NavigationHandle* navigation_handle);
-  void OnFailedNavigation(const CommonNavigationParams& common_params,
-                          const BeginNavigationParams& begin_params,
-                          net::Error error_code);
-
-  void DispatchBufferedProtocolMessagesIfNecessary();
 
   void SetPending(RenderFrameHostImpl* host);
   void CommitPending();
   void DiscardPending();
   void UpdateProtocolHandlers(RenderFrameHostImpl* host);
 
   bool IsChildFrame();
 
   void OnClientAttached();
   void OnClientDetached();
 
   void RenderFrameCrashed();
   void OnSwapCompositorFrame(const IPC::Message& message);
   void OnDispatchOnInspectorFrontend(
       RenderFrameHost* sender,
       const DevToolsMessageChunk& message);
   void OnRequestNewWindow(RenderFrameHost* sender, int new_routing_id);
   void DestroyOnRenderFrameGone();
 
   bool CheckConsistency();
+  void UpdateFrameHost(RenderFrameHostImpl* frame_host);
+  void MaybeReattachToRenderFrame();
+  void SendMessageFromProcessor(int session_id, const std::string& message);
+  void GrantPolicy(RenderFrameHostImpl* host);
+  void RevokePolicy(RenderFrameHostImpl* host);
 
 #if defined(OS_ANDROID)
   device::mojom::WakeLock* GetWakeLock();
 #endif
 
   void SynchronousSwapCompositorFrame(
       cc::CompositorFrameMetadata frame_metadata);
 
   class FrameHostHolder;
 
   std::unique_ptr<FrameHostHolder> current_;
   std::unique_ptr<FrameHostHolder> pending_;
 
   // Stores per-host state between DisconnectWebContents and ConnectWebContents.
   std::string disconnected_cookie_;
 
   std::unique_ptr<DevToolsFrameTraceRecorder> frame_trace_recorder_;
 #if defined(OS_ANDROID)
   device::mojom::WakeLockPtr wake_lock_;
 #endif
   RenderFrameHostImpl* handlers_frame_host_;
   bool current_frame_crashed_;
 
   // PlzNavigate
 
-  // Handle that caused the setting of pending_.
-  NavigationHandle* pending_handle_;
-
-  // List of handles currently navigating.
-  std::set<NavigationHandle*> navigating_handles_;
-
-  struct PendingMessage {
+  // The active host we are talking to.
+  RenderFrameHostImpl* frame_host_ = nullptr;
+  struct Message {
     int session_id;
     std::string method;
     std::string message;
   };
-  // <call_id> -> PendingMessage
-  std::map<int, PendingMessage> in_navigation_protocol_message_buffer_;
+  // Chunk processor's state cookie always corresponds to a state before
+  // any of the suspended or waiting for response messages have been handled.
+  DevToolsMessageChunkProcessor chunk_processor_;
+  std::unordered_set<NavigationHandleImpl*> navigation_handles_;
+  bool render_frame_alive_ = false;
+  // These messages were sent before suspending, but their result have not been
+  // received yet, and state cookie has not been updated.
+  std::map<int, Message> waiting_for_response_messages_;
+  // These messages were queued after suspending, not sent to the agent,
+  // and will be sent after resuming.
+  std::map<int, Message> suspended_messages_;
 
   // The FrameTreeNode associated with this agent.
   FrameTreeNode* frame_tree_node_;
 
   DISALLOW_COPY_AND_ASSIGN(RenderFrameDevToolsAgentHost);
 };
 
 }  // namespace content
 
 #endif  // CONTENT_BROWSER_DEVTOOLS_RENDER_FRAME_DEVTOOLS_AGENT_HOST_H_