Refactor the implementation of the webNavigation extension API.

chrome/browser/extensions/api/web_navigation/frame_navigation_state.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 CHROME_BROWSER_EXTENSIONS_API_WEB_NAVIGATION_FRAME_NAVIGATION_STATE_H_
 #define CHROME_BROWSER_EXTENSIONS_API_WEB_NAVIGATION_FRAME_NAVIGATION_STATE_H_
 
 #include <map>
 #include <set>
 
 #include "base/compiler_specific.h"
 #include "base/macros.h"
 #include "url/gurl.h"
 
 namespace content {
 class RenderFrameHost;
 class RenderViewHost;
 }
 
 namespace extensions {
 
 // Tracks the navigation state of all frame hosts in a given tab currently known
 // to the webNavigation API. It is mainly used to track in which frames an error
 // occurred so no further events for this frame are being sent.
 class FrameNavigationState {

[nasko, 2016/02/05 17:49:30]

I renamed this into FrameLoadingState in my big CL, but decided it isn't worth
the churn in this one. I will rename it as a follow up, to ensure it properly
reflects its new semantics.

  public:
   typedef std::set<content::RenderFrameHost*>::const_iterator const_iterator;
 
   FrameNavigationState();
   ~FrameNavigationState();
 
   // True if in general webNavigation events may be sent for the given URL.
   static bool IsValidUrl(const GURL& url);
 
   // Use these to iterate over all frame hosts known by this object.
   const_iterator begin() const { return frame_hosts_.begin(); }
   const_iterator end() const { return frame_hosts_.end(); }
 
   // True if navigation events for the given frame can be sent.
   bool CanSendEvents(content::RenderFrameHost* frame_host) const;
 
   // Starts to track a navigation in |frame_host| to |url|.
-  void StartTrackingNavigation(content::RenderFrameHost* frame_host,
-                               const GURL& url,
-                               bool is_error_page,
-                               bool is_iframe_srcdoc);
+  void StartTrackingDocumentLoad(content::RenderFrameHost* frame_host,
+                                 const GURL& url,
+                                 bool is_same_page,
+                                 bool is_error_page,
+                                 bool is_iframe_srcdoc);
 
   // Adds the |frame_host| to the set of RenderFrameHosts associated with the
   // WebContents this object is tracking. This method and FrameHostDeleted
   // are used to track the set of current RenderFrameHosts, which is used to
   // implement the GetFrame and GetAllFrames extension APIs.
   void FrameHostCreated(content::RenderFrameHost* frame_host);
 
   // Removes the |frame_host| from the set of RenderFrameHosts associated with
   // the WebContents this object is tracking.
   void FrameHostDeleted(content::RenderFrameHost* frame_host);
@@ skipping 22 matching lines @@
 
   // True if |frame_host| is currently not navigating.
   bool GetNavigationCompleted(content::RenderFrameHost* frame_host) const;
 
   // Marks |frame_host| as having finished parsing.
   void SetParsingFinished(content::RenderFrameHost* frame_host);
 
   // True if |frame_host| has finished parsing.
   bool GetParsingFinished(content::RenderFrameHost* frame_host) const;
 
-  // Marks |frame_host| as having committed its navigation, i.e. the onCommitted
-  // event was fired for this frame.
-  void SetNavigationCommitted(content::RenderFrameHost* frame_host);
-
-  // True if |frame_host| has committed its navigation.
-  bool GetNavigationCommitted(content::RenderFrameHost* frame_host) const;
-
-  // Marks |frame_host| as redirected by the server.
-  void SetIsServerRedirected(content::RenderFrameHost* frame_host);
-
-  // True if |frame_host| was redirected by the server.
-  bool GetIsServerRedirected(content::RenderFrameHost* frame_host) const;
-
 #ifdef UNIT_TEST
   static void set_allow_extension_scheme(bool allow_extension_scheme) {
     allow_extension_scheme_ = allow_extension_scheme;
   }
 #endif
 
  private:
   struct FrameState {
     FrameState();
 
     bool error_occurred;  // True if an error has occurred in this frame.
     bool is_iframe_srcdoc;  // True if the frame is displaying its srcdoc.
-    bool is_navigating;  // True if there is a navigation going on.
-    bool is_committed;  // True if the navigation is already committed.
-    bool is_server_redirected;  // True if a server redirect happened.
+    bool is_loading;        // True if there is a navigation going on.

[Devlin, 2016/02/05 18:30:28]

this comment is weird, given that this is set to true from
DidFinishNavigation().  I think we should change it.  (See also other comment in
DidFinishNavigation)

[nasko, 2016/02/05 23:41:22]

In general, the model we want to move to is have clear separation between the
different stages of a "navigation". The navigation stage - the resource request
until commit time, and the document loading stage - once we've committed and
started parsing the document, until all subresource/subframe loads are complete.

I missed updating the comment.

     bool is_parsing;  // True if the frame is still parsing.
     GURL url;  // URL of this frame.
   };
   typedef std::map<content::RenderFrameHost*, FrameState> FrameHostToStateMap;
 
   // Tracks the state of known frame hosts.
   FrameHostToStateMap frame_host_state_map_;
 
   // Set of all known frame hosts.
   std::set<content::RenderFrameHost*> frame_hosts_;
 
   // If true, also allow events from chrome-extension:// URLs.
   static bool allow_extension_scheme_;
 
   DISALLOW_COPY_AND_ASSIGN(FrameNavigationState);
 };
 
 }  // namespace extensions
 
 #endif  // CHROME_BROWSER_EXTENSIONS_API_WEB_NAVIGATION_FRAME_NAVIGATION_STATE_H_