Separate page load metrics for backgrounded pages

components/page_load_metrics/browser/metrics_web_contents_observer_unittest.cc

 // Copyright (c) 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.
 
 #include "components/page_load_metrics/browser/metrics_web_contents_observer.h"
 
 #include "base/memory/scoped_ptr.h"
 #include "base/process/kill.h"
 #include "base/test/histogram_tester.h"
 #include "base/time/time.h"
@@ skipping 11 matching lines @@
 const char kDefaultTestUrlAnchor[] = "https://google.com#samepage";
 const char kDefaultTestUrl2[] = "https://whatever.com";
 
 const char kHistogramNameFirstLayout[] =
     "PageLoad.Timing.NavigationToFirstLayout";
 const char kHistogramNameDomContent[] =
     "PageLoad.Timing.NavigationToDOMContentLoadedEventFired";
 const char kHistogramNameLoad[] =
     "PageLoad.Timing.NavigationToLoadEventFired";
 
+const char kBGHistogramNameFirstLayout[] =
+    "PageLoad.Timing.BG.NavigationToFirstLayout";
+const char kBGHistogramNameDomContent[] =
+    "PageLoad.Timing.BG.NavigationToDOMContentLoadedEventFired";
+const char kBGHistogramNameLoad[] =
+    "PageLoad.Timing.BG.NavigationToLoadEventFired";
 }  //  namespace
 
 class MetricsWebContentsObserverTest
     : public content::RenderViewHostTestHarness {
  public:
   MetricsWebContentsObserverTest() {}
 
   void SetUp() override {
     RenderViewHostTestHarness::SetUp();
     observer_ = make_scoped_ptr(new MetricsWebContentsObserver(web_contents()));
+    observer_->WasShown();
   }
 
   void AssertNoHistogramsLogged() {
     histogram_tester_.ExpectTotalCount(kHistogramNameDomContent, 0);
     histogram_tester_.ExpectTotalCount(kHistogramNameLoad, 0);
     histogram_tester_.ExpectTotalCount(kHistogramNameFirstLayout, 0);
   }
 
  protected:
   base::HistogramTester histogram_tester_;
@@ skipping 20 matching lines @@
   content::RenderFrameHost* subframe = rfh_tester->AppendChild("subframe");
 
   content::RenderFrameHostTester* subframe_tester =
       content::RenderFrameHostTester::For(subframe);
   subframe_tester->SimulateNavigationStart(GURL(kDefaultTestUrl2));
   subframe_tester->SimulateNavigationCommit(GURL(kDefaultTestUrl2));
   observer_->OnMessageReceived(
       PageLoadMetricsMsg_TimingUpdated(observer_->routing_id(), timing),
       subframe);
   subframe_tester->SimulateNavigationStop();
+  observer_->DidFinishLoad(web_contents()->GetMainFrame(),

[Bryan McQuade, 2015/09/29 00:43:01]

we probably no longer need these calls to DidFinishLoad, since you removed the
logic related to finish

+                           GURL(kDefaultTestUrl2));
 
   // Navigate again to see if the timing updated for a subframe message.
   web_contents_tester->NavigateAndCommit(GURL(kDefaultTestUrl));
 
   AssertNoHistogramsLogged();
 }
 
 TEST_F(MetricsWebContentsObserverTest, SamePageNoTrigger) {
   base::TimeDelta first_layout = base::TimeDelta::FromMilliseconds(1);
 
   PageLoadTiming timing;
   timing.navigation_start = base::Time::FromDoubleT(1);
   timing.first_layout = first_layout;
 
   content::WebContentsTester* web_contents_tester =
       content::WebContentsTester::For(web_contents());
   web_contents_tester->NavigateAndCommit(GURL(kDefaultTestUrl));
 
   observer_->OnMessageReceived(
       PageLoadMetricsMsg_TimingUpdated(observer_->routing_id(), timing),
       web_contents()->GetMainFrame());
+  observer_->DidFinishLoad(web_contents()->GetMainFrame(),
+                           GURL(kDefaultTestUrl));
   web_contents_tester->NavigateAndCommit(GURL(kDefaultTestUrlAnchor));
   // A same page navigation shouldn't trigger logging UMA for the original.
   AssertNoHistogramsLogged();
 }
 
 TEST_F(MetricsWebContentsObserverTest, SamePageNoTriggerUntilTrueNavCommit) {
   base::TimeDelta first_layout = base::TimeDelta::FromMilliseconds(1);
 
   PageLoadTiming timing;
   timing.navigation_start = base::Time::FromDoubleT(1);
   timing.first_layout = first_layout;
 
   content::WebContentsTester* web_contents_tester =
       content::WebContentsTester::For(web_contents());
   web_contents_tester->NavigateAndCommit(GURL(kDefaultTestUrl));
 
   observer_->OnMessageReceived(
       PageLoadMetricsMsg_TimingUpdated(observer_->routing_id(), timing),
       web_contents()->GetMainFrame());
+  observer_->DidFinishLoad(web_contents()->GetMainFrame(),
+                           GURL(kDefaultTestUrl));
   web_contents_tester->NavigateAndCommit(GURL(kDefaultTestUrlAnchor));
+  observer_->DidFinishLoad(web_contents()->GetMainFrame(),
+                           GURL(kDefaultTestUrlAnchor));
   // A same page navigation shouldn't trigger logging UMA for the original.
   AssertNoHistogramsLogged();
 
   // But we should keep the timing info and log it when we get another
   // navigation.
   web_contents_tester->NavigateAndCommit(GURL(kDefaultTestUrl2));
   histogram_tester_.ExpectTotalCount(kHistogramNameDomContent, 0);
   histogram_tester_.ExpectTotalCount(kHistogramNameLoad, 0);
   histogram_tester_.ExpectTotalCount(kHistogramNameFirstLayout, 1);
   histogram_tester_.ExpectBucketCount(kHistogramNameFirstLayout,
                                       first_layout.InMilliseconds(), 1);
 }
 
 TEST_F(MetricsWebContentsObserverTest, SingleMetricAfterCommit) {
   base::TimeDelta first_layout = base::TimeDelta::FromMilliseconds(1);
 
   PageLoadTiming timing;
   timing.navigation_start = base::Time::FromDoubleT(1);
   timing.first_layout = first_layout;
 
   content::WebContentsTester* web_contents_tester =
       content::WebContentsTester::For(web_contents());
   web_contents_tester->NavigateAndCommit(GURL(kDefaultTestUrl));
 
   observer_->OnMessageReceived(
       PageLoadMetricsMsg_TimingUpdated(observer_->routing_id(), timing),
       web_contents()->GetMainFrame());
+  observer_->DidFinishLoad(web_contents()->GetMainFrame(),
+                           GURL(kDefaultTestUrl));
 
   AssertNoHistogramsLogged();
 
   // Navigate again to force histogram recording.
   web_contents_tester->NavigateAndCommit(GURL(kDefaultTestUrl2));
 
   histogram_tester_.ExpectTotalCount(kHistogramNameDomContent, 0);
   histogram_tester_.ExpectTotalCount(kHistogramNameLoad, 0);
   histogram_tester_.ExpectTotalCount(kHistogramNameFirstLayout, 1);
   histogram_tester_.ExpectBucketCount(kHistogramNameFirstLayout,
@@ skipping 14 matching lines @@
   timing.dom_content_loaded_event_start = dom_content;
   timing.load_event_start = load;
 
   content::WebContentsTester* web_contents_tester =
       content::WebContentsTester::For(web_contents());
   web_contents_tester->NavigateAndCommit(GURL(kDefaultTestUrl));
 
   observer_->OnMessageReceived(
       PageLoadMetricsMsg_TimingUpdated(observer_->routing_id(), timing),
       web_contents()->GetMainFrame());
+  observer_->DidFinishLoad(web_contents()->GetMainFrame(),
+                           GURL(kDefaultTestUrl));
 
   web_contents_tester->NavigateAndCommit(GURL(kDefaultTestUrl2));
 
   PageLoadTiming timing2;
   timing2.navigation_start = base::Time::FromDoubleT(200);
   timing2.first_layout = first_layout_2;
 
   observer_->OnMessageReceived(
       PageLoadMetricsMsg_TimingUpdated(observer_->routing_id(), timing2),
       web_contents()->GetMainFrame());
+  observer_->DidFinishLoad(web_contents()->GetMainFrame(),
+                           GURL(kDefaultTestUrl2));
 
   web_contents_tester->NavigateAndCommit(GURL(kDefaultTestUrl));
 
   histogram_tester_.ExpectBucketCount(kHistogramNameFirstLayout,
                                       first_layout_1.InMilliseconds(), 1);
   histogram_tester_.ExpectTotalCount(kHistogramNameFirstLayout, 2);
   histogram_tester_.ExpectBucketCount(kHistogramNameFirstLayout,
                                       first_layout_1.InMilliseconds(), 1);
   histogram_tester_.ExpectBucketCount(kHistogramNameFirstLayout,
                                       first_layout_2.InMilliseconds(), 1);
 
   histogram_tester_.ExpectTotalCount(kHistogramNameDomContent, 1);
   histogram_tester_.ExpectBucketCount(kHistogramNameDomContent,
                                       dom_content.InMilliseconds(), 1);
 
   histogram_tester_.ExpectTotalCount(kHistogramNameLoad, 1);
   histogram_tester_.ExpectBucketCount(kHistogramNameLoad, load.InMilliseconds(),
                                       1);
 }
 
+TEST_F(MetricsWebContentsObserverTest, BackgroundDifferentHistogram) {
+  base::TimeDelta first_layout = base::TimeDelta::FromMilliseconds(1);
+
+  PageLoadTiming timing;
+  timing.navigation_start = base::Time::FromDoubleT(1);
+  timing.first_layout = first_layout;
+
+  content::WebContentsTester* web_contents_tester =
+      content::WebContentsTester::For(web_contents());
+
+  // Simulate "Open link in new tab."
+  observer_->WasHidden();
+  web_contents_tester->NavigateAndCommit(GURL(kDefaultTestUrl));
+
+  observer_->OnMessageReceived(
+      PageLoadMetricsMsg_TimingUpdated(observer_->routing_id(), timing),
+      web_contents()->GetMainFrame());
+
+  // Simulate switching to the tab and making another navigation.
+  observer_->WasShown();
+  observer_->DidFinishLoad(web_contents()->GetMainFrame(),
+                           GURL(kDefaultTestUrl));
+  AssertNoHistogramsLogged();
+
+  // Navigate again to force histogram recording.
+  web_contents_tester->NavigateAndCommit(GURL(kDefaultTestUrl2));
+
+  histogram_tester_.ExpectTotalCount(kBGHistogramNameDomContent, 0);
+  histogram_tester_.ExpectTotalCount(kBGHistogramNameLoad, 0);
+  histogram_tester_.ExpectTotalCount(kBGHistogramNameFirstLayout, 1);
+  histogram_tester_.ExpectBucketCount(kBGHistogramNameFirstLayout,
+                                      first_layout.InMilliseconds(), 1);
+
+  histogram_tester_.ExpectTotalCount(kHistogramNameDomContent, 0);
+  histogram_tester_.ExpectTotalCount(kHistogramNameLoad, 0);
+  histogram_tester_.ExpectTotalCount(kHistogramNameFirstLayout, 0);
+}
+
+TEST_F(MetricsWebContentsObserverTest, DontBackgroundQuickerLoad) {
+  base::TimeDelta first_layout = base::TimeDelta::FromMilliseconds(1);
+
+  PageLoadTiming timing;
+  timing.navigation_start = base::Time::FromDoubleT(1);
+  timing.first_layout = first_layout;
+
+  observer_->WasHidden();
+
+  // Open in new tab
+  content::WebContentsTester* web_contents_tester =
+      content::WebContentsTester::For(web_contents());
+
+  web_contents_tester->StartNavigation(GURL(kDefaultTestUrl));
+
+  content::RenderFrameHostTester* rfh_tester =
+      content::RenderFrameHostTester::For(main_rfh());
+
+  // Switch to the tab
+  observer_->WasShown();
+
+  // Start another provisional load
+  web_contents_tester->StartNavigation(GURL(kDefaultTestUrl2));
+  rfh_tester->SimulateNavigationCommit(GURL(kDefaultTestUrl2));
+  observer_->OnMessageReceived(
+      PageLoadMetricsMsg_TimingUpdated(observer_->routing_id(), timing),
+      main_rfh());
+  rfh_tester->SimulateNavigationStop();
+
+  observer_->DidFinishLoad(web_contents()->GetMainFrame(),
+                           GURL(kDefaultTestUrl2));
+
+  // Navigate again to see if the timing updated for a subframe message.
+  web_contents_tester->NavigateAndCommit(GURL(kDefaultTestUrl));
+
+  histogram_tester_.ExpectTotalCount(kHistogramNameDomContent, 0);
+  histogram_tester_.ExpectTotalCount(kHistogramNameLoad, 0);
+  histogram_tester_.ExpectTotalCount(kHistogramNameFirstLayout, 1);
+  histogram_tester_.ExpectBucketCount(kHistogramNameFirstLayout,
+                                      first_layout.InMilliseconds(), 1);
+}

[Bryan McQuade, 2015/09/29 00:43:01]

could we add one more test where some metrics occur before backgrounding, and
some after? (to test the background_time_ logic)

[Charlie Harrison, 2015/09/29 14:13:07]

It's already in the most updated patch :)

 }  // namespace page_load_metrics