Report page load timing information for child frames.

chrome/browser/page_load_metrics/page_load_metrics_observer.h

 // Copyright 2015 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_PAGE_LOAD_METRICS_PAGE_LOAD_METRICS_OBSERVER_H_
 #define CHROME_BROWSER_PAGE_LOAD_METRICS_PAGE_LOAD_METRICS_OBSERVER_H_
 
 #include <memory>
 #include <string>
 
@@ skipping 105 matching lines @@
       const base::Optional<base::TimeDelta>& first_foreground_time,
       bool started_in_foreground,
       UserInitiatedInfo user_initiated_info,
       const GURL& url,
       const GURL& start_url,
       bool did_commit,
       PageEndReason page_end_reason,
       UserInitiatedInfo page_end_user_initiated_info,
       const base::Optional<base::TimeDelta>& page_end_time,
       const PageLoadMetadata& main_frame_metadata,
-      const PageLoadMetadata& child_frame_metadata);
+      const PageLoadMetadata& subframe_metadata);
 
   // Simplified version of the constructor, intended for use in tests.
   static PageLoadExtraInfo CreateForTesting(const GURL& url,
                                             bool started_in_foreground);
 
   PageLoadExtraInfo(const PageLoadExtraInfo& other);
 
   ~PageLoadExtraInfo();
 
   // The time the navigation was initiated.
@@ skipping 50 matching lines @@
   // * the render process hosting the page goes away
   // * a new navigation which later commits is initiated in the same tab
   // This field will not be set if the page is still active and hasn't yet
   // finished.
   const base::Optional<base::TimeDelta> page_end_time;
 
   // Extra information supplied to the page load metrics system from the
   // renderer for the main frame.
   const PageLoadMetadata main_frame_metadata;
 
-  // PageLoadMetadata for child frames of the current page load.
-  const PageLoadMetadata child_frame_metadata;
+  // PageLoadMetadata for subframes of the current page load.
+  const PageLoadMetadata subframe_metadata;
 };
 
 // Container for various information about a completed request within a page
 // load.
 struct ExtraRequestCompleteInfo {
   ExtraRequestCompleteInfo(
       const GURL& url,
       int frame_tree_node_id,
       bool was_cached,
       int64_t raw_body_bytes,
@@ skipping 54 matching lines @@
   // callbacks to indicate whether the observer would like to continue observing
   // metric callbacks. Observers that wish to continue observing metric
   // callbacks should return CONTINUE_OBSERVING; observers that wish to stop
   // observing callbacks should return STOP_OBSERVING. Observers that return
   // STOP_OBSERVING may be deleted.
   enum ObservePolicy {
     CONTINUE_OBSERVING,
     STOP_OBSERVING,
   };
 
+  using FrameTreeNodeId = int;
+
   virtual ~PageLoadMetricsObserver() {}
 
   // The page load started, with the given navigation handle.
   // currently_committed_url contains the URL of the committed page load at the
   // time the navigation for navigation_handle was initiated, or the empty URL
   // if there was no committed page load at the time the navigation was
   // initiated.
   virtual ObservePolicy OnStart(content::NavigationHandle* navigation_handle,
                                 const GURL& currently_committed_url,
                                 bool started_in_foreground);
@@ skipping 45 matching lines @@
   // callbacks below.
 
   // OnTimingUpdate is triggered when an updated PageLoadTiming is
   // available. This method may be called multiple times over the course of the
   // page load. This method is currently only intended for use in testing. Most
   // implementers should implement one of the On* callbacks, such as
   // OnFirstContentfulPaint or OnDomContentLoadedEventStart. Please email
   // loading-dev@chromium.org if you intend to override this method.
   virtual void OnTimingUpdate(const PageLoadTiming& timing,
                               const PageLoadExtraInfo& extra_info) {}
+
   // OnUserInput is triggered when a new user input is passed in to
   // web_contents. Contains a TimeDelta from navigation start.
   virtual void OnUserInput(const blink::WebInputEvent& event) {}
 
   // The following methods are invoked at most once, when the timing for the
   // associated event first becomes available.
   virtual void OnDomContentLoadedEventStart(
       const PageLoadTiming& timing,
       const PageLoadExtraInfo& extra_info) {}
   virtual void OnLoadEventStart(const PageLoadTiming& timing,
                                 const PageLoadExtraInfo& extra_info) {}
   virtual void OnFirstLayout(const PageLoadTiming& timing,
                              const PageLoadExtraInfo& extra_info) {}
-  virtual void OnFirstPaint(const PageLoadTiming& timing,
-                            const PageLoadExtraInfo& extra_info) {}
-  virtual void OnFirstTextPaint(const PageLoadTiming& timing,
-                                const PageLoadExtraInfo& extra_info) {}
-  virtual void OnFirstImagePaint(const PageLoadTiming& timing,
-                                 const PageLoadExtraInfo& extra_info) {}
-  virtual void OnFirstContentfulPaint(const PageLoadTiming& timing,
-                                      const PageLoadExtraInfo& extra_info) {}
-  virtual void OnFirstMeaningfulPaint(const PageLoadTiming& timing,
-                                      const PageLoadExtraInfo& extra_info) {}
   virtual void OnParseStart(const PageLoadTiming& timing,
                             const PageLoadExtraInfo& extra_info) {}
   virtual void OnParseStop(const PageLoadTiming& timing,
                            const PageLoadExtraInfo& extra_info) {}
 
+  // On*PaintInPage(...) are invoked when the first relevant paint in the page,
+  // across all frames, is observed.
+  virtual void OnFirstPaintInPage(const PageLoadTiming& timing,
+                                  const PageLoadExtraInfo& extra_info) {}
+  virtual void OnFirstTextPaintInPage(const PageLoadTiming& timing,
+                                      const PageLoadExtraInfo& extra_info) {}
+  virtual void OnFirstImagePaintInPage(const PageLoadTiming& timing,
+                                       const PageLoadExtraInfo& extra_info) {}
+  virtual void OnFirstContentfulPaintInPage(
+      const PageLoadTiming& timing,
+      const PageLoadExtraInfo& extra_info) {}
+
+  // Unlike other paint callbacks, OnFirstMeaningfulPaintInMainFrameDocument is
+  // tracked per document, and is reported for the main frame document only.
+  virtual void OnFirstMeaningfulPaintInMainFrameDocument(
+      const PageLoadTiming& timing,
+      const PageLoadExtraInfo& extra_info) {}
+
   // Invoked when there is a change in either the main_frame_metadata or the
-  // child_frame_metadata's loading behavior_flags.
+  // subframe_metadata's loading behavior_flags.
   virtual void OnLoadingBehaviorObserved(
       const page_load_metrics::PageLoadExtraInfo& extra_info) {}
 
   // Invoked when a media element starts playing.
   virtual void MediaStartedPlaying(
       const content::WebContentsObserver::MediaPlayerInfo& video_type,
       bool is_in_main_frame) {}
 
   // Invoked on navigations where a navigation delay was added by the
   // DelayNavigationThrottle. This is a temporary method that will be removed
@@ skipping 48 matching lines @@
   // Called whenever a request is loaded for this page load. This comes
   // unfiltered from the ResourceDispatcherHost and may include blob requests
   // and data uris.
   virtual void OnLoadedResource(
       const ExtraRequestCompleteInfo& extra_request_complete_info) {}
 };
 
 }  // namespace page_load_metrics
 
 #endif  // CHROME_BROWSER_PAGE_LOAD_METRICS_PAGE_LOAD_METRICS_OBSERVER_H_