chrome/browser/resource_coordinator/tab_metrics_logger_unittest.cc - chromium/src - Git at Google

 // Copyright 2018 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/resource_coordinator/tab_metrics_logger.h"

 #include "base/test/scoped_task_environment.h"
 #include "chrome/browser/browser_process.h"
 #include "chrome/browser/engagement/site_engagement_service.h"
 #include "chrome/browser/resource_coordinator/tab_ranker/mru_features.h"
 #include "chrome/browser/resource_coordinator/tab_ranker/tab_features.h"
 #include "chrome/browser/ui/browser.h"
 #include "chrome/browser/ui/tabs/tab_activity_simulator.h"
 #include "chrome/browser/ui/tabs/tab_strip_model.h"
 #include "chrome/test/base/chrome_render_view_host_test_harness.h"
 #include "chrome/test/base/test_browser_window.h"
 #include "chrome/test/base/testing_profile.h"
 #include "components/ukm/test_ukm_recorder.h"
 #include "content/public/browser/web_contents.h"
 #include "content/public/test/web_contents_tester.h"
 #include "testing/gtest/include/gtest/gtest.h"

 using content::WebContentsTester;

 // Sanity checks for functions in TabMetricsLogger.
 // See TabActivityWatcherTest for more thorough tab usage UKM tests.
 using TabMetricsLoggerTest = ChromeRenderViewHostTestHarness;

 // Tests creating a flat TabFeatures structure for logging a tab and its
 // TabMetrics state.
 TEST_F(TabMetricsLoggerTest, TabFeatures) {
   TabActivitySimulator tab_activity_simulator;
   Browser::CreateParams params(profile(), true);
   std::unique_ptr<Browser> browser =
       CreateBrowserWithTestWindowForParams(&params);
   TabStripModel* tab_strip_model = browser->tab_strip_model();

   // Add a foreground tab.
   tab_activity_simulator.AddWebContentsAndNavigate(tab_strip_model,
                                                    GURL("about://blank"));
   tab_strip_model->ActivateTabAt(0, false);

   // Add a background tab to test.
   content::WebContents* bg_contents =
       tab_activity_simulator.AddWebContentsAndNavigate(
           tab_strip_model, GURL("http://example.com/test.html"));
   WebContentsTester::For(bg_contents)->TestSetIsLoading(false);

   {
     TabMetricsLogger::TabMetrics bg_metrics;
     bg_metrics.web_contents = bg_contents;
     bg_metrics.page_transition = ui::PAGE_TRANSITION_FORM_SUBMIT;

     base::TimeDelta inactive_duration = base::TimeDelta::FromSeconds(10);

     tab_ranker::TabFeatures bg_features = TabMetricsLogger::GetTabFeatures(
         browser.get(), bg_metrics, inactive_duration);
     EXPECT_EQ(bg_features.has_before_unload_handler, false);
     EXPECT_EQ(bg_features.has_form_entry, false);
     EXPECT_EQ(bg_features.host, "example.com");
     EXPECT_EQ(bg_features.is_pinned, false);
     EXPECT_EQ(bg_features.key_event_count, 0);
     EXPECT_EQ(bg_features.mouse_event_count, 0);
     EXPECT_EQ(bg_features.navigation_entry_count, 1);
     EXPECT_EQ(bg_features.num_reactivations, 0);
     ASSERT_TRUE(bg_features.page_transition_core_type.has_value());
     EXPECT_TRUE(ui::PageTransitionTypeIncludingQualifiersIs(
         ui::PAGE_TRANSITION_FORM_SUBMIT,
         bg_features.page_transition_core_type.value()));
     EXPECT_EQ(bg_features.page_transition_from_address_bar, false);
     EXPECT_EQ(bg_features.page_transition_is_redirect, false);
     ASSERT_TRUE(bg_features.site_engagement_score.has_value());
     EXPECT_EQ(bg_features.site_engagement_score.value(), 0);
     EXPECT_EQ(bg_features.time_from_backgrounded,
               inactive_duration.InMilliseconds());
     EXPECT_EQ(bg_features.touch_event_count, 0);
     EXPECT_EQ(bg_features.was_recently_audible, false);
   }

   // Update tab features.
   ui::PageTransition page_transition = static_cast<ui::PageTransition>(
       ui::PAGE_TRANSITION_LINK | ui::PAGE_TRANSITION_FROM_ADDRESS_BAR);
   tab_activity_simulator.Navigate(bg_contents, GURL("https://www.chromium.org"),
                                   page_transition);
   tab_strip_model->SetTabPinned(1, true);
   SiteEngagementService::Get(profile())->ResetBaseScoreForURL(
       GURL("https://www.chromium.org"), 91);

   {
     TabMetricsLogger::TabMetrics bg_metrics;
     bg_metrics.web_contents = bg_contents;
     bg_metrics.page_transition = page_transition;
     bg_metrics.page_metrics.key_event_count = 3;
     bg_metrics.page_metrics.mouse_event_count = 42;
     bg_metrics.page_metrics.num_reactivations = 5;
     bg_metrics.page_metrics.touch_event_count = 10;

     base::TimeDelta inactive_duration = base::TimeDelta::FromSeconds(5);

     tab_ranker::TabFeatures bg_features = TabMetricsLogger::GetTabFeatures(
         browser.get(), bg_metrics, inactive_duration);
     EXPECT_EQ(bg_features.has_before_unload_handler, false);
     EXPECT_EQ(bg_features.has_form_entry, false);
     EXPECT_EQ(bg_features.host, "www.chromium.org");
     EXPECT_EQ(bg_features.is_pinned, true);
     EXPECT_EQ(bg_features.key_event_count, 3);
     EXPECT_EQ(bg_features.mouse_event_count, 42);
     EXPECT_EQ(bg_features.navigation_entry_count, 2);
     EXPECT_EQ(bg_features.num_reactivations, 5);
     ASSERT_TRUE(bg_features.page_transition_core_type.has_value());
     EXPECT_TRUE(ui::PageTransitionTypeIncludingQualifiersIs(
         ui::PAGE_TRANSITION_LINK,
         bg_features.page_transition_core_type.value()));
     EXPECT_EQ(bg_features.page_transition_from_address_bar, true);
     EXPECT_EQ(bg_features.page_transition_is_redirect, false);
     ASSERT_TRUE(bg_features.site_engagement_score.has_value());
     // Site engagement score should round down to the nearest 10.
     EXPECT_EQ(bg_features.site_engagement_score.value(), 90);
     EXPECT_EQ(bg_features.time_from_backgrounded,
               inactive_duration.InMilliseconds());
     EXPECT_EQ(bg_features.touch_event_count, 10);
     EXPECT_EQ(bg_features.was_recently_audible, false);
   }

   tab_strip_model->CloseAllTabs();
 }

 // Checks that ForegroundedOrClosed event is logged correctly.
 // TODO(charleszhao): add checks for TabMetrics event.
 class TabMetricsLoggerUKMTest : public ::testing::Test {
  protected:
   TabMetricsLoggerUKMTest() = default;

   // Returns a new source_id associated with the test url.
   ukm::SourceId GetSourceId() {
     const ukm::SourceId source_id = ukm::UkmRecorder::GetNewSourceID();
     test_ukm_recorder_.UpdateSourceURL(source_id,
                                        GURL("https://www.chromium.org"));
     return source_id;
   }

   // Returns the fake UKM test recorder.
   ukm::TestUkmRecorder* GetTestUkmRecorder() { return &test_ukm_recorder_; }

   // Returns the TabMetricsLogger being tested.
   TabMetricsLogger* GetLogger() { return &logger_; }

  private:
   // Sets up the task scheduling/task-runner environment for each test.
   base::test::ScopedTaskEnvironment scoped_task_environment_;
   // Sets itself as the global UkmRecorder on construction.
   ukm::TestAutoSetUkmRecorder test_ukm_recorder_;
   // The object being tested:
   TabMetricsLogger logger_;

   DISALLOW_COPY_AND_ASSIGN(TabMetricsLoggerUKMTest);
 };

 // Checks the foregrounded event is logged correctly.
 TEST_F(TabMetricsLoggerUKMTest, LogBackgroundTabShown) {
   const tab_ranker::MRUFeatures& mru_metrics{4, 7};
   const int64_t inactive_duration_ms = 1234;
   const bool is_discarded = false;

   GetLogger()->LogBackgroundTabShown(
       GetSourceId(), base::TimeDelta::FromMilliseconds(inactive_duration_ms),
       mru_metrics, is_discarded);

   // Checks that the size is logged correctly.
   EXPECT_EQ(1U, GetTestUkmRecorder()->sources_count());
   EXPECT_EQ(1U, GetTestUkmRecorder()->entries_count());
   const std::vector<const ukm::mojom::UkmEntry*> entries =
       GetTestUkmRecorder()->GetEntriesByName(
           "TabManager.Background.ForegroundedOrClosed");
   EXPECT_EQ(1U, entries.size());

   // Checks that all the fields are logged correctly.
   GetTestUkmRecorder()->ExpectEntryMetric(entries[0], "SequenceId", 1);
   GetTestUkmRecorder()->ExpectEntryMetric(entries[0], "IsForegrounded", 1);
   GetTestUkmRecorder()->ExpectEntryMetric(entries[0], "MRUIndex",
                                           mru_metrics.index);
   GetTestUkmRecorder()->ExpectEntryMetric(entries[0], "TimeFromBackgrounded",
                                           inactive_duration_ms);
   GetTestUkmRecorder()->ExpectEntryMetric(entries[0], "TotalTabCount",
                                           mru_metrics.total);
   GetTestUkmRecorder()->ExpectEntryMetric(entries[0], "IsDiscarded",
                                           is_discarded);
 }

 // Checks the closed event is logged correctly.
 TEST_F(TabMetricsLoggerUKMTest, LogBackgroundTabClosed) {
   const tab_ranker::MRUFeatures& mru_metrics{4, 7};
   const int64_t inactive_duration_ms = 1234;
   const bool is_discarded = true;

   GetLogger()->LogBackgroundTabClosed(
       GetSourceId(), base::TimeDelta::FromMilliseconds(inactive_duration_ms),
       mru_metrics, is_discarded);

   // Checks that the size is logged correctly.
   EXPECT_EQ(1U, GetTestUkmRecorder()->sources_count());
   EXPECT_EQ(1U, GetTestUkmRecorder()->entries_count());
   const std::vector<const ukm::mojom::UkmEntry*> entries =
       GetTestUkmRecorder()->GetEntriesByName(
           "TabManager.Background.ForegroundedOrClosed");
   EXPECT_EQ(1U, entries.size());

   // Checks that all the fields are logged correctly.
   GetTestUkmRecorder()->ExpectEntryMetric(entries[0], "SequenceId", 1);
   GetTestUkmRecorder()->ExpectEntryMetric(entries[0], "IsForegrounded", 0);
   GetTestUkmRecorder()->ExpectEntryMetric(entries[0], "MRUIndex",
                                           mru_metrics.index);
   GetTestUkmRecorder()->ExpectEntryMetric(entries[0], "TimeFromBackgrounded",
                                           inactive_duration_ms);
   GetTestUkmRecorder()->ExpectEntryMetric(entries[0], "TotalTabCount",
                                           mru_metrics.total);
   GetTestUkmRecorder()->ExpectEntryMetric(entries[0], "IsDiscarded",
                                           is_discarded);
 }

 // Checks the sequence id is logged as sequentially incremental sequence across
 // different events.
 TEST_F(TabMetricsLoggerUKMTest, SequenceIdShouldBeLoggedSequentially) {
   const bool is_discarded = false;
   GetLogger()->LogBackgroundTabShown(GetSourceId(), base::TimeDelta(),
                                      tab_ranker::MRUFeatures(), is_discarded);
   GetLogger()->LogBackgroundTabClosed(GetSourceId(), base::TimeDelta(),
                                       tab_ranker::MRUFeatures(), is_discarded);

   EXPECT_EQ(2U, GetTestUkmRecorder()->sources_count());
   EXPECT_EQ(2U, GetTestUkmRecorder()->entries_count());
   const std::vector<const ukm::mojom::UkmEntry*> entries =
       GetTestUkmRecorder()->GetEntriesByName(
           "TabManager.Background.ForegroundedOrClosed");
   EXPECT_EQ(2U, entries.size());
   GetTestUkmRecorder()->ExpectEntryMetric(entries[0], "SequenceId", 1);
   GetTestUkmRecorder()->ExpectEntryMetric(entries[1], "SequenceId", 2);
 }
	// Copyright 2018 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/resource_coordinator/tab_metrics_logger.h"

	#include "base/test/scoped_task_environment.h"
	#include "chrome/browser/browser_process.h"
	#include "chrome/browser/engagement/site_engagement_service.h"
	#include "chrome/browser/resource_coordinator/tab_ranker/mru_features.h"
	#include "chrome/browser/resource_coordinator/tab_ranker/tab_features.h"
	#include "chrome/browser/ui/browser.h"
	#include "chrome/browser/ui/tabs/tab_activity_simulator.h"
	#include "chrome/browser/ui/tabs/tab_strip_model.h"
	#include "chrome/test/base/chrome_render_view_host_test_harness.h"
	#include "chrome/test/base/test_browser_window.h"
	#include "chrome/test/base/testing_profile.h"
	#include "components/ukm/test_ukm_recorder.h"
	#include "content/public/browser/web_contents.h"
	#include "content/public/test/web_contents_tester.h"
	#include "testing/gtest/include/gtest/gtest.h"

	using content::WebContentsTester;

	// Sanity checks for functions in TabMetricsLogger.
	// See TabActivityWatcherTest for more thorough tab usage UKM tests.
	using TabMetricsLoggerTest = ChromeRenderViewHostTestHarness;

	// Tests creating a flat TabFeatures structure for logging a tab and its
	// TabMetrics state.
	TEST_F(TabMetricsLoggerTest, TabFeatures) {
	TabActivitySimulator tab_activity_simulator;
	Browser::CreateParams params(profile(), true);
	std::unique_ptr<Browser> browser =
	CreateBrowserWithTestWindowForParams(&params);
	TabStripModel* tab_strip_model = browser->tab_strip_model();

	// Add a foreground tab.
	tab_activity_simulator.AddWebContentsAndNavigate(tab_strip_model,
	GURL("about://blank"));
	tab_strip_model->ActivateTabAt(0, false);

	// Add a background tab to test.
	content::WebContents* bg_contents =
	tab_activity_simulator.AddWebContentsAndNavigate(
	tab_strip_model, GURL("http://example.com/test.html"));
	WebContentsTester::For(bg_contents)->TestSetIsLoading(false);

	{
	TabMetricsLogger::TabMetrics bg_metrics;
	bg_metrics.web_contents = bg_contents;
	bg_metrics.page_transition = ui::PAGE_TRANSITION_FORM_SUBMIT;

	base::TimeDelta inactive_duration = base::TimeDelta::FromSeconds(10);

	tab_ranker::TabFeatures bg_features = TabMetricsLogger::GetTabFeatures(
	browser.get(), bg_metrics, inactive_duration);
	EXPECT_EQ(bg_features.has_before_unload_handler, false);
	EXPECT_EQ(bg_features.has_form_entry, false);
	EXPECT_EQ(bg_features.host, "example.com");
	EXPECT_EQ(bg_features.is_pinned, false);
	EXPECT_EQ(bg_features.key_event_count, 0);
	EXPECT_EQ(bg_features.mouse_event_count, 0);
	EXPECT_EQ(bg_features.navigation_entry_count, 1);
	EXPECT_EQ(bg_features.num_reactivations, 0);
	ASSERT_TRUE(bg_features.page_transition_core_type.has_value());
	EXPECT_TRUE(ui::PageTransitionTypeIncludingQualifiersIs(
	ui::PAGE_TRANSITION_FORM_SUBMIT,
	bg_features.page_transition_core_type.value()));
	EXPECT_EQ(bg_features.page_transition_from_address_bar, false);
	EXPECT_EQ(bg_features.page_transition_is_redirect, false);
	ASSERT_TRUE(bg_features.site_engagement_score.has_value());
	EXPECT_EQ(bg_features.site_engagement_score.value(), 0);
	EXPECT_EQ(bg_features.time_from_backgrounded,
	inactive_duration.InMilliseconds());
	EXPECT_EQ(bg_features.touch_event_count, 0);
	EXPECT_EQ(bg_features.was_recently_audible, false);
	}

	// Update tab features.
	ui::PageTransition page_transition = static_cast<ui::PageTransition>(
	ui::PAGE_TRANSITION_LINK \| ui::PAGE_TRANSITION_FROM_ADDRESS_BAR);
	tab_activity_simulator.Navigate(bg_contents, GURL("https://www.chromium.org"),
	page_transition);
	tab_strip_model->SetTabPinned(1, true);
	SiteEngagementService::Get(profile())->ResetBaseScoreForURL(
	GURL("https://www.chromium.org"), 91);

	{
	TabMetricsLogger::TabMetrics bg_metrics;
	bg_metrics.web_contents = bg_contents;
	bg_metrics.page_transition = page_transition;
	bg_metrics.page_metrics.key_event_count = 3;
	bg_metrics.page_metrics.mouse_event_count = 42;
	bg_metrics.page_metrics.num_reactivations = 5;
	bg_metrics.page_metrics.touch_event_count = 10;

	base::TimeDelta inactive_duration = base::TimeDelta::FromSeconds(5);

	tab_ranker::TabFeatures bg_features = TabMetricsLogger::GetTabFeatures(
	browser.get(), bg_metrics, inactive_duration);
	EXPECT_EQ(bg_features.has_before_unload_handler, false);
	EXPECT_EQ(bg_features.has_form_entry, false);
	EXPECT_EQ(bg_features.host, "www.chromium.org");
	EXPECT_EQ(bg_features.is_pinned, true);
	EXPECT_EQ(bg_features.key_event_count, 3);
	EXPECT_EQ(bg_features.mouse_event_count, 42);
	EXPECT_EQ(bg_features.navigation_entry_count, 2);
	EXPECT_EQ(bg_features.num_reactivations, 5);
	ASSERT_TRUE(bg_features.page_transition_core_type.has_value());
	EXPECT_TRUE(ui::PageTransitionTypeIncludingQualifiersIs(
	ui::PAGE_TRANSITION_LINK,
	bg_features.page_transition_core_type.value()));
	EXPECT_EQ(bg_features.page_transition_from_address_bar, true);
	EXPECT_EQ(bg_features.page_transition_is_redirect, false);
	ASSERT_TRUE(bg_features.site_engagement_score.has_value());
	// Site engagement score should round down to the nearest 10.
	EXPECT_EQ(bg_features.site_engagement_score.value(), 90);
	EXPECT_EQ(bg_features.time_from_backgrounded,
	inactive_duration.InMilliseconds());
	EXPECT_EQ(bg_features.touch_event_count, 10);
	EXPECT_EQ(bg_features.was_recently_audible, false);
	}

	tab_strip_model->CloseAllTabs();
	}

	// Checks that ForegroundedOrClosed event is logged correctly.
	// TODO(charleszhao): add checks for TabMetrics event.
	class TabMetricsLoggerUKMTest : public ::testing::Test {
	protected:
	TabMetricsLoggerUKMTest() = default;

	// Returns a new source_id associated with the test url.
	ukm::SourceId GetSourceId() {
	const ukm::SourceId source_id = ukm::UkmRecorder::GetNewSourceID();
	test_ukm_recorder_.UpdateSourceURL(source_id,
	GURL("https://www.chromium.org"));
	return source_id;
	}

	// Returns the fake UKM test recorder.
	ukm::TestUkmRecorder* GetTestUkmRecorder() { return &test_ukm_recorder_; }

	// Returns the TabMetricsLogger being tested.
	TabMetricsLogger* GetLogger() { return &logger_; }

	private:
	// Sets up the task scheduling/task-runner environment for each test.
	base::test::ScopedTaskEnvironment scoped_task_environment_;
	// Sets itself as the global UkmRecorder on construction.
	ukm::TestAutoSetUkmRecorder test_ukm_recorder_;
	// The object being tested:
	TabMetricsLogger logger_;

	DISALLOW_COPY_AND_ASSIGN(TabMetricsLoggerUKMTest);
	};

	// Checks the foregrounded event is logged correctly.
	TEST_F(TabMetricsLoggerUKMTest, LogBackgroundTabShown) {
	const tab_ranker::MRUFeatures& mru_metrics{4, 7};
	const int64_t inactive_duration_ms = 1234;
	const bool is_discarded = false;

	GetLogger()->LogBackgroundTabShown(
	GetSourceId(), base::TimeDelta::FromMilliseconds(inactive_duration_ms),
	mru_metrics, is_discarded);

	// Checks that the size is logged correctly.
	EXPECT_EQ(1U, GetTestUkmRecorder()->sources_count());
	EXPECT_EQ(1U, GetTestUkmRecorder()->entries_count());
	const std::vector<const ukm::mojom::UkmEntry*> entries =
	GetTestUkmRecorder()->GetEntriesByName(
	"TabManager.Background.ForegroundedOrClosed");
	EXPECT_EQ(1U, entries.size());

	// Checks that all the fields are logged correctly.
	GetTestUkmRecorder()->ExpectEntryMetric(entries[0], "SequenceId", 1);
	GetTestUkmRecorder()->ExpectEntryMetric(entries[0], "IsForegrounded", 1);
	GetTestUkmRecorder()->ExpectEntryMetric(entries[0], "MRUIndex",
	mru_metrics.index);
	GetTestUkmRecorder()->ExpectEntryMetric(entries[0], "TimeFromBackgrounded",
	inactive_duration_ms);
	GetTestUkmRecorder()->ExpectEntryMetric(entries[0], "TotalTabCount",
	mru_metrics.total);
	GetTestUkmRecorder()->ExpectEntryMetric(entries[0], "IsDiscarded",
	is_discarded);
	}

	// Checks the closed event is logged correctly.
	TEST_F(TabMetricsLoggerUKMTest, LogBackgroundTabClosed) {
	const tab_ranker::MRUFeatures& mru_metrics{4, 7};
	const int64_t inactive_duration_ms = 1234;
	const bool is_discarded = true;

	GetLogger()->LogBackgroundTabClosed(
	GetSourceId(), base::TimeDelta::FromMilliseconds(inactive_duration_ms),
	mru_metrics, is_discarded);

	// Checks that the size is logged correctly.
	EXPECT_EQ(1U, GetTestUkmRecorder()->sources_count());
	EXPECT_EQ(1U, GetTestUkmRecorder()->entries_count());
	const std::vector<const ukm::mojom::UkmEntry*> entries =
	GetTestUkmRecorder()->GetEntriesByName(
	"TabManager.Background.ForegroundedOrClosed");
	EXPECT_EQ(1U, entries.size());

	// Checks that all the fields are logged correctly.
	GetTestUkmRecorder()->ExpectEntryMetric(entries[0], "SequenceId", 1);
	GetTestUkmRecorder()->ExpectEntryMetric(entries[0], "IsForegrounded", 0);
	GetTestUkmRecorder()->ExpectEntryMetric(entries[0], "MRUIndex",
	mru_metrics.index);
	GetTestUkmRecorder()->ExpectEntryMetric(entries[0], "TimeFromBackgrounded",
	inactive_duration_ms);
	GetTestUkmRecorder()->ExpectEntryMetric(entries[0], "TotalTabCount",
	mru_metrics.total);
	GetTestUkmRecorder()->ExpectEntryMetric(entries[0], "IsDiscarded",
	is_discarded);
	}

	// Checks the sequence id is logged as sequentially incremental sequence across
	// different events.
	TEST_F(TabMetricsLoggerUKMTest, SequenceIdShouldBeLoggedSequentially) {
	const bool is_discarded = false;
	GetLogger()->LogBackgroundTabShown(GetSourceId(), base::TimeDelta(),
	tab_ranker::MRUFeatures(), is_discarded);
	GetLogger()->LogBackgroundTabClosed(GetSourceId(), base::TimeDelta(),
	tab_ranker::MRUFeatures(), is_discarded);

	EXPECT_EQ(2U, GetTestUkmRecorder()->sources_count());
	EXPECT_EQ(2U, GetTestUkmRecorder()->entries_count());
	const std::vector<const ukm::mojom::UkmEntry*> entries =
	GetTestUkmRecorder()->GetEntriesByName(
	"TabManager.Background.ForegroundedOrClosed");
	EXPECT_EQ(2U, entries.size());
	GetTestUkmRecorder()->ExpectEntryMetric(entries[0], "SequenceId", 1);
	GetTestUkmRecorder()->ExpectEntryMetric(entries[1], "SequenceId", 2);
	}