Adding previews information to PLM UKM

chrome/browser/previews/previews_infobar_delegate.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/previews/previews_infobar_delegate.h"
 
 #include "base/feature_list.h"
 #include "base/metrics/field_trial_params.h"
 #include "base/metrics/histogram.h"
 #include "base/metrics/histogram_macros.h"
 #include "base/optional.h"
 #include "base/strings/string16.h"
 #include "base/strings/string_number_conversions.h"
 #include "base/strings/utf_string_conversions.h"
 #include "chrome/browser/android/android_theme_resources.h"
 #include "chrome/browser/browser_process.h"
 #include "chrome/browser/infobars/infobar_service.h"
 #include "chrome/browser/net/spdyproxy/data_reduction_proxy_chrome_settings.h"
 #include "chrome/browser/net/spdyproxy/data_reduction_proxy_chrome_settings_factory.h"
+#include "chrome/browser/page_load_metrics/metrics_web_contents_observer.h"
 #include "chrome/browser/previews/previews_infobar_tab_helper.h"
 #include "chrome/grit/generated_resources.h"
 #include "components/data_reduction_proxy/core/browser/data_reduction_proxy_pingback_client.h"
 #include "components/data_reduction_proxy/core/browser/data_reduction_proxy_service.h"
 #include "components/data_reduction_proxy/core/common/data_reduction_proxy_params.h"
 #include "components/infobars/core/infobar.h"
 #include "components/network_time/network_time_tracker.h"
 #include "components/previews/core/previews_features.h"
 #include "content/public/browser/render_frame_host.h"
 #include "content/public/browser/web_contents.h"
 #include "ui/base/l10n/l10n_util.h"
 
 #if defined(OS_ANDROID)
 #include "chrome/browser/ui/android/infobars/previews_infobar.h"
 #endif
 
 namespace {
 
+const void* const kOptOutEventKey = 0;
+
 const char kMinStalenessParamName[] = "min_staleness_in_minutes";
 const char kMaxStalenessParamName[] = "max_staleness_in_minutes";
 const int kMinStalenessParamDefaultValue = 2;
 const int kMaxStalenessParamDefaultValue = 1440;
 
 void RecordPreviewsInfoBarAction(
     previews::PreviewsType previews_type,
     PreviewsInfoBarDelegate::PreviewsInfoBarAction action) {
   int32_t max_limit =
       static_cast<int32_t>(PreviewsInfoBarDelegate::INFOBAR_INDEX_BOUNDARY);
@@ skipping 52 matching lines @@
       break;
     case previews::PreviewsType::LOFI:
       web_contents->ReloadLoFiImages();
       break;
     case previews::PreviewsType::NONE:
     case previews::PreviewsType::LAST:
       break;
   }
 }
 
+void NotifyPLMOfOptOut(content::WebContents* web_contents) {
+  page_load_metrics::MetricsWebContentsObserver* metrics_web_contents_observer =
+      page_load_metrics::MetricsWebContentsObserver::FromWebContents(
+          web_contents);
+  if (!metrics_web_contents_observer)
+    return;
+
+  metrics_web_contents_observer->BroadcastEventToObservers(
+      PreviewsInfoBarDelegate::OptOutEventKey());

[dougarnett, 2017/07/13 16:02:18]

Should we be able to correlate this event somehow with the type of preview that
was presented (and the user didn't like)? 

[RyanSturm, 2017/07/17 18:48:30]

That detection is done in the observer itself. Since this only pushes a
notification for opt outs (and not for non-opt outs), using this code path to
push type isn't helpful.

[dougarnett, 2017/07/17 20:41:21]

I'm asking a question not (yet) asking for a change. Do you expect we will be
able to correlate this event to the type of preview server-side? Eg, is it
grouped with page view group of metrics that would allow for that?
 

+}
+
 }  // namespace
 
 PreviewsInfoBarDelegate::~PreviewsInfoBarDelegate() {
   if (!on_dismiss_callback_.is_null())
     on_dismiss_callback_.Run(false);
 
   RecordPreviewsInfoBarAction(previews_type_, infobar_dismissed_action_);
 }
 
 // static
@@ skipping 113 matching lines @@
   infobar_dismissed_action_ = INFOBAR_LOAD_ORIGINAL_CLICKED;
   if (!on_dismiss_callback_.is_null())
     on_dismiss_callback_.Run(true);
   on_dismiss_callback_.Reset();
 
   content::WebContents* web_contents =
       InfoBarService::WebContentsFromInfoBar(infobar());
 
   ReportPingbackInformation(web_contents);
 
+  NotifyPLMOfOptOut(web_contents);

[tbansal1, 2017/07/12 21:58:45]

Does this class live on UI thread or IO thread?

[RyanSturm, 2017/07/17 18:48:30]

It's all UI thread. I renamed this to "InformPLMOfOptOut"

+
   if ((previews_type_ == previews::PreviewsType::LITE_PAGE ||
        previews_type_ == previews::PreviewsType::LOFI) &&
       !data_reduction_proxy::params::IsBlackListEnabledForServerPreviews()) {
     IncrementDataReductionProxyPrefs(web_contents);
   }
 
   ReloadWithoutPreviews(previews_type_, web_contents);
 
   return true;
 }
@@ skipping 58 matching lines @@
         IDS_PREVIEWS_INFOBAR_TIMESTAMP_MINUTES,
         base::IntToString16(staleness_in_minutes));
   } else if (staleness_in_minutes < 120) {
     return l10n_util::GetStringUTF16(IDS_PREVIEWS_INFOBAR_TIMESTAMP_ONE_HOUR);
   } else {
     return l10n_util::GetStringFUTF16(
         IDS_PREVIEWS_INFOBAR_TIMESTAMP_HOURS,
         base::IntToString16(staleness_in_minutes / 60));
   }
 }
+
+// static
+const void* PreviewsInfoBarDelegate::OptOutEventKey() {
+  return &kOptOutEventKey;
+}