[Page Load Metrics] Structure PageLoadTiming.

chrome/browser/page_load_metrics/page_load_tracker.cc

 // 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.
 
 #include "chrome/browser/page_load_metrics/page_load_tracker.h"
 
 #include <algorithm>
 #include <ostream>
 #include <string>
 #include <utility>
@@ skipping 120 matching lines @@
     return false;
 
   // If we have a non-empty timing, it should always have a navigation start.
   if (timing.navigation_start.is_null()) {
     NOTREACHED() << "Received null navigation_start.";
     return false;
   }
 
   // Verify proper ordering between the various timings.
 
-  if (!EventsInOrder(timing.response_start, timing.parse_start)) {
+  if (!EventsInOrder(timing.response_start, timing.parse_timing.parse_start)) {
+    // We sometimes get a zero response_start with a non-zero parse start. See
+    // crbug.com/590212.
     NOTREACHED() << "Invalid response_start " << timing.response_start
-                 << " for parse_start " << timing.parse_start;
+                 << " for parse_start " << timing.parse_timing.parse_start;
     return false;
   }
 
-  if (!EventsInOrder(timing.parse_start, timing.parse_stop)) {
-    NOTREACHED() << "Invalid parse_start " << timing.parse_start
-                 << " for parse_stop " << timing.parse_stop;
+  if (!EventsInOrder(timing.parse_timing.parse_start,
+                     timing.parse_timing.parse_stop)) {
+    NOTREACHED() << "Invalid parse_start " << timing.parse_timing.parse_start
+                 << " for parse_stop " << timing.parse_timing.parse_stop;
     return false;
   }
 
-  if (timing.parse_stop) {
+  if (timing.parse_timing.parse_stop) {
     const base::TimeDelta parse_duration =
-        timing.parse_stop.value() - timing.parse_start.value();
-    if (timing.parse_blocked_on_script_load_duration > parse_duration) {
+        timing.parse_timing.parse_stop.value() -
+        timing.parse_timing.parse_start.value();
+    if (timing.parse_timing.parse_blocked_on_script_load_duration >
+        parse_duration) {
       NOTREACHED() << "Invalid parse_blocked_on_script_load_duration "
-                   << timing.parse_blocked_on_script_load_duration
+                   << timing.parse_timing.parse_blocked_on_script_load_duration
                    << " for parse duration " << parse_duration;
       return false;
     }
-    if (timing.parse_blocked_on_script_execution_duration > parse_duration) {
-      NOTREACHED() << "Invalid parse_blocked_on_script_execution_duration "
-                   << timing.parse_blocked_on_script_execution_duration
-                   << " for parse duration " << parse_duration;
+    if (timing.parse_timing.parse_blocked_on_script_execution_duration >
+        parse_duration) {
+      NOTREACHED()
+          << "Invalid parse_blocked_on_script_execution_duration "
+          << timing.parse_timing.parse_blocked_on_script_execution_duration
+          << " for parse duration " << parse_duration;
       return false;
     }
   }
 
-  if (timing.parse_blocked_on_script_load_from_document_write_duration >
-      timing.parse_blocked_on_script_load_duration) {
+  if (timing.parse_timing
+          .parse_blocked_on_script_load_from_document_write_duration >
+      timing.parse_timing.parse_blocked_on_script_load_duration) {
     NOTREACHED()
         << "Invalid parse_blocked_on_script_load_from_document_write_duration "
-        << timing.parse_blocked_on_script_load_from_document_write_duration
+        << timing.parse_timing
+               .parse_blocked_on_script_load_from_document_write_duration
         << " for parse_blocked_on_script_load_duration "
-        << timing.parse_blocked_on_script_load_duration;
+        << timing.parse_timing.parse_blocked_on_script_load_duration;
     return false;
   }
 
-  if (timing.parse_blocked_on_script_execution_from_document_write_duration >
-      timing.parse_blocked_on_script_execution_duration) {
+  if (timing.parse_timing
+          .parse_blocked_on_script_execution_from_document_write_duration >
+      timing.parse_timing.parse_blocked_on_script_execution_duration) {
     NOTREACHED()
         << "Invalid "
            "parse_blocked_on_script_execution_from_document_write_duration "
-        << timing.parse_blocked_on_script_execution_from_document_write_duration
+        << timing.parse_timing
+               .parse_blocked_on_script_execution_from_document_write_duration
         << " for parse_blocked_on_script_execution_duration "
-        << timing.parse_blocked_on_script_execution_duration;
+        << timing.parse_timing.parse_blocked_on_script_execution_duration;
     return false;
   }
 
-  if (!EventsInOrder(timing.parse_stop,
-                     timing.dom_content_loaded_event_start)) {
-    NOTREACHED() << "Invalid parse_stop " << timing.parse_stop
+  if (!EventsInOrder(timing.parse_timing.parse_stop,
+                     timing.document_timing.dom_content_loaded_event_start)) {
+    NOTREACHED() << "Invalid parse_stop " << timing.parse_timing.parse_stop
                  << " for dom_content_loaded_event_start "
-                 << timing.dom_content_loaded_event_start;
+                 << timing.document_timing.dom_content_loaded_event_start;
     return false;
   }
 
-  if (!EventsInOrder(timing.dom_content_loaded_event_start,
-                     timing.load_event_start)) {
+  if (!EventsInOrder(timing.document_timing.dom_content_loaded_event_start,
+                     timing.document_timing.load_event_start)) {
     NOTREACHED() << "Invalid dom_content_loaded_event_start "
-                 << timing.dom_content_loaded_event_start
-                 << " for load_event_start " << timing.load_event_start;
+                 << timing.document_timing.dom_content_loaded_event_start
+                 << " for load_event_start "
+                 << timing.document_timing.load_event_start;
     return false;
   }
 
-  if (!EventsInOrder(timing.parse_start, timing.first_layout)) {
-    NOTREACHED() << "Invalid parse_start " << timing.parse_start
-                 << " for first_layout " << timing.first_layout;
+  if (!EventsInOrder(timing.parse_timing.parse_start,
+                     timing.document_timing.first_layout)) {
+    NOTREACHED() << "Invalid parse_start " << timing.parse_timing.parse_start
+                 << " for first_layout " << timing.document_timing.first_layout;
     return false;
   }
 
-  if (!EventsInOrder(timing.first_layout, timing.first_paint)) {
+  if (!EventsInOrder(timing.document_timing.first_layout,
+                     timing.paint_timing.first_paint)) {
     // This can happen when we process an XHTML document that doesn't contain
     // well formed XML. See crbug.com/627607.
-    DLOG(ERROR) << "Invalid first_layout " << timing.first_layout
-                << " for first_paint " << timing.first_paint;
+    DLOG(ERROR) << "Invalid first_layout "
+                << timing.document_timing.first_layout << " for first_paint "
+                << timing.paint_timing.first_paint;
     return false;
   }
 
-  if (!EventsInOrder(timing.first_paint, timing.first_text_paint)) {
-    NOTREACHED() << "Invalid first_paint " << timing.first_paint
-                 << " for first_text_paint " << timing.first_text_paint;
+  if (!EventsInOrder(timing.paint_timing.first_paint,
+                     timing.paint_timing.first_text_paint)) {
+    NOTREACHED() << "Invalid first_paint " << timing.paint_timing.first_paint
+                 << " for first_text_paint "
+                 << timing.paint_timing.first_text_paint;
     return false;
   }
 
-  if (!EventsInOrder(timing.first_paint, timing.first_image_paint)) {
-    NOTREACHED() << "Invalid first_paint " << timing.first_paint
-                 << " for first_image_paint " << timing.first_image_paint;
+  if (!EventsInOrder(timing.paint_timing.first_paint,
+                     timing.paint_timing.first_image_paint)) {
+    NOTREACHED() << "Invalid first_paint " << timing.paint_timing.first_paint
+                 << " for first_image_paint "
+                 << timing.paint_timing.first_image_paint;
     return false;
   }
 
-  if (!EventsInOrder(timing.first_paint, timing.first_contentful_paint)) {
-    NOTREACHED() << "Invalid first_paint " << timing.first_paint
+  if (!EventsInOrder(timing.paint_timing.first_paint,
+                     timing.paint_timing.first_contentful_paint)) {
+    NOTREACHED() << "Invalid first_paint " << timing.paint_timing.first_paint
                  << " for first_contentful_paint "
-                 << timing.first_contentful_paint;
+                 << timing.paint_timing.first_contentful_paint;
     return false;
   }
 
-  if (!EventsInOrder(timing.first_paint, timing.first_meaningful_paint)) {
-    NOTREACHED() << "Invalid first_paint " << timing.first_paint
+  if (!EventsInOrder(timing.paint_timing.first_paint,
+                     timing.paint_timing.first_meaningful_paint)) {
+    NOTREACHED() << "Invalid first_paint " << timing.paint_timing.first_paint
                  << " for first_meaningful_paint "
-                 << timing.first_meaningful_paint;
+                 << timing.paint_timing.first_meaningful_paint;
     return false;
   }
 
   return true;
 }
 
 void RecordAppBackgroundPageLoadCompleted(bool completed_after_background) {
   UMA_HISTOGRAM_BOOLEAN(internal::kPageLoadCompletedAfterAppBackground,
                         completed_after_background);
 }
 
 void DispatchObserverTimingCallbacks(PageLoadMetricsObserver* observer,
                                      const PageLoadTiming& last_timing,
                                      const PageLoadTiming& new_timing,
                                      const PageLoadMetadata& last_metadata,
                                      const PageLoadExtraInfo& extra_info) {
   if (extra_info.main_frame_metadata.behavior_flags !=
       last_metadata.behavior_flags)
     observer->OnLoadingBehaviorObserved(extra_info);
   if (last_timing != new_timing)
     observer->OnTimingUpdate(new_timing, extra_info);
-  if (new_timing.dom_content_loaded_event_start &&
-      !last_timing.dom_content_loaded_event_start)
+  if (new_timing.document_timing.dom_content_loaded_event_start &&
+      !last_timing.document_timing.dom_content_loaded_event_start)
     observer->OnDomContentLoadedEventStart(new_timing, extra_info);
-  if (new_timing.load_event_start && !last_timing.load_event_start)
+  if (new_timing.document_timing.load_event_start &&
+      !last_timing.document_timing.load_event_start)
     observer->OnLoadEventStart(new_timing, extra_info);
-  if (new_timing.first_layout && !last_timing.first_layout)
+  if (new_timing.document_timing.first_layout &&
+      !last_timing.document_timing.first_layout)
     observer->OnFirstLayout(new_timing, extra_info);
-  if (new_timing.first_paint && !last_timing.first_paint)
+  if (new_timing.paint_timing.first_paint &&
+      !last_timing.paint_timing.first_paint)
     observer->OnFirstPaint(new_timing, extra_info);
-  if (new_timing.first_text_paint && !last_timing.first_text_paint)
+  if (new_timing.paint_timing.first_text_paint &&
+      !last_timing.paint_timing.first_text_paint)
     observer->OnFirstTextPaint(new_timing, extra_info);
-  if (new_timing.first_image_paint && !last_timing.first_image_paint)
+  if (new_timing.paint_timing.first_image_paint &&
+      !last_timing.paint_timing.first_image_paint)
     observer->OnFirstImagePaint(new_timing, extra_info);
-  if (new_timing.first_contentful_paint && !last_timing.first_contentful_paint)
+  if (new_timing.paint_timing.first_contentful_paint &&
+      !last_timing.paint_timing.first_contentful_paint)
     observer->OnFirstContentfulPaint(new_timing, extra_info);
-  if (new_timing.first_meaningful_paint && !last_timing.first_meaningful_paint)
+  if (new_timing.paint_timing.first_meaningful_paint &&
+      !last_timing.paint_timing.first_meaningful_paint)
     observer->OnFirstMeaningfulPaint(new_timing, extra_info);
-  if (new_timing.parse_start && !last_timing.parse_start)
+  if (new_timing.parse_timing.parse_start &&
+      !last_timing.parse_timing.parse_start)
     observer->OnParseStart(new_timing, extra_info);
-  if (new_timing.parse_stop && !last_timing.parse_stop)
+  if (new_timing.parse_timing.parse_stop &&
+      !last_timing.parse_timing.parse_stop)
     observer->OnParseStop(new_timing, extra_info);
 }
 
 }  // namespace
 
 PageLoadTracker::PageLoadTracker(
     bool in_foreground,
     PageLoadMetricsEmbedderInterface* embedder_interface,
     const GURL& currently_committed_url,
     content::NavigationHandle* navigation_handle,
@@ skipping 205 matching lines @@
     app_entered_background_ = true;
   }
 
   const PageLoadExtraInfo info = ComputePageLoadExtraInfo();
   INVOKE_AND_PRUNE_OBSERVERS(observers_, FlushMetricsOnAppEnterBackground,
                              timing_, info);
 }
 
 void PageLoadTracker::NotifyClientRedirectTo(
     const PageLoadTracker& destination) {
-  if (timing_.first_paint) {
+  if (timing_.paint_timing.first_paint) {
     base::TimeTicks first_paint_time =
-        navigation_start() + timing_.first_paint.value();
+        navigation_start() + timing_.paint_timing.first_paint.value();
     base::TimeDelta first_paint_to_navigation;
     if (destination.navigation_start() > first_paint_time)
       first_paint_to_navigation =
           destination.navigation_start() - first_paint_time;
     PAGE_LOAD_HISTOGRAM(internal::kClientRedirectFirstPaintToNavigation,
                         first_paint_to_navigation);
   } else {
     UMA_HISTOGRAM_BOOLEAN(internal::kClientRedirectWithoutPaint, true);
   }
 }
@@ skipping 239 matching lines @@
     observer->MediaStartedPlaying(video_type, is_in_main_frame);
 }
 
 void PageLoadTracker::OnNavigationDelayComplete(base::TimeDelta scheduled_delay,
                                                 base::TimeDelta actual_delay) {
   for (const auto& observer : observers_)
     observer->OnNavigationDelayComplete(scheduled_delay, actual_delay);
 }
 
 }  // namespace page_load_metrics