[Page Load Metrics] Add mojom file to page load metrics.

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 111 matching lines @@
 bool EventsInOrder(const base::Optional<base::TimeDelta>& first,
                    const base::Optional<base::TimeDelta>& second) {
   if (!second) {
     return true;
   }
   return first && first <= second;
 }
 
 internal::PageLoadTimingStatus IsValidPageLoadTiming(
     const PageLoadTiming& timing) {
-  if (timing.IsEmpty())
+  if (page_load_metrics::IsEmpty(timing))
     return internal::INVALID_EMPTY_TIMING;
 
   // If we have a non-empty timing, it should always have a navigation start.
   if (timing.navigation_start.is_null()) {
     LOG(ERROR) << "Received null navigation_start.";
     return internal::INVALID_NULL_NAVIGATION_START;
   }
 
   // Verify proper ordering between the various timings.
 
-  if (!EventsInOrder(timing.response_start, timing.parse_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.
     LOG(ERROR) << "Invalid response_start " << timing.response_start
-               << " for parse_start " << timing.parse_timing.parse_start;
+               << " for parse_start " << timing.parse_timing->parse_start;
     // When browser-side navigation is enabled, we sometimes encounter this
     // error case. For now, we disable reporting of this error, since most
     // PageLoadMetricsObservers don't care about response_start and we want to
     // see how much closer fixing this error will get us to page load metrics
     // being consistent with and without browser side navigation enabled. See
     // crbug.com/716587 for more details.
     //
     // return internal::INVALID_ORDER_RESPONSE_START_PARSE_START;
   }
 
-  if (!EventsInOrder(timing.parse_timing.parse_start,
-                     timing.parse_timing.parse_stop)) {
-    LOG(ERROR) << "Invalid parse_start " << timing.parse_timing.parse_start
-               << " for parse_stop " << timing.parse_timing.parse_stop;
+  if (!EventsInOrder(timing.parse_timing->parse_start,
+                     timing.parse_timing->parse_stop)) {
+    LOG(ERROR) << "Invalid parse_start " << timing.parse_timing->parse_start
+               << " for parse_stop " << timing.parse_timing->parse_stop;
     return internal::INVALID_ORDER_PARSE_START_PARSE_STOP;
   }
 
-  if (timing.parse_timing.parse_stop) {
+  if (timing.parse_timing->parse_stop) {
     const base::TimeDelta parse_duration =
-        timing.parse_timing.parse_stop.value() -
-        timing.parse_timing.parse_start.value();
-    if (timing.parse_timing.parse_blocked_on_script_load_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) {
       LOG(ERROR) << "Invalid parse_blocked_on_script_load_duration "
-                 << timing.parse_timing.parse_blocked_on_script_load_duration
+                 << timing.parse_timing->parse_blocked_on_script_load_duration
                  << " for parse duration " << parse_duration;
       return internal::INVALID_SCRIPT_LOAD_LONGER_THAN_PARSE;
     }
-    if (timing.parse_timing.parse_blocked_on_script_execution_duration >
+    if (timing.parse_timing->parse_blocked_on_script_execution_duration >
         parse_duration) {
       LOG(ERROR)
           << "Invalid parse_blocked_on_script_execution_duration "
-          << timing.parse_timing.parse_blocked_on_script_execution_duration
+          << timing.parse_timing->parse_blocked_on_script_execution_duration
           << " for parse duration " << parse_duration;
       return internal::INVALID_SCRIPT_EXEC_LONGER_THAN_PARSE;
     }
   }
 
   if (timing.parse_timing
-          .parse_blocked_on_script_load_from_document_write_duration >
-      timing.parse_timing.parse_blocked_on_script_load_duration) {
+          ->parse_blocked_on_script_load_from_document_write_duration >
+      timing.parse_timing->parse_blocked_on_script_load_duration) {
     LOG(ERROR)
         << "Invalid parse_blocked_on_script_load_from_document_write_duration "
         << timing.parse_timing
-               .parse_blocked_on_script_load_from_document_write_duration
+               ->parse_blocked_on_script_load_from_document_write_duration
         << " for parse_blocked_on_script_load_duration "
-        << timing.parse_timing.parse_blocked_on_script_load_duration;
+        << timing.parse_timing->parse_blocked_on_script_load_duration;
     return internal::INVALID_SCRIPT_LOAD_DOC_WRITE_LONGER_THAN_SCRIPT_LOAD;
   }
 
   if (timing.parse_timing
-          .parse_blocked_on_script_execution_from_document_write_duration >
-      timing.parse_timing.parse_blocked_on_script_execution_duration) {
+          ->parse_blocked_on_script_execution_from_document_write_duration >
+      timing.parse_timing->parse_blocked_on_script_execution_duration) {
     LOG(ERROR)
         << "Invalid "
            "parse_blocked_on_script_execution_from_document_write_duration "
         << timing.parse_timing
-               .parse_blocked_on_script_execution_from_document_write_duration
+               ->parse_blocked_on_script_execution_from_document_write_duration
         << " for parse_blocked_on_script_execution_duration "
-        << timing.parse_timing.parse_blocked_on_script_execution_duration;
+        << timing.parse_timing->parse_blocked_on_script_execution_duration;
     return internal::INVALID_SCRIPT_EXEC_DOC_WRITE_LONGER_THAN_SCRIPT_EXEC;
   }
 
-  if (!EventsInOrder(timing.parse_timing.parse_stop,
-                     timing.document_timing.dom_content_loaded_event_start)) {
-    LOG(ERROR) << "Invalid parse_stop " << timing.parse_timing.parse_stop
+  if (!EventsInOrder(timing.parse_timing->parse_stop,
+                     timing.document_timing->dom_content_loaded_event_start)) {
+    LOG(ERROR) << "Invalid parse_stop " << timing.parse_timing->parse_stop
                << " for dom_content_loaded_event_start "
-               << timing.document_timing.dom_content_loaded_event_start;
+               << timing.document_timing->dom_content_loaded_event_start;
     return internal::INVALID_ORDER_PARSE_STOP_DOM_CONTENT_LOADED;
   }
 
-  if (!EventsInOrder(timing.document_timing.dom_content_loaded_event_start,
-                     timing.document_timing.load_event_start)) {
+  if (!EventsInOrder(timing.document_timing->dom_content_loaded_event_start,
+                     timing.document_timing->load_event_start)) {
     LOG(ERROR) << "Invalid dom_content_loaded_event_start "
-               << timing.document_timing.dom_content_loaded_event_start
+               << timing.document_timing->dom_content_loaded_event_start
                << " for load_event_start "
-               << timing.document_timing.load_event_start;
+               << timing.document_timing->load_event_start;
     return internal::INVALID_ORDER_DOM_CONTENT_LOADED_LOAD;
   }
 
-  if (!EventsInOrder(timing.parse_timing.parse_start,
-                     timing.document_timing.first_layout)) {
-    LOG(ERROR) << "Invalid parse_start " << timing.parse_timing.parse_start
-               << " for first_layout " << timing.document_timing.first_layout;
+  if (!EventsInOrder(timing.parse_timing->parse_start,
+                     timing.document_timing->first_layout)) {
+    LOG(ERROR) << "Invalid parse_start " << timing.parse_timing->parse_start
+               << " for first_layout " << timing.document_timing->first_layout;
     return internal::INVALID_ORDER_PARSE_START_FIRST_LAYOUT;
   }
 
-  if (!EventsInOrder(timing.document_timing.first_layout,
-                     timing.paint_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.document_timing.first_layout << " for first_paint "
-                << timing.paint_timing.first_paint;
+                << timing.document_timing->first_layout << " for first_paint "
+                << timing.paint_timing->first_paint;
     return internal::INVALID_ORDER_FIRST_LAYOUT_FIRST_PAINT;
   }
 
-  if (!EventsInOrder(timing.paint_timing.first_paint,
-                     timing.paint_timing.first_text_paint)) {
-    LOG(ERROR) << "Invalid first_paint " << timing.paint_timing.first_paint
+  if (!EventsInOrder(timing.paint_timing->first_paint,
+                     timing.paint_timing->first_text_paint)) {
+    LOG(ERROR) << "Invalid first_paint " << timing.paint_timing->first_paint
                << " for first_text_paint "
-               << timing.paint_timing.first_text_paint;
+               << timing.paint_timing->first_text_paint;
     return internal::INVALID_ORDER_FIRST_PAINT_FIRST_TEXT_PAINT;
   }
 
-  if (!EventsInOrder(timing.paint_timing.first_paint,
-                     timing.paint_timing.first_image_paint)) {
-    LOG(ERROR) << "Invalid first_paint " << timing.paint_timing.first_paint
+  if (!EventsInOrder(timing.paint_timing->first_paint,
+                     timing.paint_timing->first_image_paint)) {
+    LOG(ERROR) << "Invalid first_paint " << timing.paint_timing->first_paint
                << " for first_image_paint "
-               << timing.paint_timing.first_image_paint;
+               << timing.paint_timing->first_image_paint;
     return internal::INVALID_ORDER_FIRST_PAINT_FIRST_IMAGE_PAINT;
   }
 
-  if (!EventsInOrder(timing.paint_timing.first_paint,
-                     timing.paint_timing.first_contentful_paint)) {
-    LOG(ERROR) << "Invalid first_paint " << timing.paint_timing.first_paint
+  if (!EventsInOrder(timing.paint_timing->first_paint,
+                     timing.paint_timing->first_contentful_paint)) {
+    LOG(ERROR) << "Invalid first_paint " << timing.paint_timing->first_paint
                << " for first_contentful_paint "
-               << timing.paint_timing.first_contentful_paint;
+               << timing.paint_timing->first_contentful_paint;
     return internal::INVALID_ORDER_FIRST_PAINT_FIRST_CONTENTFUL_PAINT;
   }
 
-  if (!EventsInOrder(timing.paint_timing.first_paint,
-                     timing.paint_timing.first_meaningful_paint)) {
-    LOG(ERROR) << "Invalid first_paint " << timing.paint_timing.first_paint
+  if (!EventsInOrder(timing.paint_timing->first_paint,
+                     timing.paint_timing->first_meaningful_paint)) {
+    LOG(ERROR) << "Invalid first_paint " << timing.paint_timing->first_paint
                << " for first_meaningful_paint "
-               << timing.paint_timing.first_meaningful_paint;
+               << timing.paint_timing->first_meaningful_paint;
     return internal::INVALID_ORDER_FIRST_PAINT_FIRST_MEANINGFUL_PAINT;
   }
 
   return internal::VALID;
 }
 
 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)
+  if (!last_timing.Equals(new_timing))
     observer->OnTimingUpdate(new_timing, extra_info);
-  if (new_timing.document_timing.dom_content_loaded_event_start &&
-      !last_timing.document_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.document_timing.load_event_start &&
-      !last_timing.document_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.document_timing.first_layout &&
-      !last_timing.document_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.paint_timing.first_paint &&
-      !last_timing.paint_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.paint_timing.first_text_paint &&
-      !last_timing.paint_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.paint_timing.first_image_paint &&
-      !last_timing.paint_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.paint_timing.first_contentful_paint &&
-      !last_timing.paint_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.paint_timing.first_meaningful_paint &&
-      !last_timing.paint_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_timing.parse_start &&
-      !last_timing.parse_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_timing.parse_stop &&
-      !last_timing.parse_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,
     UserInitiatedInfo user_initiated_info,
     int aborted_chain_size,
     int aborted_chain_size_same_url)
     : did_stop_tracking_(false),
       app_entered_background_(false),
       navigation_start_(navigation_handle->NavigationStart()),
       url_(navigation_handle->GetURL()),
       start_url_(navigation_handle->GetURL()),
       did_commit_(false),
       page_end_reason_(END_NONE),
       page_end_user_initiated_info_(UserInitiatedInfo::NotUserInitiated()),
       started_in_foreground_(in_foreground),
+      timing_(CreatePageLoadTiming()),
       page_transition_(navigation_handle->GetPageTransition()),
       user_initiated_info_(user_initiated_info),
       aborted_chain_size_(aborted_chain_size),
       aborted_chain_size_same_url_(aborted_chain_size_same_url),
       embedder_interface_(embedder_interface) {
   DCHECK(!navigation_handle->HasCommitted());
   embedder_interface_->RegisterObservers(this);
   INVOKE_AND_PRUNE_OBSERVERS(observers_, OnStart, navigation_handle,
                              currently_committed_url, started_in_foreground_);
 
@@ skipping 27 matching lines @@
     if (!failed_provisional_load_info_)
       RecordInternalError(ERR_NO_COMMIT_OR_FAILED_PROVISIONAL_LOAD);
 
     // Don't include any aborts that resulted in a new navigation, as the chain
     // length will be included in the aborter PageLoadTracker.
     if (page_end_reason_ != END_RELOAD &&
         page_end_reason_ != END_FORWARD_BACK &&
         page_end_reason_ != END_NEW_NAVIGATION) {
       LogAbortChainHistograms(nullptr);
     }
-  } else if (timing_.IsEmpty()) {
+  } else if (page_load_metrics::IsEmpty(*timing_)) {
     RecordInternalError(ERR_NO_IPCS_RECEIVED);
   }
 
   const PageLoadExtraInfo info = ComputePageLoadExtraInfo();
   for (const auto& observer : observers_) {
     if (failed_provisional_load_info_) {
       observer->OnFailedProvisionalLoad(*failed_provisional_load_info_, info);
     } else if (did_commit_) {
-      observer->OnComplete(timing_, info);
+      observer->OnComplete(*timing_, info);
     }
   }
 }
 
 void PageLoadTracker::LogAbortChainHistograms(
     content::NavigationHandle* final_navigation) {
   if (aborted_chain_size_ == 0)
     return;
   // Note that this could be broken out by this navigation's abort type, if more
   // granularity is needed. Add one to the chain size to count the current
@@ skipping 46 matching lines @@
   // Only log the first time we background in a given page load.
   if (background_time_.is_null()) {
     // Make sure we either started in the foreground and haven't been
     // foregrounded yet, or started in the background and have already been
     // foregrounded.
     DCHECK_EQ(started_in_foreground_, foreground_time_.is_null());
     background_time_ = base::TimeTicks::Now();
     ClampBrowserTimestampIfInterProcessTimeTickSkew(&background_time_);
   }
   const PageLoadExtraInfo info = ComputePageLoadExtraInfo();
-  INVOKE_AND_PRUNE_OBSERVERS(observers_, OnHidden, timing_, info);
+  INVOKE_AND_PRUNE_OBSERVERS(observers_, OnHidden, *timing_, info);
 }
 
 void PageLoadTracker::WebContentsShown() {
   // Only log the first time we foreground in a given page load.
   if (foreground_time_.is_null()) {
     // Make sure we either started in the background and haven't been
     // backgrounded yet, or started in the foreground and have already been
     // backgrounded.
     DCHECK_NE(started_in_foreground_, background_time_.is_null());
     foreground_time_ = base::TimeTicks::Now();
@@ skipping 62 matching lines @@
 }
 
 void PageLoadTracker::FlushMetricsOnAppEnterBackground() {
   if (!app_entered_background_) {
     RecordAppBackgroundPageLoadCompleted(false);
     app_entered_background_ = true;
   }
 
   const PageLoadExtraInfo info = ComputePageLoadExtraInfo();
   INVOKE_AND_PRUNE_OBSERVERS(observers_, FlushMetricsOnAppEnterBackground,
-                             timing_, info);
+                             *timing_, info);
 }
 
 void PageLoadTracker::NotifyClientRedirectTo(
     const PageLoadTracker& destination) {
-  if (timing_.paint_timing.first_paint) {
+  if (timing_->paint_timing->first_paint) {
     base::TimeTicks first_paint_time =
-        navigation_start() + timing_.paint_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 14 matching lines @@
   }
 }
 
 void PageLoadTracker::UpdateTiming(const PageLoadTiming& new_timing,
                                    const PageLoadMetadata& new_metadata) {
   // Throw away IPCs that are not relevant to the current navigation.
   // Two timing structures cannot refer to the same navigation if they indicate
   // that a navigation started at different times, so a new timing struct with a
   // different start time from an earlier struct is considered invalid.
   const bool valid_timing_descendent =
-      timing_.navigation_start.is_null() ||
-      timing_.navigation_start == new_timing.navigation_start;
+      timing_->navigation_start.is_null() ||
+      timing_->navigation_start == new_timing.navigation_start;
   if (!valid_timing_descendent) {
     RecordInternalError(ERR_BAD_TIMING_IPC_INVALID_TIMING_DESCENDENT);
     return;
   }
 
   // Ensure flags sent previously are still present in the new metadata fields.
   const bool valid_behavior_descendent =
       (main_frame_metadata_.behavior_flags & new_metadata.behavior_flags) ==
       main_frame_metadata_.behavior_flags;
   if (!valid_behavior_descendent) {
     RecordInternalError(ERR_BAD_TIMING_IPC_INVALID_BEHAVIOR_DESCENDENT);
     return;
   }
   internal::PageLoadTimingStatus status = IsValidPageLoadTiming(new_timing);
   UMA_HISTOGRAM_ENUMERATION(internal::kPageLoadTimingStatus, status,
                             internal::LAST_PAGE_LOAD_TIMING_STATUS);
   if (status != internal::VALID) {
     RecordInternalError(ERR_BAD_TIMING_IPC_INVALID_TIMING);
     return;
   }
 
   DCHECK(did_commit_);  // OnCommit() must be called first.
   // There are some subtle ordering constraints here. GetPageLoadMetricsInfo()
   // must be called before DispatchObserverTimingCallbacks, but its
   // implementation depends on the state of main_frame_metadata_, so we need
   // to update main_frame_metadata_ before calling GetPageLoadMetricsInfo.
   // Thus, we make a copy of timing here, update timing_ and
   // main_frame_metadata_, and then proceed to dispatch the observer timing
   // callbacks.
-  const PageLoadTiming last_timing = timing_;
-  timing_ = new_timing;
+  mojo::StructPtr<PageLoadTiming> last_timing = std::move(timing_);
+  timing_ = new_timing.Clone();
 
   const PageLoadMetadata last_metadata = main_frame_metadata_;
   main_frame_metadata_ = new_metadata;
   const PageLoadExtraInfo info = ComputePageLoadExtraInfo();
   for (const auto& observer : observers_) {
-    DispatchObserverTimingCallbacks(observer.get(), last_timing, new_timing,
+    DispatchObserverTimingCallbacks(observer.get(), *last_timing, new_timing,
                                     last_metadata, info);
   }
 }
 
 void PageLoadTracker::OnStartedResource(
     const ExtraRequestStartInfo& extra_request_start_info) {
   for (const auto& observer : observers_) {
     observer->OnStartedResource(extra_request_start_info);
   }
 }
@@ skipping 176 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