Remove WebContentsObserver::DidCommitNavigation

content/public/browser/web_contents_observer.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_PUBLIC_BROWSER_WEB_CONTENTS_OBSERVER_H_
 #define CONTENT_PUBLIC_BROWSER_WEB_CONTENTS_OBSERVER_H_
 
 #include "base/process/kill.h"
 #include "base/process/process_handle.h"
 #include "content/common/content_export.h"
@@ skipping 104 matching lines @@
   // been replaced is in |old_host|, which is nullptr if the old RVH was shut
   // down.
   virtual void RenderViewHostChanged(RenderViewHost* old_host,
                                      RenderViewHost* new_host) {}
 
   // Navigation related events ------------------------------------------------
 
   // Called when a navigation started in the WebContents. |navigation_handle|
   // is unique to a specific navigation. The same |navigation_handle| will be
   // provided on subsequent calls to
-  // DidRedirect/Commit/FinishNavigation/ReadyToCommitNavigation related to
-  // this navigation.
+  // DidRedirect/FinishNavigation/ReadyToCommitNavigation related to this
+  // navigation.
   //
   // Note that this is fired by navigations in any frame of the WebContents,
   // not just the main frame.
   //
   // Note that more than one navigation can be ongoing in the same frame at the
   // same time (including the main frame). Each will get its own
   // NavigationHandle.
   //
   // Note that there is no guarantee that DidFinishNavigation will be called
   // for any particular navigation before DidStartNavigation is called on the
   // next.
   virtual void DidStartNavigation(NavigationHandle* navigation_handle) {}
 
   // Called when a navigation encountered a server redirect.
   virtual void DidRedirectNavigation(NavigationHandle* navigation_handle) {}
 
   // PlzNavigate
-  // Called when the navigation is ready to be committed in a renderer. This is
-  // the first point in time where a RenderFrameHost is associated with the
-  // navigation. Observers that want to initialize any renderer side
-  // structures/state before the RenderFrame is navigated, should use this
-  // method as opposed to DidCommitNavigation, which is after the fact.
+  // Called when the navigation is ready to be committed in a renderer. Most
+  // observers should use DidFinishNavigation instead, which happens right
+  // after the navigation commits. This method is for observers that want to
+  // initialize renderer-side state just before the RenderFrame commits the
+  // navigation.
+  //
+  // This is the first point in time where a RenderFrameHost is associated with
+  // the navigation.
   virtual void ReadyToCommitNavigation(NavigationHandle* navigation_handle) {}
 
-  // Called when a navigation was committed.
-  virtual void DidCommitNavigation(NavigationHandle* navigation_handle) {}
+  // Called when a navigation finished in the WebContents. This happens when a
+  // navigation is committed, aborted or replaced by a new one. Note that

[Charlie Reis, 2015/09/21 16:40:42]

Please mention NavigationHandle's HasCommitted and IsErrorPage methods as a way
to tell the difference between these cases, since almost all users will need to
check them.

[clamy, 2015/09/22 00:38:05]

Done.

+  // |navigation_handle| will be destroyed at the end of this call, so do not
+  // keep a reference to it afterward.
+  // If this is called because the navigation committed, then the document load

[Charlie Reis, 2015/09/21 16:40:42]

nit: Add an empty comment line above this paragraph, similar to line 149.

[clamy, 2015/09/22 00:38:05]

Done.

+  // will still be ongoing in the RenderFrameHost returned by
+  // |navigation_handle|. Use the document loads events such as DidStopLoading
+  // and related methods to listen for continued events from this
+  // RenderFrameHost.
+  virtual void DidFinishNavigation(NavigationHandle* navigation_handle) {}
 
-  // Called when a navigation stopped in the WebContents. This happens when a
-  // navigation is either aborted, replaced by a new one, or the document load
-  // finishes. Note that |navigation_handle| will be destroyed at the end of
-  // this call, so do not keep a reference to it afterward.
-  virtual void DidFinishNavigation(NavigationHandle* navigation_handle) {}
+  // Document load events ------------------------------------------------------
+
+  // These two methods correspond to the points in time when the spinner of the
+  // tab starts and stops spinning.
+  virtual void DidStartLoading() {}
+  virtual void DidStopLoading() {}
+
+  // This method is invoked once the window.document object of the main frame
+  // was created.
+  virtual void DocumentAvailableInMainFrame() {}
+
+  // This method is invoked once the onload handler of the main frame has
+  // completed.
+  virtual void DocumentOnLoadCompletedInMainFrame() {}
+
+  // This method is invoked when the document in the given frame finished
+  // loading. At this point, scripts marked as defer were executed, and
+  // content scripts marked "document_end" get injected into the frame.
+  virtual void DocumentLoadedInFrame(RenderFrameHost* render_frame_host) {}
+
+  // This method is invoked when the navigation is done, i.e. the spinner of
+  // the tab will stop spinning, and the onload event was dispatched.
+  //
+  // If the WebContents is displaying replacement content, e.g. network error
+  // pages, DidFinishLoad is invoked for frames that were not sending
+  // navigational events before. It is safe to ignore these events.
+  virtual void DidFinishLoad(RenderFrameHost* render_frame_host,
+                             const GURL& validated_url) {}
+
+  // This method is like DidFinishLoad, but when the load failed or was
+  // cancelled, e.g. window.stop() is invoked.
+  virtual void DidFailLoad(RenderFrameHost* render_frame_host,
+                           const GURL& validated_url,
+                           int error_code,
+                           const base::string16& error_description,
+                           bool was_ignored_by_handler) {}
 
   // ---------------------------------------------------------------------------
 
   // This method is invoked after the WebContents decides which RenderFrameHost
   // to use for the next browser-initiated navigation, but before the navigation
   // starts.  It is not called for most renderer-initiated navigations, and it
   // does not guarantee that the navigation will commit (e.g., 204s, downloads).
   //
   // DEPRECATED.  This method is difficult to use correctly and should be
   // removed.  TODO(creis): Remove in http://crbug.com/424641.
@@ skipping 57 matching lines @@
       const FrameNavigateParams& params) {}
 
   // This method is invoked when the SecurityStyle of the WebContents changes.
   // |security_style| is the new SecurityStyle. |security_style_explanations|
   // contains human-readable strings explaining why the SecurityStyle of the
   // page has been downgraded.
   virtual void SecurityStyleChanged(
       SecurityStyle security_style,
       const SecurityStyleExplanations& security_style_explanations) {}
 
-  // This method is invoked once the window.document object of the main frame
-  // was created.
-  virtual void DocumentAvailableInMainFrame() {}
-
-  // This method is invoked once the onload handler of the main frame has
-  // completed.
-  virtual void DocumentOnLoadCompletedInMainFrame() {}
-
-  // This method is invoked when the document in the given frame finished
-  // loading. At this point, scripts marked as defer were executed, and
-  // content scripts marked "document_end" get injected into the frame.
-  virtual void DocumentLoadedInFrame(RenderFrameHost* render_frame_host) {}
-
-  // This method is invoked when the navigation is done, i.e. the spinner of
-  // the tab will stop spinning, and the onload event was dispatched.
-  //
-  // If the WebContents is displaying replacement content, e.g. network error
-  // pages, DidFinishLoad is invoked for frames that were not sending
-  // navigational events before. It is safe to ignore these events.
-  virtual void DidFinishLoad(RenderFrameHost* render_frame_host,
-                             const GURL& validated_url) {}
-
-  // This method is like DidFinishLoad, but when the load failed or was
-  // cancelled, e.g. window.stop() is invoked.
-  virtual void DidFailLoad(RenderFrameHost* render_frame_host,
-                           const GURL& validated_url,
-                           int error_code,
-                           const base::string16& error_description,
-                           bool was_ignored_by_handler) {}
-
   // This method is invoked when content was loaded from an in-memory cache.
   virtual void DidLoadResourceFromMemoryCache(
       const LoadFromMemoryCacheDetails& details) {}
 
   // This method is invoked when a response has been received for a resource
   // request.
   virtual void DidGetResourceResponseStart(
       const ResourceRequestDetails& details) {}
 
   // This method is invoked when a redirect was received while requesting a
@@ skipping 17 matching lines @@
                                    RenderFrameHost* source_render_frame_host,
                                    const GURL& url,
                                    const Referrer& referrer,
                                    WindowOpenDisposition disposition,
                                    ui::PageTransition transition) {}
 
   // This method is invoked when the renderer process has completed its first
   // paint after a non-empty layout.
   virtual void DidFirstVisuallyNonEmptyPaint() {}
 
-  // These two methods correspond to the points in time when the spinner of the
-  // tab starts and stops spinning.
-  virtual void DidStartLoading() {}
-  virtual void DidStopLoading() {}
-
   // When WebContents::Stop() is called, the WebContents stops loading and then
   // invokes this method. If there are ongoing navigations, their respective
   // failure methods will also be invoked.
   virtual void NavigationStopped() {}
 
   // This indicates that the next navigation was triggered by a user gesture.
   virtual void DidGetUserGesture() {}
 
   // This method is invoked when a RenderViewHost of this WebContents was
   // configured to ignore UI events, and an UI event took place.
@@ skipping 135 matching lines @@
   void ResetWebContents();
 
   WebContentsImpl* web_contents_;
 
   DISALLOW_COPY_AND_ASSIGN(WebContentsObserver);
 };
 
 }  // namespace content
 
 #endif  // CONTENT_PUBLIC_BROWSER_WEB_CONTENTS_OBSERVER_H_