[PageLoadMetrics] Keep track of Ad Sizes on Pages

chrome/browser/page_load_metrics/observers/ads_page_load_metrics_observer_unittest.cc

+// Copyright 2017 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/observers/ads_page_load_metrics_observer.h"
+
+#include <string>
+
+#include "base/macros.h"
+#include "chrome/browser/page_load_metrics/observers/page_load_metrics_observer_test_harness.h"
+#include "content/public/browser/render_frame_host.h"
+#include "url/gurl.h"
+
+using content::RenderFrameHost;
+using content::RenderFrameHostTester;

[Charlie Harrison, 2017/04/11 17:30:07]

include test_renderer_host.h

[jkarlin, 2017/04/13 17:25:30]

Done.

+
+namespace {

[Charlie Harrison, 2017/04/11 17:30:06]

nit:
namespace {

enum class ResourceCached { NOT_CACHED, CACHED };

}  // namespace

[jkarlin, 2017/04/13 17:25:30]

Done.

+enum class ResourceCached { NOT_CACHED, CACHED };
+}
+
+class AdsPageLoadMetricsObserverTest
+    : public page_load_metrics::PageLoadMetricsObserverTestHarness {
+ public:
+  AdsPageLoadMetricsObserverTest() {}
+
+  RenderFrameHost* NavigateMainFrame(const GURL& url) {
+    NavigateAndCommit(url);
+    return web_contents()->GetMainFrame();
+  }
+
+  RenderFrameHost* CreateAndNavigateSubFrame(const GURL& url,
+                                             const std::string& frame_name,
+                                             content::RenderFrameHost* parent) {
+    RenderFrameHostTester* rfh_tester = RenderFrameHostTester::For(parent);
+    RenderFrameHost* subframe = rfh_tester->AppendChild(frame_name);
+    RenderFrameHostTester* subframe_tester =
+        RenderFrameHostTester::For(subframe);
+    subframe_tester->SimulateNavigationCommit(url);
+    return subframe;

[Charlie Harrison, 2017/04/11 17:30:06]

I wonder if you could use the NavigationSimulator here and above, which will
ensure the code is correct for OOPIF / transfer navigations if you navigate
cross-site.

This is newish territory for the PLM test code but I think it might be needed
now that we care about subframes.

[jkarlin, 2017/04/13 17:25:30]

Done.

+  }
+
+  void LoadResource(RenderFrameHost* frame,
+                    ResourceCached resource_cached,
+                    int resource_size_in_kb) {
+    page_load_metrics::ExtraRequestInfo request(
+        GURL(), frame->GetFrameTreeNodeId(),

[Charlie Harrison, 2017/04/11 17:30:06]

include gurl

[jkarlin, 2017/04/13 17:25:30]

Already there.

+        resource_cached == ResourceCached::CACHED, resource_size_in_kb * 1024,
+        false /* data_reduction_proxy_used */,
+        0 /* original_network_content_length */);
+    SimulateLoadedResource(request);
+  }
+
+ protected:
+  void RegisterObservers(page_load_metrics::PageLoadTracker* tracker) override {

[Charlie Harrison, 2017/04/11 17:30:06]

include page_load_tracker.h

[jkarlin, 2017/04/13 17:25:30]

Done.

+    tracker->AddObserver(base::WrapUnique(new AdsPageLoadMetricsObserver()));

[Charlie Harrison, 2017/04/11 17:30:06]

nit: prefer base::MakeUnique<AdsPageLoadMetricsObserver>()

[jkarlin, 2017/04/13 17:25:30]

Done.

+  }
+
+ private:
+  DISALLOW_COPY_AND_ASSIGN(AdsPageLoadMetricsObserverTest);

[Charlie Harrison, 2017/04/11 17:30:06]

include base/macros.

[jkarlin, 2017/04/13 17:25:30]

Already there.

+};
+
+TEST_F(AdsPageLoadMetricsObserverTest, PageWithNoAds) {
+  RenderFrameHost* main_frame = NavigateMainFrame(GURL("https://foo.com/"));
+  RenderFrameHost* frame1 = CreateAndNavigateSubFrame(
+      GURL("https://foo.com/frame1"), "foo name", main_frame);
+  RenderFrameHost* frame2 =
+      CreateAndNavigateSubFrame(GURL("https://foo.com/frame2"), "", main_frame);
+  LoadResource(main_frame, ResourceCached::NOT_CACHED, 1);
+  LoadResource(frame1, ResourceCached::NOT_CACHED, 1);
+  LoadResource(frame2, ResourceCached::NOT_CACHED, 1);
+
+  // Navigate again to trigger histograms.
+  NavigateMainFrame(GURL("https://bar.com/"));
+
+  histogram_tester().ExpectUniqueSample(
+      "PageLoad.Clients.Ads.Google.PageHasNoAds", 1, 1);
+  histogram_tester().ExpectTotalCount(
+      "PageLoad.Clients.Ads.Google.AdFrameCount", 0);
+  histogram_tester().ExpectTotalCount(
+      "PageLoad.Clients.Ads.Google.Bytes.AdFrames", 0);
+}
+
+TEST_F(AdsPageLoadMetricsObserverTest, ResourceBeforeAdFrameCommits) {
+  RenderFrameHost* main_frame = NavigateMainFrame(GURL("https://foo.com/"));
+
+  LoadResource(main_frame, ResourceCached::NOT_CACHED, 1);
+
+  // Assume that the next frame's id will be the main frame + 1 and load a
+  // resource for that frame. Make sure it gets counted.
+  page_load_metrics::ExtraRequestInfo request(
+      GURL(), main_frame->GetFrameTreeNodeId() + 1, false /* cached */,
+      1024 /* size */, false /* data_reduction_proxy_used */,
+      0 /* original_network_content_length */);
+  SimulateLoadedResource(request);
+
+  CreateAndNavigateSubFrame(GURL("https://foo.com/frame2"),
+                            "google_ads_iframe_1", main_frame);
+
+  // Navigate again to trigger histograms.
+  NavigateMainFrame(GURL("https://bar.com/"));
+
+  // 2KB total were loaded from network, one of which was in an ad frame.
+  histogram_tester().ExpectTotalCount(
+      "PageLoad.Clients.Ads.Google.PageHasNoAds", 0);
+  histogram_tester().ExpectUniqueSample(
+      "PageLoad.Clients.Ads.Google.AdFrameCount", 1, 1);
+
+  // Individual Ad Frame Metrics
+  histogram_tester().ExpectUniqueSample(
+      "PageLoad.Clients.Ads.Google.Bytes.AdFrame", 1, 1);
+  histogram_tester().ExpectUniqueSample(
+      "PageLoad.Clients.Ads.Google.Bytes.AdFrameFromNetwork", 1, 1);
+  histogram_tester().ExpectUniqueSample(
+      "PageLoad.Clients.Ads.Google.BytesPercent.AdFrameFromNetwork", 100, 1);
+
+  // Page percentages
+  histogram_tester().ExpectUniqueSample(
+      "PageLoad.Clients.Ads.Google.BytesPercent.AdFrames", 50, 1);
+  histogram_tester().ExpectUniqueSample(
+      "PageLoad.Clients.Ads.Google.BytesPercent."
+      "AdFramesFromNetworkOfAdFramesTotal",
+      100, 1);
+  histogram_tester().ExpectUniqueSample(
+      "PageLoad.Clients.Ads.Google.Bytes.Percent."
+      "AdFramesFromNetworkOfPageFromNetwork",
+      50, 1);
+
+  // Page byte counts
+  histogram_tester().ExpectUniqueSample(
+      "PageLoad.Clients.Ads.Google.Bytes.AdFrames", 1, 1);
+  histogram_tester().ExpectUniqueSample(
+      "PageLoad.Clients.Ads.Google.Bytes.PageSansAdFrames", 1, 1);
+  histogram_tester().ExpectUniqueSample(
+      "PageLoad.Clients.Ads.Google.Bytes.Page", 2, 1);
+  histogram_tester().ExpectUniqueSample(
+      "PageLoad.Clients.Ads.Google.Bytes.PageFromNetwork", 2, 1);
+  histogram_tester().ExpectUniqueSample(
+      "PageLoad.Clients.Ads.Google.Bytes.AdFramesFromNetwork", 1, 1);
+}
+
+TEST_F(AdsPageLoadMetricsObserverTest, PageWithAdFrames) {
+  RenderFrameHost* main_frame = NavigateMainFrame(GURL("https://foo.com/"));
+  RenderFrameHost* non_ad_frame = CreateAndNavigateSubFrame(
+      GURL("https://foo.com/frame1"), "foo name", main_frame);
+
+  // Create 5 ad frames, one nested inside another. Verify that the nested ad
+  // frame doesn't get counted separately (but that its bytes are still
+  // coutned). Also verify that the various ad signals (urls and names) are
+  // properly detected.
+  RenderFrameHost* ad_frame1 = CreateAndNavigateSubFrame(
+      GURL("https://foo.com/frame2"), "google_ads_iframe_1", main_frame);
+  RenderFrameHost* ad_frame2 = CreateAndNavigateSubFrame(
+      GURL("https://foo.com/frame2"), "google_ads_frame_1", main_frame);
+  RenderFrameHost* ad_frame3 = CreateAndNavigateSubFrame(
+      GURL("http://tpc.googlesyndication.com/safeframe/"), "", main_frame);
+  RenderFrameHost* ad_frame4 = CreateAndNavigateSubFrame(
+      GURL("https://tpc.googlesyndication.com/safeframe/1"), "", main_frame);
+  RenderFrameHost* nested_ad_frame4 = CreateAndNavigateSubFrame(
+      GURL("https://tpc.googlesyndication.com/safeframe/2"), "", ad_frame4);
+
+  // Create an ad frame without content, it shouldn't be counted.
+  CreateAndNavigateSubFrame(
+      GURL("https://tpc.googlesyndication.com/safeframe/3"), "", main_frame);
+
+  // 7 bytes total in page, all from network, 5 from ads.
+  LoadResource(main_frame, ResourceCached::NOT_CACHED, 1);
+  LoadResource(non_ad_frame, ResourceCached::NOT_CACHED, 1);
+  LoadResource(ad_frame1, ResourceCached::NOT_CACHED, 1);
+  LoadResource(ad_frame2, ResourceCached::NOT_CACHED, 1);
+  LoadResource(ad_frame3, ResourceCached::NOT_CACHED, 1);
+  LoadResource(ad_frame4, ResourceCached::NOT_CACHED, 1);
+  LoadResource(nested_ad_frame4, ResourceCached::NOT_CACHED, 1);
+
+  // Navigate again to trigger histograms.
+  NavigateMainFrame(GURL("https://bar.com/"));
+
+  // Individual Ad Frame Metrics
+  histogram_tester().ExpectTotalCount(
+      "PageLoad.Clients.Ads.Google.Bytes.AdFrame", 4);
+  histogram_tester().ExpectTotalCount(
+      "PageLoad.Clients.Ads.Google.Bytes.AdFrameFromNetwork", 4);
+  histogram_tester().ExpectTotalCount(
+      "PageLoad.Clients.Ads.Google.BytesPercent.AdFrameFromNetwork", 4);
+
+  // Counts
+  histogram_tester().ExpectTotalCount(
+      "PageLoad.Clients.Ads.Google.PageHasNoAds", 0);
+  histogram_tester().ExpectUniqueSample(
+      "PageLoad.Clients.Ads.Google.AdFrameCount", 4, 1);
+
+  // Page percentages
+  histogram_tester().ExpectUniqueSample(
+      "PageLoad.Clients.Ads.Google.BytesPercent.AdFrames", 71, 1);
+  histogram_tester().ExpectUniqueSample(
+      "PageLoad.Clients.Ads.Google.BytesPercent."
+      "AdFramesFromNetworkOfAdFramesTotal",
+      100, 1);
+  histogram_tester().ExpectUniqueSample(
+      "PageLoad.Clients.Ads.Google.Bytes.Percent."
+      "AdFramesFromNetworkOfPageFromNetwork",
+      71, 1);
+
+  // Page byte counts
+  histogram_tester().ExpectUniqueSample(
+      "PageLoad.Clients.Ads.Google.Bytes.AdFrames", 5, 1);
+  histogram_tester().ExpectUniqueSample(
+      "PageLoad.Clients.Ads.Google.Bytes.PageSansAdFrames", 2, 1);
+  histogram_tester().ExpectUniqueSample(
+      "PageLoad.Clients.Ads.Google.Bytes.Page", 7, 1);
+  histogram_tester().ExpectUniqueSample(
+      "PageLoad.Clients.Ads.Google.Bytes.PageFromNetwork", 7, 1);
+  histogram_tester().ExpectUniqueSample(
+      "PageLoad.Clients.Ads.Google.Bytes.AdFramesFromNetwork", 5, 1);
+}