Adding previews information to PLM UKM

chrome/browser/previews/previews_infobar_delegate_unittest.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 <memory>
 #include <string>
 
 #include "base/bind.h"
 #include "base/bind_helpers.h"
 #include "base/feature_list.h"
 #include "base/memory/ptr_util.h"
 #include "base/metrics/field_trial.h"
 #include "base/metrics/field_trial_params.h"
+#include "base/metrics/metrics_hashes.h"
 #include "base/optional.h"
 #include "base/test/histogram_tester.h"
 #include "base/test/scoped_feature_list.h"
 #include "base/threading/thread_task_runner_handle.h"
 #include "base/time/time.h"
 #include "chrome/browser/android/android_theme_resources.h"
 #include "chrome/browser/infobars/infobar_service.h"
 #include "chrome/browser/loader/chrome_navigation_data.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/page_load_metrics/observers/page_load_metrics_observer_test_harness.h"
 #include "chrome/browser/previews/previews_infobar_tab_helper.h"
 #include "chrome/grit/generated_resources.h"
 #include "chrome/test/base/chrome_render_view_host_test_harness.h"
 #include "chrome/test/base/testing_browser_process.h"
 #include "components/data_reduction_proxy/core/browser/data_reduction_proxy_config_test_utils.h"
 #include "components/data_reduction_proxy/core/browser/data_reduction_proxy_data.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/browser/data_reduction_proxy_settings.h"
 #include "components/data_reduction_proxy/core/browser/data_reduction_proxy_test_utils.h"
 #include "components/data_reduction_proxy/core/common/data_reduction_proxy_pref_names.h"
 #include "components/infobars/core/confirm_infobar_delegate.h"
 #include "components/infobars/core/infobar.h"
 #include "components/infobars/core/infobar_delegate.h"
 #include "components/network_time/network_time_test_utils.h"
 #include "components/prefs/pref_registry_simple.h"
 #include "components/previews/core/previews_experiments.h"
 #include "components/previews/core/previews_features.h"
 #include "components/proxy_config/proxy_config_pref_names.h"
+#include "components/ukm/test_ukm_recorder.h"
+#include "components/ukm/ukm_source.h"
 #include "components/variations/variations_associated_data.h"
 #include "content/public/browser/navigation_entry.h"
 #include "content/public/browser/navigation_handle.h"
 #include "content/public/browser/reload_type.h"
 #include "content/public/browser/web_contents.h"
 #include "content/public/browser/web_contents_observer.h"
 #include "content/public/browser/web_contents_user_data.h"
 #include "content/public/common/referrer.h"
 #include "content/public/test/test_renderer_host.h"
 #include "content/public/test/web_contents_tester.h"
@@ skipping 55 matching lines @@
 
  private:
   content::ReloadType last_navigation_reload_type_;
   bool should_have_page_id_;
 };
 
 }  // namespace
 
 DEFINE_WEB_CONTENTS_USER_DATA_KEY(TestPreviewsWebContentsObserver);
 
-class PreviewsInfoBarDelegateUnitTest : public ChromeRenderViewHostTestHarness {
+class PreviewsInfoBarDelegateUnitTest
+    : public page_load_metrics::PageLoadMetricsObserverTestHarness {
  protected:
   PreviewsInfoBarDelegateUnitTest()
       : field_trial_list_(new base::FieldTrialList(nullptr)) {}
 
   void SetUp() override {
-    ChromeRenderViewHostTestHarness::SetUp();
+    PageLoadMetricsObserverTestHarness::SetUp();
     InfoBarService::CreateForWebContents(web_contents());
     PreviewsInfoBarTabHelper::CreateForWebContents(web_contents());
     TestPreviewsWebContentsObserver::CreateForWebContents(web_contents());
 
     drp_test_context_ =
         data_reduction_proxy::DataReductionProxyTestContext::Builder()
             .WithMockConfig()
             .SkipSettingsInitialization()
             .Build();
 
@@ skipping 10 matching lines @@
     data_reduction_proxy_settings->InitDataReductionProxySettings(
         drp_test_context_->io_data(), drp_test_context_->pref_service(),
         drp_test_context_->request_context_getter(),
         base::WrapUnique(new data_reduction_proxy::DataStore()),
         base::ThreadTaskRunnerHandle::Get(),
         base::ThreadTaskRunnerHandle::Get());
 
     TestingBrowserProcess::GetGlobal()->SetLocalState(
         drp_test_context_->pref_service());
     network_time::NetworkTimeTracker::RegisterPrefs(registry);
+
+    TestingBrowserProcess::GetGlobal()->SetUkmRecorder(&test_ukm_recorder_);
   }
 
   void TearDown() override {
     drp_test_context_->DestroySettings();
     ChromeRenderViewHostTestHarness::TearDown();
     TestingBrowserProcess::GetGlobal()->SetLocalState(nullptr);
   }
 
   PreviewsInfoBarDelegate* CreateInfoBar(previews::PreviewsType type,
                                          base::Time previews_freshness,
@@ skipping 30 matching lines @@
     scoped_feature_list_.InitWithFeatureList(std::move(feature_list));
   }
 
   void OnDismissPreviewsInfobar(bool user_opt_out) {
     user_opt_out_ = user_opt_out;
   }
 
   InfoBarService* infobar_service() {
     return InfoBarService::FromWebContents(web_contents());
   }
+  size_t ukm_source_count() { return test_ukm_recorder_.sources_count(); }
+
+  size_t ukm_entry_count() { return test_ukm_recorder_.entries_count(); }
+
+  const ukm::UkmSource* GetUkmSourceForUrl(const char* url) {
+    return test_ukm_recorder_.GetSourceForUrl(url);
+  }
+
+  const ukm::mojom::UkmEntry* GetUkmEntry(size_t entry_index) {
+    return test_ukm_recorder_.GetEntry(entry_index);
+  }
+
+  std::vector<const ukm::mojom::UkmEntry*> GetUkmEntriesForSourceID(
+      ukm::SourceId source_id) {
+    std::vector<const ukm::mojom::UkmEntry*> entries;
+    for (size_t i = 0; i < ukm_entry_count(); ++i) {
+      const ukm::mojom::UkmEntry* entry = GetUkmEntry(i);
+      if (entry->source_id == source_id)
+        entries.push_back(entry);
+    }
+    return entries;
+  }
+
+  ukm::mojom::UkmEntryPtr GetMergedEntry(
+      const std::vector<const ukm::mojom::UkmEntry*>& entries) {
+    ukm::mojom::UkmEntryPtr merged_entry = ukm::mojom::UkmEntry::New();
+    for (const auto* entry : entries) {
+      if (merged_entry->event_hash) {
+        EXPECT_EQ(merged_entry->source_id, entry->source_id);
+        EXPECT_EQ(merged_entry->event_hash, entry->event_hash);
+      } else {
+        merged_entry->event_hash = entry->event_hash;
+        merged_entry->source_id = entry->source_id;
+      }
+      for (const auto& metric : entry->metrics) {
+        merged_entry->metrics.emplace_back(metric->Clone());
+      }
+    }
+    return merged_entry;
+  }
+
+  ukm::mojom::UkmEntryPtr GetMergedEntryForSourceID(ukm::SourceId source_id) {
+    ukm::mojom::UkmEntryPtr entry =
+        GetMergedEntry(GetUkmEntriesForSourceID(source_id));
+    return entry;
+  }
+
+  void ExpectOptOutUKM(bool expect, ukm::SourceId source_id) {
+    ukm::mojom::UkmEntryPtr entry = GetMergedEntryForSourceID(source_id);
+    const ukm::mojom::UkmMetric* metric =
+        ukm::TestUkmRecorder::FindMetric(entry.get(), "opt_out");
+    if (!expect) {
+      EXPECT_FALSE(metric);
+    } else {
+      EXPECT_EQ(entry->source_id, source_id);
+      EXPECT_TRUE(metric->value);
+      EXPECT_EQ(entry->event_hash, base::HashMetricName("Previews"));
+    }
+  }
 
   std::unique_ptr<data_reduction_proxy::DataReductionProxyTestContext>
       drp_test_context_;
 
   base::Optional<bool> user_opt_out_;
   std::unique_ptr<base::FieldTrialList> field_trial_list_;
   base::test::ScopedFeatureList scoped_feature_list_;
+
+  ukm::TestUkmRecorder test_ukm_recorder_;
 };
 
 TEST_F(PreviewsInfoBarDelegateUnitTest, InfobarTestNavigationDismissal) {
   base::HistogramTester tester;
 
   CreateInfoBar(previews::PreviewsType::LOFI, base::Time(),
                 true /* is_data_saver_user */);
 
   // Try showing a second infobar. Another should not be shown since the page
   // has not navigated.
@@ skipping 30 matching lines @@
       web_contents(), previews::PreviewsType::LOFI,
       base::Time() /* previews_freshness */, true /* is_data_saver_user */,
       PreviewsInfoBarDelegate::OnDismissPreviewsInfobarCallback());
   EXPECT_EQ(1U, infobar_service()->infobar_count());
 
   // Navigate to test URL as a reload to dismiss the infobar.
   controller().LoadURL(GURL(kTestUrl), content::Referrer(),
                        ui::PAGE_TRANSITION_RELOAD, std::string());
   content::WebContentsTester::For(web_contents())->CommitPendingNavigation();
 
+  ukm::SourceId source_id =
+      page_load_metrics::MetricsWebContentsObserver::FromWebContents(
+          web_contents())
+          ->GetUKMSourceForCommittedLoad()
+          .value();
+
   EXPECT_EQ(0U, infobar_service()->infobar_count());
   EXPECT_FALSE(user_opt_out_.value());
 
   tester.ExpectBucketCount(kUMAPreviewsInfoBarActionLoFi,
                            PreviewsInfoBarDelegate::INFOBAR_DISMISSED_BY_RELOAD,
                            1);
   EXPECT_EQ(0, drp_test_context_->pref_service()->GetInteger(
                    data_reduction_proxy::prefs::kLoFiLoadImagesPerSession));
 
   auto* data_reduction_proxy_settings =
       DataReductionProxyChromeSettingsFactory::GetForBrowserContext(
           web_contents()->GetBrowserContext());
 
   EXPECT_EQ(0u, data_reduction_proxy_settings->data_reduction_proxy_service()
                     ->pingback_client()
                     ->OptOutsSizeForTesting());
+
+  ExpectOptOutUKM(false, source_id);
 }
 
 TEST_F(PreviewsInfoBarDelegateUnitTest, InfobarTestUserDismissal) {
   base::HistogramTester tester;
 
   ConfirmInfoBarDelegate* infobar =
       CreateInfoBar(previews::PreviewsType::LOFI, base::Time(),
                     true /* is_data_saver_user */);
 
   // Simulate dismissing the infobar.
@@ skipping 39 matching lines @@
     field_trial_list_.reset();
     field_trial_list_.reset(new base::FieldTrialList(nullptr));
     if (test.using_previews_blacklist) {
       base::FieldTrialList::CreateFieldTrial(
           "DataReductionProxyPreviewsBlackListTransition", "Enabled_");
     }
     base::HistogramTester tester;
     // Call Reload and CommitPendingNavigation to force DidFinishNavigation.
     web_contents()->GetController().Reload(content::ReloadType::NORMAL, true);
     content::WebContentsTester::For(web_contents())->CommitPendingNavigation();
+    ukm::SourceId source_id =
+        page_load_metrics::MetricsWebContentsObserver::FromWebContents(
+            web_contents())
+            ->GetUKMSourceForCommittedLoad()
+            .value();
 
     ConfirmInfoBarDelegate* infobar =
         CreateInfoBar(previews::PreviewsType::LOFI, base::Time(),
                       true /* is_data_saver_user */);
 
     // Simulate clicking the infobar link.
     if (infobar->LinkClicked(WindowOpenDisposition::CURRENT_TAB))
       infobar_service()->infobar_at(0)->RemoveSelf();
     EXPECT_EQ(0U, infobar_service()->infobar_count());
 
     tester.ExpectBucketCount(
         kUMAPreviewsInfoBarActionLoFi,
         PreviewsInfoBarDelegate::INFOBAR_LOAD_ORIGINAL_CLICKED, 1);
     EXPECT_EQ(test.using_previews_blacklist ? 0 : 1,
               drp_test_context_->pref_service()->GetInteger(
                   data_reduction_proxy::prefs::kLoFiLoadImagesPerSession));
     EXPECT_TRUE(user_opt_out_.value());
 
     auto* data_reduction_proxy_settings =
         DataReductionProxyChromeSettingsFactory::GetForBrowserContext(
             web_contents()->GetBrowserContext());
     EXPECT_EQ(1u, data_reduction_proxy_settings->data_reduction_proxy_service()
                       ->pingback_client()
                       ->OptOutsSizeForTesting());
+    EXPECT_EQ(1u, data_reduction_proxy_settings->data_reduction_proxy_service()
+                      ->pingback_client()
+                      ->OptOutsSizeForTesting());
+
+    ExpectOptOutUKM(true, source_id);
   }
 }
 
 TEST_F(PreviewsInfoBarDelegateUnitTest, InfobarTestClickLinkLitePage) {
   base::HistogramTester tester;
 
   NavigateAndCommit(GURL(kTestUrl));
+  ukm::SourceId source_id =
+      page_load_metrics::MetricsWebContentsObserver::FromWebContents(
+          web_contents())
+          ->GetUKMSourceForCommittedLoad()
+          .value();
 
   ConfirmInfoBarDelegate* infobar =
       CreateInfoBar(previews::PreviewsType::LITE_PAGE, base::Time(),
                     true /* is_data_saver_user */);
 
   // Simulate clicking the infobar link.
   if (infobar->LinkClicked(WindowOpenDisposition::CURRENT_TAB))
     infobar_service()->infobar_at(0)->RemoveSelf();
   EXPECT_EQ(0U, infobar_service()->infobar_count());
 
   tester.ExpectBucketCount(
       kUMAPreviewsInfoBarActionLitePage,
       PreviewsInfoBarDelegate::INFOBAR_LOAD_ORIGINAL_CLICKED, 1);
 
   content::WebContentsTester::For(web_contents())->CommitPendingNavigation();
 
   EXPECT_EQ(content::ReloadType::DISABLE_LOFI_MODE,
             TestPreviewsWebContentsObserver::FromWebContents(web_contents())
                 ->last_navigation_reload_type());
 
   auto* data_reduction_proxy_settings =
       DataReductionProxyChromeSettingsFactory::GetForBrowserContext(
           web_contents()->GetBrowserContext());
 
   EXPECT_EQ(1u, data_reduction_proxy_settings->data_reduction_proxy_service()
                     ->pingback_client()
                     ->OptOutsSizeForTesting());
+  ExpectOptOutUKM(true, source_id);
 }
 
 TEST_F(PreviewsInfoBarDelegateUnitTest, InfobarTestShownOncePerNavigation) {
   ConfirmInfoBarDelegate* infobar =
       CreateInfoBar(previews::PreviewsType::LOFI, base::Time(),
                     true /* is_data_saver_user */);
 
   // Simulate dismissing the infobar.
   infobar->InfoBarDismissed();
   infobar_service()->infobar_at(0)->RemoveSelf();
@@ skipping 115 matching lines @@
 #endif
 }
 
 TEST_F(PreviewsInfoBarDelegateUnitTest, OfflineInfobarDisablesLoFi) {
   base::HistogramTester tester;
 
   TestPreviewsWebContentsObserver::FromWebContents(web_contents())
       ->set_should_have_page_id(false);
 
   NavigateAndCommit(GURL(kTestUrl));
+  ukm::SourceId source_id =
+      page_load_metrics::MetricsWebContentsObserver::FromWebContents(
+          web_contents())
+          ->GetUKMSourceForCommittedLoad()
+          .value();
 
   ConfirmInfoBarDelegate* infobar =
       CreateInfoBar(previews::PreviewsType::OFFLINE, base::Time(),
                     true /* is_data_saver_user */);
 
   tester.ExpectUniqueSample(kUMAPreviewsInfoBarActionOffline,
                             PreviewsInfoBarDelegate::INFOBAR_SHOWN, 1);
 
   // Simulate clicking the infobar link.
   if (infobar->LinkClicked(WindowOpenDisposition::CURRENT_TAB))
     infobar_service()->infobar_at(0)->RemoveSelf();
   EXPECT_EQ(0U, infobar_service()->infobar_count());
 
   content::WebContentsTester::For(web_contents())->CommitPendingNavigation();
 
   EXPECT_EQ(content::ReloadType::DISABLE_LOFI_MODE,
             TestPreviewsWebContentsObserver::FromWebContents(web_contents())
                 ->last_navigation_reload_type());
 
   auto* data_reduction_proxy_settings =
       DataReductionProxyChromeSettingsFactory::GetForBrowserContext(
           web_contents()->GetBrowserContext());
 
   EXPECT_EQ(0u, data_reduction_proxy_settings->data_reduction_proxy_service()
                     ->pingback_client()
                     ->OptOutsSizeForTesting());
+
+  ExpectOptOutUKM(false, source_id);
 }
 
 TEST_F(PreviewsInfoBarDelegateUnitTest, PingbackClientClearedTabClosed) {
   base::HistogramTester tester;
 
   NavigateAndCommit(GURL(kTestUrl));
 
   ConfirmInfoBarDelegate* infobar =
       CreateInfoBar(previews::PreviewsType::LITE_PAGE, base::Time(),
                     true /* is_data_saver_user */);
@@ skipping 77 matching lines @@
 
   PreviewsInfoBarDelegate* infobar = CreateInfoBar(
       previews::PreviewsType::LITE_PAGE,
       base::Time::Now() - base::TimeDelta::FromHours(staleness_in_hours),
       true /* is_data_saver_user */);
 
   ASSERT_EQ(l10n_util::GetStringFUTF16(IDS_PREVIEWS_INFOBAR_TIMESTAMP_HOURS,
                                        base::IntToString16(staleness_in_hours)),
             infobar->GetTimestampText());
 }