Use FrameIsAd to decide whether to isolate a frame in TopDocumentIsolation mode.

chrome/browser/page_load_metrics/observers/ads_page_load_metrics_observer.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 <utility>
 
 #include "base/feature_list.h"
 #include "base/logging.h"
 #include "base/memory/ptr_util.h"
 #include "base/strings/string_util.h"
+#include "chrome/browser/page_load_metrics/ads_detection.h"
 #include "chrome/browser/page_load_metrics/page_load_metrics_util.h"
 #include "content/public/browser/navigation_handle.h"
 #include "content/public/browser/render_frame_host.h"
 #include "content/public/browser/web_contents.h"
 #include "url/gurl.h"
 
 namespace {
 
 const base::Feature kAdsFeature{"AdsMetrics", base::FEATURE_ENABLED_BY_DEFAULT};
 
 #define ADS_HISTOGRAM(suffix, hist_macro, ad_type, value)                  \
   switch (ad_type) {                                                       \
-    case AdsPageLoadMetricsObserver::AD_TYPE_GOOGLE:                       \
+    case page_load_metrics::AD_TYPE_GOOGLE:                                \
       hist_macro("PageLoad.Clients.Ads.Google." suffix, value);            \
       break;                                                               \
-    case AdsPageLoadMetricsObserver::AD_TYPE_SUBRESOURCE_FILTER:           \
+    case page_load_metrics::AD_TYPE_SUBRESOURCE_FILTER:                    \
       hist_macro("PageLoad.Clients.Ads.SubresourceFilter." suffix, value); \
       break;                                                               \
-    case AdsPageLoadMetricsObserver::AD_TYPE_ALL:                          \
+    case page_load_metrics::AD_TYPE_ALL:                                   \
       hist_macro("PageLoad.Clients.Ads.All." suffix, value);               \
       break;                                                               \
   }
 
-bool DetectGoogleAd(content::NavigationHandle* navigation_handle) {
-  // Because sub-resource filtering isn't always enabled, and doesn't work
-  // well in monitoring mode (no CSS enforcement), it's difficult to identify
-  // ads. Google ads are prevalent and easy to track, so we'll start by
-  // tracking those. Note that the frame name can be very large, so be careful
-  // to avoid full string searches if possible.
-  // TODO(jkarlin): Track other ad networks that are easy to identify.
-
-  // In case the navigation aborted, look up the RFH by the Frame Tree Node
-  // ID. It returns the committed frame host or the initial frame host for the
-  // frame if no committed host exists. Using a previous host is fine because
-  // once a frame has an ad we always consider it to have an ad.
-  // We use the unsafe method of FindFrameByFrameTreeNodeId because we're not
-  // concerned with which process the frame lives on (we're just measuring
-  // bytes and not granting security priveleges).
-  content::RenderFrameHost* current_frame_host =
-      navigation_handle->GetWebContents()->UnsafeFindFrameByFrameTreeNodeId(
-          navigation_handle->GetFrameTreeNodeId());
-  if (current_frame_host) {
-    const std::string& frame_name = current_frame_host->GetFrameName();
-    if (base::StartsWith(frame_name, "google_ads_iframe",
-                         base::CompareCase::SENSITIVE) ||
-        base::StartsWith(frame_name, "google_ads_frame",
-                         base::CompareCase::SENSITIVE)) {
-      return true;
-    }
-  }
-
-  const GURL& url = navigation_handle->GetURL();
-  return url.host_piece() == "tpc.googlesyndication.com" &&
-         base::StartsWith(url.path_piece(), "/safeframe",
-                          base::CompareCase::SENSITIVE);
-}
-
-void RecordParentExistsForSubFrame(
-    bool parent_exists,
-    const AdsPageLoadMetricsObserver::AdTypes& ad_types) {
+void RecordParentExistsForSubFrame(bool parent_exists,
+                                   const page_load_metrics::AdTypes& ad_types) {
   ADS_HISTOGRAM("ParentExistsForSubFrame", UMA_HISTOGRAM_BOOLEAN,
-                AdsPageLoadMetricsObserver::AD_TYPE_ALL, parent_exists);
+                page_load_metrics::AD_TYPE_ALL, parent_exists);
 }
 
 }  // namespace
 
 AdsPageLoadMetricsObserver::AdFrameData::AdFrameData(
     FrameTreeNodeId frame_tree_node_id,
-    AdTypes ad_types)
+    page_load_metrics::AdTypes ad_types)
     : frame_bytes(0u),
       frame_bytes_uncached(0u),
       frame_tree_node_id(frame_tree_node_id),
       ad_types(ad_types) {}
 
 // static
 std::unique_ptr<AdsPageLoadMetricsObserver>
 AdsPageLoadMetricsObserver::CreateIfNeeded() {
   if (!base::FeatureList::IsEnabled(kAdsFeature))
     return nullptr;
@@ skipping 37 matching lines @@
 void AdsPageLoadMetricsObserver::OnDidFinishSubFrameNavigation(
     content::NavigationHandle* navigation_handle) {
   // Determine if the frame is part of an existing ad, the root of a new ad,
   // or a non-ad frame. Once a frame is labled as an ad, it is always
   // considered an ad, even if it navigates to a non-ad page. This function
   // labels all of a page's frames, even those that fail to commit.
   FrameTreeNodeId frame_tree_node_id = navigation_handle->GetFrameTreeNodeId();
   content::RenderFrameHost* parent_frame_host =
       navigation_handle->GetParentFrame();
 
-  AdTypes ad_types = DetectAds(navigation_handle);
+  page_load_metrics::AdTypes ad_types =
+      page_load_metrics::GetDetectedAdTypes(navigation_handle);
 
   const auto& id_and_data = ad_frames_data_.find(frame_tree_node_id);
   if (id_and_data != ad_frames_data_.end()) {
     // An existing subframe is navigating again.
     if (id_and_data->second) {
       // The subframe was an ad to begin with, keep tracking it as an ad.
       ProcessOngoingNavigationResource(frame_tree_node_id);
 
       if (frame_tree_node_id == id_and_data->second->frame_tree_node_id) {
         // This is the top-most frame in the ad.
         ADS_HISTOGRAM("Navigations.AdFrameRenavigatedToAd",
-                      UMA_HISTOGRAM_BOOLEAN, AD_TYPE_ALL, ad_types.any());
+                      UMA_HISTOGRAM_BOOLEAN, page_load_metrics::AD_TYPE_ALL,
+                      ad_types.any());
       }
       return;
     }
     // This frame was previously not an ad, process it as usual. If it had
     // any child frames that were ads, those will still be recorded.
     ADS_HISTOGRAM("Navigations.NonAdFrameRenavigatedToAd",
-                  UMA_HISTOGRAM_BOOLEAN, AD_TYPE_ALL, ad_types.any());
+                  UMA_HISTOGRAM_BOOLEAN, page_load_metrics::AD_TYPE_ALL,
+                  ad_types.any());
   }
 
   // Determine who the parent frame's ad ancestor is.
   const auto& parent_id_and_data =
       ad_frames_data_.find(parent_frame_host->GetFrameTreeNodeId());
   if (parent_id_and_data == ad_frames_data_.end()) {
     // We don't know who the parent for this frame is. One possibility is that
     // it's a frame from a previous navigation.
     RecordParentExistsForSubFrame(false /* parent_exists */, ad_types);
     return;
@@ skipping 36 matching lines @@
   RecordHistograms();
 }
 
 void AdsPageLoadMetricsObserver::OnSubframeNavigationEvaluated(
     content::NavigationHandle* navigation_handle,
     subresource_filter::LoadPolicy load_policy) {
   // We don't track DISALLOW frames because their resources won't be loaded
   // and therefore would provide bad histogram data. Note that WOULD_DISALLOW
   // is only seen in dry runs.
   if (load_policy == subresource_filter::LoadPolicy::WOULD_DISALLOW) {
-    unfinished_subresource_ad_frames_.insert(
-        navigation_handle->GetFrameTreeNodeId());
+    SetDetectedAdType(navigation_handle,
+                      page_load_metrics::AD_TYPE_SUBRESOURCE_FILTER);
   }
 }
 
 void AdsPageLoadMetricsObserver::OnSubresourceFilterGoingAway() {
   subresource_observer_.RemoveAll();
 }
 
-bool AdsPageLoadMetricsObserver::DetectSubresourceFilterAd(
-    FrameTreeNodeId frame_tree_node_id) {
-  return unfinished_subresource_ad_frames_.erase(frame_tree_node_id);
-}
-
-AdsPageLoadMetricsObserver::AdTypes AdsPageLoadMetricsObserver::DetectAds(
-    content::NavigationHandle* navigation_handle) {
-  AdTypes ad_types;
-
-  if (DetectGoogleAd(navigation_handle))
-    ad_types.set(AD_TYPE_GOOGLE);
-
-  if (DetectSubresourceFilterAd(navigation_handle->GetFrameTreeNodeId()))
-    ad_types.set(AD_TYPE_SUBRESOURCE_FILTER);
-
-  return ad_types;
-}
-
 void AdsPageLoadMetricsObserver::ProcessLoadedResource(
     const page_load_metrics::ExtraRequestCompleteInfo& extra_request_info) {
   const auto& id_and_data =
       ad_frames_data_.find(extra_request_info.frame_tree_node_id);
   if (id_and_data == ad_frames_data_.end()) {
     if (extra_request_info.resource_type == content::RESOURCE_TYPE_MAIN_FRAME ||
         extra_request_info.resource_type == content::RESOURCE_TYPE_SUB_FRAME) {
       // This resource request is the primary resource load for a frame that
       // hasn't yet finished navigating. Hang onto the request info and replay
       // it once the frame finishes navigating.
@@ skipping 32 matching lines @@
 
   if (ancestor_data) {
     ancestor_data->frame_bytes += extra_request_info.raw_body_bytes;
     if (!extra_request_info.was_cached) {
       ancestor_data->frame_bytes_uncached += extra_request_info.raw_body_bytes;
     }
   }
 }
 
 void AdsPageLoadMetricsObserver::RecordHistograms() {
-  RecordHistogramsForType(AD_TYPE_GOOGLE);
-  RecordHistogramsForType(AD_TYPE_SUBRESOURCE_FILTER);
-  RecordHistogramsForType(AD_TYPE_ALL);
+  RecordHistogramsForType(page_load_metrics::AD_TYPE_GOOGLE);
+  RecordHistogramsForType(page_load_metrics::AD_TYPE_SUBRESOURCE_FILTER);
+  RecordHistogramsForType(page_load_metrics::AD_TYPE_ALL);
 }
 
 void AdsPageLoadMetricsObserver::RecordHistogramsForType(int ad_type) {
   if (page_bytes_ == 0)
     return;
 
   int non_zero_ad_frames = 0;
   size_t total_ad_frame_bytes = 0;
   size_t uncached_ad_frame_bytes = 0;
 
   for (const AdFrameData& ad_frame_data : ad_frames_data_storage_) {
     if (ad_frame_data.frame_bytes == 0)
       continue;
 
     // If this isn't the type of ad we're looking for, move on to the next.
-    if (ad_type != AD_TYPE_ALL && !ad_frame_data.ad_types.test(ad_type))
+    if (ad_type != page_load_metrics::AD_TYPE_ALL &&
+        !ad_frame_data.ad_types.test(ad_type))
       continue;
 
     non_zero_ad_frames += 1;
     total_ad_frame_bytes += ad_frame_data.frame_bytes;
 
     uncached_ad_frame_bytes += ad_frame_data.frame_bytes_uncached;
     ADS_HISTOGRAM("Bytes.AdFrames.PerFrame.Total", PAGE_BYTES_HISTOGRAM,
                   ad_type, ad_frame_data.frame_bytes);
     ADS_HISTOGRAM("Bytes.AdFrames.PerFrame.Network", PAGE_BYTES_HISTOGRAM,
                   ad_type, ad_frame_data.frame_bytes_uncached);
@@ skipping 43 matching lines @@
 void AdsPageLoadMetricsObserver::ProcessOngoingNavigationResource(
     FrameTreeNodeId frame_tree_node_id) {
   const auto& frame_id_and_request =
       ongoing_navigation_resources_.find(frame_tree_node_id);
   if (frame_id_and_request == ongoing_navigation_resources_.end())
     return;
 
   ProcessLoadedResource(frame_id_and_request->second);
   ongoing_navigation_resources_.erase(frame_id_and_request);
 }