// Copyright 2015 The Chromium Authors // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. #include "components/site_engagement/content/site_engagement_service.h" #include #include #include #include #include "base/files/scoped_temp_dir.h" #include "base/functional/bind.h" #include "base/functional/callback_helpers.h" #include "base/memory/raw_ptr.h" #include "base/run_loop.h" #include "base/test/bind.h" #include "base/test/metrics/histogram_tester.h" #include "base/test/simple_test_clock.h" #include "base/time/default_clock.h" #include "base/time/time.h" #include "build/build_config.h" #include "chrome/browser/content_settings/host_content_settings_map_factory.h" #include "chrome/browser/engagement/history_aware_site_engagement_service.h" #include "chrome/browser/engagement/site_engagement_service_factory.h" #include "chrome/browser/history/history_service_factory.h" #include "chrome/test/base/chrome_render_view_host_test_harness.h" #include "chrome/test/base/testing_profile.h" #include "components/content_settings/core/browser/content_settings_observer.h" #include "components/content_settings/core/browser/host_content_settings_map.h" #include "components/content_settings/core/common/content_settings_types.h" #include "components/history/core/browser/history_database_params.h" #include "components/history/core/browser/history_service.h" #include "components/history/core/test/test_history_database.h" #include "components/prefs/pref_service.h" #include "components/site_engagement/content/engagement_type.h" #include "components/site_engagement/content/site_engagement_helper.h" #include "components/site_engagement/content/site_engagement_metrics.h" #include "components/site_engagement/content/site_engagement_observer.h" #include "components/site_engagement/content/site_engagement_score.h" #include "components/site_engagement/core/pref_names.h" #include "components/webapps/common/web_app_id.h" #include "content/public/browser/browser_task_traits.h" #include "content/public/browser/browser_thread.h" #include "content/public/browser/navigation_entry.h" #include "content/public/browser/web_contents.h" #include "content/public/test/navigation_simulator.h" #include "content/public/test/test_utils.h" #include "testing/gtest/include/gtest/gtest.h" using content::NavigationSimulator; namespace site_engagement { namespace { base::FilePath g_temp_history_dir; const double kMaxRoundingDeviation = 0.0001; // Waits until a change is observed in site engagement content settings. class SiteEngagementChangeWaiter : public content_settings::Observer { public: explicit SiteEngagementChangeWaiter(Profile* profile) : profile_(profile) { HostContentSettingsMapFactory::GetForProfile(profile)->AddObserver(this); } SiteEngagementChangeWaiter(const SiteEngagementChangeWaiter&) = delete; SiteEngagementChangeWaiter& operator=(const SiteEngagementChangeWaiter&) = delete; ~SiteEngagementChangeWaiter() override { HostContentSettingsMapFactory::GetForProfile(profile_)->RemoveObserver( this); } // Overridden from content_settings::Observer: void OnContentSettingChanged( const ContentSettingsPattern& primary_pattern, const ContentSettingsPattern& secondary_pattern, ContentSettingsTypeSet content_type_set) override { if (content_type_set.Contains(ContentSettingsType::SITE_ENGAGEMENT)) Proceed(); } void Wait() { run_loop_.Run(); } private: void Proceed() { run_loop_.Quit(); } raw_ptr profile_; base::RunLoop run_loop_; }; base::Time GetReferenceTime() { static constexpr base::Time::Exploded kReferenceTime = {.year = 2015, .month = 1, .day_of_week = 5, .day_of_month = 30, .hour = 11}; base::Time out_time; EXPECT_TRUE(base::Time::FromLocalExploded(kReferenceTime, &out_time)); return out_time; } std::unique_ptr BuildTestHistoryService( content::BrowserContext* context) { auto history = std::make_unique(); history->Init(history::TestHistoryDatabaseParamsForPath(g_temp_history_dir)); return std::move(history); } std::unique_ptr BuildTestSiteEngagementService( content::BrowserContext* context) { return std::make_unique(context); } } // namespace class ObserverTester : public SiteEngagementObserver { public: ObserverTester(SiteEngagementService* service, content::WebContents* web_contents, const GURL& url, double score, EngagementType type) : SiteEngagementObserver(service), web_contents_(web_contents), url_(url), score_(score), type_(type), callback_called_(false), run_loop_() {} ObserverTester(const ObserverTester&) = delete; ObserverTester& operator=(const ObserverTester&) = delete; void OnEngagementEvent(content::WebContents* web_contents, const GURL& url, double score, double old_score, EngagementType type, const std::optional& app_id) override { EXPECT_EQ(web_contents_, web_contents); EXPECT_EQ(url_, url); EXPECT_DOUBLE_EQ(score_, score); EXPECT_EQ(type_, type); set_callback_called(true); run_loop_.Quit(); } void Wait() { run_loop_.Run(); } bool callback_called() { return callback_called_; } void set_callback_called(bool callback_called) { callback_called_ = callback_called; } private: raw_ptr web_contents_; GURL url_; double score_; EngagementType type_; bool callback_called_; base::RunLoop run_loop_; }; class SiteEngagementServiceTest : public ChromeRenderViewHostTestHarness { public: void SetUp() override { ChromeRenderViewHostTestHarness::SetUp(); ASSERT_TRUE(temp_dir_.CreateUniqueTempDir()); g_temp_history_dir = temp_dir_.GetPath(); HistoryServiceFactory::GetInstance()->SetTestingFactory( profile(), base::BindRepeating(&BuildTestHistoryService)); SiteEngagementScore::SetParamValuesForTesting(); SiteEngagementServiceFactory::GetInstance()->SetTestingFactory( profile(), base::BindRepeating(&BuildTestSiteEngagementService)); // Ensure that we have just one SiteEngagementService: any service created // with TestingProfile has been shut down. // (See KeyedServiceBaseFactory::ServiceIsCreatedWithContext). DCHECK(!SiteEngagementServiceFactory::GetForProfileIfExists(profile())); service_ = SiteEngagementServiceFactory::GetForProfile(profile()); service_->SetClockForTesting(&clock_); clock_.SetNow(GetReferenceTime()); } void TearDown() override { service_->Shutdown(); ChromeRenderViewHostTestHarness::TearDown(); } bool IsEngagementAtLeast(const GURL& url, blink::mojom::EngagementLevel level) { double score = service_->GetScore(url); return SiteEngagementService::IsEngagementAtLeast(score, level); } void NavigateWithTransitionAndExpectHigherScore( SiteEngagementService* service, const GURL& url, ui::PageTransition transition) { double prev_score = service->GetScore(url); auto navigation = NavigationSimulator::CreateBrowserInitiated(url, web_contents()); navigation->SetTransition(transition); navigation->Commit(); EXPECT_LT(prev_score, service->GetScore(url)); } void NavigateWithTransitionAndExpectEqualScore( SiteEngagementService* service, const GURL& url, ui::PageTransition transition) { double prev_score = service->GetScore(url); auto navigation = NavigationSimulator::CreateBrowserInitiated(url, web_contents()); navigation->SetTransition(transition); navigation->Commit(); EXPECT_EQ(prev_score, service->GetScore(url)); } void SetParamValue(SiteEngagementScore::Variation variation, double value) { SiteEngagementScore::GetParamValues()[variation].second = value; } void AssertInRange(double expected, double actual) { EXPECT_NEAR(expected, actual, kMaxRoundingDeviation); } double CheckScoreFromSettingsOnThread( content::BrowserThread::ID thread_id, HostContentSettingsMap* settings_map, const GURL& url) { double score = 0; base::RunLoop run_loop; content::BrowserThread::GetTaskRunnerForThread(thread_id)->PostTaskAndReply( FROM_HERE, base::BindOnce(&SiteEngagementServiceTest::CheckScoreFromSettings, base::Unretained(this), base::RetainedRef(settings_map), url, &score), run_loop.QuitClosure()); run_loop.Run(); return score; } double GetMedian(SiteEngagementService* service) { std::vector details = service->GetAllDetails(); std::sort(details.begin(), details.end(), [](const mojom::SiteEngagementDetails& lhs, const mojom::SiteEngagementDetails& rhs) { return lhs.total_score < rhs.total_score; }); return service->GetMedianEngagementFromSortedDetails(details); } std::map GetScoreMap(SiteEngagementService* service) { std::vector details = service->GetAllDetails(); std::map score_map; for (const auto& detail : details) score_map[detail.origin] = detail.total_score; return score_map; } protected: void CheckScoreFromSettings(HostContentSettingsMap* settings_map, const GURL& url, double* score) { *score = SiteEngagementService::GetScoreFromSettings(settings_map, url); } void SetLastShortcutLaunchTime(content::WebContents* web_contents, GURL url) { static const webapps::AppId kFakeAppId = "abcdefg"; #if BUILDFLAG(IS_ANDROID) service_->SetLastShortcutLaunchTime(web_contents, url); #else service_->SetLastShortcutLaunchTime(web_contents, kFakeAppId, url); #endif } base::ScopedTempDir temp_dir_; raw_ptr service_; base::SimpleTestClock clock_; }; TEST_F(SiteEngagementServiceTest, GetMedianEngagement) { GURL url1("http://www.google.com/"); GURL url2("https://www.google.com/"); GURL url3("https://drive.google.com/"); GURL url4("https://maps.google.com/"); GURL url5("https://youtube.com/"); GURL url6("https://images.google.com/"); // For zero total sites, the median is 0. EXPECT_EQ(0u, service_->GetAllDetails().size()); EXPECT_DOUBLE_EQ(0, GetMedian(service_)); // For odd total sites, the median is the middle score. service_->AddPointsForTesting(url1, 1); EXPECT_EQ(1u, service_->GetAllDetails().size()); EXPECT_DOUBLE_EQ(1, GetMedian(service_)); // For even total sites, the median is the mean of the middle two scores. service_->AddPointsForTesting(url2, 2); EXPECT_EQ(2u, service_->GetAllDetails().size()); EXPECT_DOUBLE_EQ(1.5, GetMedian(service_)); service_->AddPointsForTesting(url3, 1.4); EXPECT_EQ(3u, service_->GetAllDetails().size()); EXPECT_DOUBLE_EQ(1.4, GetMedian(service_)); service_->AddPointsForTesting(url4, 1.8); EXPECT_EQ(4u, service_->GetAllDetails().size()); EXPECT_DOUBLE_EQ(1.6, GetMedian(service_)); service_->AddPointsForTesting(url5, 2.5); EXPECT_EQ(5u, service_->GetAllDetails().size()); EXPECT_DOUBLE_EQ(1.8, GetMedian(service_)); service_->AddPointsForTesting(url6, 3); EXPECT_EQ(6u, service_->GetAllDetails().size()); EXPECT_DOUBLE_EQ(1.9, GetMedian(service_)); } // Tests that the Site Engagement service is hooked up properly to navigations // by performing two navigations and checking the engagement score increases // both times. TEST_F(SiteEngagementServiceTest, ScoreIncrementsOnPageRequest) { // Create the helper manually since it isn't present when a tab isn't created. SiteEngagementService::Helper::CreateForWebContents(web_contents()); GURL url("http://www.google.com/"); EXPECT_EQ(0, service_->GetScore(url)); NavigateWithTransitionAndExpectHigherScore(service_, url, ui::PAGE_TRANSITION_TYPED); NavigateWithTransitionAndExpectHigherScore(service_, url, ui::PAGE_TRANSITION_AUTO_BOOKMARK); } // Expect that site engagement scores for several sites are correctly // aggregated during navigation events. TEST_F(SiteEngagementServiceTest, GetTotalNavigationPoints) { // The https and http versions of www.google.com should be separate. GURL url1("https://www.google.com/"); GURL url2("http://www.google.com/"); GURL url3("http://drive.google.com/"); EXPECT_EQ(0, service_->GetScore(url1)); EXPECT_EQ(0, service_->GetScore(url2)); EXPECT_EQ(0, service_->GetScore(url3)); NavigateAndCommit(url1); service_->HandleNavigation(web_contents(), ui::PAGE_TRANSITION_TYPED); EXPECT_EQ(0.5, service_->GetScore(url1)); EXPECT_EQ(0.5, service_->GetTotalEngagementPoints()); NavigateAndCommit(url2); service_->HandleNavigation(web_contents(), ui::PAGE_TRANSITION_GENERATED); service_->HandleNavigation(web_contents(), ui::PAGE_TRANSITION_KEYWORD_GENERATED); EXPECT_EQ(1, service_->GetScore(url2)); EXPECT_EQ(1.5, service_->GetTotalEngagementPoints()); service_->HandleNavigation(web_contents(), ui::PAGE_TRANSITION_AUTO_BOOKMARK); EXPECT_EQ(1.5, service_->GetScore(url2)); EXPECT_EQ(2, service_->GetTotalEngagementPoints()); NavigateAndCommit(url3); service_->HandleNavigation(web_contents(), ui::PAGE_TRANSITION_TYPED); EXPECT_EQ(0.5, service_->GetScore(url3)); EXPECT_EQ(2.5, service_->GetTotalEngagementPoints()); NavigateAndCommit(url1); service_->HandleNavigation(web_contents(), ui::PAGE_TRANSITION_GENERATED); service_->HandleNavigation(web_contents(), ui::PAGE_TRANSITION_TYPED); EXPECT_EQ(1.5, service_->GetScore(url1)); EXPECT_EQ(3.5, service_->GetTotalEngagementPoints()); } TEST_F(SiteEngagementServiceTest, GetTotalUserInputPoints) { // The https and http versions of www.google.com should be separate. GURL url1("https://www.google.com/"); GURL url2("http://www.google.com/"); GURL url3("http://drive.google.com/"); EXPECT_EQ(0, service_->GetScore(url1)); EXPECT_EQ(0, service_->GetScore(url2)); EXPECT_EQ(0, service_->GetScore(url3)); NavigateAndCommit(url1); service_->HandleUserInput(web_contents(), EngagementType::kMouse); EXPECT_DOUBLE_EQ(0.05, service_->GetScore(url1)); EXPECT_DOUBLE_EQ(0.05, service_->GetTotalEngagementPoints()); NavigateAndCommit(url2); service_->HandleUserInput(web_contents(), EngagementType::kMouse); service_->HandleUserInput(web_contents(), EngagementType::kKeypress); EXPECT_DOUBLE_EQ(0.1, service_->GetScore(url2)); EXPECT_DOUBLE_EQ(0.15, service_->GetTotalEngagementPoints()); NavigateAndCommit(url3); service_->HandleUserInput(web_contents(), EngagementType::kKeypress); EXPECT_DOUBLE_EQ(0.05, service_->GetScore(url3)); EXPECT_DOUBLE_EQ(0.2, service_->GetTotalEngagementPoints()); NavigateAndCommit(url1); service_->HandleUserInput(web_contents(), EngagementType::kKeypress); service_->HandleUserInput(web_contents(), EngagementType::kMouse); EXPECT_DOUBLE_EQ(0.15, service_->GetScore(url1)); EXPECT_DOUBLE_EQ(0.3, service_->GetTotalEngagementPoints()); NavigateAndCommit(url2); service_->HandleUserInput(web_contents(), EngagementType::kScroll); NavigateAndCommit(url3); service_->HandleUserInput(web_contents(), EngagementType::kTouchGesture); EXPECT_DOUBLE_EQ(0.15, service_->GetScore(url2)); EXPECT_DOUBLE_EQ(0.1, service_->GetScore(url3)); EXPECT_DOUBLE_EQ(0.4, service_->GetTotalEngagementPoints()); } TEST_F(SiteEngagementServiceTest, GetTotalNotificationPoints) { base::HistogramTester histograms; // The https and http versions of www.google.com should be separate. GURL url1("https://www.google.com/"); GURL url2("http://www.google.com/"); GURL url3("http://drive.google.com/"); EXPECT_EQ(0, service_->GetScore(url1)); EXPECT_EQ(0, service_->GetScore(url2)); EXPECT_EQ(0, service_->GetScore(url3)); service_->HandleNotificationInteraction(url1); EXPECT_DOUBLE_EQ(1.0, service_->GetScore(url1)); EXPECT_DOUBLE_EQ(1.0, service_->GetTotalEngagementPoints()); histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram, EngagementType::kNotificationInteraction, 1); service_->HandleNotificationInteraction(url2); EXPECT_DOUBLE_EQ(1.0, service_->GetScore(url2)); EXPECT_DOUBLE_EQ(2.0, service_->GetTotalEngagementPoints()); histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram, EngagementType::kNotificationInteraction, 2); service_->HandleNotificationInteraction(url1); EXPECT_DOUBLE_EQ(2.0, service_->GetScore(url1)); EXPECT_DOUBLE_EQ(3.0, service_->GetTotalEngagementPoints()); histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram, EngagementType::kNotificationInteraction, 3); service_->HandleNotificationInteraction(url3); EXPECT_DOUBLE_EQ(1.0, service_->GetScore(url3)); EXPECT_DOUBLE_EQ(4.0, service_->GetTotalEngagementPoints()); histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram, EngagementType::kNotificationInteraction, 4); } // TODO(crbug.com/40899584): Fix and enable this test. TEST_F(SiteEngagementServiceTest, DISABLED_RestrictedToHTTPAndHTTPS) { // The https and http versions of www.google.com should be separate. GURL url1("ftp://www.google.com/"); GURL url2("file://blah"); GURL url3("chrome://version/"); GURL url4("chrome://config"); NavigateAndCommit(url1); service_->HandleUserInput(web_contents(), EngagementType::kMouse); EXPECT_EQ(0, service_->GetScore(url1)); NavigateAndCommit(url2); service_->HandleNavigation(web_contents(), ui::PAGE_TRANSITION_TYPED); EXPECT_EQ(0, service_->GetScore(url2)); NavigateAndCommit(url3); service_->HandleMediaPlaying(web_contents(), true); EXPECT_EQ(0, service_->GetScore(url3)); NavigateAndCommit(url4); service_->HandleUserInput(web_contents(), EngagementType::kKeypress); EXPECT_EQ(0, service_->GetScore(url4)); } TEST_F(SiteEngagementServiceTest, LastShortcutLaunch) { base::HistogramTester histograms; base::Time current_day = GetReferenceTime(); clock_.SetNow(current_day - base::Days(5)); // The https and http versions of www.google.com should be separate. But // different paths on the same origin should be treated the same. GURL url1("https://www.google.com/"); GURL url2("http://www.google.com/"); GURL url3("http://www.google.com/maps"); EXPECT_EQ(0, service_->GetScore(url1)); EXPECT_EQ(0, service_->GetScore(url2)); EXPECT_EQ(0, service_->GetScore(url3)); SetLastShortcutLaunchTime(web_contents(), url2); histograms.ExpectUniqueSample(SiteEngagementMetrics::kEngagementTypeHistogram, EngagementType::kWebappShortcutLaunch, 1); service_->AddPointsForTesting(url1, 2.0); service_->AddPointsForTesting(url2, 2.0); clock_.SetNow(current_day); SetLastShortcutLaunchTime(web_contents(), url2); histograms.ExpectTotalCount(SiteEngagementMetrics::kEngagementTypeHistogram, 4); histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram, EngagementType::kWebappShortcutLaunch, 2); histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram, EngagementType::kFirstDailyEngagement, 2); EXPECT_DOUBLE_EQ(2.0, service_->GetScore(url1)); EXPECT_DOUBLE_EQ(7.0, service_->GetScore(url2)); clock_.SetNow(GetReferenceTime() + base::Days(1)); EXPECT_DOUBLE_EQ(2.0, service_->GetScore(url1)); EXPECT_DOUBLE_EQ(7.0, service_->GetScore(url2)); clock_.SetNow(GetReferenceTime() + base::Days(7)); EXPECT_DOUBLE_EQ(0.0, service_->GetScore(url1)); EXPECT_DOUBLE_EQ(5.0, service_->GetScore(url2)); service_->AddPointsForTesting(url1, 1.0); clock_.SetNow(GetReferenceTime() + base::Days(10)); EXPECT_DOUBLE_EQ(1.0, service_->GetScore(url1)); EXPECT_DOUBLE_EQ(5.0, service_->GetScore(url2)); clock_.SetNow(GetReferenceTime() + base::Days(11)); EXPECT_DOUBLE_EQ(1.0, service_->GetScore(url1)); EXPECT_DOUBLE_EQ(0.0, service_->GetScore(url2)); } // TODO(crbug.com/40724963): Flaky test. TEST_F(SiteEngagementServiceTest, DISABLED_CheckHistograms) { base::HistogramTester histograms; base::Time current_day = GetReferenceTime(); clock_.SetNow(current_day); // Histograms should start empty as the testing SiteEngagementService // constructor does not record metrics. histograms.ExpectTotalCount(SiteEngagementMetrics::kTotalOriginsHistogram, 0); histograms.ExpectTotalCount(SiteEngagementMetrics::kMeanEngagementHistogram, 0); histograms.ExpectTotalCount(SiteEngagementMetrics::kMedianEngagementHistogram, 0); histograms.ExpectTotalCount(SiteEngagementMetrics::kEngagementScoreHistogram, 0); histograms.ExpectTotalCount(SiteEngagementMetrics::kEngagementTypeHistogram, 0); // Record metrics for an empty engagement system. service_->RecordMetrics(service_->GetAllDetails()); histograms.ExpectUniqueSample(SiteEngagementMetrics::kTotalOriginsHistogram, 0, 1); histograms.ExpectTotalCount(SiteEngagementMetrics::kEngagementScoreHistogram, 0); histograms.ExpectUniqueSample(SiteEngagementMetrics::kMeanEngagementHistogram, 0, 1); histograms.ExpectUniqueSample( SiteEngagementMetrics::kMedianEngagementHistogram, 0, 1); histograms.ExpectTotalCount(SiteEngagementMetrics::kEngagementTypeHistogram, 0); clock_.SetNow(clock_.Now() + base::Minutes(60)); // The https and http versions of www.google.com should be separate. GURL url1("https://www.google.com/"); GURL url2("http://www.google.com/"); GURL url3("http://drive.google.com/"); NavigateAndCommit(url1); service_->HandleNavigation(web_contents(), ui::PAGE_TRANSITION_TYPED); service_->HandleUserInput(web_contents(), EngagementType::kKeypress); service_->HandleUserInput(web_contents(), EngagementType::kMouse); NavigateAndCommit(url2); service_->HandleMediaPlaying(web_contents(), true); // Wait until the background metrics recording happens. content::RunAllTasksUntilIdle(); histograms.ExpectTotalCount(SiteEngagementMetrics::kTotalOriginsHistogram, 2); histograms.ExpectBucketCount(SiteEngagementMetrics::kTotalOriginsHistogram, 0, 1); histograms.ExpectBucketCount(SiteEngagementMetrics::kTotalOriginsHistogram, 1, 1); histograms.ExpectTotalCount(SiteEngagementMetrics::kMeanEngagementHistogram, 2); histograms.ExpectTotalCount(SiteEngagementMetrics::kMedianEngagementHistogram, 2); // Recorded per origin. histograms.ExpectTotalCount(SiteEngagementMetrics::kEngagementScoreHistogram, 1); histograms.ExpectTotalCount(SiteEngagementMetrics::kEngagementTypeHistogram, 6); histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram, EngagementType::kNavigation, 1); histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram, EngagementType::kKeypress, 1); histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram, EngagementType::kMouse, 1); histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram, EngagementType::kMediaHidden, 1); histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram, EngagementType::kFirstDailyEngagement, 2); // Navigations are still logged within the 1 hour refresh period clock_.SetNow(clock_.Now() + base::Minutes(59)); NavigateAndCommit(url2); service_->HandleNavigation(web_contents(), ui::PAGE_TRANSITION_GENERATED); service_->HandleNavigation(web_contents(), ui::PAGE_TRANSITION_AUTO_BOOKMARK); histograms.ExpectTotalCount(SiteEngagementMetrics::kEngagementTypeHistogram, 8); histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram, EngagementType::kNavigation, 3); histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram, EngagementType::kKeypress, 1); histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram, EngagementType::kMouse, 1); histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram, EngagementType::kMediaHidden, 1); histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram, EngagementType::kFirstDailyEngagement, 2); // Update the hourly histograms again. clock_.SetNow(clock_.Now() + base::Minutes(1)); NavigateAndCommit(url3); service_->HandleNavigation(web_contents(), ui::PAGE_TRANSITION_TYPED); service_->HandleMediaPlaying(web_contents(), false); NavigateAndCommit(url2); service_->HandleUserInput(web_contents(), EngagementType::kTouchGesture); // Wait until the background metrics recording happens. content::RunAllTasksUntilIdle(); histograms.ExpectBucketCount(SiteEngagementMetrics::kTotalOriginsHistogram, 0, 1); histograms.ExpectBucketCount(SiteEngagementMetrics::kTotalOriginsHistogram, 1, 1); histograms.ExpectBucketCount(SiteEngagementMetrics::kTotalOriginsHistogram, 3, 1); histograms.ExpectTotalCount(SiteEngagementMetrics::kMeanEngagementHistogram, 3); histograms.ExpectTotalCount(SiteEngagementMetrics::kMedianEngagementHistogram, 3); // Recorded per origin. histograms.ExpectTotalCount(SiteEngagementMetrics::kEngagementScoreHistogram, 4); histograms.ExpectTotalCount(SiteEngagementMetrics::kEngagementTypeHistogram, 12); histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram, EngagementType::kNavigation, 4); histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram, EngagementType::kKeypress, 1); histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram, EngagementType::kMouse, 1); histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram, EngagementType::kTouchGesture, 1); histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram, EngagementType::kMediaVisible, 1); histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram, EngagementType::kMediaHidden, 1); histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram, EngagementType::kFirstDailyEngagement, 3); NavigateAndCommit(url1); service_->HandleNavigation(web_contents(), ui::PAGE_TRANSITION_GENERATED); service_->HandleNavigation(web_contents(), ui::PAGE_TRANSITION_TYPED); NavigateAndCommit(url2); service_->HandleUserInput(web_contents(), EngagementType::kScroll); NavigateAndCommit(url1); service_->HandleUserInput(web_contents(), EngagementType::kKeypress); NavigateAndCommit(url3); service_->HandleUserInput(web_contents(), EngagementType::kMouse); histograms.ExpectTotalCount(SiteEngagementMetrics::kEngagementTypeHistogram, 17); histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram, EngagementType::kNavigation, 6); histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram, EngagementType::kKeypress, 2); histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram, EngagementType::kMouse, 2); histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram, EngagementType::kTouchGesture, 1); histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram, EngagementType::kScroll, 1); histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram, EngagementType::kFirstDailyEngagement, 3); // Advance an origin to the max for a day and advance the clock an hour before // the last increment before max. Expect the histogram to be updated. NavigateAndCommit(url1); for (int i = 0; i < 6; ++i) service_->HandleNavigation(web_contents(), ui::PAGE_TRANSITION_TYPED); clock_.SetNow(clock_.Now() + base::Minutes(60)); service_->HandleNavigation(web_contents(), ui::PAGE_TRANSITION_TYPED); // Wait until the background metrics recording happens. content::RunAllTasksUntilIdle(); histograms.ExpectBucketCount(SiteEngagementMetrics::kTotalOriginsHistogram, 0, 1); histograms.ExpectBucketCount(SiteEngagementMetrics::kTotalOriginsHistogram, 1, 1); histograms.ExpectBucketCount(SiteEngagementMetrics::kTotalOriginsHistogram, 3, 2); histograms.ExpectTotalCount(SiteEngagementMetrics::kMeanEngagementHistogram, 4); histograms.ExpectTotalCount(SiteEngagementMetrics::kMedianEngagementHistogram, 4); histograms.ExpectTotalCount(SiteEngagementMetrics::kEngagementScoreHistogram, 7); histograms.ExpectTotalCount(SiteEngagementMetrics::kEngagementTypeHistogram, 24); histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram, EngagementType::kNavigation, 13); histograms.ExpectBucketCount(SiteEngagementMetrics::kEngagementTypeHistogram, EngagementType::kFirstDailyEngagement, 3); } // Expect that sites that have reached zero engagement are cleaned up. Expect // engagement times to be reset if too much time has passed since the last // engagement. TEST_F(SiteEngagementServiceTest, CleanupEngagementScores) { // Set the base time to be 3 weeks past the stale period in the past. // Use a 1 second offset to make sure scores don't yet decay. base::TimeDelta one_second = base::Seconds(1); base::TimeDelta one_day = base::Days(1); base::TimeDelta decay_period = base::Hours(SiteEngagementScore::GetDecayPeriodInHours()); base::TimeDelta shorter_than_decay_period = decay_period - one_second; base::Time max_decay_time = GetReferenceTime() - service_->GetMaxDecayPeriod(); base::Time stale_time = GetReferenceTime() - service_->GetStalePeriod(); base::Time base_time = stale_time - shorter_than_decay_period * 4; clock_.SetNow(base_time); // The https and http versions of www.google.com should be separate. GURL url1("https://www.google.com/"); GURL url2("http://www.google.com/"); GURL url3("http://maps.google.com/"); GURL url4("http://drive.google.com/"); EXPECT_EQ(0, service_->GetScore(url1)); EXPECT_EQ(0, service_->GetScore(url2)); EXPECT_EQ(0, service_->GetScore(url3)); EXPECT_EQ(0, service_->GetScore(url4)); // Add some points service_->AddPointsForTesting(url1, 1.0); service_->AddPointsForTesting(url2, 5.0); EXPECT_EQ(1.0, service_->GetScore(url1)); EXPECT_EQ(5.0, service_->GetScore(url2)); // Add more to url2 over the next few days. Leave it completely alone after // this. clock_.SetNow(base_time + one_day); service_->AddPointsForTesting(url2, 5.0); EXPECT_EQ(10.0, service_->GetScore(url2)); clock_.SetNow(base_time + 2 * one_day); service_->AddPointsForTesting(url2, 5.0); EXPECT_EQ(15.0, service_->GetScore(url2)); clock_.SetNow(base_time + 3 * one_day); service_->AddPointsForTesting(url2, 2.0); EXPECT_EQ(17.0, service_->GetScore(url2)); base::Time url2_last_modified = clock_.Now(); // Move to (3 * shorter_than_decay_period) before the stale period. base_time += shorter_than_decay_period; clock_.SetNow(base_time); service_->AddPointsForTesting(url1, 1.0); service_->AddPointsForTesting(url3, 5.0); EXPECT_EQ(2.0, service_->GetScore(url1)); EXPECT_EQ(5.0, service_->GetScore(url3)); // Add more to url3, and then leave it alone. clock_.SetNow(base_time + one_day); service_->AddPointsForTesting(url1, 5.0); service_->AddPointsForTesting(url3, 5.0); EXPECT_EQ(7.0, service_->GetScore(url1)); EXPECT_EQ(10.0, service_->GetScore(url3)); // Move to (2 * shorter_than_decay_period) before the stale period. base_time += shorter_than_decay_period; clock_.SetNow(base_time); service_->AddPointsForTesting(url1, 5.0); service_->AddPointsForTesting(url4, 5.0); EXPECT_EQ(12.0, service_->GetScore(url1)); EXPECT_EQ(5.0, service_->GetScore(url4)); // Move to shorter_than_decay_period before the stale period. base_time += shorter_than_decay_period; clock_.SetNow(base_time); service_->AddPointsForTesting(url1, 1.5); service_->AddPointsForTesting(url4, 2.0); EXPECT_EQ(13.5, service_->GetScore(url1)); EXPECT_EQ(7.0, service_->GetScore(url4)); // After cleanup, url2 should be last modified offset to max_decay_time by the // current offset to now. url2_last_modified = max_decay_time - (clock_.Now() - url2_last_modified); base_time = GetReferenceTime(); { clock_.SetNow(base_time); ASSERT_TRUE(service_->IsLastEngagementStale()); // Run a cleanup. Last engagement times will be reset relative to // max_decay_time. After the reset, url2 will go through 3 decays, url3 // will go through 2 decays, and url1/url4 will go through 1 decay. This // decay is uncommitted! service_->CleanupEngagementScores(true); ASSERT_FALSE(service_->IsLastEngagementStale()); std::map score_map = GetScoreMap(service_); EXPECT_EQ(3u, score_map.size()); EXPECT_EQ(8.5, score_map[url1]); EXPECT_EQ(2.0, score_map[url2]); EXPECT_EQ(2.0, score_map[url4]); EXPECT_EQ(0, service_->GetScore(url3)); EXPECT_EQ(max_decay_time, service_->CreateEngagementScore(url1).last_engagement_time()); EXPECT_EQ(url2_last_modified, service_->CreateEngagementScore(url2).last_engagement_time()); EXPECT_EQ(max_decay_time, service_->CreateEngagementScore(url4).last_engagement_time()); EXPECT_EQ(max_decay_time, service_->GetLastEngagementTime()); } { // Advance time by the stale period. Nothing should happen in the cleanup. // Last engagement times are now relative to max_decay_time + stale period base_time += service_->GetStalePeriod(); clock_.SetNow(base_time); ASSERT_TRUE(service_->IsLastEngagementStale()); std::map score_map = GetScoreMap(service_); EXPECT_EQ(3u, score_map.size()); EXPECT_EQ(8.5, score_map[url1]); EXPECT_EQ(2.0, score_map[url2]); EXPECT_EQ(2.0, score_map[url4]); EXPECT_EQ(max_decay_time + service_->GetStalePeriod(), service_->CreateEngagementScore(url1).last_engagement_time()); EXPECT_EQ(url2_last_modified + service_->GetStalePeriod(), service_->CreateEngagementScore(url2).last_engagement_time()); EXPECT_EQ(max_decay_time + service_->GetStalePeriod(), service_->CreateEngagementScore(url4).last_engagement_time()); EXPECT_EQ(max_decay_time + service_->GetStalePeriod(), service_->GetLastEngagementTime()); } { // Add points to commit the decay. service_->AddPointsForTesting(url1, 0.5); service_->AddPointsForTesting(url2, 0.5); service_->AddPointsForTesting(url4, 1); std::map score_map = GetScoreMap(service_); EXPECT_EQ(3u, score_map.size()); EXPECT_EQ(9.0, score_map[url1]); EXPECT_EQ(2.5, score_map[url2]); EXPECT_EQ(3.0, score_map[url4]); EXPECT_EQ(clock_.Now(), service_->CreateEngagementScore(url1).last_engagement_time()); EXPECT_EQ(clock_.Now(), service_->CreateEngagementScore(url2).last_engagement_time()); EXPECT_EQ(clock_.Now(), service_->CreateEngagementScore(url4).last_engagement_time()); EXPECT_EQ(clock_.Now(), service_->GetLastEngagementTime()); } { // Advance time by a decay period after the current last engagement time. // Expect url2/url4 to be decayed to zero and url1 to decay once. base_time = clock_.Now() + decay_period; clock_.SetNow(base_time); ASSERT_FALSE(service_->IsLastEngagementStale()); std::map score_map = GetScoreMap(service_); EXPECT_EQ(3u, score_map.size()); EXPECT_EQ(4, score_map[url1]); EXPECT_EQ(0, score_map[url2]); EXPECT_EQ(0, score_map[url4]); service_->CleanupEngagementScores(false); ASSERT_FALSE(service_->IsLastEngagementStale()); score_map = GetScoreMap(service_); EXPECT_EQ(1u, score_map.size()); EXPECT_EQ(4, score_map[url1]); EXPECT_EQ(0, service_->GetScore(url2)); EXPECT_EQ(0, service_->GetScore(url4)); EXPECT_EQ(clock_.Now() - decay_period, service_->CreateEngagementScore(url1).last_engagement_time()); EXPECT_EQ(clock_.Now() - decay_period, service_->GetLastEngagementTime()); } { // Add points to commit the decay. service_->AddPointsForTesting(url1, 0.5); std::map score_map = GetScoreMap(service_); EXPECT_EQ(1u, score_map.size()); EXPECT_EQ(4.5, score_map[url1]); EXPECT_EQ(clock_.Now(), service_->CreateEngagementScore(url1).last_engagement_time()); EXPECT_EQ(clock_.Now(), service_->GetLastEngagementTime()); } { // Another decay period will decay url1 to zero. clock_.SetNow(clock_.Now() + decay_period); ASSERT_FALSE(service_->IsLastEngagementStale()); std::map score_map = GetScoreMap(service_); EXPECT_EQ(1u, score_map.size()); EXPECT_EQ(0, score_map[url1]); EXPECT_EQ(clock_.Now() - decay_period, service_->CreateEngagementScore(url1).last_engagement_time()); EXPECT_EQ(clock_.Now() - decay_period, service_->GetLastEngagementTime()); service_->CleanupEngagementScores(false); ASSERT_FALSE(service_->IsLastEngagementStale()); score_map = GetScoreMap(service_); EXPECT_EQ(0u, score_map.size()); EXPECT_EQ(0, service_->GetScore(url1)); EXPECT_EQ(clock_.Now() - decay_period, service_->GetLastEngagementTime()); } } TEST_F(SiteEngagementServiceTest, CleanupEngagementScoresProportional) { SetParamValue(SiteEngagementScore::DECAY_PROPORTION, 0.5); SetParamValue(SiteEngagementScore::DECAY_POINTS, 0); SetParamValue(SiteEngagementScore::SCORE_CLEANUP_THRESHOLD, 0.5); base::Time current_day = GetReferenceTime(); clock_.SetNow(current_day); GURL url1("https://www.google.com/"); GURL url2("https://www.somewhereelse.com/"); service_->AddPointsForTesting(url1, 1.0); service_->AddPointsForTesting(url2, 1.2); current_day += base::Days(7); clock_.SetNow(current_day); std::map score_map = GetScoreMap(service_); EXPECT_EQ(2u, score_map.size()); AssertInRange(0.5, service_->GetScore(url1)); AssertInRange(0.6, service_->GetScore(url2)); service_->CleanupEngagementScores(false); score_map = GetScoreMap(service_); EXPECT_EQ(1u, score_map.size()); EXPECT_EQ(0, service_->GetScore(url1)); AssertInRange(0.6, service_->GetScore(url2)); } // Tests behavior of CleanupEngagementScores() with a very short // DECAY_PERIOD_IN_HOURS. TEST_F(SiteEngagementServiceTest, CleanupEngagementScoresShortDecayPeriod) { SetParamValue(SiteEngagementScore::DECAY_PERIOD_IN_HOURS, 1); SetParamValue(SiteEngagementScore::DECAY_POINTS, 0); SetParamValue(SiteEngagementScore::LAST_ENGAGEMENT_GRACE_PERIOD_IN_HOURS, 0); clock_.SetNow(GetReferenceTime()); GURL origin("http://www.google.com/"); service_->AddPointsForTesting(origin, 5); clock_.Advance(base::Days(1)); service_->AddPointsForTesting(origin, 5); EXPECT_EQ(10, service_->GetScore(origin)); } TEST_F(SiteEngagementServiceTest, NavigationAccumulation) { GURL url("https://www.google.com/"); // Create the helper manually since it isn't present when a tab isn't created. SiteEngagementService::Helper::CreateForWebContents(web_contents()); // Only direct navigation should trigger engagement. NavigateWithTransitionAndExpectHigherScore(service_, url, ui::PAGE_TRANSITION_TYPED); NavigateWithTransitionAndExpectHigherScore(service_, url, ui::PAGE_TRANSITION_GENERATED); NavigateWithTransitionAndExpectHigherScore(service_, url, ui::PAGE_TRANSITION_AUTO_BOOKMARK); NavigateWithTransitionAndExpectHigherScore( service_, url, ui::PAGE_TRANSITION_KEYWORD_GENERATED); NavigateWithTransitionAndExpectHigherScore(service_, url, ui::PAGE_TRANSITION_AUTO_TOPLEVEL); // Other transition types should not accumulate engagement. NavigateWithTransitionAndExpectEqualScore(service_, url, ui::PAGE_TRANSITION_LINK); NavigateWithTransitionAndExpectEqualScore(service_, url, ui::PAGE_TRANSITION_RELOAD); NavigateWithTransitionAndExpectEqualScore(service_, url, ui::PAGE_TRANSITION_FORM_SUBMIT); } TEST_F(SiteEngagementServiceTest, IsBootstrapped) { base::Time current_day = GetReferenceTime(); clock_.SetNow(current_day); GURL url1("https://www.google.com/"); GURL url2("https://www.somewhereelse.com/"); EXPECT_FALSE(service_->IsBootstrapped()); service_->AddPointsForTesting(url1, 5.0); EXPECT_FALSE(service_->IsBootstrapped()); service_->AddPointsForTesting(url2, 5.0); EXPECT_TRUE(service_->IsBootstrapped()); clock_.SetNow(current_day + base::Days(8)); EXPECT_FALSE(service_->IsBootstrapped()); } TEST_F(SiteEngagementServiceTest, CleanupOriginsOnHistoryDeletion) { SiteEngagementServiceFactory::GetInstance()->SetTestingFactory( profile(), base::BindLambdaForTesting([](content::BrowserContext* context) -> std::unique_ptr { history::HistoryService* history = HistoryServiceFactory::GetForProfile( Profile::FromBrowserContext(context), ServiceAccessType::IMPLICIT_ACCESS); return std::make_unique(context, history); })); service_ = SiteEngagementServiceFactory::GetForProfile(profile()); service_->SetClockForTesting(&clock_); // Enable proportional decay to ensure that the undecay that happens to // balance out history deletion also accounts for the proportional decay. SetParamValue(SiteEngagementScore::DECAY_PROPORTION, 0.5); GURL origin1("http://www.google.com/"); GURL origin1a("http://www.google.com/search?q=asdf"); GURL origin1b("http://www.google.com/maps/search?q=asdf"); GURL origin2("https://drive.google.com/"); GURL origin2a("https://drive.google.com/somedoc"); GURL origin3("http://notdeleted.com/"); GURL origin4("http://decayed.com/"); GURL origin4a("http://decayed.com/index.html"); base::Time today = GetReferenceTime(); base::Time yesterday = GetReferenceTime() - base::Days(1); base::Time yesterday_afternoon = GetReferenceTime() - base::Days(1) + base::Hours(4); base::Time yesterday_week = GetReferenceTime() - base::Days(8); clock_.SetNow(today); history::HistoryService* history = HistoryServiceFactory::GetForProfile( profile(), ServiceAccessType::IMPLICIT_ACCESS); history->AddPage(origin1, yesterday_afternoon, history::SOURCE_BROWSED); history->AddPage(origin1a, yesterday_week, history::SOURCE_BROWSED); history->AddPage(origin1b, today, history::SOURCE_BROWSED); service_->AddPointsForTesting(origin1, 3.0); history->AddPage(origin2, yesterday_afternoon, history::SOURCE_BROWSED); history->AddPage(origin2a, yesterday_afternoon, history::SOURCE_BROWSED); service_->AddPointsForTesting(origin2, 5.0); history->AddPage(origin3, today, history::SOURCE_BROWSED); service_->AddPointsForTesting(origin3, 5.0); history->AddPage(origin4, yesterday_week, history::SOURCE_BROWSED); history->AddPage(origin4a, yesterday_afternoon, history::SOURCE_BROWSED); service_->AddPointsForTesting(origin4, 5.0); AssertInRange(3.0, service_->GetScore(origin1)); AssertInRange(5.0, service_->GetScore(origin2)); AssertInRange(5.0, service_->GetScore(origin3)); AssertInRange(5.0, service_->GetScore(origin4)); EXPECT_EQ(4U, service_->GetAllDetails().size()); { SiteEngagementChangeWaiter waiter(profile()); base::CancelableTaskTracker task_tracker; // Expire origin1, origin2, origin2a, and origin4's most recent visit. history->ExpireHistoryBetween( std::set(), history::kNoAppIdFilter, yesterday, today, /*user_initiated*/ true, base::DoNothing(), &task_tracker); waiter.Wait(); // origin2 is cleaned up because all its urls are deleted. origin1a and // origin1b are still in history, but 33% of urls have been deleted, thus // cutting origin1's score by 1/3. origin3 is untouched. origin4 has 1 URL // deleted and 1 remaining, but its most recent visit is more than 1 week in // the past. Ensure that its scored is halved, and not decayed further. AssertInRange(2, service_->GetScore(origin1)); EXPECT_EQ(0, service_->GetScore(origin2)); AssertInRange(5.0, service_->GetScore(origin3)); AssertInRange(2.5, service_->GetScore(origin4)); AssertInRange(9.5, service_->GetTotalEngagementPoints()); EXPECT_EQ(3U, service_->GetAllDetails().size()); } { SiteEngagementChangeWaiter waiter(profile()); // Expire origin1a. std::vector expire_list; history::ExpireHistoryArgs args; args.urls.insert(origin1a); args.SetTimeRangeForOneDay(yesterday_week); expire_list.push_back(args); base::CancelableTaskTracker task_tracker; history->ExpireHistory(expire_list, base::DoNothing(), &task_tracker); waiter.Wait(); // origin1's score should be halved again. origin3 and origin4 remain // untouched. AssertInRange(1, service_->GetScore(origin1)); EXPECT_EQ(0, service_->GetScore(origin2)); AssertInRange(5.0, service_->GetScore(origin3)); AssertInRange(2.5, service_->GetScore(origin4)); AssertInRange(8.5, service_->GetTotalEngagementPoints()); EXPECT_EQ(3U, service_->GetAllDetails().size()); } { SiteEngagementChangeWaiter waiter(profile()); // Expire origin1b. std::vector expire_list; history::ExpireHistoryArgs args; args.urls.insert(origin1b); args.SetTimeRangeForOneDay(today); expire_list.push_back(args); base::CancelableTaskTracker task_tracker; history->ExpireHistory(expire_list, base::DoNothing(), &task_tracker); waiter.Wait(); // origin1 should be removed. origin3 and origin4 remain untouched. EXPECT_EQ(0, service_->GetScore(origin1)); EXPECT_EQ(0, service_->GetScore(origin2)); AssertInRange(5.0, service_->GetScore(origin3)); AssertInRange(2.5, service_->GetScore(origin4)); AssertInRange(7.5, service_->GetTotalEngagementPoints()); EXPECT_EQ(2U, service_->GetAllDetails().size()); } } TEST_F(SiteEngagementServiceTest, EngagementLevel) { static_assert(blink::mojom::EngagementLevel::NONE != blink::mojom::EngagementLevel::LOW, "enum values should not be equal"); static_assert(blink::mojom::EngagementLevel::LOW != blink::mojom::EngagementLevel::MEDIUM, "enum values should not be equal"); static_assert(blink::mojom::EngagementLevel::MEDIUM != blink::mojom::EngagementLevel::HIGH, "enum values should not be equal"); static_assert(blink::mojom::EngagementLevel::HIGH != blink::mojom::EngagementLevel::MAX, "enum values should not be equal"); base::Time current_day = GetReferenceTime(); clock_.SetNow(current_day); GURL url1("https://www.google.com/"); GURL url2("http://www.google.com/"); EXPECT_EQ(blink::mojom::EngagementLevel::NONE, service_->GetEngagementLevel(url1)); EXPECT_EQ(blink::mojom::EngagementLevel::NONE, service_->GetEngagementLevel(url2)); EXPECT_TRUE(IsEngagementAtLeast(url1, blink::mojom::EngagementLevel::NONE)); EXPECT_FALSE( IsEngagementAtLeast(url1, blink::mojom::EngagementLevel::MINIMAL)); EXPECT_FALSE(IsEngagementAtLeast(url1, blink::mojom::EngagementLevel::LOW)); EXPECT_FALSE( IsEngagementAtLeast(url1, blink::mojom::EngagementLevel::MEDIUM)); EXPECT_FALSE(IsEngagementAtLeast(url1, blink::mojom::EngagementLevel::HIGH)); EXPECT_FALSE(IsEngagementAtLeast(url1, blink::mojom::EngagementLevel::MAX)); // Bring url2 to MINIMAL engagement. service_->AddPointsForTesting(url2, 0.5); EXPECT_EQ(blink::mojom::EngagementLevel::NONE, service_->GetEngagementLevel(url1)); EXPECT_EQ(blink::mojom::EngagementLevel::MINIMAL, service_->GetEngagementLevel(url2)); EXPECT_TRUE(IsEngagementAtLeast(url2, blink::mojom::EngagementLevel::NONE)); EXPECT_TRUE( IsEngagementAtLeast(url2, blink::mojom::EngagementLevel::MINIMAL)); EXPECT_FALSE(IsEngagementAtLeast(url2, blink::mojom::EngagementLevel::LOW)); EXPECT_FALSE( IsEngagementAtLeast(url2, blink::mojom::EngagementLevel::MEDIUM)); EXPECT_FALSE(IsEngagementAtLeast(url2, blink::mojom::EngagementLevel::HIGH)); EXPECT_FALSE(IsEngagementAtLeast(url2, blink::mojom::EngagementLevel::MAX)); // Bring url1 to LOW engagement. service_->AddPointsForTesting(url1, 1.0); EXPECT_EQ(blink::mojom::EngagementLevel::LOW, service_->GetEngagementLevel(url1)); EXPECT_EQ(blink::mojom::EngagementLevel::MINIMAL, service_->GetEngagementLevel(url2)); EXPECT_TRUE(IsEngagementAtLeast(url1, blink::mojom::EngagementLevel::NONE)); EXPECT_TRUE( IsEngagementAtLeast(url1, blink::mojom::EngagementLevel::MINIMAL)); EXPECT_TRUE(IsEngagementAtLeast(url1, blink::mojom::EngagementLevel::LOW)); EXPECT_FALSE( IsEngagementAtLeast(url1, blink::mojom::EngagementLevel::MEDIUM)); EXPECT_FALSE(IsEngagementAtLeast(url1, blink::mojom::EngagementLevel::HIGH)); EXPECT_FALSE(IsEngagementAtLeast(url1, blink::mojom::EngagementLevel::MAX)); // Bring url2 to MEDIUM engagement. service_->AddPointsForTesting(url2, 4.5); EXPECT_EQ(blink::mojom::EngagementLevel::LOW, service_->GetEngagementLevel(url1)); EXPECT_EQ(blink::mojom::EngagementLevel::MEDIUM, service_->GetEngagementLevel(url2)); EXPECT_TRUE(IsEngagementAtLeast(url2, blink::mojom::EngagementLevel::NONE)); EXPECT_TRUE( IsEngagementAtLeast(url2, blink::mojom::EngagementLevel::MINIMAL)); EXPECT_TRUE(IsEngagementAtLeast(url2, blink::mojom::EngagementLevel::LOW)); EXPECT_TRUE(IsEngagementAtLeast(url2, blink::mojom::EngagementLevel::MEDIUM)); EXPECT_FALSE(IsEngagementAtLeast(url2, blink::mojom::EngagementLevel::HIGH)); EXPECT_FALSE(IsEngagementAtLeast(url2, blink::mojom::EngagementLevel::MAX)); // Bring url2 to HIGH engagement. for (int i = 0; i < 9; ++i) { current_day += base::Days(1); clock_.SetNow(current_day); service_->AddPointsForTesting(url2, 5.0); } EXPECT_EQ(blink::mojom::EngagementLevel::HIGH, service_->GetEngagementLevel(url2)); EXPECT_TRUE(IsEngagementAtLeast(url2, blink::mojom::EngagementLevel::NONE)); EXPECT_TRUE( IsEngagementAtLeast(url2, blink::mojom::EngagementLevel::MINIMAL)); EXPECT_TRUE(IsEngagementAtLeast(url2, blink::mojom::EngagementLevel::LOW)); EXPECT_TRUE(IsEngagementAtLeast(url2, blink::mojom::EngagementLevel::MEDIUM)); EXPECT_TRUE(IsEngagementAtLeast(url2, blink::mojom::EngagementLevel::HIGH)); EXPECT_FALSE(IsEngagementAtLeast(url2, blink::mojom::EngagementLevel::MAX)); // Bring url2 to MAX engagement. for (int i = 0; i < 10; ++i) { current_day += base::Days(1); clock_.SetNow(current_day); service_->AddPointsForTesting(url2, 5.0); } EXPECT_EQ(blink::mojom::EngagementLevel::MAX, service_->GetEngagementLevel(url2)); EXPECT_TRUE(IsEngagementAtLeast(url2, blink::mojom::EngagementLevel::NONE)); EXPECT_TRUE( IsEngagementAtLeast(url2, blink::mojom::EngagementLevel::MINIMAL)); EXPECT_TRUE(IsEngagementAtLeast(url2, blink::mojom::EngagementLevel::LOW)); EXPECT_TRUE(IsEngagementAtLeast(url2, blink::mojom::EngagementLevel::MEDIUM)); EXPECT_TRUE(IsEngagementAtLeast(url2, blink::mojom::EngagementLevel::HIGH)); EXPECT_TRUE(IsEngagementAtLeast(url2, blink::mojom::EngagementLevel::MAX)); } TEST_F(SiteEngagementServiceTest, Observers) { GURL url_score_1("http://www.google.com/maps"); GURL url_score_2("http://www.google.com/drive"); GURL url_score_3("http://www.google.com/"); GURL url_score_4("http://maps.google.com/"); GURL url_score_5("http://books.google.com/"); GURL url_not_called("https://www.google.com/"); // Create an observer and Observe(nullptr). ObserverTester tester_not_called(service_, web_contents(), url_not_called, 1, EngagementType::kLast); tester_not_called.Observe(nullptr); base::Time current_day = GetReferenceTime(); clock_.SetNow(current_day); { // Create an observer for navigation. ObserverTester tester(service_, web_contents(), url_score_1, 0.5, EngagementType::kNavigation); NavigateAndCommit(url_score_1); service_->HandleNavigation(web_contents(), ui::PAGE_TRANSITION_TYPED); tester.Wait(); EXPECT_TRUE(tester.callback_called()); EXPECT_FALSE(tester_not_called.callback_called()); tester.Observe(nullptr); } { // Update observer for a user input. ObserverTester tester(service_, web_contents(), url_score_2, 0.55, EngagementType::kMouse); NavigateAndCommit(url_score_2); service_->HandleUserInput(web_contents(), EngagementType::kMouse); tester.Wait(); EXPECT_TRUE(tester.callback_called()); EXPECT_FALSE(tester_not_called.callback_called()); tester.Observe(nullptr); } // Add two observers for media playing in the foreground. { ObserverTester tester_1(service_, web_contents(), url_score_3, 0.57, EngagementType::kMediaVisible); ObserverTester tester_2(service_, web_contents(), url_score_3, 0.57, EngagementType::kMediaVisible); NavigateAndCommit(url_score_3); service_->HandleMediaPlaying(web_contents(), false); tester_1.Wait(); tester_2.Wait(); EXPECT_TRUE(tester_1.callback_called()); EXPECT_TRUE(tester_2.callback_called()); EXPECT_FALSE(tester_not_called.callback_called()); tester_1.Observe(nullptr); tester_2.Observe(nullptr); } // Add an observer for media playing in the background. { ObserverTester tester(service_, web_contents(), url_score_3, 0.58, EngagementType::kMediaHidden); service_->HandleMediaPlaying(web_contents(), true); tester.Wait(); EXPECT_TRUE(tester.callback_called()); EXPECT_FALSE(tester_not_called.callback_called()); tester.Observe(nullptr); } // Add an observer for notifications. { ObserverTester tester(service_, nullptr, url_score_4, 1.0, EngagementType::kNotificationInteraction); service_->HandleNotificationInteraction(url_score_4); tester.Wait(); EXPECT_TRUE(tester.callback_called()); EXPECT_FALSE(tester_not_called.callback_called()); tester.Observe(nullptr); } // Add an observer for web app launch. { ObserverTester tester(service_, web_contents(), url_score_5, 5.0, EngagementType::kWebappShortcutLaunch); SetLastShortcutLaunchTime(web_contents(), url_score_5); tester.Wait(); EXPECT_TRUE(tester.callback_called()); EXPECT_FALSE(tester_not_called.callback_called()); tester.Observe(nullptr); } } TEST_F(SiteEngagementServiceTest, LastEngagementTime) { // The last engagement time should start off null in prefs and in the service. base::Time last_engagement_time = base::Time::FromInternalValue( profile()->GetPrefs()->GetInt64(prefs::kSiteEngagementLastUpdateTime)); ASSERT_TRUE(last_engagement_time.is_null()); ASSERT_TRUE(service_->GetLastEngagementTime().is_null()); base::Time current_day = GetReferenceTime(); clock_.SetNow(current_day); // Add points should set the last engagement time in the service, and persist // it to disk. GURL origin("http://www.google.com/"); service_->AddPointsForTesting(origin, 1); last_engagement_time = base::Time::FromInternalValue( profile()->GetPrefs()->GetInt64(prefs::kSiteEngagementLastUpdateTime)); EXPECT_EQ(current_day, service_->GetLastEngagementTime()); EXPECT_EQ(current_day, last_engagement_time); // Running a cleanup and updating last engagement times should persist the // last engagement time to disk. current_day += service_->GetStalePeriod(); base::Time rebased_time = current_day - service_->GetMaxDecayPeriod(); clock_.SetNow(current_day); service_->CleanupEngagementScores(true); last_engagement_time = base::Time::FromInternalValue( profile()->GetPrefs()->GetInt64(prefs::kSiteEngagementLastUpdateTime)); EXPECT_EQ(rebased_time, last_engagement_time); EXPECT_EQ(rebased_time, service_->GetLastEngagementTime()); // Adding 0 points shouldn't update the last engagement time. base::Time later_in_day = current_day + base::Seconds(30); clock_.SetNow(later_in_day); service_->AddPointsForTesting(origin, 0); last_engagement_time = base::Time::FromInternalValue( profile()->GetPrefs()->GetInt64(prefs::kSiteEngagementLastUpdateTime)); EXPECT_EQ(rebased_time, last_engagement_time); EXPECT_EQ(rebased_time, service_->GetLastEngagementTime()); // Add some more points and ensure the value is persisted. service_->AddPointsForTesting(origin, 3); last_engagement_time = base::Time::FromInternalValue( profile()->GetPrefs()->GetInt64(prefs::kSiteEngagementLastUpdateTime)); EXPECT_EQ(later_in_day, last_engagement_time); EXPECT_EQ(later_in_day, service_->GetLastEngagementTime()); } TEST_F(SiteEngagementServiceTest, CleanupMovesScoreBackToNow) { base::Time current_day = GetReferenceTime(); clock_.SetNow(current_day); GURL origin("http://www.google.com/"); service_->AddPointsForTesting(origin, 1); EXPECT_EQ(1, service_->GetScore(origin)); EXPECT_EQ(current_day, service_->GetLastEngagementTime()); // Send the clock back in time before the stale period and add engagement for // a new origin. Ensure that the original origin has its last engagement time // updated to now as a result. base::Time before_stale_period = clock_.Now() - service_->GetStalePeriod() - service_->GetMaxDecayPeriod(); clock_.SetNow(before_stale_period); GURL origin1("http://maps.google.com/"); service_->AddPointsForTesting(origin1, 1); EXPECT_EQ(before_stale_period, service_->CreateEngagementScore(origin).last_engagement_time()); EXPECT_EQ(before_stale_period, service_->GetLastEngagementTime()); EXPECT_EQ(1, service_->GetScore(origin)); EXPECT_EQ(1, service_->GetScore(origin1)); // Advance within a decay period and add points. base::TimeDelta less_than_decay_period = base::Hours(SiteEngagementScore::GetDecayPeriodInHours()) - base::Seconds(30); base::Time origin1_last_updated = clock_.Now() + less_than_decay_period; clock_.SetNow(origin1_last_updated); service_->AddPointsForTesting(origin, 1); service_->AddPointsForTesting(origin1, 5); EXPECT_EQ(2, service_->GetScore(origin)); EXPECT_EQ(6, service_->GetScore(origin1)); clock_.SetNow(clock_.Now() + less_than_decay_period); service_->AddPointsForTesting(origin, 5); EXPECT_EQ(7, service_->GetScore(origin)); // Move forward to the max number of decays per score. This is within the // stale period so no cleanup should be run. for (int i = 0; i < SiteEngagementScore::GetMaxDecaysPerScore(); ++i) { clock_.SetNow(clock_.Now() + less_than_decay_period); service_->AddPointsForTesting(origin, 5); EXPECT_EQ(clock_.Now(), service_->GetLastEngagementTime()); } EXPECT_EQ(12, service_->GetScore(origin)); EXPECT_EQ(clock_.Now(), service_->GetLastEngagementTime()); // Move the clock back to precisely 1 decay period after origin1's last // updated time. |last_engagement_time| is in the future, so AddPoints // triggers a cleanup. Ensure that |last_engagement_time| is moved back // appropriately, while origin1 is decayed correctly (once). clock_.SetNow(origin1_last_updated + less_than_decay_period + base::Seconds(30)); service_->AddPointsForTesting(origin1, 1); EXPECT_EQ(clock_.Now(), service_->CreateEngagementScore(origin).last_engagement_time()); EXPECT_EQ(clock_.Now(), service_->GetLastEngagementTime()); EXPECT_EQ(12, service_->GetScore(origin)); EXPECT_EQ(1, service_->GetScore(origin1)); } TEST_F(SiteEngagementServiceTest, CleanupMovesScoreBackToRebase) { base::Time current_day = GetReferenceTime(); clock_.SetNow(current_day); GURL origin("http://www.google.com/"); service_->ResetBaseScoreForURL(origin, 5); service_->AddPointsForTesting(origin, 5); EXPECT_EQ(10, service_->GetScore(origin)); EXPECT_EQ(current_day, service_->GetLastEngagementTime()); // Send the clock back in time before the stale period and add engagement for // a new origin. base::Time before_stale_period = clock_.Now() - service_->GetStalePeriod() - service_->GetMaxDecayPeriod(); clock_.SetNow(before_stale_period); GURL origin1("http://maps.google.com/"); service_->AddPointsForTesting(origin1, 1); EXPECT_EQ(before_stale_period, service_->GetLastEngagementTime()); // Set the clock such that |origin|'s last engagement time is between // last_engagement_time and rebase_time. clock_.SetNow(current_day + service_->GetStalePeriod() + service_->GetMaxDecayPeriod() - base::Seconds((30))); base::Time rebased_time = clock_.Now() - service_->GetMaxDecayPeriod(); service_->CleanupEngagementScores(true); // Ensure that the original origin has its last engagement time updated to // rebase_time, and it has decayed when we access the score. EXPECT_EQ(rebased_time, service_->CreateEngagementScore(origin).last_engagement_time()); EXPECT_EQ(rebased_time, service_->GetLastEngagementTime()); EXPECT_EQ(5, service_->GetScore(origin)); EXPECT_EQ(0, service_->GetScore(origin1)); } TEST_F(SiteEngagementServiceTest, IncognitoEngagementService) { base::Time current_day = GetReferenceTime(); clock_.SetNow(current_day); GURL url1("http://www.google.com/"); GURL url2("https://www.google.com/"); GURL url3("https://drive.google.com/"); GURL url4("https://maps.google.com/"); service_->AddPointsForTesting(url1, 1); service_->AddPointsForTesting(url2, 2); auto incognito_service = std::make_unique( profile()->GetPrimaryOTRProfile(/*create_if_needed=*/true)); incognito_service->SetClockForTesting(&clock_); EXPECT_EQ(1, incognito_service->GetScore(url1)); EXPECT_EQ(2, incognito_service->GetScore(url2)); EXPECT_EQ(0, incognito_service->GetScore(url3)); incognito_service->AddPointsForTesting(url3, 1); EXPECT_EQ(1, incognito_service->GetScore(url3)); EXPECT_EQ(0, service_->GetScore(url3)); incognito_service->AddPointsForTesting(url2, 1); EXPECT_EQ(3, incognito_service->GetScore(url2)); EXPECT_EQ(2, service_->GetScore(url2)); service_->AddPointsForTesting(url3, 2); EXPECT_EQ(1, incognito_service->GetScore(url3)); EXPECT_EQ(2, service_->GetScore(url3)); EXPECT_EQ(0, incognito_service->GetScore(url4)); service_->AddPointsForTesting(url4, 2); EXPECT_EQ(2, incognito_service->GetScore(url4)); EXPECT_EQ(2, service_->GetScore(url4)); // Engagement should never become stale in incognito. current_day += incognito_service->GetStalePeriod(); clock_.SetNow(current_day); EXPECT_FALSE(incognito_service->IsLastEngagementStale()); current_day += incognito_service->GetStalePeriod(); clock_.SetNow(current_day); EXPECT_FALSE(incognito_service->IsLastEngagementStale()); incognito_service->Shutdown(); } TEST_F(SiteEngagementServiceTest, GetScoreFromSettings) { service_->SetClockForTesting(base::DefaultClock::GetInstance()); GURL url1("http://www.google.com/"); GURL url2("https://www.google.com/"); HostContentSettingsMap* settings_map = HostContentSettingsMapFactory::GetForProfile(profile()); HostContentSettingsMap* incognito_settings_map = HostContentSettingsMapFactory::GetForProfile( profile()->GetPrimaryOTRProfile(/*create_if_needed=*/true)); // All scores are 0 to start. EXPECT_EQ(0, CheckScoreFromSettingsOnThread(content::BrowserThread::IO, settings_map, url1)); EXPECT_EQ(0, CheckScoreFromSettingsOnThread(content::BrowserThread::UI, settings_map, url2)); EXPECT_EQ(0, CheckScoreFromSettingsOnThread(content::BrowserThread::UI, incognito_settings_map, url1)); EXPECT_EQ(0, CheckScoreFromSettingsOnThread(content::BrowserThread::IO, incognito_settings_map, url2)); service_->AddPointsForTesting(url1, 1); service_->AddPointsForTesting(url2, 2); EXPECT_EQ(1, CheckScoreFromSettingsOnThread(content::BrowserThread::UI, settings_map, url1)); EXPECT_EQ(2, CheckScoreFromSettingsOnThread(content::BrowserThread::IO, settings_map, url2)); EXPECT_EQ(1, CheckScoreFromSettingsOnThread(content::BrowserThread::UI, incognito_settings_map, url1)); EXPECT_EQ(2, CheckScoreFromSettingsOnThread(content::BrowserThread::IO, incognito_settings_map, url2)); SiteEngagementService* incognito_service = SiteEngagementService::Get( profile()->GetPrimaryOTRProfile(/*create_if_needed=*/true)); ASSERT_TRUE(incognito_service); incognito_service->AddPointsForTesting(url1, 3); incognito_service->AddPointsForTesting(url2, 1); EXPECT_EQ(1, CheckScoreFromSettingsOnThread(content::BrowserThread::IO, settings_map, url1)); EXPECT_EQ(2, CheckScoreFromSettingsOnThread(content::BrowserThread::UI, settings_map, url2)); EXPECT_EQ(4, CheckScoreFromSettingsOnThread(content::BrowserThread::IO, incognito_settings_map, url1)); EXPECT_EQ(3, CheckScoreFromSettingsOnThread(content::BrowserThread::UI, incognito_settings_map, url2)); service_->AddPointsForTesting(url1, 2); service_->AddPointsForTesting(url2, 1); EXPECT_EQ(3, CheckScoreFromSettingsOnThread(content::BrowserThread::IO, settings_map, url1)); EXPECT_EQ(3, CheckScoreFromSettingsOnThread(content::BrowserThread::UI, settings_map, url2)); EXPECT_EQ(4, CheckScoreFromSettingsOnThread(content::BrowserThread::UI, incognito_settings_map, url1)); EXPECT_EQ(3, CheckScoreFromSettingsOnThread(content::BrowserThread::IO, incognito_settings_map, url2)); } TEST_F(SiteEngagementServiceTest, GetAllDetailsIncludesBonusOnlyScores) { GURL url1("http://www.google.com/"); GURL url2("https://www.google.com/"); std::vector details = service_->GetAllDetails(); EXPECT_EQ(0u, details.size()); // Add a single site score via explicitly resetting the engagement score. service_->ResetBaseScoreForURL(url1, 5); // Add a second site indirectly, via a shortcut launch. SetLastShortcutLaunchTime(web_contents(), url2); // Verify that the URLs with engagement and a recent shortcut launch are // included. details = service_->GetAllDetails(); EXPECT_EQ(2u, details.size()); } TEST_F(SiteEngagementServiceTest, GetAllDetailsFilterByURLSets) { GURL http_url("http://www.google.com/"); GURL webui_url("chrome://history"); EXPECT_EQ(0u, service_->GetAllDetails().size()); // Add a HTTP url. service_->ResetBaseScoreForURL(http_url, 5); // Add a WebUI url. service_->ResetBaseScoreForURL(webui_url, 5); { // By default, GetAllDetails() returns http:// and https:// sites. std::vector details = service_->GetAllDetails(); EXPECT_EQ(1u, details.size()); EXPECT_EQ(http_url, details[0].origin); } { // Request scores from both HTTP and WebUI sites. std::vector details = service_->GetAllDetails( site_engagement::SiteEngagementService::URLSets::HTTP | site_engagement::SiteEngagementService::URLSets::WEB_UI); EXPECT_EQ(2u, details.size()); EXPECT_TRUE(http_url == details[0].origin || http_url == details[1].origin); EXPECT_TRUE(webui_url == details[0].origin || webui_url == details[1].origin); } } } // namespace site_engagement