Abandon startup profiling for first WebContents when it gets hidden or navigated to a different ...

chrome/browser/metrics/first_web_contents_profiler.cc

 // Copyright 2014 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.
 
 #if !defined(OS_ANDROID)
 
 #include "chrome/browser/metrics/first_web_contents_profiler.h"
 
 #include <string>
 
 #include "base/location.h"
 #include "base/metrics/histogram_macros.h"
 #include "base/process/process_info.h"
 #include "base/single_thread_task_runner.h"
 #include "base/thread_task_runner_handle.h"
 #include "base/time/time.h"
 #include "chrome/browser/ui/browser.h"
 #include "chrome/browser/ui/browser_iterator.h"
 #include "chrome/browser/ui/tabs/tab_strip_model.h"
 #include "components/metrics/profiler/tracking_synchronizer.h"
 #include "components/metrics/proto/profiler_event.pb.h"
 #include "components/startup_metric_utils/startup_metric_utils.h"
 #include "content/public/browser/browser_thread.h"
+#include "content/public/browser/navigation_details.h"
 
 namespace {
+
 // The initial delay for responsiveness prober in milliseconds.
 const int kInitialDelayMs = 20;
 
 // The following is the multiplier is used to delay the probe for
 // responsiveness.
 const double kBackoffMultiplier = 1.5;
 
 // The maximum backoff delay in milliseconds.
 const int kMaxDelayMs = 250;
 
@@ skipping 72 matching lines @@
           new FirstWebContentsProfiler(web_contents, delegate));
     }
   }
   return nullptr;
 }
 
 FirstWebContentsProfiler::FirstWebContentsProfiler(
     content::WebContents* web_contents,
     Delegate* delegate)
     : content::WebContentsObserver(web_contents),
+      initial_entry_committed_(false),
       collected_paint_metric_(false),
       collected_load_metric_(false),
       delegate_(delegate),
       responsiveness_histogram_(NULL),
       responsiveness_1sec_histogram_(NULL),
       responsiveness_10sec_histogram_(NULL),
       unresponsiveness_histogram_(NULL),
       unresponsiveness_1sec_histogram_(NULL),
       unresponsiveness_10sec_histogram_(NULL) {
   InitHistograms();
 }
 
 void FirstWebContentsProfiler::DidFirstVisuallyNonEmptyPaint() {
   if (collected_paint_metric_)
     return;
   if (startup_metric_utils::WasNonBrowserUIDisplayed()) {
-    FinishedCollectingMetrics();
+    FinishedCollectingMetrics(FinishReason::ABANDON_BLOCKING_UI);
     return;
   }
 
   collected_paint_metric_ = true;
   startup_metric_utils::RecordFirstWebContentsNonEmptyPaint(base::Time::Now());
 
   metrics::TrackingSynchronizer::OnProfilingPhaseCompleted(
       metrics::ProfilerEventProto::EVENT_FIRST_NONEMPTY_PAINT);
 
   // Measures responsiveness now.
@@ skipping 10 matching lines @@
                  unresponsiveness_1sec_histogram_),
       base::TimeDelta::FromSeconds(1));
 
   base::ThreadTaskRunnerHandle::Get()->PostDelayedTask(
       FROM_HERE,
       base::Bind(&MeasureUIResponsiveness, responsiveness_10sec_histogram_,
                  unresponsiveness_10sec_histogram_),
       base::TimeDelta::FromSeconds(10));
 
   if (IsFinishedCollectingMetrics())
-    FinishedCollectingMetrics();
+    FinishedCollectingMetrics(FinishReason::DONE);
 }
 
 void FirstWebContentsProfiler::DocumentOnLoadCompletedInMainFrame() {
   if (collected_load_metric_)
     return;
   if (startup_metric_utils::WasNonBrowserUIDisplayed()) {
-    FinishedCollectingMetrics();
+    FinishedCollectingMetrics(FinishReason::ABANDON_BLOCKING_UI);
     return;
   }
 
   collected_load_metric_ = true;
   startup_metric_utils::RecordFirstWebContentsMainFrameLoad(base::Time::Now());
 
   if (IsFinishedCollectingMetrics())
-    FinishedCollectingMetrics();
+    FinishedCollectingMetrics(FinishReason::DONE);
+}
+
+void FirstWebContentsProfiler::NavigationEntryCommitted(
+    const content::LoadCommittedDetails& load_details) {
+  // Stop profiling on any navigation to a different page as it (1) is no longer

[rkaplow, 2015/10/20 20:08:30]

text seems good but I would break this is up, a lot to parse for one sentance

[gab, 2015/10/20 20:16:21]

Kept sentence, but re-ordered in bullet points, WDYT?

+  // a fair timing and (2) can cause http://crbug.com/525209 where one of the
+  // timing heuristics (e.g. first paint) didn't fire for the initial content
+  // but fires after a lot of idle time when the user finally navigates to
+  // another page that does trigger it.
+  if (load_details.is_navigation_to_different_page()) {
+    if (initial_entry_committed_)
+      FinishedCollectingMetrics(FinishReason::ABANDON_NAVIGATION);
+    else
+      initial_entry_committed_ = true;
+  }
+}
+
+void FirstWebContentsProfiler::WasHidden() {
+  // Stop profiling if the content gets hidden as its load may be deprioritized
+  // and timing it becomes meaningless.
+  FinishedCollectingMetrics(FinishReason::ABANDON_CONTENT_HIDDEN);
 }
 
 void FirstWebContentsProfiler::WebContentsDestroyed() {
-  FinishedCollectingMetrics();
+  FinishedCollectingMetrics(FinishReason::ABANDON_CONTENT_DESTROYED);
 }
 
 bool FirstWebContentsProfiler::IsFinishedCollectingMetrics() {
   return collected_paint_metric_ && collected_load_metric_;
 }
 
-void FirstWebContentsProfiler::FinishedCollectingMetrics() {
+void FirstWebContentsProfiler::FinishedCollectingMetrics(
+    FinishReason finish_reason) {
+  UMA_HISTOGRAM_ENUMERATION("Startup.FirstWebContents.FinishReason",
+                            finish_reason, FinishReason::COUNT);
+  if (!collected_paint_metric_) {
+    UMA_HISTOGRAM_ENUMERATION("Startup.FirstWebContents.FinishReason_NoPaint",
+                              finish_reason, FinishReason::COUNT);
+  }
+  if (!collected_load_metric_) {
+    UMA_HISTOGRAM_ENUMERATION("Startup.FirstWebContents.FinishReason_NoLoad",
+                              finish_reason, FinishReason::COUNT);
+  }
   delegate_->ProfilerFinishedCollectingMetrics();
 }
 
 void FirstWebContentsProfiler::InitHistograms() {
   const std::string responsiveness_histogram_name =
       "Startup.FirstWebContents.UIResponsive";
   responsiveness_histogram_ = base::Histogram::FactoryTimeGet(
       responsiveness_histogram_name, base::TimeDelta::FromMilliseconds(1),
       base::TimeDelta::FromSeconds(60), 100,
       base::Histogram::kUmaTargetedHistogramFlag);
@@ skipping 27 matching lines @@
       100, base::Histogram::kUmaTargetedHistogramFlag);
 
   const std::string unresponsiveness_10sec_histogram_name =
       "Startup.FirstWebContents.UINotResponsive_10sec";
   unresponsiveness_10sec_histogram_ = base::Histogram::FactoryTimeGet(
       unresponsiveness_10sec_histogram_name,
       base::TimeDelta::FromMilliseconds(1), base::TimeDelta::FromSeconds(60),
       100, base::Histogram::kUmaTargetedHistogramFlag);
 }
 #endif  // !defined(OS_ANDROID)