Report page load timing information for child frames.

chrome/browser/page_load_metrics/page_load_tracker.h

 // Copyright 2016 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_TRACKER_H_
 #define CHROME_BROWSER_PAGE_LOAD_METRICS_PAGE_LOAD_TRACKER_H_
 
 #include <memory>
 #include <vector>
 
 #include "base/macros.h"
 #include "base/optional.h"
 #include "base/time/time.h"
 #include "chrome/browser/page_load_metrics/page_load_metrics_observer.h"
 #include "chrome/browser/page_load_metrics/user_input_tracker.h"
 #include "chrome/common/page_load_metrics/page_load_timing.h"
 #include "content/public/browser/global_request_id.h"
 #include "content/public/browser/web_contents_observer.h"
 #include "ui/base/page_transition_types.h"
 
 class GURL;
 
 namespace blink {
 class WebInputEvent;
 }  // namespace blink
 
 namespace content {
 class NavigationHandle;
+class RenderFrameHost;
 }  // namespace content
 
 namespace page_load_metrics {
 
 class PageLoadMetricsEmbedderInterface;
 class PageLoadMetricsObserver;
 
 namespace internal {
 
 extern const char kErrorEvents[];
@@ skipping 106 matching lines @@
   // renderer process and the system clock has inter process time tick skew.
   ERR_INTER_PROCESS_TIME_TICK_SKEW,
 
   // At the time a PageLoadTracker was destroyed, we had received neither a
   // commit nor a failed provisional load.
   ERR_NO_COMMIT_OR_FAILED_PROVISIONAL_LOAD,
 
   // No page load end time was recorded for this page load.
   ERR_NO_PAGE_LOAD_END_TIME,
 
-  // Received a timing update from a subframe.
-  ERR_TIMING_IPC_FROM_SUBFRAME,
+  // Received a timing update from a subframe (deprecated).
+  DEPRECATED_ERR_TIMING_IPC_FROM_SUBFRAME,
 
   // A timing IPC was sent from the renderer that contained timing data which
   // was inconsistent with our timing data for the currently committed load.
   ERR_BAD_TIMING_IPC_INVALID_TIMING_DESCENDENT,
 
   // A timing IPC was sent from the renderer that contained loading behavior
   // data which was inconsistent with our loading behavior data for the
   // currently committed load.
   ERR_BAD_TIMING_IPC_INVALID_BEHAVIOR_DESCENDENT,
 
   // A timing IPC was sent from the renderer that contained invalid timing data
   // (e.g. out of order timings, or other issues).
   ERR_BAD_TIMING_IPC_INVALID_TIMING,
 
+  // We received an IPC for a subframe when we weren't tracking a committed load
+  // in that frame. This can happen if the frame fails to commit but a document
+  // is created in it from the parent document via document.open().
+  ERR_SUBFRAME_IPC_WITH_NO_RELEVANT_LOAD,
+
+  // We received a navigation start for a child frame that is before the
+  // navigation start of the main frame.
+  ERR_SUBFRAME_NAVIGATION_START_BEFORE_MAIN_FRAME,
+
   // Add values before this final count.
   ERR_LAST_ENTRY,
 };
 
 // NOTE: these functions are shared by page_load_tracker.cc and
 // metrics_web_contents_observer.cc. They are declared here to allow both files
 // to access them.
 void RecordInternalError(InternalErrorLoadEvent event);
 PageEndReason EndReasonForPageTransition(ui::PageTransition transition);
 void LogAbortChainSameURLHistogram(int aborted_chain_size_same_url);
 bool IsNavigationUserInitiated(content::NavigationHandle* handle);
+content::RenderFrameHost* GetMainFrame(content::RenderFrameHost* rfh);
 
 // This class tracks a given page load, starting from navigation start /
 // provisional load, until a new navigation commits or the navigation fails.
 // MetricsWebContentsObserver manages a set of provisional PageLoadTrackers, as
 // well as a committed PageLoadTracker.
 class PageLoadTracker {
  public:
   // Caller must guarantee that the embedder_interface pointer outlives this
   // class. The PageLoadTracker must not hold on to
   // currently_committed_load_or_null or navigation_handle beyond the scope of
@@ skipping 23 matching lines @@
   // metrics as the application goes into the background. The application may be
   // killed at any time after this method is invoked without further
   // notification.
   void FlushMetricsOnAppEnterBackground();
 
   void NotifyClientRedirectTo(const PageLoadTracker& destination);
 
   void UpdateTiming(const PageLoadTiming& timing,
                     const PageLoadMetadata& metadata);
 
+  void UpdateSubFrameTiming(content::RenderFrameHost* render_frame_host,
+                            const PageLoadTiming& new_timing,
+                            const PageLoadMetadata& new_metadata);
+
   // Update metadata for child frames. Updates for child frames arrive
   // separately from updates for the main frame, so aren't included in
   // UpdateTiming.
-  void UpdateChildFrameMetadata(const PageLoadMetadata& child_metadata);
+  void UpdateSubFrameMetadata(const PageLoadMetadata& child_metadata);

[jkarlin, 2017/05/10 16:55:28]

Why the rename? Should the comments and argument say "subframe" instead of
"child"?

[Bryan McQuade, 2017/05/10 18:06:15]

I wanted to mirror your naming for the subframe commit. i can update child->sub
everywhere, sure

 
   void OnStartedResource(
       const ExtraRequestStartInfo& extra_request_started_info);
 
   void OnLoadedResource(
       const ExtraRequestCompleteInfo& extra_request_complete_info);
 
   // Signals that we should stop tracking metrics for the associated page load.
   // We may stop tracking a page load if it doesn't meet the criteria for
   // tracking metrics in DidFinishNavigation.
@@ skipping 60 matching lines @@
       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
   // once the experiment is complete.
   void OnNavigationDelayComplete(base::TimeDelta scheduled_delay,
                                  base::TimeDelta actual_delay);
 
  private:
+  using FrameTreeNodeId = int;
+
   // This function converts a TimeTicks value taken in the browser process
   // to navigation_start_ if:
   // - base::TimeTicks is not comparable across processes because the clock
   // is not system wide monotonic.
   // - *event_time < navigation_start_
   void ClampBrowserTimestampIfInterProcessTimeTickSkew(
       base::TimeTicks* event_time);
 
   void UpdatePageEndInternal(PageEndReason page_end_reason,
                              UserInitiatedInfo user_initiated_info,
                              base::TimeTicks timestamp,
                              bool is_certainly_browser_timestamp);
 
   // If |final_navigation| is null, then this is an "unparented" abort chain,
   // and represents a sequence of provisional aborts that never ends with a
   // committed load.
   void LogAbortChainHistograms(content::NavigationHandle* final_navigation);
 
   void MaybeUpdateURL(content::NavigationHandle* navigation_handle);
 
+  // Merge values from |new_paint_timing| into |merged_page_timing_|, offsetting
+  // any new timings by the |navigation_start_offset|.
+  void MergePaintTiming(base::TimeDelta navigation_start_offset,
+                        const page_load_metrics::PaintTiming& new_paint_timing,
+                        bool is_main_frame);
+
   UserInputTracker input_tracker_;
 
   // Whether we stopped tracking this navigation after it was initiated. We may
   // stop tracking a navigation if it doesn't meet the criteria for tracking
   // metrics in DidFinishNavigation.
   bool did_stop_tracking_;
 
   // Whether the application went into the background when this PageLoadTracker
   // was active. This is a temporary boolean for UMA tracking.
   bool app_entered_background_;
@@ skipping 29 matching lines @@
 
   base::TimeTicks page_end_time_;
 
   // We record separate metrics for events that occur after a background,
   // because metrics like layout/paint are delayed artificially
   // when they occur in the background.
   base::TimeTicks background_time_;
   base::TimeTicks foreground_time_;
   bool started_in_foreground_;
 
-  PageLoadTiming timing_;
+  // PageLoadTiming for the currently tracked page. The fields in |paint_timing|
+  // are merged across all frames in the document. All other fields are for the
+  // main frame document.
+  PageLoadTiming merged_page_timing_;
+
   PageLoadMetadata main_frame_metadata_;
   PageLoadMetadata child_frame_metadata_;
 
   ui::PageTransition page_transition_;
 
   base::Optional<content::GlobalRequestID> navigation_request_id_;
 
   // Whether this page load was user initiated.
   UserInitiatedInfo user_initiated_info_;
 
   // This is a subtle member. If a provisional load A gets aborted by
   // provisional load B, which gets aborted by C that eventually commits, then
   // there exists an abort chain of length 2, starting at A's navigation_start.
   // This is useful because it allows histograming abort chain lengths based on
   // what the last load's transition type is. i.e. holding down F-5 to spam
   // reload will produce a long chain with the RELOAD transition.
   const int aborted_chain_size_;
 
   // This member counts consecutive provisional aborts that share a url. It will
   // always be less than or equal to |aborted_chain_size_|.
   const int aborted_chain_size_same_url_;
 
   // Interface to chrome features. Must outlive the class.
   PageLoadMetricsEmbedderInterface* const embedder_interface_;
 
   std::vector<std::unique_ptr<PageLoadMetricsObserver>> observers_;
 
+  // Navigation start offsets for the most recently committed document in each
+  // frame.
+  std::map<FrameTreeNodeId, base::TimeDelta>
+      child_frame_navigation_start_offset_;
+
   DISALLOW_COPY_AND_ASSIGN(PageLoadTracker);
 };
 
 }  // namespace page_load_metrics
 
 #endif  // CHROME_BROWSER_PAGE_LOAD_METRICS_PAGE_LOAD_TRACKER_H_